UDDI Spec TC
1
UDDI Spec TC Change Request
2
Valid Characters for UDDI Keys
3
4
Document identifier:
uddi-spec-tc-cr-009-20030304
5
Location:
6
7
8
http://www.oasis-open.org/committees/uddi-spec/doc/cr/uddi-spec-tc-cr-00920030304.doc
Document Control:
9
Administration Block
Change Request ID
CR-009
10
11
Document Identification Block
Title
Correction for legal key characters
Spec Versions
Affected by this
Change Request
V1
V2
V3

12
13
14
15
Editor:
16
17
18
19
20
Contributors:
Andrew Hately
Claus von Riegen
Sam Lee
21
22
23
Abstract:
This document updates the description in the V3 Specification of the characters that are
allowed in UDDI keys.
John Colgrave
24
25
Status:
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 1 of 13
26
This document is updated periodically on no particular schedule.
27
28
29
30
31
Committee members should send comments on this change request to the uddispec@lists.oasis-open.org list. Others should subscribe to and send comments to the
uddi-spec-comment@lists.oasis-open.org list. To subscribe, send an email message to
uddi-spec-comment-request@lists.oasis-open.org with the word "subscribe" as the body
of the message.
32
33
34
35
For information on whether any patents have been disclosed that may be essential to
implementing this change request, and any offers of patent licensing terms, please refer
to the Intellectual Property Rights section of the UDDI Spec TC web page
(http://www.oasis-open.org/committees/uddi-spec/).
36
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 2 of 13
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Table of Contents
1
Problem Outline ...................................................................................................................... 4
1.1 Terminology........................................................................................................................... 4
2
Solution Outline ....................................................................................................................... 5
2.1 Notes ..................................................................................................................................... 5
3
Impact Statement (optional) .................................................................................................... 6
4
Spec Change Detail ................................................................................................................ 7
4.1 Section 4.4 ............................................................................................................................ 7
4.2 Section 4.4.1 ......................................................................................................................... 7
4.3 Section 9.6.4 ......................................................................................................................... 8
5
Alternatives Considered (optional) .......................................................................................... 9
6
References ............................................................................................................................ 10
6.1 Normative ............................................................................................................................ 10
Appendix A. Acknowledgments ..................................................................................................... 11
Appendix B. Revision History ........................................................................................................ 12
Appendix C. Notices ...................................................................................................................... 13
53
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 3 of 13
54
1 Problem Outline
55
56
There are several problems with the description of the valid characters for keys in the UDDI V3
Specification:
57
58
1. The “%” character is missing from the valid characters, meaning that keys cannot contain
encoded characters.
59
2. Several of the “reserved” characters from RFC 2396 are missing but others are included.
60
3. Several of the “mark” characters from RFC 2396 are missing but others are included.
61
4. The characters “E” and “e” are missing from the definition of hexNumber.
62
63
5. An IP Address is not allowed, only a name.[ Was that intentional? If not, should IPv6
addresses be allowed (per RFC 2373) in addition to IPv4?]
64
6. There is an unnecessary reference to RFC 2459 for the definition of domain/dNSname.
65
1.1 Terminology
66
67
The key words must, must not, required, shall, shall not, should, should not, recommended, may,
and optional in this document are to be interpreted as described in RFC2119.
68
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 4 of 13
69
2 Solution Outline
70
71
The proposed solution is to describe UDDI keys using the ABNF [RFC2234] form of the relevant
parts of RFC2396, written to use the ABNF core where appropriate.
72
73
All keys in the (unofficial) uddi scheme correspond to the absoluteURI production in RFC 2396,
using opaque_part.
74
2.1 Notes
75
There are some extra restrictions on domain names that cannot be captured in ABNF.
76
77
The maximum length of a string representation of a domain name is 253 bytes/octets (deduced
from RFC1034).
78
The maximum length of an individual domainlabel is 63 bytes/octets.
79
80
There is an additional restriction on KSS that is not captured in the ABNF syntax above.
81
KSS MUST NOT be “keyGenerator”.
82
This is done to exclude the cases such as uddi:tempuri.com:keyGenerator:keyGenerator.
83
84
85
86
I have not reproduced the definitions from the ABNF core. Note that the core definition of
HEXDIG will also match lower-case characters due to the fact that ABNF strings are caseinsensitive.
87
88
The old syntax allowed the scheme name to be upper case, i.e. “UDDI:” but this would not be
valid as RFC 2396 requires the first letter at least to be lower case.
89
A lot of this is the ABNF form of a subset of what is defined in RFC 2396.
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 5 of 13
90
3 Impact Statement (optional)
91
92
The impact of this change is to increase the characters that can be used in UDDI keys so the
impact is small.
93
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 6 of 13
94
4 Spec Change Detail
95
4.1 Section 4.4
96
97
98
99
100
Replace the existing opening sentence “UDDI registries MUST use URIs conforming to RFC
2396 for keys.” with the following: “UDDI registries MUST use keys that conform to the following
grammar. All UDDI keys are URIs that conform to RFC 2396 but not all URIs are valid UDDI
keys. The URIs that are valid as UDDI keys correspond to a subset of the opaque_part
alternative of the absoluteURI rule in RFC 2396.”
101
4.2 Section 4.4.1
102
Replace the entire section with the following:
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
uddiScheme
=
%d117.100.100.105
uddiKey
=
nonKeyGeneratorKey / keyGeneratorKey
nonKeyGeneratorKey
=
uuidKey / domainKey / derivedKey
uuidKey
=
uddiScheme “:” uuid_part
uuid_part
=
8HEXDIG “-“
4HEXDIG “-“
4HEXDIG “-“
4HEXDIG “-“
12HEXDIG
domainKey
=
uddiScheme “:” hostname
hostname
=
*(domainlabel “.”) toplabel [“.”]
domainlabel
=
alphanum /
alphanum *(alphanum / “-“) alphanum
toplabel
=
ALPHA / ALPHA *(alphanum / “-“) alphanum
alphanum
=
ALPHA / DIGIT
derivedKey
=
nonKeyGeneratorKey “:” KSS
keyGeneratorKey
=
nonKeyGeneratorKey “:” “keyGenerator”
KSS
=
1*uric ; KSS MUST NOT be “keyGenerator”
uric
=
reserved / unreserved / escaped
reserved
=
“;” / “/” / “?” / “:” / “@” / “&” /
“=” / “+” / “$” / “,”
unreserved
=
alphanum / mark
mark
=
“-” / “_” / “.” / “!” / “~” / “*” /
“’” / “(“ / “)”
escaped
=
“%”
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
; “uddi” in lower case
HEXDIG HEXDIG
6 March 2016
Page 7 of 13
145
146
There are some extra restrictions on domain names that are not captured in the ABNF syntax
above:
147
1. The maximum length of a string representation of a hostname is 253 characters/octets.
148
2. The maximum length of an individual domainlabel is 63 characters/octets.
149
150
There is an additional restriction on KSS that is not captured in the ABNF syntax above:
1. KSS MUST NOT be “keyGenerator”.
151
4.3 Section 9.6.4
152
153
154
Replace the opening sentence “UDDI MUST use URIs conforming to RFC 2396 for keys.” with
the following: “UDDI registries MUST use keys that conform to the grammar in Section 4.4 About
uddiKeys.”
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 8 of 13
155
5 Alternatives Considered (optional)
156
No alternatives were considered.
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 9 of 13
157
6 References
158
6.1 Normative
159
160
161
162
163
164
165
166
167
168
[RFC1034]
[RFC2119]
[RFC2234]
[RFC2396]
P. Mockapetris, DOMAIN NAMES – CONCEPTS AND FACILITIES,
http://www.ietf.org/rfc/rfc1034.txt, IETF RFC 1034, November 1987.
S. Bradner, Key words for use in RFCs to Indicate Requirement Levels,
http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.
D. Crocker, P. Overell, Augmented BNF for Syntax Specifications:
ABNF, http://www.ietf.org/rfc/rfc2234.txt, IETF RFC 2234, November
1997.
T. Berners-Lee, R. Fielding, L. Masinter, Uniform Resource Identifiers
(URI): Generic Syntax, http://www.ietf.org/rfc/rfc2396.txt, IETF RFC
2396, August 1998.
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 10 of 13
169
Appendix A. Acknowledgments
170
171
The following individuals were members of the committee during the development of this change
request:
172

Andrew Hately
173

Claus von Riegen
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 11 of 13
174
Appendix B. Revision History
175
[This appendix is optional]
Rev
Date
By Whom
What
20030120
January 20,
2003
John Colgrave
Initial version for TC Review
20030211
February
20030304
March 4, 2003
Sam Lee
Refine ABNF syntax to exclude cases such as
“uddi:tempuri.com:keyGenerator:keyGenerator”
176
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 12 of 13
177
Appendix C. Notices
178
179
180
181
182
183
184
185
186
OASIS takes no position regarding the validity or scope of any intellectual property or other rights
that might be claimed to pertain to the implementation or use of the technology described in this
document or the extent to which any license under such rights might or might not be available;
neither does it represent that it has made any effort to identify any such rights. Information on
OASIS's procedures with respect to rights in OASIS specifications can be found at the OASIS
website. Copies of claims of rights made available for publication and any assurances of licenses
to be made available, or the result of an attempt made to obtain a general license or permission
for the use of such proprietary rights by implementors or users of this specification, can be
obtained from the OASIS Executive Director.
187
188
189
OASIS invites any interested party to bring to its attention any copyrights, patents or patent
applications, or other proprietary rights which may cover technology that may be required to
implement this specification. Please address the information to the OASIS Executive Director.
190
Copyright © OASIS Open 2002. All Rights Reserved.
191
192
193
194
195
196
197
198
199
This document and translations of it may be copied and furnished to others, and derivative works
that comment on or otherwise explain it or assist in its implementation may be prepared, copied,
published and distributed, in whole or in part, without restriction of any kind, provided that the
above copyright notice and this paragraph are included on all such copies and derivative works.
However, this document itself does not be modified in any way, such as by removing the
copyright notice or references to OASIS, except as needed for the purpose of developing OASIS
specifications, in which case the procedures for copyrights defined in the OASIS Intellectual
Property Rights document must be followed, or as required to translate it into languages other
than English.
200
201
The limited permissions granted above are perpetual and will not be revoked by OASIS or its
successors or assigns.
202
203
204
205
206
This document and the information contained herein is provided on an “AS IS” basis and OASIS
DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE
ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
PARTICULAR PURPOSE.
106747461
Copyright © OASIS Open 2002. All Rights Reserved.
6 March 2016
Page 13 of 13