draft-ietf-httpbis-auth-info-05.txt   draft-ietf-httpbis-auth-info-latest.txt 
HTTP Working Group J. Reschke HTTP Working Group J. Reschke
Internet-Draft greenbytes Internet-Draft greenbytes
Updates: 2617 (if approved) April 7, 2015 Obsoletes: 2617 (if approved) July 6, 2024
Intended status: Standards Track Intended status: Standards Track
Expires: October 9, 2015 Expires: January 7, 2025
The Hypertext Transfer Protocol (HTTP) Authentication-Info and Proxy- HTTP Authentication-Info and Proxy-Authentication-Info Response Header
Authentication-Info Response Header Fields Fields
draft-ietf-httpbis-auth-info-05 draft-ietf-httpbis-auth-info-latest
Abstract Abstract
This specification defines the "Authentication-Info" and "Proxy- This specification defines the "Authentication-Info" and "Proxy-
Authentication-Info" response header fields for use in HTTP Authentication-Info" response header fields for use in Hypertext
authentication schemes which need to return information once the Transfer Protocol (HTTP) authentication schemes that need to return
client's authentication credentials have been accepted. information once the client's authentication credentials have been
accepted.
Editorial Note (To be removed by RFC Editor) Editorial Note (To be removed by RFC Editor)
Discussion of this draft takes place on the HTTPBIS working group Discussion of this draft takes place on the HTTPBIS working group
mailing list (ietf-http-wg@w3.org), which is archived at mailing list (ietf-http-wg@w3.org), which is archived at
<https://lists.w3.org/Archives/Public/ietf-http-wg/>. <https://lists.w3.org/Archives/Public/ietf-http-wg/>.
Working Group information can be found at Working Group information can be found at <https://tools.ietf.org/wg/
<https://tools.ietf.org/wg/httpbis/> and <http://httpwg.github.io/>; httpbis/> and <http://httpwg.github.io/>; source code and issues list
source code and issues list for this draft can be found at for this draft can be found at <https://github.com/httpwg/http-
<https://github.com/httpwg/http-extensions>. extensions>.
The changes in this draft are summarized in Appendix A.6.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on October 9, 2015. This Internet-Draft will expire on January 7, 2025.
Copyright Notice Copyright Notice
Copyright (c) 2015 IETF Trust and the persons identified as the Copyright (c) 2024 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
This document may contain material from IETF Documents or IETF This document may contain material from IETF Documents or IETF
Contributions published or made publicly available before November Contributions published or made publicly available before November
10, 2008. The person(s) controlling the copyright in some of this 10, 2008. The person(s) controlling the copyright in some of this
skipping to change at page 2, line 34 skipping to change at page 2, line 34
modifications of such material outside the IETF Standards Process. modifications of such material outside the IETF Standards Process.
Without obtaining an adequate license from the person(s) controlling Without obtaining an adequate license from the person(s) controlling
the copyright in such materials, this document may not be modified the copyright in such materials, this document may not be modified
outside the IETF Standards Process, and derivative works of it may outside the IETF Standards Process, and derivative works of it may
not be created outside the IETF Standards Process, except to format not be created outside the IETF Standards Process, except to format
it for publication as an RFC or to translate it into languages other it for publication as an RFC or to translate it into languages other
than English. than English.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Notational Conventions . . . . . . . . . . . . . . . . . . . . 3 2. Notational Conventions . . . . . . . . . . . . . . . . . . . 3
3. The Authentication-Info Response Header Field . . . . . . . . . 3 3. The Authentication-Info Response Header Field . . . . . . . . 3
3.1. Parameter Value Format . . . . . . . . . . . . . . . . . . 4 3.1. Parameter Value Format . . . . . . . . . . . . . . . . . 4
4. The Proxy-Authentication-Info Response Header Field . . . . . . 4 4. The Proxy-Authentication-Info Response Header Field . . . . . 4
5. Security Considerations . . . . . . . . . . . . . . . . . . . . 4 5. Security Considerations . . . . . . . . . . . . . . . . . . . 4
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 5 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5
7. References . . . . . . . . . . . . . . . . . . . . . . . . . . 5 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 5
7.1. Normative References . . . . . . . . . . . . . . . . . . . 5 7.1. Normative References . . . . . . . . . . . . . . . . . . 5
7.2. Informative References . . . . . . . . . . . . . . . . . . 5 7.2. Informative References . . . . . . . . . . . . . . . . . 5
Appendix A. Change Log (to be removed by RFC Editor before Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 7
publication) . . . . . . . . . . . . . . . . . . . . . 6 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 7
A.1. draft-reschke-httpauth-auth-info-00 . . . . . . . . . . . . 6
A.2. Since draft-ietf-httpbis-auth-info-00 . . . . . . . . . . . 6
A.3. Since draft-ietf-httpbis-auth-info-01 . . . . . . . . . . . 6
A.4. Since draft-ietf-httpbis-auth-info-02 . . . . . . . . . . . 6
A.5. Since draft-ietf-httpbis-auth-info-03 . . . . . . . . . . . 7
A.6. Since draft-ietf-httpbis-auth-info-04 . . . . . . . . . . . 7
Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . . 7
1. Introduction 1. Introduction
This specification defines the "Authentication-Info" and "Proxy- This specification defines the "Authentication-Info" and "Proxy-
Authentication-Info" response header fields for use in HTTP Authentication-Info" response header fields for use in HTTP
authentication schemes ([RFC7235]) which need to return information authentication schemes ([RFC7235]) that need to return information
once the client's authentication credentials have been accepted. once the client's authentication credentials have been accepted.
Both were previously defined in Section 3 of [RFC2617], defining the Both were previously defined in Section 3 of [RFC2617], defining the
HTTP "Digest" authentication scheme. This document generalizes the HTTP "Digest" authentication scheme. This document generalizes the
description for use not only in "Digest" ([DIGEST]), but also in description for use not only in "Digest" ([RFC7616]), but also in
other future schemes that might have the same requirements for other future schemes that might have the same requirements for
carrying additional information during authentication. carrying additional information during authentication.
2. Notational Conventions 2. Notational Conventions
This specification uses the Augmented Backus-Naur Form (ABNF) This specification uses the Augmented Backus-Naur Form (ABNF)
notation of [RFC5234] with a list extension, defined in Section 7 of notation of [RFC5234] with a list extension, defined in Section 7 of
[RFC7230], that allows for compact definition of comma-separated [RFC7230], that allows for compact definition of comma-separated
lists using a '#' operator (similar to how the '*' operator indicates lists using a '#' operator (similar to how the '*' operator indicates
repetition). The ABNF production for "auth-param" is defined in repetition). The ABNF production for "auth-param" is defined in
skipping to change at page 3, line 38 skipping to change at page 3, line 31
HTTP authentication schemes can use the Authentication-Info response HTTP authentication schemes can use the Authentication-Info response
header field to communicate information after the client's header field to communicate information after the client's
authentication credentials have been accepted. This information can authentication credentials have been accepted. This information can
include a finalization message from the server (e.g., it can contain include a finalization message from the server (e.g., it can contain
the server authentication). the server authentication).
The field value is a list of parameters (name/value pairs), using the The field value is a list of parameters (name/value pairs), using the
"auth-param" syntax defined in Section 2.1 of [RFC7235]. This "auth-param" syntax defined in Section 2.1 of [RFC7235]. This
specification only describes the generic format; authentication specification only describes the generic format; authentication
schemes using "Authentication-Info" will define the individual schemes using Authentication-Info will define the individual
parameters. The "Digest" Authentication Scheme, for instance, parameters. The "Digest" Authentication Scheme, for instance,
defines multiple parameters in Section 3.5 of [DIGEST]. defines multiple parameters in Section 3.5 of [RFC7616].
Authentication-Info = #auth-param Authentication-Info = #auth-param
The Authentication-Info header field can be used in any HTTP The Authentication-Info header field can be used in any HTTP
response, independently of request method and status code. Its response, independently of request method and status code. Its
semantics are defined by the authentication scheme indicated by the semantics are defined by the authentication scheme indicated by the
Authorization header field ([RFC7235], Section 4.2) of the Authorization header field ([RFC7235], Section 4.2) of the
corresponding request. corresponding request.
A proxy forwarding a response is not allowed to modify the field A proxy forwarding a response is not allowed to modify the field
value in any way. value in any way.
Authentication-Info can be used inside trailers ([RFC7230], Section Authentication-Info can be used inside trailers ([RFC7230],
4.1.2) when the authentication scheme explicitly allows this. Section 4.1.2) when the authentication scheme explicitly allows this.
3.1. Parameter Value Format 3.1. Parameter Value Format
Parameter values can be expressed either as "token" or as "quoted- Parameter values can be expressed either as "token" or as "quoted-
string" (Section 3.2.6 of [RFC7230]). string" (Section 3.2.6 of [RFC7230]).
Authentication scheme definitions need to allow both notations, both Authentication scheme definitions need to allow both notations, both
for senders and recipients. This allows recipients to use generic for senders and recipients. This allows recipients to use generic
parsing components, independent of the authentication scheme in use. parsing components, independent of the authentication scheme in use.
For backwards compatibility, authentication scheme definitions can For backwards compatibility, authentication scheme definitions can
restrict the format for senders to one of the two variants. This can restrict the format for senders to one of the two variants. This can
be important when it is known that deployed implementations will fail be important when it is known that deployed implementations will fail
when encountering one of the two formats. when encountering one of the two formats.
4. The Proxy-Authentication-Info Response Header Field 4. The Proxy-Authentication-Info Response Header Field
The Proxy-Authentication-Info response header field is equivalent to The Proxy-Authentication-Info response header field is equivalent to
Authentication-Info, except that its semantics are defined by the Authentication-Info, except that it applies to proxy authentication
([RFC7235], Section 2) and its semantics are defined by the
authentication scheme indicated by the Proxy-Authorization header authentication scheme indicated by the Proxy-Authorization header
field ([RFC7235], Section 4.4) of the corresponding request, and field ([RFC7235], Section 4.4) of the corresponding request:
applies to proxy authentication ([RFC7235], Section 2):
Proxy-Authentication-Info = #auth-param Proxy-Authentication-Info = #auth-param
However, unlike Authentication-Info, the Proxy-Authentication-Info However, unlike Authentication-Info, the Proxy-Authentication-Info
header field applies only to the next outbound client on the response header field applies only to the next outbound client on the response
chain. This is because only the client that chose a given proxy is chain. This is because only the client that chose a given proxy is
likely to have the credentials necessary for authentication. likely to have the credentials necessary for authentication.
However, when multiple proxies are used within the same However, when multiple proxies are used within the same
administrative domain, such as office and regional caching proxies administrative domain, such as office and regional caching proxies
within a large corporate network, it is common for credentials to be within a large corporate network, it is common for credentials to be
skipping to change at page 5, line 8 skipping to change at page 5, line 8
Adding information to HTTP responses that are sent over an Adding information to HTTP responses that are sent over an
unencrypted channel can affect security and privacy. The presence of unencrypted channel can affect security and privacy. The presence of
the header fields alone indicates that HTTP authentication is in use. the header fields alone indicates that HTTP authentication is in use.
Additional information could be exposed by the contents of the Additional information could be exposed by the contents of the
authentication-scheme specific parameters; this will have to be authentication-scheme specific parameters; this will have to be
considered in the definitions of these schemes. considered in the definitions of these schemes.
6. IANA Considerations 6. IANA Considerations
HTTP header fields are registered within the "Message Headers" HTTP header fields are registered within the "Message Headers"
registry located at registry located at <http://www.iana.org/assignments/message-
<http://www.iana.org/assignments/message-headers>, as defined by headers>, as defined by [BCP90].
[BCP90].
This document updates the definitions of the "Authentication-Info" This document updates the definitions of the "Authentication-Info"
and "Proxy-Authentication-Info" header fields, so the "Permanent and "Proxy-Authentication-Info" header fields, so the "Permanent
Message Header Field Names" registry shall be updated accordingly: Message Header Field Names" registry has been updated accordingly:
+---------------------------+----------+----------+-----------------+ +---------------------------+----------+----------+-----------------+
| Header Field Name | Protocol | Status | Reference | | Header Field Name | Protocol | Status | Reference |
+---------------------------+----------+----------+-----------------+ +---------------------------+----------+----------+-----------------+
| Authentication-Info | http | standard | Section 3 of | | Authentication-Info | http | standard | Section 3 of |
| | | | this document | | | | | this document |
| Proxy-Authentication-Info | http | standard | Section 4 of | | Proxy-Authentication-Info | http | standard | Section 4 of |
| | | | this document | | | | | this document |
+---------------------------+----------+----------+-----------------+ +---------------------------+----------+----------+-----------------+
7. References 7. References
7.1. Normative References 7.1. Normative References
[RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax [RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", STD 68, RFC 5234, January 2008, Specifications: ABNF", STD 68, RFC 5234,
<http://www.rfc-editor.org/info/rfc5234>. DOI 10.17487/RFC5234, January 2008,
<https://www.rfc-editor.org/info/rfc5234>.
[RFC7230] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer [RFC7230] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
Protocol (HTTP/1.1): Message Syntax and Routing", Protocol (HTTP/1.1): Message Syntax and Routing",
RFC 7230, June 2014, RFC 7230, DOI 10.17487/RFC7230, June 2014,
<http://www.rfc-editor.org/info/rfc7230>. <https://www.rfc-editor.org/info/rfc7230>.
[RFC7235] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer [RFC7235] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
Protocol (HTTP/1.1): Authentication", RFC 7235, June 2014, Protocol (HTTP/1.1): Authentication", RFC 7235,
<http://www.rfc-editor.org/info/rfc7235>. DOI 10.17487/RFC7235, June 2014,
<https://www.rfc-editor.org/info/rfc7235>.
7.2. Informative References 7.2. Informative References
[BCP90] Klyne, G., Nottingham, M., and J. Mogul, "Registration [BCP90] Klyne, G., Nottingham, M., and J. Mogul, "Registration
Procedures for Message Header Fields", BCP 90, RFC 3864, Procedures for Message Header Fields", BCP 90, RFC 3864,
September 2004, <http://www.rfc-editor.org/info/bcp90>. September 2004, <https://www.rfc-editor.org/info/bcp90>.
[DIGEST] Shekh-Yusef, R., Ed., Ahrens, D., and S. Bremer, "HTTP
Digest Access Authentication",
draft-ietf-httpauth-digest-15 (work in progress),
March 2015.
[RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S., [RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S.,
Leach, P., Luotonen, A., and L. Stewart, "HTTP Leach, P., Luotonen, A., and L. Stewart, "HTTP
Authentication: Basic and Digest Access Authentication", Authentication: Basic and Digest Access Authentication",
RFC 2617, June 1999, RFC 2617, DOI 10.17487/RFC2617, June 1999,
<http://www.rfc-editor.org/info/rfc2617>. <https://www.rfc-editor.org/info/rfc2617>.
Appendix A. Change Log (to be removed by RFC Editor before publication)
A.1. draft-reschke-httpauth-auth-info-00
Changed boilerplate to make this an HTTPbis WG draft. Added
Acknowledgements.
In the Security Considerations, remind people that those apply to
unencryped channels.
Make it clearer that these are really just response header fields.
A.2. Since draft-ietf-httpbis-auth-info-00
Rephrase introduction of header field to be closer to what RFC 2617
said ("successful authentication").
Update DIGEST reference.
A.3. Since draft-ietf-httpbis-auth-info-01
State that scheme definitions need to define whether the header field
can be used in trailers.
Add "updates: 2617" to boilerplate.
A.4. Since draft-ietf-httpbis-auth-info-02
Updated DIGEST reference.
Clarify purpose of header consistently
(<https://github.com/httpwg/http-extensions/issues/49>).
The do-not-modify rule does not include proxies that consume
Authentication-Info
(<https://github.com/httpwg/http-extensions/issues/50>).
Borrow more proxy auth related considerations from RFC 7235 for the
description of Proxy-Authentication-Info
(<https://github.com/httpwg/http-extensions/issues/51>).
A.5. Since draft-ietf-httpbis-auth-info-03
Updated DIGEST reference.
Clarify how the applicable auth scheme is determined (it is present
in the request's (Proxy-)Authorization header field).
Adjust the IPR boilerplate because we are using some text from RFC
2617.
A.6. Since draft-ietf-httpbis-auth-info-04
Add another clarification about how the applicable scheme for Proxy- [RFC7616] Shekh-Yusef, R., Ed., Ahrens, D., and S. Bremer, "HTTP
Authentication-Info is determined. Digest Access Authentication", RFC 7616,
DOI 10.17487/RFC7616, September 2015,
<https://www.rfc-editor.org/info/rfc7616>.
Appendix B. Acknowledgements Acknowledgements
This document is based on the header field definitions in RFCs 2069 This document is based on the header field definitions in RFCs 2069
and 2617, whose authors are: John Franks, Phillip M. Hallam-Baker, and 2617, whose authors are: John Franks, Phillip M. Hallam-Baker,
Jeffery L. Hostetler, Scott D. Lawrence, Paul J. Leach, Ari Luotonen, Jeffery L. Hostetler, Scott D. Lawrence, Paul J. Leach, Ari
Eric W. Sink, and Lawrence C. Stewart. Luotonen, Eric W. Sink, and Lawrence C. Stewart.
Additional thanks go to the members of the HTTPAuth and HTTPbis Additional thanks go to the members of the HTTPAUTH and HTTPBIS
Working Groups, namely Amos Jeffries, Benjamin Kaduk, Alexey Working Groups, namely, Amos Jeffries, Benjamin Kaduk, Alexey
Melnikov, Mark Nottingham, Yutaka Oiwa, Rifaat Shekh-Yusef, and Melnikov, Mark Nottingham, Yutaka Oiwa, Rifaat Shekh-Yusef, and
Martin Thomson. Martin Thomson.
Author's Address Author's Address
Julian F. Reschke Julian F. Reschke
greenbytes GmbH greenbytes GmbH
Hafenweg 16 Hafenweg 16
Muenster, NW 48155 Muenster, NW 48155
Germany Germany
 End of changes. 28 change blocks. 
125 lines changed or deleted 62 lines changed or added

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