2808980468

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/codeigniter4/shield/commit/<a class=hub.com/codeigniter4/shield/commit/<a class="double-link" href="https://git"><a class=hub.com/codeigniter4/shield/commit/<a class="double-link" href="https://git"><a class=hub.com/codeigniter4/shield/commit/5607e192e2e2a53387b40ce1b898ed82756352ac">5607e192e<a href="https://github.com/codeigniter4/shield/commit/5607e192e2e2a53387b40ce1b898ed82756352ac">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/codeigniter4/shield/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/codeigniter4/shield/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/codeigniter4/shield/commit/5607e192e2e2a53387b40ce1b898ed82756352ac&quot;&gt;5607e192e&lt;/a&gt;&lt;a href=&quot;https://github.com/codeigniter4/shield/commit/5607e192e2e2a53387b40ce1b898ed82756352ac&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/codeigniter4/shield/commit/5607e192e2e2a53387b40ce1b898ed82&lt;/a&gt;756352ac">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/codeigniter4/shield/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/codeigniter4/shield/commit/<a class="double-link" href="https://github.com/codeigniter4/shield/commit/2d39f84afd6962d8e422b551ae8ab5011938177b">2d39f84af</a><a href="https://github.com/codeigniter4/shield/commit/5607e192e2e2a53387b40ce1b898ed82756352ac">&amp;quot;&amp;gt;2d39f84af&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;2d39f84af&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/codeigniter4/shield/commit/5607e192e2e2a53387b40ce1b898ed8275635&lt;/a&gt;2ac&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/codeigniter4/shield/commit/<a class="double-link" href="https://github.com/codeigniter4/shield/commit/44e65eff3">44e65eff3">44e65eff3</a>

Pull Request Pull Request #345: Fix email deliverability error log

Run Details

15 of 18 new or added lines in 3 files covered. (83.33%)

1359 of 1464 relevant lines covered (92.83%)

15.57 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

89.47

/src/Authentication/Actions/Email2FA.php

<?php

namespace CodeIgniter\Shield\Authentication\Actions;

use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\Shield\Authentication\Authenticators\Session;
use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Exceptions\RuntimeException;
use CodeIgniter\Shield\Models\UserIdentityModel;

/**
 * Class Email2FA
 *
 * Sends an email to the user with a code to verify their account.
 */
class Email2FA implements ActionInterface
{
    private string $type = Session::ID_TYPE_EMAIL_2FA;

    /**
     * Displays the "Hey we're going to send you a number to your email"
     * message to the user with a prompt to continue.
     */
    public function show(): string
    {
        /** @var Session $authenticator */
        $authenticator = auth('session')->getAuthenticator();

        $user = $authenticator->getPendingUser();
        if ($user === null) {
            throw new RuntimeException('Cannot get the pending login User.');
        }

        $this->createIdentity($user);

        return view(setting('Auth.views')['action_email_2fa'], ['user' => $user]);
    }

    /**
     * Generates the random number, saves it as a temp identity
     * with the user, and fires off an email to the user with the code,
     * then displays the form to accept the 6 digits
     *
     * @return RedirectResponse|string
     */
    public function handle(IncomingRequest $request)
    {
        $email = $request->getPost('email');

        /** @var Session $authenticator */
        $authenticator = auth('session')->getAuthenticator();

        $user = $authenticator->getPendingUser();
        if ($user === null) {
            throw new RuntimeException('Cannot get the pending login User.');
        }

        if (empty($email) || $email !== $user->email) {
            return redirect()->route('auth-action-show')->with('error', lang('Auth.invalidEmail'));
        }

        /** @var UserIdentityModel $identityModel */
        $identityModel = model(UserIdentityModel::class);

        $identity = $identityModel->getIdentityByType($user, $this->type);

        if (empty($identity)) {
            return redirect()->route('auth-action-show')->with('error', lang('Auth.need2FA'));
        }

        // Send the user an email with the code
        helper('email');
        $email = emailer()->setFrom(setting('Email.fromEmail'), setting('Email.fromName') ?? '');
        $email->setTo($user->email);
        $email->setSubject(lang('Auth.email2FASubject'));
        $email->setMessage(view(setting('Auth.views')['action_email_2fa_email'], ['code' => $identity->secret]));

        if ($email->send(false) === false) {
            throw new RuntimeException('Cannot send email for user: ' . $user->email . '\n' . $email->printDebugger(['headers']));
        }

        return view(setting('Auth.views')['action_email_2fa_verify']);
    }

    /**
     * Attempts to verify the code the user entered.
     *
     * @return RedirectResponse|string
     */
    public function verify(IncomingRequest $request)
    {
        $token = $request->getPost('token');

        /** @var Session $authenticator */
        $authenticator = auth('session')->getAuthenticator();

        // Token mismatch? Let them try again...
        if (! $authenticator->checkAction($this->type, $token)) {
            session()->setFlashdata('error', lang('Auth.invalid2FAToken'));

            return view(setting('Auth.views')['action_email_2fa_verify']);
        }

        // Get our login redirect url
        return redirect()->to(config('Auth')->loginRedirect());
    }

    /**
     * Called from `Session::attempt()`.
     */
    public function afterLogin(User $user): void
    {
        $this->createIdentity($user);
    }

    private function createIdentity(User $user): void
    {
        /** @var UserIdentityModel $identityModel */
        $identityModel = model(UserIdentityModel::class);

        $generator = static fn (): string => random_string('nozero', 6);

        $identityModel->createCodeIdentity(
            $user,
            [
                'type'  => $this->type,
                'name'  => 'login',
                'extra' => lang('Auth.need2FA'),
            ],
            $generator
        );
    }

    public function getType(): string
    {
        return $this->type;
    }
}

1	<?php
2
3	namespace CodeIgniter\Shield\Authentication\Actions;
4
5	use CodeIgniter\HTTP\IncomingRequest;
6	use CodeIgniter\HTTP\RedirectResponse;
7	use CodeIgniter\Shield\Authentication\Authenticators\Session;
8	use CodeIgniter\Shield\Entities\User;
9	use CodeIgniter\Shield\Exceptions\RuntimeException;
10	use CodeIgniter\Shield\Models\UserIdentityModel;
11
12	/**
13	* Class Email2FA
14	*
15	* Sends an email to the user with a code to verify their account.
16	*/
17	class Email2FA implements ActionInterface
18	{
19	private string $type = Session::ID_TYPE_EMAIL_2FA;
20
21	/**
22	* Displays the "Hey we're going to send you a number to your email"
23	* message to the user with a prompt to continue.
24	*/
25	public function show(): string
26	{
27	/** @var Session $authenticator */
28	$authenticator = auth('session')->getAuthenticator();	2✔
29
30	$user = $authenticator->getPendingUser();	2✔
31	if ($user === null) {	2✔
32	throw new RuntimeException('Cannot get the pending login User.');	×
33	}
34
35	$this->createIdentity($user);	2✔
36
37	return view(setting('Auth.views')['action_email_2fa'], ['user' => $user]);	2✔
38	}
39
40	/**
41	* Generates the random number, saves it as a temp identity
42	* with the user, and fires off an email to the user with the code,
43	* then displays the form to accept the 6 digits
44	*
45	* @return RedirectResponse\|string
46	*/
47	public function handle(IncomingRequest $request)
48	{
49	$email = $request->getPost('email');	2✔
50
51	/** @var Session $authenticator */
52	$authenticator = auth('session')->getAuthenticator();	2✔
53
54	$user = $authenticator->getPendingUser();	2✔
55	if ($user === null) {	2✔
56	throw new RuntimeException('Cannot get the pending login User.');	×
57	}
58
59	if (empty($email) \|\| $email !== $user->email) {	2✔
60	return redirect()->route('auth-action-show')->with('error', lang('Auth.invalidEmail'));	1✔
61	}
62
63	/** @var UserIdentityModel $identityModel */
64	$identityModel = model(UserIdentityModel::class);	1✔
65
66	$identity = $identityModel->getIdentityByType($user, $this->type);	1✔
67
68	if (empty($identity)) {	1✔
69	return redirect()->route('auth-action-show')->with('error', lang('Auth.need2FA'));	×
70	}
71
72	// Send the user an email with the code
73	helper('email');	1✔
74	$email = emailer()->setFrom(setting('Email.fromEmail'), setting('Email.fromName') ?? '');	1✔
75	$email->setTo($user->email);	1✔
76	$email->setSubject(lang('Auth.email2FASubject'));	1✔
77	$email->setMessage(view(setting('Auth.views')['action_email_2fa_email'], ['code' => $identity->secret]));	1✔
78
79	if ($email->send(false) === false) {	1✔
NEW 80	throw new RuntimeException('Cannot send email for user: ' . $user->email . '\n' . $email->printDebugger(['headers']));	×
81	}
82
83	return view(setting('Auth.views')['action_email_2fa_verify']);	1✔
84	}
85
86	/**
87	* Attempts to verify the code the user entered.
88	*
89	* @return RedirectResponse\|string
90	*/
91	public function verify(IncomingRequest $request)
92	{
93	$token = $request->getPost('token');	2✔
94
95	/** @var Session $authenticator */
96	$authenticator = auth('session')->getAuthenticator();	2✔
97
98	// Token mismatch? Let them try again...
99	if (! $authenticator->checkAction($this->type, $token)) {	2✔
100	session()->setFlashdata('error', lang('Auth.invalid2FAToken'));	1✔
101
102	return view(setting('Auth.views')['action_email_2fa_verify']);	1✔
103	}
104
105	// Get our login redirect url
106	return redirect()->to(config('Auth')->loginRedirect());	1✔
107	}
108
109	/**
110	* Called from `Session::attempt()`.
111	*/
112	public function afterLogin(User $user): void
113	{
114	$this->createIdentity($user);	1✔
115	}
116
117	private function createIdentity(User $user): void
118	{
119	/** @var UserIdentityModel $identityModel */
120	$identityModel = model(UserIdentityModel::class);	3✔
121
122	$generator = static fn (): string => random_string('nozero', 6);	3✔
123
124	$identityModel->createCodeIdentity(	3✔
125	$user,
126	[
127	'type' => $this->type,	3✔
128	'name' => 'login',
129	'extra' => lang('Auth.need2FA'),	3✔
130	],
131	$generator
132	);
133	}
134
135	public function getType(): string
136	{
137	return $this->type;	1✔
138	}
139	}

codeigniter4 / shield / 2808980468

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous