]> SimpleLogin

beltram.ietf@pm.me

Security Secure Patterns for Internet CrEdentials openid connect oidc standard claims This document registers OpenId Connect standards claims already used in JSON Web Tokens for CBOR Web Tokens. About This Document The latest revision of this draft can be found at . Status information for this document may be found at . Discussion of this document takes place on the Secure Patterns for Internet CrEdentials Working Group mailing list (), which is archived at . Subscribe at . Source for this draft and an issue tracker can be found at .

Introduction OpenId Connect is an authentication standard including standard claims already in use for JSON Web Tokens (JWT) . CBOR Web Tokens (CWT) 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.

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 when, and only when, they appear in all capitals, as shown here.

Address claim In order to further reduce the size of this prevalent and large claim, we register integer labels for it. We strictly map the definition of claims in Section 5.1.1 of : all the claims are optional and "formatted" can either be used instead or in addition of all the other fields.

Security Considerations This document registers existing OpenID Connect standard claims already used in JSON Web Tokens for use in CBOR Web Tokens without changing their semantics. The Security and Privacy Considerations respectively of Sections 16 and 17 of also apply.

IANA Considerations All claims defined in this document are placed in the (CBOR Web Token (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 the IESG approves the document for publication as an RFC, IANA is asked to assign Claim Key values from the 170-256 range.

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
• Change Controller: IETF
• Specification Document(s): Section 5.1 of

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

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

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
• Change Controller: IETF
• Specification Document(s): Section 5.1 of

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

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

profile

• Claim Name: profile
• Claim Description: URL of the End-User's profile page.
• JWT Claim Name: profile
• Claim Key: TBD7 (176 suggested)
• Claim Value Type(s): text string
• Change Controller: IETF
• Specification Document(s): Section 5.1 of

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

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

email

• Claim Name: email
• Claim Description: End-User's preferred e-mail address.
• JWT Claim Name: email
• Claim Key: TBD10 (179 suggested)
• Claim Value Type(s): text string
• Change Controller: IETF
• Specification Document(s): Section 5.1 of

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): bool
• Change Controller: IETF
• Specification Document(s): Section 5.1 of

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

birthdate

• Claim Name: birthdate
• Claim Description: End-User's birthday, represented as an YYYY-MM-DD format.
• 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

zoneinfo

• Claim Name: zoneinfo
• Claim Description: String from IANA Time Zone Database 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

locale

• Claim Name: locale
• Claim Description: End-User's locale, represented as a BCP47 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

phone_number

• Claim Name: phone_number
• 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

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): bool
• Change Controller: IETF
• Specification Document(s): Section 5.1 of

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): map
• Change Controller: IETF
• Specification Document(s): Section 5.1 of

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

References Normative References n.d. n.d. IANA CBOR Web Token (CWT) is a compact means of representing claims to be transferred between two parties. The claims in a CWT are encoded in the Concise Binary Object Representation (CBOR), and CBOR Object Signing and Encryption (COSE) is used for added application-layer security protection. A claim is a piece of information asserted about a subject and is represented as a name/value pair consisting of a claim name and a claim value. CWT is derived from JSON Web Token (JWT) but uses CBOR rather than JSON. In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. This document describes the structure, content, construction, and semantics of language tags for use in cases where it is desirable to indicate the language used in an information object. It also describes how to register values for use in language tags and the creation of user-defined extensions for private interchange. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. Informative References JSON Web Token (JWT) is a compact, URL-safe means of representing claims to be transferred between two parties. The claims in a JWT are encoded as a JSON object that is used as the payload of a JSON Web Signature (JWS) structure or as the plaintext of a JSON Web Encryption (JWE) structure, enabling the claims to be digitally signed or integrity protected with a Message Authentication Code (MAC) and/or encrypted.

CDDL Schema

A CDDL description of each claim