idnits 2.17.1 draft-young-md-query-saml-16.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 : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (10 January 2022) is 838 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Outdated reference: A later version (-20) exists of draft-young-md-query-16 -- Obsolete informational reference (is this intentional?): RFC 4844 (Obsoleted by RFC 8729) Summary: 0 errors (**), 0 flaws (~~), 2 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group I.A. Young, Ed. 3 Internet-Draft Independent 4 Intended status: Informational 10 January 2022 5 Expires: 14 July 2022 7 SAML Profile for the Metadata Query Protocol 8 draft-young-md-query-saml-16 10 Abstract 12 This document profiles the Metadata Query Protocol for use with SAML 13 metadata. 15 This document is a product of the Research and Education Federations 16 (REFEDS) Working Group process. 18 Editorial Note (To be removed by RFC Editor before publication) 20 Discussion of this draft takes place on the MDX mailing list 21 (mdx@lists.iay.org.uk), which is accessed from [MDX.list]. 23 XML versions, latest edits and the issues list for this document are 24 available from [md-query]. 26 The changes in this draft are summarized in Appendix A.17. 28 Status of This Memo 30 This Internet-Draft is submitted in full conformance with the 31 provisions of BCP 78 and BCP 79. 33 Internet-Drafts are working documents of the Internet Engineering 34 Task Force (IETF). Note that other groups may also distribute 35 working documents as Internet-Drafts. The list of current Internet- 36 Drafts is at https://datatracker.ietf.org/drafts/current/. 38 Internet-Drafts are draft documents valid for a maximum of six months 39 and may be updated, replaced, or obsoleted by other documents at any 40 time. It is inappropriate to use Internet-Drafts as reference 41 material or to cite them other than as "work in progress." 43 This Internet-Draft will expire on 14 July 2022. 45 Copyright Notice 47 Copyright (c) 2022 IETF Trust and the persons identified as the 48 document authors. All rights reserved. 50 This document is subject to BCP 78 and the IETF Trust's Legal 51 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 52 license-info) in effect on the date of publication of this document. 53 Please review these documents carefully, as they describe your rights 54 and restrictions with respect to this document. 56 Table of Contents 58 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 59 1.1. Notation and Conventions . . . . . . . . . . . . . . . . 3 60 2. Request Profile . . . . . . . . . . . . . . . . . . . . . . . 3 61 2.1. Content Type . . . . . . . . . . . . . . . . . . . . . . 3 62 2.2. Identifiers . . . . . . . . . . . . . . . . . . . . . . . 3 63 2.2.1. Unique Identifier . . . . . . . . . . . . . . . . . . 4 64 2.2.2. Transformed Identifier . . . . . . . . . . . . . . . 4 65 2.2.3. Additional Identifiers . . . . . . . . . . . . . . . 5 66 3. Response Profile . . . . . . . . . . . . . . . . . . . . . . 5 67 3.1. Response Cardinality . . . . . . . . . . . . . . . . . . 5 68 3.1.1. No Entity Descriptors Returned . . . . . . . . . . . 5 69 3.1.2. One Entity Descriptor Returned . . . . . . . . . . . 5 70 3.1.3. More Than One Entity Descriptor Returned . . . . . . 5 71 4. Security Considerations . . . . . . . . . . . . . . . . . . . 5 72 4.1. Integrity . . . . . . . . . . . . . . . . . . . . . . . . 6 73 4.2. Use of SHA-1 in Transformed Identifiers . . . . . . . . . 6 74 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 75 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 7 76 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 7 77 7.1. Normative References . . . . . . . . . . . . . . . . . . 7 78 7.2. Informative References . . . . . . . . . . . . . . . . . 8 79 Appendix A. Change Log (to be removed by RFC Editor before 80 publication) . . . . . . . . . . . . . . . . . . . . . . 9 81 A.1. draft-young-md-query-saml-00 . . . . . . . . . . . . . . 9 82 A.2. Since draft-young-md-query-saml-00 . . . . . . . . . . . 9 83 A.3. Since draft-young-md-query-saml-01 . . . . . . . . . . . 9 84 A.4. Since draft-young-md-query-saml-02 . . . . . . . . . . . 9 85 A.5. Since draft-young-md-query-saml-03 . . . . . . . . . . . 9 86 A.6. Since draft-young-md-query-saml-04 . . . . . . . . . . . 9 87 A.7. Since draft-young-md-query-saml-05 . . . . . . . . . . . 10 88 A.8. Since draft-young-md-query-saml-06 . . . . . . . . . . . 10 89 A.9. Since draft-young-md-query-saml-07 . . . . . . . . . . . 10 90 A.10. Since draft-young-md-query-saml-08 . . . . . . . . . . . 10 91 A.11. Since draft-young-md-query-saml-09 . . . . . . . . . . . 10 92 A.12. Since draft-young-md-query-saml-10 . . . . . . . . . . . 10 93 A.13. Since draft-young-md-query-saml-11 . . . . . . . . . . . 10 94 A.14. Since draft-young-md-query-saml-12 . . . . . . . . . . . 11 95 A.15. Since draft-young-md-query-saml-13 . . . . . . . . . . . 11 96 A.16. Since draft-young-md-query-saml-14 . . . . . . . . . . . 11 97 A.17. Since draft-young-md-query-saml-15 . . . . . . . . . . . 11 99 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 11 101 1. Introduction 103 This document profiles the Metadata Query Protocol 104 [I-D.young-md-query] for use with SAML metadata [SAML2Meta]. 106 The Research and Education Federations group ([REFEDS]) is the voice 107 that articulates the mutual needs of research and education identity 108 federations worldwide. It aims to represent the requirements of 109 research and education in the ever-growing space of access and 110 identity management. 112 From time to time REFEDS will wish to publish a document in the 113 Internet RFC series. Such documents will be published as part of the 114 RFC Independent Submission Stream [RFC4844]; however the REFEDS 115 working group sign-off process will have been followed for these 116 documents, as described in the REFEDS Participant's Agreement 117 [REFEDS.agreement]. 119 This document is a product of the REFEDS Working Group process. 121 1.1. Notation and Conventions 123 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 124 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 125 "OPTIONAL" in this document are to be interpreted as described in 126 BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all 127 capitals, as shown here. 129 This document makes use of the Augmented BNF metalanguage defined in 130 [STD68]. 132 2. Request Profile 134 2.1. Content Type 136 Requests compliant with this profile MUST include the following HTTP 137 header to indicate that the metadata returned should be SAML metadata 138 (see Appendix A of [SAML2Meta]): 140 Accept: application/samlmetadata+xml 142 2.2. Identifiers 143 2.2.1. Unique Identifier 145 Each entity known to the responder MUST be associated with the unique 146 identifier of the entity, corresponding to the entityID attribute of 147 the entity's EntityDescriptor element in SAML metadata. 149 2.2.2. Transformed Identifier 151 SAML 2.0 [SAML2Core] includes profiles based on the transfer of an 152 "artifact" containing the unique identifier of a SAML entity 153 transformed by means of the SHA-1 [RFC3174] hash algorithm (see 154 [SAML2Bind] sections 3.6 and 3.6.4). 156 In order to support use cases in which clients may be in possession 157 of only such a transformed representation of a SAML entity's unique 158 identifier without any way to establish the original entity 159 identifier, a responder compliant with this profile MUST associate 160 each entity with an identifier matching the sha1id production in the 161 following ABNF grammar, and treat such an identifier as equivalent to 162 the corresponding untransformed identifier: 164 SHA1 = %x73 %x68 %x61 %x31 ; lower case "sha1" 165 DIGIT = %x30-39 166 HEXDIGIT = DIGIT | %x61-66 ; lower case a-f 167 sha1id = "{" SHA1 "}" sha1hex 168 sha1hex = 40*HEXDIGIT 170 In the above, the sha1hex component encodes the 20-octet (160-bit) 171 binary SHA-1 hash value as a sequence of 40 lower case hexadecimal 172 digits. 174 For example, the identifier 176 http://example.org/service 178 transformed by means of SHA-1 hashing would become 180 {sha1}11d72e8cf351eb6c75c721e838f469677ab41bdb 182 Responder implementations MAY detect malformed SHA-1 transformed 183 identifiers (for example where the string of characters following the 184 "}" contains characters other than hexadecimal digits, or is other 185 than exactly 40 characters in length) and return an HTTP status code 186 of 400 ("bad request"). Alternatively, implementations MAY process 187 these as normal identifiers and return an HTTP status code of 404 188 ("not found") if appropriate. 190 2.2.3. Additional Identifiers 192 Entities MAY also be associated with any number of additional 193 responder-defined identifiers naming arbitrary groups of entities. 195 3. Response Profile 197 3.1. Response Cardinality 199 A request may return information for any number of entities, 200 including none. Responses compliant with this profile MUST use the 201 appropriate representation described below depending on the number of 202 EntityDescriptor elements returned. 204 3.1.1. No Entity Descriptors Returned 206 A response which returns no EntityDescriptor elements MUST be 207 represented by an HTTP status code of 404 ("not found"). 209 3.1.2. One Entity Descriptor Returned 211 A response which returns a single EntityDescriptor element MUST use 212 that element as its document element. The responder MUST NOT make 213 use of a EntitiesDescriptor element in this situation (see 214 [SAML2Meta] section 2.3). 216 Such a response MUST include the following HTTP header to indicate 217 that the metadata returned is SAML metadata: 219 Content-Type: application/samlmetadata+xml 221 3.1.3. More Than One Entity Descriptor Returned 223 A response which returns more than one EntityDescriptor element MUST 224 consist of a document element which is an EntitiesDescriptor element, 225 containing the returned EntityDescriptor elements as children. 226 Responses MUST NOT contain nested EntitiesDescriptor elements. 228 Such a response MUST include the following HTTP header to indicate 229 that the metadata returned is SAML metadata: 231 Content-Type: application/samlmetadata+xml 233 4. Security Considerations 234 4.1. Integrity 236 As SAML metadata contains information necessary for the secure 237 operation of interacting services it is strongly RECOMMENDED that a 238 mechanism for integrity checking is provided to clients. 240 It is RECOMMENDED that the integrity checking mechanism provided by a 241 responder is a digital signature embedded in the returned metadata 242 document, as defined by [SAML2Meta] section 3. 244 Such digital signatures: 246 * SHOULD use an RSA keypair whose modulus is no less than 2048 bits 247 in length. 249 * MUST NOT use the SHA-1 cryptographic hash algorithm as a digest 250 algorithm. 252 * MUST NOT use the MD5 cryptographic hash algorithm as a digest 253 algorithm. 255 * SHOULD otherwise follow current cryptographic best practices in 256 algorithm selection. 258 4.2. Use of SHA-1 in Transformed Identifiers 260 This profile mandates the availability of an identifier synonym 261 mechanism based on the SHA-1 cryptographic hash algorithm. Although 262 SHA-1 is now regarded as weak enough to exclude it from use in new 263 cryptographic systems, its use in this profile is necessary for full 264 support of the SAML 2.0 standard. 266 The use of SHA-1 in section 3.6.4 of [SAML2Bind], and its resulting 267 use in this protocol, would be vulnerable to an attack in which 268 metadata was introduced into a system by an attacker capable of 269 creating an entity identifier with the same SHA-1 hash as that of an 270 existing entity's identifier. 272 Such an identifier is known as a _second preimage_ of the original, 273 and SHA-1's resistance to discovery of it is referred to as SHA-1's 274 _second-preimage resistance_. 276 As demonstrated by the the [SHAttered] and [Shambles] attacks, the 277 SHA-1 algorithm is known to have weak collision resistance. However, 278 at the time of writing no attacks are known on SHA-1's second- 279 preimage resistance; a result in this area would be required to 280 provide the basis of an attack based on duplicating the SHA-1 hash of 281 an existing identifier. As a result, the use of SHA-1 in SAML and in 282 this protocol is not believed to introduce a security concern. 284 Implementations may guard against the possibility of a future 285 practical attack on the second-preimage resistance of SHA-1 by 286 treating two entities whose entityID values have the same SHA-1 287 equivalent as an indicator of malicious intent on the part of the 288 owner of one of the entities. 290 5. IANA Considerations 292 This document has no actions for IANA. 294 6. Acknowledgements 296 The editor would like to acknowledge the following individuals for 297 their contributions to this document: 299 Scott Cantor (The Ohio State University) 301 Leif Johansson (SUNET) 303 Joe St Sauver (University of Oregon) 305 Tom Scavo (Internet2) 307 7. References 309 7.1. Normative References 311 [I-D.young-md-query] 312 Young, I.A., Ed., "Metadata Query Protocol", Work in 313 Progress, Internet-Draft, draft-young-md-query-16, January 314 2022, . 317 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 318 Requirement Levels", BCP 14, RFC 2119, 319 DOI 10.17487/RFC2119, March 1997, 320 . 322 [RFC3174] Eastlake 3rd, D. and P. Jones, "US Secure Hash Algorithm 1 323 (SHA1)", RFC 3174, DOI 10.17487/RFC3174, September 2001, 324 . 326 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 327 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 328 May 2017, . 330 [SAML2Bind] 331 Cantor, S., Hirsch, F., Kemp, J., Philpott, R., and E. 332 Maler, "Bindings for the Security Assertion Markup 333 Language (SAML) V2.0", OASIS Standard saml-bindings- 334 2.0-os, March 2005. 336 [SAML2Meta] 337 Cantor, S., Moreh, J., Philpott, R., and E. Maler, 338 "Metadata for the Security Assertion Markup Language 339 (SAML) V2.0", OASIS Standard saml-metadata-2.0-os, March 340 2005, . 343 [STD68] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax 344 Specifications: ABNF", STD 68, RFC 5234, 345 DOI 10.17487/RFC5234, January 2008, 346 . 348 7.2. Informative References 350 [md-query] Young, I.A., Ed., "md-query Project", 351 . 353 [MDX.list] Young, I.A., Ed., "MDX Mailing List", 354 . 356 [REFEDS] Research and Education Federations, "REFEDS Home Page", 357 . 359 [REFEDS.agreement] 360 Research and Education Federations, "REFEDS Participant's 361 Agreement", 362 . 364 [RFC4844] Daigle, L., Ed. and Internet Architecture Board, "The RFC 365 Series and RFC Editor", RFC 4844, DOI 10.17487/RFC4844, 366 July 2007, . 368 [SAML2Core] 369 Cantor, S., Kemp, J., Philpott, R., and E. Maler, 370 "Assertions and Protocol for the OASIS Security Assertion 371 Markup Language (SAML) V2.0", OASIS Standard saml-core- 372 2.0-os, March 2005, . 375 [Shambles] "SHA-1 is a Shambles", January 2020, 376 . 378 [SHAttered] 379 "SHAttered", February 2017, . 381 Appendix A. Change Log (to be removed by RFC Editor before publication) 383 A.1. draft-young-md-query-saml-00 385 Initial version. 387 A.2. Since draft-young-md-query-saml-00 389 Added REFEDS RFC stream boilerplate. 391 A.3. Since draft-young-md-query-saml-01 393 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 395 Rework Section 2.2 to make the role of transformed identifiers 396 clearer. This changes the semantics slightly (malformed transformed 397 identifiers may now result in a 404 return rather than 400) but this 398 gives implementers more latitude in the way that they handle the 399 feature. 401 A.4. Since draft-young-md-query-saml-02 403 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 405 A.5. Since draft-young-md-query-saml-03 407 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 409 Added an Editorial Note to help direct readers back to the 410 discussion. 412 A.6. Since draft-young-md-query-saml-04 414 Fix reference to the Metadata Query Protocol [I-D.young-md-query]. 416 A.7. Since draft-young-md-query-saml-05 418 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 420 A.8. Since draft-young-md-query-saml-06 422 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 424 A.9. Since draft-young-md-query-saml-07 426 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 428 A.10. Since draft-young-md-query-saml-08 430 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 432 Modernise normative language to include [RFC8174]. 434 Improved references to RFCs. 436 A.11. Since draft-young-md-query-saml-09 438 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 440 A.12. Since draft-young-md-query-saml-10 442 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 444 Replace citations in the abstract with straight textual mentions, as 445 required by the ID-NITS checklist. 447 A.13. Since draft-young-md-query-saml-11 449 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 451 Strengthen Section 4.1 so that SHA-1 now MUST NOT be used in the 452 context of digital signatures. This brings the section in line with 453 current best practice recommendations, particularly in light of the 454 [SHAttered] and [Shambles] attacks. 456 Revised Section 4.2 on the use of SHA-1 in transformed identifiers 457 to: 459 * Make clear that this is a SAML-level issue, not one introduced by 460 the query protocol. 462 * Reference the attacks demonstrating SHA-1's weak collision 463 resistance. 465 * Identify second-preimage resistance as the potential source of the 466 attack we'd be concerned about for the query protocol. 468 * Note that SHA-1's second-preimage resistance is at present 469 uncompromised. 471 A.14. Since draft-young-md-query-saml-12 473 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 475 A.15. Since draft-young-md-query-saml-13 477 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 479 A.16. Since draft-young-md-query-saml-14 481 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 483 A.17. Since draft-young-md-query-saml-15 485 Bump reference to the Metadata Query Protocol [I-D.young-md-query]. 487 Author's Address 489 Ian A. Young (editor) 490 Independent 492 Email: ian@iay.org.uk