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.



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

def initialize
  clear
end

Instance Attribute Details

#attestation ⇒ Object

Returns the value of attribute attestation.



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

def attestation
  @attestation
end

#authenticator_selection ⇒ Object

Returns the value of attribute authenticator_selection.



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

def authenticator_selection
  @authenticator_selection
end

#challenge ⇒ Object

When this field is expressed as a WebAuthnPublicKeyCredentialCreationOptions class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.



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

def challenge
  @challenge
end

#credential_exclude_list ⇒ Object

Returns the value of attribute credential_exclude_list.



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

def credential_exclude_list
  @credential_exclude_list
end

#extensions ⇒ Object

Returns the value of attribute extensions.



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

def extensions
  @extensions
end

#parameters ⇒ Object

Returns the value of attribute parameters.



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

def parameters
  @parameters
end

#relying_party ⇒ Object

Returns the value of attribute relying_party.



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

def relying_party
  @relying_party
end

#timeout ⇒ Object

Returns the value of attribute timeout.



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

def timeout
  @timeout
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#user ⇒ Object

Returns the value of attribute user.



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

def user
  @user
end

Instance Method Details

#clear ⇒ Object 



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

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) 


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
129
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 72

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) 


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

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



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

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



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
159
 
# File 'lib/comet/models/web_authn_public_key_credential_creation_options.rb', line 132

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



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

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