Class: Comet::WebAuthnPublicKeyCredentialCreationOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/web_authn_public_key_credential_creation_options.rb

Overview

WebAuthnPublicKeyCredentialCreationOptions is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WebAuthnPublicKeyCredentialCreationOptions

Returns a new instance of WebAuthnPublicKeyCredentialCreationOptions.



46
47
48
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 46

def initialize
  clear
end

Instance Attribute Details

#attestation ⇒ Object

Returns the value of attribute attestation.



41
42
43
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 41

def attestation
  @attestation
end

#authenticator_selection ⇒ Object

Returns the value of attribute authenticator_selection.



29
30
31
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 29

def authenticator_selection
  @authenticator_selection
end

#challenge ⇒ Object

Returns the value of attribute challenge.



17
18
19
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 17

def challenge
  @challenge
end

#credential_exclude_list ⇒ Object

Returns the value of attribute credential_exclude_list.



35
36
37
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 35

def credential_exclude_list
  @credential_exclude_list
end

#extensions ⇒ Object

Returns the value of attribute extensions.



38
39
40
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 38

def extensions
  @extensions
end

#parameters ⇒ Object

Returns the value of attribute parameters.



26
27
28
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 26

def parameters
  @parameters
end

#relying_party ⇒ Object

Returns the value of attribute relying_party.



20
21
22
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 20

def relying_party
  @relying_party
end

#timeout ⇒ Object

Returns the value of attribute timeout.



32
33
34
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 32

def timeout
  @timeout
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



44
45
46
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 44

def unknown_json_fields
  @unknown_json_fields
end

#user ⇒ Object

Returns the value of attribute user.



23
24
25
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 23

def user
  @user
end

Instance Method Details

#clear ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 50

def clear
  @challenge = []
  @relying_party = Comet::WebAuthnRelyingPartyEntity.new
  @user = Comet::WebAuthnUserEntity.new
  @parameters = []
  @authenticator_selection = Comet::WebAuthnAuthenticatorSelection.new
  @timeout = 0
  @credential_exclude_list = []
  @extensions = {}
  @attestation = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 71

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'challenge'
      @challenge = Base64.decode64(v)
    when 'rp'
      @relying_party = Comet::WebAuthnRelyingPartyEntity.new
      @relying_party.from_hash(v)
    when 'user'
      @user = Comet::WebAuthnUserEntity.new
      @user.from_hash(v)
    when 'pubKeyCredParams'
      if v.nil?
        @parameters = []
      else
        @parameters = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @parameters[i1] = Comet::WebAuthnCredentialParameter.new
          @parameters[i1].from_hash(v1)
        end
      end
    when 'authenticatorSelection'
      @authenticator_selection = Comet::WebAuthnAuthenticatorSelection.new
      @authenticator_selection.from_hash(v)
    when 'timeout'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @timeout = v
    when 'excludeCredentials'
      if v.nil?
        @credential_exclude_list = []
      else
        @credential_exclude_list = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @credential_exclude_list[i1] = Comet::WebAuthnCredentialDescriptor.new
          @credential_exclude_list[i1].from_hash(v1)
        end
      end
    when 'extensions'
      @extensions = {}
      if v.nil?
        @extensions = {}
      else
        v.each do |k1, v1|
          @extensions[k1] = v1
        end
      end
    when 'attestation'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @attestation = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


64
65
66
67
68
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 64

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



161
162
163
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 161

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 131

def to_hash
  ret = {}
  ret['challenge'] = Base64.strict_encode64(@challenge)
  ret['rp'] = @relying_party
  ret['user'] = @user
  unless @parameters.nil?
    ret['pubKeyCredParams'] = @parameters
  end
  unless @authenticator_selection.nil?
    ret['authenticatorSelection'] = @authenticator_selection
  end
  unless @timeout.nil?
    ret['timeout'] = @timeout
  end
  unless @credential_exclude_list.nil?
    ret['excludeCredentials'] = @credential_exclude_list
  end
  unless @extensions.nil?
    ret['extensions'] = @extensions
  end
  unless @attestation.nil?
    ret['attestation'] = @attestation
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



166
167
168
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 166

def to_json(options = {})
  to_hash.to_json(options)
end