debian-mirror-gitlab/spec/lib/gitlab/saml/user_spec.rb

404 lines
14 KiB
Ruby
Raw Normal View History

2016-04-02 18:10:28 +05:30
require 'spec_helper'
2017-09-10 17:25:29 +05:30
describe Gitlab::Saml::User do
2018-03-17 18:26:18 +05:30
include LdapHelpers
include LoginHelpers
2016-04-02 18:10:28 +05:30
let(:saml_user) { described_class.new(auth_hash) }
let(:gl_user) { saml_user.gl_user }
let(:uid) { 'my-uid' }
2018-03-17 18:26:18 +05:30
let(:dn) { 'uid=user1,ou=people,dc=example' }
2016-04-02 18:10:28 +05:30
let(:provider) { 'saml' }
2018-03-17 18:26:18 +05:30
let(:raw_info_attr) { { 'groups' => %w(Developers Freelancers Designers) } }
let(:auth_hash) { OmniAuth::AuthHash.new(uid: uid, provider: provider, info: info_hash, extra: { raw_info: OneLogin::RubySaml::Attributes.new(raw_info_attr) }) }
2016-04-02 18:10:28 +05:30
let(:info_hash) do
{
name: 'John',
email: 'john@mail.com'
}
end
let(:ldap_user) { Gitlab::LDAP::Person.new(Net::LDAP::Entry.new, 'ldapmain') }
describe '#save' do
2017-09-10 17:25:29 +05:30
before do
stub_basic_saml_config
end
2016-06-02 11:05:42 +05:30
2016-04-02 18:10:28 +05:30
describe 'account exists on server' do
2017-09-10 17:25:29 +05:30
before do
stub_omniauth_config({ allow_single_sign_on: ['saml'], auto_link_saml_user: true })
end
2016-06-02 11:05:42 +05:30
let!(:existing_user) { create(:user, email: 'john@mail.com', username: 'john') }
2017-09-10 17:25:29 +05:30
2016-04-02 18:10:28 +05:30
context 'and should bind with SAML' do
it 'adds the SAML identity to the existing user' do
saml_user.save
expect(gl_user).to be_valid
expect(gl_user).to eq existing_user
identity = gl_user.identities.first
expect(identity.extern_uid).to eql uid
expect(identity.provider).to eql 'saml'
end
end
2016-06-02 11:05:42 +05:30
context 'external groups' do
context 'are defined' do
it 'marks the user as external' do
stub_saml_group_config(%w(Freelancers))
saml_user.save
expect(gl_user).to be_valid
expect(gl_user.external).to be_truthy
end
end
2017-09-10 17:25:29 +05:30
before do
stub_saml_group_config(%w(Interns))
end
2016-06-02 11:05:42 +05:30
context 'are defined but the user does not belong there' do
it 'does not mark the user as external' do
saml_user.save
expect(gl_user).to be_valid
expect(gl_user.external).to be_falsey
end
end
context 'user was external, now should not be' do
2016-09-13 17:45:13 +05:30
it 'makes user internal' do
2016-06-02 11:05:42 +05:30
existing_user.update_attribute('external', true)
saml_user.save
expect(gl_user).to be_valid
expect(gl_user.external).to be_falsey
end
end
end
2016-04-02 18:10:28 +05:30
end
describe 'no account exists on server' do
shared_examples 'to verify compliance with allow_single_sign_on' do
context 'with allow_single_sign_on enabled' do
2017-09-10 17:25:29 +05:30
before do
stub_omniauth_config(allow_single_sign_on: ['saml'])
end
2016-04-02 18:10:28 +05:30
it 'creates a user from SAML' do
saml_user.save
expect(gl_user).to be_valid
identity = gl_user.identities.first
expect(identity.extern_uid).to eql uid
expect(identity.provider).to eql 'saml'
end
end
context 'with allow_single_sign_on default (["saml"])' do
2017-09-10 17:25:29 +05:30
before do
stub_omniauth_config(allow_single_sign_on: ['saml'])
end
2016-09-13 17:45:13 +05:30
it 'does not throw an error' do
2018-03-17 18:26:18 +05:30
expect { saml_user.save }.not_to raise_error
2016-04-02 18:10:28 +05:30
end
end
context 'with allow_single_sign_on disabled' do
2017-09-10 17:25:29 +05:30
before do
stub_omniauth_config(allow_single_sign_on: false)
end
2016-09-13 17:45:13 +05:30
it 'throws an error' do
2018-03-17 18:26:18 +05:30
expect { saml_user.save }.to raise_error StandardError
2016-04-02 18:10:28 +05:30
end
end
end
2016-06-02 11:05:42 +05:30
context 'external groups' do
context 'are defined' do
it 'marks the user as external' do
stub_saml_group_config(%w(Freelancers))
saml_user.save
expect(gl_user).to be_valid
expect(gl_user.external).to be_truthy
end
end
context 'are defined but the user does not belong there' do
it 'does not mark the user as external' do
stub_saml_group_config(%w(Interns))
saml_user.save
expect(gl_user).to be_valid
expect(gl_user.external).to be_falsey
end
end
end
2016-04-02 18:10:28 +05:30
context 'with auto_link_ldap_user disabled (default)' do
2017-09-10 17:25:29 +05:30
before do
stub_omniauth_config({ auto_link_ldap_user: false, auto_link_saml_user: false, allow_single_sign_on: ['saml'] })
end
2016-04-02 18:10:28 +05:30
include_examples 'to verify compliance with allow_single_sign_on'
end
context 'with auto_link_ldap_user enabled' do
2017-09-10 17:25:29 +05:30
before do
stub_omniauth_config({ auto_link_ldap_user: true, auto_link_saml_user: false })
end
2016-04-02 18:10:28 +05:30
context 'and at least one LDAP provider is defined' do
2017-09-10 17:25:29 +05:30
before do
stub_ldap_config(providers: %w(ldapmain))
end
2016-04-02 18:10:28 +05:30
context 'and a corresponding LDAP person' do
2018-03-17 18:26:18 +05:30
let(:adapter) { ldap_adapter('ldapmain') }
2016-04-02 18:10:28 +05:30
before do
allow(ldap_user).to receive(:uid) { uid }
allow(ldap_user).to receive(:username) { uid }
2016-06-02 11:05:42 +05:30
allow(ldap_user).to receive(:email) { %w(john@mail.com john2@example.com) }
2018-03-17 18:26:18 +05:30
allow(ldap_user).to receive(:dn) { dn }
allow(Gitlab::LDAP::Adapter).to receive(:new).and_return(adapter)
allow(Gitlab::LDAP::Person).to receive(:find_by_uid).with(uid, adapter).and_return(ldap_user)
allow(Gitlab::LDAP::Person).to receive(:find_by_dn).with(dn, adapter).and_return(ldap_user)
allow(Gitlab::LDAP::Person).to receive(:find_by_email).with('john@mail.com', adapter).and_return(ldap_user)
2016-04-02 18:10:28 +05:30
end
context 'and no account for the LDAP user' do
it 'creates a user with dual LDAP and SAML identities' do
saml_user.save
expect(gl_user).to be_valid
expect(gl_user.username).to eql uid
2016-06-02 11:05:42 +05:30
expect(gl_user.email).to eql 'john@mail.com'
2017-08-17 22:00:37 +05:30
expect(gl_user.identities.length).to be 2
2016-04-02 18:10:28 +05:30
identities_as_hash = gl_user.identities.map { |id| { provider: id.provider, extern_uid: id.extern_uid } }
2018-03-17 18:26:18 +05:30
expect(identities_as_hash).to match_array([{ provider: 'ldapmain', extern_uid: dn },
2017-08-17 22:00:37 +05:30
{ provider: 'saml', extern_uid: uid }])
2016-04-02 18:10:28 +05:30
end
end
context 'and LDAP user has an account already' do
2018-03-17 18:26:18 +05:30
let(:auth_hash_base_attributes) do
{
uid: uid,
provider: provider,
info: info_hash,
extra: {
raw_info: OneLogin::RubySaml::Attributes.new(
{ 'groups' => %w(Developers Freelancers Designers) }
)
}
}
end
let(:auth_hash) { OmniAuth::AuthHash.new(auth_hash_base_attributes) }
let(:uid_types) { %w(uid dn email) }
2016-08-24 12:49:21 +05:30
before do
create(:omniauth_user,
email: 'john@mail.com',
2018-03-17 18:26:18 +05:30
extern_uid: dn,
2016-08-24 12:49:21 +05:30
provider: 'ldapmain',
username: 'john')
end
2018-03-17 18:26:18 +05:30
shared_examples 'find LDAP person' do |uid_type, uid|
let(:auth_hash) { OmniAuth::AuthHash.new(auth_hash_base_attributes.merge(uid: extern_uid)) }
before do
nil_types = uid_types - [uid_type]
nil_types.each do |type|
allow(Gitlab::LDAP::Person).to receive(:"find_by_#{type}").and_return(nil)
end
allow(Gitlab::LDAP::Person).to receive(:"find_by_#{uid_type}").and_return(ldap_user)
end
it 'adds the omniauth identity to the LDAP account' do
identities = [
{ provider: 'ldapmain', extern_uid: dn },
{ provider: 'saml', extern_uid: extern_uid }
]
identities_as_hash = gl_user.identities.map do |id|
{ provider: id.provider, extern_uid: id.extern_uid }
end
saml_user.save
expect(gl_user).to be_valid
expect(gl_user.username).to eql 'john'
expect(gl_user.email).to eql 'john@mail.com'
expect(gl_user.identities.length).to be 2
expect(identities_as_hash).to match_array(identities)
end
end
context 'when uid is an uid' do
it_behaves_like 'find LDAP person', 'uid' do
let(:extern_uid) { uid }
end
end
context 'when uid is a dn' do
it_behaves_like 'find LDAP person', 'dn' do
let(:extern_uid) { dn }
end
end
context 'when uid is an email' do
it_behaves_like 'find LDAP person', 'email' do
let(:extern_uid) { 'john@mail.com' }
end
end
2016-06-02 11:05:42 +05:30
it 'adds the omniauth identity to the LDAP account' do
2016-04-02 18:10:28 +05:30
saml_user.save
expect(gl_user).to be_valid
expect(gl_user.username).to eql 'john'
2016-06-02 11:05:42 +05:30
expect(gl_user.email).to eql 'john@mail.com'
2017-08-17 22:00:37 +05:30
expect(gl_user.identities.length).to be 2
2016-04-02 18:10:28 +05:30
identities_as_hash = gl_user.identities.map { |id| { provider: id.provider, extern_uid: id.extern_uid } }
2018-03-17 18:26:18 +05:30
expect(identities_as_hash).to match_array([{ provider: 'ldapmain', extern_uid: dn },
2017-08-17 22:00:37 +05:30
{ provider: 'saml', extern_uid: uid }])
2016-04-02 18:10:28 +05:30
end
2016-08-24 12:49:21 +05:30
it 'saves successfully on subsequent tries, when both identities are present' do
saml_user.save
local_saml_user = described_class.new(auth_hash)
local_saml_user.save
expect(local_saml_user.gl_user).to be_valid
expect(local_saml_user.gl_user).to be_persisted
end
2016-04-02 18:10:28 +05:30
end
context 'user has SAML user, and wants to add their LDAP identity' do
it 'adds the LDAP identity to the existing SAML user' do
2018-03-17 18:26:18 +05:30
create(:omniauth_user, email: 'john@mail.com', extern_uid: dn, provider: 'saml', username: 'john')
allow(Gitlab::LDAP::Person).to receive(:find_by_uid).with(dn, adapter).and_return(ldap_user)
local_hash = OmniAuth::AuthHash.new(uid: dn, provider: provider, info: info_hash)
local_saml_user = described_class.new(local_hash)
2018-03-17 18:26:18 +05:30
local_saml_user.save
local_gl_user = local_saml_user.gl_user
expect(local_gl_user).to be_valid
2017-08-17 22:00:37 +05:30
expect(local_gl_user.identities.length).to be 2
identities_as_hash = local_gl_user.identities.map { |id| { provider: id.provider, extern_uid: id.extern_uid } }
2018-03-17 18:26:18 +05:30
expect(identities_as_hash).to match_array([{ provider: 'ldapmain', extern_uid: dn },
{ provider: 'saml', extern_uid: dn }])
end
end
2016-04-02 18:10:28 +05:30
end
end
end
2017-08-17 22:00:37 +05:30
context 'when signup is disabled' do
before do
stub_application_setting signup_enabled: false
end
it 'creates the user' do
saml_user.save
expect(gl_user).to be_persisted
end
end
context 'when user confirmation email is enabled' do
before do
stub_application_setting send_user_confirmation_email: true
end
it 'creates and confirms the user anyway' do
saml_user.save
expect(gl_user).to be_persisted
expect(gl_user).to be_confirmed
end
end
2016-04-02 18:10:28 +05:30
end
describe 'blocking' do
2017-09-10 17:25:29 +05:30
before do
stub_omniauth_config({ allow_single_sign_on: ['saml'], auto_link_saml_user: true })
end
2016-04-02 18:10:28 +05:30
context 'signup with SAML only' do
context 'dont block on create' do
2017-09-10 17:25:29 +05:30
before do
stub_omniauth_config(block_auto_created_users: false)
end
2016-04-02 18:10:28 +05:30
2016-09-13 17:45:13 +05:30
it 'does not block the user' do
2016-04-02 18:10:28 +05:30
saml_user.save
expect(gl_user).to be_valid
expect(gl_user).not_to be_blocked
end
end
context 'block on create' do
2017-09-10 17:25:29 +05:30
before do
stub_omniauth_config(block_auto_created_users: true)
end
2016-04-02 18:10:28 +05:30
2016-09-13 17:45:13 +05:30
it 'blocks user' do
2016-04-02 18:10:28 +05:30
saml_user.save
expect(gl_user).to be_valid
expect(gl_user).to be_blocked
end
end
end
context 'sign-in' do
before do
saml_user.save
saml_user.gl_user.activate
end
context 'dont block on create' do
2017-09-10 17:25:29 +05:30
before do
stub_omniauth_config(block_auto_created_users: false)
end
2016-04-02 18:10:28 +05:30
it do
saml_user.save
expect(gl_user).to be_valid
expect(gl_user).not_to be_blocked
end
end
context 'block on create' do
2017-09-10 17:25:29 +05:30
before do
stub_omniauth_config(block_auto_created_users: true)
end
2016-04-02 18:10:28 +05:30
it do
saml_user.save
expect(gl_user).to be_valid
expect(gl_user).not_to be_blocked
end
end
end
end
end
2018-03-17 18:26:18 +05:30
describe '#find_user' do
context 'raw info hash attributes empty' do
let(:raw_info_attr) { {} }
it 'does not mark user as external' do
stub_saml_group_config(%w(Freelancers))
expect(saml_user.find_user.external).to be_falsy
end
end
end
2016-04-02 18:10:28 +05:30
end