[Docs] [txt|pdf] [Tracker] [WG] [Email] [Diff1] [Diff2] [Nits]
Versions: 00 01 02 03 04 05 06 07 08 09 10 11
12
ACE Working Group L. Seitz
Internet-Draft Combitech
Intended status: Standards Track January 11, 2020
Expires: July 14, 2020
Additional OAuth Parameters for Authorization in Constrained
Environments (ACE)
draft-ietf-ace-oauth-params-11
Abstract
This specification defines new parameters for the OAuth 2.0 token and
introspection endpoints when used with the framework for
authentication and authorization for constrained environments (ACE).
These are used to express the proof-of-possession key the client
wishes to use, the proof-of-possession key that the Authorization
Server has selected, and the key the Resource Server should use to
authenticate to the client.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on July 14, 2020.
Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
Seitz Expires July 14, 2020 [Page 1]
Internet-Draft ACE-OAuth-Params January 2020
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Parameters for the Token Endpoint . . . . . . . . . . . . . . 3
3.1. Client-to-AS Request . . . . . . . . . . . . . . . . . . 3
3.2. AS-to-Client Response . . . . . . . . . . . . . . . . . . 4
3.3. The Resource Server Confirmation Claim . . . . . . . . . 6
4. Parameters for the Introspection Endpoint . . . . . . . . . . 6
4.1. AS-to-RS Response . . . . . . . . . . . . . . . . . . . . 6
5. Confirmation Method Parameters . . . . . . . . . . . . . . . 8
6. CBOR Mappings . . . . . . . . . . . . . . . . . . . . . . . . 9
7. Security Considerations . . . . . . . . . . . . . . . . . . . 9
8. Privacy Considerations . . . . . . . . . . . . . . . . . . . 9
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9
9.1. JSON Web Token Claims . . . . . . . . . . . . . . . . . . 9
9.2. CBOR Web Token Claims . . . . . . . . . . . . . . . . . . 9
9.3. OAuth Parameter Registration . . . . . . . . . . . . . . 10
9.4. OAuth Introspection Response Parameter Registration . . . 10
9.5. OAuth Parameters CBOR Mappings Registration . . . . . . . 10
9.6. OAuth Token Introspection Response CBOR Mappings
Registration . . . . . . . . . . . . . . . . . . . . . . 11
10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 11
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 11
11.1. Normative References . . . . . . . . . . . . . . . . . . 11
11.2. Informative References . . . . . . . . . . . . . . . . . 13
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 13
1. Introduction
The Authentication and Authorization for Constrained Environments
(ACE) specification [I-D.ietf-ace-oauth-authz] requires some new
parameters for interactions with the OAuth 2.0 [RFC6749] token and
introspection endpoints, as well as some new claims to be used in
access tokens. These parameters and claims can also be used in other
contexts and have therefore been put into a dedicated document, to
facilitate their use in a manner independent of
[I-D.ietf-ace-oauth-authz].
Note that although all examples are shown in CBOR [RFC7049], JSON
[RFC8259] MAY be used as an alternative for HTTP-based
communications, as specified in [I-D.ietf-ace-oauth-authz].
Seitz Expires July 14, 2020 [Page 2]
Internet-Draft ACE-OAuth-Params January 2020
2. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
Readers are assumed to be familiar with the terminology from
[I-D.ietf-ace-oauth-authz], especially the terminology for entities
in the architecture such as client (C), resource server (RS) and
authorization server (AS).
Terminology from [RFC8152] is used in the examples, especially
COSE_Key defined in section 7 of [RFC8152].
Note that the term "endpoint" is used here following its OAuth 2.0
[RFC6749] definition, which is to denote resources such as token and
introspection at the AS and authz-info at the RS. The CoAP [RFC7252]
definition, which is "An entity participating in the CoAP protocol"
is not used in this specification.
3. Parameters for the Token Endpoint
This section defines additional parameters for the interactions with
the token endpoint in the ACE framework [I-D.ietf-ace-oauth-authz].
3.1. Client-to-AS Request
This section defines the "req_cnf" parameter allowing clients to
request a specific proof-of-possession key in an access token from a
token endpoint in the ACE framework [I-D.ietf-ace-oauth-authz]:
req_cnf
OPTIONAL. This field contains information about the key the
client would like to bind to the access token for proof-of-
possession. It is RECOMMENDED that an AS reject a request
containing a symmetric key value in the 'req_cnf' field
(kty=Symmetric), since the AS is expected to be able to generate
better symmetric keys than a constrained client. The AS MUST
verify that the client really is in possession of the
corresponding key. Values of this parameter follow the syntax and
semantics of the "cnf" claim either from section 3.1 of
[I-D.ietf-ace-cwt-proof-of-possession] for CBOR-based interactions
or from section 3.1 of [RFC7800] for JSON-based interactions.
Figure 1 shows a request for an access token using the "req_cnf"
parameter to request a specific public key as proof-of-possession
Seitz Expires July 14, 2020 [Page 3]
Internet-Draft ACE-OAuth-Params January 2020
key. The content is displayed in CBOR diagnostic notation, without
abbreviations and with line-breaks for better readability.
Header: POST (Code=0.02)
Uri-Host: "as.example.com"
Uri-Path: "token"
Content-Format: "application/ace+cbor"
Payload:
{
"req_cnf" : {
"COSE_Key" : {
"kty" : "EC2",
"kid" : h'11',
"crv" : "P-256",
"x" : h'BAC5B11CAD8F99F9C72B05CF4B9E26D24
4DC189F745228255A219A86D6A09EFF',
"y" : h'20138BF82DC1B6D562BE0FA54AB7804A3
A64B6D72CCFED6B6FB6ED28BBFC117E'
}
}
}
Figure 1: Example request for an access token bound to an asymmetric
key.
3.2. AS-to-Client Response
This section defines the following additional parameters for an AS
response to a request to the token endpoint:
cnf
REQUIRED if the token type is "pop" and a symmetric key is used.
MAY be present for asymmetric proof-of-possession keys. This
field contains the proof-of-possession key that the AS selected
for the token. Values of this parameter follow the syntax and
semantics of the "cnf" claim either from section 3.1 of
[I-D.ietf-ace-cwt-proof-of-possession] for CBOR-based interactions
of from section 3.1 of [RFC7800] for JSON-based interactions. See
Section 5 for additional discussion of the usage of this
parameter.
rs_cnf
OPTIONAL if the token type is "pop" and asymmetric keys are used.
MUST NOT be present otherwise. This field contains information
about the public key used by the RS to authenticate. If this
parameter is absent, either the RS does not use a public key or
the AS knows that the RS can authenticate itself to the client
Seitz Expires July 14, 2020 [Page 4]
Internet-Draft ACE-OAuth-Params January 2020
without additional information. Values of this parameter follow
the syntax and semantics of the "cnf" claim either from section
3.1 of [I-D.ietf-ace-cwt-proof-of-possession] for CBOR-based
interactions or from section 3.1 of [RFC7800] for JSON-based
interactions. See Section 5 for additional discussion of the
usage of this parameter.
Figure 2 shows an AS response containing a token and a "cnf"
parameter with a symmetric proof-of-possession key.
Header: Created (Code=2.01)
Content-Format: "application/ace+cbor"
Payload:
{
"access_token" : h'4A5015DF686428 ...
(remainder of CWT omitted for brevity;
CWT contains COSE_Key in the "cnf" claim)',
"cnf" : {
"COSE_Key" : {
"kty" : "Symmetric",
"kid" : h'DFD1AA97',
"k" : h'849B5786457C1491BE3A76DCEA6C427108'
}
}
}
Figure 2: Example AS response with an access token bound to a
symmetric key.
Figure 3 shows an AS response containing a token bound to a
previously requested asymmetric proof-of-possession key (not shown)
and a "rs_cnf" parameter containing the public key of the RS.
Seitz Expires July 14, 2020 [Page 5]
Internet-Draft ACE-OAuth-Params January 2020
Header: Created (Code=2.01)
Content-Format: "application/ace+cbor"
Payload:
{
"access_token" : h'D08343A1010AA1054D2A45DF6FBC5A5A ...
(remainder of CWT omitted for brevity;
CWT contains COSE_Key in the "cnf" claim)',
"rs_cnf" : {
"COSE_Key" : {
"kty" : "EC2",
"kid" : h'12',
"crv" : "P-256",
"x" : h'BCEE7EAAC162F91E6F330F5771211E220
B8B546C96589B0AC4AD0FD24C77E1F1',
"y" : h'C647B38C55EFBBC4E62E651720F002D5D
75B2E0C02CD1326E662BCA222B90416'
}
}
}
Figure 3: Example AS response, including the RS's public key.
3.3. The Resource Server Confirmation Claim
If the AS needs to convey a hint to the RS about which key it should
use to authenticate towards the client, this specification defines
the "rs_cnf" claim, which MAY be used in the access token, with the
same syntax and semantics as defined in for the "rs_cnf" parameter.
4. Parameters for the Introspection Endpoint
This section defines an additional parameter for the interactions
with the introspection endpoint in the ACE framework
[I-D.ietf-ace-oauth-authz].
4.1. AS-to-RS Response
This section defines the following additional parameter for an AS
response to a request to the introspection endpoint:
rs_cnf
OPTIONAL. If the RS uses asymmetric keys to authenticate towards
the client (e.g., with a DTLS Raw Public Key handshake [RFC7250]
and it has several such keys (e.g., for different elliptic
curves), the AS can give the RS a hint using this parameter, as to
which key it should use. Values of this parameter follow the
syntax and semantics of the "cnf" claim from either section 3.1 of
[I-D.ietf-ace-cwt-proof-of-possession] for CBOR-based interactions
Seitz Expires July 14, 2020 [Page 6]
Internet-Draft ACE-OAuth-Params January 2020
or section 3.1 of [RFC7800] for JSON-based interactions. See
Section 5 for additional discussion of the usage of this
parameter.
Furthermore the AS can use the "cnf" parameter specified in section
9.4 of [I-D.ietf-oauth-mtls] in an introspection response. For CBOR-
based interactions the AS MUST use the parameter mapping specified in
Figure 5 and the value must follow the syntax of "cnf" claim values
from section 3.1 of [I-D.ietf-ace-cwt-proof-of-possession].
Figure 4 shows an AS response to an introspection request including
the "cnf" parameter to indicate the proof-of-possession key bound to
the token and the "rs_cnf" parameter to indicate the key the RS is
supposed to use to authenticate to the client.
Header: Created Code=2.01)
Content-Format: "application/ace+cbor"
Payload:
{
"active" : true,
"scope" : "read",
"aud" : "tempSensor4711",
"cnf" : {
"COSE_Key" : {
"kty" : "EC2",
"kid" : h'11',
"crv" : "P-256",
"x" : h'BAC5B11CAD8F99F9C72B05CF4B9E26D24
4DC189F745228255A219A86D6A09EFF',
"y" : h'20138BF82DC1B6D562BE0FA54AB7804A3
A64B6D72CCFED6B6FB6ED28BBFC117E'
}
},
"rs_cnf" : {
"COSE_Key" : {
"kty" : "EC2",
"kid" : h'12',
"crv" : "P-256",
"x" : h'BCEE7EAAC162F91E6F330F5771211E220
B8B546C96589B0AC4AD0FD24C77E1F1',
"y" : h'C647B38C55EFBBC4E62E651720F002D5D
75B2E0C02CD1326E662BCA222B90416'
}
}
}
Figure 4: Example introspection response.
Seitz Expires July 14, 2020 [Page 7]
Internet-Draft ACE-OAuth-Params January 2020
5. Confirmation Method Parameters
The confirmation method parameters are used as follows:
o "req_cnf" in the access token request C -> AS, OPTIONAL to
indicate the client's raw public key, or the key-identifier of a
previously established key between C and RS that the client wishes
to use for proof-of-possession of the access token.
o "cnf" in the token response AS -> C, OPTIONAL if using an
asymmetric key or a key that the client requested via a key
identifier in the request. REQUIRED if the client didn't specify
a "req_cnf" and symmetric keys are used. Used to indicate the
symmetric key generated by the AS for proof-of-possession of the
access token.
o "cnf" in the introspection response AS -> RS, REQUIRED if the
access token that was subject to introspection is a proof-of-
possession token, absent otherwise. Indicates the proof-of-
possession key bound to the access token.
o "rs_cnf" in the token response AS -> C, OPTIONAL to indicate the
public key of the RS, if it uses one to authenticate itself to the
client and the binding between key and RS identity is not
established through other means.
o "rs_cnf" in the introspection response AS -> RS, OPTIONAL,
contains the public key that the RS should use for authenticating
itself to the client (e.g., if the RS has several different public
keys, and there may be ambiguity as to which key to use).
Note that the COSE_Key structure in a confirmation claim or parameter
may contain an "alg" or "key_ops" parameter. If such parameters are
present, a client MUST NOT use a key that is incompatible with the
profile or proof-of-possession algorithm according to those
parameters. An RS MUST reject a proof-of-possession using such a
key.
If an access token is issued for an audience that includes several
RS, the "rs_cnf" parameter MUST NOT be used, since the client cannot
determine for which RS the key applies. This document recommends to
specify a different endpoint that the client can use to acquire RS
authentication keys in such cases. The specification of such an
endpoint is out of scope for this document.
Seitz Expires July 14, 2020 [Page 8]
Internet-Draft ACE-OAuth-Params January 2020
6. CBOR Mappings
If CBOR is used, the new parameters and claims defined in this
document MUST be mapped to CBOR types as specified in Figure 5, using
the given integer abbreviation for the map key.
/----------+----------+-------------------------------------\
| Name | CBOR Key | Value Type | Usage |
|----------+----------+-------------------------------------|
| req_cnf | TBD (4) | map | token request |
| cnf | TBD (8) | map | token response |
| cnf | TBD (8) | map | introspection response |
| rs_cnf | TBD (41) | map | token response |
| rs_cnf | TBD (41) | map | introspection response |
| rs_cnf | TBD (41) | map | CWT claim |
\----------+----------+------------+------------------------/
Figure 5: CBOR mappings for new parameters and claims.
7. Security Considerations
This document is an extension to [I-D.ietf-ace-oauth-authz]. All
security considerations from that document apply here as well.
8. Privacy Considerations
This document is an extension to [I-D.ietf-ace-oauth-authz]. All
privacy considerations from that document apply here as well.
9. IANA Considerations
9.1. JSON Web Token Claims
This specification registers the following new claim in the JSON Web
Token (JWT) registry of JSON Web Token Claims
[IANA.JsonWebTokenClaims]:
o Claim Name: "rs_cnf"
o Claim Description: public key used by RS to authenticate itself to
the client.
o Change Controller: IESG
o Reference: Section 3.3 of [this document]
9.2. CBOR Web Token Claims
This specification registers the following new claim in the "CBOR Web
Token (CWT) Claims" registry [IANA.CborWebTokenClaims].
Seitz Expires July 14, 2020 [Page 9]
Internet-Draft ACE-OAuth-Params January 2020
o Claim Name: "rs_cnf"
o Claim Description: public key used by RS to authenticate itself to
the client.
o JWT Claim Name: rs_cnf
o Claim Key: TBD (suggested: 41)
o Claim Value Type(s): map
o Change Controller: IESG
o Specification Document(s): Section 3.3 of [this document]
9.3. OAuth Parameter Registration
This section registers the following parameters in the "OAuth
Parameters" registry [IANA.OAuthParameters]:
o Name: "req_cnf"
o Parameter Usage Location: token request
o Change Controller: IESG
o Reference: Section 5 of [this document]
o Name: "rs_cnf"
o Parameter Usage Location: token response
o Change Controller: IESG
o Reference: Section 5 of [this document]
o Name: "cnf"
o Parameter Usage Location: token response
o Change Controller: IESG
o Reference: Section 5 of [this document]
9.4. OAuth Introspection Response Parameter Registration
This section registers the following parameter in the OAuth Token
Introspection Response registry [IANA.TokenIntrospectionResponse].
o Name: "rs_cnf"
o Description: public key used by RS to authenticate itself to the
client.
o Change Controller: IESG
o Reference: Section 4.1 of [this document]
9.5. OAuth Parameters CBOR Mappings Registration
This section registers the following parameter mappings in the "OAuth
Parameters CBOR Mappings" registry established in section 8.9. of
[I-D.ietf-ace-oauth-authz].
o Name: "req_cnf"
o CBOR key: TBD (suggested: 4)
Seitz Expires July 14, 2020 [Page 10]
Internet-Draft ACE-OAuth-Params January 2020
o Change Controller: IESG
o Reference: Section 3.1 of [this document]
o Name: "cnf"
o CBOR key: TBD (suggested: 8)
o Change Controller: IESG
o Reference: Section 3.2 of [this document]
o Name: "rs_cnf"
o CBOR key: TBD (suggested: 41)
o Change Controller: IESG
o Reference: Section 3.2 of [this document]
9.6. OAuth Token Introspection Response CBOR Mappings Registration
This section registers the following parameter mappings in the "OAuth
Token Introspection Response CBOR Mappings" registry established in
section 8.11. of [I-D.ietf-ace-oauth-authz].
o Name: "cnf"
o CBOR key: TBD (suggested: 8)
o Change Controller: IESG
o Reference: Section 4.1 of [this document]
o Name: "rs_cnf"
o CBOR key: TBD (suggested: 41)
o Change Controller: IESG
o Reference: Section 4.1 of [this document]
10. Acknowledgments
This document is a product of the ACE working group of the IETF.
Ludwig Seitz worked on this document as part of the CelticNext
projects CyberWI, and CRITISEC with funding from Vinnova.
11. References
11.1. Normative References
[I-D.ietf-ace-cwt-proof-of-possession]
Jones, M., Seitz, L., Selander, G., Erdtman, S., and H.
Tschofenig, "Proof-of-Possession Key Semantics for CBOR
Web Tokens (CWTs)", draft-ietf-ace-cwt-proof-of-
possession-11 (work in progress), October 2019.
Seitz Expires July 14, 2020 [Page 11]
Internet-Draft ACE-OAuth-Params January 2020
[I-D.ietf-ace-oauth-authz]
Seitz, L., Selander, G., Wahlstroem, E., Erdtman, S., and
H. Tschofenig, "Authentication and Authorization for
Constrained Environments (ACE) using the OAuth 2.0
Framework (ACE-OAuth)", draft-ietf-ace-oauth-authz-29
(work in progress), December 2019.
[I-D.ietf-oauth-mtls]
Campbell, B., Bradley, J., Sakimura, N., and T.
Lodderstedt, "OAuth 2.0 Mutual-TLS Client Authentication
and Certificate-Bound Access Tokens", draft-ietf-oauth-
mtls-17 (work in progress), August 2019.
[IANA.CborWebTokenClaims]
IANA, "CBOR Web Token (CWT) Claims",
<https://www.iana.org/assignments/cwt/cwt.xhtml#claims-
registry>.
[IANA.JsonWebTokenClaims]
IANA, "JSON Web Token Claims",
<https://www.iana.org/assignments/jwt/jwt.xhtml#claims>.
[IANA.OAuthParameters]
IANA, "OAuth Parameters",
<https://www.iana.org/assignments/oauth-parameters/oauth-
parameters.xhtml#parameters>.
[IANA.TokenIntrospectionResponse]
IANA, "OAuth Token Introspection Response",
<https://www.iana.org/assignments/oauth-parameters/oauth-
parameters.xhtml#token-introspection-response>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC6749] Hardt, D., Ed., "The OAuth 2.0 Authorization Framework",
RFC 6749, DOI 10.17487/RFC6749, October 2012,
<https://www.rfc-editor.org/info/rfc6749>.
[RFC7049] Bormann, C. and P. Hoffman, "Concise Binary Object
Representation (CBOR)", RFC 7049, DOI 10.17487/RFC7049,
October 2013, <https://www.rfc-editor.org/info/rfc7049>.
Seitz Expires July 14, 2020 [Page 12]
Internet-Draft ACE-OAuth-Params January 2020
[RFC7800] Jones, M., Bradley, J., and H. Tschofenig, "Proof-of-
Possession Key Semantics for JSON Web Tokens (JWTs)",
RFC 7800, DOI 10.17487/RFC7800, April 2016,
<https://www.rfc-editor.org/info/rfc7800>.
[RFC8152] Schaad, J., "CBOR Object Signing and Encryption (COSE)",
RFC 8152, DOI 10.17487/RFC8152, July 2017,
<https://www.rfc-editor.org/info/rfc8152>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data
Interchange Format", STD 90, RFC 8259,
DOI 10.17487/RFC8259, December 2017,
<https://www.rfc-editor.org/info/rfc8259>.
11.2. Informative References
[RFC7250] Wouters, P., Ed., Tschofenig, H., Ed., Gilmore, J.,
Weiler, S., and T. Kivinen, "Using Raw Public Keys in
Transport Layer Security (TLS) and Datagram Transport
Layer Security (DTLS)", RFC 7250, DOI 10.17487/RFC7250,
June 2014, <https://www.rfc-editor.org/info/rfc7250>.
[RFC7252] Shelby, Z., Hartke, K., and C. Bormann, "The Constrained
Application Protocol (CoAP)", RFC 7252,
DOI 10.17487/RFC7252, June 2014,
<https://www.rfc-editor.org/info/rfc7252>.
Author's Address
Ludwig Seitz
Combitech
Djaeknegatan 31
Malmoe 211 35
Sweden
Email: ludwig.seitz@combitech.se
Seitz Expires July 14, 2020 [Page 13]
Html markup produced by rfcmarkup 1.129d, available from
https://tools.ietf.org/tools/rfcmarkup/