Class: OryClient::DeviceAuthnKey

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/device_authn_key.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ DeviceAuthnKey

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



120
121
122
123
124
125
126
127
128
129
130
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/ory-client/models/device_authn_key.rb', line 120

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::DeviceAuthnKey` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::DeviceAuthnKey`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'attestation')
    self.attestation = attributes[:'attestation']
  end

  if attributes.key?(:'client_key_id')
    self.client_key_id = attributes[:'client_key_id']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'device_name')
    self.device_name = attributes[:'device_name']
  end

  if attributes.key?(:'device_type')
    self.device_type = attributes[:'device_type']
  end

  if attributes.key?(:'pin')
    self.pin = attributes[:'pin']
  end

  if attributes.key?(:'public_key')
    if (value = attributes[:'public_key']).is_a?(Array)
      self.public_key = value
    end
  end

  if attributes.key?(:'relaxed_attestation_expires_at')
    self.relaxed_attestation_expires_at = attributes[:'relaxed_attestation_expires_at']
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.key?(:'user_verification')
    self.user_verification = attributes[:'user_verification']
  end

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  end
end

Instance Attribute Details

#attestation ⇒ Object

Returns the value of attribute attestation.



18
19
20
 
# File 'lib/ory-client/models/device_authn_key.rb', line 18

def attestation
  @attestation
end

#client_key_id ⇒ Object

ClientKeyID is the key's stable, unique-per-identity id, computed as hex(SHA-256(PublicKey)) — the lowercase-hex SHA-256 digest of the public key's PKIX, ASN.1 DER (SubjectPublicKeyInfo) encoding, exactly the bytes stored in PublicKey. It is a deterministic fingerprint of the enrolled signing key, so the device recomputes the identical value locally instead of receiving it from the server. Keys enrolled before the server derived the id keep their original client-chosen value.



21
22
23
 
# File 'lib/ory-client/models/device_authn_key.rb', line 21

def client_key_id
  @client_key_id
end

#created_at ⇒ Object

CreatedAt is the timestamp of when the key was created. Only used for troubleshooting/UI.



24
25
26
 
# File 'lib/ory-client/models/device_authn_key.rb', line 24

def created_at
  @created_at
end

#device_name ⇒ Object

DeviceName is a human readable name for the device, helping the user to distinguish it from others.



27
28
29
 
# File 'lib/ory-client/models/device_authn_key.rb', line 27

def device_name
  @device_name
end

#device_type ⇒ Object

Returns the value of attribute device_type.



29
30
31
 
# File 'lib/ory-client/models/device_authn_key.rb', line 29

def device_type
  @device_type
end

#pin ⇒ Object

Returns the value of attribute pin.



31
32
33
 
# File 'lib/ory-client/models/device_authn_key.rb', line 31

def pin
  @pin
end

#public_key ⇒ Object

PublicKey is the device's public key (EC P-256 in v1), used to verify signatures. It is stored in PKIX, ASN.1 DER form (the SubjectPublicKeyInfo encoding produced by x509.MarshalPKIXPublicKey). The private key resides inside the device and does not exist on the server.



34
35
36
 
# File 'lib/ory-client/models/device_authn_key.rb', line 34

def public_key
  @public_key
end

#relaxed_attestation_expires_at ⇒ Object

RelaxedAttestationExpiresAt is set only when the key's attestation chain validated because relaxed attestation was allowed (software roots, expired certs, software security level) rather than under strict rules. Such keys are second-class: they are refused at login after this time, or immediately if relaxed attestation is turned off. It is nil for hardware-attested keys that pass strict validation.



37
38
39
 
# File 'lib/ory-client/models/device_authn_key.rb', line 37

def relaxed_attestation_expires_at
  @relaxed_attestation_expires_at
end

#state ⇒ Object

Returns the value of attribute state.



39
40
41
 
# File 'lib/ory-client/models/device_authn_key.rb', line 39

def state
  @state
end

#user_verification ⇒ Object

Returns the value of attribute user_verification.



41
42
43
 
# File 'lib/ory-client/models/device_authn_key.rb', line 41

def user_verification
  @user_verification
end

#version ⇒ Object

v1 uses SHA256 + EC256. v2 (in the future) may use ML-DSA which is post-quantum resistant. This requires Android/iOS support so we have to wait. We intentionally avoid storing the cryptographic algorithm here a la JWT/TLS to avoid security issues and algorithm negotiation.



44
45
46
 
# File 'lib/ory-client/models/device_authn_key.rb', line 44

def version
  @version
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



86
87
88
 
# File 'lib/ory-client/models/device_authn_key.rb', line 86

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/ory-client/models/device_authn_key.rb', line 91

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/ory-client/models/device_authn_key.rb', line 69

def self.attribute_map
  {
    :'attestation' => :'attestation',
    :'client_key_id' => :'client_key_id',
    :'created_at' => :'created_at',
    :'device_name' => :'device_name',
    :'device_type' => :'device_type',
    :'pin' => :'pin',
    :'public_key' => :'public_key',
    :'relaxed_attestation_expires_at' => :'relaxed_attestation_expires_at',
    :'state' => :'state',
    :'user_verification' => :'user_verification',
    :'version' => :'version'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/ory-client/models/device_authn_key.rb', line 229

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
 
# File 'lib/ory-client/models/device_authn_key.rb', line 113

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ory-client/models/device_authn_key.rb', line 96

def self.openapi_types
  {
    :'attestation' => :'DeviceAuthnAttestation',
    :'client_key_id' => :'String',
    :'created_at' => :'Time',
    :'device_name' => :'String',
    :'device_type' => :'String',
    :'pin' => :'PINConfig',
    :'public_key' => :'Array<Integer>',
    :'relaxed_attestation_expires_at' => :'Time',
    :'state' => :'String',
    :'user_verification' => :'UserVerification',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ory-client/models/device_authn_key.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attestation == o.attestation &&
      client_key_id == o.client_key_id &&
      created_at == o.created_at &&
      device_name == o.device_name &&
      device_type == o.device_type &&
      pin == o.pin &&
      public_key == o.public_key &&
      relaxed_attestation_expires_at == o.relaxed_attestation_expires_at &&
      state == o.state &&
      user_verification == o.user_verification &&
      version == o.version
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


216
217
218
 
# File 'lib/ory-client/models/device_authn_key.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



222
223
224
 
# File 'lib/ory-client/models/device_authn_key.rb', line 222

def hash
  [attestation, client_key_id, created_at, device_name, device_type, pin, public_key, relaxed_attestation_expires_at, state, user_verification, version].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



183
184
185
186
187
 
# File 'lib/ory-client/models/device_authn_key.rb', line 183

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/ory-client/models/device_authn_key.rb', line 251

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



191
192
193
194
 
# File 'lib/ory-client/models/device_authn_key.rb', line 191

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end