Web Services Security SOAP Messages with Attachments (SwA) Profile 1.0 Interop 1 Scenarios

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 Web Services Security SOAP Messages with Attachments (SwA) Profile 1.0 Interop 1 Scenarios Working Draft 04, 21 Oct 2004 Document identifier: Location: http://www.oasis-open.org/committees/wss/ Editor: Blake Dournaee, Sarvega Inc. <blake@sarvega.com> Contributors: Bruce Rich, IBM <brich@us.ibm.com> Maneesh Sahu, Actional <maneesh@actional.com> Frederick Hirsch, Nokia <Frederick.Hirsch@nokia.com> Abstract: This document formalizes the interoperability scenarios to be used in the first Web Services Security SwA Profile interoperability event. Status: Committee members should send comments on this specification to the wss@lists.oasisopen.org list. Others should subscribe to and send comments to the wsscomment@lists.oasis-open.org list. To subscribe, send an email message to wsscomment-request@lists.oasis-open.org with the word "subscribe" as the body of the message. Copyright OASIS Open 2004. All Rights Reserved. Page 1 of 39

26 Table of Contents 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 Introduction... 5 1.1 Terminology... 5 2 Test Application... 6 2.1 Example Ping Element... 6 2.2 Example PingResponse Element... 6 2.3 SOAP Message Packages... 6 3 Scenario #1: Attachment Signature... 7 3.1 Attachment Properties... 7 3.2 Agreements... 7 3.2.1 CERT-VALUE... 7 3.2.2 Signature Trust Root... 7 3.3 Parameters... 7 3.4 General Message Flow... 7 3.5 First Message Request... 8 3.5.1 Message Elements and Attributes... 8 3.5.2 Message Creation... 8 3.5.3 Responder Message Processing... 9 3.5.4 Example (Non-normative)... 10 3.6 Second Message - Response... 11 3.6.1 Message Elements and Attributes... 11 3.6.2 Message Creation... 11 3.6.3 Message Processing... 11 3.6.4 Example (Non-normative)... 11 3.7 Other processing... 11 3.7.1 Requester... 11 3.7.2 Responder... 12 3.8 Expected Security Properties... 12 4 Scenario #2 Attachment Encryption... 13 4.1 Attachment Properties... 13 4.2 Agreements... 13 4.2.1 CERT-VALUE... 13 4.2.2 Signature Trust Root... 13 4.3 Parameters... 13 4.4 General Message Flow... 13 4.5 First Message - Request... 14 4.5.1 Message Elements and Attributes... 14 4.5.2 Message Creation... 14 4.5.3 Responder Message Processing... 16 4.5.4 Example (Non-normative)... 16 4.6 Second Message - Response... 17 Copyright OASIS Open 2004. All Rights Reserved. Page 2 of 39

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 4.6.1 Message Elements and Attributes... 17 4.6.2 Message Creation... 18 4.6.3 Message Processing... 18 4.6.4 Example (Non-normative)... 18 4.7 Other processing... 18 4.7.1 Requester... 18 4.7.2 Responder... 18 4.8 Expected Security Properties... 18 5 Scenario #3 Attachment Signature and Encryption... 19 5.1 Attachment Properties... 19 5.2 Agreements... 19 5.2.1 CERT-VALUE... 19 5.2.2 Signature Trust Root... 19 5.3 Parameters... 19 5.4 General Message Flow... 20 5.5 First Message - Request... 20 5.5.1 Message Elements and Attributes... 20 5.5.2 Message Creation... 21 5.5.3 Responder Message Processing... 23 5.5.4 Example (Non-normative)... 23 5.6 Second Message - Response... 25 5.6.1 Message Elements and Attributes... 25 5.6.2 Message Creation... 25 5.6.3 Message Processing... 26 5.6.4 Example (Non-normative)... 26 5.7 Other processing... 26 5.7.1 Requester... 26 5.7.2 Responder... 26 5.8 Expected Security Properties... 26 6 Scenario #4 Attachment Signature and Encryption with MIME Headers... 27 6.1 Attachment Properties... 27 6.2 Agreements... 27 6.2.1 CERT-VALUE... 27 6.2.2 Signature Trust Root... 27 6.3 Parameters... 27 6.4 General Message Flow... 28 6.5 First Message - Request... 28 6.5.1 Message Elements and Attributes... 28 6.5.2 Message Creation... 29 6.5.3 Responder Message Processing... 31 6.5.4 Example (Non-normative)... 31 6.6 Second Message - Response... 33 6.6.1 Message Elements and Attributes... 33 Copyright OASIS Open 2004. All Rights Reserved. Page 3 of 39

110 111 112 113 114 115 116 117 118 119 120 121 122 6.6.2 Message Creation... 33 6.6.3 Message Processing... 34 6.6.4 Example (Non-normative)... 34 6.7 Other processing... 34 6.7.1 Requester... 34 6.7.2 Responder... 34 6.8 Expected Security Properties... 34 7 References... 35 7.1 Normative... 35 Appendix A. Ping Application WSDL File... 36 Appendix B. Revision History... 38 Appendix C. Notices... 39 Copyright OASIS Open 2004. All Rights Reserved. Page 4 of 39

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 Introduction This document describes the message exchanges to be tested during the first interoperability event of the Web Services Security SOAP Message with Attachments Profile. All scenarios use the Request/Response Message Exchange Pattern (MEP) with no intermediaries. All scenarios invoke the same simple application. To avoid confusion, they are called Scenario #1 through Scenario #4. These scenarios are intended to test the interoperability of different implementations performing common operations and to test the soundness of the various specifications and clarity and mutual understanding of their meaning and proper application. THESE SCENARIOS ARE NOT INTENDED TO REPRESENT REASONABLE OR USEFUL PRACTICAL APPLICATIONS OF THE SPECIFICATIONS. THEY HAVE BEEN DESIGNED PURELY FOR THE PURPOSES INDICATED ABOVE AND DO NOT NECESSARILY REPRESENT EFFICIENT OR SECURE MEANS OF PERFORMING THE INDICATED FUNCTIONS. IN PARTICULAR THESE SCENARIOS ARE KNOWN TO VIOLATE SECURITY BEST PRACTICES IN SOME RESPECTS AND IN GENERAL HAVE NOT BEEN EXTENSIVELY VETTED FOR ATTACKS. 1.1 Terminology The key words must, must not, required, shall, shall not, should, should not, recommended, may, and optional in this document are to be interpreted as described in [RFC2119]. Copyright OASIS Open 2004. All Rights Reserved. Page 5 of 39

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 2 Test Application All four scenarios use the same, simple application. The Requester sends a Ping element with a value of a string as the single child to a SOAP request. The value should be the name of the organization that has developed the software and the number of the scenario, e.g. Acme Corp. Scenario #1. The Responder returns a PingResponse element with a value of the same string. Each interaction will also include a SOAP attachment secured via one of the content level security mechanisms described in [WSS-SwA]. For the purpose of these interoperability scenarios, the Ping request and response elements will not have security properties applied to them; they are used only to keep track of the specific scenarios. 2.1 Example Ping Element <Ping xmlns="http://xmlsoap.org/ping"> <text>acme Corp. Scenario #1</text> </Ping> 2.2 Example PingResponse Element <PingResponse xmlns="http://xmlsoap.org/ping"> <text> Acme Corp. Scenario #1</text> </PingResponse> 2.3 SOAP Message Packages When SOAP attachments are used as specified in [SwA] the main SOAP payload is accompanied by a MIME header and possibly multiple boundary parts. This is known as a SOAP message package. All interoperability scenarios in this document assume that a proper SOAP message package is constructed using the MIME headers appropriate to [SwA]. Interoperability of the SOAP message package format, including the appropriate use of the MIME header and boundary semantics, is outside the scope of this interoperability document. 2.4 URI Shorthand Notation For brevity, the following shorthand is used in describing URI strings: URI http://docs.oasis-open.org/wss/2004/xx/oasis- 2004XX-wss-swa-profile-1.0#Attachment-Content-Only-Transform http://docs.oasis-open.org/wss/2004/xx/oasis- 2004XX-wss-swa-profile-1.0#Attachment- Complete-Transform Shorthand #Attachment-Content-Only- Transform #Attachment-Complete- Transform 169 Copyright OASIS Open 2004. All Rights Reserved. Page 6 of 39

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 3 Scenario #1: Attachment Signature Scenario #1 tests the interoperability of a signed attachment using an X.509 certificate. The certificate used to verify the signature shall be present in the SOAP header. No security properties are applied to any part of the SOAP envelope.. 3.1 Attachment Properties This section specifies the attachment properties BEFORE security operations are applied. The Content-Type of the attachment MUST be image/jpeg. The Content-Transfer-Encoding MUST be base64. The attachment MUST have a Content-Id header that uniquely identifies the attachment. The generation of the Content-Id header is out of scope. 3.2 Agreements This section describes the agreements that must be made, directly or indirectly between parties who wish to interoperate. 3.2.1 CERT-VALUE This is an opaque identifier indicating the X.509 certificate to be used. The certificate in question MUST be obtained by the Requester by unspecified means. The certificate SHOULD NOT have a KeyUsage extension. If it does contain a KeyUsage extension, it SHOULD include the value of digitalsignature. 3.2.2 Signature Trust Root This refers generally to agreeing on at least one trusted key and any other certificates and sources of revocation information sufficient to validate certificates sent for the purpose of signature verification. 3.3 Parameters This section describes parameters that are required to correctly create or process messages, but not a matter of mutual agreement. No parameters are required. 3.4 General Message Flow This section provides a general overview of the flow of messages. This contract covers a request/response MEP over the HTTP binding. SOAP 1.1 MUST be used. The SOAP envelope MUST be wrapped in a SOAP Message Package as specified by [SwA]. As required by SOAP 1.1, the SOAPAction HTTP header MUST be present. Any value, including a null string may be used. The recipient SHOULD ignore the value. The request contains a signed attachment. The certificate used for signing is included in the message. The Responder verifies the signature over the attachment. If no errors are detected it returns the response with no additional security properties. Copyright OASIS Open 2004. All Rights Reserved. Page 7 of 39

204 205 206 207 208 209 210 3.5 First Message Request 3.5.1 Message Elements and Attributes Elements not listed in the following table MAY be present, but MUST NOT be marked with the mustunderstand= 1 attribute. Items marked mandatory MUST be generated and processed. Items marked optional MAY be generated and MUST be processed if present. Items MUST appear in the order specified, except as noted. Name Envelope Header Security mustunderstand= 1 BinarySecurityToken Signature SignedInfo CanonicalizationMethod SignatureMethod Reference Transforms Transform SignatureValue KeyInfo Body Ping? 211 212 213 214 215 216 217 218 219 220 3.5.2 Message Creation 3.5.2.1 Security The Security element MUST contain the mustunderstand= 1 attribute. 3.5.2.2 BinarySecurityToken The ValueType MUST be X509v3. The EncodingType MUST be Base64Binary. The token MUST be labeled with an Id so it can be referenced by the signature. The value MUST be a public key certificate suitable for verifying the signature. The certificate SHOULD NOT have a KeyUsage extension. If it does contain a KeyUsage extension, it SHOULD include the value of digitalsignature. The Requester must have access to the private key corresponding to the public key in the certificate. Copyright OASIS Open 2004. All Rights Reserved. Page 8 of 39

221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 3.5.2.3 Signature The signature is over the attachment content only, using the #Attachment-Content-Only- Transform 3.5.2.3.1 SignedInfo The CanonicalizationMethod MUST be Exclusive Canonicalization. The SignatureMethod MUST be RSA-SHA1. 3.5.2.3.2 Reference The Reference MUST specify a URI using the cid scheme that points to the Content-Id of the attachment. The only Transform specified MUST be #Attachment-Content-Only. The DigestMethod MUST be SHA1. 3.5.2.3.3 SignatureValue The SignatureValue MUST be calculated as specified by the specification, using the private key corresponding to the public key specified in the certificate in the BinarySecurityToken. 3.5.2.3.4 KeyInfo The KeyInfo MUST contain a SecurityTokenReference with a reference to a relative URI which indicates the BinarySecurityToken containing the certificate which will be used for signature verification. 3.5.2.4 Post Operation Attachment Properties This section specifies the attachment properties AFTER security operations are applied. The Content-Type of the attachment MUST be image/jpeg. The Content-Transfer-Encoding MUST be base64. The attachment MUST have a Content-Id header that uniquely identifies the attachment. The generation of the Content-Id header is out of scope. 3.5.3 Responder Message Processing This section describes the processing performed by the Responder. If an error is detected, the Responder MUST cease processing the message and issue a Fault with a value of FailedAuthentication. 3.5.3.1 Security 3.5.3.2 BinarySecurityToken The certificate in the token MUST be validated. The Subject of the certificate MUST be an authorized entity. The public key in the certificate MUST be retained for verification of the signature. 3.5.3.3 Signature The attachment MUST be verified against the signature using the specified algorithms and transforms and the retained public key. 3.5.3.4 Attachment After the attachment s signature has been verified, it should be passed to the application. Copyright OASIS Open 2004. All Rights Reserved. Page 9 of 39

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 3.5.4 Example (Non-normative) Content-Type: multipart/related; boundary= sig-example ; type= text/xml --sig-example Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xmlns:xsd="http://www.w3.org/2001/xmlschema"> <soap:header> <wsse:security soap:mustunderstand= 1 xmlns:wsse="docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext-1.0.xsd"> <!-- This is the certificate used to verify the signature --> <wsse:binarysecuritytoken ValueType="wsse:X509v3" EncodingType="wsse:Base64Binary" xmlns:wsu="http://docs.oasis open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:id="mysigcert">mii...hk</wsse:binarysecuritytoken> <Signature xmlns="http://www.w3.org/2000/09/xmldsig#"> <SignedInfo> <CanonicalizationMethod Algorithm= http://www.w3.org/2001/10/xml-exc-c14n# /> <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/> <Reference URI="cid:signature"> <Transforms> <Transform Algorithm="http://docs.oasis-open.org/wss/2004/XX/oasis- 2004XX-wss-swa-profile-1.0#Attachment-Content-Only-Transform"/> </Transforms> <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/> <DigestValue>QTV...dw=</DigestValue> </Reference> </SignedInfo> <SignatureValue>H+x0...gUw=</SignatureValue> <KeyInfo> <wsse:securitytokenreference> <wsse:reference URI="#mySigCert" /> </wsse:securitytokenreference> </KeyInfo> </Signature> </wsse:security> </soap:header> <soap:body> <Ping xmlns="http://xmlsoap.org/ping"> <text>acme Corp. Scenario #1</text> </Ping> </soap:body> </soap:envelope> --sig-example Content-Type: image/jpeg Content-Id: <signature> Content-Transfer-Encoding: base64 Dcg3AdGFcFs3764fddSArk Copyright OASIS Open 2004. All Rights Reserved. Page 10 of 39

315 316 317 318 319 320 3.6 Second Message - Response 3.6.1 Message Elements and Attributes Items not listed in the following table MUST NOT be created or processed. Items marked mandatory MUST be generated and processed. Items marked optional MAY be generated and MUST be processed if present. Items MUST appear in the order specified, except as noted. Name Envelope Body PingResponse? 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 3.6.2 Message Creation 3.6.2.1 Security There are no security properties on the response message 3.6.2.2 Body The body element MUST be not be signed or encrypted 3.6.3 Message Processing The response is passed to the application without modification. 3.6.4 Example (Non-normative) Here is an example response. <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xmlns:xsd="http://www.w3.org/2001/xmlschema"> <soap:body> <PingResponse xmlns="http://xmlsoap.org/ping"> <text> Acme Corp. Scenario #1</text> </PingResponse> </soap:body> </soap:envelope> 3.7 Other processing This section describes processing that occurs outside of generating or processing a message. 3.7.1 Requester No additional processing is required. Copyright OASIS Open 2004. All Rights Reserved. Page 11 of 39

346 347 348 349 350 351 3.7.2 Responder No additional processing is required. 3.8 Expected Security Properties Use of the service is restricted to authorized parties that sign the attachment. The attachment of the request is protected against modification and interception. The response does not have any security properties. Copyright OASIS Open 2004. All Rights Reserved. Page 12 of 39

352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 4 Scenario #2 Attachment Encryption The SOAP request has an attachment that has been encrypted. The encryption is done using a symmetric cipher. The symmetric encryption key is further encrypted for a specific recipient identified by an X.509 certificate. The certificate associated with the key encryption is provided to the requestor out-of-band. No security properties are applied to any part of the SOAP envelope. 4.1 Attachment Properties This section specifies the attachment properties BEFORE security operations are applied. The Content-Type of the attachment MUST be image/jpeg. The Content-Transfer-Encoding MUST be base64. The attachment MUST have a Content-Id header that uniquely identifies the attachment. The generation of the Content-Id header is out of scope. 4.2 Agreements This section describes the agreements that must be made, directly or indirectly between parties who wish to interoperate. 4.2.1 CERT-VALUE This is an opaque identifier indicating the X.509 certificate to be used. The certificate in question MUST be obtained by the Requester by unspecified means. The certificate SHOULD NOT have a KeyUsage extension. If it does contain a KeyUsage extension, it SHOULD include the values of keyencipherment. The Responder MUST have access to the Private key corresponding to the Public key in the certificate. 4.2.2 Signature Trust Root There is no digital signature operation for this scenario 4.3 Parameters This section describes parameters that are required to correctly create or process messages, but not a matter of mutual agreement. No parameters are required. 4.4 General Message Flow This section provides a general overview of the flow of messages. This contract covers a request/response MEP over the HTTP binding. SOAP 1.1 MUST be used. The SOAP envelope MUST be wrapped in a SOAP Message Package as specified by [SwA]. The Content-Transfer-Encoding for the encrypted attachment MUST be base64. As required by SOAP 1.1, the SOAPAction HTTP header MUST be present. Any value, including a null string may be used. The recipient SHOULD ignore the value. The request contains an encrypted SOAP attachment. The attachment is encrypted with a random symmetric key, which is encrypted using a public key certificate. The certificate used for the encryption is provided to the Requestor out of band. The Responder decrypts the attachment using the symmetric key which is decrypted with the matching private key. If no errors are detected it returns the response without any security properties. If there is a decryption failure a fault is returned as outlined in section 4.5.3. Copyright OASIS Open 2004. All Rights Reserved. Page 13 of 39

390 391 392 393 394 395 396 4.5 First Message - Request 4.5.1 Message Elements and Attributes Items not listed in the following table MAY be present, but MUST NOT be marked with the mustunderstand= 1 attribute. Items marked mandatory MUST be generated and processed. Items marked optional MAY be generated and MUST be processed if present. Items MUST appear in the order specified, except as noted. Name Envelope Header Security mustunderstand= 1 BinarySecurityToken EncryptedKey EncryptionMethod KeyInfo SecurityTokenReference CipherData ReferenceList EncryptedData EncryptionMethod CipherData CipherReference Transforms Transform Body Ping? 397 398 399 4.5.2 Message Creation 4.5.2.1 Security The Security element MUST contain the mustunderstand= 1 attribute. Copyright OASIS Open 2004. All Rights Reserved. Page 14 of 39

400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 4.5.2.2 BinarySecurityToken The ValueType MUST be X509v3. The EncodingType MUST be Base64Binary. The token MUST be labeled with an Id so it can be referenced EncryptedKey security token reference. The value MUST be a Public Key certificate suitable for symmetric key encryption. The certificate SHOULD NOT have a KeyUsage extension. If it does contain a KeyUsage extension, it SHOULD include the values of keyencipherment and dataencipherment. The Responder must have access to the private key corresponding to the public key in the certificate. 4.5.2.3 EncryptedKey The EncryptionMethod MUST contain the Algorithm attribute. The algorithm MUST be RSA v1.5. The KeyInfo MUST contain a SecurityTokenReference with a reference to a relative URI which indicates the BinarySecurityToken containing the certificate which will be used to decrypt the symmetric key. The CipherData MUST contain the encrypted form of the random key, encrypted under the Public Key specified in the specified X.509 certificate, using the specified algorithm. The ReferenceList MUST contain a DataReference which has the value of a relative URI that refers to the EncryptedData element that refers to the encrypted attachment. 4.5.2.4 EncryptedData The EncryptedData element refers to the encrypted attachment. The Type attribute MUST be present and it MUST have a value of #Attachment-Content-Only. The EncryptedData element MUST be referenced by the ReferenceList element in the EncryptedKey element. The EncryptedData MUST have a MimeType attribute with the value of image/jpeg. 4.5.2.5 EncryptionMethod The encryption method MUST be Triple-DES in CBC mode. 4.5.2.6 CipherData The CipherData MUST refer to the encrypted attachment with a CipherReference element. The CipherReference element MUST refer to the attachment using a URI with a cid scheme. The CipherReference must have a single Transforms element with a single Transform child with an Algorithm attribute value of #Attachment-Content-Only-Transform. 4.5.2.7 Body The body element MUST not have any security operations applied to it. 4.5.2.8 Ping The Ping element should contain the scenario number and the name of the entity performing the request. 4.5.2.9 Post Operation Attachment Properties This section specifies the attachment properties AFTER security operations are applied. The Content-Type of the attachment MUST be application/octet-stream. The Content-Transfer- Encoding MUST be base64. The attachment MUST have a Content-Id header that uniquely identifies the attachment. The generation of the Content-Id header is out of scope. The Content-Id MUST match the Content-Id before encryption. Copyright OASIS Open 2004. All Rights Reserved. Page 15 of 39

440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 4.5.3 Responder Message Processing This section describes the processing performed by the Responder. If an error is detected, the Responder MUST cease processing the message and issue a Fault with a value of FailedDecryption. 4.5.3.1 Security 4.5.3.2 BinarySecurityToken The public key in the certificate MUST be used to decrypt the symmetric key. No trust validation of the public key is required. The responder MUST have the matching private key. 4.5.3.3 EncryptedKey The random key contained in the CipherData MUST be decrypted using the private key corresponding to the certificate specified by the SecurityTokenReference, using the specified algorithm. 4.5.3.4 EncryptedData The attachment referred to by the EncrypteData MUST be decrypted using the encrypted symmetric key. 4.5.3.5 Attachment After decrypting the attachment, it should be passed to the application 4.5.4 Example (Non-normative) Here is an example request. Content-Type: multipart/related; boundary= enc-example ; type= text/xml --enc-example Content-Type: text/xml; charset=utf-8 <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xmlns:xsd="http://www.w3.org/2001/xmlschema"> <soap:header> <wsse:security soap:mustunderstand= 1 xmlns:wsse="docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext-1.0.xsd"> <!-- This certificate is used for symmetric key encryption --> <wsse:binarysecuritytoken ValueType="wsse:X509v3" EncodingType="wsse:Base64Binary" xmlns:wsu="httphttp://docs.oasis open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:id="myenccert">mii...hk</wsse:binarysecuritytoken> <xenc:encryptedkey xmlns:xenc="http://www.w3.org/2001/04/xmlenc#"> <xenc:encryptionmethod Algorithm="http://www.w3.org/2001/04/xmlenc#rsa-1_5" /> <KeyInfo xmlns="http://www.w3.org/2000/09/xmldsig#"> <wsse:securitytokenreference> <wsse:reference URI="#myEncCert" /> </wsse:securitytokenreference> </KeyInfo> <xenc:cipherdata> <xenc:ciphervalue>dnys...fq=</xenc:ciphervalue> Copyright OASIS Open 2004. All Rights Reserved. Page 16 of 39

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 </xenc:cipherdata> <xenc:referencelist> <xenc:datareference URI="#encrypted-attachment" /> </xenc:referencelist> </xenc:encryptedkey> <!-- The EncryptedData portion here refers to content of the attachment --> <xenc:encrypteddata wsu:id="encrypted-attachment" Type="http://docs.oasis-open.org/wss/2004/XX/oasis-2004XX-wss-swa-profile- 1.0#Attachment-Content-Only MimeType= image/jpeg"> xmlns:xenc="http://www.w3.org/2001/04/xmlenc#"> <xenc:encryptionmethod Algorithm="http://www.w3.org/2001/04/xmlenc#tripledes-cbc" /> <xenc:cipherdata> <xenc:cipherreference URI= cid:enc > <xenc:transforms> <ds:transform Algorithm= http://docs.oasis-open.org/wss/2004/xx/oasis-2004xx-wss-swaprofile-1.0#attachment-content-only-transform /> <ds:transform </xenc:transforms> </xenc:cipherreference> </xenc:cipherdata> </xenc:encrypteddata> </wsse:security> </soap:header> <soap:body> <Ping xmlns="http://xmlsoap.org/ping"> <text>acme Corp. Scenario #2</text> </Ping> </soap:body> </soap:envelope> --enc-example Content-Type: application/octet-stream Content-Id: <enc> Content-Transfer-Encoding: base64 Dsh5SA3thsRh3Dh54wafDhjaq2 4.6 Second Message - Response 4.6.1 Message Elements and Attributes Items not listed in the following table MUST NOT be created or processed. Items marked mandatory MUST be generated and processed. Items marked optional MAY be generated and MUST be processed if present. Items MUST appear in the order specified, except as noted. Name Envelope Body PingResponse? 537 Copyright OASIS Open 2004. All Rights Reserved. Page 17 of 39

538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 4.6.2 Message Creation The response message MUST NOT contain a <wsse:security> header. Any other header elements MUST NOT be labeled with a mustunderstand= 1 attribute. 4.6.2.1 Security There are no security properties on the response message 4.6.2.2 Body The body element MUST be not be signed or encrypted 4.6.3 Message Processing The response is passed to the application without modification. 4.6.4 Example (Non-normative) Here is an example response. <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xmlns:xsd="http://www.w3.org/2001/xmlschema"> <soap:body> <PingResponse xmlns="http://xmlsoap.org/ping"> <text> Acme Corp. Scenario #2</text> </PingResponse> </soap:body> </soap:envelope> 4.7 Other processing This section describes processing that occurs outside of generating or processing a message. 4.7.1 Requester No additional processing is required. 4.7.2 Responder No additional processing is required. 4.8 Expected Security Properties The attachment content is private for the holder of the appropriate private key. There should be no inferences made regarding the authenticity of the sender. The response is not protected in any way. Copyright OASIS Open 2004. All Rights Reserved. Page 18 of 39

569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 5 Scenario #3 Attachment Signature and Encryption The SOAP request contains an attachment that has been signed and then encrypted. The certificate associated with the encryption is provided out-of-band to the requestor. The certificate used to verify the signature is provided in the header. The Response Body is not signed or encrypted. There are two certificates in the request message. One identifiers the recipient of the encrypted attachment and one identifies the signer. 5.1 Attachment Properties This section specifies the attachment properties BEFORE security operations are applied. The Content-Type of the attachment MUST be text/xml. The Content-Transfer-Encoding MUST be 8bit ASCII (8bit). The attachment MUST have a Content-Id header that uniquely identifies the attachment. The generation of the Content-Id header is out of scope. An example of what the attachment may look like before encryption and signing is shown as follows. This example is nonnormative. --enc-sig-example Content-Type: text/xml; charset=utf-8 Content-Transfer-Encoding: 8bit Content-ID: <encsignexample> <?xml version=1.0 encoding= utf-8?> <somexml/> 5.2 Agreements This section describes the agreements that must be made, directly or indirectly between parties who wish to interoperate. 5.2.1 CERT-VALUE This is an opaque identifier indicating the X.509 certificate to be used. The certificate in question MUST be obtained by the Requester by unspecified means. The certificate SHOULD NOT have a KeyUsage extension. If it does contain a KeyUsage extension, it SHOULD include the values of keyencipherment, dataencipherment and digitalsignature. The Responder MUST have access to the private key corresponding to the public key in the certificate. 5.2.2 Signature Trust Root This refers generally to agreeing on at least one trusted key and any other certificates and sources of revocation information sufficient to validate certificates sent for the purpose of signature verification. 5.3 Parameters This section describes parameters that are required to correctly create or process messages, but not a matter of mutual agreement. No parameters are required. Copyright OASIS Open 2004. All Rights Reserved. Page 19 of 39

609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 5.4 General Message Flow This section provides a general overview of the flow of messages. This contract covers a request/response MEP over the HTTP binding. SOAP 1.1 MUST be used. The SOAP envelope MUST be wrapped in a SOAP Message Package as specified by [SwA]. The Content-Transfer-Encoding for the encrypted attachment MUST be base64. As required by SOAP 1.1, the SOAPAction HTTP header MUST be present. Any value, including a null string may be used. The recipient SHOULD ignore the value. The request contains an attachment, which is signed and then encrypted. The certificate for encryption is provided externally to the requestor but conveyed in the request message. The attachment is encrypted with a random symmetric key that is encrypted with a public key certificate. The certificate for signing is included in the message. The Responder decrypts the attachment using its private key and then verifies the signature using the included public key certificate. If no errors are detected it returns the Response with no security properties. 5.5 First Message - Request 5.5.1 Message Elements and Attributes Items not listed in the following table MAY be present, but MUST NOT be marked with the mustunderstand= 1 attribute. Items marked mandatory MUST be generated and processed. Items marked optional MAY be generated and MUST be processed if present. Items MUST appear in the order specified, except as noted. Name Envelope Header Security mustunderstand= 1 BinarySecurityToken EncryptedKey EncryptionMethod KeyInfo SecurityTokenReference CipherData ReferenceList EncryptedData EncryptionMethod CipherData CipherReference? Copyright OASIS Open 2004. All Rights Reserved. Page 20 of 39

Transforms Transform BinarySecurityToken Signature SignedInfo CanonicalizationMethod SignatureMethod Reference Transforms Transform SignatureValue KeyInfo Body Ping 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 5.5.2 Message Creation 5.5.2.1 Security The Security element MUST contain the mustunderstand= 1 attribute. 5.5.2.2 BinarySecurityToken The ValueType MUST be X509v3. The EncodingType MUST be Base64Binary. The token MUST be labeled with an Id so it can be uniquely referenced. The value MUST be a PK certificate suitable for encrypting the content. The certificate SHOULD NOT have a KeyUsage extension. If it does contain a KeyUsage extension, it SHOULD include the value of keyencipherment and dataencipherment. 5.5.2.3 EncryptedKey The EncryptionMethod MUST contain the Algorithm attribute. The algorithm MUST be RSA v1.5. The KeyInfo MUST contain a SecurityTokenReference with a Reference child that points to the X.509 certificate of the recipient. The Reference child should point to a relative URI which indicates the BinarySecurityToken containing the certificate which will be used to decrypt the symmetric key. The CipherData MUST contain the encrypted form of the random key, encrypted under the Public Key specified in the specified X.509 certificate, using the specified algorithm. The ReferenceList MUST contain a DataReference which has the value of a relative URI that refers to the EncryptedData element that refers to the encrypted attachment. Copyright OASIS Open 2004. All Rights Reserved. Page 21 of 39

648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 5.5.2.4 EncryptedData The EncryptedData element refers to the encrypted attachment. The Type attribute MUST be present and it MUST have a value of #Attachment-Content-Only. The EncryptedData element MUST be referenced by the ReferenceList element in the EncryptedKey element. The EncryptedData MUST have a MimeType attribute with the value of text/xml. 5.5.2.5 EncryptionMethod The encryption method MUST be Triple-DES in CBC mode. 5.5.2.6 CipherData The CipherData MUST refer to the encrypted attachment with a CipherReference element. The CipherReference element MUST refer to the attachment using a URI with a cid scheme. The CipherReference must have a Transforms child with a single Transform sub child with the value of #Attachment-Content-Only-Transform. 5.5.2.7 BinarySecurityToken The ValueType MUST be X509v3. The EncodingType MUST be Base64Binary. The token MUST be labeled with an Id so it can be referenced by the signature. The value MUST be a PK certificate suitable for verifying the signature. The certificate SHOULD NOT have a KeyUsage extension. If it does contain a KeyUsage extension, it SHOULD include the values of digitalsignature. The Requester must have access to the private key corresponding to the public key in the certificate. 5.5.2.8 Signature The signature is over the attachment content only, using the #Attachment-Content-Only- Transform 5.5.2.8.1 SignedInfo The CanonicalizationMethod MUST be Exclusive Canonicalization. The SignatureMethod MUST be RSA-SHA1. 5.5.2.8.2 Reference The Reference MUST specify a URI using the cid scheme that points to the Content-Id of the attachment. The only Transform specified MUST be #Attachment-Content-Only. The DigestMethod MUST be SHA1. 5.5.2.8.3 SignatureValue The SignatureValue MUST be calculated as specified by the specification, using the private key corresponding to the public key specified in the certificate in the BinarySecurityToken. 5.5.2.8.4 KeyInfo The KeyInfo MUST contain a SecurityTokenReference with a reference to a relative URI which indicates the BinarySecurityToken containing the certificate which will be used for signature verification. 5.5.2.9 Body The contents of the body MUST NOT be encrypted or signed Copyright OASIS Open 2004. All Rights Reserved. Page 22 of 39

686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 5.5.2.10 Post Operation Attachment Properties This section specifies the attachment properties AFTER security operations are applied. The Content-Type of the attachment MUST be application/octet-stream. The Content-Transfer- Encoding MUST be base64. The attachment MUST have a Content-Id header that uniquely identifies the attachment. The generation of the Content-Id header is out of scope. The Content-Id MUST match the Content-Id before encryption. 5.5.3 Responder Message Processing This section describes the processing performed by the Responder. If an error is detected, the Responder MUST cease processing the message and issue a Fault with a value of FailedAuthentication. 5.5.3.1 Security 5.5.3.2 BinarySecurityToken The public key in the certificate MUST be used to decrypt the symmetric key. No trust validation of the public key is required. The responder MUST have the matching private key. 5.5.3.3 EncryptedKey The random key contained in the CipherData MUST be decrypted using the private key corresponding to the certificate specified by the SecurityTokenReference, using the specified algorithm. 5.5.3.4 EncryptedData The attachment referred to by the EncryptedData MUST be decrypted using the encrypted symmetric key. 5.5.3.5 Attachment After decrypting the attachment, it should have its signature verified 5.5.3.6 BinarySecurityToken The certificate in the token MUST be validated. The Subject of the certificate MUST be an authorized entity. The public key in the certificate MUST be retained for verification of the signature. 5.5.3.7 Signature The attachment MUST be verified against the signature using the specified algorithms and transforms and the retained public key. 5.5.3.8 Attachment After the attachment s signature has been verified, it should be passed to the application 5.5.4 Example (Non-normative) Here is an example request. Content-Type: multipart/related; boundary= enc-sig-example ; type= text/xml --enc-sig-example Content-Type: text/xml; charset=utf-8 Copyright OASIS Open 2004. All Rights Reserved. Page 23 of 39

723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xmlns:xsd="http://www.w3.org/2001/xmlschema"> <soap:header> <wsse:security soap:mustunderstand= 1 xmlns:wsse="docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext-1.0.xsd"> <!-- This certificate is used for symmetric key encryption --> <wsse:binarysecuritytoken ValueType="wsse:X509v3" EncodingType="wsse:Base64Binary" xmlns:wsu="httphttp://docs.oasis open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:id="myenccert">mii...hk</wsse:binarysecuritytoken> <xenc:encryptedkey xmlns:xenc="http://www.w3.org/2001/04/xmlenc#"> <xenc:encryptionmethod Algorithm="http://www.w3.org/2001/04/xmlenc#rsa-1_5" /> <KeyInfo xmlns="http://www.w3.org/2000/09/xmldsig#"> <wsse:securitytokenreference> <wsse:reference URI="#myEncCert" /> </wsse:securitytokenreference> </KeyInfo> <xenc:cipherdata> <xenc:ciphervalue>dnys...fq=</xenc:ciphervalue> </xenc:cipherdata> <xenc:referencelist> <xenc:datareference URI="#encrypted-signed-attachment" /> </xenc:referencelist> </xenc:encryptedkey> <!-- The EncryptedData portion here refers to content of the attachment --> <xenc:encrypteddata wsu:id="encrypted-signed-attachment" Type="http://docs.oasis-open.org/wss/2004/XX/oasis-2004XX-wss-swa-profile- 1.0#Attachment-Content-Only MimeType= text/xml"> xmlns:xenc="http://www.w3.org/2001/04/xmlenc#"> <xenc:encryptionmethod Algorithm="http://www.w3.org/2001/04/xmlenc#tripledes-cbc" /> <xenc:cipherdata> <xenc:cipherreference URI= cid:encsignexample > <xenc:transforms> <ds:transform Algorithm= http://docs.oasis-open.org/wss/2004/xx/oasis-2004xx-wss-swaprofile-1.0#attachment-content-only-transform /> </xenc:transforms> </xenc:cipherreference> </xenc:cipherdata> </xenc:encrypteddata> <!-- This certificate is used to verify the signature --> <wsse:binarysecuritytoken ValueType="wsse:X509v3" EncodingType="wsse:Base64Binary" xmlns:wsu="http://docs.oasis open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:id="mysigcertcert">mii...hk</wsse:binarysecuritytoken> <Signature xmlns="http://www.w3.org/2000/09/xmldsig#"> <SignedInfo> <CanonicalizationMethod Algorithm= http://www.w3.org/2001/10/xml-exc-c14n# /> <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/> <Reference URI="cid:encsignexample"> <Transforms> <Transform Algorithm="http://docs.oasis-open.org/wss/2004/XX/oasis- 2004XX-wss-swa-profile-1.0#Attachment-Content-Only-Transform"/> Copyright OASIS Open 2004. All Rights Reserved. Page 24 of 39

792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 </Transforms> <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/> <DigestValue>QTV...dw=</DigestValue> </Reference> </SignedInfo> <SignatureValue>H+x0...gUw=</SignatureValue> <KeyInfo> <wsse:securitytokenreference> <wsse:reference URI="#mySigCert" /> </wsse:securitytokenreference> </KeyInfo> </Signature> </wsse:security> </soap:header> <soap:body> <Ping xmlns="http://xmlsoap.org/ping"> <text>acme Corp. Scenario #3</text> </Ping> </soap:body> </soap:envelope> --enc-sig-example Content-Type: application/octet-stream Content-Id: <encsignexample> Content-Transfer-Encoding: base64 FEWMMIIfc93ASjfdjsa358sa98xsjcx 5.6 Second Message - Response 5.6.1 Message Elements and Attributes Items not listed in the following table MUST NOT be created or processed. Items marked mandatory MUST be generated and processed. Items marked optional MAY be generated and MUST be processed if present. Items MUST appear in the order specified, except as noted. Name Envelope Body PingResponse? 825 826 827 828 829 830 831 832 5.6.2 Message Creation The response message MUST NOT contain a <wsse:security> header. Any other header elements MUST NOT be labeled with a mustunderstand= 1 attribute. 5.6.2.1 Security There are no security properties on the response message 5.6.2.2 Body The body element MUST be not be signed or encrypted Copyright OASIS Open 2004. All Rights Reserved. Page 25 of 39

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 5.6.3 Message Processing The response is passed to the application without modification. 5.6.4 Example (Non-normative) Here is an example response. <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xmlns:xsd="http://www.w3.org/2001/xmlschema"> <soap:body> <PingResponse xmlns="http://xmlsoap.org/ping"> <text> Acme Corp. Scenario #3</text> </PingResponse> </soap:body> </soap:envelope> 5.7 Other processing This section describes processing that occurs outside of generating or processing a message. 5.7.1 Requester No additional processing is required. 5.7.2 Responder No additional processing is required. 5.8 Expected Security Properties Use of the service is restricted to authorized parties that sign the attachment. The request attachment is protected against modification and interception. The response is not protected in any way. Copyright OASIS Open 2004. All Rights Reserved. Page 26 of 39

858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 6 Scenario #4 Attachment Signature and Encryption with MIME Headers The SOAP request contains an attachment that has been signed and then encrypted. The certificate associated with the encryption is provided out-of-band to the requestor. The certificate used to verify the signature is provided in the header. The Response Body is not signed or encrypted. There are two certificates in the request message. One identifies the recipient of the encrypted attachment and one identifies the signer. This scenario differs from the first three scenarios in that it covers MIME headers in the signature and encryption. This means that it uses the Attachment-Complete Signature Reference Transform and Attachment-Complete EncryptedData Type. Aside from these two changes, this scenario is identical to Scenario #3. 6.1 Attachment Properties This section specifies the attachment properties BEFORE security operations are applied. The Content-Type of the attachment MUST be text/xml. The Content-Transfer-Encoding MUST be 8bit ASCII (8bit). The attachment MUST have a Content-Id header that uniquely identifies the attachment. The generation of the Content-Id header is out of scope. An example of what the attachment may look like before encryption and signature is shown as follows: --enc-sig-headers-example Content-Type: text/xml; charset=utf-8 Content-Transfer-Encoding: 8bit Content-ID: <enc-sig-headers-example> <?xml version=1.0 encoding= utf-8?> <somexml/> 6.2 Agreements This section describes the agreements that must be made, directly or indirectly between parties who wish to interoperate. 6.2.1 CERT-VALUE This is an opaque identifier indicating the X.509 certificate to be used. The certificate in question MUST be obtained by the Requester by unspecified means. The certificate SHOULD NOT have a KeyUsage extension. If it does contain a KeyUsage extension, it SHOULD include the values of keyencipherment, dataencipherment and digitalsignature. The Responder MUST have access to the private key corresponding to the public key in the certificate. 6.2.2 Signature Trust Root This refers generally to agreeing on at least one trusted key and any other certificates and sources of revocation information sufficient to validate certificates sent for the purpose of signature verification. 6.3 Parameters This section describes parameters that are required to correctly create or process messages, but not a matter of mutual agreement. Copyright OASIS Open 2004. All Rights Reserved. Page 27 of 39

899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 No parameters are required. 6.4 General Message Flow This section provides a general overview of the flow of messages. This contract covers a request/response MEP over the HTTP binding. SOAP 1.1 MUST be used. The SOAP envelope MUST be wrapped in a SOAP Message Package as specified by [SwA]. The Content-Transfer-Encoding for the encrypted attachment MUST be base64. As required by SOAP 1.1, the SOAPAction HTTP header MUST be present. Any value, including a null string may be used. The recipient SHOULD ignore the value. The request contains an attachment, which is signed and then encrypted. The certificate for encryption is provided externally to the requestor but conveyed in the request message. The attachment is encrypted with a random symmetric key that is encrypted with a public key certificate. The certificate for signing is included in the message. The Responder decrypts the attachment using its private key and then verifies the signature using the included public key certificate. If no errors are detected it returns the Response with no security properties. 6.5 First Message - Request 6.5.1 Message Elements and Attributes Items not listed in the following table MAY be present, but MUST NOT be marked with the mustunderstand= 1 attribute. Items marked mandatory MUST be generated and processed. Items marked optional MAY be generated and MUST be processed if present. Items MUST appear in the order specified, except as noted. Name Envelope Header Security mustunderstand= 1 BinarySecurityToken EncryptedKey EncryptionMethod KeyInfo SecurityTokenReference CipherData ReferenceList EncryptedData EncryptionMethod CipherData? Copyright OASIS Open 2004. All Rights Reserved. Page 28 of 39