1,7 → 1,7 |
|
|
|
|
|
INTERNET-DRAFT D. Marschall |
Intended Status: Informational ViaThinkSoft |
Expires: 26 July 2024 23 January 2024 |
50,9 → 50,9 |
extracted from this document must include Revised BSD License text as |
described in Section 4.e of the Trust Legal Provisions and are |
provided without warranty as described in the Revised BSD License. |
|
|
|
|
Marschall Expires 26 July 2024 [Page 1] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
106,9 → 106,9 |
7 Internationalization Considerations . . . . . . . . . . . . . . 29 |
8 Security Considerations . . . . . . . . . . . . . . . . . . . . 30 |
9 IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 30 |
|
|
|
|
Marschall Expires 26 July 2024 [Page 2] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
162,9 → 162,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 3] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
177,7 → 177,7 |
of object with a globally unambiguous name. OIDs provide a |
persistent identification of objects based on a hierarchical |
structure of Registration Authorities (RA), where each parent has an |
Object Identifier and allocates Object Identifiers to child nodes. |
Object Identifier and allocates Object Identifiers to child nodes. |
More information about Object Identifiers can be found in |
Recommendation ITU-T X.660 (2011) | ISO/IEC 9834-1:2012 [X660]. |
|
218,9 → 218,9 |
(3) In directory services like LDAP (Lightweight Directory Access |
Protocol) [RFC4511], applications could query the name of attributes |
that are described by an OID the application doesn't know. |
|
|
|
|
Marschall Expires 26 July 2024 [Page 4] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
274,9 → 274,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 5] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
294,7 → 294,7 |
OID-IP is a text-based protocol transmitted over the Hypertext |
Transfer Protocol [TODO: RFC Ref]. |
|
2.1.1 Request Method and Path |
2.1.1 Request Method and Path |
|
All requests MUST be made using the request method "GET". |
|
315,7 → 315,7 |
|
To query the root node of any object type, <objectIdentifier> MUST |
have the value "root", for example |
"https://example.com/oidip/oid/root/text". Since the word "root" has |
"https://example.com/oidip/oid/root/text". Since the word "root" has |
a special meaning, identifiers that actually have the name "root" |
CANNOT be queried using OID-IP. |
|
330,9 → 330,9 |
The following authentication methods are possible: |
|
1. Whitedlisted IP address |
|
|
|
|
Marschall Expires 26 July 2024 [Page 6] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
375,7 → 375,7 |
"text/json" or "application/json". |
|
(3) "xml": Extensible Markup Language (XML, [XML]) representation as |
defined in section 3.1.3 (MANDATORY for the HTTP request method). |
defined in section 3.1.3 (MANDATORY for the HTTP request method). |
The "Content-Type" response header MUST be either "text/xml" or |
"application/xml". |
|
386,9 → 386,9 |
|
|
Lang: Accept-Language HTTP Header |
|
|
|
|
Marschall Expires 26 July 2024 [Page 7] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
413,11 → 413,11 |
There are the following requirements based on the result of the query |
(see section 2.3.1): |
|
- If the result is "Found", the HTTP Response Code MUST be "200 OK". |
- If the result is "Found", then the HTTP Response Code MUST be "200 |
OK". |
|
- If the result is "Not found; superior object found", the HTTP |
Response Code MUST NOT be a 4xx client error; instead it MUST be "200 |
OK". |
Response Code MUST be "470 Not Found - Superior Object Found". |
|
- If the result is "Not found", the HTTP Response Code MUST be "404 |
Not Found". |
426,9 → 426,9 |
the HTTP Response Code MUST NOT be a 3xx redirection status code. |
|
While the 3xx redirection status code is not allowed to indicate an |
OID-IP referral (as specified by section 4), the 3xx redirection |
status codes may be used if the OID-IP service itself moves (e.g. to |
a different domain name). |
OID-IP referral as specified by section 4, the 3xx redirection status |
codes may be used if the OID-IP service itself moves, e.g. to a |
different domain name. |
|
|
|
442,9 → 442,9 |
(TODO) |
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 8] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
462,7 → 462,7 |
OID-IP server replies with text content. All requests are terminated |
with ASCII CR followed by ASCII LF. The response contains multiple |
lines of text, separated by ASCII CR followed by ASCII LF. The OID- |
IP server closes its connection as soon as the output is finished. |
IP server closes its connection as soon as the output is finished. |
The closed TCP connection indicates to the client that the response |
has been received. |
|
498,9 → 498,9 |
A request can contain multiple input parameters which are each |
prepended by a dollar sign ("$"). |
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 9] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
554,9 → 554,9 |
English language (e.g. "text") or be common abbreviations (e.g. |
"json"). |
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 10] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
610,9 → 610,9 |
preference, and containing at least one element. |
|
The translation SHALL only affect the "message", "name", |
|
|
|
|
Marschall Expires 26 July 2024 [Page 11] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
666,9 → 666,9 |
( str-auth "=" tokens ) / |
( str-lang "=" languages ) / |
( other-arg-name "=" other-arg-val ) |
|
|
|
|
Marschall Expires 26 July 2024 [Page 12] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
722,9 → 722,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 13] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
764,7 → 764,7 |
mentioned in section 3.3 "Digital Signature"). |
|
(9) A response consists of sections, which MUST be separated by at |
least one empty line and/or comment line. |
least one empty line and/or comment line. |
|
(10) Custom sections CAN be added after any section defined in this |
document. The query section MUST be the first section in the |
778,9 → 778,9 |
(2) A response consists of sections, which MUST be named |
"querySection", "objectSection", "raSection", "ra1Section", etc. |
which SHOULD stay in this order. |
|
|
|
|
Marschall Expires 26 July 2024 [Page 14] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
834,9 → 834,9 |
|
Possible fields are: |
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 15] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
844,7 → 844,7 |
|
(1) "query" MUST be present and contains the request string the |
client has sent. Canonization or sanitation (like removing a leading |
dot in front of the OID) SHOULD NOT be applied at this step. |
dot in front of the OID) SHOULD NOT be applied at this step. |
Authentication tokens SHOULD be omitted, though. |
|
(2) "result" MUST be present and SHALL be one of the following |
882,7 → 882,7 |
displaying an error message). It MUST NOT be present if the result |
has a different value. |
|
(5) "lang" (OPTIONAL) contains the language of the field "message". |
(5) "lang" (OPTIONAL) contains the language of the field "message". |
The language should be a language tag as defined in [RFC5646]. |
|
The OID-IP service SHOULD NOT add additional fields to this section. |
890,9 → 890,9 |
3.2.2 Object-Section (Information about the OID) |
|
This section MUST be present if the result is "Found" or "Not found; |
|
|
|
|
Marschall Expires 26 July 2024 [Page 16] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
935,7 → 935,7 |
short as possible. |
|
(5) "description" (OPTIONAL) contains a short description of the OID. |
The description SHOULD only be a single sentence. |
The description SHOULD only be a single sentence. |
|
(6) "information" (OPTIONAL) contains additional information, e.g. |
Management Information Base (MIB) definitions. |
946,9 → 946,9 |
|
(8) "asn1-notation" (OPTIONAL, multiple values allowed) contains one |
or more possible notations in the ASN.1 syntax, as defined in |
|
|
|
|
Marschall Expires 26 July 2024 [Page 17] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
958,7 → 958,7 |
[X680], e.g. {joint-iso-itu-t(2) example(999)}. |
|
Note: A line break, to break up lines that are too long, as |
defined in section 3.1 ("Format and Encoding") SHOULD be used. |
defined in section 3.1 ("Format and Encoding") SHOULD be used. |
This is no problem because multiple ASN.1 notations can be |
distinguished by their opening curly bracket and their closing |
curly bracket. |
980,7 → 980,7 |
|
(11) "standardized-id" (OPTIONAL, multiple values allowed) contains |
an alphanumeric identifier that has a standardized "NameForm", i.e. |
in ASN.1 notation, it can be written without its associated number. |
in ASN.1 notation, it can be written without its associated number. |
See more information in Recommendation ITU-T X.680 (2015) | ISO/IEC |
8824-1:2015, clause 32.7 [X680]. |
|
990,7 → 990,7 |
|
(13) "long-arc" (OPTIONAL, multiple values allowed) contains a Non- |
integer Unicode label that can be used as the first identifier in an |
OID Internationalized Resource Identifier (OID-IRI), shortening it. |
OID Internationalized Resource Identifier (OID-IRI), shortening it. |
More information can be found in Recommendation ITU-T X.660 (2011) | |
ISO/IEC 9834-1:2012, clause 3.5.8 [X660]. |
|
1002,9 → 1002,9 |
is only informational; its existence is most likely a hint that |
subordinate OIDs will be found at that OID-IP server. If the result |
is "Not found; superior object found", then the client SHOULD query |
|
|
|
|
Marschall Expires 26 July 2024 [Page 18] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1011,7 → 1011,7 |
|
|
the referred OID-IP server to receive more information about the OID. |
See more information in section 4 "Referral". |
See more information in section 4 "Referral". |
|
(15) "oidip-pubkey" (OPTIONAL) contains the public key of the service |
that is identified with "oidip-service", in case it uses signatures |
1033,7 → 1033,7 |
OID, e.g. because the RA has stopped operating, but the existing |
child OIDs stay valid. |
|
"leaf" means that no child OIDs can be allocated under this OID. |
"leaf" means that no child OIDs can be allocated under this OID. |
The field "subordinate" SHALL therefore not be present. |
|
"no-identifiers" means that the RA is not allocating alphanumeric |
1048,7 → 1048,7 |
|
(17) "parent" (OPTIONAL) contains the OID of the nearest known parent |
OID, prepended by namespace identifier and double colon, i.e. "oid:". |
It MAY be followed by additional human-readable information, e.g. a |
It MAY be followed by additional human-readable information, e.g. a |
description or a list of ASN.1 identifiers. There SHALL be at least |
1 whitespace in between. |
|
1058,9 → 1058,9 |
readable information, e.g. a description or a list of ASN.1 |
identifiers. There SHALL be at least 1 whitespace in between. |
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 19] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1076,7 → 1076,7 |
|
Additional fields can be defined by the OID-IP service. The field |
names SHALL only consist of the lower-case letters "a..z", hyphens |
("-"), and numbers, and SHOULD be written in the English language. |
("-"), and numbers, and SHOULD be written in the English language. |
The field name MUST NOT begin or end with a hyphen and a hyphen MUST |
NOT be followed by another hyphen. |
|
1114,9 → 1114,9 |
|
(4) "ra-contact-name" (OPTIONAL, multiple values allowed) contains |
the name of a person responsible for the allocation of subordinate |
|
|
|
|
Marschall Expires 26 July 2024 [Page 20] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1125,7 → 1125,7 |
OIDs, in case "ra" is a group or organization. |
|
(5) "ra-address" (OPTIONAL) contains the physical location of the RA. |
While a fully qualified postal address is recommended, the field can |
While a fully qualified postal address is recommended, the field can |
also just contain a rough location like city and country name, state |
and country name, or just the country name, etc. The name of the |
country SHOULD always be present. |
1170,9 → 1170,9 |
|
(13) "ra-updated" (OPTIONAL) contains the date and time (as specified |
in section 3.4 "Date/Time Format") when the RA information was last |
|
|
|
|
Marschall Expires 26 July 2024 [Page 21] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1226,9 → 1226,9 |
3.3.2 "json" Format |
|
Steps for signing a message: |
|
|
|
|
Marschall Expires 26 July 2024 [Page 22] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1282,9 → 1282,9 |
be omitted until the date/time reference has the highest correctness. |
|
Examples of valid date/time references can be found in section 3.4.2. |
|
|
|
|
Marschall Expires 26 July 2024 [Page 23] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1338,9 → 1338,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 24] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1394,9 → 1394,9 |
ra-status: Information unavailable |
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 25] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1450,9 → 1450,9 |
% -----BEGIN RSA SIGNATURE----- |
% DwnqRtx/ONtPh4onXnrZPl9jF+G50RMLZkSwuClaoH2t/yK8CnYJrmzkzA5+gkfWkoQ |
% cq+J8J9cvnwXvBfpVHg== |
|
|
|
|
Marschall Expires 26 July 2024 [Page 26] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1506,9 → 1506,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 27] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1562,9 → 1562,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 28] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1618,9 → 1618,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 29] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1674,9 → 1674,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 30] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1730,9 → 1730,9 |
|
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC |
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, |
|
|
|
|
Marschall Expires 26 July 2024 [Page 31] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1786,9 → 1786,9 |
|
10.2 Informative References |
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 32] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1842,9 → 1842,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 33] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1898,9 → 1898,9 |
} |
}, |
"required":[ |
|
|
|
|
Marschall Expires 26 July 2024 [Page 34] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
1954,9 → 1954,9 |
"oneOf":[ |
{ |
"type":"string" |
|
|
|
|
Marschall Expires 26 July 2024 [Page 35] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2010,9 → 2010,9 |
} |
] |
}, |
|
|
|
|
Marschall Expires 26 July 2024 [Page 36] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2066,9 → 2066,9 |
}, |
"parent":{ |
"type":"string" |
|
|
|
|
Marschall Expires 26 July 2024 [Page 37] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2122,9 → 2122,9 |
}, |
"address":{ |
"type":"string" |
|
|
|
|
Marschall Expires 26 July 2024 [Page 38] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2178,9 → 2178,9 |
"ra1Section":{"$ref":"#/properties/oidip/properties/raSection"}, |
"ra2Section":{"$ref":"#/properties/oidip/properties/raSection"}, |
"ra3Section":{"$ref":"#/properties/oidip/properties/raSection"}, |
|
|
|
|
Marschall Expires 26 July 2024 [Page 39] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2234,9 → 2234,9 |
"ra49Section":{"$ref":"#/properties/oidip/properties/raSection"}, |
"ra50Section":{"$ref":"#/properties/oidip/properties/raSection"}, |
"ra51Section":{"$ref":"#/properties/oidip/properties/raSection"}, |
|
|
|
|
Marschall Expires 26 July 2024 [Page 40] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2290,9 → 2290,9 |
"ra97Section":{"$ref":"#/properties/oidip/properties/raSection"}, |
"ra98Section":{"$ref":"#/properties/oidip/properties/raSection"}, |
"ra99Section":{"$ref":"#/properties/oidip/properties/raSection"} |
|
|
|
|
Marschall Expires 26 July 2024 [Page 41] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2346,9 → 2346,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 42] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2402,9 → 2402,9 |
"(Russian characters are omitted in this example)" |
], |
"parent": "oid:2 (joint-iso-ccitt, joint-iso-itu-t)", |
|
|
|
|
Marschall Expires 26 July 2024 [Page 43] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2458,9 → 2458,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 44] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2514,9 → 2514,9 |
type="ns1:RaSectionType"/> |
<xs:element name="ra1Section" minOccurs="0" maxOccurs="1" |
type="ns1:RaSectionType"/> |
|
|
|
|
Marschall Expires 26 July 2024 [Page 45] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2570,9 → 2570,9 |
type="ns1:RaSectionType"/> |
<xs:element name="ra25Section" minOccurs="0" maxOccurs="1" |
type="ns1:RaSectionType"/> |
|
|
|
|
Marschall Expires 26 July 2024 [Page 46] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2626,9 → 2626,9 |
type="ns1:RaSectionType"/> |
<xs:element name="ra49Section" minOccurs="0" maxOccurs="1" |
type="ns1:RaSectionType"/> |
|
|
|
|
Marschall Expires 26 July 2024 [Page 47] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2682,9 → 2682,9 |
type="ns1:RaSectionType"/> |
<xs:element name="ra73Section" minOccurs="0" maxOccurs="1" |
type="ns1:RaSectionType"/> |
|
|
|
|
Marschall Expires 26 July 2024 [Page 48] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2738,9 → 2738,9 |
type="ns1:RaSectionType"/> |
<xs:element name="ra97Section" minOccurs="0" maxOccurs="1" |
type="ns1:RaSectionType"/> |
|
|
|
|
Marschall Expires 26 July 2024 [Page 49] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2794,9 → 2794,9 |
<xs:enumeration value="Service error"/> |
</xs:restriction> |
</xs:simpleType> |
|
|
|
|
Marschall Expires 26 July 2024 [Page 50] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2850,9 → 2850,9 |
</xs:complexType> |
|
<xs:simpleType name="ObjectIdType"> |
|
|
|
|
Marschall Expires 26 July 2024 [Page 51] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2882,7 → 2882,7 |
<xs:enumeration value="no-unicode-labels"/> |
<xs:enumeration value="retired"/> |
</xs:restriction> |
</xs:simpleType> |
</xs:simpleType> |
|
<xs:complexType name="RaSectionType"> |
<xs:sequence> |
2906,9 → 2906,9 |
<xs:element name="email" minOccurs="0" maxOccurs="unbounded" |
type="xs:string"/> |
<xs:element name="url" minOccurs="0" maxOccurs="unbounded" |
|
|
|
|
Marschall Expires 26 July 2024 [Page 52] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
2962,9 → 2962,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 53] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
3018,9 → 3018,9 |
<long-arc>(Arabian characters are omitted)</long-arc> |
<long-arc>(Japanese characters are omitted)</long-arc> |
<long-arc>(Chinese characters are omitted)</long-arc> |
|
|
|
|
Marschall Expires 26 July 2024 [Page 54] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |
3074,9 → 3074,9 |
|
|
|
|
|
|
|
Marschall Expires 26 July 2024 [Page 55] |
|
INTERNET DRAFT OID Information Protocol 23 January 2024 |