draft-ietf-weirds-rdap-query-06.txt   draft-ietf-weirds-rdap-query-07.txt 
Network Working Group A. Newton Network Working Group A. Newton
Internet-Draft ARIN Internet-Draft ARIN
Intended status: Standards Track S. Hollenbeck Intended status: Standards Track S. Hollenbeck
Expires: February 17, 2014 Verisign Labs Expires: April 04, 2014 Verisign Labs
August 16, 2013 October 01, 2013
Registration Data Access Protocol Query Format Registration Data Access Protocol Query Format
draft-ietf-weirds-rdap-query-06 draft-ietf-weirds-rdap-query-07
Abstract Abstract
This document describes uniform patterns to construct HTTP URLs that This document describes uniform patterns to construct HTTP URLs that
may be used to retrieve registration information from registries may be used to retrieve registration information from registries
(including both Regional Internet Registries (RIRs) and Domain Name (including both Regional Internet Registries (RIRs) and Domain Name
Registries (DNRs)) using "RESTful" web access patterns. Registries (DNRs)) using "RESTful" web access patterns.
Status of This Memo Status of This Memo
skipping to change at page 1, line 34 skipping to change at page 1, line 34
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on February 17, 2014. This Internet-Draft will expire on April 04, 2014.
Copyright Notice Copyright Notice
Copyright (c) 2013 IETF Trust and the persons identified as the Copyright (c) 2013 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 24 skipping to change at page 2, line 24
3.1.3. Domain Path Segment Specification . . . . . . . . . . 6 3.1.3. Domain Path Segment Specification . . . . . . . . . . 6
3.1.4. Name Server Path Segment Specification . . . . . . . 6 3.1.4. Name Server Path Segment Specification . . . . . . . 6
3.1.5. Entity Path Segment Specification . . . . . . . . . . 7 3.1.5. Entity Path Segment Specification . . . . . . . . . . 7
3.1.6. Help Path Segment Specification . . . . . . . . . . . 7 3.1.6. Help Path Segment Specification . . . . . . . . . . . 7
3.2. Search Path Segment Specification . . . . . . . . . . . . 8 3.2. Search Path Segment Specification . . . . . . . . . . . . 8
3.2.1. Domain Search . . . . . . . . . . . . . . . . . . . . 8 3.2.1. Domain Search . . . . . . . . . . . . . . . . . . . . 8
3.2.2. Name Server Search . . . . . . . . . . . . . . . . . 8 3.2.2. Name Server Search . . . . . . . . . . . . . . . . . 8
3.2.3. Entity Search . . . . . . . . . . . . . . . . . . . . 9 3.2.3. Entity Search . . . . . . . . . . . . . . . . . . . . 9
4. Search Processing . . . . . . . . . . . . . . . . . . . . . . 9 4. Search Processing . . . . . . . . . . . . . . . . . . . . . . 9
5. Extensibility . . . . . . . . . . . . . . . . . . . . . . . . 10 5. Extensibility . . . . . . . . . . . . . . . . . . . . . . . . 10
6. Internationalization Considerations . . . . . . . . . . . . . 10 6. Internationalization Considerations . . . . . . . . . . . . . 11
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
8. Security Considerations . . . . . . . . . . . . . . . . . . . 11 8. Security Considerations . . . . . . . . . . . . . . . . . . . 11
9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 11 9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 12
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 12 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 12
10.1. Normative References . . . . . . . . . . . . . . . . . . 12 10.1. Normative References . . . . . . . . . . . . . . . . . . 12
10.2. Informative References . . . . . . . . . . . . . . . . . 13 10.2. Informative References . . . . . . . . . . . . . . . . . 14
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 14 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 14
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 14 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 15
1. Conventions Used in This Document 1. Conventions Used in This Document
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119 [RFC2119]. document are to be interpreted as described in RFC 2119 [RFC2119].
1.1. Acronyms and Abbreviations 1.1. Acronyms and Abbreviations
IDN: Internationalized Domain Name IDN: Internationalized Domain Name
skipping to change at page 5, line 40 skipping to change at page 5, line 40
This is an example URL for the most specific network containing This is an example URL for the most specific network containing
2001:db8:1:1::1: 2001:db8:1:1::1:
/ip/2001:db8:1:1::1 /ip/2001:db8:1:1::1
3.1.2. Autonomous System Path Segment Specification 3.1.2. Autonomous System Path Segment Specification
Syntax: autnum/<autonomous system number> Syntax: autnum/<autonomous system number>
Queries for information regarding autonomous system number Queries for information regarding autonomous system number
registrations are of the form /autnum/XXX/... where XXX is an asplain registrations are of the form /autnum/XXX/... where XXX is an AS
autonomous system number [RFC5396]. In some registries, registration Plain autonomous system number [RFC5396]. In some registries,
of autonomous system numbers is done on an individual number basis, registration of autonomous system numbers is done on an individual
while other registries may register blocks of autonomous system number basis, while other registries may register blocks of
numbers. The semantics of this query are such that if a number falls autonomous system numbers. The semantics of this query are such that
within a range of registered blocks, the target of the query is the if a number falls within a range of registered blocks, the target of
block registration, and that individual number registrations are the query is the block registration, and that individual number
considered a block of numbers with a size of 1. registrations are considered a block of numbers with a size of 1.
For example, to find information on autonomous system number 65551, For example, to find information on autonomous system number 65551,
the following path would be used: the following path would be used:
/autnum/65551 /autnum/65551
The following path would be used to find information on 4-byte The following path would be used to find information on 4-byte
autonomous system number 65538: autonomous system number 65538:
/autnum/65538 /autnum/65538
skipping to change at page 8, line 28 skipping to change at page 8, line 28
character ('/', ASCII value 0x002F), and an HTTP query string. The character ('/', ASCII value 0x002F), and an HTTP query string. The
HTTP query string is formed using a concatenation of the question HTTP query string is formed using a concatenation of the question
mark character ('?', ASCII value 0x003F), the JSON object value mark character ('?', ASCII value 0x003F), the JSON object value
associated with the object being searched for, the equal sign associated with the object being searched for, the equal sign
character ('=', ASCII value 0x003D), and the search pattern. For the character ('=', ASCII value 0x003D), and the search pattern. For the
domain and entity objects described in this document the plural domain and entity objects described in this document the plural
object forms are "domains" and "entities". object forms are "domains" and "entities".
3.2.1. Domain Search 3.2.1. Domain Search
Syntax: domains/?ldhName=<domain search pattern> Syntax: domains?name=<domain search pattern>
Searches for domain information are of the form /domains/ Searches for domain information are of the form
?ldhName=XXXX, where XXXX is a search pattern representing a domain
name in "letters, digits, hyphen" format [RFC5890] in a zone
administered by the server operator of a DNR. The following path
would be used to find DNR information for domain names matching the
"example*.com" pattern:
/domains/?ldhName=example*.com /domains?name=XXXX
where XXXX is a search pattern representing a domain name in
"letters, digits, hyphen" format [RFC5890] in a zone administered by
the server operator of a DNR. The following path would be used to
find DNR information for domain names matching the "example*.com"
pattern:
/domains?name=example*.com
Internationalized Domain Names (IDNs) in U-label format [RFC5890] can Internationalized Domain Names (IDNs) in U-label format [RFC5890] can
also be used as search patterns (see Section 4). Searches for these also be used as search patterns (see Section 4). Searches for these
names are of the form /domains/?unicodeName=XXXX, where XXXX is a names are of the form /domains?name=XXXX, where XXXX is a search
search pattern representing a domain name in U-label format pattern representing a domain name in U-label format [RFC5890].
[RFC5890].
3.2.2. Name Server Search 3.2.2. Name Server Search
Syntax: nameservers/?ldhName=<nameserver search pattern> Syntax: nameservers?name=<nameserver search pattern>
Searches for name server information are of the form /nameservers/ Searches for name server information are of the form
?ldhName=XXXX, where XXXX is a search pattern representing a host /nameservers?name=XXXX
name in "letters, digits, hyphen" format [RFC5890] in a zone
administered by the server operator of a DNR. The following path
would be used to find DNR information for name server names matching
the "ns1.example*.com" pattern:
/nameservers/?ldhName=ns1.example*.com where XXXX is a search pattern representing a host name in "letters,
digits, hyphen" format [RFC5890] in a zone administered by the server
operator of a DNR. The following path would be used to find DNR
information for name server names matching the "ns1.example*.com"
pattern:
/nameservers?name=ns1.example*.com
Internationalized name server names in U-label format [RFC5890] can Internationalized name server names in U-label format [RFC5890] can
also be used as search patterns (see Section 4). Searches for these also be used as search patterns (see Section 4). Searches for these
names are of the form /nameservers/?unicodeName=XXXX, where XXXX is a names are of the form /nameservers?name=XXXX, where XXXX is a search
search pattern representing a name server name in U-label format pattern representing a name server name in U-label format [RFC5890].
[RFC5890].
3.2.3. Entity Search 3.2.3. Entity Search
Syntax: entities/?fn=<entity search pattern> Syntax: entities?fn=<entity name search pattern>
Syntax: entities?handle=<entity handle search pattern>
Searches for entity information by name are of the form
/entities?fn=XXXX
Searches for entity information are of the form /entities/?fn=XXXX,
where XXXX is a search pattern representing an entity name as where XXXX is a search pattern representing an entity name as
specified in Section 7.1 of [I-D.ietf-weirds-json-response]. The specified in Section 6.1 of [I-D.ietf-weirds-json-response]. The
following path would be used to find information for entity names following path would be used to find information for entity names
matching the "Bobby Joe*" pattern. matching the "Bobby Joe*" pattern.
/entities/?fn=Bobby%20Joe* /entities?fn=Bobby%20Joe*
Searches for entity information by handle are of the form
/entities?handle=XXXX
where XXXX is a search pattern representing an entity handle as
specified in Section 6.1 of [I-D.ietf-weirds-json-response]. The
following path would be used to find information for entity names
matching the "CID-40*" pattern.
/entities?handle=CID-40*
URLs MUST be properly encoded according to the rules of [RFC3986]. URLs MUST be properly encoded according to the rules of [RFC3986].
In the example above, "Bobby Joe*" is encoded to "Bobby%20Joe*". In the example above, "Bobby Joe*" is encoded to "Bobby%20Joe*".
4. Search Processing 4. Search Processing
Partial string searching uses the asterisk ('*', ASCII value 0x002A) Partial string searching uses the asterisk ('*', ASCII value 0x002A)
character to match zero or more trailing characters. Additional character to match zero or more trailing characters. Additional
pattern matching processing is beyond the scope of this pattern matching processing is beyond the scope of this
specification. specification.
If a server receives a search request but cannot process the request If a server receives a search request but cannot process the request
because it does not support a particular style of partial match because it does not support a particular style of partial match
searching, it SHOULD return an HTTP 422 [RFC4918] error. When searching, it SHOULD return an HTTP 422 [RFC4918] error. When
returning a 422 error, the server MAY also return an error response returning a 422 error, the server MAY also return an error response
body as specified in Section 12 of [I-D.ietf-weirds-json-response] if body as specified in Section 7 of [I-D.ietf-weirds-json-response] if
the requested media type is one that is specified in the requested media type is one that is specified in
[I-D.ietf-weirds-using-http]. [I-D.ietf-weirds-using-http].
Because Unicode characters may be combined with another Unicode Because Unicode characters may be combined with another Unicode
character or characters, partial matching is not feasible across character or characters, partial matching is not feasible across
combinations of Unicode characters. Servers SHOULD NOT partially combinations of Unicode characters. Servers SHOULD NOT partially
match combinations of Unicode characters where a Unicode character match combinations of Unicode characters where a Unicode character
may be legally combined with another Unicode character or characters. may be legally combined with another Unicode character or characters.
Clients MUST NOT issue a partial match search of Unicode characters Clients should avoid submitting a partial match search of Unicode
where a Unicode character may be legally combined with another characters where a Unicode character may be legally combined with
Unicode character or characters. Partial match searches with another Unicode character or characters. Partial match searches with
incomplete combinations of characters where a character must be incomplete combinations of characters where a character must be
combined with another character or characters are invalid. Partial combined with another character or characters are invalid. Partial
match searches with characters that may be combined with another match searches with characters that may be combined with another
character or characters are to be considered non-combined characters character or characters are to be considered non-combined characters
(that is, if character x maybe combined with character y but (that is, if character x may be combined with character y but
character y is not submitted in the search string then character x is character y is not submitted in the search string then character x is
a complete character and no combinations of character x are to a complete character and no combinations of character x are to be
searched). searched).
Because Unicode characters may be combined with another Unicode Because Unicode characters may be combined with another Unicode
character or characters, partial matching requires that a server character or characters, partial matching requires that a server
maintain a list of valid character combinations to be considered a maintain a list of valid character combinations to be considered a
match. When comparing DNS U-labels, servers SHOULD use the code match. When comparing DNS U-labels, servers SHOULD use the code
points specified in [RFC5892] to determine partial matches. When points specified in [RFC5892] to determine partial matches. When
comparing entity names, servers SHOULD use the normalization rules comparing entity names, servers SHOULD use the normalization rules
and code points specified by [I-D.ietf-precis-nickname] to determine and code points specified by [I-D.ietf-precis-nickname] to determine
partial matches. partial matches.
Clients SHOULD NOT submit search requests with partial matching for
DNS A-labels starting with 'xn--'. A-labels of this type represent
an encoding that can only be reconstructed properly when the label is
complete.
5. Extensibility 5. Extensibility
This document describes path segment specifications for a limited This document describes path segment specifications for a limited
number of objects commonly registered in both RIRs and DNRs. It does number of objects commonly registered in both RIRs and DNRs. It does
not attempt to describe path segments for all of the objects not attempt to describe path segments for all of the objects
registered in all registries. Custom path segments can be created registered in all registries. Custom path segments can be created
for objects not specified here using the process described in for objects not specified here using the process described in
Section TBD of "Using HTTP for RESTful Whois Services by Internet Section 6 of "HTTP usage in the Registration Data Access Protocol
Registries" [I-D.ietf-weirds-using-http]. (RDAP)" [I-D.ietf-weirds-using-http].
Custom path segments can be created by prefixing the segment with a Custom path segments can be created by prefixing the segment with a
unique identifier followed by an underscore character (0x5F). For unique identifier followed by an underscore character (0x5F). For
example, a custom entity path segment could be created by prefixing example, a custom entity path segment could be created by prefixing
"entity" with "custom_", producing "custom_entity". Servers MUST "entity" with "custom_", producing "custom_entity". Servers MUST
return an appropriate failure status code for a request with an return an appropriate failure status code for a request with an
unrecognized path segment. unrecognized path segment.
6. Internationalization Considerations 6. Internationalization Considerations
skipping to change at page 11, line 32 skipping to change at page 11, line 47
described in "Security Services for the Registration Data Access described in "Security Services for the Registration Data Access
Protocol" [I-D.ietf-weirds-rdap-sec]. Protocol" [I-D.ietf-weirds-rdap-sec].
Search functionality typically requires more server resources (such Search functionality typically requires more server resources (such
as memory, CPU cycles, and network bandwidth) when compared to basic as memory, CPU cycles, and network bandwidth) when compared to basic
lookup functionality. This increases the risk of server resource lookup functionality. This increases the risk of server resource
exhaustion and subsequent denial of service due to abuse. This risk exhaustion and subsequent denial of service due to abuse. This risk
can be mitigated by developing and implementing controls to restrict can be mitigated by developing and implementing controls to restrict
search functionality to identified and authorized clients. If those search functionality to identified and authorized clients. If those
clients behave badly, their search privileges can be suspended or clients behave badly, their search privileges can be suspended or
revoked. Rate limiting as described in Section 5.5 of "Using the revoked. Rate limiting as described in Section 5.5 of "HTTP usage in
Registration Data Access Protocol (RDAP) with HTTP" the Registration Data Access Protocol (RDAP)"
[I-D.ietf-weirds-using-http] can also be used to control the rate of [I-D.ietf-weirds-using-http] can also be used to control the rate of
received search requests. Server operators can also reduce their received search requests. Server operators can also reduce their
risk by restricting the amount of information returned in response to risk by restricting the amount of information returned in response to
a search request. a search request.
9. Acknowledgements 9. Acknowledgements
This document is derived from original work on RIR query formats This document is derived from original work on RIR query formats
developed by Byron J. Ellacott of APNIC, Arturo L. Servin of LACNIC, developed by Byron J. Ellacott of APNIC, Arturo L. Servin of LACNIC,
Kaveh Ranjbar of the RIPE NCC, and Andrew L. Newton of ARIN. Kaveh Ranjbar of the RIPE NCC, and Andrew L. Newton of ARIN.
skipping to change at page 12, line 17 skipping to change at page 12, line 31
10.1. Normative References 10.1. Normative References
[I-D.ietf-precis-nickname] [I-D.ietf-precis-nickname]
Saint-Andre, P., "Preparation and Comparison of Saint-Andre, P., "Preparation and Comparison of
Nicknames", draft-ietf-precis-nickname-06 (work in Nicknames", draft-ietf-precis-nickname-06 (work in
progress), July 2013. progress), July 2013.
[I-D.ietf-weirds-json-response] [I-D.ietf-weirds-json-response]
Newton, A. and S. Hollenbeck, "JSON Responses for the Newton, A. and S. Hollenbeck, "JSON Responses for the
Registration Data Access Protocol (RDAP)", draft-ietf- Registration Data Access Protocol (RDAP)", draft-ietf-
weirds-json-response-04 (work in progress), June 2013. weirds-json-response-05 (work in progress), August 2013.
[I-D.ietf-weirds-rdap-sec] [I-D.ietf-weirds-rdap-sec]
Hollenbeck, S. and N. Kong, "Security Services for the Hollenbeck, S. and N. Kong, "Security Services for the
Registration Data Access Protocol", draft-ietf-weirds- Registration Data Access Protocol", draft-ietf-weirds-
rdap-sec-04 (work in progress), June 2013. rdap-sec-05 (work in progress), August 2013.
[I-D.ietf-weirds-using-http] [I-D.ietf-weirds-using-http]
Newton, A., Ellacott, B., and N. Kong, "HTTP usage in the Newton, A., Ellacott, B., and N. Kong, "HTTP usage in the
Registration Data Access Protocol (RDAP)", draft-ietf- Registration Data Access Protocol (RDAP)", draft-ietf-
weirds-using-http-07 (work in progress), July 2013. weirds-using-http-07 (work in progress), July 2013.
[RFC0952] Harrenstien, K., Stahl, M., and E. Feinler, "DoD Internet [RFC0952] Harrenstien, K., Stahl, M., and E. Feinler, "DoD Internet
host table specification", RFC 952, October 1985. host table specification", RFC 952, October 1985.
[RFC1123] Braden, R., "Requirements for Internet Hosts - Application [RFC1123] Braden, R., "Requirements for Internet Hosts - Application
skipping to change at page 14, line 37 skipping to change at page 15, line 5
Included a multitude of minor additions and clarifications Included a multitude of minor additions and clarifications
provided by Marc Blanchet and Jean-Philippe Dionne. Modified the provided by Marc Blanchet and Jean-Philippe Dionne. Modified the
domain and name server sections to include support for IDN domain and name server sections to include support for IDN
U-labels. U-labels.
-04: Updated the domain and name server sections to use .example IDN -04: Updated the domain and name server sections to use .example IDN
U-labels. Added text to note that mixed IDN labels SHOULD NOT be U-labels. Added text to note that mixed IDN labels SHOULD NOT be
used. Fixed broken sentences in Section 6. used. Fixed broken sentences in Section 6.
-05: Added "help" path segment. -05: Added "help" path segment.
-06: Added search text and removed or edited old search text. -06: Added search text and removed or edited old search text.
-07: Fixed query parameter typo by replacing "/?" with "?". Changed
"asplain" to "AS Plain". Added entity search by handle.
Corrected section references. Updated IDN search text.
Authors' Addresses Authors' Addresses
Andrew Lee Newton Andrew Lee Newton
American Registry for Internet Numbers American Registry for Internet Numbers
3635 Concorde Parkway 3635 Concorde Parkway
Chantilly, VA 20151 Chantilly, VA 20151
US US
Email: andy@arin.net Email: andy@arin.net
URI: http://www.arin.net URI: http://www.arin.net
 End of changes. 31 change blocks. 
60 lines changed or deleted 77 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/