3 namespace BookStack\Http\Controllers\Auth;
5 use BookStack\Actions\ActivityType;
6 use BookStack\Auth\Access\LoginService;
7 use BookStack\Auth\Access\Mfa\BackupCodeService;
8 use BookStack\Auth\Access\Mfa\MfaSession;
9 use BookStack\Auth\Access\Mfa\MfaValue;
10 use BookStack\Exceptions\NotFoundException;
11 use BookStack\Http\Controllers\Controller;
13 use Illuminate\Http\Request;
14 use Illuminate\Validation\ValidationException;
16 class MfaBackupCodesController extends Controller
18 use HandlesPartialLogins;
20 protected const SETUP_SECRET_SESSION_KEY = 'mfa-setup-backup-codes';
23 * Show a view that generates and displays backup codes.
25 public function generate(BackupCodeService $codeService)
27 $codes = $codeService->generateNewSet();
28 session()->put(self::SETUP_SECRET_SESSION_KEY, encrypt($codes));
30 $downloadUrl = 'data:application/octet-stream;base64,' . base64_encode(implode("\n\n", $codes));
32 return view('mfa.backup-codes-generate', [
34 'downloadUrl' => $downloadUrl,
39 * Confirm the setup of backup codes, storing them against the user.
43 public function confirm()
45 if (!session()->has(self::SETUP_SECRET_SESSION_KEY)) {
46 return response('No generated codes found in the session', 500);
49 $codes = decrypt(session()->pull(self::SETUP_SECRET_SESSION_KEY));
50 MfaValue::upsertWithValue($this->currentOrLastAttemptedUser(), MfaValue::METHOD_BACKUP_CODES, json_encode($codes));
52 $this->logActivity(ActivityType::MFA_SETUP_METHOD, 'backup-codes');
54 if (!auth()->check()) {
55 $this->showSuccessNotification(trans('auth.mfa_setup_login_notification'));
57 return redirect('/login');
60 return redirect('/mfa/setup');
64 * Verify the MFA method submission on check.
66 * @throws NotFoundException
67 * @throws ValidationException
69 public function verify(Request $request, BackupCodeService $codeService, MfaSession $mfaSession, LoginService $loginService)
71 $user = $this->currentOrLastAttemptedUser();
72 $codes = MfaValue::getValueForUser($user, MfaValue::METHOD_BACKUP_CODES) ?? '[]';
74 $this->validate($request, [
78 function ($attribute, $value, $fail) use ($codeService, $codes) {
79 if (!$codeService->inputCodeExistsInSet($value, $codes)) {
80 $fail(trans('validation.backup_codes'));
86 $updatedCodes = $codeService->removeInputCodeFromSet($request->get('code'), $codes);
87 MfaValue::upsertWithValue($user, MfaValue::METHOD_BACKUP_CODES, $updatedCodes);
89 $mfaSession->markVerifiedForUser($user);
90 $loginService->reattemptLoginFor($user);
92 if ($codeService->countCodesInSet($updatedCodes) < 5) {
93 $this->showWarningNotification(trans('auth.mfa_backup_codes_usage_limit_warning'));
96 return redirect()->intended();