source: draft-ietf-httpbis/latest/p7-auth.xml @ 1643

Last change on this file since 1643 was 1636, checked in by julian.reschke@…, 8 years ago

add formal ref to RFC2616 in order to silence xml2rfc warnings

  • Property svn:eol-style set to native
  • Property svn:mime-type set to text/xml
File size: 47.6 KB
[29]1<?xml version="1.0" encoding="utf-8"?>
[101]2<?xml-stylesheet type='text/xsl' href='../myxml2rfc.xslt'?>
[8]3<!DOCTYPE rfc [
4  <!ENTITY MAY "<bcp14 xmlns=''>MAY</bcp14>">
5  <!ENTITY MUST "<bcp14 xmlns=''>MUST</bcp14>">
6  <!ENTITY MUST-NOT "<bcp14 xmlns=''>MUST NOT</bcp14>">
7  <!ENTITY OPTIONAL "<bcp14 xmlns=''>OPTIONAL</bcp14>">
8  <!ENTITY RECOMMENDED "<bcp14 xmlns=''>RECOMMENDED</bcp14>">
9  <!ENTITY REQUIRED "<bcp14 xmlns=''>REQUIRED</bcp14>">
10  <!ENTITY SHALL "<bcp14 xmlns=''>SHALL</bcp14>">
11  <!ENTITY SHALL-NOT "<bcp14 xmlns=''>SHALL NOT</bcp14>">
12  <!ENTITY SHOULD "<bcp14 xmlns=''>SHOULD</bcp14>">
13  <!ENTITY SHOULD-NOT "<bcp14 xmlns=''>SHOULD NOT</bcp14>">
[29]14  <!ENTITY ID-VERSION "latest">
[1552]15  <!ENTITY ID-MONTH "March">
[1497]16  <!ENTITY ID-YEAR "2012">
[1101]17  <!ENTITY mdash "&#8212;">
[1452]18  <!ENTITY architecture                 "<xref target='Part1' x:rel='#architecture' xmlns:x=''/>">
[424]19  <!ENTITY notation                     "<xref target='Part1' x:rel='#notation' xmlns:x=''/>">
[1518]20  <!ENTITY abnf-extension               "<xref target='Part1' x:rel='#abnf.extension' xmlns:x=''/>">
[1399]21  <!ENTITY acks                         "<xref target='Part1' x:rel='#acks' xmlns:x=''/>">
[1518]22  <!ENTITY whitespace                   "<xref target='Part1' x:rel='#whitespace' xmlns:x=''/>">
23  <!ENTITY field-components             "<xref target='Part1' x:rel='#field.components' xmlns:x=''/>">
[961]24  <!ENTITY effective-request-uri        "<xref target='Part1' x:rel='#effective.request.uri' xmlns:x=''/>">
[1518]25  <!ENTITY msg-orient-and-buffering     "<xref target='Part1' x:rel='#intermediaries' xmlns:x=''/>">
[998]26  <!ENTITY end-to-end.and-hop-by-hop    "<xref target='Part1' x:rel='#end-to-end.and.hop-by-hop.header-fields' xmlns:x=''/>">
[31]27  <!ENTITY shared-and-non-shared-caches "<xref target='Part6' x:rel='#shared.and.non-shared.caches' xmlns:x=''/>">
29<?rfc toc="yes" ?>
[29]30<?rfc symrefs="yes" ?>
31<?rfc sortrefs="yes" ?>
[8]32<?rfc compact="yes"?>
33<?rfc subcompact="no" ?>
34<?rfc linkmailto="no" ?>
35<?rfc editing="no" ?>
[205]36<?rfc comments="yes"?>
37<?rfc inline="yes"?>
[799]38<?rfc rfcedstyle="yes"?>
[8]39<?rfc-ext allow-markup-in-artwork="yes" ?>
40<?rfc-ext include-references-in-index="yes" ?>
[1477]41<rfc obsoletes="2616" updates="2617" category="std" x:maturity-level="proposed"
[446]42     ipr="pre5378Trust200902" docName="draft-ietf-httpbis-p7-auth-&ID-VERSION;"
[153]43     xmlns:x=''>
[1472]44<x:link rel="prev" basename="p6-cache"/>
[1522]45<x:feedback template="{docname},%20%22{section}%22&amp;body=&lt;{ref}&gt;:"/>
[120]48  <title abbrev="HTTP/1.1, Part 7">HTTP/1.1, part 7: Authentication</title>
[29]50  <author initials="R." surname="Fielding" fullname="Roy T. Fielding" role="editor">
[1106]51    <organization abbrev="Adobe">Adobe Systems Incorporated</organization>
[8]52    <address>
53      <postal>
[1106]54        <street>345 Park Ave</street>
55        <city>San Jose</city>
[8]56        <region>CA</region>
[1106]57        <code>95110</code>
[29]58        <country>USA</country>
[8]59      </postal>
[29]60      <email></email>
61      <uri></uri>
[8]62    </address>
63  </author>
[95]65  <author initials="Y." surname="Lafon" fullname="Yves Lafon" role="editor">
66    <organization abbrev="W3C">World Wide Web Consortium</organization>
67    <address>
68      <postal>
69        <street>W3C / ERCIM</street>
70        <street>2004, rte des Lucioles</street>
71        <city>Sophia-Antipolis</city>
72        <region>AM</region>
73        <code>06902</code>
74        <country>France</country>
75      </postal>
76      <email></email>
77      <uri></uri>
78    </address>
79  </author>
81  <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke" role="editor">
82    <organization abbrev="greenbytes">greenbytes GmbH</organization>
83    <address>
84      <postal>
85        <street>Hafenweg 16</street>
86        <city>Muenster</city><region>NW</region><code>48155</code>
87        <country>Germany</country>
88      </postal>
[609]89      <phone>+49 251 2807760</phone>
90      <facsimile>+49 251 2807761</facsimile>
91      <email></email>
92      <uri></uri>
[95]93    </address>
94  </author>
[31]96  <date month="&ID-MONTH;" year="&ID-YEAR;"/>
[440]97  <workgroup>HTTPbis Working Group</workgroup>
[1373]101   The Hypertext Transfer Protocol (HTTP) is an application-level protocol for
102   distributed, collaborative, hypermedia information systems. HTTP has been in
103   use by the World Wide Web global information initiative since 1990. This
104   document is Part 7 of the seven-part specification that defines the protocol
105   referred to as "HTTP/1.1" and, taken together, obsoletes RFC 2616.
108   Part 7 defines the HTTP Authentication framework.
112<note title="Editorial Note (To be removed by RFC Editor)">
113  <t>
114    Discussion of this draft should take place on the HTTPBIS working group
[1268]115    mailing list (, which is archived at
116    <eref target=""/>.
117  </t>
118  <t>
119    The current issues list is at
120    <eref target=""/> and related
121    documents (including fancy diffs) can be found at
[324]122    <eref target=""/>.
[36]123  </t>
[153]124  <t>
[1592]125    The changes in this draft are summarized in <xref target="changes.since.19"/>.
[153]126  </t>
130<section title="Introduction" anchor="introduction">
[998]132   This document defines HTTP/1.1 access control and authentication. It
133   includes the relevant parts of <xref target="RFC2616" x:fmt="none">RFC 2616</xref>
[1636]134   with only minor changes (<xref target="RFC2616"/>), plus the general framework for HTTP authentication,
[998]135   as previously defined in "HTTP Authentication: Basic and Digest Access
136   Authentication" (<xref target="RFC2617"/>).
139   HTTP provides several &OPTIONAL; challenge-response authentication
[998]140   mechanisms which can be used by a server to challenge a client request and
141   by a client to provide authentication information. The "basic" and "digest"
142   authentication schemes continue to be specified in
143   <xref target="RFC2617" x:fmt="none">RFC 2617</xref>.
[1452]146<section title="Conformance and Error Handling" anchor="intro.conformance.and.error.handling">
148   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
149   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
150   document are to be interpreted as described in <xref target="RFC2119"/>.
[1452]153   This document defines conformance criteria for several roles in HTTP
154   communication, including Senders, Recipients, Clients, Servers, User-Agents,
155   Origin Servers, Intermediaries, Proxies and Gateways. See &architecture;
156   for definitions of these terms.
159   An implementation is considered conformant if it complies with all of the
160   requirements associated with its role(s). Note that SHOULD-level requirements
161   are relevant here, unless one of the documented exceptions is applicable.
164   This document also uses ABNF to define valid protocol elements
165   (<xref target="notation"/>). In addition to the prose requirements placed
166   upon them, Senders &MUST-NOT; generate protocol elements that are invalid.
169   Unless noted otherwise, Recipients &MAY; take steps to recover a usable
170   protocol element from an invalid construct. However, HTTP does not define
171   specific error handling mechanisms, except in cases where it has direct
172   impact on security. This is because different uses of the protocol require
173   different error handling strategies; for example, a Web browser may wish to
174   transparently recover from a response where the Location header field
175   doesn't parse according to the ABNF, whereby in a systems control protocol
176   using HTTP, this type of error recovery could lead to dangerous consequences.
[424]180<section title="Syntax Notation" anchor="notation">
[425]181  <x:anchor-alias value="ALPHA"/>
182  <x:anchor-alias value="CR"/>
183  <x:anchor-alias value="DIGIT"/>
184  <x:anchor-alias value="LF"/>
185  <x:anchor-alias value="OCTET"/>
186  <x:anchor-alias value="VCHAR"/>
[998]187  <x:anchor-alias value="SP"/>
[1518]189   This specification uses the Augmented Backus-Naur Form (ABNF) notation
190   of <xref target="RFC5234"/> with the list rule extension defined in
191   &notation;<xref target="collected.abnf"/> shows the collected ABNF
192   with the list rule expanded.
[425]195  The following core rules are included by
196  reference, as defined in <xref target="RFC5234" x:fmt="," x:sec="B.1"/>:
197  ALPHA (letters), CR (carriage return), CRLF (CR LF), CTL (controls),
198  DIGIT (decimal 0-9), DQUOTE (double quote),
199  HEXDIG (hexadecimal 0-9/A-F/a-f), LF (line feed),
[1425]200  OCTET (any 8-bit sequence of data), SP (space), and
201  VCHAR (any visible US-ASCII character).
204<section title="Core Rules" anchor="core.rules">
[998]205   <x:anchor-alias value="quoted-string"/>
206   <x:anchor-alias value="token"/>
[1386]207   <x:anchor-alias value="BWS"/>
[998]208   <x:anchor-alias value="OWS"/>
[1396]210   The core rules below are defined in <xref target="Part1"/>:
212<figure><artwork type="abnf2616">
[1518]213  <x:ref>BWS</x:ref>           = &lt;BWS, defined in &whitespace;&gt;
214  <x:ref>OWS</x:ref>           = &lt;OWS, defined in &whitespace;&gt;
215  <x:ref>quoted-string</x:ref> = &lt;quoted-string, defined in &field-components;&gt;
216  <x:ref>token</x:ref>         = &lt;token, defined in &field-components;&gt;
[998]222<section title="Access Authentication Framework" anchor="access.authentication.framework">
224<section title="Challenge and Response" anchor="challenge.and.response">
[998]225  <x:anchor-alias value="auth-scheme"/>
226  <x:anchor-alias value="auth-param"/>
[1394]227  <x:anchor-alias value="b64token"/>
[229]228  <x:anchor-alias value="challenge"/>
229  <x:anchor-alias value="credentials"/>
[998]231   HTTP provides a simple challenge-response authentication mechanism
232   that can be used by a server to challenge a client request and by a
233   client to provide authentication information. It uses an extensible,
[1394]234   case-insensitive token to identify the authentication scheme, followed
235   by additional information necessary for achieving authentication via that
[1473]236   scheme. The latter can either be a comma-separated list of parameters or a
237   single sequence of characters capable of holding base64-encoded
[1394]238   information.
241   Parameters are name-value pairs where the name is matched case-insensitively,
242   and each parameter name &MUST; only occur once per challenge.
[1394]244<figure><artwork type="abnf2616"><iref item="auth-scheme" primary="true"/><iref item="auth-param" primary="true"/><iref primary="true" item="Grammar" subitem="auth-scheme"/><iref primary="true" item="Grammar" subitem="auth-param"/><iref item="b64token" primary="true"/><iref primary="true" item="Grammar" subitem="b64token"/>
[1386]245  auth-scheme    = <x:ref>token</x:ref>
[1386]247  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> )
249  b64token       = 1*( <x:ref>ALPHA</x:ref> / <x:ref>DIGIT</x:ref> /
250                       "-" / "." / "_" / "~" / "+" / "/" ) *"="
[1394]253   The "b64token" syntax allows the 66 unreserved URI characters (<xref target="RFC3986"/>),
254   plus a few others, so that it can hold a base64, base64url (URL and filename
255   safe alphabet), base32, or base16 (hex) encoding, with or without padding, but
256   excluding whitespace (<xref target="RFC4648"/>).
[998]259   The 401 (Unauthorized) response message is used by an origin server
260   to challenge the authorization of a user agent. This response &MUST;
261   include a WWW-Authenticate header field containing at least one
[1344]262   challenge applicable to the requested resource.
265   The 407 (Proxy Authentication Required) response message is used by a proxy to
[998]266   challenge the authorization of a client and &MUST; include a Proxy-Authenticate
267   header field containing at least one challenge
268   applicable to the proxy for the requested resource.
[1387]270<figure><artwork type="abnf2616"><iref item="challenge" primary="true"/><iref primary="true" item="Grammar" subitem="challenge"/>
[1394]271  <x:ref>challenge</x:ref>   = <x:ref>auth-scheme</x:ref> [ 1*<x:ref>SP</x:ref> ( <x:ref>b64token</x:ref> / #<x:ref>auth-param</x:ref> ) ]
274  <t>
[1343]275     <x:h>Note:</x:h> User agents will need to take special care in parsing the
276     WWW-Authenticate and Proxy-Authenticate header field values because they
277     can contain more than one challenge, or if more than one of each is
278     provided, since the contents of a challenge can itself contain a
279     comma-separated list of authentication parameters.
[998]280  </t>
283  <t>
[1600]284     <x:h>Note:</x:h> Many clients fail to parse challenges containing unknown
[1343]285     schemes. A workaround for this problem is to list well-supported schemes
[1344]286     (such as "basic") first.<!-- see -->
[1018]287  </t>
[1344]290   A user agent that wishes to authenticate itself with an origin server
291   &mdash; usually, but not necessarily, after receiving a 401 (Unauthorized)
292   &mdash; &MAY; do so by including an Authorization header field with the
293   request.
296   A client that wishes to authenticate itself with a proxy &mdash; usually,
297   but not necessarily, after receiving a 407 (Proxy Authentication Required)
298   &mdash; &MAY; do so by including a Proxy-Authorization header field with the
299   request.
302   Both the Authorization field value and the Proxy-Authorization field value
303   consist of credentials containing the authentication information of the
304   client for the realm of the resource being requested. The user agent &MUST;
[998]305   choose to use one of the challenges with the strongest auth-scheme it
[1344]306   understands and request credentials from the user based upon that challenge.
[1387]308<figure><artwork type="abnf2616"><iref item="credentials" primary="true"/><iref primary="true" item="Grammar" subitem="credentials"/>
[1394]309  <x:ref>credentials</x:ref> = <x:ref>auth-scheme</x:ref> [ 1*<x:ref>SP</x:ref> ( <x:ref>b64token</x:ref> / #<x:ref>auth-param</x:ref> ) ]
312   If the origin server does not wish to accept the credentials sent
313   with a request, it &SHOULD; return a 401 (Unauthorized) response. The
314   response &MUST; include a WWW-Authenticate header field containing at
315   least one (possibly new) challenge applicable to the requested
[1344]316   resource.
319   If a proxy does not accept the credentials sent with a
[998]320   request, it &SHOULD; return a 407 (Proxy Authentication Required). The
321   response &MUST; include a Proxy-Authenticate header field containing a
322   (possibly new) challenge applicable to the proxy for the requested
323   resource.
326   The HTTP protocol does not restrict applications to this simple
327   challenge-response mechanism for access authentication. Additional
328   mechanisms &MAY; be used, such as encryption at the transport level or
329   via message encapsulation, and with additional header fields
[1107]330   specifying authentication information. However, such additional
[998]331   mechanisms are not defined by this specification.
[1107]334   Proxies &MUST; forward the WWW-Authenticate and Authorization headers
335   unmodified and follow the rules found in <xref target="header.authorization"/>.
[1344]339<section title="Protection Space (Realm)" anchor="">
[1354]340  <iref item="Protection Space"/>
341  <iref item="Realm"/>
[1354]343   The authentication parameter realm is reserved for use by authentication
[1478]344   schemes that wish to indicate the scope of protection.
[1354]347   A <x:dfn>protection space</x:dfn> is defined by the canonical root URI (the
348   scheme and authority components of the effective request URI; see
349   <xref target="Part1" x:fmt="of" x:rel="#effective.request.uri"/>) of the
350   server being accessed, in combination with the realm value if present.
[1344]351   These realms allow the protected resources on a server to be
352   partitioned into a set of protection spaces, each with its own
353   authentication scheme and/or authorization database. The realm value
354   is a string, generally assigned by the origin server, which can have
355   additional semantics specific to the authentication scheme. Note that
356   there can be multiple challenges with the same auth-scheme but
357   different realms.
360   The protection space determines the domain over which credentials can
361   be automatically applied. If a prior request has been authorized, the
362   same credentials &MAY; be reused for all other requests within that
363   protection space for a period of time determined by the
364   authentication scheme, parameters, and/or user preference. Unless
365   otherwise defined by the authentication scheme, a single protection
366   space cannot extend outside the scope of its server.
369   For historical reasons, senders &MUST; only use the quoted-string syntax.
370   Recipients might have to support both token and quoted-string syntax for
371   maximum interoperability with existing clients that have been accepting both
372   notations for a long time.
[1026]376<section title="Authentication Scheme Registry" anchor="authentication.scheme.registry">
378  The HTTP Authentication Scheme Registry defines the name space for the
379  authentication schemes in challenges and credentials.
382  Registrations &MUST; include the following fields:
383  <list style="symbols">
384    <t>Authentication Scheme Name</t>
385    <t>Pointer to specification text</t>
[1371]386    <t>Notes (optional)</t>
[1026]387  </list>
[1567]390  Values to be added to this name space require IETF Review
391  (see <xref target="RFC5226" x:fmt="," x:sec="4.1"/>).
394  The registry itself is maintained at <eref target=""/>.
397<section title="Considerations for New Authentication Schemes" anchor="">
399  There are certain aspects of the HTTP Authentication Framework that put
400  constraints on how new authentication schemes can work:
403  <list style="symbols">
[1360]404    <x:lt>
[1356]405    <t>
[1518]406      HTTP authentication is presumed to be stateless: all of the information
407      necessary to authenticate a request &MUST; be provided in the request,
408      rather than be dependent on the server remembering prior requests.
409      Authentication based on, or bound to, the underlying connection is
410      outside the scope of this specification and inherently flawed unless
411      steps are taken to ensure that the connection cannot be used by any
412      party other than the authenticated user
413      (see &msg-orient-and-buffering;).
[1356]414    </t>
[1360]415    </x:lt>
416    <x:lt>
[1356]417    <t>
418      The authentication parameter "realm" is reserved for defining Protection
419      Spaces as defined in <xref target=""/>. New schemes
420      &MUST-NOT; use it in a way incompatible with that definition.
421    </t>
[1360]422    </x:lt>
423    <x:lt>
[1356]424    <t>
[1394]425      The "b64token" notation was introduced for compatibility with existing
426      authentication schemes and can only be used once per challenge/credentials.
427      New schemes thus ought to use the "auth-param" syntax instead, because
428      otherwise future extensions will be impossible.
429    </t>
430    </x:lt>
431    <x:lt>
432    <t>
[1465]433      The parsing of challenges and credentials is defined by this specification,
434      and cannot be modified by new authentication schemes. When the auth-param
435      syntax is used, all parameters ought to support both token and
436      quoted-string syntax, and syntactical constraints ought to be defined on
437      the field value after parsing (i.e., quoted-string processing). This is
438      necessary so that recipients can use a generic parser that applies to
439      all authentication schemes.
440    </t>
441    <t>
442      <x:h>Note:</x:h> the fact that the value syntax for the "realm" parameter
443      is restricted to quoted-string was a bad design choice not to be repeated
444      for new parameters.
445    </t>
446    </x:lt>
447    <x:lt>
448    <t>
[1562]449      Definitions of new schemes ought to define the treatment of unknown
450      extension parameters. In general, a "must-ignore" rule is preferable
451      over "must-understand", because otherwise it will be hard to introduce
452      new parameters in the presence of legacy recipients. Furthermore,
453      it's good to describe the policy for defining new parameters (such
454      as "update the specification", or "use this registry").
455    </t>
456    </x:lt>
457    <x:lt>
458    <t>
[1357]459      Authentication schemes need to document whether they are usable in
[1356]460      origin-server authentication (i.e., using WWW-Authenticate), and/or
461      proxy authentication (i.e., using Proxy-Authenticate).
[1360]462    </t>
463    </x:lt>
464    <x:lt>
465    <t>
466      The credentials carried in an Authorization header field are specific to
467      the User Agent, and therefore have the same effect on HTTP caches as the
468      "private" Cache-Control response directive, within the scope of the
469      request they appear in.
470    </t>
471    <t>
472      Therefore, new authentication schemes which choose not to carry
473      credentials in the Authorization header (e.g., using a newly defined
474      header) will need to explicitly disallow caching, by mandating the use of
475      either Cache-Control request directives (e.g., "no-store") or response
476      directives (e.g., "private").
477    </t>
478    </x:lt>
[1356]479  </list>
[838]487<section title="Status Code Definitions" anchor="status.code.definitions">
[39]488<section title="401 Unauthorized" anchor="status.401">
489  <iref primary="true" item="401 Unauthorized (status code)" x:for-anchor=""/>
490  <iref primary="true" item="Status Codes" subitem="401 Unauthorized" x:for-anchor=""/>
492   The request requires user authentication. The response &MUST; include a
493   WWW-Authenticate header field (<xref target="header.www-authenticate"/>) containing a challenge
[965]494   applicable to the target resource. The client &MAY; repeat the
[39]495   request with a suitable Authorization header field (<xref target="header.authorization"/>). If
496   the request already included Authorization credentials, then the 401
497   response indicates that authorization has been refused for those
498   credentials. If the 401 response contains the same challenge as the
499   prior response, and the user agent has already attempted
500   authentication at least once, then the user &SHOULD; be presented the
[874]501   representation that was given in the response, since that representation might
[998]502   include relevant diagnostic information.
505<section title="407 Proxy Authentication Required" anchor="status.407">
506  <iref primary="true" item="407 Proxy Authentication Required (status code)" x:for-anchor=""/>
507  <iref primary="true" item="Status Codes" subitem="407 Proxy Authentication Required" x:for-anchor=""/>
509   This code is similar to 401 (Unauthorized), but indicates that the
[998]510   client ought to first authenticate itself with the proxy. The proxy &MUST;
[39]511   return a Proxy-Authenticate header field (<xref target="header.proxy-authenticate"/>) containing a
[965]512   challenge applicable to the proxy for the target resource. The
[39]513   client &MAY; repeat the request with a suitable Proxy-Authorization
[998]514   header field (<xref target="header.proxy-authorization"/>).
[1415]519<section title="Header Field Definitions" anchor="header.field.definitions">
[117]521   This section defines the syntax and semantics of HTTP/1.1 header fields
522   related to authentication.
525<section title="Authorization" anchor="header.authorization">
[1120]526  <iref primary="true" item="Authorization header field" x:for-anchor=""/>
527  <iref primary="true" item="Header Fields" subitem="Authorization" x:for-anchor=""/>
[229]528  <x:anchor-alias value="Authorization"/>
[1163]530   The "Authorization" header field allows a user agent to authenticate
[1101]531   itself with a server &mdash; usually, but not necessarily, after receiving a 401
[698]532   (Unauthorized) response. Its value consists of credentials containing
533   information of the user agent for the realm of the resource being
534   requested.
[1230]536<figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="Authorization"/>
537  <x:ref>Authorization</x:ref> = <x:ref>credentials</x:ref>
[998]540   If a request is
[698]541   authenticated and a realm specified, the same credentials &SHOULD;
542   be valid for all other requests within this realm (assuming that
543   the authentication scheme itself does not require otherwise, such
544   as credentials that vary according to a challenge value or using
545   synchronized clocks).
[29]548      When a shared cache (see &shared-and-non-shared-caches;) receives a request
[8]549      containing an Authorization field, it &MUST-NOT; return the
550      corresponding response as a reply to any other request, unless one
551      of the following specific exceptions holds:
554  <list style="numbers">
555      <t>If the response includes the "s-maxage" cache-control
556         directive, the cache &MAY; use that response in replying to a
557         subsequent request. But (if the specified maximum age has
558         passed) a proxy cache &MUST; first revalidate it with the origin
[1163]559         server, using the header fields from the new request to allow
[8]560         the origin server to authenticate the new request. (This is the
561         defined behavior for s-maxage.) If the response includes "s-maxage=0",
562         the proxy &MUST; always revalidate it before re-using
563         it.</t>
565      <t>If the response includes the "must-revalidate" cache-control
566         directive, the cache &MAY; use that response in replying to a
567         subsequent request. But if the response is stale, all caches
568         &MUST; first revalidate it with the origin server, using the
[1163]569         header fields from the new request to allow the origin server
[8]570         to authenticate the new request.</t>
572      <t>If the response includes the "public" cache-control directive,
573         it &MAY; be returned in reply to any subsequent request.</t>
574  </list>
578<section title="Proxy-Authenticate" anchor="header.proxy-authenticate">
[1120]579  <iref primary="true" item="Proxy-Authenticate header field" x:for-anchor=""/>
580  <iref primary="true" item="Header Fields" subitem="Proxy-Authenticate" x:for-anchor=""/>
[229]581  <x:anchor-alias value="Proxy-Authenticate"/>
[1601]583   The "Proxy-Authenticate" header field consists of at least one
584   challenge that indicates the authentication scheme(s) and parameters
585   applicable to the proxy for this effective request URI (&effective-request-uri;).
586   It &MUST; be included as part of a 407 (Proxy Authentication Required) response.
[1230]588<figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="Proxy-Authenticate"/>
589  <x:ref>Proxy-Authenticate</x:ref> = 1#<x:ref>challenge</x:ref>
[998]592   Unlike WWW-Authenticate, the Proxy-Authenticate header field applies only to
[8]593   the current connection and &SHOULD-NOT;  be passed on to downstream
594   clients. However, an intermediate proxy might need to obtain its own
595   credentials by requesting them from the downstream client, which in
596   some circumstances will appear as if the proxy is forwarding the
597   Proxy-Authenticate header field.
600   Note that the parsing considerations for WWW-Authenticate apply to this
601   header field as well; see <xref target="header.www-authenticate"/> for
602   details.
606<section title="Proxy-Authorization" anchor="header.proxy-authorization">
[1120]607  <iref primary="true" item="Proxy-Authorization header field" x:for-anchor=""/>
608  <iref primary="true" item="Header Fields" subitem="Proxy-Authorization" x:for-anchor=""/>
[229]609  <x:anchor-alias value="Proxy-Authorization"/>
[1163]611   The "Proxy-Authorization" header field allows the client to
[8]612   identify itself (or its user) to a proxy which requires
[698]613   authentication. Its value consists of
[8]614   credentials containing the authentication information of the user
615   agent for the proxy and/or realm of the resource being requested.
[1230]617<figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="Proxy-Authorization"/>
618  <x:ref>Proxy-Authorization</x:ref> = <x:ref>credentials</x:ref>
[998]621   Unlike Authorization, the Proxy-Authorization header field applies only to
[8]622   the next outbound proxy that demanded authentication using the Proxy-Authenticate
623   field. When multiple proxies are used in a chain, the
624   Proxy-Authorization header field is consumed by the first outbound
625   proxy that was expecting to receive credentials. A proxy &MAY; relay
626   the credentials from the client request to the next proxy if that is
627   the mechanism by which the proxies cooperatively authenticate a given
628   request.
632<section title="WWW-Authenticate" anchor="header.www-authenticate">
[1120]633  <iref primary="true" item="WWW-Authenticate header field" x:for-anchor=""/>
634  <iref primary="true" item="Header Fields" subitem="WWW-Authenticate" x:for-anchor=""/>
[229]635  <x:anchor-alias value="WWW-Authenticate"/>
[1163]637   The "WWW-Authenticate" header field consists of at least one
[698]638   challenge that indicates the authentication scheme(s) and parameters
[1360]639   applicable to the effective request URI (&effective-request-uri;).
642   It &MUST; be included in 401 (Unauthorized) response messages and &MAY; be
643   included in other response messages to indicate that supplying credentials
644   (or different credentials) might affect the response.
[1230]646<figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="WWW-Authenticate"/>
647  <x:ref>WWW-Authenticate</x:ref> = 1#<x:ref>challenge</x:ref>
[998]650   User agents are advised to take special care in parsing the WWW-Authenticate
[8]651   field value as it might contain more than one challenge,
652   or if more than one WWW-Authenticate header field is provided, the
653   contents of a challenge itself can contain a comma-separated list of
654   authentication parameters.
657  <preamble>For instance:</preamble>
658  <artwork type="example">
659  WWW-Authenticate: Newauth realm="apps", type=1,
660                    title="Login to \"apps\"", Basic realm="simple"
662  <postamble>
663  This header field contains two challenges; one for the "Newauth" scheme
664  with a realm value of "apps", and two additional parameters "type" and
[1533]665  "title", and another one for the "Basic" scheme with a realm value of
666  "simple".
669  <t>
670    <x:h>Note:</x:h> The challenge grammar production uses the list syntax as
671    well. Therefore, a sequence of comma, whitespace, and comma can be
672    considered both as applying to the preceding challenge, or to be an
673    empty entry in the list of challenges. In practice, this ambiguity
674    does not affect the semantics of the header field value and thus is
675    harmless.
676  </t>
[29]682<section title="IANA Considerations" anchor="IANA.considerations">
[1026]684<section title="Authenticaton Scheme Registry" anchor="authentication.scheme.registration">
686  The registration procedure for HTTP Authentication Schemes is defined by
687  <xref target="authentication.scheme.registry"/> of this document.
690   The HTTP Method Authentication Scheme shall be created at <eref target=""/>.
[700]694<section title="Status Code Registration" anchor="status.code.registration">
696   The HTTP Status Code Registry located at <eref target=""/>
[969]697   shall be updated with the registrations below:
699<?BEGININC p7-auth.iana-status-codes ?>
700<!--AUTOGENERATED FROM extract-status-code-defs.xslt, do not edit manually-->
701<texttable align="left" suppress-title="true" anchor="iana.status.code.registration.table">
702   <ttcol>Value</ttcol>
703   <ttcol>Description</ttcol>
704   <ttcol>Reference</ttcol>
705   <c>401</c>
706   <c>Unauthorized</c>
707   <c>
708      <xref target="status.401"/>
709   </c>
710   <c>407</c>
711   <c>Proxy Authentication Required</c>
712   <c>
713      <xref target="status.407"/>
714   </c>
717<?ENDINC p7-auth.iana-status-codes ?>
[921]720<section title="Header Field Registration" anchor="header.field.registration">
[969]722   The Message Header Field Registry located at <eref target=""/> shall be updated
[290]723   with the permanent registrations below (see <xref target="RFC3864"/>):
[680]725<?BEGININC p7-auth.iana-headers ?>
[253]726<!--AUTOGENERATED FROM extract-header-defs.xslt, do not edit manually-->
[290]727<texttable align="left" suppress-title="true" anchor="iana.header.registration.table">
[253]728   <ttcol>Header Field Name</ttcol>
729   <ttcol>Protocol</ttcol>
730   <ttcol>Status</ttcol>
731   <ttcol>Reference</ttcol>
733   <c>Authorization</c>
734   <c>http</c>
735   <c>standard</c>
736   <c>
737      <xref target="header.authorization"/>
738   </c>
739   <c>Proxy-Authenticate</c>
740   <c>http</c>
741   <c>standard</c>
742   <c>
743      <xref target="header.proxy-authenticate"/>
744   </c>
745   <c>Proxy-Authorization</c>
746   <c>http</c>
747   <c>standard</c>
748   <c>
749      <xref target="header.proxy-authorization"/>
750   </c>
751   <c>WWW-Authenticate</c>
752   <c>http</c>
753   <c>standard</c>
754   <c>
755      <xref target="header.www-authenticate"/>
756   </c>
[680]759<?ENDINC p7-auth.iana-headers ?>
[290]761   The change controller is: "IETF ( - Internet Engineering Task Force".
766<section title="Security Considerations" anchor="security.considerations">
768   This section is meant to inform application developers, information
769   providers, and users of the security limitations in HTTP/1.1 as
770   described by this document. The discussion does not include
771   definitive solutions to the problems revealed, though it does make
772   some suggestions for reducing security risks.
775<section title="Authentication Credentials and Idle Clients" anchor="auth.credentials.and.idle.clients">
777   Existing HTTP clients and user agents typically retain authentication
[145]778   information indefinitely. HTTP/1.1 does not provide a method for a
[8]779   server to direct clients to discard these cached credentials. This is
780   a significant defect that requires further extensions to HTTP.
781   Circumstances under which credential caching can interfere with the
782   application's security model include but are not limited to:
783  <list style="symbols">
784     <t>Clients which have been idle for an extended period following
785        which the server might wish to cause the client to reprompt the
786        user for credentials.</t>
788     <t>Applications which include a session termination indication
[746]789        (such as a "logout" or "commit" button on a page) after which
790        the server side of the application "knows" that there is no
[8]791        further reason for the client to retain the credentials.</t>
792  </list>
795   This is currently under separate study. There are a number of work-arounds
796   to parts of this problem, and we encourage the use of
797   password protection in screen savers, idle time-outs, and other
798   methods which mitigate the security problems inherent in this
799   problem. In particular, user agents which cache credentials are
800   encouraged to provide a readily accessible mechanism for discarding
801   cached credentials under user control.
[1364]806<section title="Acknowledgments" anchor="acks">
[998]808  This specification takes over the definition of the HTTP Authentication
[1363]809  Framework, previously defined in <xref target="RFC2617" x:fmt="none">RFC 2617</xref>.
810  We thank John Franks, Phillip M. Hallam-Baker, Jeffery L. Hostetler, Scott D. Lawrence,
[998]811  Paul J. Leach, Ari Luotonen, and Lawrence C. Stewart for their work
[1389]812  on that specification. See <xref target="RFC2617" x:fmt="of" x:sec="6"/>
[1363]813  for further acknowledgements. 
816  See &acks; for the Acknowledgments related to this document revision.
[119]823<references title="Normative References">
[205]825<reference anchor="Part1">
826  <front>
827    <title abbrev="HTTP/1.1">HTTP/1.1, part 1: URIs, Connections, and Message Parsing</title>
828    <author initials="R." surname="Fielding" fullname="Roy T. Fielding" role="editor">
[1106]829      <organization abbrev="Adobe">Adobe Systems Incorporated</organization>
[205]830      <address><email></email></address>
831    </author>
832    <author initials="Y." surname="Lafon" fullname="Yves Lafon" role="editor">
833      <organization abbrev="W3C">World Wide Web Consortium</organization>
834      <address><email></email></address>
835    </author>
836    <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke" role="editor">
837      <organization abbrev="greenbytes">greenbytes GmbH</organization>
838      <address><email></email></address>
839    </author>
840    <date month="&ID-MONTH;" year="&ID-YEAR;"/>
841  </front>
842  <seriesInfo name="Internet-Draft" value="draft-ietf-httpbis-p1-messaging-&ID-VERSION;"/>
843  <x:source href="p1-messaging.xml" basename="p1-messaging"/>
[31]846<reference anchor="Part6">
[119]847  <front>
848    <title abbrev="HTTP/1.1">HTTP/1.1, part 6: Caching</title>
849    <author initials="R." surname="Fielding" fullname="Roy T. Fielding" role="editor">
[1106]850      <organization abbrev="Adobe">Adobe Systems Incorporated</organization>
[119]851      <address><email></email></address>
852    </author>
853    <author initials="Y." surname="Lafon" fullname="Yves Lafon" role="editor">
854      <organization abbrev="W3C">World Wide Web Consortium</organization>
855      <address><email></email></address>
856    </author>
[601]857    <author initials="M." surname="Nottingham" fullname="Mark Nottingham" role="editor">
[1440]858      <organization>Rackspace</organization>
[601]859      <address><email></email></address>
860    </author>
[119]861    <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke" role="editor">
862      <organization abbrev="greenbytes">greenbytes GmbH</organization>
863      <address><email></email></address>
864    </author>
865    <date month="&ID-MONTH;" year="&ID-YEAR;"/>
866  </front>
867  <seriesInfo name="Internet-Draft" value="draft-ietf-httpbis-p6-cache-&ID-VERSION;"/>
868  <x:source href="p6-cache.xml" basename="p6-cache"/>
[96]871<reference anchor="RFC2119">
872  <front>
873    <title>Key words for use in RFCs to Indicate Requirement Levels</title>
874    <author initials="S." surname="Bradner" fullname="Scott Bradner">
875      <organization>Harvard University</organization>
876      <address><email></email></address>
877    </author>
878    <date month="March" year="1997"/>
879  </front>
880  <seriesInfo name="BCP" value="14"/>
881  <seriesInfo name="RFC" value="2119"/>
[425]884<reference anchor="RFC5234">
885  <front>
886    <title abbrev="ABNF for Syntax Specifications">Augmented BNF for Syntax Specifications: ABNF</title>
887    <author initials="D." surname="Crocker" fullname="Dave Crocker" role="editor">
888      <organization>Brandenburg InternetWorking</organization>
889      <address>
[728]890        <email></email>
891      </address> 
[425]892    </author>
893    <author initials="P." surname="Overell" fullname="Paul Overell">
894      <organization>THUS plc.</organization>
895      <address>
[728]896        <email></email>
897      </address>
[425]898    </author>
899    <date month="January" year="2008"/>
900  </front>
901  <seriesInfo name="STD" value="68"/>
902  <seriesInfo name="RFC" value="5234"/>
907<references title="Informative References">
909<reference anchor="RFC2616">
910  <front>
911    <title>Hypertext Transfer Protocol -- HTTP/1.1</title>
912    <author initials="R." surname="Fielding" fullname="R. Fielding">
913      <organization>University of California, Irvine</organization>
914      <address><email></email></address>
915    </author>
916    <author initials="J." surname="Gettys" fullname="J. Gettys">
917      <organization>W3C</organization>
918      <address><email></email></address>
919    </author>
920    <author initials="J." surname="Mogul" fullname="J. Mogul">
921      <organization>Compaq Computer Corporation</organization>
922      <address><email></email></address>
923    </author>
924    <author initials="H." surname="Frystyk" fullname="H. Frystyk">
925      <organization>MIT Laboratory for Computer Science</organization>
926      <address><email></email></address>
927    </author>
928    <author initials="L." surname="Masinter" fullname="L. Masinter">
929      <organization>Xerox Corporation</organization>
930      <address><email></email></address>
931    </author>
932    <author initials="P." surname="Leach" fullname="P. Leach">
933      <organization>Microsoft Corporation</organization>
934      <address><email></email></address>
935    </author>
936    <author initials="T." surname="Berners-Lee" fullname="T. Berners-Lee">
937      <organization>W3C</organization>
938      <address><email></email></address>
939    </author>
940    <date month="June" year="1999"/>
941  </front>
942  <seriesInfo name="RFC" value="2616"/>
[998]945<reference anchor="RFC2617">
946  <front>
947    <title abbrev="HTTP Authentication">HTTP Authentication: Basic and Digest Access Authentication</title>
948    <author initials="J." surname="Franks" fullname="John Franks">
949      <organization>Northwestern University, Department of Mathematics</organization>
950      <address><email></email></address>
951    </author>
952    <author initials="P.M." surname="Hallam-Baker" fullname="Phillip M. Hallam-Baker">
953      <organization>Verisign Inc.</organization>
954      <address><email></email></address>
955    </author>
956    <author initials="J.L." surname="Hostetler" fullname="Jeffery L. Hostetler">
957      <organization>AbiSource, Inc.</organization>
958      <address><email></email></address>
959    </author>
960    <author initials="S.D." surname="Lawrence" fullname="Scott D. Lawrence">
961      <organization>Agranat Systems, Inc.</organization>
962      <address><email></email></address>
963    </author>
964    <author initials="P.J." surname="Leach" fullname="Paul J. Leach">
965      <organization>Microsoft Corporation</organization>
966      <address><email></email></address>
967    </author>
968    <author initials="A." surname="Luotonen" fullname="Ari Luotonen">
969      <organization>Netscape Communications Corporation</organization>
970    </author>
971    <author initials="L." surname="Stewart" fullname="Lawrence C. Stewart">
972      <organization>Open Market, Inc.</organization>
973      <address><email></email></address>
974    </author>
975    <date month="June" year="1999"/>
976  </front>
977  <seriesInfo name="RFC" value="2617"/>
[253]980<reference anchor='RFC3864'>
981  <front>
982    <title>Registration Procedures for Message Header Fields</title>
983    <author initials='G.' surname='Klyne' fullname='G. Klyne'>
984      <organization>Nine by Nine</organization>
985      <address><email></email></address>
986    </author>
987    <author initials='M.' surname='Nottingham' fullname='M. Nottingham'>
988      <organization>BEA Systems</organization>
989      <address><email></email></address>
990    </author>
991    <author initials='J.' surname='Mogul' fullname='J. Mogul'>
992      <organization>HP Labs</organization>
993      <address><email></email></address>
994    </author>
995    <date year='2004' month='September' />
996  </front>
997  <seriesInfo name='BCP' value='90' />
998  <seriesInfo name='RFC' value='3864' />
[1394]1001<reference anchor="RFC3986">
1002 <front>
1003  <title abbrev='URI Generic Syntax'>Uniform Resource Identifier (URI): Generic Syntax</title>
1004  <author initials='T.' surname='Berners-Lee' fullname='Tim Berners-Lee'>
1005    <organization abbrev="W3C/MIT">World Wide Web Consortium</organization>
1006    <address>
1007       <email></email>
1008       <uri></uri>
1009    </address>
1010  </author>
1011  <author initials='R.' surname='Fielding' fullname='Roy T. Fielding'>
1012    <organization abbrev="Day Software">Day Software</organization>
1013    <address>
1014      <email></email>
1015      <uri></uri>
1016    </address>
1017  </author>
1018  <author initials='L.' surname='Masinter' fullname='Larry Masinter'>
1019    <organization abbrev="Adobe Systems">Adobe Systems Incorporated</organization>
1020    <address>
1021      <email></email>
1022      <uri></uri>
1023    </address>
1024  </author>
1025  <date month='January' year='2005'></date>
1026 </front>
1027 <seriesInfo name="STD" value="66"/>
1028 <seriesInfo name="RFC" value="3986"/>
1031<reference anchor="RFC4648">
1032  <front>
1033    <title>The Base16, Base32, and Base64 Data Encodings</title>
1034    <author fullname="S. Josefsson" initials="S." surname="Josefsson"/>
1035    <date year="2006" month="October"/>
1036  </front>
1037  <seriesInfo value="4648" name="RFC"/>
[1026]1040<reference anchor='RFC5226'>
1041  <front>
1042    <title>Guidelines for Writing an IANA Considerations Section in RFCs</title>
1043    <author initials='T.' surname='Narten' fullname='T. Narten'>
1044      <organization>IBM</organization>
1045      <address><email></email></address>
1046    </author>
1047    <author initials='H.' surname='Alvestrand' fullname='H. Alvestrand'>
1048      <organization>Google</organization>
1049      <address><email></email></address>
1050    </author>
1051    <date year='2008' month='May' />
1052  </front>
1053  <seriesInfo name='BCP' value='26' />
1054  <seriesInfo name='RFC' value='5226' />
[1385]1059<section title="Changes from RFCs 2616 and 2617" anchor="changes.from.rfc.2616">
[1385]1061  The "realm" parameter isn't required anymore in general; consequently, the
1062  ABNF allows challenges without any auth parameters.
1063  (<xref target="access.authentication.framework"/>)
[1394]1066  The "b64token" alternative to auth-param lists has been added for consistency
1067  with legacy authentication schemes such as "Basic".
1068  (<xref target="access.authentication.framework"/>)
[1230]1071  Change ABNF productions for header fields to only define the field value.
[1415]1072  (<xref target="header.field.definitions"/>)
[680]1076<?BEGININC p7-auth.abnf-appendix ?>
[427]1077<section xmlns:x="" title="Collected ABNF" anchor="collected.abnf">
1079<artwork type="abnf" name="p7-auth.parsed-abnf">
[1230]1080<x:ref>Authorization</x:ref> = credentials
[1523]1082<x:ref>BWS</x:ref> = &lt;BWS, defined in [Part1], Section 3.2.1&gt;
[1523]1084<x:ref>OWS</x:ref> = &lt;OWS, defined in [Part1], Section 3.2.1&gt;
[1230]1086<x:ref>Proxy-Authenticate</x:ref> = *( "," OWS ) challenge *( OWS "," [ OWS
[425]1087 challenge ] )
[1230]1088<x:ref>Proxy-Authorization</x:ref> = credentials
[1230]1090<x:ref>WWW-Authenticate</x:ref> = *( "," OWS ) challenge *( OWS "," [ OWS challenge
1091 ] )
[1386]1093<x:ref>auth-param</x:ref> = token BWS "=" BWS ( token / quoted-string )
[998]1094<x:ref>auth-scheme</x:ref> = token
[1394]1096<x:ref>b64token</x:ref> = 1*( ALPHA / DIGIT / "-" / "." / "_" / "~" / "+" / "/" )
1097 *"="
[1394]1099<x:ref>challenge</x:ref> = auth-scheme [ 1*SP ( b64token / [ ( "," / auth-param ) *(
1100 OWS "," [ OWS auth-param ] ) ] ) ]
1101<x:ref>credentials</x:ref> = auth-scheme [ 1*SP ( b64token / [ ( "," / auth-param )
1102 *( OWS "," [ OWS auth-param ] ) ] ) ]
[1523]1104<x:ref>quoted-string</x:ref> = &lt;quoted-string, defined in [Part1], Section 3.2.4&gt;
[1523]1106<x:ref>token</x:ref> = &lt;token, defined in [Part1], Section 3.2.4&gt;
[532]1109<figure><preamble>ABNF diagnostics:</preamble><artwork type="inline">
1110; Authorization defined but not used
[425]1111; Proxy-Authenticate defined but not used
1112; Proxy-Authorization defined but not used
1113; WWW-Authenticate defined but not used
[680]1115<?ENDINC p7-auth.abnf-appendix ?>
[252]1117<section title="Change Log (to be removed by RFC Editor before publication)"  anchor="change.log">
[1624]1119  Changes up to the first Working Group Last Call draft are summarized
1120  in <eref target=""/>.
[1592]1123<section title="Since draft-ietf-httpbis-p7-auth-19" anchor="changes.since.19">
1125  None yet.
Note: See TracBrowser for help on using the repository browser.