Internet DRAFT - draft-ietf-regext-rdap-versioning
draft-ietf-regext-rdap-versioning
Network Working Group J.G. Gould
Internet-Draft D.K. Keathley
Intended status: Standards Track VeriSign, Inc.
Expires: 30 August 2024 M. Loffredo
IIT-CNR/Registro.it
27 February 2024
Versioning in the Registration Data Access Protocol (RDAP)
draft-ietf-regext-rdap-versioning-00
Abstract
This document describes an RDAP extension for an extensible set of
versioning types with the features of identifying the RDAP extension
versions supported by the server, the RDAP extension versions
included in an RDAP response, and enabling a client to specify the
desired RDAP extension versions to include in the RDAP query and RDAP
response.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 30 August 2024.
Copyright Notice
Copyright (c) 2024 IETF Trust and the persons identified as the
document authors. All rights reserved.
Gould, et al. Expires 30 August 2024 [Page 1]
Internet-Draft Versioning in RDAP February 2024
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
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.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Conventions Used in This Document . . . . . . . . . . . . . . 4
3. Versioning RDAP Features . . . . . . . . . . . . . . . . . . 4
3.1. Extension Version Identifier . . . . . . . . . . . . . . 4
3.2. Extension Versioning Request . . . . . . . . . . . . . . 5
3.2.1. Versioning Query Parameter . . . . . . . . . . . . . 5
3.2.2. Versioning Extensions Media Type Parameter . . . . . 6
3.2.3. Versioning RDAP Response . . . . . . . . . . . . . . 7
3.2.3.1. RDAP Conformance . . . . . . . . . . . . . . . . 7
3.2.4. "versioning-help" Member . . . . . . . . . . . . . . 7
3.2.5. "versioning" Member . . . . . . . . . . . . . . . . . 13
4. Versioning Types . . . . . . . . . . . . . . . . . . . . . . 18
4.1. Opaque Versioning . . . . . . . . . . . . . . . . . . . . 18
4.1.1. Opaque Versioning Identifier . . . . . . . . . . . . 19
4.1.2. Opaque Versioning "versioning-help" Member . . . . . 19
4.1.3. Opaque Versioning "versioning" Member . . . . . . . . 20
4.2. Semantic Versioning . . . . . . . . . . . . . . . . . . . 21
4.2.1. Semantic Extension Version Identifier . . . . . . . . 22
4.2.2. Semantic Versioning "versioning-help" Member . . . . 23
4.2.3. Semantic Versioning "versioning" Member . . . . . . . 25
5. Versioning Considerations . . . . . . . . . . . . . . . . . . 25
5.1. Versioning Extension Considerations . . . . . . . . . . . 25
5.2. Versioning Type Considerations . . . . . . . . . . . . . 25
6. Extension Version Identifier . . . . . . . . . . . . . . . . 26
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 26
7.1. RDAP Extensions Registry . . . . . . . . . . . . . . . . 26
7.2. RDAP JSON Values Registry . . . . . . . . . . . . . . . . 26
8. Security Considerations . . . . . . . . . . . . . . . . . . . 27
9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 27
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 27
10.1. Normative References . . . . . . . . . . . . . . . . . . 27
10.2. Informative References . . . . . . . . . . . . . . . . . 29
Appendix A. Change History . . . . . . . . . . . . . . . . . . . 29
A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 29
A.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 29
A.3. Change from 02 to REGEXT 00 . . . . . . . . . . . . . . . 30
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 30
Gould, et al. Expires 30 August 2024 [Page 2]
Internet-Draft Versioning in RDAP February 2024
1. Introduction
RDAP supports identifying the RDAP extensions included in an RDAP
response using the RDAP Conformance data structure, defined in
Section 4.1 of [RFC9083]. The RDAP Conformance values are
identifiers with no standard mechanism to support structured,
machine-parseable version signaling by the server. This document
describes an RDAP extension for an extensible set of versioning
types, with the pre-defined versioning types of Opaque Versioning
(Section 4.1) and Semantic Versioning (Section 4.2), that have the
following features:
* Enabling a client to specify the desired RDAP extension versions
to include in the RDAP query and RDAP response, using the
Extension Versioning Request (Section 3.2). The client can
specify the desired RDAP extension versions to include in the RDAP
query and RDAP response with the "versioning" query parameter or
the RDAP-X media type "extensions" parameter
[I-D.newton-regext-rdap-x-media-type].
* Identifying the RDAP extension versions supported by the server.
The RDAP extension versions supported by the server is returned in
an extension to the RDAP help response, defined© in Section 7 of
[RFC9083], using the "versioning-help" member (Section 3.2.4).
The "versioning-help" member (Section 3.2.4) includes the list of
supported extensions and additional extension information, such
the available set of extension versions and the extension version
document.
* Identifying the RDAP extension versions included in an RDAP
response. The RDAP extension versions included in an RDAP
response are identified using the "versioning" member
(Section 3.2.5). The "versioning" member (Section 3.2.5) includes
a list of extension versions included in the RDAP response that
extends the extension identifiers in the RDAP Conformance to
include versioning information.
There are two predefined versioning types that include:
* Opaque Versioning, as defined in Section 8 of
[I-D.newton-regext-rdap-extensions], to support RDAP extensions
that are identified using the Extension Identifier included in the
RDAP Conformance.
* Semantic Versioning to support RDAP extensions that include a
major and minor version with the Extension Identifier.
Gould, et al. Expires 30 August 2024 [Page 3]
Internet-Draft Versioning in RDAP February 2024
The versioning types are registered in the JSON Values Registry,
where new versioning types can be defined and registered in the
future. The specification of a versioning type defines how the base
set of features of the versioning extension are used for the
versioning type.
2. Conventions Used in This Document
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
3. Versioning RDAP Features
The extension includes a base set of features that can be used for
any defined versioning type. The features enable the client to
discover what extension versions is supported by the server, enable
the client to specify what extension versions are desired in an RDAP
query and RDAP response, and provide the extension versions included
in the RDAP response by the server. Examples are provided using the
two predefined versioning types in Section 4. The format of the
Extension Version Indentifier (Section 3.1) is general enough to
support a broad range of future versioning types.
3.1. Extension Version Identifier
The Extension Version Identifier adds support for versioning to the
Extension Identifer in [RFC7480] that is returned in the RDAP
Conformance data structure of [RFC9083]. Each versioning type will
define the scheme and the meaning of the "versioning" Augmented
Backus-Naur Form (ABNF) grammar [RFC5234] rule. The Extension
Version Identifier is used to uniquely identify a version of an RDAP
extension in the Extension Versioning Request (Section 3.2), the
members of the "versioning-help" Member (Section 3.2.4), and the
members of the "versioning" Member (Section 3.2.5).
extension-version-identifier = identifier versioning
identifier = ALPHA *( ALPHA / DIGIT / "_") ; Extension Identifer
versioning = ["-" 1*VCHAR]
Figure 1: Extension Version Identifier ABNF
Example Extension Version Identifiers:
"versioning"
Opaque versioning of the "versioning" extension.
Gould, et al. Expires 30 August 2024 [Page 4]
Internet-Draft Versioning in RDAP February 2024
"versioning-0.2"
Semantic versioning of the "versioning" extension.
"semantic_ext1-1.0"
Semantic versioning of the "semantic_ext1" extension.
"opaque_ext1"
Opaque versioning of the "opaque_ext1" extension.
"dated_ext1-20231129"
Use of potential dated versioning with the format YYYYMMDD.
3.2. Extension Versioning Request
The client MAY provide an Extension Versioning Request to indicate
the desired extension versions to include in the RDAP query and RDAP
response. There are two Extension Versioning Request methods with
the Versioning Query Parameter (Section 3.2.1) and the Versioning
Extensions Media Type Parameter (Section 3.2.2). The server MUST
support both methods of Extension Versioning Request methods and the
client MUST use at most a single Extension Versioning Request method
in the RDAP query.
The Extension Versioning Request provides a hint from the client what
extension versions to include in the RDAP query by the client and
RDAP response by the server. It is up to server policy what
extension versions to support in the RDAP query and the extension
versions to include in the RDAP response, based on the supported set
of extensions, the default extension versions, and the hint provided
by the client using the Extension Versioning Request.
3.2.1. Versioning Query Parameter
The "versioning" query parameter MAY be used with RDAP queries to
specify the RDAP extension versions to include in the RDAP query and
the RDAP response. The "versioning" query parameter is a list of one
or more Extension Version Identifiers, as defined in Section 3.1,
seperated by commas. The ABNF format for the "versioning" query
parameter, using the "extension-version-identifier" rule from
Figure 1, is:
versioning = "versioning=" extension-version-identifier
*("," extension-version-identifier)
Figure 2: Versioning Query Parameter ABNF
Example RDAP queries using the "versioning" query parameter:
Gould, et al. Expires 30 August 2024 [Page 5]
Internet-Draft Versioning in RDAP February 2024
https://example.com/rdap/help?versioning=versioning-0.2
Help query using extension "versioning-0.2". The response can be
found in Figure 6.
https://example.com/rdap/domain/
versioning.example?versioning=semantic_ext1-0.1
Domain query using extension "semantic_ext1-0.1". The response
can be found in Figure 9.
https://example.com/rdap/domain/
versioning.example?versioning=semantic_ext1-0.1,opaque_ext2
Domain query using extensions "semantic_ext1-0.1" and
"opaque_ext2". The response can be found in Figure 10.
3.2.2. Versioning Extensions Media Type Parameter
The Extensions Media Type Parameter
[I-D.newton-regext-rdap-x-media-type] MAY be used with RDAP queries
to specify the RDAP extension versions to include in the RDAP query
and the RDAP response. The RDAP extensions included in the
"extensions" parameter are Extension Version Identifiers, as defined
in Section 3.1. The "extensions" Versioning Extensions Type
Parameter is a list of one or more Extension Version Identifiers, as
defined in Section 3.1, seperated by whitespace (%x20). The use of
the "-" character in the Extension Version Identifier ABNF (Figure 1)
ensures that an Extension Version Identifier with a non-empty
"versioning" ABNF rule will not conflict with an Extension
Identifier. The ABNF format for the "extensions" parameter, using
the "extension-version-identifier" rule from Figure 1, is:
extensions = "extensions="
DQUOTE
extension-version-identifier
*(SP extension-version-identifier)
DQUOTE
Figure 3: Versioning Extensions Media Type Parameter ABNF
Example Versioning Extensions Media Type Parameter values:
extensions="versioning-0.2"
Versioning Extensions Media Type Parameter for the "versioning"
extension with the semantic versioning of "versioning-0.2". The
response for the /help query "https://example.com/rdap/help" with
the Versioning Extensions Media Type Parameter value can be found
in Figure 6.
Gould, et al. Expires 30 August 2024 [Page 6]
Internet-Draft Versioning in RDAP February 2024
extensions="semantic_ext1-0.1"
Versioning Extensions Media Type Parameter for the
"semantic_ext1" extension with the semantic versioning of
"semantic_ext1-0.1". The domain query
"https://example.com/rdap/domain/versioning.example" response
with the Versioning Extensions Media Type Parameter value can be
found in Figure 9.
extensions="semantic_ext1-0.1 opaque_ext2"
Versioning Extensions Media Type Parameter for the
"semantic_ext1" and "opaque_ext2" extensions with the semantic
versioning of "semantic_ext1-0.1" and opaque versioning of
"opaque_ext2", respectively. The domain query
"https://example.com/rdap/domain/versioning.example" response
with the Versioning Extensions Media Type Parameter value can be
found in Figure 9.
3.2.3. Versioning RDAP Response
3.2.3.1. RDAP Conformance
RDAP responses that contain values described in this document MUST
indicate conformance with this specification by including an
"rdapConformance" ([RFC9083]) value of "versioning". The
"versioning" extension identifier is described in Section 7.1.
Example "rdapConformance" member with the versioning extension:
"rdapConformance": [
"rdap_level_0",
"versioning"
]
Figure 4: "rdapConformance" with Versioning Extension
3.2.4. "versioning-help" Member
The "versioning-help" member MUST be added to the response of a /help
query, defined in [RFC9082], to indicate the extension versions that
are supported by the server. This extends the information provided
by the guidance in Section 7 of [I-D.newton-regext-rdap-extensions],
with inclusion of the all supported extension identifiers in the RDAP
Conformance to the response of a /help query. The "versioning-help"
member contains an array of extension objects with the following
child members:
"extension": REQUIRED Extension Identifer, defined in [RFC7480], and
Gould, et al. Expires 30 August 2024 [Page 7]
Internet-Draft Versioning in RDAP February 2024
returned in the "rdapConformance" data structure of [RFC9083].
An example is the "versioning" extension identifier.
"type": REQUIRED versioning type used by the extension. The
versioning types are registered using the "versioning" type in
the JSON Values Registry. There are two predefined versioning
types, including "opaque" (see Opaque Versioning (Section 4.1))
and "semantic" (see Semantic Versioning (Section 4.2))
"versions": An array of extension version objects with the following
child members:
"version:" The Extension Version Identifier, defined in
Section 3.1. An example is the "versioning-0.2" extension
version identifier.
"default:" OPTIONAL boolean value indicating which of the
extension version objects is the default returned by the
server when the client doesn't specify the version using the
"versioning" query parameter, defined in Section 3.2. When
there is a single extension version object, then the
"default" member value is true by default. When there is
more than one extension version object, the server MUST
include only one extension version object with the "default"
member set to true, and the remaining extension version
objects "default" member value is false by default.
"start:" OPTIONAL date and time that the extension version will
be supported. When the member is not included, the extension
version object is supported. Once the date and time has
passed, the "start" member MUST be removed. The syntax for
the date and time is defined in [RFC3339].
"end:" OPTIONAL date and time that the extension version will
stop being supported. When the member is not included, the
extension version object has no planned support expiry. Once
the date and time has passed, the extension version object
MUST be removed and the extension object MUST be removed if
the last extension version object is removed. The syntax for
the date and time is defined in [RFC3339].
"links:" OPTIONAL "links" array to extension version
documentation. The relationship of these links is defined by
the IANA registry described in [RFC8288]. The JSON name/
values of "rel", "href", "hreflang", "title", "media", and
"type" correspond to values found in Section 3 of [RFC8288].
The "value", "rel", and "href" JSON values MUST be specified.
All other JSON values are OPTIONAL.
Gould, et al. Expires 30 August 2024 [Page 8]
Internet-Draft Versioning in RDAP February 2024
Example "links" member for the "ext2-0.1" extension version
identifier:
"links": [
{
"value": "https://ext2.example/ext2-01.txt",
"rel": "describedby",
"href": "https://ext2.example/ext2-01.txt",
"type": "text/plain"
}
]
Figure 5: Example of "links" Member
Example response to /help query with "versioning-help" and
"versioning" members and no client specified versioning in the /help
query "https://example.com/rdap/help":
{
"rdapConformance": [
"rdap_level_0",
"versioning",
"opaque_ext1",
"opaque_ext2",
"semantic_ext1",
"semantic_ext2",
"semantic_ext3"
],
"versioning-help": [
{
"extension": "versioning",
"type": "semantic",
"versions": [
{
"version": "versioning-0.1"
},
{
"version": "versioning-0.2",
"default": true
}
]
},
{
"extension": "opaque_ext1",
"type": "opaque",
"versions": [
{
"version": "opaque_ext1"
Gould, et al. Expires 30 August 2024 [Page 9]
Internet-Draft Versioning in RDAP February 2024
"default": true
}
],
"end": "2023-12-31T23:59:59Z"
},
{
"extension": "opaque_ext2",
"type": "opaque",
"versions": [
{
"version": "opaque_ext2"
"default": true
}
],
"links": [
{
"value": "https://ext2.example/paque_ext2.txt",
"rel": "describedby",
"href": "https://ext2.example/paque_ext2.txt",
"type": "text/plain"
}
]
},
{
"extension": "semantic_ext1",
"type": "semantic",
"versions": [
{
"version": "semantic_ext1-0.1",
"end": "2023-12-31T23:59:59Z"
},
{
"version": "semantic_ext1-1.0",
"default": true
},
{
"version": "semantic_ext1-1.1",
"start": "2023-12-31T23:59:59Z"
}
]
},
{
"extension": "semantic_ext2",
"type": "semantic",
"versions": [
{
"version": "semantic_ext2-0.1",
"end": "2023-12-31T23:59:59Z",
Gould, et al. Expires 30 August 2024 [Page 10]
Internet-Draft Versioning in RDAP February 2024
"links": [
{
"value": "https://ext2.example/semantic_ext2-01.txt",
"rel": "describedby",
"href": "https://ext2.example/semantic_ext2-01.txt",
"type": "text/plain"
}
]
}
]
},
{
"extension": "semantic_ext3",
"type": "semantic",
"versions": [
{
"version": "semantic_ext3-1.0",
"start": "2023-12-31T23:59:59Z"
}
]
}
],
"versioning": [
{
"extension": "versioning",
"type": "semantic",
"version": "versioning-0.2"
}
]
}
Figure 6: Response to /help Query with No Client Specified Versioning
Example response to /help query with the "versioning-help" and
"versioning" members and client specified "versioning-0.1" extension
version in the /help query "https://example.com/rdap/
help?versioning=versioning-0.1". The "versioning-0.1" extension
version does not include support for the "type" member.
{
"rdapConformance": [
"rdap_level_0",
"versioning",
"opaque_ext1",
"opaque_ext2",
"semantic_ext1",
"semantic_ext2",
"semantic_ext3"
Gould, et al. Expires 30 August 2024 [Page 11]
Internet-Draft Versioning in RDAP February 2024
],
"versioning-help": [
{
"extension": "versioning",
"versions": [
{
"version": "versioning-0.1"
},
{
"version": "versioning-0.2",
"default": true
}
]
},
{
"extension": "opaque_ext1",
"versions": [
{
"version": "opaque_ext1-1.0",
"default": true
}
]
},
{
"extension": "opaque_ext2",
"versions": [
{
"version": "opaque_ext2-1.0",
"default": true
}
]
},
{
"extension": "semantic_ext1",
"versions": [
{
"version": "semantic_ext1-0.1",
"end": "2023-12-31T23:59:59Z"
},
{
"version": "semantic_ext1-1.0",
"default": true
},
{
"version": "semantic_ext1-1.1",
"start": "2023-12-31T23:59:59Z"
}
]
Gould, et al. Expires 30 August 2024 [Page 12]
Internet-Draft Versioning in RDAP February 2024
},
{
"extension": "semantic_ext2",
"versions": [
{
"version": "semantic_ext2-0.1",
"end": "2023-12-31T23:59:59Z",
"links": [
{
"value": "https://ext2.example/semantic_ext2-01.txt",
"rel": "describedby",
"href": "https://ext2.example/semantic_ext2-01.txt",
"type": "text/plain"
}
]
}
]
},
{
"extension": "semantic_ext3",
"versions": [
{
"version": "semantic_ext3-1.0",
"start": "2023-12-31T23:59:59Z"
}
]
}
],
"versioning": [
{
"extension": "versioning",
"version": "versioning-0.1"
}
]
}
Figure 7: Response to /help Query with "versioning-0.1" Extension
Version
3.2.5. "versioning" Member
The "versioning" member MUST be added to the RDAP response when there
is one or more RDAP extension fields. The "versioning" member is
included as a member of the object class in a lookup response, such
as the object classes defined in [RFC9083], and as a member of the
object instances in a search response, such as the object instances
defined in [RFC9083], and as a member of the response to a /help
query, such as shown in Response to /help Query with No Client
Gould, et al. Expires 30 August 2024 [Page 13]
Internet-Draft Versioning in RDAP February 2024
Specified Versioning (Figure 6). The "versioning" member contains an
array of versioning objects with the following child members:
"extension": REQUIRED Extension Identifer, defined in [RFC7480], and
returned in the "rdapConformance" data structure of [RFC9083].
An example is the "versioning" extension identifier.
"type": REQUIRED versioning type used by the extension. The
versioning types are registered using the "versioning" type in
the JSON Values Registry. There are two predefined versioning
types, including "opaque" (see Opaque Versioning (Section 4.1))
and "semantic" (see Semantic Versioning (Section 4.2))
"version": REQUIRED Extension Version Identifier, defined in
Section 3.1, that is included in the response. An example is the
"versioning-0.2" extension version identifier.
Example domain lookup response with "versioning" member and no client
specified versioning in the lookup query
"https://example.com/rdap/domain/versioning.example":
{
"rdapConformance": [
"rdap_level_0",
"versioning",
"semantic_ext1",
"opaque_ext2"
],
"objectClassName": "domain",
"handle": "XXXX",
"ldhName": "versioning.example",
"links": [
{
"value": "https://example.net/domain/versioning.example",
"rel": "self",
"href": "https://example.net/domain/versioning.example",
"type": "application/rdap+json"
}
],
"status": [
"ok"
],
"events": [
{
"eventAction": "registration",
"eventDate": "1990-12-31T23:59:59Z"
},
{
Gould, et al. Expires 30 August 2024 [Page 14]
Internet-Draft Versioning in RDAP February 2024
"eventAction": "expiration",
"eventDate": "2023-12-31T23:59:59Z"
}
],
"semantic_ext1": {
"value": "example 1",
"newoptionalstring": "new value"
},
"opaque_ext2": {
"name": "example 2"
},
"versioning": [
{
"extension": "versioning",
"type": "semantic",
"version": "versioning-0.2"
},
{
"extension": "semantic_ext1",
"type": "semantic",
"version": "semantic_ext1-1.0"
},
{
"extension": "opaque_ext2",
"type": "opaque",
"version": "opaque_ext2"
}
]
}
Figure 8: RDAP Domain Lookup Response with No Client Specified
Versioning
Example domain lookup response with "versioning" member and client
specified "semantic_ext1-0.1" extension version in the lookup query
"https://example.com/rdap/domain/
versioning.example?versioning=semantic_ext1-0.1":
{
"rdapConformance": [
"rdap_level_0",
"versioning",
"semantic_ext1",
"opaque_ext2"
],
"objectClassName": "domain",
"handle": "XXXX",
"ldhName": "versioning.example",
Gould, et al. Expires 30 August 2024 [Page 15]
Internet-Draft Versioning in RDAP February 2024
"links": [
{
"value": "https://example.net/domain/versioning.example",
"rel": "self",
"href": "https://example.net/domain/versioning.example",
"type": "application/rdap+json"
}
],
"status": [
"ok"
],
"events": [
{
"eventAction": "registration",
"eventDate": "1990-12-31T23:59:59Z"
},
{
"eventAction": "expiration",
"eventDate": "2023-12-31T23:59:59Z"
}
],
"semantic_ext1": {
"value": "example 1"
},
"opaque_ext2": {
"name": "example 2"
},
"versioning": [
{
"extension": "versioning",
"type": "semantic",
"version": "versioning-0.2"
},
{
"extension": "semantic_ext1",
"type": "semantic",
"version": "semantic_ext1-0.1"
},
{
"extension": "opaque_ext2",
"type": "opaque",
"version": "opaque_ext2"
}
]
}
Figure 9: RDAP Domain Lookup Response with "semantic_ext1-0.1"
Extension Version
Gould, et al. Expires 30 August 2024 [Page 16]
Internet-Draft Versioning in RDAP February 2024
Example domain lookup response with "versioning" member and client
specified "semantic_ext1-0.1" and "opaque_ext2" extension versions in
the lookup query "https://example.com/rdap/domain/
versioning.example?versioning=semantic_ext1-0.1,opaque_ext2":
{
"rdapConformance": [
"rdap_level_0",
"versioning",
"semantic_ext1",
"opaque_ext2"
],
"objectClassName": "domain",
"handle": "XXXX",
"ldhName": "versioning.example",
"links": [
{
"value": "https://example.net/domain/versioning.example",
"rel": "self",
"href": "https://example.net/domain/versioning.example",
"type": "application/rdap+json"
}
],
"status": [
"ok"
],
"events": [
{
"eventAction": "registration",
"eventDate": "1990-12-31T23:59:59Z"
},
{
"eventAction": "expiration",
"eventDate": "2023-12-31T23:59:59Z"
}
],
"semantic_ext1": {
"value": "example 1"
},
"opaque_ext2": {
"name": "example 2"
},
"versioning": [
{
"extension": "versioning",
"type": "semantic",
"version": "versioning-0.2"
},
Gould, et al. Expires 30 August 2024 [Page 17]
Internet-Draft Versioning in RDAP February 2024
{
"extension": "semantic_ext1",
"type": "semantic",
"version": "semantic_ext1-0.1"
},
{
"extension": "opaque_ext2",
"type": "opaque",
"version": "opaque_ext2"
}
]
}
Figure 10: RDAP Domain Lookup Response with "semantic_ext1-0.1" and
"opaque_ext2" Extension Versions
4. Versioning Types
Versioning types are extensible by formally defining the extension
version identifer, how the versioning type is represented in the
"versioning-help" member (Section 3.2.4), and how the versioning type
is represented in the "versioning" member (Section 3.2.4). The
definition of the extension version identifier determines how the
versioning type is represented in the Extension Versioning Request
(Section 3.2). Each versioning type needs to have a unique
"versioning" RDAP JSON Values Registry Type field value. This
document pre-defines two versioning types with Opaque Versioning
(Section 4.1) and Semantic Versioning (Section 4.2). Other
versioning types can be defined and registered in the RDAP JSON
Values Registry.
4.1. Opaque Versioning
Opaque Versioning is defined in Section 8 of
[I-D.newton-regext-rdap-extensions], to support RDAP extensions that
are identified using the Extension Identifier included in the RDAP
Conformance and is the base versioning type that can be applied to
any RDAP extension. All RDAP extensions are registered in the RDAP
Extensions Registry using the Extension Identifier in [RFC7480],
which is the basis for other versioning types. An RDAP Extension
that supports another versioning type, such as the Semantic
Versioning (Section 4.2), MAY be referred to using Opaque Versioning
in the Extension Versioning Request (Section 3.2) and the server
returns the extension version with the "default" (Section 3.2.4)
member set to true.
Gould, et al. Expires 30 August 2024 [Page 18]
Internet-Draft Versioning in RDAP February 2024
4.1.1. Opaque Versioning Identifier
The Opaque Versioning Identifier directly matches the Extension
Identifier registered in the RDAP Extensions Registry. The ABNF for
the Extension Identifier is defined in "Figure 1: ABNF for JSON
Names" of [RFC7480].
Example Opaque Extension Versioning Identifiers:
"versioning"
Opaque versioning of the "versioning" extension.
"opaque_ext1"
Opaque versioning of the "opaque_ext1" extension.
4.1.2. Opaque Versioning "versioning-help" Member
For an RDAP extension that only supports Opaque Extension Versioning,
there is only a single extension version. All of the members of the
"versioning-help" member (Section 3.2.4) is supported wth Opaque
Versioning, but there will be only a single "versions" member object
that has the "version" member matching the "extension" member value.
Clients can leverage the Extension Version Identifier value in the
Extension Versioning Request (Section 3.2) for Opaque Versioning.
Example response to /help query with "versioning-help" and
"versioning" members with support for only Opaque Versioning in the
/help query "https://example.com/rdap/help":
{
"rdapConformance": [
"rdap_level_0",
"versioning",
"opaque_ext1",
"opaque_ext2",
],
"versioning-help": [
{
"extension": "versioning",
"type": "opaque",
"versions": [
{
"version": "versioning"
},
]
},
{
"extension": "opaque_ext1",
Gould, et al. Expires 30 August 2024 [Page 19]
Internet-Draft Versioning in RDAP February 2024
"type": "opaque",
"versions": [
{
"version": "opaque_ext1"
}
],
"end": "2023-12-31T23:59:59Z"
},
{
"extension": "opaque_ext2",
"type": "opaque",
"versions": [
{
"version": "opaque_ext2"
}
],
"start": "2023-12-31T23:59:59Z",
"links": [
{
"value": "https://ext2.example/opaque_ext2.txt",
"rel": "describedby",
"href": "https://ext2.example/paque_ext2.txt",
"type": "text/plain"
}
]
}
],
"versioning": [
{
"extension": "versioning",
"type": "opaque",
"version": "versioning"
}
]
}
Figure 11: Response to /help Query with only Opaque Versioning
4.1.3. Opaque Versioning "versioning" Member
All of the members of the "versioning" member (Section 3.2.5) is
supported wth Opaque Versioning, where the "extension" and "version"
member are both set with the Extension Identifier and the "type" is
set to "opaque". The Response to /help Query with only Opaque
Versioning (Figure 11) includes an example of of the "versioning"
extension represented using Opaque Versioning.
Gould, et al. Expires 30 August 2024 [Page 20]
Internet-Draft Versioning in RDAP February 2024
4.2. Semantic Versioning
The Semantic Versioning uses a subset of the Semantic Versioning
[SemVer] rules, where the patch version, pre-release version, and
build metadata are not used. RDAP versioning is only associated with
changes to the protocol interface that is the public API of [SemVer],
so there is no concept of patching, pre-release, and build metadata
information. Only the [SemVer] major version and minor version are
used for Extension Versioning, and is based on the stability of the
extension as opposed to backward compatibility. The RDAP extension
given a version number MAJOR.MINOR, increment the:
1. MAJOR version when the extension interface is considered stable
and complete
2. MINOR version includes an update to the extension interface that
is not considered stable and complete
The following are the Extension Versioning rules based on
modifications to the Semantic Versioning [SemVer] rules:
1. A normal version MUST take the form X.Y where X.Y are non-
negative integers, and MUST NOT contain leading zeroes. X is the
major version and Y is the minor version. Each element MUST
increase numerically. For instance: 1.1 -> 1.2 -> 1.3.
2. Major version zero (0.y) is for initial definition. Anything MAY
change at any time. The extension interface SHOULD NOT be
considered stable. An extension that is an initial Internet
Draft prior to Working Group Last Call (WGLC) SHOULD use a zero
major version.
3. Version 1.0 defines the extension interface. The way in which
the version number is incremented after this is dependent on this
extension interface and how it changes. An extension that is an
initial Internet Draft that has passed Working Group Last Call
(WGLC) SHOULD use version 1.0.
4. Minor version Y (x.Y | x > 0) MUST be incremented if new
interface changes are introduced in the extension interface from
the last major version.
5. Major version X (X.y | X > 0) MUST be incremented once the new
interface is considered stable and complete. The minor version
MUST be reset to 0 when major version is incremented.
6. Precedence refers to how versions are compared to each other when
ordered.
Gould, et al. Expires 30 August 2024 [Page 21]
Internet-Draft Versioning in RDAP February 2024
1. Precedence MUST be calculated by seperating the version into
major and minor identifiers in that order.
2. Precedence is determined by the first difference when
comparing each of these identifiers from left to right as
follows: Major and minor are always compared numerically.
Example: 1.0 < 2.0 < 2.1.
4.2.1. Semantic Extension Version Identifier
The Semantic Versioning Identifier defines the versioning ABNF rule
in Extension Version Identifier ABNF (Figure 1) to include the major
and minor version of the extension that follows the modified Semantic
Versioning [SemVer] rules.
semantic-version-identifier = identifier versioning
identifier = ALPHA *( ALPHA / DIGIT / "_") ; Extension Identifier
versioning = ; "-" major "." minor
major = numeric-identifer
minor = numeric-identifer
numeric-identifer = "0" / positive-digit *DIGIT
positive-digit = %x31-39 ; 1-9
Figure 12: Semantic Versioning Identifier ABNF
Example Semantic Extension Versioning Identifiers:
"versioning-0.2"
The "versioning" extension version identifier that is not
considered stable.
"semantic_ext1-1.0
First stable version of the "semantic_ext1" extension.
"semantic_ext1-1.1"
Update to "semantic_ext1-1.0" of the "semantic_ext1" extension
that is not considered stable.
"semantic_ext1-2.0"
New stable version of the "semantic_ext1" extension.
Gould, et al. Expires 30 August 2024 [Page 22]
Internet-Draft Versioning in RDAP February 2024
4.2.2. Semantic Versioning "versioning-help" Member
For an RDAP extension that supports Semantic Extension Versioning,
there can be many Extension Versioning Identifiers associated with
the Extension Identifier, so the "versions" member of the
"versioning-help" member can include a list of more than one
extension version object. All of the members of the
"versioning-help" member (Section 3.2.4) is supported wth Semantic
Versioning.
Example response to /help query with "versioning-help" and
"versioning" members with support for Semantic Versioning in the
/help query "https://example.com/rdap/help":
{
"rdapConformance": [
"rdap_level_0",
"versioning",
"semantic_ext1",
"semantic_ext2",
"semantic_ext3"
] ],
"versioning-help": [
{
"extension": "versioning",
"type": "semantic",
"versions": [
{
"version": "versioning-0.1"
},
{
"version": "versioning-0.2",
"default": true
}
]
},
{
"extension": "semantic_ext1",
"type": "semantic",
"versions": [
{
"version": "semantic_ext1-0.1",
"end": "2023-12-31T23:59:59Z"
},
{
"version": "semantic_ext1-1.0",
"default": true
},
Gould, et al. Expires 30 August 2024 [Page 23]
Internet-Draft Versioning in RDAP February 2024
{
"version": "semantic_ext1-1.1",
"start": "2023-12-31T23:59:59Z"
}
]
},
{
"extension": "semantic_ext2",
"type": "semantic",
"versions": [
{
"version": "semantic_ext2-0.1",
"end": "2023-12-31T23:59:59Z",
"links": [
{
"value": "https://ext2.example/semantic_ext2-01.txt",
"rel": "describedby",
"href": "https://ext2.example/semantic_ext2-01.txt",
"type": "text/plain"
}
]
}
]
},
{
"extension": "semantic_ext3",
"type": "semantic",
"versions": [
{
"version": "semantic_ext3-1.0",
"start": "2023-12-31T23:59:59Z"
}
]
}
],
"versioning": [
{
"extension": "versioning",
"type": "opaque",
"version": "versioning-0.2"
}
]
}
Figure 13: Response to /help Query with only Semantic Versioning
Gould, et al. Expires 30 August 2024 [Page 24]
Internet-Draft Versioning in RDAP February 2024
4.2.3. Semantic Versioning "versioning" Member
All of the members of the "versioning" member (Section 3.2.5) is
supported wth Semantic Versioning, where the "extension" member is
set with the Extension Identifier, the "version" member of the
extension included in the response is set with Semantic Extension
Version Identifier (Section 4.2.1), and the "type" is set to
"semantic". The Response to /help Query with only Semantic
Versioning (Figure 13) includes an example of of the "versioning"
extension represented using Semantic Versioning with "versioning-
0.2".
5. Versioning Considerations
This section covers considerations for extensions that support the
versioning extension and for defining new versioning types.
5.1. Versioning Extension Considerations
All extensions support Opaque Versioning (Section 4.1) by default and
MAY support other forms for versioning types, such as the Semantic
Versioning (Section 4.2). The following are considerations for the
extensions an servers that support the versioning extension:
1. An extension document SHOULD define an "Extension Version
Identifier" section that includes the versioning types supported
by the extension with the associated extension version
identifier.
2. A server MUST ignore Extension Version Identifiers that are
unknown in the Extension Versioning Request.
3. A server SHOULD first process the Extension Versioning Request
(Section 3.2) prior to processing the query parameters of other
extensions to implement the client's extension versioning hint.
4. A server MAY define the policy of the extension versions that are
supported and the timing of the extension versions, such as how
many overlapping extension versions to support in parallel.
5.2. Versioning Type Considerations
The following are considerations for the definition of new versioning
types in a Versioning Type Specification. The Opaque Versioning
(Section 4.1) and Semantic Versioning (Section 4.2) with the
associated RDAP JSON Values Registry (Section 7.2) registrations are
concrete examples of a Versioning Type Specification. The Versioning
Type Specification MUST include the following:
Gould, et al. Expires 30 August 2024 [Page 25]
Internet-Draft Versioning in RDAP February 2024
1. Definition of a unique RDAP JSON Values Registry "versioning"
value.
2. Definition of the format of the Extension Versioning identifier.
3. Definition of the members of the "versioning-help" member that
apply.
4. Definition of the members of the "versioning" memeber that apply.
6. Extension Version Identifier
This extension supports the following versioning types:
Opaque Versioning: The Opaque Extension Versioning Identifier is
"versioning".
Semantic Versioning: The Semantic Extension Versioning Identifier is
"versioning-0.2".
7. IANA Considerations
7.1. RDAP Extensions Registry
IANA is requested to register the following value in the RDAP
Extensions Registry:
Extension identifier: versioning
Registry operator: Any
Published specification: This document.
Contact: IETF <iesg@ietf.org>
Intended usage: This extension identifies RDAP extension versioning.
7.2. RDAP JSON Values Registry
Section 10.2 of [RFC9083] defines the RDAP JSON Values Registry with
pre-defined Type field values and the use of the "Expert Review"
policy defined in [RFC8126]. This specification defines a new
"versioning" RDAP JSON Values Registry Type field value that can be
used to register pre-defined versioning types values. The registered
"versioning" value is referenced using the "type" field of the
"versioning" field (Section 3.2.5) or "versioning-help" field object
(Section 3.2.4). IANA is instructed to update the RDAP JSON Values
Registry to accept the additional "versioning" type field values.
The following values should be registered by the IANA in the RDAP
JSON Values Registry described in [RFC9083]:
Value: opaque
Gould, et al. Expires 30 August 2024 [Page 26]
Internet-Draft Versioning in RDAP February 2024
Type: versioning
Description: Opaque extension versioning type, where the
rdapConformance value directly indicates the extension version.
Registrant Name: IETF
Registrant Contact Information: iesg@ietf.org
Value: semantic
Type: versioning
Description: Semantic extension versioning type, where the
rdapConformance value is appended with a semantic version number.
Registrant Name: IETF
Registrant Contact Information: iesg@ietf.org
8. Security Considerations
The RDAP extensions available to clients can be subject to server
disclosure and authorization policies. Inclusion of available RDAP
extensions and their available versions in the "versioning-help"
member, defined in Section 3.2.4, of the RDAP help response and
inclusion of the RDAP extensions in the RDAP response with the
"versioning" member, defined in Section 3.2.5, can be dependent on
authentication and authorization of the client by the server.
9. Acknowledgements
The authors wish to thank the following persons for their feedback
and suggestions: Scott Hollenbeck, Andy Newton, and Jasdip Singh.
10. References
10.1. Normative References
[I-D.newton-regext-rdap-extensions]
Newton, A., Singh, J., and T. Harrison, "RDAP Extensions",
Work in Progress, Internet-Draft, draft-newton-regext-
rdap-extensions-01, 31 August 2023,
<https://datatracker.ietf.org/doc/html/draft-newton-
regext-rdap-extensions-01>.
Gould, et al. Expires 30 August 2024 [Page 27]
Internet-Draft Versioning in RDAP February 2024
[I-D.newton-regext-rdap-x-media-type]
Newton, A. and J. Singh, "An RDAP With Extensions Media
Type", Work in Progress, Internet-Draft, draft-newton-
regext-rdap-x-media-type-01, 29 August 2023,
<https://datatracker.ietf.org/doc/html/draft-newton-
regext-rdap-x-media-type-01>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet:
Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002,
<https://www.rfc-editor.org/info/rfc3339>.
[RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", STD 68, RFC 5234,
DOI 10.17487/RFC5234, January 2008,
<https://www.rfc-editor.org/info/rfc5234>.
[RFC7480] Newton, A., Ellacott, B., and N. Kong, "HTTP Usage in the
Registration Data Access Protocol (RDAP)", STD 95,
RFC 7480, DOI 10.17487/RFC7480, March 2015,
<https://www.rfc-editor.org/info/rfc7480>.
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", BCP 26,
RFC 8126, DOI 10.17487/RFC8126, June 2017,
<https://www.rfc-editor.org/info/rfc8126>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8288] Nottingham, M., "Web Linking", RFC 8288,
DOI 10.17487/RFC8288, October 2017,
<https://www.rfc-editor.org/info/rfc8288>.
[RFC9082] Hollenbeck, S. and A. Newton, "Registration Data Access
Protocol (RDAP) Query Format", STD 95, RFC 9082,
DOI 10.17487/RFC9082, June 2021,
<https://www.rfc-editor.org/info/rfc9082>.
[RFC9083] Hollenbeck, S. and A. Newton, "JSON Responses for the
Registration Data Access Protocol (RDAP)", STD 95,
RFC 9083, DOI 10.17487/RFC9083, June 2021,
<https://www.rfc-editor.org/info/rfc9083>.
Gould, et al. Expires 30 August 2024 [Page 28]
Internet-Draft Versioning in RDAP February 2024
10.2. Informative References
[SemVer] "Semantic Versioning 2.0.0 (text from June 19, 2020)",
<https://github.com/semver/semver/
blob/8b2e8eec394948632957639dfa99fc7ec6286911/semver.md>.
Appendix A. Change History
A.1. Change from 00 to 01
1. Updated the Abstract to reference the use of machine-parseable
identifiers.
2. Updated the Introduction to reference the informal support for
versioning in RFC9083.
3. Removed rule "An extension using Extension Versioning MUST
declare the extension in a specification." from Section 3.1
"Extension Versioning".
A.2. Change from 01 to 02
1. Restructure the draft to support the features of providing
versioning meta-data in the help response, providing extension
versioning information in the query response, and provide the
ability for the client to specify the desired set of extension
versions in the query with an extensible set of versioning types.
The following changes apply:
1. Added the "Versioning RDAP Features" section to define the
base set of features of the extension that applies to an
extensible set of versioning types.
2. Updated the Extension Version Identifier to be more generic
to support an extensible set of extension version identifiers
by the set of versioning types.
3. Created the "Extension Versioning Request" section to support
client extension versioning hints using either the
"versioning" query parameter or the versioning extensions
media type parameter in
[I-D.newton-regext-rdap-x-media-type].
4. Updated the ""versioning-help" Member" section to include the
versioning type for each extension and to reference the
guidance in Section 7 of [I-D.newton-regext-rdap-extensions]
and extending it by the versioning extension.
5. Updated the ""versioning" Member" section to include the
versioning type for returned RDAP response extensions.
6. Created the "Versioning Types" section to define the two pre-
defined versioning types of Opaque Versioning and Semantic
Versioning following a common template.
Gould, et al. Expires 30 August 2024 [Page 29]
Internet-Draft Versioning in RDAP February 2024
7. Created the "Versioning Extension Considerations" section to
provide guidance on the use of the versioning extension by
RDAP extensions and servers, and to provide guidance on the
definition of new versioning types.
8. In the "IANA Considerations" section, add a new RDAP JSON
Values Type of "versioning" to support defining multiple
versioning types that can be used by RDAP extensions.
9. In the "IANA Considerations" section, Pre-register the RDAP
JSON Values "versioning" types defined in the draft,
including "opaque" and "semantic".
A.3. Change from 02 to REGEXT 00
1. Changed to regext working group draft by changing draft-gould-
regext-rdap-versioning to draft-ietf-regext-rdap-versioning.
Authors' Addresses
James Gould
VeriSign, Inc.
12061 Bluemont Way
Reston, VA 20190
United States of America
Email: jgould@verisign.com
URI: http://www.verisigninc.com
Daniel Keathley
VeriSign, Inc.
12061 Bluemont Way
Reston, VA 20190
United States of America
Email: dkeathley@verisign.com
URI: http://www.verisigninc.com
Mario Loffredo
IIT-CNR/Registro.it
Via Moruzzi,1
56124 Pisa
Italy
Email: mario.loffredo@iit.cnr.it
URI: http://www.iit.cnr.it
Gould, et al. Expires 30 August 2024 [Page 30]
