Class: OryHydraClient::JsonWebKey

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-hydra-client/models/json_web_key.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JsonWebKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



116
117
118
119
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 116

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

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

  if attributes.key?(:'alg')
    self.alg = attributes[:'alg']
  else
    self.alg = nil
  end

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

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

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

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

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

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

  if attributes.key?(:'kid')
    self.kid = attributes[:'kid']
  else
    self.kid = nil
  end

  if attributes.key?(:'kty')
    self.kty = attributes[:'kty']
  else
    self.kty = nil
  end

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

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

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

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

  if attributes.key?(:'use')
    self.use = attributes[:'use']
  else
    self.use = nil
  end

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

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

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

Instance Attribute Details

#alg ⇒ Object

The "alg" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA "JSON Web Signature and Encryption Algorithms" registry established by [JWA] or be a value that contains a Collision- Resistant Name.



19
20
21
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 19

def alg
  @alg
end

#crv ⇒ Object

Returns the value of attribute crv.



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

def crv
  @crv
end

#d ⇒ Object

Returns the value of attribute d.



23
24
25
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 23

def d
  @d
end

#dp ⇒ Object

Returns the value of attribute dp.



25
26
27
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 25

def dp
  @dp
end

#dq ⇒ Object

Returns the value of attribute dq.



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

def dq
  @dq
end

#e ⇒ Object

Returns the value of attribute e.



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

def e
  @e
end

#k ⇒ Object

Returns the value of attribute k.



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

def k
  @k
end

#kid ⇒ Object

The "kid" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the "kid" value is unspecified. When "kid" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct "kid" values. (One example in which different keys might use the same "kid" value is if they have different "kty" (key type) values but are considered to be equivalent alternatives by the application using them.) The "kid" value is a case-sensitive string.



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

def kid
  @kid
end

#kty ⇒ Object

The "kty" (key type) parameter identifies the cryptographic algorithm family used with the key, such as "RSA" or "EC". "kty" values should either be registered in the IANA "JSON Web Key Types" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The "kty" value is a case-sensitive string.



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

def kty
  @kty
end

#n ⇒ Object

Returns the value of attribute n.



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

def n
  @n
end

#p ⇒ Object

Returns the value of attribute p.



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

def p
  @p
end

#q ⇒ Object

Returns the value of attribute q.



43
44
45
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 43

def q
  @q
end

#qi ⇒ Object

Returns the value of attribute qi.



45
46
47
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 45

def qi
  @qi
end

#use ⇒ Object

Use ("public key use") identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly "sig" (signature) or "enc" (encryption).



48
49
50
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 48

def use
  @use
end

#x ⇒ Object

Returns the value of attribute x.



50
51
52
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 50

def x
  @x
end

#x5c ⇒ Object

The "x5c" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (Section 4 of [RFC4648] – not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate.



53
54
55
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 53

def x5c
  @x5c
end

#y ⇒ Object

Returns the value of attribute y.



55
56
57
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 55

def y
  @y
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 306

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = OryHydraClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 58

def self.attribute_map
  {
    :'alg' => :'alg',
    :'crv' => :'crv',
    :'d' => :'d',
    :'dp' => :'dp',
    :'dq' => :'dq',
    :'e' => :'e',
    :'k' => :'k',
    :'kid' => :'kid',
    :'kty' => :'kty',
    :'n' => :'n',
    :'p' => :'p',
    :'q' => :'q',
    :'qi' => :'qi',
    :'use' => :'use',
    :'x' => :'x',
    :'x5c' => :'x5c',
    :'y' => :'y'
  }
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 282

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



109
110
111
112
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 86

def self.openapi_types
  {
    :'alg' => :'String',
    :'crv' => :'String',
    :'d' => :'String',
    :'dp' => :'String',
    :'dq' => :'String',
    :'e' => :'String',
    :'k' => :'String',
    :'kid' => :'String',
    :'kty' => :'String',
    :'n' => :'String',
    :'p' => :'String',
    :'q' => :'String',
    :'qi' => :'String',
    :'use' => :'String',
    :'x' => :'String',
    :'x5c' => :'Array<String>',
    :'y' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 245

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alg == o.alg &&
      crv == o.crv &&
      d == o.d &&
      dp == o.dp &&
      dq == o.dq &&
      e == o.e &&
      k == o.k &&
      kid == o.kid &&
      kty == o.kty &&
      n == o.n &&
      p == o.p &&
      q == o.q &&
      qi == o.qi &&
      use == o.use &&
      x == o.x &&
      x5c == o.x5c &&
      y == o.y
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 377

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


269
270
271
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



275
276
277
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 275

def hash
  [alg, crv, d, dp, dq, e, k, kid, kty, n, p, q, qi, use, x, x5c, y].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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 210

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @alg.nil?
    invalid_properties.push('invalid value for "alg", alg cannot be nil.')
  end

  if @kid.nil?
    invalid_properties.push('invalid value for "kid", kid cannot be nil.')
  end

  if @kty.nil?
    invalid_properties.push('invalid value for "kty", kty cannot be nil.')
  end

  if @use.nil?
    invalid_properties.push('invalid value for "use", use cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



353
354
355
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 353

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 359

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



347
348
349
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 347

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



234
235
236
237
238
239
240
241
 
# File 'lib/ory-hydra-client/models/json_web_key.rb', line 234

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @alg.nil?
  return false if @kid.nil?
  return false if @kty.nil?
  return false if @use.nil?
  true
end