Class: WebAuthn::RelyingParty

Inherits:
Object
  • Object
show all
Defined in:
lib/webauthn/relying_party.rb

Constant Summary collapse

DEFAULT_ALGORITHMS = 
["ES256", "PS256", "RS256"].compact.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(algorithms: DEFAULT_ALGORITHMS.dup, encoding: WebAuthn::Encoder::STANDARD_ENCODING, origin: nil, id: nil, name: nil, verify_attestation_statement: true, credential_options_timeout: 120000, silent_authentication: false, acceptable_attestation_types: ['None', 'Self', 'Basic', 'AttCA', 'Basic_or_AttCA', 'AnonCA'], attestation_root_certificates_finders: [], legacy_u2f_appid: nil) ⇒ RelyingParty

Returns a new instance of RelyingParty.



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
 
# File 'lib/webauthn/relying_party.rb', line 18

def initialize(
  algorithms: DEFAULT_ALGORITHMS.dup,
  encoding: WebAuthn::Encoder::STANDARD_ENCODING,
  origin: nil,
  id: nil,
  name: nil,
  verify_attestation_statement: true,
  credential_options_timeout: 120000,
  silent_authentication: false,
  acceptable_attestation_types: ['None', 'Self', 'Basic', 'AttCA', 'Basic_or_AttCA', 'AnonCA'],
  attestation_root_certificates_finders: [],
  legacy_u2f_appid: nil
)
  @algorithms = algorithms
  @encoding = encoding
  @origin = origin
  @id = id
  @name = name
  @verify_attestation_statement = verify_attestation_statement
  @credential_options_timeout = credential_options_timeout
  @silent_authentication = silent_authentication
  @acceptable_attestation_types = acceptable_attestation_types
  @legacy_u2f_appid = legacy_u2f_appid
  self.attestation_root_certificates_finders = attestation_root_certificates_finders
end

Instance Attribute Details

#acceptable_attestation_types ⇒ Object

Returns the value of attribute acceptable_attestation_types.



44
45
46
 
# File 'lib/webauthn/relying_party.rb', line 44

def acceptable_attestation_types
  @acceptable_attestation_types
end

#algorithms ⇒ Object

Returns the value of attribute algorithms.



44
45
46
 
# File 'lib/webauthn/relying_party.rb', line 44

def algorithms
  @algorithms
end

#attestation_root_certificates_finders ⇒ Object

Returns the value of attribute attestation_root_certificates_finders.



55
56
57
 
# File 'lib/webauthn/relying_party.rb', line 55

def attestation_root_certificates_finders
  @attestation_root_certificates_finders
end

#credential_options_timeout ⇒ Object

Returns the value of attribute credential_options_timeout.



44
45
46
 
# File 'lib/webauthn/relying_party.rb', line 44

def credential_options_timeout
  @credential_options_timeout
end

#encoding ⇒ Object

Returns the value of attribute encoding.



44
45
46
 
# File 'lib/webauthn/relying_party.rb', line 44

def encoding
  @encoding
end

#id ⇒ Object

Returns the value of attribute id.



44
45
46
 
# File 'lib/webauthn/relying_party.rb', line 44

def id
  @id
end

#legacy_u2f_appid ⇒ Object

Returns the value of attribute legacy_u2f_appid.



44
45
46
 
# File 'lib/webauthn/relying_party.rb', line 44

def legacy_u2f_appid
  @legacy_u2f_appid
end

#name ⇒ Object

Returns the value of attribute name.



44
45
46
 
# File 'lib/webauthn/relying_party.rb', line 44

def name
  @name
end

#origin ⇒ Object

Returns the value of attribute origin.



44
45
46
 
# File 'lib/webauthn/relying_party.rb', line 44

def origin
  @origin
end

#silent_authentication ⇒ Object

Returns the value of attribute silent_authentication.



44
45
46
 
# File 'lib/webauthn/relying_party.rb', line 44

def silent_authentication
  @silent_authentication
end

#verify_attestation_statement ⇒ Object

Returns the value of attribute verify_attestation_statement.



44
45
46
 
# File 'lib/webauthn/relying_party.rb', line 44

def verify_attestation_statement
  @verify_attestation_statement
end

Class Method Details

.if_pss_supported(algorithm) ⇒ Object 



12
13
14
 
# File 'lib/webauthn/relying_party.rb', line 12

def self.if_pss_supported(algorithm)
  OpenSSL::PKey::RSA.instance_methods.include?(:verify_pss) ? algorithm : nil
end

Instance Method Details

#encoder ⇒ Object

This is the user-data encoder. Used to decode user input and to encode data provided to the user.



59
60
61
 
# File 'lib/webauthn/relying_party.rb', line 59

def encoder
  @encoder ||= WebAuthn::Encoder.new(encoding)
end

#options_for_authentication(**keyword_arguments) ⇒ Object 



92
93
94
95
96
97
 
# File 'lib/webauthn/relying_party.rb', line 92

def options_for_authentication(**keyword_arguments)
  WebAuthn::Credential.options_for_get(
    **keyword_arguments,
    relying_party: self
  )
end

#options_for_registration(**keyword_arguments) ⇒ Object 



77
78
79
80
81
82
 
# File 'lib/webauthn/relying_party.rb', line 77

def options_for_registration(**keyword_arguments)
  WebAuthn::Credential.options_for_create(
    **keyword_arguments,
    relying_party: self
  )
end

#verify_authentication(raw_credential, challenge, user_presence: nil, user_verification: nil, public_key: nil, sign_count: nil) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/webauthn/relying_party.rb', line 99

def verify_authentication(
  raw_credential,
  challenge,
  user_presence: nil,
  user_verification: nil,
  public_key: nil,
  sign_count: nil
)
  webauthn_credential = WebAuthn::Credential.from_get(raw_credential, relying_party: self)

  stored_credential = yield(webauthn_credential) if block_given?

  if webauthn_credential.verify(
    challenge,
    public_key: public_key || stored_credential.public_key,
    sign_count: sign_count || stored_credential.sign_count,
    user_presence: user_presence,
    user_verification: user_verification
  )
    block_given? ? [webauthn_credential, stored_credential] : webauthn_credential
  end
end

#verify_registration(raw_credential, challenge, user_presence: nil, user_verification: nil) ⇒ Object 



84
85
86
87
88
89
90
 
# File 'lib/webauthn/relying_party.rb', line 84

def verify_registration(raw_credential, challenge, user_presence: nil, user_verification: nil)
  webauthn_credential = WebAuthn::Credential.from_create(raw_credential, relying_party: self)

  if webauthn_credential.verify(challenge, user_presence: user_presence, user_verification: user_verification)
    webauthn_credential
  end
end