Class: Azure::KeyVault::V7_0::Models::JsonWebKey

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/7.0/generated/azure_key_vault/models/json_web_key.rb

Overview

As of tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#crv ⇒ JsonWebKeyCurveName

see JsonWebKeyCurveName. Possible values include: ‘P-256’, ‘P-384’, ‘P-521’, ‘P-256K’

Returns:



59
60
61
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 59

def crv
  @crv
end

#d ⇒ Object

Returns RSA private exponent, or the D component of an EC private key.

Returns:

  • RSA private exponent, or the D component of an EC private key.



33
34
35
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 33

def d
  @d
end

#dp ⇒ Object

Returns RSA private key parameter.

Returns:

  • RSA private key parameter.



36
37
38
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 36

def dp
  @dp
end

#dq ⇒ Object

Returns RSA private key parameter.

Returns:

  • RSA private key parameter.



39
40
41
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 39

def dq
  @dq
end

#e ⇒ Object

Returns RSA public exponent.

Returns:

  • RSA public exponent.



30
31
32
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 30

def e
  @e
end

#k ⇒ Object

Returns Symmetric key.

Returns:

  • Symmetric key.



51
52
53
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 51

def k
  @k
end

#key_ops ⇒ Array<String>

Returns:

  • (Array<String>) 


24
25
26
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 24

def key_ops
  @key_ops
end

#kid ⇒ String

Returns Key identifier.

Returns:

  • (String) —

    Key identifier.



16
17
18
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 16

def kid
  @kid
end

#kty ⇒ JsonWebKeyType

tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include: ‘EC’, ‘EC-HSM’, ‘RSA’, ‘RSA-HSM’, ‘oct’

Returns:



21
22
23
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 21

def kty
  @kty
end

#n ⇒ Object

Returns RSA modulus.

Returns:

  • RSA modulus.



27
28
29
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 27

def n
  @n
end

#p ⇒ Object

Returns RSA secret prime.

Returns:

  • RSA secret prime.



45
46
47
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 45

def p
  @p
end

#q ⇒ Object

Returns RSA secret prime, with p < q.

Returns:

  • RSA secret prime, with p < q.



48
49
50
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 48

def q
  @q
end

#qi ⇒ Object

Returns RSA private key parameter.

Returns:

  • RSA private key parameter.



42
43
44
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 42

def qi
  @qi
end

#t ⇒ Object

Returns HSM Token, used with ‘Bring Your Own Key’.

Returns:

  • HSM Token, used with ‘Bring Your Own Key’.



54
55
56
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 54

def t
  @t
end

#x ⇒ Object

Returns X component of an EC public key.

Returns:

  • X component of an EC public key.



62
63
64
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 62

def x
  @x
end

#y ⇒ Object

Returns Y component of an EC public key.

Returns:

  • Y component of an EC public key.



65
66
67
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 65

def y
  @y
end

Class Method Details

.mapper ⇒ Object

Mapper for JsonWebKey class as Ruby Hash. This will be used for serialization/deserialization.



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
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/7.0/generated/azure_key_vault/models/json_web_key.rb', line 72

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'JsonWebKey',
    type: {
      name: 'Composite',
      class_name: 'JsonWebKey',
      model_properties: {
        kid: {
          client_side_validation: true,
          required: false,
          serialized_name: 'kid',
          type: {
            name: 'String'
          }
        },
        kty: {
          client_side_validation: true,
          required: false,
          serialized_name: 'kty',
          type: {
            name: 'String'
          }
        },
        key_ops: {
          client_side_validation: true,
          required: false,
          serialized_name: 'key_ops',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        n: {
          client_side_validation: true,
          required: false,
          serialized_name: 'n',
          type: {
            name: 'Base64Url'
          }
        },
        e: {
          client_side_validation: true,
          required: false,
          serialized_name: 'e',
          type: {
            name: 'Base64Url'
          }
        },
        d: {
          client_side_validation: true,
          required: false,
          serialized_name: 'd',
          type: {
            name: 'Base64Url'
          }
        },
        dp: {
          client_side_validation: true,
          required: false,
          serialized_name: 'dp',
          type: {
            name: 'Base64Url'
          }
        },
        dq: {
          client_side_validation: true,
          required: false,
          serialized_name: 'dq',
          type: {
            name: 'Base64Url'
          }
        },
        qi: {
          client_side_validation: true,
          required: false,
          serialized_name: 'qi',
          type: {
            name: 'Base64Url'
          }
        },
        p: {
          client_side_validation: true,
          required: false,
          serialized_name: 'p',
          type: {
            name: 'Base64Url'
          }
        },
        q: {
          client_side_validation: true,
          required: false,
          serialized_name: 'q',
          type: {
            name: 'Base64Url'
          }
        },
        k: {
          client_side_validation: true,
          required: false,
          serialized_name: 'k',
          type: {
            name: 'Base64Url'
          }
        },
        t: {
          client_side_validation: true,
          required: false,
          serialized_name: 'key_hsm',
          type: {
            name: 'Base64Url'
          }
        },
        crv: {
          client_side_validation: true,
          required: false,
          serialized_name: 'crv',
          type: {
            name: 'String'
          }
        },
        x: {
          client_side_validation: true,
          required: false,
          serialized_name: 'x',
          type: {
            name: 'Base64Url'
          }
        },
        y: {
          client_side_validation: true,
          required: false,
          serialized_name: 'y',
          type: {
            name: 'Base64Url'
          }
        }
      }
    }
  }
end