Class: Gitlab::Auth::Saml::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/gitlab/auth/saml/config.rb

Constant Summary collapse

DEFAULT_NICKNAME_ATTRS = 
%w[
  username
  nickname
  urn:oid:0.9.2342.19200300.100.1.1
].freeze
DEFAULT_NAME_ATTRS = 
%w[
  http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name
  http://schemas.microsoft.com/ws/2008/06/identity/claims/name
  urn:oid:2.16.840.1.113730.3.1.241
  urn:oid:2.5.4.3
].freeze
DEFAULT_EMAIL_ATTRS = 
%w[
  http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
  http://schemas.microsoft.com/ws/2008/06/identity/claims/emailaddress
  http://schemas.xmlsoap.org/ws/2005/05/identity/claims/email
  http://schemas.microsoft.com/ws/2008/06/identity/claims/email
  urn:oid:0.9.2342.19200300.100.1.3
].freeze
DEFAULT_FIRST_NAME_ATTRS = 
%w[
  http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname
  http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname
  urn:oid:2.5.4.42
].freeze
DEFAULT_LAST_NAME_ATTRS = 
%w[
  http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname
  http://schemas.microsoft.com/ws/2008/06/identity/claims/surname
  urn:oid:2.5.4.4
].freeze
DEFAULT_PROVIDER_NAME = 
'saml'

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider = DEFAULT_PROVIDER_NAME) ⇒ Config

Returns a new instance of Config.



55
56
57
 
# File 'lib/gitlab/auth/saml/config.rb', line 55

def initialize(provider = DEFAULT_PROVIDER_NAME)
  @provider = provider
end

Class Method Details

.default_attribute_statements ⇒ Object 



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/gitlab/auth/saml/config.rb', line 41

def default_attribute_statements
  defaults = OmniAuth::Strategies::SAML.default_options[:attribute_statements].to_hash.deep_symbolize_keys
  defaults[:nickname] = DEFAULT_NICKNAME_ATTRS.dup
  defaults[:name].concat(DEFAULT_NAME_ATTRS)
  defaults[:email].concat(DEFAULT_EMAIL_ATTRS)
  defaults[:first_name].concat(DEFAULT_FIRST_NAME_ATTRS)
  defaults[:last_name].concat(DEFAULT_LAST_NAME_ATTRS)

  defaults
end

.enabled? ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
 
# File 'lib/gitlab/auth/saml/config.rb', line 37

def enabled?
  ::AuthHelper.saml_providers.any?
end

Instance Method Details

#admin_groups ⇒ Object 



75
76
77
 
# File 'lib/gitlab/auth/saml/config.rb', line 75

def admin_groups
  options[:admin_groups]
end

#external_groups ⇒ Object 



71
72
73
 
# File 'lib/gitlab/auth/saml/config.rb', line 71

def external_groups
  options[:external_groups]
end

#groups ⇒ Object 



67
68
69
 
# File 'lib/gitlab/auth/saml/config.rb', line 67

def groups
  options[:groups_attribute]
end

#options ⇒ Object 



59
60
61
 
# File 'lib/gitlab/auth/saml/config.rb', line 59

def options
  Gitlab::Auth::OAuth::Provider.config_for(@provider)
end

#upstream_two_factor_authn_contexts ⇒ Object 



63
64
65
 
# File 'lib/gitlab/auth/saml/config.rb', line 63

def upstream_two_factor_authn_contexts
  options.args[:upstream_two_factor_authn_contexts]
end