Skip to content

Commit 50ef772

Browse files
AbdulboisAbdulbois
authored
Merge pull request #564 from zigbee-alliance/feature/query_noc_root_by_vid_and_ski
Query NOC Root certificates by VID and SKID
2 parents 3ae6b98 + 39a46b3 commit 50ef772

35 files changed

+2971
-552
lines changed

‎docs/static/openapi.yml

+257
Original file line numberDiff line numberDiff line change
@@ -9877,6 +9877,120 @@ paths:
98779877
format: int32
98789878
tags:
98799879
- Query
9880+
/dcl/pki/noc-root-certificates/{vid}/{subjectKeyId}:
9881+
get:
9882+
summary: Queries a NocRootCertificatesByVidAndSkid by index.
9883+
operationId: NocRootCertificatesByVidAndSkid
9884+
responses:
9885+
'200':
9886+
description: A successful response.
9887+
schema:
9888+
type: object
9889+
properties:
9890+
nocRootCertificatesByVidAndSkid:
9891+
type: object
9892+
properties:
9893+
vid:
9894+
type: integer
9895+
format: int32
9896+
subjectKeyId:
9897+
type: string
9898+
certs:
9899+
type: array
9900+
items:
9901+
type: object
9902+
properties:
9903+
pemCert:
9904+
type: string
9905+
serialNumber:
9906+
type: string
9907+
issuer:
9908+
type: string
9909+
authorityKeyId:
9910+
type: string
9911+
rootSubject:
9912+
type: string
9913+
rootSubjectKeyId:
9914+
type: string
9915+
isRoot:
9916+
type: boolean
9917+
owner:
9918+
type: string
9919+
subject:
9920+
type: string
9921+
subjectKeyId:
9922+
type: string
9923+
approvals:
9924+
type: array
9925+
items:
9926+
type: object
9927+
properties:
9928+
address:
9929+
type: string
9930+
time:
9931+
type: string
9932+
format: int64
9933+
info:
9934+
type: string
9935+
subjectAsText:
9936+
type: string
9937+
rejects:
9938+
type: array
9939+
items:
9940+
type: object
9941+
properties:
9942+
address:
9943+
type: string
9944+
time:
9945+
type: string
9946+
format: int64
9947+
info:
9948+
type: string
9949+
vid:
9950+
type: integer
9951+
format: int32
9952+
isNoc:
9953+
type: boolean
9954+
schemaVersion:
9955+
type: integer
9956+
format: int64
9957+
tq:
9958+
type: number
9959+
format: float
9960+
default:
9961+
description: An unexpected error response.
9962+
schema:
9963+
type: object
9964+
properties:
9965+
error:
9966+
type: string
9967+
code:
9968+
type: integer
9969+
format: int32
9970+
message:
9971+
type: string
9972+
details:
9973+
type: array
9974+
items:
9975+
type: object
9976+
properties:
9977+
type_url:
9978+
type: string
9979+
value:
9980+
type: string
9981+
format: byte
9982+
parameters:
9983+
- name: vid
9984+
in: path
9985+
required: true
9986+
type: integer
9987+
format: int32
9988+
- name: subjectKeyId
9989+
in: path
9990+
required: true
9991+
type: string
9992+
tags:
9993+
- Query
98809994
/dcl/pki/proposed-certificates:
98819995
get:
98829996
summary: Queries a list of ProposedCertificate items.
@@ -21814,6 +21928,76 @@ definitions:
2181421928
schemaVersion:
2181521929
type: integer
2181621930
format: int64
21931+
zigbeealliance.distributedcomplianceledger.pki.NocRootCertificatesByVidAndSkid:
21932+
type: object
21933+
properties:
21934+
vid:
21935+
type: integer
21936+
format: int32
21937+
subjectKeyId:
21938+
type: string
21939+
certs:
21940+
type: array
21941+
items:
21942+
type: object
21943+
properties:
21944+
pemCert:
21945+
type: string
21946+
serialNumber:
21947+
type: string
21948+
issuer:
21949+
type: string
21950+
authorityKeyId:
21951+
type: string
21952+
rootSubject:
21953+
type: string
21954+
rootSubjectKeyId:
21955+
type: string
21956+
isRoot:
21957+
type: boolean
21958+
owner:
21959+
type: string
21960+
subject:
21961+
type: string
21962+
subjectKeyId:
21963+
type: string
21964+
approvals:
21965+
type: array
21966+
items:
21967+
type: object
21968+
properties:
21969+
address:
21970+
type: string
21971+
time:
21972+
type: string
21973+
format: int64
21974+
info:
21975+
type: string
21976+
subjectAsText:
21977+
type: string
21978+
rejects:
21979+
type: array
21980+
items:
21981+
type: object
21982+
properties:
21983+
address:
21984+
type: string
21985+
time:
21986+
type: string
21987+
format: int64
21988+
info:
21989+
type: string
21990+
vid:
21991+
type: integer
21992+
format: int32
21993+
isNoc:
21994+
type: boolean
21995+
schemaVersion:
21996+
type: integer
21997+
format: int64
21998+
tq:
21999+
type: number
22000+
format: float
2181722001
zigbeealliance.distributedcomplianceledger.pki.PkiRevocationDistributionPoint:
2181822002
type: object
2181922003
properties:
@@ -22937,6 +23121,79 @@ definitions:
2293723121
schemaVersion:
2293823122
type: integer
2293923123
format: int64
23124+
zigbeealliance.distributedcomplianceledger.pki.QueryGetNocRootCertificatesByVidAndSkidResponse:
23125+
type: object
23126+
properties:
23127+
nocRootCertificatesByVidAndSkid:
23128+
type: object
23129+
properties:
23130+
vid:
23131+
type: integer
23132+
format: int32
23133+
subjectKeyId:
23134+
type: string
23135+
certs:
23136+
type: array
23137+
items:
23138+
type: object
23139+
properties:
23140+
pemCert:
23141+
type: string
23142+
serialNumber:
23143+
type: string
23144+
issuer:
23145+
type: string
23146+
authorityKeyId:
23147+
type: string
23148+
rootSubject:
23149+
type: string
23150+
rootSubjectKeyId:
23151+
type: string
23152+
isRoot:
23153+
type: boolean
23154+
owner:
23155+
type: string
23156+
subject:
23157+
type: string
23158+
subjectKeyId:
23159+
type: string
23160+
approvals:
23161+
type: array
23162+
items:
23163+
type: object
23164+
properties:
23165+
address:
23166+
type: string
23167+
time:
23168+
type: string
23169+
format: int64
23170+
info:
23171+
type: string
23172+
subjectAsText:
23173+
type: string
23174+
rejects:
23175+
type: array
23176+
items:
23177+
type: object
23178+
properties:
23179+
address:
23180+
type: string
23181+
time:
23182+
type: string
23183+
format: int64
23184+
info:
23185+
type: string
23186+
vid:
23187+
type: integer
23188+
format: int32
23189+
isNoc:
23190+
type: boolean
23191+
schemaVersion:
23192+
type: integer
23193+
format: int64
23194+
tq:
23195+
type: number
23196+
format: float
2294023197
zigbeealliance.distributedcomplianceledger.pki.QueryGetNocRootCertificatesResponse:
2294123198
type: object
2294223199
properties:

‎docs/transactions.md

+19
Original file line numberDiff line numberDiff line change
@@ -1482,6 +1482,25 @@ Use [GET_ALL_REVOKED_NOC_ROOT](#get_revoked_noc_root) to get a list of all revok
14821482
- REST API:
14831483
- GET `/dcl/pki/noc-root-certificates/{vid}`
14841484

1485+
#### GET_NOC_ROOT_BY_VID_AND_SKID
1486+
1487+
**Status: Implemented**
1488+
1489+
Retrieve NOC root certificates associated with a specific VID and subject key ID.
1490+
This request also returns the Trust Quotient (TQ) value of the certificate
1491+
1492+
Revoked NOC root certificates are not returned.
1493+
Use [GET_ALL_REVOKED_NOC_ROOT](#get_revoked_noc_root) to get a list of all revoked NOC root certificates.
1494+
1495+
- Who can send: Any account
1496+
- Parameters:
1497+
- vid: `uint16` - Vendor ID (positive non-zero)
1498+
- subject_key_id: `string` - Certificate's `Subject Key Id` in hex string format, e.g., `5A:88:0E:6C:36:53:D0:7F:B0:89:71:A3:F4:73:79:09:30:E6:2B:DB`
1499+
- CLI Command:
1500+
- `dcld query pki noc-x509-root-certs --vid=<uint16> --subject-key-id=<hex string>`
1501+
- REST API:
1502+
- GET `/dcl/pki/noc-root-certificates/{vid}/{subject_key_id}`
1503+
14851504
#### GET_NOC_ICA_BY_VID
14861505

14871506
**Status: Implemented**

0 commit comments

Comments
 (0)