Skip to content

Commit 2fb61cd

Browse files
paulbastianc2bo
andauthored
extend requirements for IANA registries (#356)
* extend requirements for IANA registries * Apply suggestions from code review Co-authored-by: Paul Bastian <paul.bastian@posteo.de> * Apply suggestions from code review Co-authored-by: Christian Bormann <chris.bormann@gmx.de> --------- Co-authored-by: Christian Bormann <chris.bormann@gmx.de>
1 parent 02f47a1 commit 2fb61cd

1 file changed

Lines changed: 47 additions & 17 deletions

File tree

draft-ietf-oauth-status-list.md

Lines changed: 47 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1097,15 +1097,24 @@ IANA "JSON Web Token Claims" registry {{IANA.JWT}} established by {{RFC7519}}.
10971097
This specification establishes the IANA "JWT Status Mechanisms" registry for JWT "status" member values and adds it to the "JSON Web Token (JWT)" registry group at https://www.iana.org/assignments/jwt. The registry records the status mechanism member and a reference to the specification that defines it.
10981098

10991099
JWT Status Mechanisms are registered by Specification Required {{RFC8126}} after a three-week
1100-
review period on the jwt-reg-review@ietf.org mailing list, on the advice of one or more Designated Experts.
1100+
review period on the jwt-reg-review@ietf.org mailing list, on the advice of one or more Designated Experts. To allow for the allocation of values prior to publication of the final version of a specification, the designated experts may approve registration once they are satisfied that the specification will be completed and published. However, if the specification is not completed and published in a timely manner, as determined by the designated experts, the designated experts may request that IANA withdraw the registration.
11011101

11021102
Registration requests sent to the mailing list for review should use an appropriate subject (e.g., "Request to register JWT Status Mechanism: example").
11031103

1104-
Within the review period, the Designated Expert(s) will either approve or deny the registration request, communicating this decision
1105-
to the review list and IANA. Denials should include an explanation and, if applicable, suggestions as to how to make the request
1106-
successful.
1104+
Within the review period, the designated experts will either approve or deny the registration request, communicating this decision to the review list and IANA. Denials should include an explanation and, if applicable, suggestions as to how to make the request successful. If the designated experts are not responsive, the registration requesters should contact IANA to escalate the process.
11071105

1108-
IANA must only accept registry updates from the Designated Expert(s) and should direct all requests for registration to the review mailing list.
1106+
Designated experts should apply at least the following criteria when reviewing proposed registrations:
1107+
1108+
* they should not duplicate existing functionality
1109+
* they are likely generally applicable, as opposed to being used for a single application
1110+
* they are clear and fit the purpose of the registry
1111+
* they use and extend the terminology of this document to describe the mechanism
1112+
1113+
IANA must only accept registry updates from the designated experts and should direct all requests for registration to the review mailing list.
1114+
1115+
In order to enable broadly informed review of registration decisions, there should be multiple designated experts to represent the perspectives of different applications using this specification. In cases where registration may be perceived as a conflict of interest for a particular expert, that expert should defer to the judgment of the other experts.
1116+
1117+
The mailing list is used to enable public review of registration requests, which enables both designated experts and other interested parties to provide feedback on proposed registrations. Designated experts may allocate values prior to publication of the final specification. This allows authors to receive guidance from the designated experts early, so any identified issues can be fixed before the final specification is published.
11091118

11101119
### Registration Template
11111120

@@ -1174,16 +1183,24 @@ IANA "CBOR Web Token (CWT) Claims" registry {{IANA.CWT}} established by {{RFC839
11741183
This specification establishes the IANA "CWT Status Mechanisms" registry for CWT "status" member values and adds it to the "CBOR Web Token (CWT) Claims" registry group at https://www.iana.org/assignments/cwt. The registry records the status mechanism member and a reference to the specification that defines it.
11751184

11761185
CWT Status Mechanisms are registered by Specification Required {{RFC8126}} after a three-week
1177-
review period on the cwt-reg-review@ietf.org mailing list, on the advice of one or more Designated Experts. However, to allow for the allocation of names prior to publication, the Designated Expert(s) may approve registration once they are satisfied that such a
1178-
specification will be published.
1186+
review period on the cwt-reg-review@ietf.org mailing list, on the advice of one or more Designated Experts. To allow for the allocation of values prior to publication of the final version of a specification, the designated experts may approve registration once they are satisfied that the specification will be completed and published. However, if the specification is not completed and published in a timely manner, as determined by the designated experts, the designated experts may request that IANA withdraw the registration.
11791187

11801188
Registration requests sent to the mailing list for review should use an appropriate subject (e.g., "Request to register CWT Status Mechanism: example").
11811189

1182-
Within the review period, the Designated Expert(s) will either approve or deny the registration request, communicating this decision
1183-
to the review list and IANA. Denials should include an explanation and, if applicable, suggestions as to how to make the request
1184-
successful.
1190+
Within the review period, the designated experts will either approve or deny the registration request, communicating this decision to the review list and IANA. Denials should include an explanation and, if applicable, suggestions as to how to make the request successful. If the designated experts are not responsive, the registration requesters should contact IANA to escalate the process.
1191+
1192+
Designated experts should at least apply the following criteria when reviewing proposed registrations:
1193+
1194+
* they should not duplicate existing functionality
1195+
* they are likely generally applicable, as opposed to being used for a single application
1196+
* they are clear and fit the purpose of the registry
1197+
* they use and extend the terminology of this document to describe the mechanism
1198+
1199+
IANA must only accept registry updates from the designated experts and should direct all requests for registration to the review mailing list.
11851200

1186-
IANA must only accept registry updates from the Designated Expert(s) and should direct all requests for registration to the review mailing list.
1201+
In order to enable broadly informed review of registration decisions, there should be multiple designated experts to represent the perspectives of different applications using this specification. In cases where registration may be perceived as a conflict of interest for a particular expert, that expert should defer to the judgment of the other experts.
1202+
1203+
The mailing list is used to enable public review of registration requests, which enables both designated experts and other interested parties to provide feedback on proposed registrations. Designated experts may allocate values prior to publication of the final specification. This allows authors to receive guidance from the designated experts early, so any identified issues can be fixed before the final specification is published.
11871204

11881205
### Registration Template
11891206

@@ -1215,16 +1232,25 @@ Specification Document(s):
12151232
This specification establishes the IANA "OAuth Status Types" registry for Status List values and adds it to the "OAuth Parameters" registry group at https://www.iana.org/assignments/oauth-parameters. The registry records a human-readable label, the bit representation and a common description for it.
12161233

12171234
Status Types are registered by Specification Required {{RFC8126}} after a two-week
1218-
review period on the oauth-ext-review@ietf.org mailing list, on the advice of one or more Designated Experts. However, to allow for the allocation of names prior to publication, the Designated Expert(s) may approve registration once they are satisfied that such a
1219-
specification will be published.
1235+
review period on the oauth-ext-review@ietf.org mailing list, on the advice of one or more Designated Experts. To allow for the allocation of values prior to publication of the final version of a specification, the designated experts may approve registration once they are satisfied that the specification will be completed and published. However, if the specification is not completed and published in a timely manner, as determined by the designated experts, the designated experts may request that IANA withdraw the registration.
12201236

12211237
Registration requests sent to the mailing list for review should use an appropriate subject (e.g., "Request to register Status Type name: example").
12221238

1223-
Within the review period, the Designated Expert(s) will either approve or deny the registration request, communicating this decision
1224-
to the review list and IANA. Denials should include an explanation and, if applicable, suggestions as to how to make the request
1225-
successful.
1239+
Within the review period, the designated experts will either approve or deny the registration request, communicating this decision to the review list and IANA. Denials should include an explanation and, if applicable, suggestions as to how to make the request successful. If the designated experts are not responsive, the registration requesters should contact IANA to escalate the process.
1240+
1241+
Designated experts should apply at least the following criteria when reviewing proposed registrations:
1242+
1243+
* they should not duplicate existing functionality
1244+
* they are likely generally applicable, as opposed to being used for a single application
1245+
* the Status Type Name is short, clear and using well-known terms
1246+
* the Status Type Description gives a good explanation for the intended use
1247+
* the Status Type value does not collide with existing values
1248+
1249+
IANA must only accept registry updates from the designated experts and should direct all requests for registration to the review mailing list.
12261250

1227-
IANA must only accept registry updates from the Designated Expert(s) and should direct all requests for registration to the review mailing list.
1251+
In order to enable broadly informed review of registration decisions, there should be multiple designated experts to represent the perspectives of different applications using this specification. In cases where registration may be perceived as a conflict of interest for a particular expert, that expert should defer to the judgment of the other experts.
1252+
1253+
The mailing list is used to enable public review of registration requests, which enables both designated experts and other interested parties to provide feedback on proposed registrations. Designated experts may allocate values prior to publication of the final specification. This allows authors to receive guidance from the designated experts early, so any identified issues can be fixed before the final specification is published.
12281254

12291255
### Registration Template
12301256

@@ -1833,6 +1859,10 @@ CBOR encoding:
18331859

18341860
\[\[ To be removed from the final specification \]\]
18351861

1862+
-20
1863+
1864+
* extend requirements for IANA registries
1865+
18361866
-19
18371867

18381868
* revert grapahics to ASCII

0 commit comments

Comments
 (0)