1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/Certificate.v1_5_0.json",
"$ref": "#/definitions/Certificate",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2021 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"Actions": {
"additionalProperties": false,
"description": "The available actions for this resource.",
"longDescription": "This type shall contain the available actions for this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"#Certificate.Rekey": {
"$ref": "#/definitions/Rekey"
},
"#Certificate.Renew": {
"$ref": "#/definitions/Renew"
},
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "The available OEM-specific actions for this resource.",
"longDescription": "This property shall contain the available OEM-specific actions for this resource."
}
},
"type": "object"
},
"Certificate": {
"additionalProperties": false,
"description": "The Certificate schema describes a certificate that proves the identify of a component, account, or service.",
"longDescription": "This resource shall represent a certificate for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this resource.",
"longDescription": "This property shall contain the available actions for this resource."
},
"CertificateString": {
"description": "The string for the certificate.",
"longDescription": "This property shall contain the certificate, and the format shall follow the requirements specified by the CertificateType property value. If the certificate contains any private keys, they shall be removed from the string in responses. If the service does not know the private key for the certificate and is needed to use the certificate, the client shall provide the private key as part of the string in the POST request.",
"readonly": true,
"type": [
"string",
"null"
]
},
"CertificateType": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/CertificateType"
},
{
"type": "null"
}
],
"description": "The format of the certificate.",
"longDescription": "This property shall contain the format type for the certificate.",
"readonly": true
},
"CertificateUsageTypes": {
"description": "The types or purposes for this certificate.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/CertificateUsageType"
},
{
"type": "null"
}
]
},
"longDescription": "The value of this property shall contain an array describing the types or purposes for this certificate.",
"readonly": true,
"type": "array",
"versionAdded": "v1_4_0"
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"Fingerprint": {
"description": "The fingerprint of the certificate.",
"longDescription": "The value of this property shall be a string containing the ASCII representation of the fingerprint of the certificate. The hash algorithm used to generate this fingerprint shall be specified by the FingerprintHashAlgorithm property.",
"pattern": "^([0-9A-Fa-f]{2}:){0,}([0-9A-Fa-f]{2})$",
"readonly": true,
"type": "string",
"versionAdded": "v1_3_0"
},
"FingerprintHashAlgorithm": {
"description": "The hash algorithm for the fingerprint of the certificate.",
"longDescription": "The value of this property shall be a string containing the hash algorithm used for generating the Fingerprint property. The value shall be one of the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm Registry'.",
"readonly": true,
"type": "string",
"versionAdded": "v1_3_0"
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Issuer": {
"$ref": "#/definitions/Identifier",
"description": "The issuer of the certificate.",
"longDescription": "This property shall contain an object containing information about the issuer of the certificate."
},
"KeyUsage": {
"description": "The key usage extension, which defines the purpose of the public keys in this certificate.",
"items": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/KeyUsage"
},
{
"type": "null"
}
]
},
"longDescription": "This property shall contain the key usage extension, which defines the purpose of the public keys in this certificate.",
"readonly": true,
"type": "array"
},
"Links": {
"$ref": "#/definitions/Links",
"description": "The links to other resources that are related to this resource.",
"longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
"versionAdded": "v1_4_0"
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
},
"SPDM": {
"anyOf": [
{
"$ref": "#/definitions/SPDM"
},
{
"type": "null"
}
],
"description": "SPDM-related information for the certificate.",
"longDescription": "The value of this property shall contain SPDM-related information for the certificate. This property shall only be present for SPDM certificates.",
"versionAdded": "v1_5_0"
},
"SerialNumber": {
"description": "The serial number of the certificate.",
"longDescription": "The value of this property shall be a string containing the ASCII representation of the serial number of the certificate, as defined by the RFC5280 'serialNumber' field.",
"pattern": "^([0-9A-Fa-f]{2}:){0,}([0-9A-Fa-f]{2})$",
"readonly": true,
"type": "string",
"versionAdded": "v1_3_0"
},
"SignatureAlgorithm": {
"description": "The algorithm used for creating the signature of the certificate.",
"longDescription": "The value of this property shall be a string containing the algorithm used for generating the signature of the certificate, as defined by the RFC5280 'signatureAlgorithm' field. The value shall be a string representing the ASN.1 OID of the signature algorithm as defined in, but not limited to, RFC3279, RFC4055, or RFC4491.",
"readonly": true,
"type": "string",
"versionAdded": "v1_3_0"
},
"Subject": {
"$ref": "#/definitions/Identifier",
"description": "The subject of the certificate.",
"longDescription": "This property shall contain an object containing information about the subject of the certificate."
},
"UefiSignatureOwner": {
"description": "The UEFI signature owner for this certificate.",
"longDescription": "The value of this property shall contain the GUID of the UEFI signature owner for this certificate as defined by the UEFI Specification. This property shall only be present for certificates managed by UEFI.",
"pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_2_0"
},
"ValidNotAfter": {
"description": "The date when the certificate is no longer valid.",
"format": "date-time",
"longDescription": "This property shall contain the date when the certificate validity period ends.",
"readonly": true,
"type": "string"
},
"ValidNotBefore": {
"description": "The date when the certificate becomes valid.",
"format": "date-time",
"longDescription": "This property shall contain the date when the certificate validity period begins.",
"readonly": true,
"type": "string"
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"requiredOnCreate": [
"CertificateString",
"CertificateType"
],
"type": "object"
},
"CertificateUsageType": {
"enum": [
"User",
"Web",
"SSH",
"Device",
"Platform",
"BIOS"
],
"enumDescriptions": {
"BIOS": "This certificate is a BIOS certificate like those associated with UEFI.",
"Device": "This certificate is a device type certificate like those associated with SPDM and other standards.",
"Platform": "This certificate is a platform type certificate like those associated with SPDM and other standards.",
"SSH": "This certificate is used for SSH.",
"User": "This certificate is a user certificate like those associated with a manager account.",
"Web": "This certificate is a web or HTTPS certificate like those used for event destinations."
},
"type": "string"
},
"Identifier": {
"additionalProperties": false,
"description": "The identifier information about a certificate.",
"longDescription": "This type shall contain the properties that identifies the issuer or subject of a certificate.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"City": {
"description": "The city or locality of the organization of the entity.",
"longDescription": "This property shall contain the city or locality of the organization of the entity.",
"readonly": true,
"type": "string"
},
"CommonName": {
"description": "The fully qualified domain name of the entity.",
"longDescription": "This property shall contain the fully qualified domain name of the entity.",
"readonly": true,
"type": "string"
},
"Country": {
"description": "The country of the organization of the entity.",
"longDescription": "This property shall contain the two-letter ISO code for the country of the organization of the entity.",
"readonly": true,
"type": "string"
},
"Email": {
"description": "The email address of the contact within the organization of the entity.",
"longDescription": "This property shall contain the email address of the contact within the organization of the entity.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Organization": {
"description": "The name of the organization of the entity.",
"longDescription": "This property shall contain the name of the organization of the entity.",
"readonly": true,
"type": "string"
},
"OrganizationalUnit": {
"description": "The name of the unit or division of the organization of the entity.",
"longDescription": "This property shall contain the name of the unit or division of the organization of the entity.",
"readonly": true,
"type": "string"
},
"State": {
"description": "The state, province, or region of the organization of the entity.",
"longDescription": "This property shall contain the state, province, or region of the organization of the entity.",
"readonly": true,
"type": "string"
}
},
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "The links to other resources that are related to this resource.",
"longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Issuer": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate"
},
{
"type": "null"
}
],
"description": "A link to the certificate of the CA that issued this certificate.",
"longDescription": "This property shall contain a link to a resources of type Certificate that represents the certificate of the CA that issued this certificate.",
"readonly": false,
"versionAdded": "v1_4_0"
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
},
"Subjects": {
"description": "An array of links to certificates that were issued by the CA that is represented by this certificate.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate"
},
"longDescription": "This property shall contain an array of links to resources of type Certificate that were issued by the CA that is represented by this certificate.",
"readonly": false,
"type": "array",
"versionAdded": "v1_4_0"
},
"Subjects@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
}
},
"type": "object"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM-specific actions for this resource.",
"longDescription": "This type shall contain the available OEM-specific actions for this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {},
"type": "object"
},
"Rekey": {
"actionResponse": {
"$ref": "#/definitions/RekeyResponse"
},
"additionalProperties": false,
"description": "This action generates a new key-pair for a certificate and produces a certificate signing request.",
"longDescription": "This action shall use the certificate data to generate a new key-pair for a certificate. The response shall contain a signing request that a certificate authority (CA) will sign. The service should retain the private key that generated this request for installation of the certificate. The private key should not be part of the response. The private key should not be part of the response.",
"parameters": {
"ChallengePassword": {
"description": "The challenge password to apply to the certificate for revocation requests.",
"longDescription": "This property shall contain the challenge password to apply to the certificate for revocation requests as defined by the RFC2985 'challengePassword' attribute.",
"type": "string"
},
"KeyBitLength": {
"description": "The length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value.",
"longDescription": "This parameter shall contain the length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value.",
"type": "integer"
},
"KeyCurveId": {
"description": "The curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value.",
"longDescription": "This parameter shall contain the curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value. The allowable values for this parameter shall be the strings in the 'Name' field of the 'TPM_ECC_CURVE Constants' table within the 'Trusted Computing Group Algorithm Registry'.",
"type": "string"
},
"KeyPairAlgorithm": {
"description": "The type of key-pair for use with signing algorithms.",
"longDescription": "This parameter shall contain the type of key-pair for use with signing algorithms. The allowable values for this parameter shall be the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm Registry'.",
"type": "string"
}
},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri-reference",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object",
"versionAdded": "v1_1_0"
},
"RekeyResponse": {
"additionalProperties": false,
"description": "The response body for the Rekey action.",
"longDescription": "This type shall contain the properties found in the response body for the Rekey action.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"CSRString": {
"description": "The string for the certificate signing request.",
"longDescription": "This property shall contain the certificate signing request as a PEM-encoded string, containing structures specified by RFC2986. The private key should not be part of the string.",
"readonly": true,
"type": "string",
"versionAdded": "v1_1_0"
},
"Certificate": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate",
"description": "The link to the certificate being rekeyed.",
"longDescription": "This property shall contain a link to a resource of type Certificate that is replaced after the certificate authority (CA) signs the certificate.",
"readonly": true,
"versionAdded": "v1_1_0"
}
},
"required": [
"Certificate",
"CSRString"
],
"type": "object"
},
"Renew": {
"actionResponse": {
"$ref": "#/definitions/RenewResponse"
},
"additionalProperties": false,
"description": "This action generates a certificate signing request by using the existing information and key-pair of the certificate.",
"longDescription": "This action shall generate a certificate signing request using the existing information and key-pair of the certificate. The response shall contain a signing request that a certificate authority (CA) will sign. The service should retain the private key that this request generates for when the certificate is installed. The private key should not be part of the response.",
"parameters": {
"ChallengePassword": {
"description": "The challenge password to apply to the certificate for revocation requests.",
"longDescription": "This property shall contain the challenge password to apply to the certificate for revocation requests as defined by the RFC2985 'challengePassword' attribute.",
"type": "string"
}
},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri-reference",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object",
"versionAdded": "v1_1_0"
},
"RenewResponse": {
"additionalProperties": false,
"description": "The response body for the Renew action.",
"longDescription": "This type shall contain the properties found in the response body for the Renew action.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"CSRString": {
"description": "The string for the certificate signing request.",
"longDescription": "This property shall contain the certificate signing request as a PEM-encoded string, containing structures specified by RFC2986. The private key should not be part of the string.",
"readonly": true,
"type": "string",
"versionAdded": "v1_1_0"
},
"Certificate": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/Certificate",
"description": "The link to the certificate being renewed.",
"longDescription": "This property shall contain a link to a resource of type Certificate that is replaced after the certificate authority (CA) signs the certificate.",
"readonly": true,
"versionAdded": "v1_1_0"
}
},
"required": [
"Certificate",
"CSRString"
],
"type": "object"
},
"SPDM": {
"additionalProperties": false,
"description": "SPDM-related information for a certificate.",
"longDescription": "This type shall contain contain SPDM-related information for a certificate.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"SlotId": {
"description": "Slot identifier of the certificate.",
"longDescription": "The value of this property shall contain an integer between 0 and 7, inclusive, that represents the slot identifier for an SPDM-provided certificate.",
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_5_0"
}
},
"type": "object"
}
},
"owningEntity": "DMTF",
"release": "2021.3",
"title": "#Certificate.v1_5_0.Certificate"
}
|
