Class: SAML::UserAttributes::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/saml/user_attributes/base.rb

Constant Summary collapse

REQUIRED_ATTRIBUTES = 
%i[email uuid idme_uuid sec_id loa sign_in multifactor].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(saml_attributes, authn_context, tracker_uuid) ⇒ Base

Returns a new instance of Base.



10
11
12
13
14
15
 
# File 'lib/saml/user_attributes/base.rb', line 10

def initialize(saml_attributes, authn_context, tracker_uuid)
  @attributes = saml_attributes # never default this to {}
  @authn_context = authn_context
  @tracker_uuid = tracker_uuid
  @warnings = []
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



8
9
10
 
# File 'lib/saml/user_attributes/base.rb', line 8

def attributes
  @attributes
end

#authn_context ⇒ Object (readonly)

Returns the value of attribute authn_context.



8
9
10
 
# File 'lib/saml/user_attributes/base.rb', line 8

def authn_context
  @authn_context
end

#tracker_uuid ⇒ Object (readonly)

Returns the value of attribute tracker_uuid.



8
9
10
 
# File 'lib/saml/user_attributes/base.rb', line 8

def tracker_uuid
  @tracker_uuid
end

#warnings ⇒ Object (readonly)

Returns the value of attribute warnings.



8
9
10
 
# File 'lib/saml/user_attributes/base.rb', line 8

def warnings
  @warnings
end

Instance Method Details

#account_type ⇒ Object (private) 



73
74
75
 
# File 'lib/saml/user_attributes/base.rb', line 73

def 
  existing_user_identity? ? existing_user_identity.[:account_type] : 'N/A'
end

#common_name ⇒ Object 



36
37
38
 
# File 'lib/saml/user_attributes/base.rb', line 36

def common_name
  email
end

#email ⇒ Object

ID.me email address associated with the signed-in ‘wallet’



32
33
34
 
# File 'lib/saml/user_attributes/base.rb', line 32

def email
  attributes['email']
end

#existing_user_identity ⇒ Object (private) 



77
78
79
80
81
 
# File 'lib/saml/user_attributes/base.rb', line 77

def existing_user_identity
  return @_existing_user_identity if defined?(@_existing_user_identity)

  @_existing_user_identity = UserIdentity.find(idme_uuid)
end

#existing_user_identity? ⇒ Boolean (private)

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/saml/user_attributes/base.rb', line 83

def existing_user_identity?
  existing_user_identity.present?
end

#idme_loa ⇒ Object

ID.me level of assurance, provided by all authn_contexts



41
42
43
 
# File 'lib/saml/user_attributes/base.rb', line 41

def idme_loa
  attributes['level_of_assurance']&.to_i
end

#idme_uuid ⇒ Object 



23
24
25
 
# File 'lib/saml/user_attributes/base.rb', line 23

def idme_uuid
  attributes['uuid']
end

#loa ⇒ Object

This field is derived from methods implemented on child classes



51
52
53
 
# File 'lib/saml/user_attributes/base.rb', line 51

def loa
  { current: loa_current, highest: loa_highest }
end

#multifactor ⇒ Object

ID.me boolean value that specifies whether the signed-in ‘wallet’ has multifactor enabled or not



46
47
48
 
# File 'lib/saml/user_attributes/base.rb', line 46

def multifactor
  attributes['multifactor']
end

#sec_id ⇒ Object 



27
28
29
 
# File 'lib/saml/user_attributes/base.rb', line 27

def sec_id
  nil
end

#sign_in ⇒ Object

This includes service_name used to sign-in initially, and the account type that is associated with the sign in.



56
57
58
59
60
61
62
 
# File 'lib/saml/user_attributes/base.rb', line 56

def 
  SAML::User::AUTHN_CONTEXTS.fetch(authn_context)
                            .fetch(:sign_in)
                            .merge(account_type:)
rescue
  { service_name: 'unknown', account_type: 'N/A' }
end

#to_hash ⇒ Object 



64
65
66
 
# File 'lib/saml/user_attributes/base.rb', line 64

def to_hash
  serializable_attributes.index_with { |k| send(k) }
end

#uuid ⇒ Object

Common Attributes ID.me unique identifier



19
20
21
 
# File 'lib/saml/user_attributes/base.rb', line 19

def uuid
  idme_uuid
end

#validate! ⇒ Object

Raise any fatal exceptions due to validation issues



69
 
# File 'lib/saml/user_attributes/base.rb', line 69

def validate!; end