JWK Thumbprint URI
draft-jones-oauth-jwk-thumbprint-uri-00

OAuth Working Group                                             M. Jones
Internet-Draft                                                 K. Yasuda
Intended status: Standards Track                               Microsoft
Expires: May 28, 2022                                  November 24, 2021

                           JWK Thumbprint URI
                draft-jones-oauth-jwk-thumbprint-uri-00

Abstract

   This specification registers a family of URIs that represent JSON Web
   Key (JWK) Thumbprint values.  JWK Thumbprints are defined in RFC
   7638.

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 May 28, 2022.

Copyright Notice

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

Jones & Yasuda            Expires May 28, 2022                  [Page 1]
Internet-Draft             JWK Thumbprint URI              November 2021

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Requirements Notation and Conventions . . . . . . . . . . . .   2
   3.  JWK Thumbprint URI  . . . . . . . . . . . . . . . . . . . . .   2
     3.1.  Example JWK Thumbprint URI  . . . . . . . . . . . . . . .   3
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .   3
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   3
     5.1.  OAuth URI Registration  . . . . . . . . . . . . . . . . .   3
       5.1.1.  Registry Contents . . . . . . . . . . . . . . . . . .   3
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   3
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .   3
     6.2.  Informative References  . . . . . . . . . . . . . . . . .   4
   Appendix A.  Acknowledgements . . . . . . . . . . . . . . . . . .   4
   Appendix B.  Document History . . . . . . . . . . . . . . . . . .   4
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .   4

1.  Introduction

   JSON Web Key (JWK) Thumbprints [RFC7638] are a URL-safe
   representation of a hash value over a JSON Web Key (JWK).  This
   specification defines a URI prefix indicating that the portion of the
   URI following the prefix is a JWK Thumbprint.  This enables JWK
   Thumbprints to be communicated in contexts requiring URIs, including
   in specific JSON Web Token (JWT) [RFC7519] claims.

2.  Requirements Notation and Conventions

   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.

3.  JWK Thumbprint URI

   The following URI prefix is defined to indicate that the portion of
   the URI following the prefix is a JWK Thumbprint:

   o  "urn:ietf:params:oauth:jwk-thumbprint"

   The prefix is followed by a colon and a JWK Thumbprint value to form
   a URI representing a JWK Thumbprint.

Jones & Yasuda            Expires May 28, 2022                  [Page 2]
Internet-Draft             JWK Thumbprint URI              November 2021

3.1.  Example JWK Thumbprint URI

   Section 3.1 of [RFC7638] contains the following example JWK
   Thumbprint value:

     NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs

   A complete JWK Thumbprint URI using the above JWK Thumbprint is:

  urn:ietf:params:oauth:jwk-thumbprint:NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs

4.  Security Considerations

   The security considerations of [RFC7638] also apply when using this
   specification.

5.  IANA Considerations

5.1.  OAuth URI Registration

   This specification registers the following value in the IANA "OAuth
   URI" registry [IANA.OAuth.Parameters] established by [RFC6755].

5.1.1.  Registry Contents

   o  URN: urn:ietf:params:oauth:jwk-thumbprint
   o  Common Name: JWK Thumbprint URI
   o  Change controller: IESG
   o  Specification Document: [[ this specification ]]

6.  References

6.1.  Normative References

   [IANA.OAuth.Parameters]
              IANA, "OAuth Parameters",
              <http://www.iana.org/assignments/oauth-parameters>.

   [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>.

   [RFC7638]  Jones, M. and N. Sakimura, "JSON Web Key (JWK)
              Thumbprint", RFC 7638, DOI 10.17487/RFC7638, September
              2015, <https://www.rfc-editor.org/info/rfc7638>.

Jones & Yasuda            Expires May 28, 2022                  [Page 3]
Internet-Draft             JWK Thumbprint URI              November 2021

   [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>.

6.2.  Informative References

   [RFC6755]  Campbell, B. and H. Tschofenig, "An IETF URN Sub-Namespace
              for OAuth", RFC 6755, DOI 10.17487/RFC6755, October 2012,
              <https://www.rfc-editor.org/info/rfc6755>.

   [RFC7519]  Jones, M., Bradley, J., and N. Sakimura, "JSON Web Token
              (JWT)", RFC 7519, DOI 10.17487/RFC7519, May 2015,
              <https://www.rfc-editor.org/info/rfc7519>.

   [SIOPv2]   Yasuda, K., Jones, M. B., and T. Looker, "Self-Issued
              OpenID Provider v2", September 2021,
              <https://openid.net/specs/openid-connect-self-issued-
              v2-1_0.html>.

Appendix A.  Acknowledgements

   Use cases for this specification were developed in the OpenID Connect
   Working Group of the OpenID Foundation.  Specifically, its use is
   planned in future versions of the [SIOPv2] specification.

   The following individuals also contributed to this specification:
   John Bradley and Adam Lemmon.

Appendix B.  Document History

   [[ to be removed by the RFC Editor before publication as an RFC ]]

   -00

   o  Created initial draft.

Authors' Addresses

   Michael B. Jones
   Microsoft

   Email: mbj@microsoft.com
   URI:   https://self-issued.info/

Jones & Yasuda            Expires May 28, 2022                  [Page 4]
Internet-Draft             JWK Thumbprint URI              November 2021

   Kristina Yasuda
   Microsoft

   Email: kryasuda@microsoft.com
   URI:   https://twitter.com/kristinayasuda

Jones & Yasuda            Expires May 28, 2022                  [Page 5]