Secure Patterns for Internet CrEdentials B. Maldant Internet-Draft SimpleLogin Intended status: Informational 5 November 2024 Expires: 9 May 2025 OpenID Connect standard claims registration for CBOR Web Tokens draft-maldant-spice-oidc-cwt-01 Abstract This document registers OpenId Connect standards claims already used in JSON Web Tokens for CBOR Web Tokens. About This Document This note is to be removed before publishing as an RFC. The latest revision of this draft can be found at https://beltram.github.io/rfc-spice-oidc-cwt/draft-maldant-spice- oidc-cwt.html. Status information for this document may be found at https://datatracker.ietf.org/doc/draft-maldant-spice-oidc-cwt/. Discussion of this document takes place on the Secure Patterns for Internet CrEdentials Working Group mailing list (mailto:spice@ietf.org), which is archived at https://mailarchive.ietf.org/arch/browse/spice/. Subscribe at https://www.ietf.org/mailman/listinfo/spice/. Source for this draft and an issue tracker can be found at https://github.com/beltram/rfc-spice-oidc-cwt. 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 9 May 2025. Maldant Expires 9 May 2025 [Page 1] Internet-Draft OIDC standard claims for CWT November 2024 Copyright Notice Copyright (c) 2024 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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Conventions and Definitions . . . . . . . . . . . . . . . . . 3 3. Security Considerations . . . . . . . . . . . . . . . . . . . 3 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 3 4.1. name . . . . . . . . . . . . . . . . . . . . . . . . . . 3 4.2. given_name . . . . . . . . . . . . . . . . . . . . . . . 4 4.3. family_name . . . . . . . . . . . . . . . . . . . . . . . 4 4.4. middle_name . . . . . . . . . . . . . . . . . . . . . . . 4 4.5. nickname . . . . . . . . . . . . . . . . . . . . . . . . 5 4.6. preferred_username . . . . . . . . . . . . . . . . . . . 5 4.7. profile . . . . . . . . . . . . . . . . . . . . . . . . . 5 4.8. picture . . . . . . . . . . . . . . . . . . . . . . . . . 6 4.9. website . . . . . . . . . . . . . . . . . . . . . . . . . 6 4.10. email . . . . . . . . . . . . . . . . . . . . . . . . . . 6 4.11. email_verified . . . . . . . . . . . . . . . . . . . . . 7 4.12. gender . . . . . . . . . . . . . . . . . . . . . . . . . 7 4.13. birthdate . . . . . . . . . . . . . . . . . . . . . . . . 7 4.14. zoneinfo . . . . . . . . . . . . . . . . . . . . . . . . 8 4.15. locale . . . . . . . . . . . . . . . . . . . . . . . . . 8 4.16. phone_number . . . . . . . . . . . . . . . . . . . . . . 8 4.17. phone_number_verified . . . . . . . . . . . . . . . . . . 9 4.18. address . . . . . . . . . . . . . . . . . . . . . . . . . 9 4.19. updated_at . . . . . . . . . . . . . . . . . . . . . . . 10 5. References . . . . . . . . . . . . . . . . . . . . . . . . . 10 5.1. Normative References . . . . . . . . . . . . . . . . . . 10 5.2. Informative References . . . . . . . . . . . . . . . . . 11 Appendix A. CDDL Schema . . . . . . . . . . . . . . . . . . . . 11 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 12 Maldant Expires 9 May 2025 [Page 2] Internet-Draft OIDC standard claims for CWT November 2024 1. Introduction OpenId Connect [OIDCCore] is an authentication standard including standard claims already in use for JSON Web Tokens (JWT) [RFC7519]. CBOR Web Tokens (CWT) [RFC8392] have a claims registry, but do not include most of these claims. This draft aims at unifying use of OIDC claims in JWTs and CWTs. 2. Conventions and Definitions 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. Security Considerations This document registers existing OpenID Connect standard claims already used in JSON Web Tokens [RFC7519] for use in CBOR Web Tokens [RFC8392] without changing their semantics. The Security and Privacy Considerations respectively of Sections 16 and 17 of [OIDCCore] also apply. 4. IANA Considerations All claims defined in this document are placed in the (CBOR Web Token (CWT) Claims) [IANA.CWT.Claims] Registry (part of the eponymous registry group). No new IANA registry is created. In case any of the suggested code points would have been claimed by the time of the Working Group last call, IANA is asked to assign Claim Key values from the 170-256 range. 4.1. name * Claim Name: name * Claim Description: End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences. * JWT Claim Name: name * Claim Key: TBD1 (170 suggested) * Claim Value Type(s): text string Maldant Expires 9 May 2025 [Page 3] Internet-Draft OIDC standard claims for CWT November 2024 * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.2. given_name * Claim Name: given_name * Claim Description: Given name(s) or first name(s) of the End-User. * JWT Claim Name: given_name * Claim Key: TBD2 (171 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.3. family_name * Claim Name: family_name * Claim Description: Surname(s) or last name(s) of the End-User. * JWT Claim Name: family_name * Claim Key: TBD3 (172 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.4. middle_name * Claim Name: middle_name * Claim Description: Middle name(s) of the End-User. * JWT Claim Name: middle_name * Claim Key: TBD4 (173 suggested) * Claim Value Type(s): text string Maldant Expires 9 May 2025 [Page 4] Internet-Draft OIDC standard claims for CWT November 2024 * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.5. nickname * Claim Name: nickname * Claim Description: Casual name of the End-User that may or may not be the same as the given_name. * JWT Claim Name: nickname * Claim Key: TBD5 (174 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.6. preferred_username * Claim Name: preferred_username * Claim Description: Shorthand name by which the End-User wishes to be referred to at the Resource Server. * JWT Claim Name: preferred_username * Claim Key: TBD6 (175 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.7. profile * Claim Name: profile * Claim Description: URL of the End-User's profile page. * JWT Claim Name: profile * Claim Key: TBD7 (176 suggested) Maldant Expires 9 May 2025 [Page 5] Internet-Draft OIDC standard claims for CWT November 2024 * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.8. picture * Claim Name: picture * Claim Description: URL of the End-User's profile picture. This URL MUST refer to an image file, rather than to a Web page containing an image. * JWT Claim Name: picture * Claim Key: TBD8 (177 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.9. website * Claim Name: website * Claim Description: URL of the End-User's Web page or blog. * JWT Claim Name: website * Claim Key: TBD9 (178 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.10. email * Claim Name: email * Claim Description: End-User's preferred e-mail address. * JWT Claim Name: email Maldant Expires 9 May 2025 [Page 6] Internet-Draft OIDC standard claims for CWT November 2024 * Claim Key: TBD10 (179 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.11. email_verified * Claim Name: email_verified * Claim Description: True if the End-User's e-mail address has been verified; otherwise false. * JWT Claim Name: email_verified * Claim Key: TBD11 (180 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.12. gender * Claim Name: gender * Claim Description: End-User's defined gender. * JWT Claim Name: gender * Claim Key: TBD12 (181 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.13. birthdate * Claim Name: birthdate * Claim Description: End-User's birthday, represented as an [ISO8601_1] YYYY-MM-DD format. Maldant Expires 9 May 2025 [Page 7] Internet-Draft OIDC standard claims for CWT November 2024 * JWT Claim Name: birthdate * Claim Key: TBD13 (182 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.14. zoneinfo * Claim Name: zoneinfo * Claim Description: String from IANA Time Zone Database [IANAtimezones] representing the End-User's time zone. * JWT Claim Name: zoneinfo * Claim Key: TBD14 (183 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.15. locale * Claim Name: locale * Claim Description: End-User's locale, represented as a BCP47 [RFC5646] language tag. * JWT Claim Name: locale * Claim Key: TBD15 (184 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.16. phone_number * Claim Name: phone_number Maldant Expires 9 May 2025 [Page 8] Internet-Draft OIDC standard claims for CWT November 2024 * Claim Description: End-User's preferred telephone number. * JWT Claim Name: phone_number * Claim Key: TBD16 (185 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.17. phone_number_verified * Claim Name: phone_number_verified * Claim Description: True if the End-User's phone number has been verified; otherwise false. * JWT Claim Name: phone_number_verified * Claim Key: TBD17 (186 suggested) * Claim Value Type(s): text string * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 4.18. address * Claim Name: address * Claim Description: End-User's preferred postal address. * JWT Claim Name: address * Claim Key: TBD18 (187 suggested) * Claim Value Type(s): text string (the content is a JSON array) * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] Maldant Expires 9 May 2025 [Page 9] Internet-Draft OIDC standard claims for CWT November 2024 4.19. updated_at * Claim Name: updated_at * Claim Description: Time the End-User's information was last updated. Its value is a number representing the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time. * JWT Claim Name: updated_at * Claim Key: TBD19 (188 suggested) * Claim Value Type(s): uint * Change Controller: IETF * Specification Document(s): Section 5.1 of [OIDCCore] 5. References 5.1. Normative References [IANA.CWT.Claims] IANA, "CBOR Web Token (CWT) Claims", . [IANAtimezones] "IANA time zones", n.d., . [ISO8601_1] "ISO8601-1", n.d., . [OIDCCore] Sakimura, N., Bradley, J., Jones, M. B., Medeiros, B. de., and C. Mortimore, "OpenID Connect Core 1.0 incorporating errata set 2", 15 December 2023, . [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, September 2009, . Maldant Expires 9 May 2025 [Page 10] Internet-Draft OIDC standard claims for CWT November 2024 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . [RFC8392] Jones, M., Wahlstroem, E., Erdtman, S., and H. Tschofenig, "CBOR Web Token (CWT)", RFC 8392, DOI 10.17487/RFC8392, May 2018, . 5.2. Informative References [RFC7519] Jones, M., Bradley, J., and N. Sakimura, "JSON Web Token (JWT)", RFC 7519, DOI 10.17487/RFC7519, May 2015, . Appendix A. CDDL Schema Maldant Expires 9 May 2025 [Page 11] Internet-Draft OIDC standard claims for CWT November 2024 name = (TBD1 => tstr) ; "Jane Doe" given_name = (TBD2 => tstr) ; "Jane" family_name = (TBD3 => tstr) ; "Doe" middle_name = (TBD4 => tstr) ; "Ellen" nickname = (TBD5 => tstr) ; "Jane D." preferred_username = (TBD6 => tstr) ; "j.doe" profile = (TBD7 => tstr) ; "https://example.org/about.html" picture = (TBD8 => tstr) ; "https://example.org/avatar.png" website = (TBD9 => tstr) ; "https://example.org" email = (TBD10 => tstr) ; "janedoe@example.com" email_verified = (TBD11 => tstr) ; "true" gender = (TBD12 => tstr) ; "female" birthdate = (TBD13 => tstr) ; "1970-03-22" zoneinfo = (TBD14 => tstr) ; "America/Los_Angeles" locale = (TBD15 => tstr) ; "en_US" phone_number = (TBD16 => tstr) ; "+1 (425) 555-1212" phone_number_verified = (TBD17 => tstr) ; "true" address = (TBD18 => tstr) ; "{"street_address": "1234 Hollywood Blvd.", "locality": "Los Angeles", "region": "CA", "postal_code": "90210", "country": "United States of America"}" updated_at = (TBD19 => uint) ; 1730123071 TBD1 = 170 TBD2 = 171 TBD3 = 172 TBD4 = 173 TBD5 = 174 TBD6 = 175 TBD7 = 176 TBD8 = 177 TBD9 = 178 TBD10 = 179 TBD11 = 180 TBD12 = 181 TBD13 = 182 TBD14 = 183 TBD15 = 184 TBD16 = 185 TBD17 = 186 TBD18 = 187 TBD19 = 188 Figure 1: A CDDL description of each claim Author's Address Beltram Maldant SimpleLogin Email: beltram.ietf@pm.me Maldant Expires 9 May 2025 [Page 12]