1 | <?xml version="1.0" encoding="utf-8"?> |
---|
2 | <?xml-stylesheet type='text/xsl' href='../myxml2rfc.xslt'?> |
---|
3 | <!DOCTYPE rfc [ |
---|
4 | <!ENTITY MAY "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>MAY</bcp14>"> |
---|
5 | <!ENTITY MUST "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>MUST</bcp14>"> |
---|
6 | <!ENTITY MUST-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>MUST NOT</bcp14>"> |
---|
7 | <!ENTITY OPTIONAL "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>OPTIONAL</bcp14>"> |
---|
8 | <!ENTITY RECOMMENDED "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>RECOMMENDED</bcp14>"> |
---|
9 | <!ENTITY REQUIRED "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>REQUIRED</bcp14>"> |
---|
10 | <!ENTITY SHALL "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHALL</bcp14>"> |
---|
11 | <!ENTITY SHALL-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHALL NOT</bcp14>"> |
---|
12 | <!ENTITY SHOULD "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHOULD</bcp14>"> |
---|
13 | <!ENTITY SHOULD-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHOULD NOT</bcp14>"> |
---|
14 | <!ENTITY ID-VERSION "latest"> |
---|
15 | <!ENTITY ID-MONTH "June"> |
---|
16 | <!ENTITY ID-YEAR "2013"> |
---|
17 | <!ENTITY mdash "—"> |
---|
18 | <!ENTITY Note "<x:h xmlns:x='http://purl.org/net/xml2rfc/ext'>Note:</x:h>"> |
---|
19 | <!ENTITY messaging "<xref target='Part1' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
20 | <!ENTITY semantics "<xref target='Part2' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
21 | <!ENTITY architecture "<xref target='Part1' x:rel='#architecture' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
22 | <!ENTITY conformance "<xref target='Part1' x:rel='#conformance' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
23 | <!ENTITY notation "<xref target='Part1' x:rel='#notation' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
24 | <!ENTITY abnf-extension "<xref target='Part1' x:rel='#abnf.extension' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
25 | <!ENTITY acks "<xref target='Part1' x:rel='#acks' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
26 | <!ENTITY whitespace "<xref target='Part1' x:rel='#whitespace' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
27 | <!ENTITY field-components "<xref target='Part1' x:rel='#field.components' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
28 | <!ENTITY effective-request-uri "<xref target='Part1' x:rel='#effective.request.uri' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
29 | <!ENTITY msg-orient-and-buffering "<xref target='Part1' x:rel='#intermediaries' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
30 | <!ENTITY end-to-end.and-hop-by-hop "<xref target='Part1' x:rel='#end-to-end.and.hop-by-hop.header-fields' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
31 | <!ENTITY status.403 "<xref target='Part2' x:rel='#status.403' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
32 | <!ENTITY caching-authenticated-responses "<xref target='Part6' x:rel='#caching.authenticated.responses' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
33 | <!ENTITY caching-rqd-no-store "<xref target='Part6' x:rel='#cache-request-directive.no-store' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
34 | <!ENTITY caching-rsd-private "<xref target='Part6' x:rel='#cache-response-directive.private' xmlns:x='http://purl.org/net/xml2rfc/ext'/>"> |
---|
35 | ]> |
---|
36 | <?rfc toc="yes" ?> |
---|
37 | <?rfc symrefs="yes" ?> |
---|
38 | <?rfc sortrefs="yes" ?> |
---|
39 | <?rfc compact="yes"?> |
---|
40 | <?rfc subcompact="no" ?> |
---|
41 | <?rfc linkmailto="no" ?> |
---|
42 | <?rfc editing="no" ?> |
---|
43 | <?rfc comments="yes"?> |
---|
44 | <?rfc inline="yes"?> |
---|
45 | <?rfc rfcedstyle="yes"?> |
---|
46 | <?rfc-ext allow-markup-in-artwork="yes" ?> |
---|
47 | <?rfc-ext include-references-in-index="yes" ?> |
---|
48 | <rfc obsoletes="2616" updates="2617" category="std" x:maturity-level="proposed" |
---|
49 | ipr="pre5378Trust200902" docName="draft-ietf-httpbis-p7-auth-&ID-VERSION;" |
---|
50 | xmlns:x='http://purl.org/net/xml2rfc/ext'> |
---|
51 | <x:link rel="prev" basename="p6-cache"/> |
---|
52 | <x:feedback template="mailto:ietf-http-wg@w3.org?subject={docname},%20%22{section}%22&body=<{ref}>:"/> |
---|
53 | <front> |
---|
54 | |
---|
55 | <title abbrev="HTTP/1.1 Authentication">Hypertext Transfer Protocol (HTTP/1.1): Authentication</title> |
---|
56 | |
---|
57 | <author initials="R." surname="Fielding" fullname="Roy T. Fielding" role="editor"> |
---|
58 | <organization abbrev="Adobe">Adobe Systems Incorporated</organization> |
---|
59 | <address> |
---|
60 | <postal> |
---|
61 | <street>345 Park Ave</street> |
---|
62 | <city>San Jose</city> |
---|
63 | <region>CA</region> |
---|
64 | <code>95110</code> |
---|
65 | <country>USA</country> |
---|
66 | </postal> |
---|
67 | <email>fielding@gbiv.com</email> |
---|
68 | <uri>http://roy.gbiv.com/</uri> |
---|
69 | </address> |
---|
70 | </author> |
---|
71 | |
---|
72 | <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke" role="editor"> |
---|
73 | <organization abbrev="greenbytes">greenbytes GmbH</organization> |
---|
74 | <address> |
---|
75 | <postal> |
---|
76 | <street>Hafenweg 16</street> |
---|
77 | <city>Muenster</city><region>NW</region><code>48155</code> |
---|
78 | <country>Germany</country> |
---|
79 | </postal> |
---|
80 | <email>julian.reschke@greenbytes.de</email> |
---|
81 | <uri>http://greenbytes.de/tech/webdav/</uri> |
---|
82 | </address> |
---|
83 | </author> |
---|
84 | |
---|
85 | <date month="&ID-MONTH;" year="&ID-YEAR;"/> |
---|
86 | <workgroup>HTTPbis Working Group</workgroup> |
---|
87 | |
---|
88 | <abstract> |
---|
89 | <t> |
---|
90 | The Hypertext Transfer Protocol (HTTP) is an application-level protocol for |
---|
91 | distributed, collaborative, hypermedia information systems. This document |
---|
92 | defines the HTTP Authentication framework. |
---|
93 | </t> |
---|
94 | </abstract> |
---|
95 | |
---|
96 | <note title="Editorial Note (To be removed by RFC Editor)"> |
---|
97 | <t> |
---|
98 | Discussion of this draft takes place on the HTTPBIS working group |
---|
99 | mailing list (ietf-http-wg@w3.org), which is archived at |
---|
100 | <eref target="http://lists.w3.org/Archives/Public/ietf-http-wg/"/>. |
---|
101 | </t> |
---|
102 | <t> |
---|
103 | The current issues list is at |
---|
104 | <eref target="http://tools.ietf.org/wg/httpbis/trac/report/3"/> and related |
---|
105 | documents (including fancy diffs) can be found at |
---|
106 | <eref target="http://tools.ietf.org/wg/httpbis/"/>. |
---|
107 | </t> |
---|
108 | <t> |
---|
109 | The changes in this draft are summarized in <xref target="changes.since.22"/>. |
---|
110 | </t> |
---|
111 | </note> |
---|
112 | </front> |
---|
113 | <middle> |
---|
114 | <section title="Introduction" anchor="introduction"> |
---|
115 | <t> |
---|
116 | This document defines HTTP/1.1 access control and authentication. It |
---|
117 | includes the relevant parts of <xref target="RFC2616" x:fmt="none">RFC 2616</xref> |
---|
118 | with only minor changes (<xref target="RFC2616"/>), plus the general framework for HTTP authentication, |
---|
119 | as previously defined in "HTTP Authentication: Basic and Digest Access |
---|
120 | Authentication" (<xref target="RFC2617"/>). |
---|
121 | </t> |
---|
122 | <t> |
---|
123 | HTTP provides several &OPTIONAL; challenge-response authentication |
---|
124 | schemes that can be used by a server to challenge a client request and |
---|
125 | by a client to provide authentication information. The "basic" and "digest" |
---|
126 | authentication schemes continue to be specified in |
---|
127 | <xref target="RFC2617" x:fmt="none">RFC 2617</xref>. |
---|
128 | </t> |
---|
129 | |
---|
130 | <section title="Conformance and Error Handling" anchor="conformance"> |
---|
131 | <t> |
---|
132 | The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", |
---|
133 | "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this |
---|
134 | document are to be interpreted as described in <xref target="RFC2119"/>. |
---|
135 | </t> |
---|
136 | <t> |
---|
137 | Conformance criteria and considerations regarding error handling |
---|
138 | are defined in &conformance;. |
---|
139 | </t> |
---|
140 | </section> |
---|
141 | |
---|
142 | <section title="Syntax Notation" anchor="notation"> |
---|
143 | <t> |
---|
144 | This specification uses the Augmented Backus-Naur Form (ABNF) notation |
---|
145 | of <xref target="RFC5234"/> with the list rule extension defined in |
---|
146 | ¬ation;. <xref target="imported.abnf"/> describes rules imported from |
---|
147 | other documents. <xref target="collected.abnf"/> shows the collected ABNF |
---|
148 | with the list rule expanded. |
---|
149 | </t> |
---|
150 | </section> |
---|
151 | </section> |
---|
152 | |
---|
153 | <section title="Access Authentication Framework" anchor="access.authentication.framework"> |
---|
154 | |
---|
155 | <section title="Challenge and Response" anchor="challenge.and.response"> |
---|
156 | <x:anchor-alias value="auth-scheme"/> |
---|
157 | <x:anchor-alias value="auth-param"/> |
---|
158 | <x:anchor-alias value="token68"/> |
---|
159 | <x:anchor-alias value="challenge"/> |
---|
160 | <x:anchor-alias value="credentials"/> |
---|
161 | <t> |
---|
162 | HTTP provides a simple challenge-response authentication framework |
---|
163 | that can be used by a server to challenge a client request and by a |
---|
164 | client to provide authentication information. It uses a case-insensitive |
---|
165 | token as a means to identify the authentication scheme, followed |
---|
166 | by additional information necessary for achieving authentication via that |
---|
167 | scheme. The latter can either be a comma-separated list of parameters or a |
---|
168 | single sequence of characters capable of holding base64-encoded |
---|
169 | information. |
---|
170 | </t> |
---|
171 | <t> |
---|
172 | Parameters are name-value pairs where the name is matched case-insensitively, |
---|
173 | and each parameter name &MUST; only occur once per challenge. |
---|
174 | </t> |
---|
175 | <figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="auth-scheme"/><iref primary="true" item="Grammar" subitem="auth-param"/><iref primary="true" item="Grammar" subitem="token68"/> |
---|
176 | auth-scheme = <x:ref>token</x:ref> |
---|
177 | |
---|
178 | auth-param = <x:ref>token</x:ref> <x:ref>BWS</x:ref> "=" <x:ref>BWS</x:ref> ( <x:ref>token</x:ref> / <x:ref>quoted-string</x:ref> ) |
---|
179 | |
---|
180 | token68 = 1*( <x:ref>ALPHA</x:ref> / <x:ref>DIGIT</x:ref> / |
---|
181 | "-" / "." / "_" / "~" / "+" / "/" ) *"=" |
---|
182 | </artwork></figure> |
---|
183 | <t> |
---|
184 | The "token68" syntax allows the 66 unreserved URI characters (<xref target="RFC3986"/>), |
---|
185 | plus a few others, so that it can hold a base64, base64url (URL and filename |
---|
186 | safe alphabet), base32, or base16 (hex) encoding, with or without padding, but |
---|
187 | excluding whitespace (<xref target="RFC4648"/>). |
---|
188 | </t> |
---|
189 | <t> |
---|
190 | The <x:ref>401 (Unauthorized)</x:ref> response message is used by an origin server |
---|
191 | to challenge the authorization of a user agent. This response &MUST; |
---|
192 | include a <x:ref>WWW-Authenticate</x:ref> header field containing at least one |
---|
193 | challenge applicable to the requested resource. |
---|
194 | </t> |
---|
195 | <t> |
---|
196 | The <x:ref>407 (Proxy Authentication Required)</x:ref> response message is |
---|
197 | used by a proxy to challenge the authorization of a client and &MUST; |
---|
198 | include a <x:ref>Proxy-Authenticate</x:ref> header field containing at least |
---|
199 | one challenge applicable to the proxy for the requested resource. |
---|
200 | </t> |
---|
201 | <figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="challenge"/> |
---|
202 | <x:ref>challenge</x:ref> = <x:ref>auth-scheme</x:ref> [ 1*<x:ref>SP</x:ref> ( <x:ref>token68</x:ref> / #<x:ref>auth-param</x:ref> ) ] |
---|
203 | </artwork></figure> |
---|
204 | <x:note> |
---|
205 | <t> |
---|
206 | &Note; User agents will need to take special care in parsing the |
---|
207 | <x:ref>WWW-Authenticate</x:ref> and <x:ref>Proxy-Authenticate</x:ref> |
---|
208 | header field values because they can contain more than one challenge, or |
---|
209 | if more than one of each is provided, since the contents of a challenge |
---|
210 | can itself contain a comma-separated list of authentication parameters. |
---|
211 | </t> |
---|
212 | </x:note> |
---|
213 | <x:note> |
---|
214 | <t> |
---|
215 | &Note; Many clients fail to parse challenges containing unknown |
---|
216 | schemes. A workaround for this problem is to list well-supported schemes |
---|
217 | (such as "basic") first.<!-- see http://greenbytes.de/tech/tc/httpauth/#multibasicunknown2 --> |
---|
218 | </t> |
---|
219 | </x:note> |
---|
220 | <t> |
---|
221 | A user agent that wishes to authenticate itself with an origin server |
---|
222 | — usually, but not necessarily, after receiving a <x:ref>401 (Unauthorized)</x:ref> |
---|
223 | — can do so by including an <x:ref>Authorization</x:ref> header field with the |
---|
224 | request. |
---|
225 | </t> |
---|
226 | <t> |
---|
227 | A client that wishes to authenticate itself with a proxy — usually, |
---|
228 | but not necessarily, after receiving a <x:ref>407 (Proxy Authentication Required)</x:ref> |
---|
229 | — can do so by including a <x:ref>Proxy-Authorization</x:ref> header field with the |
---|
230 | request. |
---|
231 | </t> |
---|
232 | <t> |
---|
233 | Both the <x:ref>Authorization</x:ref> field value and the <x:ref>Proxy-Authorization</x:ref> field value |
---|
234 | contain the client's credentials for the realm of the resource being |
---|
235 | requested, based upon a challenge received in a response (possibly at |
---|
236 | some point in the past). When creating their values, the user agent ought to |
---|
237 | do so by selecting the challenge with what it considers to be the most |
---|
238 | secure auth-scheme that it understands, obtaining credentials from the user |
---|
239 | as appropriate. |
---|
240 | </t> |
---|
241 | <figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="credentials"/> |
---|
242 | <x:ref>credentials</x:ref> = <x:ref>auth-scheme</x:ref> [ 1*<x:ref>SP</x:ref> ( <x:ref>token68</x:ref> / #<x:ref>auth-param</x:ref> ) ] |
---|
243 | </artwork></figure> |
---|
244 | <t> |
---|
245 | Upon a request for a protected resource that omits credentials, contains |
---|
246 | invalid credentials (e.g., a bad password) or partial credentials (e.g., |
---|
247 | when the authentication scheme requires more than one round trip), an origin |
---|
248 | server &SHOULD; send a <x:ref>401 (Unauthorized)</x:ref> response that |
---|
249 | contains a <x:ref>WWW-Authenticate</x:ref> header field with at least one |
---|
250 | (possibly new) challenge applicable to the requested resource. |
---|
251 | </t> |
---|
252 | <t> |
---|
253 | Likewise, upon a request that requires authentication by proxies that omit |
---|
254 | credentials or contain invalid or partial credentials, a proxy &SHOULD; |
---|
255 | send a <x:ref>407 (Proxy Authentication Required)</x:ref> response that |
---|
256 | contains a <x:ref>Proxy-Authenticate</x:ref> header field with a (possibly |
---|
257 | new) challenge applicable to the proxy. |
---|
258 | </t> |
---|
259 | <t> |
---|
260 | A server receiving credentials that are valid, but not adequate to gain |
---|
261 | access, ought to respond with the <x:ref>403 (Forbidden)</x:ref> status code (&status.403;). |
---|
262 | </t> |
---|
263 | <t> |
---|
264 | The HTTP protocol does not restrict applications to this simple |
---|
265 | challenge-response framework for access authentication. Additional |
---|
266 | mechanisms &MAY; be used, such as encryption at the transport level or |
---|
267 | via message encapsulation, and with additional header fields |
---|
268 | specifying authentication information. However, such additional |
---|
269 | mechanisms are not defined by this specification. |
---|
270 | </t> |
---|
271 | <t> |
---|
272 | Proxies &MUST; forward the <x:ref>WWW-Authenticate</x:ref> and |
---|
273 | <x:ref>Authorization</x:ref> header fields unmodified and follow the rules |
---|
274 | found in <xref target="header.authorization"/>. |
---|
275 | </t> |
---|
276 | </section> |
---|
277 | |
---|
278 | <section title="Protection Space (Realm)" anchor="protection.space"> |
---|
279 | <iref item="Protection Space"/> |
---|
280 | <iref item="Realm"/> |
---|
281 | <iref item="Canonical Root URI"/> |
---|
282 | <t> |
---|
283 | The authentication parameter realm is reserved for use by authentication |
---|
284 | schemes that wish to indicate the scope of protection. |
---|
285 | </t> |
---|
286 | <t> |
---|
287 | A <x:dfn>protection space</x:dfn> is defined by the canonical root URI (the |
---|
288 | scheme and authority components of the effective request URI; see |
---|
289 | <xref target="Part1" x:fmt="of" x:rel="#effective.request.uri"/>) of the |
---|
290 | server being accessed, in combination with the realm value if present. |
---|
291 | These realms allow the protected resources on a server to be |
---|
292 | partitioned into a set of protection spaces, each with its own |
---|
293 | authentication scheme and/or authorization database. The realm value |
---|
294 | is a string, generally assigned by the origin server, that can have |
---|
295 | additional semantics specific to the authentication scheme. Note that a |
---|
296 | response can have multiple challenges with the same auth-scheme but |
---|
297 | different realms. |
---|
298 | </t> |
---|
299 | <t> |
---|
300 | The protection space determines the domain over which credentials can |
---|
301 | be automatically applied. If a prior request has been authorized, the |
---|
302 | same credentials &MAY; be reused for all other requests within that |
---|
303 | protection space for a period of time determined by the |
---|
304 | authentication scheme, parameters, and/or user preference. Unless |
---|
305 | specifically allowed by the authentication scheme, a single protection |
---|
306 | space cannot extend outside the scope of its server. |
---|
307 | </t> |
---|
308 | <t> |
---|
309 | For historical reasons, senders &MUST; only generate the quoted-string syntax. |
---|
310 | Recipients might have to support both token and quoted-string syntax for |
---|
311 | maximum interoperability with existing clients that have been accepting both |
---|
312 | notations for a long time. |
---|
313 | </t> |
---|
314 | </section> |
---|
315 | |
---|
316 | </section> |
---|
317 | |
---|
318 | <section title="Status Code Definitions" anchor="status.code.definitions"> |
---|
319 | <section title="401 Unauthorized" anchor="status.401"> |
---|
320 | <iref primary="true" item="401 Unauthorized (status code)" x:for-anchor=""/> |
---|
321 | <x:anchor-alias value="401 (Unauthorized)"/> |
---|
322 | <t> |
---|
323 | The <x:dfn>401 (Unauthorized)</x:dfn> status code indicates that the |
---|
324 | request has not been applied because it lacks valid authentication |
---|
325 | credentials for the target resource. The origin server &MUST; send a |
---|
326 | <x:ref>WWW-Authenticate</x:ref> header field (<xref target="header.www-authenticate"/>) |
---|
327 | containing at least one challenge applicable to the target resource. |
---|
328 | If the request included authentication credentials, then the 401 response |
---|
329 | indicates that authorization has been refused for those credentials. |
---|
330 | The user agent &MAY; repeat the request with a new or replaced |
---|
331 | <x:ref>Authorization</x:ref> header field (<xref target="header.authorization"/>). |
---|
332 | If the 401 response contains the same challenge as the prior response, and |
---|
333 | the user agent has already attempted authentication at least once, then the |
---|
334 | user agent &SHOULD; present the enclosed representation to the user, since |
---|
335 | it usually contains relevant diagnostic information. |
---|
336 | </t> |
---|
337 | </section> |
---|
338 | <section title="407 Proxy Authentication Required" anchor="status.407"> |
---|
339 | <iref primary="true" item="407 Proxy Authentication Required (status code)" x:for-anchor=""/> |
---|
340 | <x:anchor-alias value="407 (Proxy Authentication Required)"/> |
---|
341 | <t> |
---|
342 | The <x:dfn>407 (Proxy Authentication Required)</x:dfn> status code is |
---|
343 | similar to <x:ref>401 (Unauthorized)</x:ref>, but indicates that the client |
---|
344 | needs to authenticate itself in order to use a proxy. |
---|
345 | The proxy &MUST; send a <x:ref>Proxy-Authenticate</x:ref> header field |
---|
346 | (<xref target="header.proxy-authenticate"/>) containing a challenge |
---|
347 | applicable to that proxy for the target resource. The client &MAY; repeat |
---|
348 | the request with a new or replaced <x:ref>Proxy-Authorization</x:ref> |
---|
349 | header field (<xref target="header.proxy-authorization"/>). |
---|
350 | </t> |
---|
351 | </section> |
---|
352 | </section> |
---|
353 | |
---|
354 | <section title="Header Field Definitions" anchor="header.field.definitions"> |
---|
355 | <t> |
---|
356 | This section defines the syntax and semantics of HTTP/1.1 header fields |
---|
357 | related to authentication. |
---|
358 | </t> |
---|
359 | |
---|
360 | <section title="Authorization" anchor="header.authorization"> |
---|
361 | <iref primary="true" item="Authorization header field" x:for-anchor=""/> |
---|
362 | <x:anchor-alias value="Authorization"/> |
---|
363 | <t> |
---|
364 | The "Authorization" header field allows a user agent to authenticate |
---|
365 | itself with an origin server — usually, but not necessarily, after receiving a <x:ref>401 |
---|
366 | (Unauthorized)</x:ref> response. Its value consists of credentials containing |
---|
367 | information of the user agent for the realm of the resource being |
---|
368 | requested. |
---|
369 | </t> |
---|
370 | <figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="Authorization"/> |
---|
371 | <x:ref>Authorization</x:ref> = <x:ref>credentials</x:ref> |
---|
372 | </artwork></figure> |
---|
373 | <t> |
---|
374 | If a request is |
---|
375 | authenticated and a realm specified, the same credentials &SHOULD; |
---|
376 | be valid for all other requests within this realm (assuming that |
---|
377 | the authentication scheme itself does not require otherwise, such |
---|
378 | as credentials that vary according to a challenge value or using |
---|
379 | synchronized clocks). |
---|
380 | </t> |
---|
381 | <t> |
---|
382 | See &caching-authenticated-responses; for details of and requirements |
---|
383 | pertaining to handling of the Authorization field by HTTP caches. |
---|
384 | </t> |
---|
385 | </section> |
---|
386 | |
---|
387 | <section title="Proxy-Authenticate" anchor="header.proxy-authenticate"> |
---|
388 | <iref primary="true" item="Proxy-Authenticate header field" x:for-anchor=""/> |
---|
389 | <x:anchor-alias value="Proxy-Authenticate"/> |
---|
390 | <t> |
---|
391 | The "Proxy-Authenticate" header field consists of at least one |
---|
392 | challenge that indicates the authentication scheme(s) and parameters |
---|
393 | applicable to the proxy for this effective request URI (&effective-request-uri;). |
---|
394 | It &MUST; be included as part of a <x:ref>407 (Proxy Authentication Required)</x:ref> response. |
---|
395 | </t> |
---|
396 | <figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="Proxy-Authenticate"/> |
---|
397 | <x:ref>Proxy-Authenticate</x:ref> = 1#<x:ref>challenge</x:ref> |
---|
398 | </artwork></figure> |
---|
399 | <t> |
---|
400 | Unlike <x:ref>WWW-Authenticate</x:ref>, the Proxy-Authenticate header field |
---|
401 | applies only to the current connection, and intermediaries &SHOULD-NOT; |
---|
402 | forward it to downstream clients. However, an intermediate proxy might need |
---|
403 | to obtain its own credentials by requesting them from the downstream client, |
---|
404 | which in some circumstances will appear as if the proxy is forwarding the |
---|
405 | Proxy-Authenticate header field. |
---|
406 | </t> |
---|
407 | <t> |
---|
408 | Note that the parsing considerations for <x:ref>WWW-Authenticate</x:ref> |
---|
409 | apply to this header field as well; see <xref target="header.www-authenticate"/> |
---|
410 | for details. |
---|
411 | </t> |
---|
412 | </section> |
---|
413 | |
---|
414 | <section title="Proxy-Authorization" anchor="header.proxy-authorization"> |
---|
415 | <iref primary="true" item="Proxy-Authorization header field" x:for-anchor=""/> |
---|
416 | <x:anchor-alias value="Proxy-Authorization"/> |
---|
417 | <t> |
---|
418 | The "Proxy-Authorization" header field allows the client to |
---|
419 | identify itself (or its user) to a proxy that requires |
---|
420 | authentication. Its value consists of credentials containing the |
---|
421 | authentication information of the client for the proxy and/or realm of the |
---|
422 | resource being requested. |
---|
423 | </t> |
---|
424 | <figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="Proxy-Authorization"/> |
---|
425 | <x:ref>Proxy-Authorization</x:ref> = <x:ref>credentials</x:ref> |
---|
426 | </artwork></figure> |
---|
427 | <t> |
---|
428 | Unlike <x:ref>Authorization</x:ref>, the Proxy-Authorization header field applies only to |
---|
429 | the next outbound proxy that demanded authentication using the <x:ref>Proxy-Authenticate</x:ref> |
---|
430 | field. When multiple proxies are used in a chain, the |
---|
431 | Proxy-Authorization header field is consumed by the first outbound |
---|
432 | proxy that was expecting to receive credentials. A proxy &MAY; relay |
---|
433 | the credentials from the client request to the next proxy if that is |
---|
434 | the mechanism by which the proxies cooperatively authenticate a given |
---|
435 | request. |
---|
436 | </t> |
---|
437 | </section> |
---|
438 | |
---|
439 | <section title="WWW-Authenticate" anchor="header.www-authenticate"> |
---|
440 | <iref primary="true" item="WWW-Authenticate header field" x:for-anchor=""/> |
---|
441 | <x:anchor-alias value="WWW-Authenticate"/> |
---|
442 | <t> |
---|
443 | The "WWW-Authenticate" header field consists of at least one |
---|
444 | challenge that indicates the authentication scheme(s) and parameters |
---|
445 | applicable to the effective request URI (&effective-request-uri;). |
---|
446 | </t> |
---|
447 | <t> |
---|
448 | It &MUST; be included in <x:ref>401 (Unauthorized)</x:ref> response messages and &MAY; be |
---|
449 | included in other response messages to indicate that supplying credentials |
---|
450 | (or different credentials) might affect the response. |
---|
451 | </t> |
---|
452 | <figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="WWW-Authenticate"/> |
---|
453 | <x:ref>WWW-Authenticate</x:ref> = 1#<x:ref>challenge</x:ref> |
---|
454 | </artwork></figure> |
---|
455 | <t> |
---|
456 | User agents are advised to take special care in parsing the WWW-Authenticate |
---|
457 | field value as it might contain more than one challenge, |
---|
458 | or if more than one WWW-Authenticate header field is provided, the |
---|
459 | contents of a challenge itself can contain a comma-separated list of |
---|
460 | authentication parameters. |
---|
461 | </t> |
---|
462 | <figure> |
---|
463 | <preamble>For instance:</preamble> |
---|
464 | <artwork type="example"> |
---|
465 | WWW-Authenticate: Newauth realm="apps", type=1, |
---|
466 | title="Login to \"apps\"", Basic realm="simple" |
---|
467 | </artwork> |
---|
468 | <postamble> |
---|
469 | This header field contains two challenges; one for the "Newauth" scheme |
---|
470 | with a realm value of "apps", and two additional parameters "type" and |
---|
471 | "title", and another one for the "Basic" scheme with a realm value of |
---|
472 | "simple". |
---|
473 | </postamble></figure> |
---|
474 | <x:note> |
---|
475 | <t> |
---|
476 | &Note; The challenge grammar production uses the list syntax as |
---|
477 | well. Therefore, a sequence of comma, whitespace, and comma can be |
---|
478 | considered both as applying to the preceding challenge, or to be an |
---|
479 | empty entry in the list of challenges. In practice, this ambiguity |
---|
480 | does not affect the semantics of the header field value and thus is |
---|
481 | harmless. |
---|
482 | </t> |
---|
483 | </x:note> |
---|
484 | </section> |
---|
485 | |
---|
486 | </section> |
---|
487 | |
---|
488 | <section title="IANA Considerations" anchor="IANA.considerations"> |
---|
489 | |
---|
490 | <section title="Authentication Scheme Registry" anchor="authentication.scheme.registry"> |
---|
491 | <t> |
---|
492 | The HTTP Authentication Scheme Registry defines the name space for the |
---|
493 | authentication schemes in challenges and credentials. It will be created and |
---|
494 | maintained at <eref target="http://www.iana.org/assignments/http-authschemes"/>. |
---|
495 | </t> |
---|
496 | |
---|
497 | <section title="Procedure" anchor="authentication.scheme.registry.procedure"> |
---|
498 | <t> |
---|
499 | Registrations &MUST; include the following fields: |
---|
500 | <list style="symbols"> |
---|
501 | <t>Authentication Scheme Name</t> |
---|
502 | <t>Pointer to specification text</t> |
---|
503 | <t>Notes (optional)</t> |
---|
504 | </list> |
---|
505 | </t> |
---|
506 | <t> |
---|
507 | Values to be added to this name space require IETF Review |
---|
508 | (see <xref target="RFC5226" x:fmt="," x:sec="4.1"/>). |
---|
509 | </t> |
---|
510 | </section> |
---|
511 | |
---|
512 | <section title="Considerations for New Authentication Schemes" anchor="considerations.for.new.authentication.schemes"> |
---|
513 | <t> |
---|
514 | There are certain aspects of the HTTP Authentication Framework that put |
---|
515 | constraints on how new authentication schemes can work: |
---|
516 | </t> |
---|
517 | <t> |
---|
518 | <list style="symbols"> |
---|
519 | <x:lt> |
---|
520 | <t> |
---|
521 | HTTP authentication is presumed to be stateless: all of the information |
---|
522 | necessary to authenticate a request &MUST; be provided in the request, |
---|
523 | rather than be dependent on the server remembering prior requests. |
---|
524 | Authentication based on, or bound to, the underlying connection is |
---|
525 | outside the scope of this specification and inherently flawed unless |
---|
526 | steps are taken to ensure that the connection cannot be used by any |
---|
527 | party other than the authenticated user |
---|
528 | (see &msg-orient-and-buffering;). |
---|
529 | </t> |
---|
530 | </x:lt> |
---|
531 | <x:lt> |
---|
532 | <t> |
---|
533 | The authentication parameter "realm" is reserved for defining Protection |
---|
534 | Spaces as defined in <xref target="protection.space"/>. New schemes |
---|
535 | &MUST-NOT; use it in a way incompatible with that definition. |
---|
536 | </t> |
---|
537 | </x:lt> |
---|
538 | <x:lt> |
---|
539 | <t> |
---|
540 | The "token68" notation was introduced for compatibility with existing |
---|
541 | authentication schemes and can only be used once per challenge or credential. |
---|
542 | New schemes thus ought to use the "auth-param" syntax instead, because |
---|
543 | otherwise future extensions will be impossible. |
---|
544 | </t> |
---|
545 | </x:lt> |
---|
546 | <x:lt> |
---|
547 | <t> |
---|
548 | The parsing of challenges and credentials is defined by this specification, |
---|
549 | and cannot be modified by new authentication schemes. When the auth-param |
---|
550 | syntax is used, all parameters ought to support both token and |
---|
551 | quoted-string syntax, and syntactical constraints ought to be defined on |
---|
552 | the field value after parsing (i.e., quoted-string processing). This is |
---|
553 | necessary so that recipients can use a generic parser that applies to |
---|
554 | all authentication schemes. |
---|
555 | </t> |
---|
556 | <t> |
---|
557 | &Note; The fact that the value syntax for the "realm" parameter |
---|
558 | is restricted to quoted-string was a bad design choice not to be repeated |
---|
559 | for new parameters. |
---|
560 | </t> |
---|
561 | </x:lt> |
---|
562 | <x:lt> |
---|
563 | <t> |
---|
564 | Definitions of new schemes ought to define the treatment of unknown |
---|
565 | extension parameters. In general, a "must-ignore" rule is preferable |
---|
566 | over "must-understand", because otherwise it will be hard to introduce |
---|
567 | new parameters in the presence of legacy recipients. Furthermore, |
---|
568 | it's good to describe the policy for defining new parameters (such |
---|
569 | as "update the specification", or "use this registry"). |
---|
570 | </t> |
---|
571 | </x:lt> |
---|
572 | <x:lt> |
---|
573 | <t> |
---|
574 | Authentication schemes need to document whether they are usable in |
---|
575 | origin-server authentication (i.e., using <x:ref>WWW-Authenticate</x:ref>), |
---|
576 | and/or proxy authentication (i.e., using <x:ref>Proxy-Authenticate</x:ref>). |
---|
577 | </t> |
---|
578 | </x:lt> |
---|
579 | <x:lt> |
---|
580 | <t> |
---|
581 | The credentials carried in an <x:ref>Authorization</x:ref> header field are specific to |
---|
582 | the User Agent, and therefore have the same effect on HTTP caches as the |
---|
583 | "private" Cache-Control response directive (&caching-rsd-private;), |
---|
584 | within the scope of the request they appear in. |
---|
585 | </t> |
---|
586 | <t> |
---|
587 | Therefore, new authentication schemes that choose not to carry |
---|
588 | credentials in the <x:ref>Authorization</x:ref> header field (e.g., using a newly defined |
---|
589 | header field) will need to explicitly disallow caching, by mandating the use of |
---|
590 | either Cache-Control request directives (e.g., "no-store", |
---|
591 | &caching-rqd-no-store;) or response directives (e.g., "private"). |
---|
592 | </t> |
---|
593 | </x:lt> |
---|
594 | </list> |
---|
595 | </t> |
---|
596 | </section> |
---|
597 | </section> |
---|
598 | |
---|
599 | <section title="Status Code Registration" anchor="status.code.registration"> |
---|
600 | <t> |
---|
601 | The HTTP Status Code Registry located at <eref target="http://www.iana.org/assignments/http-status-codes"/> |
---|
602 | shall be updated with the registrations below: |
---|
603 | </t> |
---|
604 | <?BEGININC p7-auth.iana-status-codes ?> |
---|
605 | <!--AUTOGENERATED FROM extract-status-code-defs.xslt, do not edit manually--> |
---|
606 | <texttable align="left" suppress-title="true" anchor="iana.status.code.registration.table"> |
---|
607 | <ttcol>Value</ttcol> |
---|
608 | <ttcol>Description</ttcol> |
---|
609 | <ttcol>Reference</ttcol> |
---|
610 | <c>401</c> |
---|
611 | <c>Unauthorized</c> |
---|
612 | <c> |
---|
613 | <xref target="status.401"/> |
---|
614 | </c> |
---|
615 | <c>407</c> |
---|
616 | <c>Proxy Authentication Required</c> |
---|
617 | <c> |
---|
618 | <xref target="status.407"/> |
---|
619 | </c> |
---|
620 | </texttable> |
---|
621 | <!--(END)--> |
---|
622 | <?ENDINC p7-auth.iana-status-codes ?> |
---|
623 | </section> |
---|
624 | |
---|
625 | <section title="Header Field Registration" anchor="header.field.registration"> |
---|
626 | <t> |
---|
627 | HTTP header fields are registered within the Message Header Field Registry |
---|
628 | maintained at |
---|
629 | <eref target="http://www.iana.org/assignments/message-headers/message-header-index.html"/>. |
---|
630 | </t> |
---|
631 | <t> |
---|
632 | This document defines the following HTTP header fields, so their |
---|
633 | associated registry entries shall be updated according to the permanent |
---|
634 | registrations below (see <xref target="BCP90"/>): |
---|
635 | </t> |
---|
636 | <?BEGININC p7-auth.iana-headers ?> |
---|
637 | <!--AUTOGENERATED FROM extract-header-defs.xslt, do not edit manually--> |
---|
638 | <texttable align="left" suppress-title="true" anchor="iana.header.registration.table"> |
---|
639 | <ttcol>Header Field Name</ttcol> |
---|
640 | <ttcol>Protocol</ttcol> |
---|
641 | <ttcol>Status</ttcol> |
---|
642 | <ttcol>Reference</ttcol> |
---|
643 | |
---|
644 | <c>Authorization</c> |
---|
645 | <c>http</c> |
---|
646 | <c>standard</c> |
---|
647 | <c> |
---|
648 | <xref target="header.authorization"/> |
---|
649 | </c> |
---|
650 | <c>Proxy-Authenticate</c> |
---|
651 | <c>http</c> |
---|
652 | <c>standard</c> |
---|
653 | <c> |
---|
654 | <xref target="header.proxy-authenticate"/> |
---|
655 | </c> |
---|
656 | <c>Proxy-Authorization</c> |
---|
657 | <c>http</c> |
---|
658 | <c>standard</c> |
---|
659 | <c> |
---|
660 | <xref target="header.proxy-authorization"/> |
---|
661 | </c> |
---|
662 | <c>WWW-Authenticate</c> |
---|
663 | <c>http</c> |
---|
664 | <c>standard</c> |
---|
665 | <c> |
---|
666 | <xref target="header.www-authenticate"/> |
---|
667 | </c> |
---|
668 | </texttable> |
---|
669 | <!--(END)--> |
---|
670 | <?ENDINC p7-auth.iana-headers ?> |
---|
671 | <t> |
---|
672 | The change controller is: "IETF (iesg@ietf.org) - Internet Engineering Task Force". |
---|
673 | </t> |
---|
674 | </section> |
---|
675 | </section> |
---|
676 | |
---|
677 | <section title="Security Considerations" anchor="security.considerations"> |
---|
678 | <t> |
---|
679 | This section is meant to inform developers, information providers, and |
---|
680 | users of known security concerns specific to HTTP/1.1 authentication. |
---|
681 | More general security considerations are addressed in HTTP messaging |
---|
682 | &messaging; and semantics &semantics;. |
---|
683 | </t> |
---|
684 | |
---|
685 | <section title="Authentication Credentials and Idle Clients" anchor="auth.credentials.and.idle.clients"> |
---|
686 | <t> |
---|
687 | Existing HTTP clients and user agents typically retain authentication |
---|
688 | information indefinitely. HTTP/1.1 does not provide a method for a |
---|
689 | server to direct clients to discard these cached credentials. This is |
---|
690 | a significant defect that requires further extensions to HTTP. |
---|
691 | Circumstances under which credential caching can interfere with the |
---|
692 | application's security model include but are not limited to: |
---|
693 | <list style="symbols"> |
---|
694 | <t>Clients that have been idle for an extended period, following |
---|
695 | which the server might wish to cause the client to re-prompt the |
---|
696 | user for credentials.</t> |
---|
697 | |
---|
698 | <t>Applications that include a session termination indication |
---|
699 | (such as a "logout" or "commit" button on a page) after which |
---|
700 | the server side of the application "knows" that there is no |
---|
701 | further reason for the client to retain the credentials.</t> |
---|
702 | </list> |
---|
703 | </t> |
---|
704 | <t> |
---|
705 | This is currently under separate study. There are a number of work-arounds |
---|
706 | to parts of this problem, and we encourage the use of |
---|
707 | password protection in screen savers, idle time-outs, and other |
---|
708 | methods that mitigate the security problems inherent in this |
---|
709 | problem. In particular, user agents that cache credentials are |
---|
710 | encouraged to provide a readily accessible mechanism for discarding |
---|
711 | cached credentials under user control. |
---|
712 | </t> |
---|
713 | </section> |
---|
714 | |
---|
715 | <section title="Protection Spaces" anchor="protection.spaces"> |
---|
716 | <t> |
---|
717 | Authentication schemes that solely rely on the "realm" mechanism for |
---|
718 | establishing a protection space will expose credentials to all resources on |
---|
719 | an origin server. Clients that have successfully made authenticated requests |
---|
720 | with a resource can use the same authentication credentials for other |
---|
721 | resources on the same origin server. This makes it possible for a different |
---|
722 | resource to harvest authentication credentials for other resources. |
---|
723 | </t> |
---|
724 | <t> |
---|
725 | This is of particular concern when an origin server hosts resources for multiple |
---|
726 | parties under the same canonical root URI (<xref target="protection.space"/>). |
---|
727 | Possible mitigation strategies include restricting direct access to |
---|
728 | authentication credentials (i.e., not making the content of the |
---|
729 | <x:ref>Authorization</x:ref> request header field available), and separating protection |
---|
730 | spaces by using a different host name (or port number) for each party. |
---|
731 | </t> |
---|
732 | </section> |
---|
733 | </section> |
---|
734 | |
---|
735 | <section title="Acknowledgments" anchor="acks"> |
---|
736 | <t> |
---|
737 | This specification takes over the definition of the HTTP Authentication |
---|
738 | Framework, previously defined in <xref target="RFC2617" x:fmt="none">RFC 2617</xref>. |
---|
739 | We thank John Franks, Phillip M. Hallam-Baker, Jeffery L. Hostetler, Scott D. Lawrence, |
---|
740 | Paul J. Leach, Ari Luotonen, and Lawrence C. Stewart for their work |
---|
741 | on that specification. See <xref target="RFC2617" x:fmt="of" x:sec="6"/> |
---|
742 | for further acknowledgements. |
---|
743 | </t> |
---|
744 | <t> |
---|
745 | See &acks; for the Acknowledgments related to this document revision. |
---|
746 | </t> |
---|
747 | </section> |
---|
748 | </middle> |
---|
749 | |
---|
750 | <back> |
---|
751 | |
---|
752 | <references title="Normative References"> |
---|
753 | |
---|
754 | <reference anchor="Part1"> |
---|
755 | <front> |
---|
756 | <title>Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing</title> |
---|
757 | <author initials="R." surname="Fielding" fullname="Roy T. Fielding" role="editor"> |
---|
758 | <organization abbrev="Adobe">Adobe Systems Incorporated</organization> |
---|
759 | <address><email>fielding@gbiv.com</email></address> |
---|
760 | </author> |
---|
761 | <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke" role="editor"> |
---|
762 | <organization abbrev="greenbytes">greenbytes GmbH</organization> |
---|
763 | <address><email>julian.reschke@greenbytes.de</email></address> |
---|
764 | </author> |
---|
765 | <date month="&ID-MONTH;" year="&ID-YEAR;"/> |
---|
766 | </front> |
---|
767 | <seriesInfo name="Internet-Draft" value="draft-ietf-httpbis-p1-messaging-&ID-VERSION;"/> |
---|
768 | <x:source href="p1-messaging.xml" basename="p1-messaging"/> |
---|
769 | </reference> |
---|
770 | |
---|
771 | <reference anchor="Part2"> |
---|
772 | <front> |
---|
773 | <title>Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content</title> |
---|
774 | <author fullname="Roy T. Fielding" initials="R." role="editor" surname="Fielding"> |
---|
775 | <organization abbrev="Adobe">Adobe Systems Incorporated</organization> |
---|
776 | <address><email>fielding@gbiv.com</email></address> |
---|
777 | </author> |
---|
778 | <author fullname="Julian F. Reschke" initials="J. F." role="editor" surname="Reschke"> |
---|
779 | <organization abbrev="greenbytes">greenbytes GmbH</organization> |
---|
780 | <address><email>julian.reschke@greenbytes.de</email></address> |
---|
781 | </author> |
---|
782 | <date month="&ID-MONTH;" year="&ID-YEAR;" /> |
---|
783 | </front> |
---|
784 | <seriesInfo name="Internet-Draft" value="draft-ietf-httpbis-p2-semantics-&ID-VERSION;" /> |
---|
785 | <x:source basename="p2-semantics" href="p2-semantics.xml"> |
---|
786 | <x:defines>403 (Forbidden)</x:defines> |
---|
787 | <x:defines>Location</x:defines> |
---|
788 | </x:source> |
---|
789 | </reference> |
---|
790 | |
---|
791 | <reference anchor="Part6"> |
---|
792 | <front> |
---|
793 | <title>Hypertext Transfer Protocol (HTTP/1.1): Caching</title> |
---|
794 | <author initials="R." surname="Fielding" fullname="Roy T. Fielding" role="editor"> |
---|
795 | <organization abbrev="Adobe">Adobe Systems Incorporated</organization> |
---|
796 | <address><email>fielding@gbiv.com</email></address> |
---|
797 | </author> |
---|
798 | <author initials="M." surname="Nottingham" fullname="Mark Nottingham" role="editor"> |
---|
799 | <organization>Akamai</organization> |
---|
800 | <address><email>mnot@mnot.net</email></address> |
---|
801 | </author> |
---|
802 | <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke" role="editor"> |
---|
803 | <organization abbrev="greenbytes">greenbytes GmbH</organization> |
---|
804 | <address><email>julian.reschke@greenbytes.de</email></address> |
---|
805 | </author> |
---|
806 | <date month="&ID-MONTH;" year="&ID-YEAR;"/> |
---|
807 | </front> |
---|
808 | <seriesInfo name="Internet-Draft" value="draft-ietf-httpbis-p6-cache-&ID-VERSION;"/> |
---|
809 | <x:source href="p6-cache.xml" basename="p6-cache"/> |
---|
810 | </reference> |
---|
811 | |
---|
812 | <reference anchor="RFC2119"> |
---|
813 | <front> |
---|
814 | <title>Key words for use in RFCs to Indicate Requirement Levels</title> |
---|
815 | <author initials="S." surname="Bradner" fullname="Scott Bradner"> |
---|
816 | <organization>Harvard University</organization> |
---|
817 | <address><email>sob@harvard.edu</email></address> |
---|
818 | </author> |
---|
819 | <date month="March" year="1997"/> |
---|
820 | </front> |
---|
821 | <seriesInfo name="BCP" value="14"/> |
---|
822 | <seriesInfo name="RFC" value="2119"/> |
---|
823 | </reference> |
---|
824 | |
---|
825 | <reference anchor="RFC5234"> |
---|
826 | <front> |
---|
827 | <title abbrev="ABNF for Syntax Specifications">Augmented BNF for Syntax Specifications: ABNF</title> |
---|
828 | <author initials="D." surname="Crocker" fullname="Dave Crocker" role="editor"> |
---|
829 | <organization>Brandenburg InternetWorking</organization> |
---|
830 | <address> |
---|
831 | <email>dcrocker@bbiw.net</email> |
---|
832 | </address> |
---|
833 | </author> |
---|
834 | <author initials="P." surname="Overell" fullname="Paul Overell"> |
---|
835 | <organization>THUS plc.</organization> |
---|
836 | <address> |
---|
837 | <email>paul.overell@thus.net</email> |
---|
838 | </address> |
---|
839 | </author> |
---|
840 | <date month="January" year="2008"/> |
---|
841 | </front> |
---|
842 | <seriesInfo name="STD" value="68"/> |
---|
843 | <seriesInfo name="RFC" value="5234"/> |
---|
844 | </reference> |
---|
845 | |
---|
846 | </references> |
---|
847 | |
---|
848 | <references title="Informative References"> |
---|
849 | |
---|
850 | <reference anchor="RFC2616"> |
---|
851 | <front> |
---|
852 | <title>Hypertext Transfer Protocol -- HTTP/1.1</title> |
---|
853 | <author initials="R." surname="Fielding" fullname="R. Fielding"> |
---|
854 | <organization>University of California, Irvine</organization> |
---|
855 | <address><email>fielding@ics.uci.edu</email></address> |
---|
856 | </author> |
---|
857 | <author initials="J." surname="Gettys" fullname="J. Gettys"> |
---|
858 | <organization>W3C</organization> |
---|
859 | <address><email>jg@w3.org</email></address> |
---|
860 | </author> |
---|
861 | <author initials="J." surname="Mogul" fullname="J. Mogul"> |
---|
862 | <organization>Compaq Computer Corporation</organization> |
---|
863 | <address><email>mogul@wrl.dec.com</email></address> |
---|
864 | </author> |
---|
865 | <author initials="H." surname="Frystyk" fullname="H. Frystyk"> |
---|
866 | <organization>MIT Laboratory for Computer Science</organization> |
---|
867 | <address><email>frystyk@w3.org</email></address> |
---|
868 | </author> |
---|
869 | <author initials="L." surname="Masinter" fullname="L. Masinter"> |
---|
870 | <organization>Xerox Corporation</organization> |
---|
871 | <address><email>masinter@parc.xerox.com</email></address> |
---|
872 | </author> |
---|
873 | <author initials="P." surname="Leach" fullname="P. Leach"> |
---|
874 | <organization>Microsoft Corporation</organization> |
---|
875 | <address><email>paulle@microsoft.com</email></address> |
---|
876 | </author> |
---|
877 | <author initials="T." surname="Berners-Lee" fullname="T. Berners-Lee"> |
---|
878 | <organization>W3C</organization> |
---|
879 | <address><email>timbl@w3.org</email></address> |
---|
880 | </author> |
---|
881 | <date month="June" year="1999"/> |
---|
882 | </front> |
---|
883 | <seriesInfo name="RFC" value="2616"/> |
---|
884 | </reference> |
---|
885 | |
---|
886 | <reference anchor="RFC2617"> |
---|
887 | <front> |
---|
888 | <title abbrev="HTTP Authentication">HTTP Authentication: Basic and Digest Access Authentication</title> |
---|
889 | <author initials="J." surname="Franks" fullname="John Franks"> |
---|
890 | <organization>Northwestern University, Department of Mathematics</organization> |
---|
891 | <address><email>john@math.nwu.edu</email></address> |
---|
892 | </author> |
---|
893 | <author initials="P.M." surname="Hallam-Baker" fullname="Phillip M. Hallam-Baker"> |
---|
894 | <organization>Verisign Inc.</organization> |
---|
895 | <address><email>pbaker@verisign.com</email></address> |
---|
896 | </author> |
---|
897 | <author initials="J.L." surname="Hostetler" fullname="Jeffery L. Hostetler"> |
---|
898 | <organization>AbiSource, Inc.</organization> |
---|
899 | <address><email>jeff@AbiSource.com</email></address> |
---|
900 | </author> |
---|
901 | <author initials="S.D." surname="Lawrence" fullname="Scott D. Lawrence"> |
---|
902 | <organization>Agranat Systems, Inc.</organization> |
---|
903 | <address><email>lawrence@agranat.com</email></address> |
---|
904 | </author> |
---|
905 | <author initials="P.J." surname="Leach" fullname="Paul J. Leach"> |
---|
906 | <organization>Microsoft Corporation</organization> |
---|
907 | <address><email>paulle@microsoft.com</email></address> |
---|
908 | </author> |
---|
909 | <author initials="A." surname="Luotonen" fullname="Ari Luotonen"> |
---|
910 | <organization>Netscape Communications Corporation</organization> |
---|
911 | </author> |
---|
912 | <author initials="L." surname="Stewart" fullname="Lawrence C. Stewart"> |
---|
913 | <organization>Open Market, Inc.</organization> |
---|
914 | <address><email>stewart@OpenMarket.com</email></address> |
---|
915 | </author> |
---|
916 | <date month="June" year="1999"/> |
---|
917 | </front> |
---|
918 | <seriesInfo name="RFC" value="2617"/> |
---|
919 | </reference> |
---|
920 | |
---|
921 | <reference anchor='BCP90'> |
---|
922 | <front> |
---|
923 | <title>Registration Procedures for Message Header Fields</title> |
---|
924 | <author initials='G.' surname='Klyne' fullname='G. Klyne'> |
---|
925 | <organization>Nine by Nine</organization> |
---|
926 | <address><email>GK-IETF@ninebynine.org</email></address> |
---|
927 | </author> |
---|
928 | <author initials='M.' surname='Nottingham' fullname='M. Nottingham'> |
---|
929 | <organization>BEA Systems</organization> |
---|
930 | <address><email>mnot@pobox.com</email></address> |
---|
931 | </author> |
---|
932 | <author initials='J.' surname='Mogul' fullname='J. Mogul'> |
---|
933 | <organization>HP Labs</organization> |
---|
934 | <address><email>JeffMogul@acm.org</email></address> |
---|
935 | </author> |
---|
936 | <date year='2004' month='September' /> |
---|
937 | </front> |
---|
938 | <seriesInfo name='BCP' value='90' /> |
---|
939 | <seriesInfo name='RFC' value='3864' /> |
---|
940 | </reference> |
---|
941 | |
---|
942 | <reference anchor="RFC3986"> |
---|
943 | <front> |
---|
944 | <title abbrev='URI Generic Syntax'>Uniform Resource Identifier (URI): Generic Syntax</title> |
---|
945 | <author initials='T.' surname='Berners-Lee' fullname='Tim Berners-Lee'> |
---|
946 | <organization abbrev="W3C/MIT">World Wide Web Consortium</organization> |
---|
947 | <address> |
---|
948 | <email>timbl@w3.org</email> |
---|
949 | <uri>http://www.w3.org/People/Berners-Lee/</uri> |
---|
950 | </address> |
---|
951 | </author> |
---|
952 | <author initials='R.' surname='Fielding' fullname='Roy T. Fielding'> |
---|
953 | <organization abbrev="Day Software">Day Software</organization> |
---|
954 | <address> |
---|
955 | <email>fielding@gbiv.com</email> |
---|
956 | <uri>http://roy.gbiv.com/</uri> |
---|
957 | </address> |
---|
958 | </author> |
---|
959 | <author initials='L.' surname='Masinter' fullname='Larry Masinter'> |
---|
960 | <organization abbrev="Adobe Systems">Adobe Systems Incorporated</organization> |
---|
961 | <address> |
---|
962 | <email>LMM@acm.org</email> |
---|
963 | <uri>http://larry.masinter.net/</uri> |
---|
964 | </address> |
---|
965 | </author> |
---|
966 | <date month='January' year='2005'></date> |
---|
967 | </front> |
---|
968 | <seriesInfo name="STD" value="66"/> |
---|
969 | <seriesInfo name="RFC" value="3986"/> |
---|
970 | </reference> |
---|
971 | |
---|
972 | <reference anchor="RFC4648"> |
---|
973 | <front> |
---|
974 | <title>The Base16, Base32, and Base64 Data Encodings</title> |
---|
975 | <author fullname="S. Josefsson" initials="S." surname="Josefsson"/> |
---|
976 | <date year="2006" month="October"/> |
---|
977 | </front> |
---|
978 | <seriesInfo value="4648" name="RFC"/> |
---|
979 | </reference> |
---|
980 | |
---|
981 | <reference anchor='RFC5226'> |
---|
982 | <front> |
---|
983 | <title>Guidelines for Writing an IANA Considerations Section in RFCs</title> |
---|
984 | <author initials='T.' surname='Narten' fullname='T. Narten'> |
---|
985 | <organization>IBM</organization> |
---|
986 | <address><email>narten@us.ibm.com</email></address> |
---|
987 | </author> |
---|
988 | <author initials='H.' surname='Alvestrand' fullname='H. Alvestrand'> |
---|
989 | <organization>Google</organization> |
---|
990 | <address><email>Harald@Alvestrand.no</email></address> |
---|
991 | </author> |
---|
992 | <date year='2008' month='May' /> |
---|
993 | </front> |
---|
994 | <seriesInfo name='BCP' value='26' /> |
---|
995 | <seriesInfo name='RFC' value='5226' /> |
---|
996 | </reference> |
---|
997 | |
---|
998 | </references> |
---|
999 | |
---|
1000 | <section title="Changes from RFCs 2616 and 2617" anchor="changes.from.rfc.2616"> |
---|
1001 | <t> |
---|
1002 | The framework for HTTP Authentication is now defined by this document, |
---|
1003 | rather than RFC 2617. |
---|
1004 | </t> |
---|
1005 | <t> |
---|
1006 | The "realm" parameter is no longer always required on challenges; |
---|
1007 | consequently, the ABNF allows challenges without any auth parameters. |
---|
1008 | (<xref target="access.authentication.framework"/>) |
---|
1009 | </t> |
---|
1010 | <t> |
---|
1011 | The "token68" alternative to auth-param lists has been added for consistency |
---|
1012 | with legacy authentication schemes such as "Basic". |
---|
1013 | (<xref target="access.authentication.framework"/>) |
---|
1014 | </t> |
---|
1015 | <t> |
---|
1016 | This specification introduces the Authentication Scheme Registry, along with |
---|
1017 | considerations for new authentication schemes. |
---|
1018 | (<xref target="authentication.scheme.registry"/>) |
---|
1019 | </t> |
---|
1020 | </section> |
---|
1021 | |
---|
1022 | <section title="Imported ABNF" anchor="imported.abnf"> |
---|
1023 | <x:anchor-alias value="ALPHA"/> |
---|
1024 | <x:anchor-alias value="CR"/> |
---|
1025 | <x:anchor-alias value="DIGIT"/> |
---|
1026 | <x:anchor-alias value="LF"/> |
---|
1027 | <x:anchor-alias value="OCTET"/> |
---|
1028 | <x:anchor-alias value="VCHAR"/> |
---|
1029 | <x:anchor-alias value="SP"/> |
---|
1030 | <x:anchor-alias value="quoted-string"/> |
---|
1031 | <x:anchor-alias value="token"/> |
---|
1032 | <x:anchor-alias value="BWS"/> |
---|
1033 | <x:anchor-alias value="OWS"/> |
---|
1034 | <t> |
---|
1035 | The following core rules are included by |
---|
1036 | reference, as defined in <xref target="RFC5234" x:fmt="of" x:sec="B.1"/>: |
---|
1037 | ALPHA (letters), CR (carriage return), CRLF (CR LF), CTL (controls), |
---|
1038 | DIGIT (decimal 0-9), DQUOTE (double quote), |
---|
1039 | HEXDIG (hexadecimal 0-9/A-F/a-f), LF (line feed), |
---|
1040 | OCTET (any 8-bit sequence of data), SP (space), and |
---|
1041 | VCHAR (any visible US-ASCII character). |
---|
1042 | </t> |
---|
1043 | <t> |
---|
1044 | The rules below are defined in <xref target="Part1"/>: |
---|
1045 | </t> |
---|
1046 | <figure><artwork type="abnf2616"> |
---|
1047 | <x:ref>BWS</x:ref> = <BWS, defined in &whitespace;> |
---|
1048 | <x:ref>OWS</x:ref> = <OWS, defined in &whitespace;> |
---|
1049 | <x:ref>quoted-string</x:ref> = <quoted-string, defined in &field-components;> |
---|
1050 | <x:ref>token</x:ref> = <token, defined in &field-components;> |
---|
1051 | </artwork></figure> |
---|
1052 | </section> |
---|
1053 | |
---|
1054 | <?BEGININC p7-auth.abnf-appendix ?> |
---|
1055 | <section xmlns:x="http://purl.org/net/xml2rfc/ext" title="Collected ABNF" anchor="collected.abnf"> |
---|
1056 | <t> |
---|
1057 | In the collected ABNF below, list rules are expanded as per <xref target="Part1" x:rel="#notation"/>. |
---|
1058 | </t><figure> |
---|
1059 | <artwork type="abnf" name="p7-auth.parsed-abnf"> |
---|
1060 | <x:ref>Authorization</x:ref> = credentials |
---|
1061 | |
---|
1062 | <x:ref>BWS</x:ref> = <BWS, defined in [Part1], Section 3.2.3> |
---|
1063 | |
---|
1064 | <x:ref>OWS</x:ref> = <OWS, defined in [Part1], Section 3.2.3> |
---|
1065 | |
---|
1066 | <x:ref>Proxy-Authenticate</x:ref> = *( "," OWS ) challenge *( OWS "," [ OWS |
---|
1067 | challenge ] ) |
---|
1068 | <x:ref>Proxy-Authorization</x:ref> = credentials |
---|
1069 | |
---|
1070 | <x:ref>WWW-Authenticate</x:ref> = *( "," OWS ) challenge *( OWS "," [ OWS challenge |
---|
1071 | ] ) |
---|
1072 | |
---|
1073 | <x:ref>auth-param</x:ref> = token BWS "=" BWS ( token / quoted-string ) |
---|
1074 | <x:ref>auth-scheme</x:ref> = token |
---|
1075 | |
---|
1076 | <x:ref>challenge</x:ref> = auth-scheme [ 1*SP ( token68 / [ ( "," / auth-param ) *( |
---|
1077 | OWS "," [ OWS auth-param ] ) ] ) ] |
---|
1078 | <x:ref>credentials</x:ref> = auth-scheme [ 1*SP ( token68 / [ ( "," / auth-param ) |
---|
1079 | *( OWS "," [ OWS auth-param ] ) ] ) ] |
---|
1080 | |
---|
1081 | <x:ref>quoted-string</x:ref> = <quoted-string, defined in [Part1], Section 3.2.6> |
---|
1082 | |
---|
1083 | <x:ref>token</x:ref> = <token, defined in [Part1], Section 3.2.6> |
---|
1084 | <x:ref>token68</x:ref> = 1*( ALPHA / DIGIT / "-" / "." / "_" / "~" / "+" / "/" ) |
---|
1085 | *"=" |
---|
1086 | </artwork> |
---|
1087 | </figure> |
---|
1088 | </section> |
---|
1089 | <?ENDINC p7-auth.abnf-appendix ?> |
---|
1090 | |
---|
1091 | <section title="Change Log (to be removed by RFC Editor before publication)" anchor="change.log"> |
---|
1092 | <t> |
---|
1093 | Changes up to the first Working Group Last Call draft are summarized |
---|
1094 | in <eref target="http://trac.tools.ietf.org/html/draft-ietf-httpbis-p7-auth-19#appendix-C"/>. |
---|
1095 | </t> |
---|
1096 | |
---|
1097 | <section title="Since draft-ietf-httpbis-p7-auth-19" anchor="changes.since.19"> |
---|
1098 | <t> |
---|
1099 | Closed issues: |
---|
1100 | <list style="symbols"> |
---|
1101 | <t> |
---|
1102 | <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/348"/>: |
---|
1103 | "Realms and scope" |
---|
1104 | </t> |
---|
1105 | <t> |
---|
1106 | <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/349"/>: |
---|
1107 | "Strength" |
---|
1108 | </t> |
---|
1109 | <t> |
---|
1110 | <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/357"/>: |
---|
1111 | "Authentication exchanges" |
---|
1112 | </t> |
---|
1113 | <t> |
---|
1114 | <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/361"/>: |
---|
1115 | "ABNF requirements for recipients" |
---|
1116 | </t> |
---|
1117 | <t> |
---|
1118 | <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/368"/>: |
---|
1119 | "note introduction of new IANA registries as normative changes" |
---|
1120 | </t> |
---|
1121 | </list> |
---|
1122 | </t> |
---|
1123 | </section> |
---|
1124 | |
---|
1125 | <section title="Since draft-ietf-httpbis-p7-auth-20" anchor="changes.since.20"> |
---|
1126 | <t> |
---|
1127 | Closed issues: |
---|
1128 | <list style="symbols"> |
---|
1129 | <t> |
---|
1130 | <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/376"/>: |
---|
1131 | "rename b64token for clarity" |
---|
1132 | </t> |
---|
1133 | </list> |
---|
1134 | </t> |
---|
1135 | <t> |
---|
1136 | Other changes: |
---|
1137 | <list style="symbols"> |
---|
1138 | <t> |
---|
1139 | Conformance criteria and considerations regarding error handling are |
---|
1140 | now defined in Part 1. |
---|
1141 | </t> |
---|
1142 | </list> |
---|
1143 | </t> |
---|
1144 | </section> |
---|
1145 | |
---|
1146 | <section title="Since draft-ietf-httpbis-p7-auth-21" anchor="changes.since.21"> |
---|
1147 | <t> |
---|
1148 | Closed issues: |
---|
1149 | <list style="symbols"> |
---|
1150 | <t> |
---|
1151 | <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/403"/>: |
---|
1152 | "Authentication and caching - max-age" |
---|
1153 | </t> |
---|
1154 | </list> |
---|
1155 | </t> |
---|
1156 | </section> |
---|
1157 | |
---|
1158 | <section title="Since draft-ietf-httpbis-p7-auth-22" anchor="changes.since.22"> |
---|
1159 | <t> |
---|
1160 | Closed issues: |
---|
1161 | <list style="symbols"> |
---|
1162 | <t> |
---|
1163 | <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/436"/>: |
---|
1164 | "explain list expansion in ABNF appendices" |
---|
1165 | </t> |
---|
1166 | <t> |
---|
1167 | <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/439"/>: |
---|
1168 | "terminology: mechanism vs framework vs scheme" |
---|
1169 | </t> |
---|
1170 | <t> |
---|
1171 | <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/463"/>: |
---|
1172 | "Editorial suggestions" |
---|
1173 | </t> |
---|
1174 | <t> |
---|
1175 | <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/464"/>: |
---|
1176 | "placement of extension point considerations" |
---|
1177 | </t> |
---|
1178 | </list> |
---|
1179 | </t> |
---|
1180 | </section> |
---|
1181 | </section> |
---|
1182 | |
---|
1183 | </back> |
---|
1184 | </rfc> |
---|