You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

99 lines
2.6 KiB

Add WebAuthn as an alternative 2FA method (#14466) * feat: add possibility of adding WebAuthn security keys to use as 2FA This adds a basic UI for enabling WebAuthn 2FA. We did a little refactor to the Settings page for editing the 2FA methods – now it will list the methods that are available to the user (TOTP and WebAuthn) and from there they'll be able to add or remove any of them. Also, it's worth mentioning that for enabling WebAuthn it's required to have TOTP enabled, so the first time that you go to the 2FA Settings page, you'll be asked to set it up. This work was inspired by the one donde by Github in their platform, and despite it could be approached in different ways, we decided to go with this one given that we feel that this gives a great UX. Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com> * feat: add request for WebAuthn as second factor at login if enabled This commits adds the feature for using WebAuthn as a second factor for login when enabled. If users have WebAuthn enabled, now a page requesting for the use of a WebAuthn credential for log in will appear, although a link redirecting to the old page for logging in using a two-factor code will also be present. Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com> * feat: add possibility of deleting WebAuthn Credentials Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com> * feat: disable WebAuthn when an Admin disables 2FA for a user Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com> * feat: remove ability to disable TOTP leaving only WebAuthn as 2FA Following examples form other platforms like Github, we decided to make Webauthn 2FA secondary to 2FA with TOTP, so that we removed the possibility of removing TOTP authentication only, leaving users with just WEbAuthn as 2FA. Instead, users will have to click on 'Disable 2FA' in order to remove second factor auth. The reason for WebAuthn being secondary to TOPT is that in that way, users will still be able to log in using their code from their phone's application if they don't have their security keys with them – or maybe even lost them. * We had to change a little the flow for setting up TOTP, given that now it's possible to setting up again if you already had TOTP, in order to let users modify their authenticator app – given that now it's not possible for them to disable TOTP and set it up again with another authenticator app. So, basically, now instead of storing the new `otp_secret` in the user, we store it in the session until the process of set up is finished. This was because, as it was before, when users clicked on 'Edit' in the new two-factor methods lists page, but then went back without finishing the flow, their `otp_secret` had been changed therefore invalidating their previous authenticator app, making them unable to log in again using TOTP. Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com> * refactor: fix eslint errors The PR build was failing given that linting returning some errors. This commit attempts to fix them. * refactor: normalize i18n translations The build was failing given that i18n translations files were not normalized. This commits fixes that. * refactor: avoid having the webauthn gem locked to a specific version * refactor: use symbols for routes without '/' * refactor: avoid sending webauthn disabled email when 2FA is disabled When an admins disable 2FA for users, we were sending two mails to them, one notifying that 2FA was disabled and the other to notify that WebAuthn was disabled. As the second one is redundant since the first email includes it, we can remove it and send just one email to users. * refactor: avoid creating new env variable for webauthn_origin config * refactor: improve flash error messages for webauthn pages Co-authored-by: Facundo Padula <facundo.padula@cedarcode.com>
3 years ago
  1. # frozen_string_literal: true
  2. require 'rails_helper'
  3. describe Settings::TwoFactorAuthentication::OtpAuthenticationController do
  4. render_views
  5. let(:user) { Fabricate(:user) }
  6. describe 'GET #show' do
  7. context 'when signed in' do
  8. before do
  9. sign_in user, scope: :user
  10. end
  11. describe 'when user has OTP enabled' do
  12. before do
  13. user.update(otp_required_for_login: true)
  14. end
  15. it 'redirects to two factor authentciation methods list page' do
  16. get :show
  17. expect(response).to redirect_to settings_two_factor_authentication_methods_path
  18. end
  19. end
  20. describe 'when user does not have OTP enabled' do
  21. before do
  22. user.update(otp_required_for_login: false)
  23. end
  24. it 'returns http success' do
  25. get :show
  26. expect(response).to have_http_status(200)
  27. end
  28. end
  29. end
  30. context 'when not signed in' do
  31. it 'redirects' do
  32. get :show
  33. expect(response).to redirect_to new_user_session_path
  34. end
  35. end
  36. end
  37. describe 'POST #create' do
  38. context 'when signed in' do
  39. before do
  40. sign_in user, scope: :user
  41. end
  42. describe 'when user has OTP enabled' do
  43. before do
  44. user.update(otp_required_for_login: true)
  45. end
  46. describe 'when creation succeeds' do
  47. it 'redirects to code confirmation page without updating user secret and setting otp secret in the session' do
  48. expect do
  49. post :create, session: { challenge_passed_at: Time.now.utc }
  50. end.to not_change { user.reload.otp_secret }
  51. .and change { session[:new_otp_secret] }
  52. expect(response).to redirect_to(new_settings_two_factor_authentication_confirmation_path)
  53. end
  54. end
  55. end
  56. describe 'when user does not have OTP enabled' do
  57. before do
  58. user.update(otp_required_for_login: false)
  59. end
  60. describe 'when creation succeeds' do
  61. it 'redirects to code confirmation page without updating user secret and setting otp secret in the session' do
  62. expect do
  63. post :create, session: { challenge_passed_at: Time.now.utc }
  64. end.to not_change { user.reload.otp_secret }
  65. .and change { session[:new_otp_secret] }
  66. expect(response).to redirect_to(new_settings_two_factor_authentication_confirmation_path)
  67. end
  68. end
  69. end
  70. end
  71. context 'when not signed in' do
  72. it 'redirects to login' do
  73. get :show
  74. expect(response).to redirect_to new_user_session_path
  75. end
  76. end
  77. end
  78. end