idnits 2.17.1 draft-ietf-jose-json-web-algorithms-33.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 : ---------------------------------------------------------------------------- == There are 23 instances of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (September 25, 2014) is 3498 days in the past. Is this intentional? -- Found something which looks like a code comment -- if you have code sections in the document, please surround them with '' and '' lines. Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Looks like a reference, but probably isn't: '1' on line 2912 -- Looks like a reference, but probably isn't: '0' on line 2912 -- Looks like a reference, but probably isn't: '7' on line 2884 -- Looks like a reference, but probably isn't: '65' on line 2892 -- Looks like a reference, but probably isn't: '49' on line 2886 -- Looks like a reference, but probably isn't: '50' on line 2886 -- Looks like a reference, but probably isn't: '56' on line 2886 -- Looks like a reference, but probably isn't: '71' on line 2886 -- Looks like a reference, but probably isn't: '67' on line 2886 -- Looks like a reference, but probably isn't: '77' on line 2886 -- Looks like a reference, but probably isn't: '5' on line 2890 -- Looks like a reference, but probably isn't: '108' on line 2892 -- Looks like a reference, but probably isn't: '105' on line 2892 -- Looks like a reference, but probably isn't: '99' on line 2892 -- Looks like a reference, but probably isn't: '101' on line 2892 -- Looks like a reference, but probably isn't: '3' on line 2896 -- Looks like a reference, but probably isn't: '66' on line 2898 -- Looks like a reference, but probably isn't: '111' on line 2898 -- Looks like a reference, but probably isn't: '98' on line 2898 -- Looks like a reference, but probably isn't: '128' on line 2902 -- Possible downref: Non-RFC (?) normative reference: ref. 'AES' -- Possible downref: Non-RFC (?) normative reference: ref. 'DSS' ** Downref: Normative reference to an Informational RFC: RFC 2104 ** Obsolete normative reference: RFC 2898 (Obsoleted by RFC 8018) ** Downref: Normative reference to an Informational RFC: RFC 3394 ** Obsolete normative reference: RFC 3447 (Obsoleted by RFC 8017) ** Downref: Normative reference to an Informational RFC: RFC 6090 ** Obsolete normative reference: RFC 7159 (Obsoleted by RFC 8259) -- Possible downref: Non-RFC (?) normative reference: ref. 'SEC1' -- Possible downref: Non-RFC (?) normative reference: ref. 'SHS' -- Possible downref: Non-RFC (?) normative reference: ref. 'USASCII' == Outdated reference: A later version (-18) exists of draft-ietf-precis-saslprepbis-07 -- Obsolete informational reference (is this intentional?): RFC 5226 (Obsoleted by RFC 8126) Summary: 6 errors (**), 0 flaws (~~), 3 warnings (==), 28 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 JOSE Working Group M. Jones 3 Internet-Draft Microsoft 4 Intended status: Standards Track September 25, 2014 5 Expires: March 29, 2015 7 JSON Web Algorithms (JWA) 8 draft-ietf-jose-json-web-algorithms-33 10 Abstract 12 The JSON Web Algorithms (JWA) specification registers cryptographic 13 algorithms and identifiers to be used with the JSON Web Signature 14 (JWS), JSON Web Encryption (JWE), and JSON Web Key (JWK) 15 specifications. It defines several IANA registries for these 16 identifiers. 18 Status of this Memo 20 This Internet-Draft is submitted in full conformance with the 21 provisions of BCP 78 and BCP 79. 23 Internet-Drafts are working documents of the Internet Engineering 24 Task Force (IETF). Note that other groups may also distribute 25 working documents as Internet-Drafts. The list of current Internet- 26 Drafts is at http://datatracker.ietf.org/drafts/current/. 28 Internet-Drafts are draft documents valid for a maximum of six months 29 and may be updated, replaced, or obsoleted by other documents at any 30 time. It is inappropriate to use Internet-Drafts as reference 31 material or to cite them other than as "work in progress." 33 This Internet-Draft will expire on March 29, 2015. 35 Copyright Notice 37 Copyright (c) 2014 IETF Trust and the persons identified as the 38 document authors. All rights reserved. 40 This document is subject to BCP 78 and the IETF Trust's Legal 41 Provisions Relating to IETF Documents 42 (http://trustee.ietf.org/license-info) in effect on the date of 43 publication of this document. Please review these documents 44 carefully, as they describe your rights and restrictions with respect 45 to this document. Code Components extracted from this document must 46 include Simplified BSD License text as described in Section 4.e of 47 the Trust Legal Provisions and are provided without warranty as 48 described in the Simplified BSD License. 50 Table of Contents 52 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 5 53 1.1. Notational Conventions . . . . . . . . . . . . . . . . . . 5 54 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 5 55 3. Cryptographic Algorithms for Digital Signatures and MACs . . . 6 56 3.1. "alg" (Algorithm) Header Parameter Values for JWS . . . . 6 57 3.2. HMAC with SHA-2 Functions . . . . . . . . . . . . . . . . 7 58 3.3. Digital Signature with RSASSA-PKCS1-V1_5 . . . . . . . . . 8 59 3.4. Digital Signature with ECDSA . . . . . . . . . . . . . . . 9 60 3.5. Digital Signature with RSASSA-PSS . . . . . . . . . . . . 10 61 3.6. Using the Algorithm "none" . . . . . . . . . . . . . . . . 11 62 4. Cryptographic Algorithms for Key Management . . . . . . . . . 11 63 4.1. "alg" (Algorithm) Header Parameter Values for JWE . . . . 12 64 4.2. Key Encryption with RSAES-PKCS1-V1_5 . . . . . . . . . . . 14 65 4.3. Key Encryption with RSAES OAEP . . . . . . . . . . . . . . 14 66 4.4. Key Wrapping with AES Key Wrap . . . . . . . . . . . . . . 14 67 4.5. Direct Encryption with a Shared Symmetric Key . . . . . . 15 68 4.6. Key Agreement with Elliptic Curve Diffie-Hellman 69 Ephemeral Static (ECDH-ES) . . . . . . . . . . . . . . . . 15 70 4.6.1. Header Parameters Used for ECDH Key Agreement . . . . 16 71 4.6.1.1. "epk" (Ephemeral Public Key) Header Parameter . . 16 72 4.6.1.2. "apu" (Agreement PartyUInfo) Header Parameter . . 16 73 4.6.1.3. "apv" (Agreement PartyVInfo) Header Parameter . . 17 74 4.6.2. Key Derivation for ECDH Key Agreement . . . . . . . . 17 75 4.7. Key Encryption with AES GCM . . . . . . . . . . . . . . . 18 76 4.7.1. Header Parameters Used for AES GCM Key Encryption . . 19 77 4.7.1.1. "iv" (Initialization Vector) Header Parameter . . 19 78 4.7.1.2. "tag" (Authentication Tag) Header Parameter . . . 19 79 4.8. Key Encryption with PBES2 . . . . . . . . . . . . . . . . 19 80 4.8.1. Header Parameters Used for PBES2 Key Encryption . . . 20 81 4.8.1.1. "p2s" (PBES2 salt input) Parameter . . . . . . . . 20 82 4.8.1.2. "p2c" (PBES2 count) Parameter . . . . . . . . . . 21 83 5. Cryptographic Algorithms for Content Encryption . . . . . . . 21 84 5.1. "enc" (Encryption Algorithm) Header Parameter Values 85 for JWE . . . . . . . . . . . . . . . . . . . . . . . . . 21 86 5.2. AES_CBC_HMAC_SHA2 Algorithms . . . . . . . . . . . . . . . 22 87 5.2.1. Conventions Used in Defining AES_CBC_HMAC_SHA2 . . . . 22 88 5.2.2. Generic AES_CBC_HMAC_SHA2 Algorithm . . . . . . . . . 23 89 5.2.2.1. AES_CBC_HMAC_SHA2 Encryption . . . . . . . . . . . 23 90 5.2.2.2. AES_CBC_HMAC_SHA2 Decryption . . . . . . . . . . . 24 91 5.2.3. AES_128_CBC_HMAC_SHA_256 . . . . . . . . . . . . . . . 25 92 5.2.4. AES_192_CBC_HMAC_SHA_384 . . . . . . . . . . . . . . . 26 93 5.2.5. AES_256_CBC_HMAC_SHA_512 . . . . . . . . . . . . . . . 26 94 5.2.6. Content Encryption with AES_CBC_HMAC_SHA2 . . . . . . 26 95 5.3. Content Encryption with AES GCM . . . . . . . . . . . . . 27 96 6. Cryptographic Algorithms for Keys . . . . . . . . . . . . . . 27 97 6.1. "kty" (Key Type) Parameter Values . . . . . . . . . . . . 28 98 6.2. Parameters for Elliptic Curve Keys . . . . . . . . . . . . 28 99 6.2.1. Parameters for Elliptic Curve Public Keys . . . . . . 28 100 6.2.1.1. "crv" (Curve) Parameter . . . . . . . . . . . . . 28 101 6.2.1.2. "x" (X Coordinate) Parameter . . . . . . . . . . . 29 102 6.2.1.3. "y" (Y Coordinate) Parameter . . . . . . . . . . . 29 103 6.2.2. Parameters for Elliptic Curve Private Keys . . . . . . 29 104 6.2.2.1. "d" (ECC Private Key) Parameter . . . . . . . . . 29 105 6.3. Parameters for RSA Keys . . . . . . . . . . . . . . . . . 29 106 6.3.1. Parameters for RSA Public Keys . . . . . . . . . . . . 30 107 6.3.1.1. "n" (Modulus) Parameter . . . . . . . . . . . . . 30 108 6.3.1.2. "e" (Exponent) Parameter . . . . . . . . . . . . . 30 109 6.3.2. Parameters for RSA Private Keys . . . . . . . . . . . 30 110 6.3.2.1. "d" (Private Exponent) Parameter . . . . . . . . . 30 111 6.3.2.2. "p" (First Prime Factor) Parameter . . . . . . . . 31 112 6.3.2.3. "q" (Second Prime Factor) Parameter . . . . . . . 31 113 6.3.2.4. "dp" (First Factor CRT Exponent) Parameter . . . . 31 114 6.3.2.5. "dq" (Second Factor CRT Exponent) Parameter . . . 31 115 6.3.2.6. "qi" (First CRT Coefficient) Parameter . . . . . . 31 116 6.3.2.7. "oth" (Other Primes Info) Parameter . . . . . . . 32 117 6.4. Parameters for Symmetric Keys . . . . . . . . . . . . . . 32 118 6.4.1. "k" (Key Value) Parameter . . . . . . . . . . . . . . 33 119 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 33 120 7.1. JSON Web Signature and Encryption Algorithms Registry . . 34 121 7.1.1. Registration Template . . . . . . . . . . . . . . . . 34 122 7.1.2. Initial Registry Contents . . . . . . . . . . . . . . 35 123 7.2. Header Parameter Names Registration . . . . . . . . . . . 41 124 7.2.1. Registry Contents . . . . . . . . . . . . . . . . . . 41 125 7.3. JSON Web Encryption Compression Algorithms Registry . . . 42 126 7.3.1. Registration Template . . . . . . . . . . . . . . . . 42 127 7.3.2. Initial Registry Contents . . . . . . . . . . . . . . 43 128 7.4. JSON Web Key Types Registry . . . . . . . . . . . . . . . 43 129 7.4.1. Registration Template . . . . . . . . . . . . . . . . 43 130 7.4.2. Initial Registry Contents . . . . . . . . . . . . . . 44 131 7.5. JSON Web Key Parameters Registration . . . . . . . . . . . 44 132 7.5.1. Registry Contents . . . . . . . . . . . . . . . . . . 44 133 7.6. JSON Web Key Elliptic Curve Registry . . . . . . . . . . . 47 134 7.6.1. Registration Template . . . . . . . . . . . . . . . . 47 135 7.6.2. Initial Registry Contents . . . . . . . . . . . . . . 48 136 8. Security Considerations . . . . . . . . . . . . . . . . . . . 48 137 8.1. Cryptographic Agility . . . . . . . . . . . . . . . . . . 48 138 8.2. Key Lifetimes . . . . . . . . . . . . . . . . . . . . . . 49 139 8.3. RSAES-PKCS1-v1_5 Security Considerations . . . . . . . . . 49 140 8.4. AES GCM Security Considerations . . . . . . . . . . . . . 49 141 8.5. Unsecured JWS Security Considerations . . . . . . . . . . 49 142 8.6. Denial of Service Attacks . . . . . . . . . . . . . . . . 50 143 8.7. Reusing Key Material when Encrypting Keys . . . . . . . . 50 144 8.8. Password Considerations . . . . . . . . . . . . . . . . . 51 145 8.9. Key Entropy and Random Values . . . . . . . . . . . . . . 51 146 8.10. Differences between Digital Signatures and MACs . . . . . 51 147 8.11. Using Matching Algorithm Strengths . . . . . . . . . . . . 51 148 8.12. Adaptive Chosen-Ciphertext Attacks . . . . . . . . . . . . 52 149 8.13. Timing Attacks . . . . . . . . . . . . . . . . . . . . . . 52 150 8.14. RSA Private Key Representations and Blinding . . . . . . . 52 151 9. Internationalization Considerations . . . . . . . . . . . . . 52 152 10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 52 153 10.1. Normative References . . . . . . . . . . . . . . . . . . . 52 154 10.2. Informative References . . . . . . . . . . . . . . . . . . 54 155 Appendix A. Algorithm Identifier Cross-Reference . . . . . . . . 56 156 A.1. Digital Signature/MAC Algorithm Identifier 157 Cross-Reference . . . . . . . . . . . . . . . . . . . . . 56 158 A.2. Key Management Algorithm Identifier Cross-Reference . . . 57 159 A.3. Content Encryption Algorithm Identifier Cross-Reference . 57 160 Appendix B. Test Cases for AES_CBC_HMAC_SHA2 Algorithms . . . . . 58 161 B.1. Test Cases for AES_128_CBC_HMAC_SHA_256 . . . . . . . . . 59 162 B.2. Test Cases for AES_192_CBC_HMAC_SHA_384 . . . . . . . . . 60 163 B.3. Test Cases for AES_256_CBC_HMAC_SHA_512 . . . . . . . . . 61 164 Appendix C. Example ECDH-ES Key Agreement Computation . . . . . . 62 165 Appendix D. Acknowledgements . . . . . . . . . . . . . . . . . . 64 166 Appendix E. Document History . . . . . . . . . . . . . . . . . . 65 167 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 75 169 1. Introduction 171 The JSON Web Algorithms (JWA) specification registers cryptographic 172 algorithms and identifiers to be used with the JSON Web Signature 173 (JWS) [JWS], JSON Web Encryption (JWE) [JWE], and JSON Web Key (JWK) 174 [JWK] specifications. It defines several IANA registries for these 175 identifiers. All these specifications utilize JavaScript Object 176 Notation (JSON) [RFC7159] based data structures. This specification 177 also describes the semantics and operations that are specific to 178 these algorithms and key types. 180 Registering the algorithms and identifiers here, rather than in the 181 JWS, JWE, and JWK specifications, is intended to allow them to remain 182 unchanged in the face of changes in the set of Required, Recommended, 183 Optional, and Deprecated algorithms over time. This also allows 184 changes to the JWS, JWE, and JWK specifications without changing this 185 document. 187 Names defined by this specification are short because a core goal is 188 for the resulting representations to be compact. 190 1.1. Notational Conventions 192 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 193 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 194 "OPTIONAL" in this document are to be interpreted as described in Key 195 words for use in RFCs to Indicate Requirement Levels [RFC2119]. If 196 these words are used without being spelled in uppercase then they are 197 to be interpreted with their normal natural language meanings. 199 BASE64URL(OCTETS) denotes the base64url encoding of OCTETS, per 200 Section 2. 202 UTF8(STRING) denotes the octets of the UTF-8 [RFC3629] representation 203 of STRING. 205 ASCII(STRING) denotes the octets of the ASCII [USASCII] 206 representation of STRING. 208 The concatenation of two values A and B is denoted as A || B. 210 2. Terminology 212 These terms defined by the JSON Web Signature (JWS) [JWS] 213 specification are incorporated into this specification: "JSON Web 214 Signature (JWS)", "Base64url Encoding", "Header Parameter", "JOSE 215 Header", "JWS Payload", "JWS Protected Header", "JWS Signature", "JWS 216 Signing Input", and "Unsecured JWS". 218 These terms defined by the JSON Web Encryption (JWE) [JWE] 219 specification are incorporated into this specification: "JSON Web 220 Encryption (JWE)", "Additional Authenticated Data (AAD)", 221 "Authentication Tag", "Ciphertext", "Content Encryption Key (CEK)", 222 "Direct Encryption", "Direct Key Agreement", "JWE Authentication 223 Tag", "JWE Ciphertext", "JWE Encrypted Key", "JWE Initialization 224 Vector", "JWE Protected Header", "Key Agreement with Key Wrapping", 225 "Key Encryption", "Key Management Mode", "Key Wrapping", and 226 "Plaintext". 228 These terms defined by the JSON Web Key (JWK) [JWK] specification are 229 incorporated into this specification: "JSON Web Key (JWK)" and "JSON 230 Web Key Set (JWK Set)". 232 3. Cryptographic Algorithms for Digital Signatures and MACs 234 JWS uses cryptographic algorithms to digitally sign or create a 235 Message Authentication Code (MAC) of the contents of the JWS 236 Protected Header and the JWS Payload. 238 3.1. "alg" (Algorithm) Header Parameter Values for JWS 240 The table below is the set of "alg" (algorithm) header parameter 241 values defined by this specification for use with JWS, each of which 242 is explained in more detail in the following sections: 244 +---------------+------------------------------+--------------------+ 245 | alg Parameter | Digital Signature or MAC | Implementation | 246 | Value | Algorithm | Requirements | 247 +---------------+------------------------------+--------------------+ 248 | HS256 | HMAC using SHA-256 | Required | 249 | HS384 | HMAC using SHA-384 | Optional | 250 | HS512 | HMAC using SHA-512 | Optional | 251 | RS256 | RSASSA-PKCS-v1_5 using | Recommended | 252 | | SHA-256 | | 253 | RS384 | RSASSA-PKCS-v1_5 using | Optional | 254 | | SHA-384 | | 255 | RS512 | RSASSA-PKCS-v1_5 using | Optional | 256 | | SHA-512 | | 257 | ES256 | ECDSA using P-256 and | Recommended+ | 258 | | SHA-256 | | 259 | ES384 | ECDSA using P-384 and | Optional | 260 | | SHA-384 | | 261 | ES512 | ECDSA using P-521 and | Optional | 262 | | SHA-512 | | 263 | PS256 | RSASSA-PSS using SHA-256 and | Optional | 264 | | MGF1 with SHA-256 | | 265 | PS384 | RSASSA-PSS using SHA-384 and | Optional | 266 | | MGF1 with SHA-384 | | 267 | PS512 | RSASSA-PSS using SHA-512 and | Optional | 268 | | MGF1 with SHA-512 | | 269 | none | No digital signature or MAC | Optional | 270 | | performed | | 271 +---------------+------------------------------+--------------------+ 273 The use of "+" in the Implementation Requirements indicates that the 274 requirement strength is likely to be increased in a future version of 275 the specification. 277 See Appendix A.1 for a table cross-referencing the JWS digital 278 signature and MAC "alg" (algorithm) values defined in this 279 specification with the equivalent identifiers used by other standards 280 and software packages. 282 3.2. HMAC with SHA-2 Functions 284 Hash-based Message Authentication Codes (HMACs) enable one to use a 285 secret plus a cryptographic hash function to generate a Message 286 Authentication Code (MAC). This can be used to demonstrate that 287 whoever generated the MAC was in possession of the MAC key. The 288 algorithm for implementing and validating HMACs is provided in RFC 289 2104 [RFC2104]. 291 A key of the same size as the hash output (for instance, 256 bits for 292 "HS256") or larger MUST be used with this algorithm. 294 The HMAC SHA-256 MAC is generated per RFC 2104, using SHA-256 as the 295 hash algorithm "H", using the JWS Signing Input as the "text" value, 296 and using the shared key. The HMAC output value is the JWS 297 Signature. 299 The following "alg" (algorithm) Header Parameter values are used to 300 indicate that the JWS Signature is an HMAC value computed using the 301 corresponding algorithm: 303 +---------------------+--------------------+ 304 | alg Parameter Value | MAC Algorithm | 305 +---------------------+--------------------+ 306 | HS256 | HMAC using SHA-256 | 307 | HS384 | HMAC using SHA-384 | 308 | HS512 | HMAC using SHA-512 | 309 +---------------------+--------------------+ 311 The HMAC SHA-256 MAC for a JWS is validated by computing an HMAC 312 value per RFC 2104, using SHA-256 as the hash algorithm "H", using 313 the received JWS Signing Input as the "text" value, and using the 314 shared key. This computed HMAC value is then compared to the result 315 of base64url decoding the received encoded JWS Signature value. 316 Alternatively, the computed HMAC value can be base64url encoded and 317 compared to the received encoded JWS Signature value, as this 318 comparison produces the same result as comparing the unencoded 319 values. In either case, if the values match, the HMAC has been 320 validated. 322 Securing content and validation with the HMAC SHA-384 and HMAC SHA- 323 512 algorithms is performed identically to the procedure for HMAC 324 SHA-256 -- just using the corresponding hash algorithms with 325 correspondingly larger minimum key sizes and result values: 384 bits 326 each for HMAC SHA-384 and 512 bits each for HMAC SHA-512. 328 An example using this algorithm is shown in Appendix A.1 of [JWS]. 330 3.3. Digital Signature with RSASSA-PKCS1-V1_5 332 This section defines the use of the RSASSA-PKCS1-V1_5 digital 333 signature algorithm as defined in Section 8.2 of RFC 3447 [RFC3447] 334 (commonly known as PKCS #1), using SHA-2 [SHS] hash functions. 336 A key of size 2048 bits or larger MUST be used with these algorithms. 338 The RSASSA-PKCS1-V1_5 SHA-256 digital signature is generated as 339 follows: Generate a digital signature of the JWS Signing Input using 340 RSASSA-PKCS1-V1_5-SIGN and the SHA-256 hash function with the desired 341 private key. This is the JWS Signature value. 343 The following "alg" (algorithm) Header Parameter values are used to 344 indicate that the JWS Signature is a digital signature value computed 345 using the corresponding algorithm: 347 +---------------------+--------------------------------+ 348 | alg Parameter Value | Digital Signature Algorithm | 349 +---------------------+--------------------------------+ 350 | RS256 | RSASSA-PKCS-v1_5 using SHA-256 | 351 | RS384 | RSASSA-PKCS-v1_5 using SHA-384 | 352 | RS512 | RSASSA-PKCS-v1_5 using SHA-512 | 353 +---------------------+--------------------------------+ 355 The RSASSA-PKCS1-V1_5 SHA-256 digital signature for a JWS is 356 validated as follows: Submit the JWS Signing Input, the JWS 357 Signature, and the public key corresponding to the private key used 358 by the signer to the RSASSA-PKCS1-V1_5-VERIFY algorithm using SHA-256 359 as the hash function. 361 Signing and validation with the RSASSA-PKCS1-V1_5 SHA-384 and RSASSA- 362 PKCS1-V1_5 SHA-512 algorithms is performed identically to the 363 procedure for RSASSA-PKCS1-V1_5 SHA-256 -- just using the 364 corresponding hash algorithms instead of SHA-256. 366 An example using this algorithm is shown in Appendix A.2 of [JWS]. 368 3.4. Digital Signature with ECDSA 370 The Elliptic Curve Digital Signature Algorithm (ECDSA) [DSS] provides 371 for the use of Elliptic Curve cryptography, which is able to provide 372 equivalent security to RSA cryptography but using shorter key sizes 373 and with greater processing speed for many operations. This means 374 that ECDSA digital signatures will be substantially smaller in terms 375 of length than equivalently strong RSA digital signatures. 377 This specification defines the use of ECDSA with the P-256 curve and 378 the SHA-256 cryptographic hash function, ECDSA with the P-384 curve 379 and the SHA-384 hash function, and ECDSA with the P-521 curve and the 380 SHA-512 hash function. The P-256, P-384, and P-521 curves are 381 defined in [DSS]. 383 The ECDSA P-256 SHA-256 digital signature is generated as follows: 385 1. Generate a digital signature of the JWS Signing Input using ECDSA 386 P-256 SHA-256 with the desired private key. The output will be 387 the pair (R, S), where R and S are 256 bit unsigned integers. 389 2. Turn R and S into octet sequences in big endian order, with each 390 array being be 32 octets long. The octet sequence 391 representations MUST NOT be shortened to omit any leading zero 392 octets contained in the values. 394 3. Concatenate the two octet sequences in the order R and then S. 395 (Note that many ECDSA implementations will directly produce this 396 concatenation as their output.) 398 4. The resulting 64 octet sequence is the JWS Signature value. 400 The following "alg" (algorithm) Header Parameter values are used to 401 indicate that the JWS Signature is a digital signature value computed 402 using the corresponding algorithm: 404 +---------------------+-------------------------------+ 405 | alg Parameter Value | Digital Signature Algorithm | 406 +---------------------+-------------------------------+ 407 | ES256 | ECDSA using P-256 and SHA-256 | 408 | ES384 | ECDSA using P-384 and SHA-384 | 409 | ES512 | ECDSA using P-521 and SHA-512 | 410 +---------------------+-------------------------------+ 412 The ECDSA P-256 SHA-256 digital signature for a JWS is validated as 413 follows: 415 1. The JWS Signature value MUST be a 64 octet sequence. If it is 416 not a 64 octet sequence, the validation has failed. 418 2. Split the 64 octet sequence into two 32 octet sequences. The 419 first octet sequence represents R and the second S. The values R 420 and S are represented as octet sequences using the Integer-to- 421 OctetString Conversion defined in Section 2.3.7 of SEC1 [SEC1] 422 (in big endian octet order). 424 3. Submit the JWS Signing Input R, S and the public key (x, y) to 425 the ECDSA P-256 SHA-256 validator. 427 Signing and validation with the ECDSA P-384 SHA-384 and ECDSA P-521 428 SHA-512 algorithms is performed identically to the procedure for 429 ECDSA P-256 SHA-256 -- just using the corresponding hash algorithms 430 with correspondingly larger result values. For ECDSA P-384 SHA-384, 431 R and S will be 384 bits each, resulting in a 96 octet sequence. For 432 ECDSA P-521 SHA-512, R and S will be 521 bits each, resulting in a 433 132 octet sequence. 435 Examples using these algorithms are shown in Appendices A.3 and A.4 436 of [JWS]. 438 3.5. Digital Signature with RSASSA-PSS 440 This section defines the use of the RSASSA-PSS digital signature 441 algorithm as defined in Section 8.1 of RFC 3447 [RFC3447] with the 442 MGF1 mask generation function and SHA-2 hash functions, always using 443 the same hash function for both the RSASSA-PSS hash function and the 444 MGF1 hash function. The size of the salt value is the same size as 445 the hash function output. All other algorithm parameters use the 446 defaults specified in Section A.2.3 of RFC 3447. 448 A key of size 2048 bits or larger MUST be used with this algorithm. 450 The RSASSA-PSS SHA-256 digital signature is generated as follows: 451 Generate a digital signature of the JWS Signing Input using RSASSA- 452 PSS-SIGN, the SHA-256 hash function, and the MGF1 mask generation 453 function with SHA-256 with the desired private key. This is the JWS 454 signature value. 456 The following "alg" (algorithm) Header Parameter values are used to 457 indicate that the JWS Signature is a digital signature value computed 458 using the corresponding algorithm: 460 +---------------------+---------------------------------------------+ 461 | alg Parameter Value | Digital Signature Algorithm | 462 +---------------------+---------------------------------------------+ 463 | PS256 | RSASSA-PSS using SHA-256 and MGF1 with | 464 | | SHA-256 | 465 | PS384 | RSASSA-PSS using SHA-384 and MGF1 with | 466 | | SHA-384 | 467 | PS512 | RSASSA-PSS using SHA-512 and MGF1 with | 468 | | SHA-512 | 469 +---------------------+---------------------------------------------+ 471 The RSASSA-PSS SHA-256 digital signature for a JWS is validated as 472 follows: Submit the JWS Signing Input, the JWS Signature, and the 473 public key corresponding to the private key used by the signer to the 474 RSASSA-PSS-VERIFY algorithm using SHA-256 as the hash function and 475 using MGF1 as the mask generation function with SHA-256. 477 Signing and validation with the RSASSA-PSS SHA-384 and RSASSA-PSS 478 SHA-512 algorithms is performed identically to the procedure for 479 RSASSA-PSS SHA-256 -- just using the alternative hash algorithm in 480 both roles. 482 3.6. Using the Algorithm "none" 484 JWSs MAY also be created that do not provide integrity protection. 485 Such a JWS is called an Unsecured JWS. An Unsecured JWS MUST use the 486 "alg" value "none", and is formatted identically to other JWSs, but 487 MUST use the empty octet sequence as its JWS Signature value. 488 Receivers MUST verify that the JWS Signature value is the empty octet 489 sequence. See Section 8.5 for security considerations associated 490 with using this algorithm. 492 4. Cryptographic Algorithms for Key Management 494 JWE uses cryptographic algorithms to encrypt or determine the Content 495 Encryption Key (CEK). 497 4.1. "alg" (Algorithm) Header Parameter Values for JWE 499 The table below is the set of "alg" (algorithm) Header Parameter 500 values that are defined by this specification for use with JWE. 501 These algorithms are used to encrypt the CEK, producing the JWE 502 Encrypted Key, or to use key agreement to agree upon the CEK. 504 +-------------------+-----------------+------------+----------------+ 505 | alg Parameter | Key Management | Additional | Implementation | 506 | Value | Algorithm | Header | Requirements | 507 | | | Parameters | | 508 +-------------------+-----------------+------------+----------------+ 509 | RSA1_5 | RSAES-PKCS1-V1_ | (none) | Required | 510 | | 5 | | | 511 | RSA-OAEP | RSAES OAEP | (none) | Optional | 512 | | using default | | | 513 | | parameters | | | 514 | RSA-OAEP-256 | RSAES OAEP | (none) | Optional | 515 | | using SHA-256 | | | 516 | | and MGF1 with | | | 517 | | SHA-256 | | | 518 | A128KW | AES Key Wrap | (none) | Recommended | 519 | | with default | | | 520 | | initial value | | | 521 | | using 128 bit | | | 522 | | key | | | 523 | A192KW | AES Key Wrap | (none) | Optional | 524 | | with default | | | 525 | | initial value | | | 526 | | using 192 bit | | | 527 | | key | | | 528 | A256KW | AES Key Wrap | (none) | Recommended | 529 | | with default | | | 530 | | initial value | | | 531 | | using 256 bit | | | 532 | | key | | | 533 | dir | Direct use of a | (none) | Recommended | 534 | | shared | | | 535 | | symmetric key | | | 536 | | as the CEK | | | 537 | ECDH-ES | Elliptic Curve | "epk", | Recommended+ | 538 | | Diffie-Hellman | "apu", | | 539 | | Ephemeral | "apv" | | 540 | | Static key | | | 541 | | agreement using | | | 542 | | Concat KDF | | | 543 | ECDH-ES+A128KW | ECDH-ES using | "epk", | Recommended | 544 | | Concat KDF and | "apu", | | 545 | | CEK wrapped | "apv" | | 546 | | with "A128KW" | | | 547 | ECDH-ES+A192KW | ECDH-ES using | "epk", | Optional | 548 | | Concat KDF and | "apu", | | 549 | | CEK wrapped | "apv" | | 550 | | with "A192KW" | | | 551 | ECDH-ES+A256KW | ECDH-ES using | "epk", | Recommended | 552 | | Concat KDF and | "apu", | | 553 | | CEK wrapped | "apv" | | 554 | | with "A256KW" | | | 555 | A128GCMKW | Key wrapping | "iv", | Optional | 556 | | with AES GCM | "tag" | | 557 | | using 128 bit | | | 558 | | key | | | 559 | A192GCMKW | Key wrapping | "iv", | Optional | 560 | | with AES GCM | "tag" | | 561 | | using 192 bit | | | 562 | | key | | | 563 | A256GCMKW | Key wrapping | "iv", | Optional | 564 | | with AES GCM | "tag" | | 565 | | using 256 bit | | | 566 | | key | | | 567 | PBES2-HS256+A128K | PBES2 with HMAC | "p2s", | Optional | 568 | W | SHA-256 and | "p2c" | | 569 | | "A128KW" | | | 570 | | wrapping | | | 571 | PBES2-HS384+A192K | PBES2 with HMAC | "p2s", | Optional | 572 | W | SHA-384 and | "p2c" | | 573 | | "A192KW" | | | 574 | | wrapping | | | 575 | PBES2-HS512+A256K | PBES2 with HMAC | "p2s", | Optional | 576 | W | SHA-512 and | "p2c" | | 577 | | "A256KW" | | | 578 | | wrapping | | | 579 +-------------------+-----------------+------------+----------------+ 581 The Additional Header Parameters column indicates what additional 582 Header Parameters are used by the algorithm, beyond "alg", which all 583 use. All but "dir" and "ECDH-ES" also produce a JWE Encrypted Key 584 value. 586 The use of "+" in the Implementation Requirements indicates that the 587 requirement strength is likely to be increased in a future version of 588 the specification. 590 See Appendix A.2 for a table cross-referencing the JWE "alg" 591 (algorithm) values defined in this specification with the equivalent 592 identifiers used by other standards and software packages. 594 4.2. Key Encryption with RSAES-PKCS1-V1_5 596 This section defines the specifics of encrypting a JWE CEK with 597 RSAES-PKCS1-V1_5 [RFC3447]. The "alg" Header Parameter value 598 "RSA1_5" is used for this algorithm. 600 A key of size 2048 bits or larger MUST be used with this algorithm. 602 An example using this algorithm is shown in Appendix A.2 of [JWE]. 604 4.3. Key Encryption with RSAES OAEP 606 This section defines the specifics of encrypting a JWE CEK with RSAES 607 using Optimal Asymmetric Encryption Padding (OAEP) [RFC3447]. Two 608 sets of parameters for using OAEP are defined, which use different 609 hash functions. In the first case, the default parameters specified 610 by RFC 3447 in Section A.2.1 are used. (Those default parameters are 611 the SHA-1 hash function and the MGF1 with SHA-1 mask generation 612 function.) In the second case, the SHA-256 hash function and the 613 MGF1 with SHA-256 mask generation function are used. 615 The following "alg" (algorithm) Header Parameter values are used to 616 indicate that the JWE Encrypted Key is the result of encrypting the 617 CEK using the corresponding algorithm: 619 +---------------------+---------------------------------------------+ 620 | alg Parameter Value | Key Management Algorithm | 621 +---------------------+---------------------------------------------+ 622 | RSA-OAEP | RSAES OAEP using default parameters | 623 | RSA-OAEP-256 | RSAES OAEP using SHA-256 and MGF1 with | 624 | | SHA-256 | 625 +---------------------+---------------------------------------------+ 627 A key of size 2048 bits or larger MUST be used with these algorithms. 629 An example using RSAES OAEP with the default parameters is shown in 630 Appendix A.1 of [JWE]. 632 4.4. Key Wrapping with AES Key Wrap 634 This section defines the specifics of encrypting a JWE CEK with the 635 Advanced Encryption Standard (AES) Key Wrap Algorithm [RFC3394] using 636 the default initial value specified in Section 2.2.3.1. 638 The following "alg" (algorithm) Header Parameter values are used to 639 indicate that the JWE Encrypted Key is the result of encrypting the 640 CEK using the corresponding algorithm and key size: 642 +------------------+------------------------------------------------+ 643 | alg Parameter | Key Management Algorithm | 644 | Value | | 645 +------------------+------------------------------------------------+ 646 | A128KW | AES Key Wrap with default initial value using | 647 | | 128 bit key | 648 | A192KW | AES Key Wrap with default initial value using | 649 | | 192 bit key | 650 | A256KW | AES Key Wrap with default initial value using | 651 | | 256 bit key | 652 +------------------+------------------------------------------------+ 654 An example using this algorithm is shown in Appendix A.3 of [JWE]. 656 4.5. Direct Encryption with a Shared Symmetric Key 658 This section defines the specifics of directly performing symmetric 659 key encryption without performing a key wrapping step. In this case, 660 the shared symmetric key is used directly as the Content Encryption 661 Key (CEK) value for the "enc" algorithm. An empty octet sequence is 662 used as the JWE Encrypted Key value. The "alg" Header Parameter 663 value "dir" is used in this case. 665 Refer to the security considerations on key lifetimes in Section 8.2 666 and AES GCM in Section 8.4 when considering utilizing direct 667 encryption. 669 4.6. Key Agreement with Elliptic Curve Diffie-Hellman Ephemeral Static 670 (ECDH-ES) 672 This section defines the specifics of key agreement with Elliptic 673 Curve Diffie-Hellman Ephemeral Static [RFC6090], in combination with 674 the Concat KDF, as defined in Section 5.8.1 of [NIST.800-56A]. The 675 key agreement result can be used in one of two ways: 677 1. directly as the Content Encryption Key (CEK) for the "enc" 678 algorithm, in the Direct Key Agreement mode, or 680 2. as a symmetric key used to wrap the CEK with the "A128KW", 681 "A192KW", or "A256KW" algorithms, in the Key Agreement with Key 682 Wrapping mode. 684 A new ephemeral public key value MUST be generated for each key 685 agreement operation. 687 In Direct Key Agreement mode, the output of the Concat KDF MUST be a 688 key of the same length as that used by the "enc" algorithm. In this 689 case, the empty octet sequence is used as the JWE Encrypted Key 690 value. The "alg" Header Parameter value "ECDH-ES" is used in the 691 Direct Key Agreement mode. 693 In Key Agreement with Key Wrapping mode, the output of the Concat KDF 694 MUST be a key of the length needed for the specified key wrapping 695 algorithm. In this case, the JWE Encrypted Key is the CEK wrapped 696 with the agreed upon key. 698 The following "alg" (algorithm) Header Parameter values are used to 699 indicate that the JWE Encrypted Key is the result of encrypting the 700 CEK using the result of the key agreement algorithm as the key 701 encryption key for the corresponding key wrapping algorithm: 703 +-------------------+-----------------------------------------------+ 704 | alg Parameter | Key Management Algorithm | 705 | Value | | 706 +-------------------+-----------------------------------------------+ 707 | ECDH-ES+A128KW | ECDH-ES using Concat KDF and CEK wrapped with | 708 | | "A128KW" | 709 | ECDH-ES+A192KW | ECDH-ES using Concat KDF and CEK wrapped with | 710 | | "A192KW" | 711 | ECDH-ES+A256KW | ECDH-ES using Concat KDF and CEK wrapped with | 712 | | "A256KW" | 713 +-------------------+-----------------------------------------------+ 715 4.6.1. Header Parameters Used for ECDH Key Agreement 717 The following Header Parameter names are used for key agreement as 718 defined below. 720 4.6.1.1. "epk" (Ephemeral Public Key) Header Parameter 722 The "epk" (ephemeral public key) value created by the originator for 723 the use in key agreement algorithms. This key is represented as a 724 JSON Web Key [JWK] public key value. It MUST contain only public key 725 parameters and SHOULD contain only the minimum JWK parameters 726 necessary to represent the key; other JWK parameters included can be 727 checked for consistency and honored or can be ignored. This Header 728 Parameter MUST be present and MUST be understood and processed by 729 implementations when these algorithms are used. 731 4.6.1.2. "apu" (Agreement PartyUInfo) Header Parameter 733 The "apu" (agreement PartyUInfo) value for key agreement algorithms 734 using it (such as "ECDH-ES"), represented as a base64url encoded 735 string. When used, the PartyUInfo value contains information about 736 the sender. Use of this Header Parameter is OPTIONAL. This Header 737 Parameter MUST be understood and processed by implementations when 738 these algorithms are used. 740 4.6.1.3. "apv" (Agreement PartyVInfo) Header Parameter 742 The "apv" (agreement PartyVInfo) value for key agreement algorithms 743 using it (such as "ECDH-ES"), represented as a base64url encoded 744 string. When used, the PartyVInfo value contains information about 745 the receiver. Use of this Header Parameter is OPTIONAL. This Header 746 Parameter MUST be understood and processed by implementations when 747 these algorithms are used. 749 4.6.2. Key Derivation for ECDH Key Agreement 751 The key derivation process derives the agreed upon key from the 752 shared secret Z established through the ECDH algorithm, per Section 753 6.2.2.2 of [NIST.800-56A]. 755 Key derivation is performed using the Concat KDF, as defined in 756 Section 5.8.1 of [NIST.800-56A], where the Digest Method is SHA-256. 757 The Concat KDF parameters are set as follows: 759 Z 760 This is set to the representation of the shared secret Z as an 761 octet sequence. 763 keydatalen 764 This is set to the number of bits in the desired output key. For 765 "ECDH-ES", this is length of the key used by the "enc" algorithm. 766 For "ECDH-ES+A128KW", "ECDH-ES+A192KW", and "ECDH-ES+A256KW", this 767 is 128, 192, and 256, respectively. 769 AlgorithmID 770 The AlgorithmID value is of the form Datalen || Data, where Data 771 is a variable-length string of zero or more octets, and Datalen is 772 a fixed-length, big endian 32 bit counter that indicates the 773 length (in octets) of Data. In the Direct Key Agreement case, 774 Data is set to the octets of the UTF-8 representation of the "enc" 775 Header Parameter value. In the Key Agreement with Key Wrapping 776 case, Data is set to the octets of the UTF-8 representation of the 777 "alg" Header Parameter value. 779 PartyUInfo 780 The PartyUInfo value is of the form Datalen || Data, where Data is 781 a variable-length string of zero or more octets, and Datalen is a 782 fixed-length, big endian 32 bit counter that indicates the length 783 (in octets) of Data. If an "apu" (agreement PartyUInfo) Header 784 Parameter is present, Data is set to the result of base64url 785 decoding the "apu" value and Datalen is set to the number of 786 octets in Data. Otherwise, Datalen is set to 0 and Data is set to 787 the empty octet sequence. 789 PartyVInfo 790 The PartyVInfo value is of the form Datalen || Data, where Data is 791 a variable-length string of zero or more octets, and Datalen is a 792 fixed-length, big endian 32 bit counter that indicates the length 793 (in octets) of Data. If an "apv" (agreement PartyVInfo) Header 794 Parameter is present, Data is set to the result of base64url 795 decoding the "apv" value and Datalen is set to the number of 796 octets in Data. Otherwise, Datalen is set to 0 and Data is set to 797 the empty octet sequence. 799 SuppPubInfo 800 This is set to the keydatalen represented as a 32 bit big endian 801 integer. 803 SuppPrivInfo 804 This is set to the empty octet sequence. 806 Applications need to specify how the "apu" and "apv" parameters are 807 used for that application. The "apu" and "apv" values MUST be 808 distinct, when used. Applications wishing to conform to 809 [NIST.800-56A] need to provide values that meet the requirements of 810 that document, e.g., by using values that identify the sender and 811 recipient. Alternatively, applications MAY conduct key derivation in 812 a manner similar to The Diffie-Hellman Key Agreement Method 813 [RFC2631]: In that case, the "apu" field MAY either be omitted or 814 represent a random 512-bit value (analogous to PartyAInfo in 815 Ephemeral-Static mode in RFC 2631) and the "apv" field SHOULD NOT be 816 present. 818 See Appendix C for an example key agreement computation using this 819 method. 821 4.7. Key Encryption with AES GCM 823 This section defines the specifics of encrypting a JWE Content 824 Encryption Key (CEK) with Advanced Encryption Standard (AES) in 825 Galois/Counter Mode (GCM) [AES, NIST.800-38D]. 827 Use of an Initialization Vector of size 96 bits is REQUIRED with this 828 algorithm. The Initialization Vector is represented in base64url 829 encoded form as the "iv" (initialization vector) Header Parameter 830 value. 832 The Additional Authenticated Data value used is the empty octet 833 string. 835 The requested size of the Authentication Tag output MUST be 128 bits, 836 regardless of the key size. 838 The JWE Encrypted Key value is the Ciphertext output. 840 The Authentication Tag output is represented in base64url encoded 841 form as the "tag" (authentication tag) Header Parameter value. 843 The following "alg" (algorithm) Header Parameter values are used to 844 indicate that the JWE Encrypted Key is the result of encrypting the 845 CEK using the corresponding algorithm and key size: 847 +---------------------+---------------------------------------------+ 848 | alg Parameter Value | Key Management Algorithm | 849 +---------------------+---------------------------------------------+ 850 | A128GCMKW | Key wrapping with AES GCM using 128 bit key | 851 | A192GCMKW | Key wrapping with AES GCM using 192 bit key | 852 | A256GCMKW | Key wrapping with AES GCM using 256 bit key | 853 +---------------------+---------------------------------------------+ 855 4.7.1. Header Parameters Used for AES GCM Key Encryption 857 The following Header Parameters are used for AES GCM key encryption. 859 4.7.1.1. "iv" (Initialization Vector) Header Parameter 861 The "iv" (initialization vector) Header Parameter value is the 862 base64url encoded representation of the Initialization Vector value 863 used for the key encryption operation. This Header Parameter MUST be 864 present and MUST be understood and processed by implementations when 865 these algorithms are used. 867 4.7.1.2. "tag" (Authentication Tag) Header Parameter 869 The "tag" (authentication tag) Header Parameter value is the 870 base64url encoded representation of the Authentication Tag value 871 resulting from the key encryption operation. This Header Parameter 872 MUST be present and MUST be understood and processed by 873 implementations when these algorithms are used. 875 4.8. Key Encryption with PBES2 877 This section defines the specifics of performing password-based 878 encryption of a JWE CEK, by first deriving a key encryption key from 879 a user-supplied password using PBES2 schemes as specified in Section 880 6.2 of [RFC2898], then by encrypting the JWE CEK using the derived 881 key. 883 These algorithms use HMAC SHA-2 algorithms as the Pseudo-Random 884 Function (PRF) for the PBKDF2 key derivation and AES Key Wrap 885 [RFC3394] for the encryption scheme. The PBES2 password input is an 886 octet sequence; if the password to be used is represented as a text 887 string rather than an octet sequence, the UTF-8 encoding of the text 888 string MUST be used as the octet sequence. The salt parameter MUST 889 be computed from the "p2s" (PBES2 salt input) Header Parameter value 890 and the "alg" (algorithm) Header Parameter value as specified in the 891 "p2s" definition below. The iteration count parameter MUST be 892 provided as the "p2c" Header Parameter value. The algorithms 893 respectively use HMAC SHA-256, HMAC SHA-384, and HMAC SHA-512 as the 894 PRF and use 128, 192, and 256 bit AES Key Wrap keys. Their derived- 895 key lengths respectively are 16, 24, and 32 octets. 897 The following "alg" (algorithm) Header Parameter values are used to 898 indicate that the JWE Encrypted Key is the result of encrypting the 899 CEK using the result of the corresponding password-based encryption 900 algorithm as the key encryption key for the corresponding key 901 wrapping algorithm: 903 +---------------------+---------------------------------------------+ 904 | alg Parameter Value | Key Management Algorithm | 905 +---------------------+---------------------------------------------+ 906 | PBES2-HS256+A128KW | PBES2 with HMAC SHA-256 and "A128KW" | 907 | | wrapping | 908 | PBES2-HS384+A192KW | PBES2 with HMAC SHA-384 and "A192KW" | 909 | | wrapping | 910 | PBES2-HS512+A256KW | PBES2 with HMAC SHA-512 and "A256KW" | 911 | | wrapping | 912 +---------------------+---------------------------------------------+ 914 See Appendix C of JSON Web Key (JWK) [JWK] for an example key 915 encryption computation using "PBES2-HS256+A128KW". 917 4.8.1. Header Parameters Used for PBES2 Key Encryption 919 The following Header Parameters are used for Key Encryption with 920 PBES2. 922 4.8.1.1. "p2s" (PBES2 salt input) Parameter 924 The "p2s" (PBES2 salt input) Header Parameter encodes a Salt Input 925 value, which is used as part of the PBKDF2 salt value. The "p2s" 926 value is BASE64URL(Salt Input). This Header Parameter MUST be 927 present and MUST be understood and processed by implementations when 928 these algorithms are used. 930 The salt expands the possible keys that can be derived from a given 931 password. A Salt Input value containing 8 or more octets MUST be 932 used. A new Salt Input value MUST be generated randomly for every 933 encryption operation; see RFC 4086 [RFC4086] for considerations on 934 generating random values. The salt value used is (UTF8(Alg) || 0x00 935 || Salt Input), where Alg is the "alg" Header Parameter value. 937 4.8.1.2. "p2c" (PBES2 count) Parameter 939 The "p2c" (PBES2 count) Header Parameter contains the PBKDF2 940 iteration count, represented as a positive integer. This Header 941 Parameter MUST be present and MUST be understood and processed by 942 implementations when these algorithms are used. 944 The iteration count adds computational expense, ideally compounded by 945 the possible range of keys introduced by the salt. A minimum 946 iteration count of 1000 is RECOMMENDED. 948 5. Cryptographic Algorithms for Content Encryption 950 JWE uses cryptographic algorithms to encrypt and integrity protect 951 the Plaintext and to also integrity protect additional authenticated 952 data. 954 5.1. "enc" (Encryption Algorithm) Header Parameter Values for JWE 956 The table below is the set of "enc" (encryption algorithm) Header 957 Parameter values that are defined by this specification for use with 958 JWE. 960 +-------------+------------------------+------------+---------------+ 961 | enc | Content Encryption | Additional | Implementatio | 962 | Parameter | Algorithm | Header | nRequirements | 963 | Value | | Parameters | | 964 +-------------+------------------------+------------+---------------+ 965 | A128CBC-HS2 | AES_128_CBC_HMAC_SHA_2 | (none) | Required | 966 | 56 | 56 authenticated | | | 967 | | encryption algorithm, | | | 968 | | as defined in | | | 969 | | Section 5.2.3 | | | 970 | A192CBC-HS3 | AES_192_CBC_HMAC_SHA_3 | (none) | Optional | 971 | 84 | 84 authenticated | | | 972 | | encryption algorithm, | | | 973 | | as defined in | | | 974 | | Section 5.2.4 | | | 975 | A256CBC-HS5 | AES_256_CBC_HMAC_SHA_5 | (none) | Required | 976 | 12 | 12 authenticated | | | 977 | | encryption algorithm, | | | 978 | | as defined in | | | 979 | | Section 5.2.5 | | | 980 | A128GCM | AES GCM using 128 bit | (none) | Recommended | 981 | | key | | | 982 | A192GCM | AES GCM using 192 bit | (none) | Optional | 983 | | key | | | 984 | A256GCM | AES GCM using 256 bit | (none) | Recommended | 985 | | key | | | 986 +-------------+------------------------+------------+---------------+ 988 The Additional Header Parameters column indicates what additional 989 Header Parameters are used by the algorithm, beyond "enc", which all 990 use. All also use a JWE Initialization Vector value and produce JWE 991 Ciphertext and JWE Authentication Tag values. 993 See Appendix A.3 for a table cross-referencing the JWE "enc" 994 (encryption algorithm) values defined in this specification with the 995 equivalent identifiers used by other standards and software packages. 997 5.2. AES_CBC_HMAC_SHA2 Algorithms 999 This section defines a family of authenticated encryption algorithms 1000 built using a composition of Advanced Encryption Standard (AES) in 1001 Cipher Block Chaining (CBC) mode with PKCS #7 padding [AES, 1002 NIST.800-38A] operations and HMAC [RFC2104, SHS] operations. This 1003 algorithm family is called AES_CBC_HMAC_SHA2. It also defines three 1004 instances of this family, the first using 128 bit CBC keys and HMAC 1005 SHA-256, the second using 192 bit CBC keys and HMAC SHA-384, and the 1006 third using 256 bit CBC keys and HMAC SHA-512. Test cases for these 1007 algorithms can be found in Appendix B. 1009 These algorithms are based upon Authenticated Encryption with AES-CBC 1010 and HMAC-SHA [I-D.mcgrew-aead-aes-cbc-hmac-sha2], performing the same 1011 cryptographic computations, but with the Initialization Vector and 1012 Authentication Tag values remaining separate, rather than being 1013 concatenated with the Ciphertext value in the output representation. 1014 This option is discussed in Appendix B of that specification. This 1015 algorithm family is a generalization of the algorithm family in 1016 [I-D.mcgrew-aead-aes-cbc-hmac-sha2], and can be used to implement 1017 those algorithms. 1019 5.2.1. Conventions Used in Defining AES_CBC_HMAC_SHA2 1021 We use the following notational conventions. 1023 CBC-PKCS5-ENC(X, P) denotes the AES CBC encryption of P using PKCS 1024 #7 padding using the cipher with the key X. 1026 MAC(Y, M) denotes the application of the Message Authentication 1027 Code (MAC) to the message M, using the key Y. 1029 5.2.2. Generic AES_CBC_HMAC_SHA2 Algorithm 1031 This section defines AES_CBC_HMAC_SHA2 in a manner that is 1032 independent of the AES CBC key size or hash function to be used. 1033 Section 5.2.2.1 and Section 5.2.2.2 define the generic encryption and 1034 decryption algorithms. Sections 5.2.3 through 5.2.5 define instances 1035 of AES_CBC_HMAC_SHA2 that specify those details. 1037 5.2.2.1. AES_CBC_HMAC_SHA2 Encryption 1039 The authenticated encryption algorithm takes as input four octet 1040 strings: a secret key K, a plaintext P, additional authenticated data 1041 A, and an initialization vector IV. The authenticated ciphertext 1042 value E and the authentication tag value T are provided as outputs. 1043 The data in the plaintext are encrypted and authenticated, and the 1044 additional authenticated data are authenticated, but not encrypted. 1046 The encryption process is as follows, or uses an equivalent set of 1047 steps: 1049 1. The secondary keys MAC_KEY and ENC_KEY are generated from the 1050 input key K as follows. Each of these two keys is an octet 1051 string. 1053 MAC_KEY consists of the initial MAC_KEY_LEN octets of K, in 1054 order. 1056 ENC_KEY consists of the final ENC_KEY_LEN octets of K, in 1057 order. 1059 Here we denote the number of octets in the MAC_KEY as 1060 MAC_KEY_LEN, and the number of octets in ENC_KEY as ENC_KEY_LEN; 1061 the values of these parameters are specified by the Authenticated 1062 Encryption algorithms in Sections 5.2.3 through 5.2.5. The 1063 number of octets in the input key K MUST be the sum of 1064 MAC_KEY_LEN and ENC_KEY_LEN. When generating the secondary keys 1065 from K, MAC_KEY and ENC_KEY MUST NOT overlap. Note that the MAC 1066 key comes before the encryption key in the input key K; this is 1067 in the opposite order of the algorithm names in the identifier 1068 "AES_CBC_HMAC_SHA2". 1070 2. The Initialization Vector (IV) used is a 128 bit value generated 1071 randomly or pseudorandomly for use in the cipher. 1073 3. The plaintext is CBC encrypted using PKCS #7 padding using 1074 ENC_KEY as the key, and the IV. We denote the ciphertext output 1075 from this step as E. 1077 4. The octet string AL is equal to the number of bits in the 1078 additional authenticated data A expressed as a 64-bit unsigned 1079 big endian integer. 1081 5. A message authentication tag T is computed by applying HMAC 1082 [RFC2104] to the following data, in order: 1084 the additional authenticated data A, 1086 the initialization vector IV, 1088 the ciphertext E computed in the previous step, and 1090 the octet string AL defined above. 1092 The string MAC_KEY is used as the MAC key. We denote the output 1093 of the MAC computed in this step as M. The first T_LEN bits of M 1094 are used as T. 1096 6. The Ciphertext E and the Authentication Tag T are returned as the 1097 outputs of the authenticated encryption. 1099 The encryption process can be illustrated as follows. Here K, P, A, 1100 IV, and E denote the key, plaintext, additional authenticated data, 1101 initialization vector, and ciphertext, respectively. 1103 MAC_KEY = initial MAC_KEY_LEN octets of K, 1105 ENC_KEY = final ENC_KEY_LEN octets of K, 1107 E = CBC-PKCS5-ENC(ENC_KEY, P), 1109 M = MAC(MAC_KEY, A || IV || E || AL), 1111 T = initial T_LEN octets of M. 1113 5.2.2.2. AES_CBC_HMAC_SHA2 Decryption 1115 The authenticated decryption operation has five inputs: K, A, IV, E, 1116 and T as defined above. It has only a single output, either a 1117 plaintext value P or a special symbol FAIL that indicates that the 1118 inputs are not authentic. The authenticated decryption algorithm is 1119 as follows, or uses an equivalent set of steps: 1121 1. The secondary keys MAC_KEY and ENC_KEY are generated from the 1122 input key K as in Step 1 of Section 5.2.2.1. 1124 2. The integrity and authenticity of A and E are checked by 1125 computing an HMAC with the inputs as in Step 5 of 1126 Section 5.2.2.1. The value T, from the previous step, is 1127 compared to the first MAC_KEY length bits of the HMAC output. If 1128 those values are identical, then A and E are considered valid, 1129 and processing is continued. Otherwise, all of the data used in 1130 the MAC validation are discarded, and the Authenticated 1131 Encryption decryption operation returns an indication that it 1132 failed, and the operation halts. (But see Section 11.5 of [JWE] 1133 for security considerations on thwarting timing attacks.) 1135 3. The value E is decrypted and the PKCS #7 padding is removed. The 1136 value IV is used as the initialization vector. The value ENC_KEY 1137 is used as the decryption key. 1139 4. The plaintext value is returned. 1141 5.2.3. AES_128_CBC_HMAC_SHA_256 1143 This algorithm is a concrete instantiation of the generic 1144 AES_CBC_HMAC_SHA2 algorithm above. It uses the HMAC message 1145 authentication code [RFC2104] with the SHA-256 hash function [SHS] to 1146 provide message authentication, with the HMAC output truncated to 128 1147 bits, corresponding to the HMAC-SHA-256-128 algorithm defined in 1148 [RFC4868]. For encryption, it uses AES in the Cipher Block Chaining 1149 (CBC) mode of operation as defined in Section 6.2 of [NIST.800-38A], 1150 with PKCS #7 padding and a 128 bit initialization vector (IV) value. 1152 The AES_CBC_HMAC_SHA2 parameters specific to AES_128_CBC_HMAC_SHA_256 1153 are: 1155 The input key K is 32 octets long. 1157 ENC_KEY_LEN is 16 octets. 1159 MAC_KEY_LEN is 16 octets. 1161 The SHA-256 hash algorithm is used for the HMAC. 1163 The HMAC-SHA-256 output is truncated to T_LEN=16 octets, by 1164 stripping off the final 16 octets. 1166 5.2.4. AES_192_CBC_HMAC_SHA_384 1168 AES_192_CBC_HMAC_SHA_384 is based on AES_128_CBC_HMAC_SHA_256, but 1169 with the following differences: 1171 The input key K is 48 octets long instead of 32. 1173 ENC_KEY_LEN is 24 octets instead of 16. 1175 MAC_KEY_LEN is 24 octets instead of 16. 1177 SHA-384 is used for the HMAC instead of SHA-256. 1179 The HMAC SHA-384 value is truncated to T_LEN=24 octets instead of 1180 16. 1182 5.2.5. AES_256_CBC_HMAC_SHA_512 1184 AES_256_CBC_HMAC_SHA_512 is based on AES_128_CBC_HMAC_SHA_256, but 1185 with the following differences: 1187 The input key K is 64 octets long instead of 32. 1189 ENC_KEY_LEN is 32 octets instead of 16. 1191 MAC_KEY_LEN is 32 octets instead of 16. 1193 SHA-512 is used for the HMAC instead of SHA-256. 1195 The HMAC SHA-512 value is truncated to T_LEN=32 octets instead of 1196 16. 1198 5.2.6. Content Encryption with AES_CBC_HMAC_SHA2 1200 This section defines the specifics of performing authenticated 1201 encryption with the AES_CBC_HMAC_SHA2 algorithms. 1203 The CEK is used as the secret key K. 1205 The following "enc" (encryption algorithm) Header Parameter values 1206 are used to indicate that the JWE Ciphertext and JWE Authentication 1207 Tag values have been computed using the corresponding algorithm: 1209 +---------------+---------------------------------------------------+ 1210 | enc Parameter | Content Encryption Algorithm | 1211 | Value | | 1212 +---------------+---------------------------------------------------+ 1213 | A128CBC-HS256 | AES_128_CBC_HMAC_SHA_256 authenticated encryption | 1214 | | algorithm, as defined in Section 5.2.3 | 1215 | A192CBC-HS384 | AES_192_CBC_HMAC_SHA_384 authenticated encryption | 1216 | | algorithm, as defined in Section 5.2.4 | 1217 | A256CBC-HS512 | AES_256_CBC_HMAC_SHA_512 authenticated encryption | 1218 | | algorithm, as defined in Section 5.2.5 | 1219 +---------------+---------------------------------------------------+ 1221 5.3. Content Encryption with AES GCM 1223 This section defines the specifics of performing authenticated 1224 encryption with Advanced Encryption Standard (AES) in Galois/Counter 1225 Mode (GCM) [AES, NIST.800-38D]. 1227 The CEK is used as the encryption key. 1229 Use of an initialization vector of size 96 bits is REQUIRED with this 1230 algorithm. 1232 The requested size of the Authentication Tag output MUST be 128 bits, 1233 regardless of the key size. 1235 The following "enc" (encryption algorithm) Header Parameter values 1236 are used to indicate that the JWE Ciphertext and JWE Authentication 1237 Tag values have been computed using the corresponding algorithm and 1238 key size: 1240 +---------------------+------------------------------+ 1241 | enc Parameter Value | Content Encryption Algorithm | 1242 +---------------------+------------------------------+ 1243 | A128GCM | AES GCM using 128 bit key | 1244 | A192GCM | AES GCM using 192 bit key | 1245 | A256GCM | AES GCM using 256 bit key | 1246 +---------------------+------------------------------+ 1248 An example using this algorithm is shown in Appendix A.1 of [JWE]. 1250 6. Cryptographic Algorithms for Keys 1252 A JSON Web Key (JWK) [JWK] is a JSON data structure that represents a 1253 cryptographic key. These keys can be either asymmetric or symmetric. 1254 They can hold both public and private information about the key. 1255 This section defines the parameters for keys using the algorithms 1256 specified by this document. 1258 6.1. "kty" (Key Type) Parameter Values 1260 The table below is the set of "kty" (key type) parameter values that 1261 are defined by this specification for use in JWKs. 1263 +--------------+--------------------------------+-------------------+ 1264 | kty | Key Type | Implementation | 1265 | Parameter | | Requirements | 1266 | Value | | | 1267 +--------------+--------------------------------+-------------------+ 1268 | EC | Elliptic Curve [DSS] | Recommended+ | 1269 | RSA | RSA [RFC3447] | Required | 1270 | oct | Octet sequence (used to | Required | 1271 | | represent symmetric keys) | | 1272 +--------------+--------------------------------+-------------------+ 1274 The use of "+" in the Implementation Requirements indicates that the 1275 requirement strength is likely to be increased in a future version of 1276 the specification. 1278 6.2. Parameters for Elliptic Curve Keys 1280 JWKs can represent Elliptic Curve [DSS] keys. In this case, the 1281 "kty" member value MUST be "EC". 1283 6.2.1. Parameters for Elliptic Curve Public Keys 1285 An elliptic curve public key is represented by a pair of coordinates 1286 drawn from a finite field, which together define a point on an 1287 elliptic curve. The following members MUST be present for elliptic 1288 curve public keys: 1290 o "crv" 1291 o "x" 1292 o "y" 1294 SEC1 [SEC1] point compression is not supported for any values. 1296 6.2.1.1. "crv" (Curve) Parameter 1298 The "crv" (curve) member identifies the cryptographic curve used with 1299 the key. Curve values from [DSS] used by this specification are: 1301 o "P-256" 1302 o "P-384" 1303 o "P-521" 1305 These values are registered in the IANA JSON Web Key Elliptic Curve 1306 registry defined in Section 7.6. Additional "crv" values can be 1307 registered by other specifications. Additional "crv" values MAY be 1308 used, provided they are understood by implementations using that 1309 Elliptic Curve key. The "crv" value is a case-sensitive string. 1311 6.2.1.2. "x" (X Coordinate) Parameter 1313 The "x" (x coordinate) member contains the x coordinate for the 1314 elliptic curve point. It is represented as the base64url encoding of 1315 the octet string representation of the coordinate, as defined in 1316 Section 2.3.5 of SEC1 [SEC1]. The length of this octet string MUST 1317 be the full size of a coordinate for the curve specified in the "crv" 1318 parameter. For example, if the value of "crv" is "P-521", the octet 1319 string must be 66 octets long. 1321 6.2.1.3. "y" (Y Coordinate) Parameter 1323 The "y" (y coordinate) member contains the y coordinate for the 1324 elliptic curve point. It is represented as the base64url encoding of 1325 the octet string representation of the coordinate, as defined in 1326 Section 2.3.5 of SEC1 [SEC1]. The length of this octet string MUST 1327 be the full size of a coordinate for the curve specified in the "crv" 1328 parameter. For example, if the value of "crv" is "P-521", the octet 1329 string must be 66 octets long. 1331 6.2.2. Parameters for Elliptic Curve Private Keys 1333 In addition to the members used to represent Elliptic Curve public 1334 keys, the following member MUST be present to represent Elliptic 1335 Curve private keys. 1337 6.2.2.1. "d" (ECC Private Key) Parameter 1339 The "d" (ECC private key) member contains the Elliptic Curve private 1340 key value. It is represented as the base64url encoding of the octet 1341 string representation of the private key value, as defined in 1342 Sections C.4 and 2.3.7 of SEC1 [SEC1]. The length of this octet 1343 string MUST be ceiling(log-base-2(n)/8) octets (where n is the order 1344 of the curve). 1346 6.3. Parameters for RSA Keys 1348 JWKs can represent RSA [RFC3447] keys. In this case, the "kty" 1349 member value MUST be "RSA". 1351 6.3.1. Parameters for RSA Public Keys 1353 The following members MUST be present for RSA public keys. 1355 6.3.1.1. "n" (Modulus) Parameter 1357 The "n" (modulus) member contains the modulus value for the RSA 1358 public key. It is represented as the base64url encoding of the 1359 value's unsigned big endian representation as an octet sequence. The 1360 octet sequence MUST utilize the minimum number of octets to represent 1361 the value. 1363 Note that implementers have found that some cryptographic libraries 1364 prefix an extra zero-valued octet to the modulus representations they 1365 return, for instance, returning 257 octets for a 2048 bit key, rather 1366 than 256. Implementations using such libraries will need to take 1367 care to omit the extra octet from the base64url encoded 1368 representation. 1370 6.3.1.2. "e" (Exponent) Parameter 1372 The "e" (exponent) member contains the exponent value for the RSA 1373 public key. It is represented as the base64url encoding of the 1374 value's unsigned big endian representation as an octet sequence. The 1375 octet sequence MUST utilize the minimum number of octets to represent 1376 the value. For instance, when representing the value 65537, the 1377 octet sequence to be base64url encoded MUST consist of the three 1378 octets [1, 0, 1]. 1380 6.3.2. Parameters for RSA Private Keys 1382 In addition to the members used to represent RSA public keys, the 1383 following members are used to represent RSA private keys. The 1384 parameter "d" is REQUIRED for RSA private keys. The others enable 1385 optimizations and SHOULD be included by producers of JWKs 1386 representing RSA private keys. If the producer includes any of the 1387 other private key parameters, then all of the others MUST be present, 1388 with the exception of "oth", which MUST only be present when more 1389 than two prime factors were used. The consumer of a JWK MAY choose 1390 to accept an RSA private key that does not contain a complete set of 1391 the private key parameters other than "d", including JWKs in which 1392 "d" is the only RSA private key parameter included. 1394 6.3.2.1. "d" (Private Exponent) Parameter 1396 The "d" (private exponent) member contains the private exponent value 1397 for the RSA private key. It is represented as the base64url encoding 1398 of the value's unsigned big endian representation as an octet 1399 sequence. The octet sequence MUST utilize the minimum number of 1400 octets to represent the value. 1402 6.3.2.2. "p" (First Prime Factor) Parameter 1404 The "p" (first prime factor) member contains the first prime factor, 1405 a positive integer. It is represented as the base64url encoding of 1406 the value's unsigned big endian representation as an octet sequence. 1407 The octet sequence MUST utilize the minimum number of octets to 1408 represent the value. 1410 6.3.2.3. "q" (Second Prime Factor) Parameter 1412 The "q" (second prime factor) member contains the second prime 1413 factor, a positive integer. It is represented as the base64url 1414 encoding of the value's unsigned big endian representation as an 1415 octet sequence. The octet sequence MUST utilize the minimum number 1416 of octets to represent the value. 1418 6.3.2.4. "dp" (First Factor CRT Exponent) Parameter 1420 The "dp" (first factor CRT exponent) member contains the Chinese 1421 Remainder Theorem (CRT) exponent of the first factor, a positive 1422 integer. It is represented as the base64url encoding of the value's 1423 unsigned big endian representation as an octet sequence. The octet 1424 sequence MUST utilize the minimum number of octets to represent the 1425 value. 1427 6.3.2.5. "dq" (Second Factor CRT Exponent) Parameter 1429 The "dq" (second factor CRT exponent) member contains the Chinese 1430 Remainder Theorem (CRT) exponent of the second factor, a positive 1431 integer. It is represented as the base64url encoding of the value's 1432 unsigned big endian representation as an octet sequence. The octet 1433 sequence MUST utilize the minimum number of octets to represent the 1434 value. 1436 6.3.2.6. "qi" (First CRT Coefficient) Parameter 1438 The "dp" (first CRT coefficient) member contains the Chinese 1439 Remainder Theorem (CRT) coefficient of the second factor, a positive 1440 integer. It is represented as the base64url encoding of the value's 1441 unsigned big endian representation as an octet sequence. The octet 1442 sequence MUST utilize the minimum number of octets to represent the 1443 value. 1445 6.3.2.7. "oth" (Other Primes Info) Parameter 1447 The "oth" (other primes info) member contains an array of information 1448 about any third and subsequent primes, should they exist. When only 1449 two primes have been used (the normal case), this parameter MUST be 1450 omitted. When three or more primes have been used, the number of 1451 array elements MUST be the number of primes used minus two. Each 1452 array element MUST be an object with the following members: 1454 6.3.2.7.1. "r" (Prime Factor) 1456 The "r" (prime factor) parameter within an "oth" array member 1457 represents the value of a subsequent prime factor, a positive 1458 integer. It is represented as the base64url encoding of the value's 1459 unsigned big endian representation as an octet sequence. The octet 1460 sequence MUST utilize the minimum number of octets to represent the 1461 value. 1463 6.3.2.7.2. "d" (Factor CRT Exponent) 1465 The "d" (Factor CRT Exponent) parameter within an "oth" array member 1466 represents the CRT exponent of the corresponding prime factor, a 1467 positive integer. It is represented as the base64url encoding of the 1468 value's unsigned big endian representation as an octet sequence. The 1469 octet sequence MUST utilize the minimum number of octets to represent 1470 the value. 1472 6.3.2.7.3. "t" (Factor CRT Coefficient) 1474 The "t" (factor CRT coefficient) parameter within an "oth" array 1475 member represents the CRT coefficient of the corresponding prime 1476 factor, a positive integer. It is represented as the base64url 1477 encoding of the value's unsigned big endian representation as an 1478 octet sequence. The octet sequence MUST utilize the minimum number 1479 of octets to represent the value. 1481 6.4. Parameters for Symmetric Keys 1483 When the JWK "kty" member value is "oct" (octet sequence), the member 1484 "k" is used to represent a symmetric key (or another key whose value 1485 is a single octet sequence). An "alg" member SHOULD also be present 1486 to identify the algorithm intended to be used with the key, unless 1487 the application uses another means or convention to determine the 1488 algorithm used. 1490 6.4.1. "k" (Key Value) Parameter 1492 The "k" (key value) member contains the value of the symmetric (or 1493 other single-valued) key. It is represented as the base64url 1494 encoding of the octet sequence containing the key value. 1496 7. IANA Considerations 1498 The following registration procedure is used for all the registries 1499 established by this specification. 1501 Values are registered on a Specification Required [RFC5226] basis 1502 after a three-week review period on the [TBD]@ietf.org mailing list, 1503 on the advice of one or more Designated Experts. However, to allow 1504 for the allocation of values prior to publication, the Designated 1505 Expert(s) may approve registration once they are satisfied that such 1506 a specification will be published. 1508 Registration requests must be sent to the [TBD]@ietf.org mailing list 1509 for review and comment, with an appropriate subject (e.g., "Request 1510 for access token type: example"). [[ Note to the RFC Editor: The name 1511 of the mailing list should be determined in consultation with the 1512 IESG and IANA. Suggested name: jose-reg-review. ]] 1514 Within the review period, the Designated Expert(s) will either 1515 approve or deny the registration request, communicating this decision 1516 to the review list and IANA. Denials should include an explanation 1517 and, if applicable, suggestions as to how to make the request 1518 successful. Registration requests that are undetermined for a period 1519 longer than 21 days can be brought to the IESG's attention (using the 1520 iesg@iesg.org mailing list) for resolution. 1522 Criteria that should be applied by the Designated Expert(s) includes 1523 determining whether the proposed registration duplicates existing 1524 functionality, determining whether it is likely to be of general 1525 applicability or whether it is useful only for a single application, 1526 and whether the registration makes sense. 1528 IANA must only accept registry updates from the Designated Expert(s) 1529 and should direct all requests for registration to the review mailing 1530 list. 1532 It is suggested that multiple Designated Experts be appointed who are 1533 able to represent the perspectives of different applications using 1534 this specification, in order to enable broadly-informed review of 1535 registration decisions. In cases where a registration decision could 1536 be perceived as creating a conflict of interest for a particular 1537 Expert, that Expert should defer to the judgment of the other 1538 Expert(s). 1540 7.1. JSON Web Signature and Encryption Algorithms Registry 1542 This specification establishes the IANA JSON Web Signature and 1543 Encryption Algorithms registry for values of the JWS and JWE "alg" 1544 (algorithm) and "enc" (encryption algorithm) Header Parameters. The 1545 registry records the algorithm name, the algorithm usage locations, 1546 implementation requirements, and a reference to the specification 1547 that defines it. The same algorithm name can be registered multiple 1548 times, provided that the sets of usage locations are disjoint. 1550 It is suggested that when algorithms can use keys of different 1551 lengths, that the length of the key be included in the algorithm 1552 name. This allows readers of the JSON text to easily make security 1553 consideration decisions. 1555 The implementation requirements of an algorithm MAY be changed over 1556 time by the Designated Experts(s) as the cryptographic landscape 1557 evolves, for instance, to change the status of an algorithm to 1558 Deprecated, or to change the status of an algorithm from Optional to 1559 Recommended+ or Required. Changes of implementation requirements are 1560 only permitted on a Specification Required basis, with the new 1561 specification defining the revised implementation requirements level. 1563 7.1.1. Registration Template 1565 Algorithm Name: 1566 The name requested (e.g., "example"). This name is case- 1567 sensitive. Names may not match other registered names in a case- 1568 insensitive manner unless the Designated Expert(s) state that 1569 there is a compelling reason to allow an exception in this 1570 particular case. 1572 Algorithm Description: 1573 Brief description of the Algorithm (e.g., "Example description"). 1575 Algorithm Usage Location(s): 1576 The algorithm usage location. This must be one or more of the 1577 values "alg" or "enc" if the algorithm is to be used with JWS or 1578 JWE. The value "JWK" is used if the algorithm identifier will be 1579 used as a JWK "alg" member value, but will not be used with JWS or 1580 JWE; this could be the case, for instance, for non-authenticated 1581 encryption algorithms. Other values may be used with the approval 1582 of a Designated Expert. 1584 JOSE Implementation Requirements: 1585 The algorithm implementation requirements for JWS and JWE, which 1586 must be one the words Required, Recommended, Optional, Deprecated, 1587 or Prohibited. Optionally, the word can be followed by a "+" or 1588 "-". The use of "+" indicates that the requirement strength is 1589 likely to be increased in a future version of the specification. 1590 The use of "-" indicates that the requirement strength is likely 1591 to be decreased in a future version of the specification. Any 1592 identifiers registered for non-authenticated encryption algorithms 1593 or other algorithms that are otherwise unsuitable for direct use 1594 as JWS or JWE algorithms must be registered as "Prohibited". 1596 Change Controller: 1597 For Standards Track RFCs, state "IESG". For others, give the name 1598 of the responsible party. Other details (e.g., postal address, 1599 email address, home page URI) may also be included. 1601 Specification Document(s): 1602 Reference to the document(s) that specify the parameter, 1603 preferably including URI(s) that can be used to retrieve copies of 1604 the document(s). An indication of the relevant sections may also 1605 be included but is not required. 1607 7.1.2. Initial Registry Contents 1609 o Algorithm Name: "HS256" 1610 o Algorithm Description: HMAC using SHA-256 1611 o Algorithm Usage Location(s): "alg" 1612 o JOSE Implementation Requirements: Required 1613 o Change Controller: IESG 1614 o Specification Document(s): Section 3.1 of [[ this document ]] 1616 o Algorithm Name: "HS384" 1617 o Algorithm Description: HMAC using SHA-384 1618 o Algorithm Usage Location(s): "alg" 1619 o JOSE Implementation Requirements: Optional 1620 o Change Controller: IESG 1621 o Specification Document(s): Section 3.1 of [[ this document ]] 1623 o Algorithm Name: "HS512" 1624 o Algorithm Description: HMAC using SHA-512 1625 o Algorithm Usage Location(s): "alg" 1626 o JOSE Implementation Requirements: Optional 1627 o Change Controller: IESG 1628 o Specification Document(s): Section 3.1 of [[ this document ]] 1629 o Algorithm Name: "RS256" 1630 o Algorithm Description: RSASSA-PKCS-v1_5 using SHA-256 1631 o Algorithm Usage Location(s): "alg" 1632 o JOSE Implementation Requirements: Recommended 1633 o Change Controller: IESG 1634 o Specification Document(s): Section 3.1 of [[ this document ]] 1636 o Algorithm Name: "RS384" 1637 o Algorithm Description: RSASSA-PKCS-v1_5 using SHA-384 1638 o Algorithm Usage Location(s): "alg" 1639 o JOSE Implementation Requirements: Optional 1640 o Change Controller: IESG 1641 o Specification Document(s): Section 3.1 of [[ this document ]] 1643 o Algorithm Name: "RS512" 1644 o Algorithm Description: RSASSA-PKCS-v1_5 using SHA-512 1645 o Algorithm Usage Location(s): "alg" 1646 o JOSE Implementation Requirements: Optional 1647 o Change Controller: IESG 1648 o Specification Document(s): Section 3.1 of [[ this document ]] 1650 o Algorithm Name: "ES256" 1651 o Algorithm Description: ECDSA using P-256 and SHA-256 1652 o Algorithm Usage Location(s): "alg" 1653 o JOSE Implementation Requirements: Recommended+ 1654 o Change Controller: IESG 1655 o Specification Document(s): Section 3.1 of [[ this document ]] 1657 o Algorithm Name: "ES384" 1658 o Algorithm Description: ECDSA using P-384 and SHA-384 1659 o Algorithm Usage Location(s): "alg" 1660 o JOSE Implementation Requirements: Optional 1661 o Change Controller: IESG 1662 o Specification Document(s): Section 3.1 of [[ this document ]] 1664 o Algorithm Name: "ES512" 1665 o Algorithm Description: ECDSA using P-521 and SHA-512 1666 o Algorithm Usage Location(s): "alg" 1667 o JOSE Implementation Requirements: Optional 1668 o Change Controller: IESG 1669 o Specification Document(s): Section 3.1 of [[ this document ]] 1671 o Algorithm Name: "PS256" 1672 o Algorithm Description: RSASSA-PSS using SHA-256 and MGF1 with SHA- 1673 256 1674 o Algorithm Usage Location(s): "alg" 1675 o JOSE Implementation Requirements: Optional 1676 o Change Controller: IESG 1677 o Specification Document(s): Section 3.1 of [[ this document ]] 1679 o Algorithm Name: "PS384" 1680 o Algorithm Description: RSASSA-PSS using SHA-384 and MGF1 with SHA- 1681 384 1682 o Algorithm Usage Location(s): "alg" 1683 o JOSE Implementation Requirements: Optional 1684 o Change Controller: IESG 1685 o Specification Document(s): Section 3.1 of [[ this document ]] 1687 o Algorithm Name: "PS512" 1688 o Algorithm Description: RSASSA-PSS using SHA-512 and MGF1 with SHA- 1689 512 1690 o Algorithm Usage Location(s): "alg" 1691 o JOSE Implementation Requirements: Optional 1692 o Change Controller: IESG 1693 o Specification Document(s): Section 3.1 of [[ this document ]] 1695 o Algorithm Name: "none" 1696 o Algorithm Description: No digital signature or MAC performed 1697 o Algorithm Usage Location(s): "alg" 1698 o JOSE Implementation Requirements: Optional 1699 o Change Controller: IESG 1700 o Specification Document(s): Section 3.1 of [[ this document ]] 1702 o Algorithm Name: "RSA1_5" 1703 o Algorithm Description: RSAES-PKCS1-V1_5 1704 o Algorithm Usage Location(s): "alg" 1705 o JOSE Implementation Requirements: Required 1706 o Change Controller: IESG 1707 o Specification Document(s): Section 4.1 of [[ this document ]] 1709 o Algorithm Name: "RSA-OAEP" 1710 o Algorithm Description: RSAES OAEP using default parameters 1711 o Algorithm Usage Location(s): "alg" 1712 o JOSE Implementation Requirements: Optional 1713 o Change Controller: IESG 1714 o Specification Document(s): Section 4.1 of [[ this document ]] 1716 o Algorithm Name: "RSA-OAEP-256" 1717 o Algorithm Description: RSAES OAEP using SHA-256 and MGF1 with SHA- 1718 256 1719 o Algorithm Usage Location(s): "alg" 1720 o JOSE Implementation Requirements: Optional 1721 o Change Controller: IESG 1722 o Specification Document(s): Section 4.1 of [[ this document ]] 1724 o Algorithm Name: "A128KW" 1725 o Algorithm Description: AES Key Wrap using 128 bit key 1726 o Algorithm Usage Location(s): "alg" 1727 o JOSE Implementation Requirements: Recommended 1728 o Change Controller: IESG 1729 o Specification Document(s): Section 4.1 of [[ this document ]] 1731 o Algorithm Name: "A192KW" 1732 o Algorithm Description: AES Key Wrap using 192 bit key 1733 o Algorithm Usage Location(s): "alg" 1734 o JOSE Implementation Requirements: Optional 1735 o Change Controller: IESG 1736 o Specification Document(s): Section 4.1 of [[ this document ]] 1738 o Algorithm Name: "A256KW" 1739 o Algorithm Description: AES Key Wrap using 256 bit key 1740 o Algorithm Usage Location(s): "alg" 1741 o JOSE Implementation Requirements: Recommended 1742 o Change Controller: IESG 1743 o Specification Document(s): Section 4.1 of [[ this document ]] 1745 o Algorithm Name: "dir" 1746 o Algorithm Description: Direct use of a shared symmetric key 1747 o Algorithm Usage Location(s): "alg" 1748 o JOSE Implementation Requirements: Recommended 1749 o Change Controller: IESG 1750 o Specification Document(s): Section 4.1 of [[ this document ]] 1752 o Algorithm Name: "ECDH-ES" 1753 o Algorithm Description: ECDH-ES using Concat KDF 1754 o Algorithm Usage Location(s): "alg" 1755 o JOSE Implementation Requirements: Recommended+ 1756 o Change Controller: IESG 1757 o Specification Document(s): Section 4.1 of [[ this document ]] 1759 o Algorithm Name: "ECDH-ES+A128KW" 1760 o Algorithm Description: ECDH-ES using Concat KDF and "A128KW" 1761 wrapping 1762 o Algorithm Usage Location(s): "alg" 1763 o JOSE Implementation Requirements: Recommended 1764 o Change Controller: IESG 1765 o Specification Document(s): Section 4.1 of [[ this document ]] 1766 o Algorithm Name: "ECDH-ES+A192KW" 1767 o Algorithm Description: ECDH-ES using Concat KDF and "A192KW" 1768 wrapping 1769 o Algorithm Usage Location(s): "alg" 1770 o JOSE Implementation Requirements: Optional 1771 o Change Controller: IESG 1772 o Specification Document(s): Section 4.1 of [[ this document ]] 1774 o Algorithm Name: "ECDH-ES+A256KW" 1775 o Algorithm Description: ECDH-ES using Concat KDF and "A256KW" 1776 wrapping 1777 o Algorithm Usage Location(s): "alg" 1778 o JOSE Implementation Requirements: Recommended 1779 o Change Controller: IESG 1780 o Specification Document(s): Section 4.1 of [[ this document ]] 1782 o Algorithm Name: "A128GCMKW" 1783 o Algorithm Description: Key wrapping with AES GCM using 128 bit key 1784 o Algorithm Usage Location(s): "alg" 1785 o JOSE Implementation Requirements: Optional 1786 o Change Controller: IESG 1787 o Specification Document(s): Section 4.7 of [[ this document ]] 1789 o Algorithm Name: "A192GCMKW" 1790 o Algorithm Description: Key wrapping with AES GCM using 192 bit key 1791 o Algorithm Usage Location(s): "alg" 1792 o JOSE Implementation Requirements: Optional 1793 o Change Controller: IESG 1794 o Specification Document(s): Section 4.7 of [[ this document ]] 1796 o Algorithm Name: "A256GCMKW" 1797 o Algorithm Description: Key wrapping with AES GCM using 256 bit key 1798 o Algorithm Usage Location(s): "alg" 1799 o JOSE Implementation Requirements: Optional 1800 o Change Controller: IESG 1801 o Specification Document(s): Section 4.7 of [[ this document ]] 1803 o Algorithm Name: "PBES2-HS256+A128KW" 1804 o Algorithm Description: PBES2 with HMAC SHA-256 and "A128KW" 1805 wrapping 1806 o Algorithm Usage Location(s): "alg" 1807 o JOSE Implementation Requirements: Optional 1808 o Change Controller: IESG 1809 o Specification Document(s): Section 4.8 of [[ this document ]] 1811 o Algorithm Name: "PBES2-HS384+A192KW" 1812 o Algorithm Description: PBES2 with HMAC SHA-384 and "A192KW" 1813 wrapping 1814 o Algorithm Usage Location(s): "alg" 1815 o JOSE Implementation Requirements: Optional 1816 o Change Controller: IESG 1817 o Specification Document(s): Section 4.8 of [[ this document ]] 1819 o Algorithm Name: "PBES2-HS512+A256KW" 1820 o Algorithm Description: PBES2 with HMAC SHA-512 and "A256KW" 1821 wrapping 1822 o Algorithm Usage Location(s): "alg" 1823 o JOSE Implementation Requirements: Optional 1824 o Change Controller: IESG 1825 o Specification Document(s): Section 4.8 of [[ this document ]] 1827 o Algorithm Name: "A128CBC-HS256" 1828 o Algorithm Description: AES_128_CBC_HMAC_SHA_256 authenticated 1829 encryption algorithm 1830 o Algorithm Usage Location(s): "enc" 1831 o JOSE Implementation Requirements: Required 1832 o Change Controller: IESG 1833 o Specification Document(s): Section 5.1 of [[ this document ]] 1835 o Algorithm Name: "A192CBC-HS384" 1836 o Algorithm Description: AES_192_CBC_HMAC_SHA_384 authenticated 1837 encryption algorithm 1838 o Algorithm Usage Location(s): "enc" 1839 o JOSE Implementation Requirements: Optional 1840 o Change Controller: IESG 1841 o Specification Document(s): Section 5.1 of [[ this document ]] 1843 o Algorithm Name: "A256CBC-HS512" 1844 o Algorithm Description: AES_256_CBC_HMAC_SHA_512 authenticated 1845 encryption algorithm 1846 o Algorithm Usage Location(s): "enc" 1847 o JOSE Implementation Requirements: Required 1848 o Change Controller: IESG 1849 o Specification Document(s): Section 5.1 of [[ this document ]] 1851 o Algorithm Name: "A128GCM" 1852 o Algorithm Description: AES GCM using 128 bit key 1853 o Algorithm Usage Location(s): "enc" 1854 o JOSE Implementation Requirements: Recommended 1855 o Change Controller: IESG 1856 o Specification Document(s): Section 5.1 of [[ this document ]] 1857 o Algorithm Name: "A192GCM" 1858 o Algorithm Description: AES GCM using 192 bit key 1859 o Algorithm Usage Location(s): "enc" 1860 o JOSE Implementation Requirements: Optional 1861 o Change Controller: IESG 1862 o Specification Document(s): Section 5.1 of [[ this document ]] 1864 o Algorithm Name: "A256GCM" 1865 o Algorithm Description: AES GCM using 256 bit key 1866 o Algorithm Usage Location(s): "enc" 1867 o JOSE Implementation Requirements: Recommended 1868 o Change Controller: IESG 1869 o Specification Document(s): Section 5.1 of [[ this document ]] 1871 7.2. Header Parameter Names Registration 1873 This specification registers the Header Parameter names defined in 1874 Section 4.6.1, Section 4.7.1, and Section 4.8.1 in the IANA JSON Web 1875 Signature and Encryption Header Parameters registry defined in [JWS]. 1877 7.2.1. Registry Contents 1879 o Header Parameter Name: "epk" 1880 o Header Parameter Description: Ephemeral Public Key 1881 o Header Parameter Usage Location(s): JWE 1882 o Change Controller: IESG 1883 o Specification Document(s): Section 4.6.1.1 of [[ this document ]] 1885 o Header Parameter Name: "apu" 1886 o Header Parameter Description: Agreement PartyUInfo 1887 o Header Parameter Usage Location(s): JWE 1888 o Change Controller: IESG 1889 o Specification Document(s): Section 4.6.1.2 of [[ this document ]] 1891 o Header Parameter Name: "apv" 1892 o Header Parameter Description: Agreement PartyVInfo 1893 o Header Parameter Usage Location(s): JWE 1894 o Change Controller: IESG 1895 o Specification Document(s): Section 4.6.1.3 of [[ this document ]] 1897 o Header Parameter Name: "iv" 1898 o Header Parameter Description: Initialization Vector 1899 o Header Parameter Usage Location(s): JWE 1900 o Change Controller: IESG 1901 o Specification Document(s): Section 4.7.1.1 of [[ this document ]] 1902 o Header Parameter Name: "tag" 1903 o Header Parameter Description: Authentication Tag 1904 o Header Parameter Usage Location(s): JWE 1905 o Change Controller: IESG 1906 o Specification Document(s): Section 4.7.1.2 of [[ this document ]] 1908 o Header Parameter Name: "p2s" 1909 o Header Parameter Description: PBES2 salt 1910 o Header Parameter Usage Location(s): JWE 1911 o Change Controller: IESG 1912 o Specification Document(s): Section 4.8.1.1 of [[ this document ]] 1914 o Header Parameter Name: "p2c" 1915 o Header Parameter Description: PBES2 count 1916 o Header Parameter Usage Location(s): JWE 1917 o Change Controller: IESG 1918 o Specification Document(s): Section 4.8.1.2 of [[ this document ]] 1920 7.3. JSON Web Encryption Compression Algorithms Registry 1922 This specification establishes the IANA JSON Web Encryption 1923 Compression Algorithms registry for JWE "zip" member values. The 1924 registry records the compression algorithm value and a reference to 1925 the specification that defines it. 1927 7.3.1. Registration Template 1929 Compression Algorithm Value: 1930 The name requested (e.g., "example"). Because a core goal of this 1931 specification is for the resulting representations to be compact, 1932 it is RECOMMENDED that the name be short -- not to exceed 8 1933 characters without a compelling reason to do so. This name is 1934 case-sensitive. Names may not match other registered names in a 1935 case-insensitive manner unless the Designated Expert(s) state that 1936 there is a compelling reason to allow an exception in this 1937 particular case. 1939 Compression Algorithm Description: 1940 Brief description of the compression algorithm (e.g., "Example 1941 description"). 1943 Change Controller: 1944 For Standards Track RFCs, state "IESG". For others, give the name 1945 of the responsible party. Other details (e.g., postal address, 1946 email address, home page URI) may also be included. 1948 Specification Document(s): 1949 Reference to the document(s) that specify the parameter, 1950 preferably including URI(s) that can be used to retrieve copies of 1951 the document(s). An indication of the relevant sections may also 1952 be included but is not required. 1954 7.3.2. Initial Registry Contents 1956 o Compression Algorithm Value: "DEF" 1957 o Compression Algorithm Description: DEFLATE 1958 o Change Controller: IESG 1959 o Specification Document(s): JSON Web Encryption (JWE) [JWE] 1961 7.4. JSON Web Key Types Registry 1963 This specification establishes the IANA JSON Web Key Types registry 1964 for values of the JWK "kty" (key type) parameter. The registry 1965 records the "kty" value, implementation requirements, and a reference 1966 to the specification that defines it. 1968 The implementation requirements of a key type MAY be changed over 1969 time by the Designated Experts(s) as the cryptographic landscape 1970 evolves, for instance, to change the status of a key type to 1971 Deprecated, or to change the status of a key type from Optional to 1972 Recommended+ or Required. Changes of implementation requirements are 1973 only permitted on a Specification Required basis, with the new 1974 specification defining the revised implementation requirements level. 1976 7.4.1. Registration Template 1978 "kty" Parameter Value: 1979 The name requested (e.g., "example"). Because a core goal of this 1980 specification is for the resulting representations to be compact, 1981 it is RECOMMENDED that the name be short -- not to exceed 8 1982 characters without a compelling reason to do so. This name is 1983 case-sensitive. Names may not match other registered names in a 1984 case-insensitive manner unless the Designated Expert(s) state that 1985 there is a compelling reason to allow an exception in this 1986 particular case. 1988 Key Type Description: 1989 Brief description of the Key Type (e.g., "Example description"). 1991 Change Controller: 1992 For Standards Track RFCs, state "IESG". For others, give the name 1993 of the responsible party. Other details (e.g., postal address, 1994 email address, home page URI) may also be included. 1996 JOSE Implementation Requirements: 1997 The key type implementation requirements for JWS and JWE, which 1998 must be one the words Required, Recommended, Optional, Deprecated, 1999 or Prohibited. Optionally, the word can be followed by a "+" or 2000 "-". The use of "+" indicates that the requirement strength is 2001 likely to be increased in a future version of the specification. 2002 The use of "-" indicates that the requirement strength is likely 2003 to be decreased in a future version of the specification. 2005 Specification Document(s): 2006 Reference to the document(s) that specify the parameter, 2007 preferably including URI(s) that can be used to retrieve copies of 2008 the document(s). An indication of the relevant sections may also 2009 be included but is not required. 2011 7.4.2. Initial Registry Contents 2013 This specification registers the values defined in Section 6.1. 2015 o "kty" Parameter Value: "EC" 2016 o Key Type Description: Elliptic Curve 2017 o JOSE Implementation Requirements: Recommended+ 2018 o Change Controller: IESG 2019 o Specification Document(s): Section 6.2 of [[ this document ]] 2021 o "kty" Parameter Value: "RSA" 2022 o Key Type Description: RSA 2023 o JOSE Implementation Requirements: Required 2024 o Change Controller: IESG 2025 o Specification Document(s): Section 6.3 of [[ this document ]] 2027 o "kty" Parameter Value: "oct" 2028 o Key Type Description: Octet sequence 2029 o JOSE Implementation Requirements: Required 2030 o Change Controller: IESG 2031 o Specification Document(s): Section 6.4 of [[ this document ]] 2033 7.5. JSON Web Key Parameters Registration 2035 This specification registers the parameter names defined in Sections 2036 6.2, 6.3, and 6.4 in the IANA JSON Web Key Parameters registry 2037 defined in [JWK]. 2039 7.5.1. Registry Contents 2041 o Parameter Name: "crv" 2042 o Parameter Description: Curve 2043 o Used with "kty" Value(s): "EC" 2044 o Parameter Information Class: Public 2045 o Change Controller: IESG 2046 o Specification Document(s): Section 6.2.1.1 of [[ this document ]] 2048 o Parameter Name: "x" 2049 o Parameter Description: X Coordinate 2050 o Used with "kty" Value(s): "EC" 2051 o Parameter Information Class: Public 2052 o Change Controller: IESG 2053 o Specification Document(s): Section 6.2.1.2 of [[ this document ]] 2055 o Parameter Name: "y" 2056 o Parameter Description: Y Coordinate 2057 o Used with "kty" Value(s): "EC" 2058 o Parameter Information Class: Public 2059 o Change Controller: IESG 2060 o Specification Document(s): Section 6.2.1.3 of [[ this document ]] 2062 o Parameter Name: "d" 2063 o Parameter Description: ECC Private Key 2064 o Used with "kty" Value(s): "EC" 2065 o Parameter Information Class: Private 2066 o Change Controller: IESG 2067 o Specification Document(s): Section 6.2.2.1 of [[ this document ]] 2069 o Parameter Name: "n" 2070 o Parameter Description: Modulus 2071 o Used with "kty" Value(s): "RSA" 2072 o Parameter Information Class: Public 2073 o Change Controller: IESG 2074 o Specification Document(s): Section 6.3.1.1 of [[ this document ]] 2076 o Parameter Name: "e" 2077 o Parameter Description: Exponent 2078 o Used with "kty" Value(s): "RSA" 2079 o Parameter Information Class: Public 2080 o Change Controller: IESG 2081 o Specification Document(s): Section 6.3.1.2 of [[ this document ]] 2083 o Parameter Name: "d" 2084 o Parameter Description: Private Exponent 2085 o Used with "kty" Value(s): "RSA" 2086 o Parameter Information Class: Private 2087 o Change Controller: IESG 2088 o Specification Document(s): Section 6.3.2.1 of [[ this document ]] 2090 o Parameter Name: "p" 2091 o Parameter Description: First Prime Factor 2092 o Used with "kty" Value(s): "RSA" 2093 o Parameter Information Class: Private 2094 o Change Controller: IESG 2095 o Specification Document(s): Section 6.3.2.2 of [[ this document ]] 2097 o Parameter Name: "q" 2098 o Parameter Description: Second Prime Factor 2099 o Used with "kty" Value(s): "RSA" 2100 o Parameter Information Class: Private 2101 o Change Controller: IESG 2102 o Specification Document(s): Section 6.3.2.3 of [[ this document ]] 2104 o Parameter Name: "dp" 2105 o Parameter Description: First Factor CRT Exponent 2106 o Used with "kty" Value(s): "RSA" 2107 o Parameter Information Class: Private 2108 o Change Controller: IESG 2109 o Specification Document(s): Section 6.3.2.4 of [[ this document ]] 2111 o Parameter Name: "dq" 2112 o Parameter Description: Second Factor CRT Exponent 2113 o Used with "kty" Value(s): "RSA" 2114 o Parameter Information Class: Private 2115 o Change Controller: IESG 2116 o Specification Document(s): Section 6.3.2.5 of [[ this document ]] 2118 o Parameter Name: "qi" 2119 o Parameter Description: First CRT Coefficient 2120 o Used with "kty" Value(s): "RSA" 2121 o Parameter Information Class: Private 2122 o Change Controller: IESG 2123 o Specification Document(s): Section 6.3.2.6 of [[ this document ]] 2125 o Parameter Name: "oth" 2126 o Parameter Description: Other Primes Info 2127 o Used with "kty" Value(s): "RSA" 2128 o Parameter Information Class: Private 2129 o Change Controller: IESG 2130 o Specification Document(s): Section 6.3.2.7 of [[ this document ]] 2132 o Parameter Name: "k" 2133 o Parameter Description: Key Value 2134 o Used with "kty" Value(s): "oct" 2135 o Parameter Information Class: Private 2136 o Change Controller: IESG 2137 o Specification Document(s): Section 6.4.1 of [[ this document ]] 2139 7.6. JSON Web Key Elliptic Curve Registry 2141 This specification establishes the IANA JSON Web Key Elliptic Curve 2142 registry for JWK "crv" member values. The registry records the curve 2143 name, implementation requirements, and a reference to the 2144 specification that defines it. This specification registers the 2145 parameter names defined in Section 6.2.1.1. 2147 The implementation requirements of a curve MAY be changed over time 2148 by the Designated Experts(s) as the cryptographic landscape evolves, 2149 for instance, to change the status of a curve to Deprecated, or to 2150 change the status of a curve from Optional to Recommended+ or 2151 Required. Changes of implementation requirements are only permitted 2152 on a Specification Required basis, with the new specification 2153 defining the revised implementation requirements level. 2155 7.6.1. Registration Template 2157 Curve Name: 2158 The name requested (e.g., "example"). Because a core goal of this 2159 specification is for the resulting representations to be compact, 2160 it is RECOMMENDED that the name be short -- not to exceed 8 2161 characters without a compelling reason to do so. This name is 2162 case-sensitive. Names may not match other registered names in a 2163 case-insensitive manner unless the Designated Expert(s) state that 2164 there is a compelling reason to allow an exception in this 2165 particular case. 2167 Curve Description: 2168 Brief description of the curve (e.g., "Example description"). 2170 JOSE Implementation Requirements: 2171 The curve implementation requirements for JWS and JWE, which must 2172 be one the words Required, Recommended, Optional, Deprecated, or 2173 Prohibited. Optionally, the word can be followed by a "+" or "-". 2174 The use of "+" indicates that the requirement strength is likely 2175 to be increased in a future version of the specification. The use 2176 of "-" indicates that the requirement strength is likely to be 2177 decreased in a future version of the specification. 2179 Change Controller: 2180 For Standards Track RFCs, state "IESG". For others, give the name 2181 of the responsible party. Other details (e.g., postal address, 2182 email address, home page URI) may also be included. 2184 Specification Document(s): 2185 Reference to the document(s) that specify the parameter, 2186 preferably including URI(s) that can be used to retrieve copies of 2187 the document(s). An indication of the relevant sections may also 2188 be included but is not required. 2190 7.6.2. Initial Registry Contents 2192 o Curve Name: "P-256" 2193 o Curve Description: P-256 curve 2194 o JOSE Implementation Requirements: Recommended+ 2195 o Change Controller: IESG 2196 o Specification Document(s): Section 6.2.1.1 of [[ this document ]] 2198 o Curve Name: "P-384" 2199 o Curve Description: P-384 curve 2200 o JOSE Implementation Requirements: Optional 2201 o Change Controller: IESG 2202 o Specification Document(s): Section 6.2.1.1 of [[ this document ]] 2204 o Curve Name: "P-521" 2205 o Curve Description: P-521 curve 2206 o JOSE Implementation Requirements: Optional 2207 o Change Controller: IESG 2208 o Specification Document(s): Section 6.2.1.1 of [[ this document ]] 2210 8. Security Considerations 2212 All of the security issues that are pertinent to any cryptographic 2213 application must be addressed by JWS/JWE/JWK agents. Among these 2214 issues are protecting the user's asymmetric private and symmetric 2215 secret keys and employing countermeasures to various attacks. 2217 The security considerations in [AES], [DSS], [JWE], [JWK], [JWS], 2218 [NIST.800-38A], [NIST.800-38D], [NIST.800-56A], [RFC2104], [RFC3394], 2219 [RFC3447], [RFC5116], [RFC6090], and [SHS] apply to this 2220 specification. 2222 8.1. Cryptographic Agility 2224 Implementers should be aware that cryptographic algorithms become 2225 weaker with time. As new cryptanalysis techniques are developed and 2226 computing performance improves, the work factor to break a particular 2227 cryptographic algorithm will be reduced. Therefore, implementers and 2228 deployments must be prepared for the set of algorithms that are 2229 supported and used to change over time. Thus, cryptographic 2230 algorithm implementations should be modular, allowing new algorithms 2231 to be readily inserted. 2233 8.2. Key Lifetimes 2235 Many algorithms have associated security considerations related to 2236 key lifetimes and/or the number of times that a key may be used. 2237 Those security considerations continue to apply when using those 2238 algorithms with JOSE data structures. See NIST SP 800-57 2239 [NIST.800-57] for specific guidance on key lifetimes. 2241 8.3. RSAES-PKCS1-v1_5 Security Considerations 2243 While Section 8 of RFC 3447 [RFC3447] explicitly calls for people not 2244 to adopt RSASSA-PKCS-v1_5 for new applications and instead requests 2245 that people transition to RSASSA-PSS, this specification does include 2246 RSASSA-PKCS-v1_5, for interoperability reasons, because it commonly 2247 implemented. 2249 Keys used with RSAES-PKCS1-v1_5 must follow the constraints in 2250 Section 7.2 of RFC 3447. In particular, keys with a low public key 2251 exponent value must not be used. 2253 8.4. AES GCM Security Considerations 2255 Keys used with AES GCM must follow the constraints in Section 8.3 of 2256 [NIST.800-38D], which states: "The total number of invocations of the 2257 authenticated encryption function shall not exceed 2^32, including 2258 all IV lengths and all instances of the authenticated encryption 2259 function with the given key". In accordance with this rule, AES GCM 2260 MUST NOT be used with the same key value more than 2^32 times. 2262 An Initialization Vector value MUST never be used multiple times with 2263 the same AES GCM key. One way to prevent this is to store a counter 2264 with the key and increment it with every use. The counter can also 2265 be used to prevent exceeding the 2^32 limit above. 2267 This security consideration does not apply to the composite AES-CBC 2268 HMAC SHA-2 or AES Key Wrap algorithms. 2270 8.5. Unsecured JWS Security Considerations 2272 Unsecured JWSs (JWSs that use the "alg" value "none") provide no 2273 integrity protection. Thus, they must only be used in contexts in 2274 which the payload is secured by means other than a digital signature 2275 or MAC value, or need not be secured. 2277 Implementations that support Unsecured JWS objects MUST NOT accept 2278 such objects as valid unless the application specifies that it is 2279 acceptable for a specific object to not be integrity-protected. 2280 Implementations MUST NOT accept Unsecured JWS objects by default. 2281 For example, the "verify" method of a hypothetical JWS software 2282 library might have a Boolean "acceptUnsigned" parameter that 2283 indicates "none" is an acceptable "alg" value. As another example, 2284 the "verify" method might take a list of algorithms that are 2285 acceptable to the application as a parameter and would reject 2286 Unsecured JWS values if "none" is not in that list. 2288 In order to mitigate downgrade attacks, applications MUST NOT signal 2289 acceptance of Unsecured JWS objects at a global level, and SHOULD 2290 signal acceptance on a per-object basis. For example, suppose an 2291 application accepts JWS objects over two channels, (1) HTTP and (2) 2292 HTTPS with client authentication. It requires a JWS signature on 2293 objects received over HTTP, but accepts Unsecured JWS objects over 2294 HTTPS. If the application were to globally indicate that "none" is 2295 acceptable, then an attacker could provide it with an unsigned object 2296 over HTTP and still have that object successfully validate. Instead, 2297 the application needs to indicate acceptance of "none" for each 2298 object received over HTTPS (e.g., by setting "acceptUnsigned" to 2299 "true" for the first hypothetical JWS software library above), but 2300 not for each object received over HTTP. 2302 8.6. Denial of Service Attacks 2304 Receiving agents that validate signatures and sending agents that 2305 encrypt messages need to be cautious of cryptographic processing 2306 usage when validating signatures and encrypting messages using keys 2307 larger than those mandated in this specification. An attacker could 2308 send certificates with keys that would result in excessive 2309 cryptographic processing, for example, keys larger than those 2310 mandated in this specification, which could swamp the processing 2311 element. Agents that use such keys without first validating the 2312 certificate to a trust anchor are advised to have some sort of 2313 cryptographic resource management system to prevent such attacks. 2315 8.7. Reusing Key Material when Encrypting Keys 2317 It is NOT RECOMMENDED to reuse the same key material (Key Encryption 2318 Key, Content Encryption Key, Initialization Vector, etc.) to encrypt 2319 multiple JWK or JWK Set objects, or to encrypt the same JWK or JWK 2320 Set object multiple times. One suggestion for preventing re-use is 2321 to always generate a new set of key material for each encryption 2322 operation, based on the considerations noted in this document as well 2323 as from RFC 4086 [RFC4086]. 2325 8.8. Password Considerations 2327 Passwords are vulnerable to a number of attacks. To help mitigate 2328 some of these limitations, this document applies principles from RFC 2329 2898 [RFC2898] to derive cryptographic keys from user-supplied 2330 passwords. 2332 However, the strength of the password still has a significant impact. 2333 A high-entropy password has greater resistance to dictionary attacks. 2334 [NIST-800-63-1] contains guidelines for estimating password entropy, 2335 which can help applications and users generate stronger passwords. 2337 An ideal password is one that is as large as (or larger than) the 2338 derived key length. However, passwords larger than a certain 2339 algorithm-specific size are first hashed, which reduces an attacker's 2340 effective search space to the length of the hash algorithm. It is 2341 RECOMMENDED that a password used for "PBES2-HS256+A128KW" be no 2342 shorter than 16 octets and no longer than 128 octets and a password 2343 used for "PBES2-HS512+A256KW" be no shorter than 32 octets and no 2344 longer than 128 octets long. 2346 Still, care needs to be taken in where and how password-based 2347 encryption is used. These algorithms can still be susceptible to 2348 dictionary-based attacks if the iteration count is too small; this is 2349 of particular concern if these algorithms are used to protect data 2350 that an attacker can have indefinite number of attempts to circumvent 2351 the protection, such as protected data stored on a file system. 2353 8.9. Key Entropy and Random Values 2355 See Section 10.1 of [JWS] for security considerations on key entropy 2356 and random values. 2358 8.10. Differences between Digital Signatures and MACs 2360 See Section 10.5 of [JWS] for security considerations on differences 2361 between digital signatures and MACs. 2363 8.11. Using Matching Algorithm Strengths 2365 See Section 11.3 of [JWE] for security considerations on using 2366 matching algorithm strengths. 2368 8.12. Adaptive Chosen-Ciphertext Attacks 2370 See Section 11.4 of [JWE] for security considerations on adaptive 2371 chosen-ciphertext attacks. 2373 8.13. Timing Attacks 2375 See Section 10.9 of [JWS] and Section 11.5 of [JWE] for security 2376 considerations on timing attacks. 2378 8.14. RSA Private Key Representations and Blinding 2380 See Section 9.3 of [JWK] for security considerations on RSA private 2381 key representations and blinding. 2383 9. Internationalization Considerations 2385 Passwords obtained from users are likely to require preparation and 2386 normalization to account for differences of octet sequences generated 2387 by different input devices, locales, etc. It is RECOMMENDED that 2388 applications to perform the steps outlined in 2389 [I-D.ietf-precis-saslprepbis] to prepare a password supplied directly 2390 by a user before performing key derivation and encryption. 2392 10. References 2394 10.1. Normative References 2396 [AES] National Institute of Standards and Technology (NIST), 2397 "Advanced Encryption Standard (AES)", FIPS PUB 197, 2398 November 2001. 2400 [DSS] National Institute of Standards and Technology, "Digital 2401 Signature Standard (DSS)", FIPS PUB 186-4, July 2013. 2403 [JWE] Jones, M. and J. Hildebrand, "JSON Web Encryption (JWE)", 2404 draft-ietf-jose-json-web-encryption (work in progress), 2405 September 2014. 2407 [JWK] Jones, M., "JSON Web Key (JWK)", 2408 draft-ietf-jose-json-web-key (work in progress), 2409 September 2014. 2411 [JWS] Jones, M., Bradley, J., and N. Sakimura, "JSON Web 2412 Signature (JWS)", draft-ietf-jose-json-web-signature (work 2413 in progress), September 2014. 2415 [NIST.800-38A] 2416 National Institute of Standards and Technology (NIST), 2417 "Recommendation for Block Cipher Modes of Operation", 2418 NIST PUB 800-38A, December 2001. 2420 [NIST.800-38D] 2421 National Institute of Standards and Technology (NIST), 2422 "Recommendation for Block Cipher Modes of Operation: 2423 Galois/Counter Mode (GCM) and GMAC", NIST PUB 800-38D, 2424 December 2001. 2426 [NIST.800-56A] 2427 National Institute of Standards and Technology (NIST), 2428 "Recommendation for Pair-Wise Key Establishment Schemes 2429 Using Discrete Logarithm Cryptography", NIST Special 2430 Publication 800-56A, Revision 2, May 2013. 2432 [NIST.800-57] 2433 National Institute of Standards and Technology (NIST), 2434 "Recommendation for Key Management - Part 1: General 2435 (Revision 3)", NIST Special Publication 800-57, Part 1, 2436 Revision 3, July 2012. 2438 [RFC2104] Krawczyk, H., Bellare, M., and R. Canetti, "HMAC: Keyed- 2439 Hashing for Message Authentication", RFC 2104, 2440 February 1997. 2442 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2443 Requirement Levels", BCP 14, RFC 2119, March 1997. 2445 [RFC2898] Kaliski, B., "PKCS #5: Password-Based Cryptography 2446 Specification Version 2.0", RFC 2898, September 2000. 2448 [RFC3394] Schaad, J. and R. Housley, "Advanced Encryption Standard 2449 (AES) Key Wrap Algorithm", RFC 3394, September 2002. 2451 [RFC3447] Jonsson, J. and B. Kaliski, "Public-Key Cryptography 2452 Standards (PKCS) #1: RSA Cryptography Specifications 2453 Version 2.1", RFC 3447, February 2003. 2455 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 2456 10646", STD 63, RFC 3629, November 2003. 2458 [RFC4868] Kelly, S. and S. Frankel, "Using HMAC-SHA-256, HMAC-SHA- 2459 384, and HMAC-SHA-512 with IPsec", RFC 4868, May 2007. 2461 [RFC6090] McGrew, D., Igoe, K., and M. Salter, "Fundamental Elliptic 2462 Curve Cryptography Algorithms", RFC 6090, February 2011. 2464 [RFC7159] Bray, T., "The JavaScript Object Notation (JSON) Data 2465 Interchange Format", RFC 7159, March 2014. 2467 [SEC1] Standards for Efficient Cryptography Group, "SEC 1: 2468 Elliptic Curve Cryptography", May 2009. 2470 [SHS] National Institute of Standards and Technology, "Secure 2471 Hash Standard (SHS)", FIPS PUB 180-4, March 2012. 2473 [USASCII] American National Standards Institute, "Coded Character 2474 Set -- 7-bit American Standard Code for Information 2475 Interchange", ANSI X3.4, 1986. 2477 10.2. Informative References 2479 [CanvasApp] 2480 Facebook, "Canvas Applications", 2010. 2482 [I-D.ietf-precis-saslprepbis] 2483 Saint-Andre, P. and A. Melnikov, "Preparation and 2484 Comparison of Internationalized Strings Representing 2485 Usernames and Passwords", draft-ietf-precis-saslprepbis-07 2486 (work in progress), March 2014. 2488 [I-D.mcgrew-aead-aes-cbc-hmac-sha2] 2489 McGrew, D., Foley, J., and K. Paterson, "Authenticated 2490 Encryption with AES-CBC and HMAC-SHA", 2491 draft-mcgrew-aead-aes-cbc-hmac-sha2-05 (work in progress), 2492 July 2014. 2494 [I-D.miller-jose-jwe-protected-jwk] 2495 Miller, M., "Using JavaScript Object Notation (JSON) Web 2496 Encryption (JWE) for Protecting JSON Web Key (JWK) 2497 Objects", draft-miller-jose-jwe-protected-jwk-02 (work in 2498 progress), June 2013. 2500 [I-D.rescorla-jsms] 2501 Rescorla, E. and J. Hildebrand, "JavaScript Message 2502 Security Format", draft-rescorla-jsms-00 (work in 2503 progress), March 2011. 2505 [JCA] Oracle, "Java Cryptography Architecture (JCA) Reference 2506 Guide", 2014. 2508 [JSE] Bradley, J. and N. Sakimura (editor), "JSON Simple 2509 Encryption", September 2010. 2511 [JSS] Bradley, J. and N. Sakimura (editor), "JSON Simple Sign", 2512 September 2010. 2514 [MagicSignatures] 2515 Panzer (editor), J., Laurie, B., and D. Balfanz, "Magic 2516 Signatures", January 2011. 2518 [NIST-800-63-1] 2519 National Institute of Standards and Technology (NIST), 2520 "Electronic Authentication Guideline", NIST 800-63-1, 2521 December 2011. 2523 [RFC2631] Rescorla, E., "Diffie-Hellman Key Agreement Method", 2524 RFC 2631, June 1999. 2526 [RFC3275] Eastlake, D., Reagle, J., and D. Solo, "(Extensible Markup 2527 Language) XML-Signature Syntax and Processing", RFC 3275, 2528 March 2002. 2530 [RFC4086] Eastlake, D., Schiller, J., and S. Crocker, "Randomness 2531 Requirements for Security", BCP 106, RFC 4086, June 2005. 2533 [RFC5116] McGrew, D., "An Interface and Algorithms for Authenticated 2534 Encryption", RFC 5116, January 2008. 2536 [RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an 2537 IANA Considerations Section in RFCs", BCP 26, RFC 5226, 2538 May 2008. 2540 [W3C.NOTE-xmldsig-core2-20130411] 2541 Eastlake, D., Reagle, J., Solo, D., Hirsch, F., Roessler, 2542 T., Yiu, K., Datta, P., and S. Cantor, "XML Signature 2543 Syntax and Processing Version 2.0", World Wide Web 2544 Consortium Note NOTE-xmldsig-core2-20130411, April 2013, 2545 . 2547 [W3C.REC-xmlenc-core-20021210] 2548 Eastlake, D. and J. Reagle, "XML Encryption Syntax and 2549 Processing", World Wide Web Consortium Recommendation REC- 2550 xmlenc-core-20021210, December 2002, 2551 . 2553 [W3C.REC-xmlenc-core1-20130411] 2554 Eastlake, D., Reagle, J., Hirsch, F., and T. Roessler, 2555 "XML Encryption Syntax and Processing Version 1.1", World 2556 Wide Web Consortium Recommendation REC-xmlenc-core1- 2557 20130411, April 2013, 2558 . 2560 Appendix A. Algorithm Identifier Cross-Reference 2562 This appendix contains tables cross-referencing the cryptographic 2563 algorithm identifier values defined in this specification with the 2564 equivalent identifiers used by other standards and software packages. 2565 See XML DSIG [RFC3275], XML DSIG 2.0 2566 [W3C.NOTE-xmldsig-core2-20130411], XML Encryption 2567 [W3C.REC-xmlenc-core-20021210], XML Encryption 1.1 2568 [W3C.REC-xmlenc-core1-20130411], and Java Cryptography Architecture 2569 [JCA] for more information about the names defined by those 2570 documents. 2572 A.1. Digital Signature/MAC Algorithm Identifier Cross-Reference 2574 This section contains a table cross-referencing the JWS digital 2575 signature and MAC "alg" (algorithm) values defined in this 2576 specification with the equivalent identifiers used by other standards 2577 and software packages. 2579 +-----+-------------------------------+--------------+--------------+ 2580 | JWS | XML DSIG | JCA | OID | 2581 +-----+-------------------------------+--------------+--------------+ 2582 | HS2 | http://www.w3.org/2001/04/xml | HmacSHA256 | 1.2.840.1135 | 2583 | 56 | dsig-more#hmac-sha256 | | 49.2.9 | 2584 | HS3 | http://www.w3.org/2001/04/xml | HmacSHA384 | 1.2.840.1135 | 2585 | 84 | dsig-more#hmac-sha384 | | 49.2.10 | 2586 | HS5 | http://www.w3.org/2001/04/xml | HmacSHA512 | 1.2.840.1135 | 2587 | 12 | dsig-more#hmac-sha512 | | 49.2.11 | 2588 | RS2 | http://www.w3.org/2001/04/xml | SHA256withRS | 1.2.840.1135 | 2589 | 56 | dsig-more#rsa-sha256 | A | 49.1.1.11 | 2590 | RS3 | http://www.w3.org/2001/04/xml | SHA384withRS | 1.2.840.1135 | 2591 | 84 | dsig-more#rsa-sha384 | A | 49.1.1.12 | 2592 | RS5 | http://www.w3.org/2001/04/xml | SHA512withRS | 1.2.840.1135 | 2593 | 12 | dsig-more#rsa-sha512 | A | 49.1.1.13 | 2594 | ES2 | http://www.w3.org/2001/04/xml | SHA256withEC | 1.2.840.1004 | 2595 | 56 | dsig-more#ecdsa-sha256 | DSA | 5.4.3.2 | 2596 | ES3 | http://www.w3.org/2001/04/xml | SHA384withEC | 1.2.840.1004 | 2597 | 84 | dsig-more#ecdsa-sha384 | DSA | 5.4.3.3 | 2598 | ES5 | http://www.w3.org/2001/04/xml | SHA512withEC | 1.2.840.1004 | 2599 | 12 | dsig-more#ecdsa-sha512 | DSA | 5.4.3.4 | 2600 | PS2 | http://www.w3.org/2007/05/xml | SHA256withRS | 1.2.840.1135 | 2601 | 56 | dsig-more#sha256-rsa-MGF1 | AandMGF1 | 49.1.1.10 | 2602 | PS3 | http://www.w3.org/2007/05/xml | SHA384withRS | 1.2.840.1135 | 2603 | 84 | dsig-more#sha384-rsa-MGF1 | AandMGF1 | 49.1.1.10 | 2604 | PS5 | http://www.w3.org/2007/05/xml | SHA512withRS | 1.2.840.1135 | 2605 | 12 | dsig-more#sha512-rsa-MGF1 | AandMGF1 | 49.1.1.10 | 2606 +-----+-------------------------------+--------------+--------------+ 2608 A.2. Key Management Algorithm Identifier Cross-Reference 2610 This section contains a table cross-referencing the JWE "alg" 2611 (algorithm) values defined in this specification with the equivalent 2612 identifiers used by other standards and software packages. 2614 +-------+------------------------+--------------------+-------------+ 2615 | JWE | XML ENC | JCA | OID | 2616 +-------+------------------------+--------------------+-------------+ 2617 | RSA1_ | http://www.w3.org/2001 | RSA/ECB/PKCS1Paddi | 1.2.840.113 | 2618 | 5 | /04/xmlenc#rsa-1_5 | ng | 549.1.1.1 | 2619 | RSA-O | http://www.w3.org/2001 | RSA/ECB/OAEPWithSH | 1.2.840.113 | 2620 | AEP | /04/xmlenc#rsa-oaep-mg | A-1AndMGF1Padding | 549.1.1.7 | 2621 | | f1p | | | 2622 | RSA-O | http://www.w3.org/2009 | RSA/ECB/OAEPWithSH | 1.2.840.113 | 2623 | AEP-2 | /xmlenc11#rsa-oaep & | A-256AndMGF1Paddin | 549.1.1.7 | 2624 | 56 | http://www.w3.org/200 | g& | | 2625 | | 9/xmlenc11#mgf1sha256 | MGF1ParameterSpec | | 2626 | | | .SHA256 | | 2627 | ECDH- | http://www.w3.org/2009 | ECDH | 1.3.132.1.1 | 2628 | ES | /xmlenc11#ECDH-ES | | 2 | 2629 | A128K | http://www.w3.org/2001 | AESWrap | 2.16.840.1. | 2630 | W | /04/xmlenc#kw-aes128 | | 101.3.4.1.5 | 2631 | A192K | http://www.w3.org/2001 | AESWrap | 2.16.840.1. | 2632 | W | /04/xmlenc#kw-aes192 | | 101.3.4.1.2 | 2633 | | | | 5 | 2634 | A256K | http://www.w3.org/2001 | AESWrap | 2.16.840.1. | 2635 | W | /04/xmlenc#kw-aes256 | | 101.3.4.1.4 | 2636 | | | | 5 | 2637 +-------+------------------------+--------------------+-------------+ 2639 A.3. Content Encryption Algorithm Identifier Cross-Reference 2641 This section contains a table cross-referencing the JWE "enc" 2642 (encryption algorithm) values defined in this specification with the 2643 equivalent identifiers used by other standards and software packages. 2645 For the composite algorithms "A128CBC-HS256", "A192CBC-HS384", and 2646 "A256CBC-HS512", the corresponding AES CBC algorithm identifiers are 2647 listed. 2649 +---------+-------------------------+--------------+----------------+ 2650 | JWE | XML ENC | JCA | OID | 2651 +---------+-------------------------+--------------+----------------+ 2652 | A128CBC | http://www.w3.org/2001/ | AES/CBC/PKCS | 2.16.840.1.101 | 2653 | -HS256 | 04/xmlenc#aes128-cbc | 5Padding | .3.4.1.2 | 2654 | A192CBC | http://www.w3.org/2001/ | AES/CBC/PKCS | 2.16.840.1.101 | 2655 | -HS384 | 04/xmlenc#aes192-cbc | 5Padding | .3.4.1.22 | 2656 | A256CBC | http://www.w3.org/2001/ | AES/CBC/PKCS | 2.16.840.1.101 | 2657 | -HS512 | 04/xmlenc#aes256-cbc | 5Padding | .3.4.1.42 | 2658 | A128GCM | http://www.w3.org/2009/ | AES/GCM/NoPa | 2.16.840.1.101 | 2659 | | xmlenc11#aes128-gcm | dding | .3.4.1.6 | 2660 | A192GCM | http://www.w3.org/2009/ | AES/GCM/NoPa | 2.16.840.1.101 | 2661 | | xmlenc11#aes192-gcm | dding | .3.4.1.26 | 2662 | A256GCM | http://www.w3.org/2009/ | AES/GCM/NoPa | 2.16.840.1.101 | 2663 | | xmlenc11#aes256-gcm | dding | .3.4.1.46 | 2664 +---------+-------------------------+--------------+----------------+ 2666 Appendix B. Test Cases for AES_CBC_HMAC_SHA2 Algorithms 2668 The following test cases can be used to validate implementations of 2669 the AES_CBC_HMAC_SHA2 algorithms defined in Section 5.2. They are 2670 also intended to correspond to test cases that may appear in a future 2671 version of [I-D.mcgrew-aead-aes-cbc-hmac-sha2], demonstrating that 2672 the cryptographic computations performed are the same. 2674 The variable names are those defined in Section 5.2. All values are 2675 hexadecimal. 2677 B.1. Test Cases for AES_128_CBC_HMAC_SHA_256 2679 AES_128_CBC_HMAC_SHA_256 2681 K = 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 2682 10 11 12 13 14 15 16 17 18 19 1a 1b 1c 1d 1e 1f 2684 MAC_KEY = 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 2686 ENC_KEY = 10 11 12 13 14 15 16 17 18 19 1a 1b 1c 1d 1e 1f 2688 P = 41 20 63 69 70 68 65 72 20 73 79 73 74 65 6d 20 2689 6d 75 73 74 20 6e 6f 74 20 62 65 20 72 65 71 75 2690 69 72 65 64 20 74 6f 20 62 65 20 73 65 63 72 65 2691 74 2c 20 61 6e 64 20 69 74 20 6d 75 73 74 20 62 2692 65 20 61 62 6c 65 20 74 6f 20 66 61 6c 6c 20 69 2693 6e 74 6f 20 74 68 65 20 68 61 6e 64 73 20 6f 66 2694 20 74 68 65 20 65 6e 65 6d 79 20 77 69 74 68 6f 2695 75 74 20 69 6e 63 6f 6e 76 65 6e 69 65 6e 63 65 2697 IV = 1a f3 8c 2d c2 b9 6f fd d8 66 94 09 23 41 bc 04 2699 A = 54 68 65 20 73 65 63 6f 6e 64 20 70 72 69 6e 63 2700 69 70 6c 65 20 6f 66 20 41 75 67 75 73 74 65 20 2701 4b 65 72 63 6b 68 6f 66 66 73 2703 AL = 00 00 00 00 00 00 01 50 2705 E = c8 0e df a3 2d df 39 d5 ef 00 c0 b4 68 83 42 79 2706 a2 e4 6a 1b 80 49 f7 92 f7 6b fe 54 b9 03 a9 c9 2707 a9 4a c9 b4 7a d2 65 5c 5f 10 f9 ae f7 14 27 e2 2708 fc 6f 9b 3f 39 9a 22 14 89 f1 63 62 c7 03 23 36 2709 09 d4 5a c6 98 64 e3 32 1c f8 29 35 ac 40 96 c8 2710 6e 13 33 14 c5 40 19 e8 ca 79 80 df a4 b9 cf 1b 2711 38 4c 48 6f 3a 54 c5 10 78 15 8e e5 d7 9d e5 9f 2712 bd 34 d8 48 b3 d6 95 50 a6 76 46 34 44 27 ad e5 2713 4b 88 51 ff b5 98 f7 f8 00 74 b9 47 3c 82 e2 db 2715 M = 65 2c 3f a3 6b 0a 7c 5b 32 19 fa b3 a3 0b c1 c4 2716 e6 e5 45 82 47 65 15 f0 ad 9f 75 a2 b7 1c 73 ef 2718 T = 65 2c 3f a3 6b 0a 7c 5b 32 19 fa b3 a3 0b c1 c4 2720 B.2. Test Cases for AES_192_CBC_HMAC_SHA_384 2722 K = 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 2723 10 11 12 13 14 15 16 17 18 19 1a 1b 1c 1d 1e 1f 2724 20 21 22 23 24 25 26 27 28 29 2a 2b 2c 2d 2e 2f 2726 MAC_KEY = 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 2727 10 11 12 13 14 15 16 17 2729 ENC_KEY = 18 19 1a 1b 1c 1d 1e 1f 20 21 22 23 24 25 26 27 2730 28 29 2a 2b 2c 2d 2e 2f 2732 P = 41 20 63 69 70 68 65 72 20 73 79 73 74 65 6d 20 2733 6d 75 73 74 20 6e 6f 74 20 62 65 20 72 65 71 75 2734 69 72 65 64 20 74 6f 20 62 65 20 73 65 63 72 65 2735 74 2c 20 61 6e 64 20 69 74 20 6d 75 73 74 20 62 2736 65 20 61 62 6c 65 20 74 6f 20 66 61 6c 6c 20 69 2737 6e 74 6f 20 74 68 65 20 68 61 6e 64 73 20 6f 66 2738 20 74 68 65 20 65 6e 65 6d 79 20 77 69 74 68 6f 2739 75 74 20 69 6e 63 6f 6e 76 65 6e 69 65 6e 63 65 2741 IV = 1a f3 8c 2d c2 b9 6f fd d8 66 94 09 23 41 bc 04 2743 A = 54 68 65 20 73 65 63 6f 6e 64 20 70 72 69 6e 63 2744 69 70 6c 65 20 6f 66 20 41 75 67 75 73 74 65 20 2745 4b 65 72 63 6b 68 6f 66 66 73 2747 AL = 00 00 00 00 00 00 01 50 2749 E = ea 65 da 6b 59 e6 1e db 41 9b e6 2d 19 71 2a e5 2750 d3 03 ee b5 00 52 d0 df d6 69 7f 77 22 4c 8e db 2751 00 0d 27 9b dc 14 c1 07 26 54 bd 30 94 42 30 c6 2752 57 be d4 ca 0c 9f 4a 84 66 f2 2b 22 6d 17 46 21 2753 4b f8 cf c2 40 0a dd 9f 51 26 e4 79 66 3f c9 0b 2754 3b ed 78 7a 2f 0f fc bf 39 04 be 2a 64 1d 5c 21 2755 05 bf e5 91 ba e2 3b 1d 74 49 e5 32 ee f6 0a 9a 2756 c8 bb 6c 6b 01 d3 5d 49 78 7b cd 57 ef 48 49 27 2757 f2 80 ad c9 1a c0 c4 e7 9c 7b 11 ef c6 00 54 e3 2759 M = 84 90 ac 0e 58 94 9b fe 51 87 5d 73 3f 93 ac 20 2760 75 16 80 39 cc c7 33 d7 45 94 f8 86 b3 fa af d4 2761 86 f2 5c 71 31 e3 28 1e 36 c7 a2 d1 30 af de 57 2763 T = 84 90 ac 0e 58 94 9b fe 51 87 5d 73 3f 93 ac 20 2764 75 16 80 39 cc c7 33 d7 2766 B.3. Test Cases for AES_256_CBC_HMAC_SHA_512 2768 K = 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 2769 10 11 12 13 14 15 16 17 18 19 1a 1b 1c 1d 1e 1f 2770 20 21 22 23 24 25 26 27 28 29 2a 2b 2c 2d 2e 2f 2771 30 31 32 33 34 35 36 37 38 39 3a 3b 3c 3d 3e 3f 2773 MAC_KEY = 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 2774 10 11 12 13 14 15 16 17 18 19 1a 1b 1c 1d 1e 1f 2776 ENC_KEY = 20 21 22 23 24 25 26 27 28 29 2a 2b 2c 2d 2e 2f 2777 30 31 32 33 34 35 36 37 38 39 3a 3b 3c 3d 3e 3f 2779 P = 41 20 63 69 70 68 65 72 20 73 79 73 74 65 6d 20 2780 6d 75 73 74 20 6e 6f 74 20 62 65 20 72 65 71 75 2781 69 72 65 64 20 74 6f 20 62 65 20 73 65 63 72 65 2782 74 2c 20 61 6e 64 20 69 74 20 6d 75 73 74 20 62 2783 65 20 61 62 6c 65 20 74 6f 20 66 61 6c 6c 20 69 2784 6e 74 6f 20 74 68 65 20 68 61 6e 64 73 20 6f 66 2785 20 74 68 65 20 65 6e 65 6d 79 20 77 69 74 68 6f 2786 75 74 20 69 6e 63 6f 6e 76 65 6e 69 65 6e 63 65 2788 IV = 1a f3 8c 2d c2 b9 6f fd d8 66 94 09 23 41 bc 04 2790 A = 54 68 65 20 73 65 63 6f 6e 64 20 70 72 69 6e 63 2791 69 70 6c 65 20 6f 66 20 41 75 67 75 73 74 65 20 2792 4b 65 72 63 6b 68 6f 66 66 73 2794 AL = 00 00 00 00 00 00 01 50 2796 E = 4a ff aa ad b7 8c 31 c5 da 4b 1b 59 0d 10 ff bd 2797 3d d8 d5 d3 02 42 35 26 91 2d a0 37 ec bc c7 bd 2798 82 2c 30 1d d6 7c 37 3b cc b5 84 ad 3e 92 79 c2 2799 e6 d1 2a 13 74 b7 7f 07 75 53 df 82 94 10 44 6b 2800 36 eb d9 70 66 29 6a e6 42 7e a7 5c 2e 08 46 a1 2801 1a 09 cc f5 37 0d c8 0b fe cb ad 28 c7 3f 09 b3 2802 a3 b7 5e 66 2a 25 94 41 0a e4 96 b2 e2 e6 60 9e 2803 31 e6 e0 2c c8 37 f0 53 d2 1f 37 ff 4f 51 95 0b 2804 be 26 38 d0 9d d7 a4 93 09 30 80 6d 07 03 b1 f6 2806 M = 4d d3 b4 c0 88 a7 f4 5c 21 68 39 64 5b 20 12 bf 2807 2e 62 69 a8 c5 6a 81 6d bc 1b 26 77 61 95 5b c5 2808 fd 30 a5 65 c6 16 ff b2 f3 64 ba ec e6 8f c4 07 2809 53 bc fc 02 5d de 36 93 75 4a a1 f5 c3 37 3b 9c 2811 T = 4d d3 b4 c0 88 a7 f4 5c 21 68 39 64 5b 20 12 bf 2812 2e 62 69 a8 c5 6a 81 6d bc 1b 26 77 61 95 5b c5 2814 Appendix C. Example ECDH-ES Key Agreement Computation 2816 This example uses ECDH-ES Key Agreement and the Concat KDF to derive 2817 the Content Encryption Key (CEK) in the manner described in 2818 Section 4.6. In this example, the ECDH-ES Direct Key Agreement mode 2819 ("alg" value "ECDH-ES") is used to produce an agreed upon key for AES 2820 GCM with a 128 bit key ("enc" value "A128GCM"). 2822 In this example, a sender Alice is encrypting content to a recipient 2823 Bob. The sender (Alice) generates an ephemeral key for the key 2824 agreement computation. Alice's ephemeral key (in JWK format) used 2825 for the key agreement computation in this example (including the 2826 private part) is: 2828 {"kty":"EC", 2829 "crv":"P-256", 2830 "x":"gI0GAILBdu7T53akrFmMyGcsF3n5dO7MmwNBHKW5SV0", 2831 "y":"SLW_xSffzlPWrHEVI30DHM_4egVwt3NQqeUD7nMFpps", 2832 "d":"0_NxaRPUMQoAJt50Gz8YiTr8gRTwyEaCumd-MToTmIo" 2833 } 2835 The recipient's (Bob's) key (in JWK format) used for the key 2836 agreement computation in this example (including the private part) 2837 is: 2839 {"kty":"EC", 2840 "crv":"P-256", 2841 "x":"weNJy2HscCSM6AEDTDg04biOvhFhyyWvOHQfeF_PxMQ", 2842 "y":"e8lnCO-AlStT-NJVX-crhB7QRYhiix03illJOVAOyck", 2843 "d":"VEmDZpDXXK8p8N0Cndsxs924q6nS1RXFASRl6BfUqdw" 2844 } 2846 Header Parameter values used in this example are as follows. In this 2847 example, the "apu" (agreement PartyUInfo) parameter value is the 2848 base64url encoding of the UTF-8 string "Alice" and the "apv" 2849 (agreement PartyVInfo) parameter value is the base64url encoding of 2850 the UTF-8 string "Bob". The "epk" parameter is used to communicate 2851 the sender's (Alice's) ephemeral public key value to the recipient 2852 (Bob). 2854 {"alg":"ECDH-ES", 2855 "enc":"A128GCM", 2856 "apu":"QWxpY2U", 2857 "apv":"Qm9i", 2858 "epk": 2859 {"kty":"EC", 2860 "crv":"P-256", 2861 "x":"gI0GAILBdu7T53akrFmMyGcsF3n5dO7MmwNBHKW5SV0", 2862 "y":"SLW_xSffzlPWrHEVI30DHM_4egVwt3NQqeUD7nMFpps" 2863 } 2864 } 2866 The resulting Concat KDF [NIST.800-56A] parameter values are: 2868 Z 2869 This is set to the ECDH-ES key agreement output. (This value is 2870 often not directly exposed by libraries, due to NIST security 2871 requirements, and only serves as an input to a KDF.) In this 2872 example, Z is following the octet sequence (using JSON array 2873 notation): 2874 [158, 86, 217, 29, 129, 113, 53, 211, 114, 131, 66, 131, 191, 132, 2875 38, 156, 251, 49, 110, 163, 218, 128, 106, 72, 246, 218, 167, 121, 2876 140, 254, 144, 196]. 2878 keydatalen 2879 This value is 128 - the number of bits in the desired output key 2880 (because "A128GCM" uses a 128 bit key). 2882 AlgorithmID 2883 This is set to the octets representing the 32 bit big endian value 2884 7 - [0, 0, 0, 7] - the number of octets in the AlgorithmID content 2885 "A128GCM", followed, by the octets representing the UTF-8 string 2886 "A128GCM" - [65, 49, 50, 56, 71, 67, 77]. 2888 PartyUInfo 2889 This is set to the octets representing the 32 bit big endian value 2890 5 - [0, 0, 0, 5] - the number of octets in the PartyUInfo content 2891 "Alice", followed, by the octets representing the UTF-8 string 2892 "Alice" - [65, 108, 105, 99, 101]. 2894 PartyVInfo 2895 This is set to the octets representing the 32 bit big endian value 2896 3 - [0, 0, 0, 3] - the number of octets in the PartyUInfo content 2897 "Bob", followed, by the octets representing the UTF-8 string "Bob" 2898 - [66, 111, 98]. 2900 SuppPubInfo 2901 This is set to the octets representing the 32 bit big endian value 2902 128 - [0, 0, 0, 128] - the keydatalen value. 2904 SuppPrivInfo 2905 This is set to the empty octet sequence. 2907 Concatenating the parameters AlgorithmID through SuppPubInfo results 2908 in an OtherInfo value of: 2909 [0, 0, 0, 7, 65, 49, 50, 56, 71, 67, 77, 0, 0, 0, 5, 65, 108, 105, 2910 99, 101, 0, 0, 0, 3, 66, 111, 98, 0, 0, 0, 128] 2912 Concatenating the round number 1 ([0, 0, 0, 1]), Z, and the OtherInfo 2913 value results in the Concat KDF round 1 hash input of: 2914 [0, 0, 0, 1, 2915 158, 86, 217, 29, 129, 113, 53, 211, 114, 131, 66, 131, 191, 132, 38, 2916 156, 251, 49, 110, 163, 218, 128, 106, 72, 246, 218, 167, 121, 140, 2917 254, 144, 196, 2918 0, 0, 0, 7, 65, 49, 50, 56, 71, 67, 77, 0, 0, 0, 5, 65, 108, 105, 99, 2919 101, 0, 0, 0, 3, 66, 111, 98, 0, 0, 0, 128] 2921 The resulting derived key, which is the first 128 bits of the round 1 2922 hash output is: 2923 [86, 170, 141, 234, 248, 35, 109, 32, 92, 34, 40, 205, 113, 167, 16, 2924 26] 2926 The base64url encoded representation of this derived key is: 2928 VqqN6vgjbSBcIijNcacQGg 2930 Appendix D. Acknowledgements 2932 Solutions for signing and encrypting JSON content were previously 2933 explored by Magic Signatures [MagicSignatures], JSON Simple Sign 2934 [JSS], Canvas Applications [CanvasApp], JSON Simple Encryption [JSE], 2935 and JavaScript Message Security Format [I-D.rescorla-jsms], all of 2936 which influenced this draft. 2938 The Authenticated Encryption with AES-CBC and HMAC-SHA 2939 [I-D.mcgrew-aead-aes-cbc-hmac-sha2] specification, upon which the 2940 AES_CBC_HMAC_SHA2 algorithms are based, was written by David A. 2941 McGrew and Kenny Paterson. The test cases for AES_CBC_HMAC_SHA2 are 2942 based upon those for [I-D.mcgrew-aead-aes-cbc-hmac-sha2] by John 2943 Foley. 2945 Matt Miller wrote Using JavaScript Object Notation (JSON) Web 2946 Encryption (JWE) for Protecting JSON Web Key (JWK) Objects 2948 [I-D.miller-jose-jwe-protected-jwk], which the password-based 2949 encryption content of this draft is based upon. 2951 This specification is the work of the JOSE Working Group, which 2952 includes dozens of active and dedicated participants. In particular, 2953 the following individuals contributed ideas, feedback, and wording 2954 that influenced this specification: 2956 Dirk Balfanz, Richard Barnes, John Bradley, Brian Campbell, Breno de 2957 Medeiros, Vladimir Dzhuvinov, Roni Even, Yaron Y. Goland, Dick Hardt, 2958 Joe Hildebrand, Jeff Hodges, Edmund Jay, Charlie Kaufman, James 2959 Manger, Matt Miller, Kathleen Moriarty, Tony Nadalin, Axel Nennker, 2960 John Panzer, Emmanuel Raviart, Eric Rescorla, Nat Sakimura, Jim 2961 Schaad, Hannes Tschofenig, and Sean Turner. 2963 Jim Schaad and Karen O'Donoghue chaired the JOSE working group and 2964 Sean Turner, Stephen Farrell, and Kathleen Moriarty served as 2965 Security area directors during the creation of this specification. 2967 Appendix E. Document History 2969 [[ to be removed by the RFC Editor before publication as an RFC ]] 2971 -33 2973 o Changed the registration review period to three weeks. 2975 o Acknowledged additional contributors. 2977 -32 2979 o Added a note to implementers about libraries that prefix an extra 2980 zero-valued octet to RSA modulus representations returned. 2982 o Addressed secdir review comments by Charlie Kaufman, Scott Kelly, 2983 and Stephen Kent. 2985 o Addressed Gen-ART review comments by Roni Even. 2987 o Replaced the term Plaintext JWS with Unsecured JWS. 2989 -31 2991 o Referenced NIST SP 800-57 for guidance on key lifetimes. 2993 o Updated the reference to draft-mcgrew-aead-aes-cbc-hmac-sha2. 2995 -30 2997 o Cleaned up the reference syntax in a few places. 2999 o Applied minor wording changes to the Security Considerations 3000 section. 3002 -29 3004 o Replaced the terms JWS Header, JWE Header, and JWT Header with a 3005 single JOSE Header term defined in the JWS specification. This 3006 also enabled a single Header Parameter definition to be used and 3007 reduced other areas of duplication between specifications. 3009 -28 3011 o Specified the use of PKCS #7 padding with AES CBC, rather than 3012 PKCS #5. (PKCS #7 is a superset of PKCS #5, and is appropriate 3013 for the 16 octet blocks used by AES CBC.) 3015 o Revised the introduction to the Security Considerations section. 3016 Also introduced additional subsection headings for security 3017 considerations items and moved a few security consideration items 3018 from here to the JWS and JWE drafts. 3020 -27 3022 o Described additional security considerations. 3024 o Updated the JCA and XMLENC parameters for "RSA-OAEP-256" and the 3025 JCA parameters for "A128KW", "A192KW", "A256KW", and "ECDH-ES". 3027 -26 3029 o Added algorithm identifier "RSA-OAEP-256" for RSAES OAEP using 3030 SHA-256 and MGF1 with SHA-256. 3032 o Clarified that the ECDSA signature values R and S are represented 3033 as octet sequences as defined in Section 2.3.7 of SEC1 [SEC1]. 3035 o Noted that octet sequences are depicted using JSON array notation. 3037 o Updated references, including to W3C specifications. 3039 -25 3041 o Corrected an external section number reference that had changed. 3043 -24 3045 o Replaced uses of the term "associated data" wherever it was used 3046 to refer to a data value with "additional authenticated data", 3047 since both terms were being used as synonyms, causing confusion. 3049 o Updated the JSON reference to RFC 7159. 3051 -23 3053 o No changes were made, other than to the version number and date. 3055 -22 3057 o Corrected RFC 2119 terminology usage. 3059 o Replaced references to draft-ietf-json-rfc4627bis with RFC 7158. 3061 -21 3063 o Compute the PBES2 salt parameter as (UTF8(Alg) || 0x00 || Salt 3064 Input), where the "p2s" Header Parameter encodes the Salt Input 3065 value and Alg is the "alg" Header Parameter value. 3067 o Changed some references from being normative to informative, 3068 addressing issue #90. 3070 -20 3072 o Replaced references to RFC 4627 with draft-ietf-json-rfc4627bis, 3073 addressing issue #90. 3075 -19 3077 o Used tables to show the correspondence between algorithm 3078 identifiers and algorithm descriptions and parameters in the 3079 algorithm definition sections, addressing issue #183. 3081 o Changed the "Implementation Requirements" registry field names to 3082 "JOSE Implementation Requirements" to make it clear that these 3083 implementation requirements apply only to JWS and JWE 3084 implementations. 3086 -18 3088 o Changes to address editorial and minor issues #129, #134, #135, 3089 #158, #161, #185, #186, and #187. 3091 o Added and used Description registry fields. 3093 -17 3095 o Explicitly named all the logical components of a JWS and JWE and 3096 defined the processing rules and serializations in terms of those 3097 components, addressing issues #60, #61, and #62. 3099 o Removed processing steps in algorithm definitions that duplicated 3100 processing steps in JWS or JWE, addressing issue #56. 3102 o Replaced verbose repetitive phases such as "base64url encode the 3103 octets of the UTF-8 representation of X" with mathematical 3104 notation such as "BASE64URL(UTF8(X))". 3106 o Terms used in multiple documents are now defined in one place and 3107 incorporated by reference. Some lightly used or obvious terms 3108 were also removed. This addresses issue #58. 3110 o Changes to address minor issue #53. 3112 -16 3114 o Added a DataLen prefix to the AlgorithmID value in the Concat KDF 3115 computation. 3117 o Added OIDs for encryption algorithms, additional signature 3118 algorithm OIDs, and additional XML DSIG/ENC URIs in the algorithm 3119 cross-reference tables. 3121 o Changes to address editorial and minor issues #28, #36, #39, #52, 3122 #53, #55, #127, #128, #136, #137, #141, #150, #151, #152, and 3123 #155. 3125 -15 3127 o Changed statements about rejecting JWSs to statements about 3128 validation failing, addressing issue #35. 3130 o Stated that changes of implementation requirements are only 3131 permitted on a Specification Required basis, addressing issue #38. 3133 o Made "oct" a required key type, addressing issue #40. 3135 o Updated the example ECDH-ES key agreement values. 3137 o Changes to address editorial and minor issues #34, #37, #49, #63, 3138 #123, #124, #125, #130, #132, #133, #138, #139, #140, #142, #143, 3139 #144, #145, #148, #149, #150, and #162. 3141 -14 3143 o Removed "PBKDF2" key type and added "p2s" and "p2c" header 3144 parameters for use with the PBES2 algorithms. 3146 o Made the RSA private key parameters that are there to enable 3147 optimizations be RECOMMENDED rather than REQUIRED. 3149 o Added algorithm identifiers for AES algorithms using 192 bit keys 3150 and for RSASSA-PSS using HMAC SHA-384. 3152 o Added security considerations about key lifetimes, addressing 3153 issue #18. 3155 o Added an example ECDH-ES key agreement computation. 3157 -13 3159 o Added key encryption with AES GCM as specified in 3160 draft-jones-jose-aes-gcm-key-wrap-01, addressing issue #13. 3162 o Added security considerations text limiting the number of times 3163 that an AES GCM key can be used for key encryption or direct 3164 encryption, per Section 8.3 of NIST SP 800-38D, addressing issue 3165 #28. 3167 o Added password-based key encryption as specified in 3168 draft-miller-jose-jwe-protected-jwk-02. 3170 -12 3172 o In the Direct Key Agreement case, the Concat KDF AlgorithmID is 3173 set to the octets of the UTF-8 representation of the "enc" header 3174 parameter value. 3176 o Restored the "apv" (agreement PartyVInfo) parameter. 3178 o Moved the "epk", "apu", and "apv" Header Parameter definitions to 3179 be with the algorithm descriptions that use them. 3181 o Changed terminology from "block encryption" to "content 3182 encryption". 3184 -11 3185 o Removed the Encrypted Key value from the AAD computation since it 3186 is already effectively integrity protected by the encryption 3187 process. The AAD value now only contains the representation of 3188 the JWE Encrypted Header. 3190 o Removed "apv" (agreement PartyVInfo) since it is no longer used. 3192 o Added more information about the use of PartyUInfo during key 3193 agreement. 3195 o Use the keydatalen as the SuppPubInfo value for the Concat KDF 3196 when doing key agreement, as RFC 2631 does. 3198 o Added algorithm identifiers for RSASSA-PSS with SHA-256 and SHA- 3199 512. 3201 o Added a Parameter Information Class value to the JSON Web Key 3202 Parameters registry, which registers whether the parameter conveys 3203 public or private information. 3205 -10 3207 o Changed the JWE processing rules for multiple recipients so that a 3208 single AAD value contains the header parameters and encrypted key 3209 values for all the recipients, enabling AES GCM to be safely used 3210 for multiple recipients. 3212 -09 3214 o Expanded the scope of the JWK parameters to include private and 3215 symmetric key representations, as specified by 3216 draft-jones-jose-json-private-and-symmetric-key-00. 3218 o Changed term "JWS Secured Input" to "JWS Signing Input". 3220 o Changed from using the term "byte" to "octet" when referring to 8 3221 bit values. 3223 o Specified that AES Key Wrap uses the default initial value 3224 specified in Section 2.2.3.1 of RFC 3394. This addressed issue 3225 #19. 3227 o Added Key Management Mode definitions to terminology section and 3228 used the defined terms to provide clearer key management 3229 instructions. This addressed issue #5. 3231 o Replaced "A128CBC+HS256" and "A256CBC+HS512" with "A128CBC-HS256" 3232 and "A256CBC-HS512". The new algorithms perform the same 3233 cryptographic computations as [I-D.mcgrew-aead-aes-cbc-hmac-sha2], 3234 but with the Initialization Vector and Authentication Tag values 3235 remaining separate from the Ciphertext value in the output 3236 representation. Also deleted the header parameters "epu" 3237 (encryption PartyUInfo) and "epv" (encryption PartyVInfo), since 3238 they are no longer used. 3240 o Changed from using the term "Integrity Value" to "Authentication 3241 Tag". 3243 -08 3245 o Changed the name of the JWK key type parameter from "alg" to 3246 "kty". 3248 o Replaced uses of the term "AEAD" with "Authenticated Encryption", 3249 since the term AEAD in the RFC 5116 sense implied the use of a 3250 particular data representation, rather than just referring to the 3251 class of algorithms that perform authenticated encryption with 3252 associated data. 3254 o Applied editorial improvements suggested by Jeff Hodges. Many of 3255 these simplified the terminology used. 3257 o Added seriesInfo information to Internet Draft references. 3259 -07 3261 o Added a data length prefix to PartyUInfo and PartyVInfo values. 3263 o Changed the name of the JWK RSA modulus parameter from "mod" to 3264 "n" and the name of the JWK RSA exponent parameter from "xpo" to 3265 "e", so that the identifiers are the same as those used in RFC 3266 3447. 3268 o Made several local editorial changes to clean up loose ends left 3269 over from to the decision to only support block encryption methods 3270 providing integrity. 3272 -06 3274 o Removed the "int" and "kdf" parameters and defined the new 3275 composite Authenticated Encryption algorithms "A128CBC+HS256" and 3276 "A256CBC+HS512" to replace the former uses of AES CBC, which 3277 required the use of separate integrity and key derivation 3278 functions. 3280 o Included additional values in the Concat KDF calculation -- the 3281 desired output size and the algorithm value, and optionally 3282 PartyUInfo and PartyVInfo values. Added the optional header 3283 parameters "apu" (agreement PartyUInfo), "apv" (agreement 3284 PartyVInfo), "epu" (encryption PartyUInfo), and "epv" (encryption 3285 PartyVInfo). 3287 o Changed the name of the JWK RSA exponent parameter from "exp" to 3288 "xpo" so as to allow the potential use of the name "exp" for a 3289 future extension that might define an expiration parameter for 3290 keys. (The "exp" name is already used for this purpose in the JWT 3291 specification.) 3293 o Applied changes made by the RFC Editor to RFC 6749's registry 3294 language to this specification. 3296 -05 3298 o Support both direct encryption using a shared or agreed upon 3299 symmetric key, and the use of a shared or agreed upon symmetric 3300 key to key wrap the CMK. Specifically, added the "alg" values 3301 "dir", "ECDH-ES+A128KW", and "ECDH-ES+A256KW" to finish filling in 3302 this set of capabilities. 3304 o Updated open issues. 3306 -04 3308 o Added text requiring that any leading zero bytes be retained in 3309 base64url encoded key value representations for fixed-length 3310 values. 3312 o Added this language to Registration Templates: "This name is case 3313 sensitive. Names that match other registered names in a case 3314 insensitive manner SHOULD NOT be accepted." 3316 o Described additional open issues. 3318 o Applied editorial suggestions. 3320 -03 3322 o Always use a 128 bit "authentication tag" size for AES GCM, 3323 regardless of the key size. 3325 o Specified that use of a 128 bit IV is REQUIRED with AES CBC. It 3326 was previously RECOMMENDED. 3328 o Removed key size language for ECDSA algorithms, since the key size 3329 is implied by the algorithm being used. 3331 o Stated that the "int" key size must be the same as the hash output 3332 size (and not larger, as was previously allowed) so that its size 3333 is defined for key generation purposes. 3335 o Added the "kdf" (key derivation function) header parameter to 3336 provide crypto agility for key derivation. The default KDF 3337 remains the Concat KDF with the SHA-256 digest function. 3339 o Clarified that the "mod" and "exp" values are unsigned. 3341 o Added Implementation Requirements columns to algorithm tables and 3342 Implementation Requirements entries to algorithm registries. 3344 o Changed AES Key Wrap to RECOMMENDED. 3346 o Moved registries JSON Web Signature and Encryption Header 3347 Parameters and JSON Web Signature and Encryption Type Values to 3348 the JWS specification. 3350 o Moved JSON Web Key Parameters registry to the JWK specification. 3352 o Changed registration requirements from RFC Required to 3353 Specification Required with Expert Review. 3355 o Added Registration Template sections for defined registries. 3357 o Added Registry Contents sections to populate registry values. 3359 o No longer say "the UTF-8 representation of the JWS Secured Input 3360 (which is the same as the ASCII representation)". Just call it 3361 "the ASCII representation of the JWS Secured Input". 3363 o Added "Collision Resistant Namespace" to the terminology section. 3365 o Numerous editorial improvements. 3367 -02 3369 o For AES GCM, use the "additional authenticated data" parameter to 3370 provide integrity for the header, encrypted key, and ciphertext 3371 and use the resulting "authentication tag" value as the JWE 3372 Authentication Tag. 3374 o Defined minimum required key sizes for algorithms without 3375 specified key sizes. 3377 o Defined KDF output key sizes. 3379 o Specified the use of PKCS #5 padding with AES CBC. 3381 o Generalized text to allow key agreement to be employed as an 3382 alternative to key wrapping or key encryption. 3384 o Clarified that ECDH-ES is a key agreement algorithm. 3386 o Required implementation of AES-128-KW and AES-256-KW. 3388 o Removed the use of "A128GCM" and "A256GCM" for key wrapping. 3390 o Removed "A512KW" since it turns out that it's not a standard 3391 algorithm. 3393 o Clarified the relationship between "typ" header parameter values 3394 and MIME types. 3396 o Generalized language to refer to Message Authentication Codes 3397 (MACs) rather than Hash-based Message Authentication Codes (HMACs) 3398 unless in a context specific to HMAC algorithms. 3400 o Established registries: JSON Web Signature and Encryption Header 3401 Parameters, JSON Web Signature and Encryption Algorithms, JSON Web 3402 Signature and Encryption "typ" Values, JSON Web Key Parameters, 3403 and JSON Web Key Algorithm Families. 3405 o Moved algorithm-specific definitions from JWK to JWA. 3407 o Reformatted to give each member definition its own section 3408 heading. 3410 -01 3412 o Moved definition of "alg":"none" for JWSs here from the JWT 3413 specification since this functionality is likely to be useful in 3414 more contexts that just for JWTs. 3416 o Added Advanced Encryption Standard (AES) Key Wrap Algorithm using 3417 512 bit keys ("A512KW"). 3419 o Added text "Alternatively, the Encoded JWS Signature MAY be 3420 base64url decoded to produce the JWS Signature and this value can 3421 be compared with the computed HMAC value, as this comparison 3422 produces the same result as comparing the encoded values". 3424 o Corrected the Magic Signatures reference. 3426 o Made other editorial improvements suggested by JOSE working group 3427 participants. 3429 -00 3431 o Created the initial IETF draft based upon 3432 draft-jones-json-web-signature-04 and 3433 draft-jones-json-web-encryption-02 with no normative changes. 3435 o Changed terminology to no longer call both digital signatures and 3436 HMACs "signatures". 3438 Author's Address 3440 Michael B. Jones 3441 Microsoft 3443 Email: mbj@microsoft.com 3444 URI: http://self-issued.info/