1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Profiles::TwoFactorAuthsController, feature_category: :system_access do
before do
# `user` should be defined within the action-specific describe blocks
sign_in(user)
allow(subject).to receive(:current_user).and_return(user)
end
shared_examples 'user must first verify their primary email address' do
before do
allow(user).to receive(:primary_email_verified?).and_return(false)
end
it 'redirects to profile_emails_path' do
go
expect(response).to redirect_to(profile_emails_path)
end
it 'displays a notice' do
go
expect(flash[:notice])
.to eq _('You need to verify your primary email first before enabling Two-Factor Authentication.')
end
end
shared_examples 'user must enter a valid current password' do
let(:current_password) { '123' }
let(:error_message) { { message: _('You must provide a valid current password.') } }
it 'requires the current password', :aggregate_failures do
go
error = assigns[:error] || assigns[:otp_error]
expect(error).to eq(error_message)
expect(response).to render_template(:show)
end
it 'assigns qr_code' do
code = double('qr code')
expect(subject).to receive(:build_qr_code).and_return(code)
go
expect(assigns[:qr_code]).to eq(code)
end
it 'assigns account_string' do
go
expect(assigns[:account_string]).to eq("#{Gitlab.config.gitlab.host}:#{user.email}")
end
context 'when the user is on the last sign in attempt' do
it do
user.update!(failed_attempts: User.maximum_attempts.pred)
go
expect(user.reload).to be_access_locked
end
end
context 'when user authenticates with an external service' do
before do
allow(user).to receive(:password_automatically_set?).and_return(true)
end
it 'does not require the current password', :aggregate_failures do
go
expect(assigns[:error]).not_to eq(error_message)
end
end
context 'when password authentication is disabled' do
before do
stub_application_setting(password_authentication_enabled_for_web: false)
end
it 'does not require the current password', :aggregate_failures do
go
expect(assigns[:error]).not_to eq(error_message)
end
end
context 'when the user is an LDAP user' do
before do
allow(user).to receive(:ldap_user?).and_return(true)
end
it 'does not require the current password', :aggregate_failures do
go
expect(assigns[:error]).not_to eq(error_message)
end
end
end
describe 'GET show' do
let_it_be_with_reload(:user) { create(:user) }
it 'generates otp_secret for user' do
expect(User).to receive(:generate_otp_secret).with(32).and_call_original.once
get :show
end
it 'assigns qr_code' do
code = double('qr code')
expect(subject).to receive(:build_qr_code).and_return(code)
get :show
expect(assigns[:qr_code]).to eq(code)
end
it 'generates a single otp_secret with multiple page loads', :freeze_time do
expect(User).to receive(:generate_otp_secret).with(32).and_call_original.once
user.update!(otp_secret: nil, otp_secret_expires_at: nil)
2.times do
get :show
end
end
it 'generates a new otp_secret once the ttl has expired' do
expect(User).to receive(:generate_otp_secret).with(32).and_call_original.once
user.update!(otp_secret: "FT7KAVNU63YZH7PBRVPVL7CPSAENXY25", otp_secret_expires_at: 2.minutes.from_now)
travel_to(10.minutes.from_now) do
get :show
end
end
it_behaves_like 'user must first verify their primary email address' do
let(:go) { get :show }
end
end
describe 'POST create' do
let_it_be_with_reload(:user) { create(:user) }
let(:pin) { 'pin-code' }
let(:current_password) { user.password }
def go
post :create, params: { pin_code: pin, current_password: current_password }
end
context 'with valid pin' do
before do
allow(user).to receive(:validate_and_consume_otp!).with(pin).and_return(true)
end
it 'enables 2fa for the user' do
go
user.reload
expect(user).to be_two_factor_enabled
end
it 'presents plaintext codes for the user to save' do
expect(user).to receive(:generate_otp_backup_codes!).and_return(%w[a b c])
go
expect(assigns[:codes]).to match_array %w[a b c]
end
it 'calls to delete other sessions' do
expect(ActiveSession).to receive(:destroy_all_but_current)
go
end
it 'dismisses the `TWO_FACTOR_AUTH_RECOVERY_SETTINGS_CHECK` callout' do
expect(controller.helpers).to receive(:dismiss_two_factor_auth_recovery_settings_check)
go
end
it 'renders create' do
go
expect(response).to render_template(:create)
expect(user.otp_backup_codes?).to be_eql(true)
end
it 'do not create new backup codes if exists' do
expect(user).to receive(:otp_backup_codes?).and_return(true)
go
expect(response).to redirect_to(profile_two_factor_auth_path)
end
it 'calls to delete other sessions when backup codes already exist' do
expect(user).to receive(:otp_backup_codes?).and_return(true)
expect(ActiveSession).to receive(:destroy_all_but_current)
go
end
end
context 'with invalid pin' do
before do
expect(user).to receive(:validate_and_consume_otp!).with(pin).and_return(false)
end
it 'assigns error' do
go
expect(assigns[:error]).to eq({ message: 'Invalid pin code.' })
end
it 'assigns qr_code' do
code = double('qr code')
expect(subject).to receive(:build_qr_code).and_return(code)
go
expect(assigns[:qr_code]).to eq(code)
end
it 'assigns account_string' do
go
expect(assigns[:account_string]).to eq("#{Gitlab.config.gitlab.host}:#{user.email}")
end
it 'renders show' do
go
expect(response).to render_template(:show)
end
end
it_behaves_like 'user must enter a valid current password'
it_behaves_like 'user must first verify their primary email address'
end
describe 'POST codes' do
let_it_be_with_reload(:user) { create(:user, :two_factor) }
let(:current_password) { user.password }
it 'presents plaintext codes for the user to save' do
expect(user).to receive(:generate_otp_backup_codes!).and_return(%w[a b c])
post :codes, params: { current_password: current_password }
expect(assigns[:codes]).to match_array %w[a b c]
end
it 'persists the generated codes' do
post :codes, params: { current_password: current_password }
user.reload
expect(user.otp_backup_codes).not_to be_empty
end
it 'dismisses the `TWO_FACTOR_AUTH_RECOVERY_SETTINGS_CHECK` callout' do
expect(controller.helpers).to receive(:dismiss_two_factor_auth_recovery_settings_check)
post :codes, params: { current_password: current_password }
end
it_behaves_like 'user must enter a valid current password' do
let(:go) { post :codes, params: { current_password: current_password } }
end
end
describe 'POST create_webauthn' do
let_it_be_with_reload(:user) { create(:user) }
let(:client) { WebAuthn::FakeClient.new('http://localhost', encoding: :base64) }
let(:credential) { create_credential(client: client, rp_id: request.host) }
let(:params) { { device_registration: { name: 'touch id', device_response: device_response } } }
let(:params_with_password) do
{ device_registration: { name: 'touch id', device_response: device_response }, current_password: user.password }
end
before do
session[:challenge] = challenge
end
def go
post :create_webauthn, params: params
end
def challenge
@_challenge ||= begin
options_for_create = WebAuthn::Credential.options_for_create(
user: { id: user.webauthn_xid, name: user.username },
authenticator_selection: { user_verification: 'discouraged' },
rp: { name: 'GitLab' }
)
options_for_create.challenge
end
end
def device_response
client.create(challenge: challenge).to_json # rubocop:disable Rails/SaveBang
end
it 'update failed_attempts when proper password is not given' do
go
expect(user.failed_attempts).to be_eql(1)
end
context "when valid password is given" do
it "registers and render OTP backup codes" do
post :create_webauthn, params: params_with_password
expect(user.otp_backup_codes).not_to be_empty
expect(flash[:notice]).to match(/Your WebAuthn device was registered!/)
end
it 'registers and redirects back if user is already having backup codes' do
expect(user).to receive(:otp_backup_codes?).and_return(true)
post :create_webauthn, params: params_with_password
expect(response).to redirect_to(profile_two_factor_auth_path)
expect(flash[:notice]).to match(/Your WebAuthn device was registered!/)
end
end
end
describe 'DELETE destroy' do
def go
delete :destroy, params: { current_password: current_password }
end
let(:current_password) { user.password }
context 'for a user that has 2FA enabled' do
let_it_be_with_reload(:user) { create(:user, :two_factor) }
it 'disables two factor' do
go
expect(user.reload.two_factor_enabled?).to eq(false)
end
it 'redirects to profile_account_path' do
go
expect(response).to redirect_to(profile_account_path)
end
it 'displays a notice on success' do
go
expect(flash[:notice])
.to eq _('Two-factor authentication has been disabled successfully!')
end
it_behaves_like 'user must enter a valid current password'
end
context 'for a user that does not have 2FA enabled' do
let_it_be_with_reload(:user) { create(:user) }
it 'redirects to profile_account_path' do
go
expect(response).to redirect_to(profile_account_path)
end
it 'displays an alert on failure' do
go
expect(flash[:alert])
.to eq _('Two-factor authentication is not enabled for this user')
end
end
end
describe 'DELETE destroy_otp' do
let(:destroy_otp) do
delete :destroy_otp, params: { current_password: current_password }
end
let(:current_password) { user.password }
def go
destroy_otp
end
context 'for a user that has OTP and WebAuthn enabled' do
let_it_be_with_reload(:user) do
create(:user, :two_factor_via_otp, :two_factor_via_webauthn)
end
it 'disables OTP authenticator and leaves WebAuthn devices unaffected' do
expect(user.two_factor_otp_enabled?).to eq(true)
expect(user.two_factor_webauthn_enabled?).to eq(true)
go
user.reload
expect(user.two_factor_otp_enabled?).to eq(false)
expect(user.two_factor_webauthn_enabled?).to eq(true)
end
it 'redirects to profile_two_factor_auth_path' do
go
expect(response).to redirect_to(profile_two_factor_auth_path)
end
it 'displays a notice on success' do
go
expect(flash[:notice])
.to eq _('One-time password authenticator has been deleted!')
end
it_behaves_like 'user must enter a valid current password'
end
context 'for a user that has only WebAuthn enabled' do
let_it_be_with_reload(:user) do
create(:user, :two_factor_via_webauthn)
end
it 'leaves WebAuthn devices unaffected' do
expect(user.two_factor_otp_enabled?).to eq(false)
expect(user.two_factor_webauthn_enabled?).to eq(true)
go
user.reload
expect(user.two_factor_otp_enabled?).to eq(false)
expect(user.two_factor_webauthn_enabled?).to eq(true)
end
it 'redirects to profile_two_factor_auth_path' do
go
expect(response).to redirect_to(profile_two_factor_auth_path)
end
it 'displays a alert on failure' do
go
expect(flash[:alert])
.to eq _('This user does not have a one-time password authenticator registered.')
end
it_behaves_like 'user must enter a valid current password'
end
end
describe 'DELETE destroy_webauthn' do
let_it_be_with_reload(:user) do
create(:user, :two_factor_via_webauthn)
end
let(:webauthn_id) { user.webauthn_registrations.first.id }
let(:current_password) { user.password }
let(:destroy_webauthn) do
delete :destroy_webauthn, params: { id: webauthn_id, current_password: current_password }
end
def go
destroy_webauthn
end
it 'destroys the webauthn device' do
count = user.webauthn_registrations.count
go
user.reload
expect(user.webauthn_registrations.count).to eq(count - 1)
end
it 'redirects to the profile two factor authentication page' do
go
expect(response).to redirect_to profile_two_factor_auth_path
end
it 'calls the Webauthn::DestroyService' do
service = double
expect(Webauthn::DestroyService).to receive(:new).with(user, user, webauthn_id.to_s).and_return(service)
expect(service).to receive(:execute)
go
end
it_behaves_like 'user must enter a valid current password'
end
describe 'PATCH skip' do
let(:user) { create(:user, otp_grace_period_started_at: Time.zone.now) }
def request
patch :skip
end
before do
stub_application_setting(require_two_factor_authentication: true)
stub_application_setting(two_factor_grace_period: 24)
end
it 'redirects the user to the root url' do
request
expect(response).to redirect_to root_url
end
it 'redirects back to 2fa page if grace period expired' do
travel_to(27.hours.from_now) do
request
expect(response).to redirect_to profile_two_factor_auth_url
end
end
end
end
|