debian-mirror-gitlab/spec/controllers/omniauth_callbacks_controller_spec.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

628 lines
19 KiB
Ruby
Raw Normal View History

2019-07-31 22:56:46 +05:30
# frozen_string_literal: true
2018-03-17 18:26:18 +05:30
require 'spec_helper'
2020-06-23 00:09:42 +05:30
RSpec.describe OmniauthCallbacksController, type: :controller do
2018-03-17 18:26:18 +05:30
include LoginHelpers
2018-11-08 19:23:39 +05:30
describe 'omniauth' do
let(:user) { create(:omniauth_user, extern_uid: extern_uid, provider: provider) }
2019-09-30 23:59:55 +05:30
let(:additional_info) { {} }
2018-03-17 18:26:18 +05:30
2018-05-09 12:01:36 +05:30
before do
2019-10-12 21:52:04 +05:30
@original_env_config_omniauth_auth = mock_auth_hash(provider.to_s, extern_uid, user.email, additional_info: additional_info )
2018-11-08 19:23:39 +05:30
stub_omniauth_provider(provider, context: request)
2018-03-26 14:24:53 +05:30
end
2018-03-17 18:26:18 +05:30
2019-07-31 22:56:46 +05:30
after do
Rails.application.env_config['omniauth.auth'] = @original_env_config_omniauth_auth
end
2019-12-21 20:55:43 +05:30
context 'a deactivated user' do
let(:provider) { :github }
let(:extern_uid) { 'my-uid' }
before do
user.deactivate!
post provider
end
it 'allows sign in' do
expect(request.env['warden']).to be_authenticated
end
it 'activates the user' do
expect(user.reload.active?).to be_truthy
end
it 'shows reactivation flash message after logging in' do
expect(flash[:notice]).to eq('Welcome back! Your account had been deactivated due to inactivity but is now reactivated.')
end
end
2020-09-03 11:15:55 +05:30
context 'when sign in is not valid' do
let(:provider) { :github }
let(:extern_uid) { 'my-uid' }
it 'renders omniauth error page' do
allow_next_instance_of(Gitlab::Auth::OAuth::User) do |instance|
allow(instance).to receive(:valid_sign_in?).and_return(false)
end
post provider
expect(response).to render_template("errors/omniauth_error")
expect(response).to have_gitlab_http_status(:unprocessable_entity)
end
end
2018-11-08 19:23:39 +05:30
context 'when the user is on the last sign in attempt' do
let(:extern_uid) { 'my-uid' }
2018-03-17 18:26:18 +05:30
2018-11-08 19:23:39 +05:30
before do
2021-04-29 21:17:54 +05:30
user.update!(failed_attempts: User.maximum_attempts.pred)
2018-11-08 19:23:39 +05:30
subject.response = ActionDispatch::Response.new
2018-03-26 14:24:53 +05:30
end
2018-03-17 18:26:18 +05:30
2018-11-08 19:23:39 +05:30
context 'when using a form based provider' do
let(:provider) { :ldap }
2018-03-17 18:26:18 +05:30
2018-11-08 19:23:39 +05:30
it 'locks the user when sign in fails' do
allow(subject).to receive(:params).and_return(ActionController::Parameters.new(username: user.username))
request.env['omniauth.error.strategy'] = OmniAuth::Strategies::LDAP.new(nil)
2018-03-17 18:26:18 +05:30
2018-11-08 19:23:39 +05:30
subject.send(:failure)
2018-05-09 12:01:36 +05:30
2018-11-08 19:23:39 +05:30
expect(user.reload).to be_access_locked
end
2018-03-26 14:24:53 +05:30
end
2018-03-17 18:26:18 +05:30
2018-11-08 19:23:39 +05:30
context 'when using a button based provider' do
let(:provider) { :github }
2018-03-17 18:26:18 +05:30
2018-11-08 19:23:39 +05:30
it 'does not lock the user when sign in fails' do
request.env['omniauth.error.strategy'] = OmniAuth::Strategies::GitHub.new(nil)
2018-03-17 18:26:18 +05:30
2018-11-08 19:23:39 +05:30
subject.send(:failure)
2018-03-17 18:26:18 +05:30
2018-11-08 19:23:39 +05:30
expect(user.reload).not_to be_access_locked
2018-05-09 12:01:36 +05:30
end
2018-03-26 14:24:53 +05:30
end
2018-11-08 19:23:39 +05:30
end
2018-03-17 18:26:18 +05:30
2019-03-02 22:35:43 +05:30
context 'when sign in fails' do
include RoutesHelpers
let(:extern_uid) { 'my-uid' }
let(:provider) { :saml }
def stub_route_as(path)
allow(@routes).to receive(:generate_extras) { [path, []] }
end
2019-07-07 11:18:12 +05:30
it 'calls through to the failure handler' do
2019-03-02 22:35:43 +05:30
request.env['omniauth.error'] = OneLogin::RubySaml::ValidationError.new("Fingerprint mismatch")
request.env['omniauth.error.strategy'] = OmniAuth::Strategies::SAML.new(nil)
stub_route_as('/users/auth/saml/callback')
ForgeryProtection.with_forgery_protection do
post :failure
end
expect(flash[:alert]).to match(/Fingerprint mismatch/)
end
end
context 'when a redirect fragment is provided' do
let(:provider) { :jwt }
let(:extern_uid) { 'my-uid' }
before do
request.env['omniauth.params'] = { 'redirect_fragment' => 'L101' }
end
context 'when a redirect url is stored' do
it 'redirects with fragment' do
post provider, session: { user_return_to: '/fake/url' }
expect(response).to redirect_to('/fake/url#L101')
end
end
context 'when a redirect url with a fragment is stored' do
it 'redirects with the new fragment' do
post provider, session: { user_return_to: '/fake/url#replaceme' }
expect(response).to redirect_to('/fake/url#L101')
end
end
context 'when no redirect url is stored' do
it 'does not redirect with the fragment' do
post provider
expect(response.redirect?).to be true
expect(response.location).not_to include('#L101')
end
end
end
2018-11-08 19:23:39 +05:30
context 'strategies' do
2019-09-30 23:59:55 +05:30
shared_context 'sign_up' do
2019-10-12 21:52:04 +05:30
let(:user) { double(email: 'new@example.com') }
2019-09-30 23:59:55 +05:30
before do
stub_omniauth_setting(block_auto_created_users: false)
end
end
2018-11-08 19:23:39 +05:30
context 'github' do
let(:extern_uid) { 'my-uid' }
let(:provider) { :github }
2018-05-09 12:01:36 +05:30
2020-05-24 23:13:21 +05:30
it_behaves_like 'known sign in' do
let(:post_action) { post provider }
end
2018-11-08 19:23:39 +05:30
it 'allows sign in' do
2018-05-09 12:01:36 +05:30
post provider
2018-03-17 18:26:18 +05:30
2018-05-09 12:01:36 +05:30
expect(request.env['warden']).to be_authenticated
end
2018-03-17 18:26:18 +05:30
2020-11-24 15:15:51 +05:30
it 'creates an authentication event record' do
expect { post provider }.to change { AuthenticationEvent.count }.by(1)
expect(AuthenticationEvent.last.provider).to eq(provider.to_s)
end
2019-07-07 11:18:12 +05:30
context 'when user has no linked provider' do
let(:user) { create(:user) }
before do
sign_in user
end
it 'links identity' do
expect do
post provider
user.reload
end.to change { user.identities.count }.by(1)
end
context 'and is not allowed to link the provider' do
before do
allow_any_instance_of(IdentityProviderPolicy).to receive(:can?).with(:link).and_return(false)
end
it 'returns 403' do
post provider
2020-03-13 15:44:24 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2019-07-07 11:18:12 +05:30
end
end
end
2020-10-24 23:57:45 +05:30
context 'when user with 2FA is unconfirmed' do
render_views
let(:user) { create(:omniauth_user, :two_factor, extern_uid: 'my-uid', provider: provider) }
before do
user.update_column(:confirmed_at, nil)
end
it 'redirects to login page' do
post provider
expect(response).to redirect_to(new_user_session_path)
expect(flash[:alert]).to match(/You have to confirm your email address before continuing./)
end
end
2018-11-08 19:23:39 +05:30
context 'sign up' do
include_context 'sign_up'
2018-05-09 12:01:36 +05:30
2022-07-23 23:45:48 +05:30
context 'when intent to register is added to omniauth params' do
before do
request.env['omniauth.params'] = { 'intent' => 'register' }
end
it 'is allowed' do
post provider
2018-05-09 12:01:36 +05:30
2022-07-23 23:45:48 +05:30
expect(request.env['warden']).to be_authenticated
end
it 'redirects to welcome path' do
post provider
expect(response).to redirect_to(users_sign_up_welcome_path)
end
end
context 'when intent to register is not added to omniauth params' do
it 'is allowed' do
post provider
expect(request.env['warden']).to be_authenticated
end
it 'redirects to root path' do
post provider
expect(response).to redirect_to(root_path)
end
2018-11-08 19:23:39 +05:30
end
2018-05-09 12:01:36 +05:30
end
2018-11-08 19:23:39 +05:30
context 'when OAuth is disabled' do
before do
stub_env('IN_MEMORY_APPLICATION_SETTINGS', 'false')
settings = Gitlab::CurrentSettings.current_application_settings
2021-04-29 21:17:54 +05:30
settings.update!(disabled_oauth_sign_in_sources: [provider.to_s])
2018-11-08 19:23:39 +05:30
end
2018-05-09 12:01:36 +05:30
2018-11-08 19:23:39 +05:30
it 'prevents login via POST' do
2018-05-09 12:01:36 +05:30
post provider
expect(request.env['warden']).not_to be_authenticated
end
2018-11-08 19:23:39 +05:30
it 'shows warning when attempting login' do
post provider
expect(response).to redirect_to new_user_session_path
expect(flash[:alert]).to eq('Signing in using GitHub has been disabled')
end
it 'allows linking the disabled provider' do
2020-06-23 00:09:42 +05:30
user.identities.destroy_all # rubocop: disable Cop/DestroyAll
2018-11-08 19:23:39 +05:30
sign_in(user)
expect { post provider }.to change { user.reload.identities.count }.by(1)
end
context 'sign up' do
include_context 'sign_up'
it 'is prevented' do
post provider
expect(request.env['warden']).not_to be_authenticated
end
end
end
end
context 'auth0' do
let(:extern_uid) { '' }
let(:provider) { :auth0 }
it 'does not allow sign in without extern_uid' do
post 'auth0'
expect(request.env['warden']).not_to be_authenticated
2020-04-22 19:07:51 +05:30
expect(response).to have_gitlab_http_status(:found)
2018-11-08 19:23:39 +05:30
expect(controller).to set_flash[:alert].to('Wrong extern UID provided. Make sure Auth0 is configured correctly.')
2018-05-09 12:01:36 +05:30
end
2018-03-17 18:26:18 +05:30
end
2019-09-30 23:59:55 +05:30
2020-11-24 15:15:51 +05:30
context 'atlassian_oauth2' do
let(:provider) { :atlassian_oauth2 }
let(:extern_uid) { 'my-uid' }
context 'when the user and identity already exist' do
let(:user) { create(:atlassian_user, extern_uid: extern_uid) }
it 'allows sign-in' do
post :atlassian_oauth2
expect(request.env['warden']).to be_authenticated
end
2021-09-04 01:27:46 +05:30
it 'sets the username and caller_id in the context' do
expect(controller).to receive(:atlassian_oauth2).and_wrap_original do |m, *args|
m.call(*args)
expect(Gitlab::ApplicationContext.current)
.to include('meta.user' => user.username,
'meta.caller_id' => 'OmniauthCallbacksController#atlassian_oauth2')
end
post :atlassian_oauth2
end
2020-11-24 15:15:51 +05:30
end
context 'for a new user' do
before do
stub_omniauth_setting(enabled: true, auto_link_user: true, allow_single_sign_on: ['atlassian_oauth2'])
2021-04-29 21:17:54 +05:30
user.destroy!
2020-11-24 15:15:51 +05:30
end
it 'denies sign-in if sign-up is enabled, but block_auto_created_users is set' do
post :atlassian_oauth2
2021-11-11 11:23:49 +05:30
expect(flash[:alert]).to start_with 'Your account is pending approval'
2020-11-24 15:15:51 +05:30
end
it 'accepts sign-in if sign-up is enabled' do
stub_omniauth_setting(block_auto_created_users: false)
post :atlassian_oauth2
expect(request.env['warden']).to be_authenticated
end
it 'denies sign-in if sign-up is not enabled' do
stub_omniauth_setting(allow_single_sign_on: false, block_auto_created_users: false)
post :atlassian_oauth2
expect(flash[:alert]).to start_with 'Signing in using your Atlassian account without a pre-existing GitLab account is not allowed.'
end
end
end
2019-09-30 23:59:55 +05:30
context 'salesforce' do
let(:extern_uid) { 'my-uid' }
let(:provider) { :salesforce }
let(:additional_info) { { extra: { email_verified: false } } }
context 'without verified email' do
it 'does not allow sign in' do
post 'salesforce'
expect(request.env['warden']).not_to be_authenticated
2020-04-22 19:07:51 +05:30
expect(response).to have_gitlab_http_status(:found)
2019-09-30 23:59:55 +05:30
expect(controller).to set_flash[:alert].to('Email not verified. Please verify your email in Salesforce.')
end
end
context 'with verified email' do
include_context 'sign_up'
let(:additional_info) { { extra: { email_verified: true } } }
it 'allows sign in' do
post 'salesforce'
expect(request.env['warden']).to be_authenticated
end
end
end
2018-03-17 18:26:18 +05:30
end
2018-11-08 19:23:39 +05:30
end
describe '#saml' do
2019-09-30 23:59:55 +05:30
let(:last_request_id) { 'ONELOGIN_4fee3b046395c4e751011e97f8900b5273d56685' }
2018-11-08 19:23:39 +05:30
let(:user) { create(:omniauth_user, :two_factor, extern_uid: 'my-uid', provider: 'saml') }
let(:mock_saml_response) { File.read('spec/fixtures/authentication/saml_response.xml') }
let(:saml_config) { mock_saml_config_with_upstream_two_factor_authn_contexts }
2019-09-30 23:59:55 +05:30
def stub_last_request_id(id)
session['last_authn_request_id'] = id
end
2018-11-08 19:23:39 +05:30
before do
2019-09-30 23:59:55 +05:30
stub_last_request_id(last_request_id)
2021-02-22 17:27:13 +05:30
stub_omniauth_saml_config(enabled: true, auto_link_saml_user: true, allow_single_sign_on: ['saml'],
providers: [saml_config])
2019-07-31 22:56:46 +05:30
mock_auth_hash_with_saml_xml('saml', +'my-uid', user.email, mock_saml_response)
2019-09-30 23:59:55 +05:30
request.env['devise.mapping'] = Devise.mappings[:user]
2018-11-08 19:23:39 +05:30
request.env['omniauth.auth'] = Rails.application.env_config['omniauth.auth']
end
2018-03-26 14:24:53 +05:30
2020-05-24 23:13:21 +05:30
it_behaves_like 'known sign in' do
let(:user) { create(:omniauth_user, extern_uid: 'my-uid', provider: 'saml') }
let(:post_action) { post :saml, params: { SAMLResponse: mock_saml_response } }
end
2020-03-13 15:44:24 +05:30
context 'sign up' do
before do
2021-04-29 21:17:54 +05:30
user.destroy!
2020-03-13 15:44:24 +05:30
end
it 'denies login if sign up is enabled, but block_auto_created_users is set' do
post :saml, params: { SAMLResponse: mock_saml_response }
2021-11-11 11:23:49 +05:30
expect(flash[:alert]).to start_with 'Your account is pending approval'
2020-03-13 15:44:24 +05:30
end
it 'accepts login if sign up is enabled' do
stub_omniauth_setting(block_auto_created_users: false)
post :saml, params: { SAMLResponse: mock_saml_response }
expect(request.env['warden']).to be_authenticated
end
it 'denies login if sign up is not enabled' do
stub_omniauth_setting(allow_single_sign_on: false, block_auto_created_users: false)
post :saml, params: { SAMLResponse: mock_saml_response }
expect(flash[:alert]).to start_with 'Signing in using your saml account without a pre-existing GitLab account is not allowed.'
end
end
2019-09-30 23:59:55 +05:30
context 'with GitLab initiated request' do
before do
post :saml, params: { SAMLResponse: mock_saml_response }
end
context 'when worth two factors' do
let(:mock_saml_response) do
File.read('spec/fixtures/authentication/saml_response.xml')
2018-11-08 19:23:39 +05:30
.gsub('urn:oasis:names:tc:SAML:2.0:ac:classes:Password', 'urn:oasis:names:tc:SAML:2.0:ac:classes:SecondFactorIGTOKEN')
2019-09-30 23:59:55 +05:30
end
it 'expects user to be signed_in' do
expect(request.env['warden']).to be_authenticated
end
2018-11-08 19:23:39 +05:30
end
2018-03-26 14:24:53 +05:30
2019-09-30 23:59:55 +05:30
context 'when not worth two factors' do
it 'expects user to provide second factor' do
expect(response).to render_template('devise/sessions/two_factor')
expect(request.env['warden']).not_to be_authenticated
end
2018-11-08 19:23:39 +05:30
end
end
2018-03-26 14:24:53 +05:30
2019-09-30 23:59:55 +05:30
context 'with IdP initiated request' do
let(:user) { create(:user) }
let(:last_request_id) { '99999' }
before do
sign_in user
end
it 'lets the user know their account isn\'t linked yet' do
post :saml, params: { SAMLResponse: mock_saml_response }
expect(flash[:notice]).to eq 'Request to link SAML account must be authorized'
end
it 'redirects to profile account page' do
post :saml, params: { SAMLResponse: mock_saml_response }
expect(response).to redirect_to(profile_account_path)
end
it 'doesn\'t link a new identity to the user' do
expect { post :saml, params: { SAMLResponse: mock_saml_response } }.not_to change { user.identities.count }
2018-05-09 12:01:36 +05:30
end
2021-09-04 01:27:46 +05:30
it 'sets the username and caller_id in the context' do
expect(controller).to receive(:saml).and_wrap_original do |m, *args|
m.call(*args)
expect(Gitlab::ApplicationContext.current)
.to include('meta.user' => user.username,
'meta.caller_id' => 'OmniauthCallbacksController#saml')
end
post :saml, params: { SAMLResponse: mock_saml_response }
end
2018-03-26 14:24:53 +05:30
end
2022-01-26 12:08:38 +05:30
context 'with a blocked user trying to log in when there are hooks set up' do
let(:user) { create(:omniauth_user, extern_uid: 'my-uid', provider: 'saml') }
subject(:post_action) { post :saml, params: { SAMLResponse: mock_saml_response } }
before do
create(:system_hook)
user.block!
end
it { expect { post_action }.not_to raise_error }
end
2018-03-26 14:24:53 +05:30
end
2020-01-01 13:55:28 +05:30
describe 'enable admin mode' do
include_context 'custom session'
let(:provider) { :auth0 }
let(:extern_uid) { 'my-uid' }
let(:user) { create(:omniauth_user, extern_uid: extern_uid, provider: provider) }
def reauthenticate_and_check_admin_mode(expected_admin_mode:)
# Initially admin mode disabled
expect(subject.current_user_mode.admin_mode?).to be(false)
# Trigger OmniAuth admin mode flow and expect admin mode status
post provider
expect(request.env['warden']).to be_authenticated
expect(subject.current_user_mode.admin_mode?).to be(expected_admin_mode)
end
context 'user and admin mode requested by the same user' do
before do
sign_in user
mock_auth_hash(provider.to_s, extern_uid, user.email, additional_info: {})
stub_omniauth_provider(provider, context: request)
end
context 'with a regular user' do
it 'cannot be enabled' do
reauthenticate_and_check_admin_mode(expected_admin_mode: false)
expect(response).to redirect_to(root_path)
end
end
context 'with an admin user' do
let(:user) { create(:omniauth_user, extern_uid: extern_uid, provider: provider, access_level: :admin) }
context 'when requested first' do
before do
subject.current_user_mode.request_admin_mode!
end
it 'can be enabled' do
reauthenticate_and_check_admin_mode(expected_admin_mode: true)
expect(response).to redirect_to(admin_root_path)
end
end
context 'when not requested first' do
it 'cannot be enabled' do
reauthenticate_and_check_admin_mode(expected_admin_mode: false)
expect(response).to redirect_to(root_path)
end
end
end
end
context 'user and admin mode requested by different users' do
let(:reauth_extern_uid) { 'another_uid' }
let(:reauth_user) { create(:omniauth_user, extern_uid: reauth_extern_uid, provider: provider) }
before do
sign_in user
mock_auth_hash(provider.to_s, reauth_extern_uid, reauth_user.email, additional_info: {})
stub_omniauth_provider(provider, context: request)
end
context 'with a regular user' do
it 'cannot be enabled' do
reauthenticate_and_check_admin_mode(expected_admin_mode: false)
expect(response).to redirect_to(profile_account_path)
end
end
context 'with an admin user' do
let(:user) { create(:omniauth_user, extern_uid: extern_uid, provider: provider, access_level: :admin) }
let(:reauth_user) { create(:omniauth_user, extern_uid: reauth_extern_uid, provider: provider, access_level: :admin) }
context 'when requested first' do
before do
subject.current_user_mode.request_admin_mode!
end
it 'cannot be enabled' do
reauthenticate_and_check_admin_mode(expected_admin_mode: false)
expect(response).to redirect_to(new_admin_session_path)
end
end
context 'when not requested first' do
it 'cannot be enabled' do
reauthenticate_and_check_admin_mode(expected_admin_mode: false)
expect(response).to redirect_to(profile_account_path)
end
end
end
end
end
2018-03-17 18:26:18 +05:30
end