1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
|
<pre>Internet Engineering Task Force (IETF) B. Campbell
Request for Comments: 6755 Ping Identity Corp.
Category: Informational H. Tschofenig
ISSN: 2070-1721 Nokia Siemens Networks
October 2012
<span class="h1">An IETF URN Sub-Namespace for OAuth</span>
Abstract
This document establishes an IETF URN Sub-namespace for use with
OAuth-related specifications.
Status of This Memo
This document is not an Internet Standards Track specification; it is
published for informational purposes.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Not all documents
approved by the IESG are a candidate for any level of Internet
Standard; see <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc6755">http://www.rfc-editor.org/info/rfc6755</a>.
Copyright Notice
Copyright (c) 2012 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) 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 Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
<span class="grey">Campbell & Tschofenig Informational [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc6755">RFC 6755</a> An IETF URN Sub-Namespace for OAuth October 2012</span>
Table of Contents
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-2">2</a>
<a href="#section-2">2</a>. Registration Template ...........................................<a href="#page-2">2</a>
<a href="#section-2.1">2.1</a>. Example Registration Request ...............................<a href="#page-3">3</a>
<a href="#section-3">3</a>. Security Considerations .........................................<a href="#page-3">3</a>
<a href="#section-4">4</a>. IANA Considerations .............................................<a href="#page-3">3</a>
<a href="#section-4.1">4.1</a>. IETF URN Sub-Namespace Registration urn:ietf:params:oauth ..4
<a href="#section-5">5</a>. References ......................................................<a href="#page-4">4</a>
<a href="#section-5.1">5.1</a>. Normative References .......................................<a href="#page-4">4</a>
<a href="#section-5.2">5.2</a>. Informative Reference ......................................<a href="#page-4">4</a>
<a href="#appendix-A">Appendix A</a>. Acknowledgements ......................................<a href="#page-5">5</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
Various extensions and companion specifications to the OAuth 2.0
Authorization Framework [<a href="#ref-OAUTH-V2" title=""The OAuth 2.0 Authorization Framework"">OAUTH-V2</a>] utilize URIs to identify the
extension in use or other relevant context. This document creates
and registers an IETF URN Sub-namespace, as documented in <a href="./rfc3553">RFC 3553</a>
[<a href="./rfc3553" title=""An IETF URN Sub-namespace for Registered Protocol Parameters"">RFC3553</a>], for use with such specifications. The new 'oauth' Sub-
namespace is urn:ietf:params:oauth, and OAuth relevant parameters
will be established underneath it.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Registration Template</span>
If a registrant wishes to have an OAuth URI registered, then a URN of
the form urn:ietf:params:oauth:<value> will be requested where
<value> is a suitable representation of the functionality or concept
being registered.
The registration procedure for new entries requires a request in the
form of the following template and is "Specification Required" per
<a href="./rfc5226">RFC 5226</a> [<a href="./rfc5226" title="">RFC5226</a>].
URN:
The URI that identifies the registered functionality.
Common Name:
The name by which the functionality being registered is generally
known.
Change Controller: For Standards Track RFCs, state "IETF". For
others, give the name of the responsible party. Other details
(e.g., postal address, email address, and home page URI) may also
be included.
<span class="grey">Campbell & Tschofenig Informational [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc6755">RFC 6755</a> An IETF URN Sub-Namespace for OAuth October 2012</span>
Specification Document(s): Reference to the document that specifies
the URI, preferably including a URI that can be used to retrieve a
copy of the document. An indication of the relevant sections may
also be included but is not required.
The registration request for the urn:ietf:params:oauth URN Sub-
namespace is found in the IANA Considerations section of this
document (<a href="#section-4">Section 4</a>).
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Example Registration Request</span>
The following is an example registration request for a URI underneath
the urn:ietf:params:oauth Sub-namespace. The requested URI
represents a new OAuth 2.0 grant type.
This is a request to IANA to please register the value
"grant-type:example" in the registry urn:ietf:params:oauth
established in an IETF URN Sub-namespace for OAuth.
o URN: urn:ietf:params:oauth:grant-type:example
o Common Name: An Example Grant Type for OAuth 2.0
o Change controller: IETF
o Specification Document: [the document URI]
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Security Considerations</span>
There are no additional security considerations beyond those already
inherent to using URNs. Security considerations for URNs in general
can be found in <a href="./rfc2141">RFC 2141</a> [<a href="./rfc2141" title=""URN Syntax"">RFC2141</a>].
Any work that is related to OAuth would benefit from familiarity with
the security considerations of the OAuth 2.0 Authorization Framework
[<a href="#ref-OAUTH-V2" title=""The OAuth 2.0 Authorization Framework"">OAUTH-V2</a>].
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. IANA Considerations</span>
IANA has created the following:
o The registration of a new IANA URN Sub-namespace,
urn:ietf:params:oauth:, per <a href="./rfc3553">RFC 3553</a> [<a href="./rfc3553" title=""An IETF URN Sub-namespace for Registered Protocol Parameters"">RFC3553</a>]. The registration
request can be found in <a href="#section-4.1">Section 4.1</a> below.
o A new registry called the "OAuth URI" registry for URNs
subordinate to urn:ietf:params:oauth. The registry "OAuth URI"
has been added to a new top-level registry called "OAuth
<span class="grey">Campbell & Tschofenig Informational [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc6755">RFC 6755</a> An IETF URN Sub-Namespace for OAuth October 2012</span>
Parameters" as defined by [<a href="#ref-OAUTH-V2" title=""The OAuth 2.0 Authorization Framework"">OAUTH-V2</a>]. Instructions for a
registrant to request the registration of such a URN are in
<a href="#section-2">Section 2</a>.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. IETF URN Sub-Namespace Registration urn:ietf:params:oauth</span>
Per <a href="./rfc3553">RFC 3553</a> [<a href="./rfc3553" title=""An IETF URN Sub-namespace for Registered Protocol Parameters"">RFC3553</a>], IANA has registered a new URN Sub-namespace,
urn:ietf:params:oauth.
o Registry name: oauth
o Specification: [this document]
o Repository: [The registry created in <a href="#section-2">Section 2</a>.]
o Index value: values subordinate to urn:ietf:params:oauth are of
the form urn:ietf:params:oauth:<value> with <value> as the index
value. It is suggested that <value> include both a "class" and an
"identifier-within-class" component, with the two components being
separated by a colon (":"); other compositions of the <value> may
also be used.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. References</span>
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. Normative References</span>
[<a id="ref-RFC2141">RFC2141</a>] Moats, R., "URN Syntax", <a href="./rfc2141">RFC 2141</a>, May 1997.
[<a id="ref-RFC3553">RFC3553</a>] Mealling, M., Masinter, L., Hardie, T., and G. Klyne, "An
IETF URN Sub-namespace for Registered Protocol
Parameters", <a href="https://www.rfc-editor.org/bcp/bcp73">BCP 73</a>, <a href="./rfc3553">RFC 3553</a>, June 2003.
[<a id="ref-RFC5226">RFC5226</a>] Narten, T. and H. Alvestrand, "Guidelines for Writing an
IANA Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>, <a href="./rfc5226">RFC 5226</a>,
May 2008.
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. Informative Reference</span>
[<a id="ref-OAUTH-V2">OAUTH-V2</a>] Hardt, D., <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&q=inurl:draft-+%22The+OAuth+2.0+Authorization+Framework%22'>"The OAuth 2.0 Authorization Framework"</a>, Work
in Progress, July 2012.
<span class="grey">Campbell & Tschofenig Informational [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc6755">RFC 6755</a> An IETF URN Sub-Namespace for OAuth October 2012</span>
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. Acknowledgements</span>
The authors thank the following for their helpful contributions:
Stephen Farrell, Barry Leiba, Peter Saint-Andre, Eran Hammer, John
Bradley, Ben Campbell, and Michael B. Jones.
Authors' Addresses
Brian Campbell
Ping Identity Corp.
EMail: brian.d.campbell@gmail.com
Hannes Tschofenig
Nokia Siemens Networks
EMail: hannes.tschofenig@gmx.net
Campbell & Tschofenig Informational [Page 5]
</pre>
|