OAuth Working Group R. Shekh-Yusef
Internet-Draft Avaya
Intended status: Standards Track September 2, 2019
Expires: March 5, 2020

Nested JSON Web Token (JWT)


This specification extends the scope of the Nested JSON Web Token (JWT) to allow the enclosing JWT to contain its own Claims Set in addition to the enclosed JWT.

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 March 5, 2020.

Copyright Notice

Copyright (c) 2019 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 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.

This document may contain material from IETF Documents or IETF Contributions published or made publicly available before November 10, 2008. The person(s) controlling the copyright in some of this material may not have granted the IETF Trust the right to allow modifications of such material outside the IETF Standards Process. Without obtaining an adequate license from the person(s) controlling the copyright in such materials, this document may not be modified outside the IETF Standards Process, and derivative works of it may not be created outside the IETF Standards Process, except to format it for publication as an RFC or to translate it into languages other than English.

Table of Contents

1. Introduction

JSON Web Token (JWT) is a mechanism that is used to transfer claims between two parties across security domains. Nested JWT is a JWT in which the payload is another JWT. The current specification does not define a means by which the enclosing JWT could have its own Claims Set, only the enclosed JWT would have claims.

This specification extends the scope of the Nested JWT to allow the enclosing JWT to contain its own Claims Set in addition to the enclosed JWT.

1.1. Terminology

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC8174].

2. Overview

RFC7519 defines Nested JWT as a JWT in which nested signing and/or encryption are employed. In Nested JWTs, a JWT is used as the payload or plaintext value of an enclosing JWS or JWE structure, respectively.

To indicate that the payload of an enclosing JWT is yet another JWT, the value of the Content Type Parameter of the JOSE header, i.e. "cty", must be set to "JWT", which means that the enclosing JWT cannot have its own claims.

This document updates the enclosing JWT content to allow it to represent a Claims Set and an enclosed JWT, using JSON data structures, and updates the Content Type to indicate this new nested content.

3. Use Cases

3.1. Native App

The use case is for a telephony application that is based on the "Native Apps Using the Browser" flow defined in RFC8252. The Native App needs access to a telephony and non-telephony services that are controlled by different authorization servers, where the Native App can validate tokens issued by only one of these authorization servers.

The Native App starts the process by interacting with a Client that requires the user to authenticate itself using a Browser. The Browser starts by contacting an AS, which redirects it to an OP. The user authenticates to the OP and obtains a Code, and then gets redirected back to AS. The Native App gets access to the Code, then sends the Code to the AS, which then interacts with the OP to exchange the Code for an ID Token and OP Access Token. Since the Native App has no way of validating the OP Access Token, when the AS creates an AS Access Token, it embeds the OP Access Token inside the AS Access Token, and returns it back to the Native App. The Native App gets the AS Access Token and is able to validate it and extract the OP Access Token, and access the different services protected with these tokens.

3.2. STIR

[RFC8225] defines a PASSporT, which is a JWT, that is used to verify the identity of a caller in an incoming call.

The PASSporT Extension for Diverted Calls draft [STIR] uses a nested PASSporT to deliver the details of an incoming call that get redirected. An authentication service acting for a retargeting entity generates new PASSporT and embeds the original PASSporT inside the new one. When the new target receives the nested PASSporT it will be able to validate the enclosing PASSporT and use the details of the enclosed PASSporT to identify the origianl target.

4. JWT Content Type Header Parameter

The JOSE Header contains an optional parameter that could be used to indicate the type of the payload of a JWT. With a typical Nested JWT, the value of the "cty" header must be "JWT". To indicate that the payload contains a Claims Set in addition to the JWT, the value of the "cty" header must be "NJWT".

5. JWT Content

The payload of the enclosing JWT is JSON object that contains the Claims Set, and one new claim that is used to hold the enclosed JWT.

This document defines a new claim, "njwt", that is used to contain the enclosed JWT.

6. Example

  "alg": "HS256",
  "typ": "JWT",
  "cty": "NJWT"

  "sub": "1234567890",
  "name": "John Doe",
  "iat": 1516239022,
  "njwt": "<njwt>"

7. Security Considerations


8. IANA Considerations


9. Acknowledgments


10. References

10.1. Normative References

[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017.

10.2. Informative References

[RFC8225] Wendt, C. and J. Peterson, "PASSporT: Personal Assertion Token", RFC 8225, DOI 10.17487/RFC8225, February 2018.
[STIR] Peterson, J., "PASSporT Extension for Diverted Calls", October 2018.

Author's Address

Rifaat Shekh-Yusef Avaya 425 Legget Drive Ottawa, Ontario Canada Phone: +1-613-595-9106 EMail: rifaat.ietf@gmail.com