idnits 2.17.1 draft-ietf-secevent-subject-identifiers-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The abstract seems to contain references ([JSON], [JWT], [SET]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (July 18, 2018) is 2107 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Possible downref: Non-RFC (?) normative reference: ref. 'E164' -- Possible downref: Non-RFC (?) normative reference: ref. 'IDTOKEN' ** Obsolete normative reference: RFC 7159 (ref. 'JSON') (Obsoleted by RFC 8259) -- Duplicate reference: RFC7519, mentioned in 'RFC7519', was also mentioned in 'JWT'. Summary: 2 errors (**), 0 flaws (~~), 1 warning (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Security Events Working Group A. Backman 3 Internet-Draft Amazon 4 Intended status: Standards Track M. Scurtescu 5 Expires: January 19, 2019 Google 6 July 18, 2018 8 Subject Identifiers for Security Event Tokens 9 draft-ietf-secevent-subject-identifiers-00 11 Abstract 13 Security events communicated within Security Event Tokens may support 14 a variety of identifiers to identify the subject and/or other 15 principals related to the event. This specification formalizes the 16 notion of subject identifiers as named sets of well-defined claims 17 describing the subject, a mechanism for representing subject 18 identifiers within a [JSON] object such as a JSON Web Token [JWT] or 19 Security Event Token [SET], and a registry for defining and 20 allocating names for these claim sets. 22 Status of This Memo 24 This Internet-Draft is submitted in full conformance with the 25 provisions of BCP 78 and BCP 79. 27 Internet-Drafts are working documents of the Internet Engineering 28 Task Force (IETF). Note that other groups may also distribute 29 working documents as Internet-Drafts. The list of current Internet- 30 Drafts is at https://datatracker.ietf.org/drafts/current/. 32 Internet-Drafts are draft documents valid for a maximum of six months 33 and may be updated, replaced, or obsoleted by other documents at any 34 time. It is inappropriate to use Internet-Drafts as reference 35 material or to cite them other than as "work in progress." 37 This Internet-Draft will expire on January 19, 2019. 39 Copyright Notice 41 Copyright (c) 2018 IETF Trust and the persons identified as the 42 document authors. All rights reserved. 44 This document is subject to BCP 78 and the IETF Trust's Legal 45 Provisions Relating to IETF Documents 46 (https://trustee.ietf.org/license-info) in effect on the date of 47 publication of this document. Please review these documents 48 carefully, as they describe your rights and restrictions with respect 49 to this document. Code Components extracted from this document must 50 include Simplified BSD License text as described in Section 4.e of 51 the Trust Legal Provisions and are provided without warranty as 52 described in the Simplified BSD License. 54 Table of Contents 56 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 57 2. Notational Conventions . . . . . . . . . . . . . . . . . . . 3 58 3. Subject Identifiers . . . . . . . . . . . . . . . . . . . . . 3 59 3.1. Email Subject Identifier Type . . . . . . . . . . . . . . 3 60 3.2. Phone Number Subject Identifier Type . . . . . . . . . . 4 61 3.3. Issuer and Subject Subject Identifier Type . . . . . . . 4 62 3.4. ID Token Claims Subject Identifier Type . . . . . . . . . 5 63 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5 64 4.1. Security Event Subject Identifier Types Registry . . . . 5 65 4.1.1. Registration Template . . . . . . . . . . . . . . . . 6 66 4.1.2. Initial Registry Contents . . . . . . . . . . . . . . 6 67 4.1.3. Guidance for Expert Reviewers . . . . . . . . . . . . 7 68 5. Privacy Considerations . . . . . . . . . . . . . . . . . . . 8 69 6. Security Considerations . . . . . . . . . . . . . . . . . . . 8 70 7. Normative References . . . . . . . . . . . . . . . . . . . . 8 71 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 9 72 Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 73 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 9 75 1. Introduction 77 As described in section 1.2 of [SET], the subject of a security event 78 may take a variety of forms, including but not limited to a JWT 79 principal, an IP address, a URL, etc. Furthermore, even in the case 80 where the subject of an event is more narrowly scoped, there may be 81 multiple ways by which a given subject may be identified. For 82 example, an account may be identified by an opaque identifier, an 83 email address, a phone number, a JWT "iss" claim and "sub" claim, 84 etc., depending on the nature and needs of the transmitter and 85 receiver. Even within the context of a given transmitter and 86 receiver relationship, it may be appropriate to identify different 87 accounts in different ways, for example if some accounts only have 88 email addresses associated with them while others only have phone 89 numbers. Therefore it can be necessary to indicate within a SET the 90 mechanism by which the subject of the security event is being 91 identified. 93 2. Notational Conventions 95 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 96 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 97 document are to be interpreted as described in [RFC2119]. 99 3. Subject Identifiers 101 A Subject Identifier Type is a light-weight schema that describes a 102 set of claims that identifies a subject. Every Subject Identifier 103 Type MUST have a unique name registered in the IANA "Security Event 104 Subject Identifier Types" registry established by Section 4.1. A 105 Subject Identifier Type MAY describe more claims than are strictly 106 necessary to uniquely identify a subject, and MAY describe conditions 107 under which those claims are required, optional, or prohibited. 109 A Subject Identifier is a [JSON] object containing a "subject_type" 110 claim whose value is the unique name of a Subject Identifier Type, 111 and a set of additional "payload claims" which are to be interpreted 112 according to the rules defined by that Subject Identifier Type. 113 Payload claim values MUST match the format specified for the claim by 114 the Subject Identifier Type. A Subject Identifier MUST NOT contain 115 any payload claims prohibited or not described by its Subject 116 Identifier Type, and MUST contain all payload claims required by its 117 Subject Identifier Type. 119 The following Subject Identifier Types are registered in the IANA 120 "Security Event Subject Identifier Types" registry established by 121 Section 4.1. 123 3.1. Email Subject Identifier Type 125 The Email Subject Identifier Type describes a subject by email 126 address. Subject Identifiers of this type MUST contain an "email" 127 claim whose value is a string containing the email address of the 128 subject. The "email" claim MUST NOT be null or empty. The Email 129 Subject Identifier Type is identified by the name "email". 131 Below is a non-normative example Subject Identifier for the Email 132 Subject Identifier Type: 134 { 135 "subject_type": "email", 136 "email": "user@example.com", 137 } 139 Figure 1: Example: Subject Identifier for the Email Subject 140 Identifier Type. 142 3.2. Phone Number Subject Identifier Type 144 The Phone Number Subject Identifier Type describes a subject by 145 telephone number. Subject Identifiers of this type MUST contain a 146 "phone" claim whose value is a string containing the full telephone 147 number of the subject, including international dialing prefix, 148 formatted according to E.164 [E164]. The "phone" claim MUST NOT be 149 null or empty. The Phone Number Subject Identifier Type is 150 identified by the name "phone". 152 Below is a non-normative example Subject Identifier for the Email 153 Subject Identifier Type: 155 { 156 "subject_type": "phone", 157 "phone": "+1 (206) 555-0100", 158 } 160 Figure 2: Example: Subject Identifier for the Phone Number Subject 161 Identifier Type. 163 3.3. Issuer and Subject Subject Identifier Type 165 The Issuer and Subject Subject Identifier Type describes a subject by 166 an issuer and a subject. Subject Identifiers of this type MUST 167 contain an "iss" claim whose value identifies the issuer, and a "sub" 168 claim whose value identifies the subject with respect to the issuer. 169 These claims MUST follow the formats of the "iss" claim and "sub" 170 claim defined by [JWT], respectively. Both the "iss" claim and the 171 "sub" claim MUST NOT be null or empty. The Issuer and Subject 172 Subject Identifier Type is identified by the name "iss_sub". 174 Below is a non-normative example Subject Identifier for the Issuer 175 and Subject Subject Identifier Type: 177 { 178 "subject_type": "iss_sub", 179 "iss": "http://issuer.example.com/", 180 "sub": "145234573", 181 } 183 Figure 3: Example: Subject Identifier for the Issuer and Subject 184 Subject Identifier Type. 186 3.4. ID Token Claims Subject Identifier Type 188 The ID Token Claims Subject Identifier Type describes a subject by a 189 subset of the claims from an ID token. Subject Identifiers of this 190 type MUST contain at least one of the following claims: 192 email 193 An "email" claim, as defined in [IDTOKEN]. 195 phone_number 196 A "phone_number" claim, as defined in [IDTOKEN]. 198 sub 199 A "sub" claim, as defined in [RFC7519]. 201 If the Subject Identifier contains a "sub" claim, it MUST also 202 contain an "iss" claim, as defined in [RFC7519]. The ID Token Claims 203 Subject Identifier Type is identified by the name "id_token_claims". 205 Below is a non-normative example Subject Identifier for the ID Token 206 Claims Subject Identifier Type: 208 { 209 "subject_type": "id_token_claims", 210 "iss": "http://issuer.example.com/", 211 "sub": "145234573", 212 "email": "user@example.com", 213 } 215 Figure 4: Example: Subject Identifier for the ID Token Claims Subject 216 Identifier Type. 218 4. IANA Considerations 220 4.1. Security Event Subject Identifier Types Registry 222 This document defines Subject Identifier Types, for which IANA is 223 asked to create and maintain a new registry titled "Security Event 224 Subject Identifier Types". Initial values for the Security Event 225 Subject Identifier Types registry are given in Section 3. Future 226 assignments are to be made through the Expert Review registration 227 policy [BCP26] and shall follow the template presented in 228 Section 4.1.1. 230 4.1.1. Registration Template 232 Type Name 233 The name of the Subject Identifier Type, as described in 234 Section 3. The name MUST be an ASCII string consisting only of 235 lower-case characters ("a" - "z"), digits ("0" - "9"), and hyphens 236 ("-"), and SHOULD NOT exceed 20 characters in length. 238 Type Description 239 A brief description of the Subject Identifier Type. 241 Change Controller 242 For types defined in documents published by the OpenID Foundation 243 or its working groups, list "OpenID Foundation RISC Working 244 Group". For all other types, list the name of the party 245 responsible for the registration. Contact information such as 246 mailing address, email address, or phone number may also be 247 provided. 249 Defining Document(s) 250 A reference to the document or documents that define the Subject 251 Identifier Type. The definition MUST specify the name, format, 252 and meaning of each claim that may occur within a Subject 253 Identifier of the defined type, as well as whether each claim is 254 optional or required, or the circumstances under which the claim 255 is optional or required. URIs that can be used to retrieve copies 256 of each document SHOULD be included. 258 4.1.2. Initial Registry Contents 260 4.1.2.1. Email Subject Identifier Type 262 o Type Name: "email" 264 o Type Description: Subject identifier based on email address. 266 o Change Controller: IETF secevent Working Group 268 o Defining Document(s): Section 3 of this document. 270 4.1.2.2. ID Token Claims Subject Identifier Type 272 o Type Name: "id_token_claims" 274 o Type Description: Subject identifier based on OpenID Connect ID 275 Token claims. 277 o Change Controller: IETF secevent Working Group 278 o Defining Document(s): Section 3 of this document. 280 4.1.2.3. Issuer and Subject Subject Identifier Type 282 o Type Name: "iss_sub" 284 o Type Description: Subject identifier based on an issuer and 285 subject. 287 o Change Controller: IETF secevent Working Group 289 o Defining Document(s): Section 3 of this document. 291 4.1.2.4. Phone Number Subject Identifier Type 293 o Type Name: "phone" 295 o Type Description: Subject identifier based on an phone number. 297 o Change Controller: IETF secevent Working Group 299 o Defining Document(s): Section 3 of this document. 301 4.1.3. Guidance for Expert Reviewers 303 The Expert Reviewer is expected to review the documentation 304 referenced in a registration request to verify its completeness. The 305 Expert Reviewer must base their decision to accept or reject the 306 request on a fair and impartial assessment of the request. If the 307 Expert Reviewer has a conflict of interest, such as being an author 308 of a defining document referenced by the request, they must recuse 309 themselves from the approval process for that request. In the case 310 where a request is rejected, the Expert Reviewer should provide the 311 requesting party with a written statement expressing the reason for 312 rejection, and be prepared to cite any sources of information that 313 went into that decision. 315 Subject Identifier Types need not be generally applicable and may be 316 highly specific to a particular domain; it is expected that types may 317 be registered for niche or industry-specific use cases. The Expert 318 Reviewer should focus on whether the type is thoroughly documented, 319 and whether its registration will promote or harm interoperability. 320 In most cases, the Expert Reviewer should not approve a request if 321 the registration would contribute to confusion, or amount to a 322 synonym for an existing type. 324 5. Privacy Considerations 326 There are no privacy considerations. 328 6. Security Considerations 330 There are no security considerations. 332 7. Normative References 334 [BCP26] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 335 Writing an IANA Considerations Section in RFCs", BCP 26, 336 RFC 8126, DOI 10.17487/RFC8126, June 2017, 337 . 339 [E164] International Telecommunication Union, "The international 340 public telecommunication numbering plan", 2010, 341 . 343 [IDTOKEN] Sakamura, N., Bradley, J., Jones, M., de Medeiros, B., and 344 C. Mortimore, "OpenID Connect Core 1.0 - ID Token", April 345 2017, . 348 [JSON] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 349 Interchange Format", RFC 7159, DOI 10.17487/RFC7159, March 350 2014, . 352 [JWT] Jones, M., Bradley, J., and N. Sakimura, "JSON Web Token 353 (JWT)", RFC 7519, DOI 10.17487/RFC7519, May 2015, 354 . 356 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 357 Requirement Levels", BCP 14, RFC 2119, 358 DOI 10.17487/RFC2119, March 1997, 359 . 361 [RFC7519] Jones, M., Bradley, J., and N. Sakimura, "JSON Web Token 362 (JWT)", RFC 7519, DOI 10.17487/RFC7519, May 2015, 363 . 365 [SET] Hunt, P., Ed., Jones, M., Denniss, W., and M. Ansari, 366 "Security Event Token (SET)", RFC 8417, 367 DOI 10.17487/RFC8417, July 2018, 368 . 370 Acknowledgements 372 This document is based on work developed within the OpenID RISC 373 Working Group. The authors would like to thank the members of this 374 group for their hard work and contributions. 376 Change Log 378 (This section to be removed by the RFC Editor before publication as 379 an RFC.) 381 Draft 00 - AB - First draft 383 Authors' Addresses 385 Annabelle Backman 386 Amazon 388 Email: richanna@amazon.com 390 Marius Scurtescu 391 Google 393 Email: mscurtescu@google.com