draft-ietf-crisp-iris-common-transport-05.txt   rfc4991.txt 
Network Working Group A. Newton Network Working Group A. Newton
Internet-Draft VeriSign, Inc. Request for Comments: 4991 VeriSign, Inc.
Intended status: Standards Track March 5, 2007 Category: Standards Track August 2007
Expires: September 6, 2007
A Common Schema for Internet Registry Information Service Transfer
Protocols
draft-ietf-crisp-iris-common-transport-05
Status of this Memo
By submitting this Internet-Draft, each author represents that any
applicable patent or other IPR claims of which he or she is aware
have been or will be disclosed, and any of which he or she becomes
aware will be disclosed, in accordance with Section 6 of BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet-
Drafts.
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."
The list of current Internet-Drafts can be accessed at A Common Schema for Internet Registry Information Service
http://www.ietf.org/ietf/1id-abstracts.txt. Transfer Protocols
The list of Internet-Draft Shadow Directories can be accessed at Status of This Memo
http://www.ietf.org/shadow.html.
This Internet-Draft will expire on September 6, 2007. This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Copyright Notice Copyright Notice
Copyright (C) The IETF Trust (2007). Copyright (C) The IETF Trust (2007).
Abstract Abstract
This document describes an XML Schema for use by Internet Registry This document describes an XML Schema for use by Internet Registry
Information Service (IRIS) application transfer protocols that share Information Service (IRIS) application transfer protocols that share
common characteristics. It describes common information about the common characteristics. It describes common information about the
transfer protocol, such as version, supported extensions, and transfer protocol, such as version, supported extensions, and
supported security mechanisms. supported security mechanisms.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Document Terminology . . . . . . . . . . . . . . . . . . . . . 4 2. Document Terminology . . . . . . . . . . . . . . . . . . . . . 2
3. Formal XML Syntax . . . . . . . . . . . . . . . . . . . . . . 5 3. Formal XML Syntax . . . . . . . . . . . . . . . . . . . . . . 3
4. Version Information . . . . . . . . . . . . . . . . . . . . . 8 4. Version Information . . . . . . . . . . . . . . . . . . . . . 6
5. Size Information . . . . . . . . . . . . . . . . . . . . . . . 10 5. Size Information . . . . . . . . . . . . . . . . . . . . . . . 7
6. Authentication Success Information . . . . . . . . . . . . . . 11 6. Authentication Success Information . . . . . . . . . . . . . . 8
7. Authentication Failure Information . . . . . . . . . . . . . . 12 7. Authentication Failure Information . . . . . . . . . . . . . . 8
8. Other Information . . . . . . . . . . . . . . . . . . . . . . 13 8. Other Information . . . . . . . . . . . . . . . . . . . . . . 9
9. Internationalization Considerations . . . . . . . . . . . . . 14 9. Internationalization Considerations . . . . . . . . . . . . . 9
10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 15 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 10
10.1. XML Namespace URN Registration . . . . . . . . . . . . . 15 10.1. XML Namespace URN Registration . . . . . . . . . . . . . 10
11. Security Considerations . . . . . . . . . . . . . . . . . . . 16 11. Security Considerations . . . . . . . . . . . . . . . . . . . 10
12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 17 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 11
12.1. Normative References . . . . . . . . . . . . . . . . . . 17 12.1. Normative References . . . . . . . . . . . . . . . . . . 11
12.2. Informative References . . . . . . . . . . . . . . . . . 17 12.2. Informative References . . . . . . . . . . . . . . . . . 11
Appendix A. Contributors . . . . . . . . . . . . . . . . . . . . 18 Appendix A. Contributors . . . . . . . . . . . . . . . . . . . . 12
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 19
Intellectual Property and Copyright Statements . . . . . . . . . . 20
1. Introduction 1. Introduction
IRIS [8] has two transfer protocols, LWZ [9] and XPC [10], that share IRIS [8] has two transfer protocols, LWZ (lightweight using
common negotiation mechanisms. Both transfer protocols have a need compression) [9] and XPC (XML pipelining with chunks) [10], that
for the server to provide rich status information to clients during share common negotiation mechanisms. Both transfer protocols have a
protocol negotiation. In many cases, this status information would need for the server to provide rich status information to clients
be too complex to describe using simple bit fields and length- during protocol negotiation. In many cases, this status information
specifed octet sequences. This document defines an XML Schema for would be too complex to describe using simple bit fields and length-
this rich status information and describes the usage of comforant XML specified octet sequences. This document defines an XML Schema for
for conveying this status information. this rich status information and describes the usage of conformant
XML for conveying this status information.
This document defines five types of information used in the This document defines five types of information used in the
negotiation of protocol capabilities: version, size, authentication negotiation of protocol capabilities: version, size, authentication
success, authentication failure, and other information. The version success, authentication failure, and other information. The version
information is used to negotiate the versions and extensions to the information is used to negotiate the versions and extensions to the
transfer protocol, the application operations protocol, and data transfer protocol, the application operations protocol, and data
models used by the application operations. Size information is used models used by the application operations. Size information is used
to indicate request and response size capabilities and errors. to indicate request and response size capabilities and errors.
Authentication failure and success information is used to indicate Authentication success and failure information is used to indicate
the outcome of an authentication action. Other types of information the outcome of an authentication action. Other types of information
may also be conveyed that is generally a result of an error but may also be conveyed that is generally a result of an error but
cannot be corrected through defined protocol behavior. cannot be corrected through defined protocol behavior.
As an example, upon initiation of a connection, a server may send As an example, upon initiation of a connection, a server may send
version information informing the client the data models supported by version information informing the client of the data models supported
the server and the security mechanims supported by the server. The by the server and the security mechanisms supported by the server.
client may then respond appropriately. For example, the client may The client may then respond appropriately. For example, the client
not recognize any of the data models supported by the server, and may not recognize any of the data models supported by the server, and
thefore close the connection. On the other hand, the client may therefore close the connection. On the other hand, the client may
recognize the data models and the security mechanisms and begin the recognize the data models and the security mechanisms and begin the
procedure to initialize a security mechanism with the server before procedure to initialize a security mechanism with the server before
proceeding to query data according to a recognized data model. proceeding to query data according to a recognized data model.
Both LWZ [9] and XPC [10] provide examples of the usage of the XML Both LWZ [9] and XPC [10] provide examples of the usage of the XML
Schema defined in this document. Schema defined in this document.
2. Document Terminology 2. Document Terminology
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 RFC2119 [6]. document are to be interpreted as described in RFC2119 [6].
3. Formal XML Syntax 3. Formal XML Syntax
The following is the XML Schema used to define transfer protocol The following is the XML Schema used to define transfer protocol
status information. See the following specifications: [2], [3], [4], status information. See the following specifications: [2], [3], [4],
[5]. [5]. Updates or changes to this schema require a document that
UPDATES or OBSOLETES this document.
<?xml version="1.0"?> <?xml version="1.0"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema" <schema xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:iristrans="urn:ietf:params:xml:ns:iris-transport" xmlns:iristrans="urn:ietf:params:xml:ns:iris-transport"
targetNamespace="urn:ietf:params:xml:ns:iris-transport" targetNamespace="urn:ietf:params:xml:ns:iris-transport"
elementFormDefault="qualified" > elementFormDefault="qualified" >
<annotation> <annotation>
<documentation> <documentation>
A schema for describing status information A schema for describing status information
skipping to change at page 8, line 39 skipping to change at page 6, line 39
'authenticationIds', 'responseSizeOctets', and 'requestSizeOctets' 'authenticationIds', 'responseSizeOctets', and 'requestSizeOctets'
attributes. The 'authenticationIds' attribute identifies attributes. The 'authenticationIds' attribute identifies
authentication mechanisms supported by the associated transfer authentication mechanisms supported by the associated transfer
protocol. The 'responseSizeOctets' attribute describes the maximum protocol. The 'responseSizeOctets' attribute describes the maximum
response size in octets the server will give. The response size in octets the server will give. The
'requestSizeOctets' attribute describes the maximum request size in 'requestSizeOctets' attribute describes the maximum request size in
octets the server will accept. octets the server will accept.
The protocol, extension, and authentication mechanism identifiers are The protocol, extension, and authentication mechanism identifiers are
of no specific type, and this document defines none. Specifications of no specific type, and this document defines none. Specifications
using this XML Schema MUST define the identifers for use with the using this XML Schema MUST define the identifiers for use with the
<versions> element and its children. <versions> element and its children.
The meaning of octets for the transfer of data is counted in The meaning of octets for the transfer of data is counted in
different ways for different transfer protocols. Some transfer different ways for different transfer protocols. Some transfer
protocols need only to specify the octets of the data being protocols need only to specify the octets of the data being
transfered while other transfer protocols need to account for transferred, while other transfer protocols need to account for
additional octets used to transfer the data. Specifications using additional octets used to transfer the data. Specifications using
this XML Schema MUST describe how these octet counts are calculated. this XML Schema MUST describe how these octet counts are calculated.
The following is example XML describing version information. The following is example XML describing version information.
<versions xmlns="urn:ietf:params:xml:ns:iris-transport"> <versions xmlns="urn:ietf:params:xml:ns:iris-transport">
<transferProtocol protocolId="iris.lwz" <transferProtocol protocolId="iris.lwz"
authenticationIds="PLAIN EXTERNAL"> authenticationIds="PLAIN EXTERNAL">
<application protocolId="urn:ietf:params:xml:ns:iris1" <application protocolId="urn:ietf:params:xml:ns:iris1"
extensionIds="http://example.com/SIMPLEBAG"> extensionIds="http://example.com/SIMPLEBAG">
skipping to change at page 10, line 27 skipping to change at page 7, line 42
<octets> - this child element indicates that the size exceeded the <octets> - this child element indicates that the size exceeded the
negotiated size and conveys the number of octets that is the negotiated size and conveys the number of octets that is the
maximum for a request if the parent element is a <request> element maximum for a request if the parent element is a <request> element
or the number of octets needed to provide the response if the or the number of octets needed to provide the response if the
parent element is a <response> element. parent element is a <response> element.
The meaning of octets for the transfer of data is counted in The meaning of octets for the transfer of data is counted in
different ways for different transfer protocols. Some transfer different ways for different transfer protocols. Some transfer
protocols need only to specify the octets of the data being protocols need only to specify the octets of the data being
transfered while other transfer protocols need to account for transferred, while other transfer protocols need to account for
additional octets used to transfer the data. Specifications using additional octets used to transfer the data. Specifications using
this XML Schema MUST describe how these octet counts are calculated. this XML Schema MUST describe how these octet counts are calculated.
The following is example XML describing size information. The following is example XML describing size information.
<size xmlns="urn:ietf:params:xml:ns:iris-transport"> <size xmlns="urn:ietf:params:xml:ns:iris-transport">
<response> <response>
<octets>1211</octets> <octets>1211</octets>
</response> </response>
</size> </size>
skipping to change at page 11, line 14 skipping to change at page 8, line 15
6. Authentication Success Information 6. Authentication Success Information
The <authenticationSuccess> element indicates that a client has The <authenticationSuccess> element indicates that a client has
successfully authenticated to a server. Along with this indication, successfully authenticated to a server. Along with this indication,
it can provide text that may be presented to a user with regard to it can provide text that may be presented to a user with regard to
this successful authentication using child <description> elements. this successful authentication using child <description> elements.
Each <description> element MUST have a 'language' attribute Each <description> element MUST have a 'language' attribute
describing the language of the content of the <description> element. describing the language of the content of the <description> element.
Clients are not expected to concatenate multiple descriptions, Clients are not expected to concatenate multiple descriptions;
therefore servers MUST NOT provide multiple <description> elements therefore, servers MUST NOT provide multiple <description> elements
with the same language descriptor. with the same language descriptor.
Finally, additional security data may be sent back with the Finally, additional security data may be sent back with the
authentication sucess message using the <data> element. The content authentication success message using the <data> element. The content
of this element is of the base64Binary simple type. of this element is of the base64Binary simple type.
The following is example XML describing authentication success The following is example XML describing authentication success
information. information.
<authenticationSuccess <authenticationSuccess
xmlns="urn:ietf:params:xml:ns:iris-transport"> xmlns="urn:ietf:params:xml:ns:iris-transport">
<description language="en"> <description language="en">
user 'bob' authenticates via password user 'bob' authenticates via password
</description> </description>
skipping to change at page 12, line 15 skipping to change at page 8, line 45
7. Authentication Failure Information 7. Authentication Failure Information
The <authenticationFailure> element indicates that a client has The <authenticationFailure> element indicates that a client has
failed to properly authenticate to a server. Along with this failed to properly authenticate to a server. Along with this
indication, it can provide text that may be presented to a user with indication, it can provide text that may be presented to a user with
regard to this authentication failure using child <description> regard to this authentication failure using child <description>
elements. elements.
Each <description> element MUST have a 'language' attribute Each <description> element MUST have a 'language' attribute
describing the language of the content of the <description> element. describing the language of the content of the <description> element.
Clients are not expected to concatenate multiple descriptions, Clients are not expected to concatenate multiple descriptions;
therefore servers MUST NOT provide multiple <description> elements therefore, servers MUST NOT provide multiple <description> elements
with the same language descriptor. with the same language descriptor.
The following is example XML describing authentication failure The following is example XML describing authentication failure
information. information.
<authenticationFailure <authenticationFailure
xmlns="urn:ietf:params:xml:ns:iris-transport"> xmlns="urn:ietf:params:xml:ns:iris-transport">
<description language="en"> <description language="en">
please consult your admin if you have forgotten your password please consult your admin if you have forgotten your password
</description> </description>
</authenticationFailure> </authenticationFailure>
Authentication Failure Example Authentication Failure Example
8. Other Information 8. Other Information
The <other> element conveys status information that may require The <other> element conveys status information that may require
interpretation by a human to be meaningful. This element has a interpretation by a human to be meaningful. This element has a
required 'type' attribute which contains an identifier regarding the required 'type' attribute, which contains an identifier regarding the
nature of the information. This document does not define any nature of the information. This document does not define any
identifiers for use in this attribute, but the intent is that these identifiers for use in this attribute, but the intent is that these
identifiers are well-known so that clients may take different classes identifiers are well-known so that clients may take different classes
of action based on the content of this attribute. Therefore, of action based on the content of this attribute. Therefore,
specifications making use of this XML Schema MUST define these specifications making use of this XML Schema MUST define these
identifiers. identifiers.
The <other> element may have zero or more <description> elements. The <other> element may have zero or more <description> elements.
Each <description> element MUST have a 'language' attribute Each <description> element MUST have a 'language' attribute
describing the language of the content of the <description> element. describing the language of the content of the <description> element.
Servers may use these child elements to convey textual information to Servers may use these child elements to convey textual information to
clients regarding the class (or type) of status information being clients regarding the class (or type) of status information being
specified by the <other> element. Clients are not expected to specified by the <other> element. Clients are not expected to
concatenate multiple descriptions, therefore servers MUST NOT provide concatenate multiple descriptions; therefore, servers MUST NOT
multiple <description> elements with the same language descriptor. provide multiple <description> elements with the same language
descriptor.
The following is example XML describing other information. The following is example XML describing other information.
<other xmlns="urn:ietf:params:xml:ns:iris-transport" type="system"> <other xmlns="urn:ietf:params:xml:ns:iris-transport" type="system">
<description language="en">unavailable, come back <description language="en">unavailable, come back
later</description> later</description>
</other> </other>
Other Information Example Other Information Example
skipping to change at page 15, line 10 skipping to change at page 10, line 10
encodings. XML provides for mechanisms to identify and use other encodings. XML provides for mechanisms to identify and use other
character encodings. Application transfer protocols MUST define character encodings. Application transfer protocols MUST define
which additional character encodings, if any, are to be allowed in which additional character encodings, if any, are to be allowed in
the use of the XML defined in this document. the use of the XML defined in this document.
10. IANA Considerations 10. IANA Considerations
10.1. XML Namespace URN Registration 10.1. XML Namespace URN Registration
This document makes use of the XML namespace and schema registry This document makes use of the XML namespace and schema registry
specified in XML_URN [7]. Accordingly, the following registration specified in XML_URN [7]. Accordingly, the following registrations
information is provided for the IANA: have been made by IANA:
o XML Namespace URN/URI: o XML Namespace URN/URI:
* urn:ietf:params:xml:ns:iris-transport * urn:ietf:params:xml:ns:iris-transport
o Contact: o Contact:
* Andrew Newton <andy@hxr.us> * Andrew Newton <andy@hxr.us>
o XML: o XML:
* None. * None
o XML Schema URN/URI: o XML Schema URN/URI:
* urn:ietf:params:xml:schema:iris-transport * urn:ietf:params:xml:schema:iris-transport
o Contact: o Contact:
* Andrew Newton <andy@hxr.us> * Andrew Newton <andy@hxr.us>
o XML: o XML:
* The XML Schema specified in Section 3 * The XML Schema specified in Section 3
11. Security Considerations 11. Security Considerations
Transfer protocols using XML conformant to the XML Schema in this Transfer protocols using XML conformant to the XML Schema in this
document and offering security properties such as authentication and document and offering security properties such as authentication and
confidentiality SHOULD offer an initial message from the server to confidentiality SHOULD offer an initial message from the server to
the client using the <version> element. This <version> element the client using the <versions> element. This <versions> element
SHOULD contain all relevant authentication identifiers in its SHOULD contain all relevant authentication identifiers in its
'autheticationId' attribute. The purpose of providing this initial 'authenticationId' attribute. The purpose of providing this initial
message is to help thwart downgrade attacks. message is to help thwart downgrade attacks.
12. References 12. References
12.1. Normative References 12.1. Normative References
[1] The Unicode Consortium, "The Unicode Standard, Version 3", [1] The Unicode Consortium, "The Unicode Standard, Version 3", ISBN
ISBN 0-201-61633-5, 2000, <The Unicode Standard, Version 3>. 0-201-61633-5, 2000, <The Unicode Standard, Version 3>.
[2] World Wide Web Consortium, "Extensible Markup Language (XML) [2] World Wide Web Consortium, "Extensible Markup Language (XML)
1.0", W3C XML, February 1998, 1.0", W3C XML, February 1998, <http://www.w3.org/TR/1998/REC-
<http://www.w3.org/TR/1998/REC-xml-19980210>. xml-19980210>.
[3] World Wide Web Consortium, "Namespaces in XML", W3C XML [3] World Wide Web Consortium, "Namespaces in XML", W3C XML
Namespaces, January 1999, Namespaces, January 1999, <http://www.w3.org/TR/1999/REC-xml-
<http://www.w3.org/TR/1999/REC-xml-names-19990114>. names-19990114>.
[4] World Wide Web Consortium, "XML Schema Part 2: Datatypes", [4] World Wide Web Consortium, "XML Schema Part 2: Datatypes", W3C
W3C XML Schema, October 2004, XML Schema, October 2004, <http://www.w3.org/TR/xmlschema-2/>.
<http://www.w3.org/TR/xmlschema-2/>.
[5] World Wide Web Consortium, "XML Schema Part 1: Structures", [5] World Wide Web Consortium, "XML Schema Part 1: Structures", W3C
W3C XML Schema, October 2004, XML Schema, October 2004, <http://www.w3.org/TR/xmlschema-1/>.
<http://www.w3.org/TR/xmlschema-1/>.
[6] Bradner, S., "Key words for use in RFCs to Indicate [6] Bradner, S., "Key words for use in RFCs to Indicate Requirement
Requirement Levels", RFC 2119, BCP 14, March 1997. Levels", RFC 2119, BCP 14, March 1997.
[7] Mealling, M., "The IETF XML Registry", RFC 3688, BCP 81, [7] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
February 2004. January 2004.
12.2. Informative References 12.2. Informative References
[8] Newton, A. and M. Sanz, "Internet Registry Information [8] Newton, A. and M. Sanz, "IRIS: The Internet Registry
Service", RFC 3981, January 2004. Information Service (IRIS) Core Protocol", RFC 3981, January
2005.
[9] Newton, A., "A Lightweight UDP Transfer Protocol for the [9] Newton, A., "A Lightweight UDP Transfer Protocol for the
Internet Registry Information Service", Internet Registry Information Service", RFC 4993, August 2007.
draft-ietf-crips-iris-lwz-02 (work in progress), April 2005.
[10] Newton, A., "XML Pipelining with Chunks for the Internet [10] Newton, A., "XML Pipelining with Chunks for the Internet
Registry Information Service", draft-ietf-crips-iris-xpc-00 Registry Information Service", RFC 4992, August 2007.
(work in progress), April 2005.
Appendix A. Contributors Appendix A. Contributors
Substantive contributions to this document have been provided by the Substantive contributions to this document have been provided by the
members of the IETF's CRISP Working Group, especially Robert Martin- members of the IETF's CRISP Working Group, especially Robert
Legene, Milena Caires, and David Blacka. Martin-Legene, Milena Caires, and David Blacka.
Author's Address Author's Address
Andrew L. Newton Andrew L. Newton
VeriSign, Inc. VeriSign, Inc.
21345 Ridgetop Circle 21345 Ridgetop Circle
Sterling, VA 20166 Sterling, VA 20166
USA USA
Phone: +1 703 948 3382 Phone: +1 703 948 3382
Email: andy@hxr.us EMail: andy@hxr.us
URI: http://www.verisignlabs.com/ URI: http://www.verisignlabs.com/
Full Copyright Statement Full Copyright Statement
Copyright (C) The IETF Trust (2007). Copyright (C) The IETF Trust (2007).
This document is subject to the rights, licenses and restrictions This document is subject to the rights, licenses and restrictions
contained in BCP 78, and except as set forth therein, the authors contained in BCP 78, and except as set forth therein, the authors
retain all their rights. retain all their rights.
skipping to change at page 20, line 45 skipping to change at page 13, line 45
such proprietary rights by implementers or users of this such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at specification can be obtained from the IETF on-line IPR repository at
http://www.ietf.org/ipr. http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at this standard. Please address the information to the IETF at
ietf-ipr@ietf.org. ietf-ipr@ietf.org.
Acknowledgment Acknowledgement
Funding for the RFC Editor function is provided by the IETF Funding for the RFC Editor function is currently provided by the
Administrative Support Activity (IASA). Internet Society.
 End of changes. 35 change blocks. 
104 lines changed or deleted 83 lines changed or added

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