Key Management Interoperability Protocol HTTPS Profile Version 1.0

Transcription

1 Key Management Interoperability Protocol HTTPS Profile Version 1.0 Working Draft June 2012 Technical Committee: OASIS Key Management Interoperability Protocol (KMIP) TC Chairs: Robert Griffin EMC Corporation Subhash Sankuratripati NetApp Editors: Tim Hudson Cryptsoft Related work: This specification is related to: Key Management Interoperability Protocol Profiles Version October OASIS Standard. Key Management Interoperability Protocol Specification Version 1.1. Latest version. Key Management Interoperability Protocol Use Cases Version 1.1. Latest version. Key Management Interoperability Protocol Usage Guide Version 1.1. Latest version. Abstract: Describes an HTTP encoding alternative to the raw TTLV encoding. Status: This Working Draft (WD) has been produced by one or more TC Members; it has not yet been voted on by the TC or approved as a Committee Draft (Committee Specification Draft or a Committee Note Draft). The OASIS document Approval Process begins officially with a TC vote to approve a WD as a Committee Draft. A TC may approve a Working Draft, revise it, and reapprove it any number of times as a Committee Draft. Copyright OASIS Open All Rights Reserved. All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Standards Track Draft Copyright OASIS Open All Rights Reserved. Page 1 of 10

2 Table of Contents 1 Introduction Terminology Normative References Non-Normative References HTTPS Profile Authentication Suite KMIP Port Number Request URI HTTP Encoding HTTPS Profile Test Cases Query, Maximum Response Size Test Case: Query, Maximum Response Size... 5 Appendix A. Acknowledgments Standards Track Draft Copyright OASIS Open All Rights Reserved. Page 2 of 10

3 1 Introduction For normative definition of the elements of KMIP see the KMIP Specification ([KMIP-SPEC-1_0 and KMIP-SPEC-1_1]) and the KMIP Profiles ([KMIP-PROF]). Illustrative guidance for the implementation of KMIP clients and servers is provided in the KMIP Usage Guide ([KMIP-UG]) and KMIP Use Cases ([KMIP_UC]). This profile defines the necessary encoding rules for the transport of KMIP TTLV messages via the Hypertext Transfer Protocol ([RFC2616]) over TLS as specified in HTTP over TLS ([RFC2818]). 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]. 1.2 Normative References [RFC1945] T. Berners-Lee, R. Fielding, H. Frystyk, Hypertext Transfer Protocol -- HTTP/1.0, IETF RFC 1945, May [RFC2119] S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, IETF RFC 2119, March [RFC2246] T. Dierks and C. Allen, The TLS Protocol, Version 1.0, IETF RFC 2246, Jan 1999, [RFC2616] R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L. Masinter, P. Leach, T. Berners- Lee, Hypertext Transfer Protocol -- HTTP/1.1, IETF RFC 2616, June [RFC2818] E. Rescorla, HTTP over TLS, IETF RFC 2818, May 2000, [KMIP-SPEC-1_0] OASIS Standard, Key Management Interoperability Protocol Specification Version 1.0, October 2010, [KMIP-SPEC-1_1] Key Management Interoperability Protocol Specification Version Committee Specification Draft 01.1 December [KMIP-PROF] Key Management Interoperability Protocol Usage Guide Version December OASIS Standard Non-Normative References [KMIP-UG] Key Management Interoperability Protocol Usage Guide Version Committee Note Draft, 1 December 2011, [KMIP-TC] Key Management Interoperability Protocol Test Cases Version Committee Note Draft, 1 December Standards Track Draft Copyright OASIS Open All Rights Reserved. Page 3 of 10

4 2 HTTPS Profile The Hypertext Transfer Protocol over Transport Layer Security (HTTPS) is simply the use of HTTP over TLS in the same manner that HTTP is used over TCP. KMIP over HTTPS is simply the use of KMIP messages over HTTPS in the same manner than KMIP is used over TLS. 2.1 Authentication Suite Implementations conformant to this profile SHALL support one or more of the Authentication Suites defined within section 3 of [KMIP-PROF]. The establishment of the trust relationship between the KMIP client and the KMIP server is same as the defined base profiles. 2.2 KMIP Port Number KMIP servers conformant to this profile MAY use TCP port number 5696, as assigned by IANA, to receive and send KMIP messages provided that both HTTP and non-http encoded messages are supported. KMIP clients SHALL enable end user configuration of the TCP port number used, as a KMIP server may specify a different TCP port number. 2.3 Request URI KMIP servers conformant to this profile SHOULD support the value /kmip as the target URI. KMIP clients SHALL enable end user configuration of the target URI used as a KMIP server may specify a different target URI. 2.4 HTTP Encoding KMIP client implementations conformant to this profile SHALL: 1. Support HTTP/1.0 and/or HTTP/1.1 over TLS conformant to [RFC2818] 2. Use the POST request method 3. Specify a Content-Type of application/octet-stream 4. Specify a Content-Length 5. Specify a Cache-Control of no-cache 6. Send KMIP TTLV message in binary format as the body of the HTTP request KMIP server implementations conformant to this profile SHALL: 1. Support HTTP/1.0 and HTTP/1.1 over TLS conformant to [RFC2818] 2. Return HTTP response code 200 if a KMIP response is available 3. Specify a Content-Type of application/octet-stream 4. Specify a Content-Length 5. Specify a Cache-Control of no-cache 6. Send KMIP TTLV message in binary format as the body of the HTTP request KMIP servers that support server to client operations shall behave as an HTTPS client. KMIP clients that support responding to server to client operations shall behave as a HTTPS server. Standards Track Draft Copyright OASIS Open All Rights Reserved. Page 4 of 10

5 3 HTTPS Profile Test Cases This section contains a test case that demonstrates the HTTPS profile encoding using test case 12.1 from [KMIP-TC] using protocol version 1.0 which exercises the Query operation and the Maximum Response Size header field. 3.1 Query, Maximum Response Size Test Case: Query, Maximum Response Size Perform a Query operation, querying the Operations and Objects supported by the server, with a restriction on the Maximum Response Size set in the request header. Since the resulting Query response is too big, an error is returned. Increase the Maximum Response Size, resubmit the Query request, and get a successful response. Time Request/Response messages 0 Query (operations, objects) In (header): maximumresponsesize= 256 In: queryfunctions={ , } Tag: REQUEST_MESSAGE (0x420078), Type: STRUCTURE (0x01), Data: Tag: REQUEST_HEADER (0x420077), Type: STRUCTURE (0x01), Data: Tag: PROTOCOL_VERSION (0x420069), Type: STRUCTURE (0x01), Data: Tag: PROTOCOL_VERSION_MAJOR (0x42006a), Type: INTEGER (0x02), Data: 0x Tag: PROTOCOL_VERSION_MINOR (0x42006b), Type: INTEGER (0x02), Data: 0x Tag: MAXIMUM_RESPONSE_SIZE (0x420050), Type: INTEGER (0x02), Data: 0x Tag: BATCH_COUNT (0x42000d), Type: INTEGER (0x02), Data: 0x Tag: BATCH_ITEM (0x42000f), Type: STRUCTURE (0x01), Data: Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (QUERY) Tag: REQUEST_PAYLOAD (0x420079), Type: STRUCTURE (0x01), Data: Tag: QUERY_FUNCTION (0x420074), Type: ENUMERATION (0x05), Data: 0x (QUERY_OPERATIONS) Tag: QUERY_FUNCTION (0x420074), Type: ENUMERATION (0x05), Data: 0x (QUERY_OBJECTS) a b d f c f f 6b 6d f POST /kmip HTTP/ e 30 0d 0a d 61 3a 20 6e 6f 2d 1.0..Pragma: no d 0a d 43 6f 6e cache..cache-con f 6c 3a 20 6e 6f-2d d 0a trol: no-cache f 6e 6e f 6e 3a 20 6b Connection: keep d 61 6c d 0a-43 6f 6e e 74 2d -alive..content a c f Type: applicatio e 2f 6f d d 0d 0a n/octet-stream f 6e e 74 2d-4c 65 6e a 20 Content-Length: d 0a 0d 0a B. 00a x...b.w...hb. 00b a i... B.j... 00c b B.k... 00d B.P... 00e d B... 00f f B...8B c \...B y... B.t B.t Standards Track Draft Copyright OASIS Open All Rights Reserved. Page 5 of 10

6 Out: Operation Failed, Response Too Large Tag: RESPONSE_MESSAGE (0x42007b), Type: STRUCTURE (0x01), Data: Tag: RESPONSE_HEADER (0x42007a), Type: STRUCTURE (0x01), Data: Tag: PROTOCOL_VERSION (0x420069), Type: STRUCTURE (0x01), Data: Tag: PROTOCOL_VERSION_MAJOR (0x42006a), Type: INTEGER (0x02), Data: 0x Tag: PROTOCOL_VERSION_MINOR (0x42006b), Type: INTEGER (0x02), Data: 0x Tag: TIME_STAMP (0x420092), Type: DATE_TIME (0x09), Data: 0x feafb9f Wed Jun 27 22:25: Tag: BATCH_COUNT (0x42000d), Type: INTEGER (0x02), Data: 0x Tag: BATCH_ITEM (0x42000f), Type: STRUCTURE (0x01), Data: Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (QUERY) Tag: RESULT_STATUS (0x42007f), Type: ENUMERATION (0x05), Data: 0x (OPERATION_FAILED) Tag: RESULT_REASON (0x42007e), Type: ENUMERATION (0x05), Data: 0x (RESPONSE_TOO_LARGE) Tag: RESULT_MESSAGE (0x42007d), Type: TEXT_STRING (0x07), Data: TOO_LARGE 42007B C842007A A B F9A556B42000D F F E D F6E A653A C204D D756D F6E A E E A f 31 2e f 4b 0d HTTP/ OK a 43 6f 6e e 74-2d a Content-Type: a c f 6e 2f 6f pplication/octet d d 0d-0a 43 6f 6e e 74 -stream..content d 4c 65 6e a d 0a 0d 0a -Length: b a a B.{...B.z...H a B.i... B.j b B.k B f ea fb 4b d O..KB... 00a f B...H 00b c B.\... 00c f B... 00d e B.~... 00e d f 4f 5f 4c B.}...TOO_LARG 00f E... 1 Query (operations, objects) In (header): maximumresponsesize= 2048 In: queryfunctions={ , } Tag: REQUEST_MESSAGE (0x420078), Type: STRUCTURE (0x01), Data: Tag: REQUEST_HEADER (0x420077), Type: STRUCTURE (0x01), Data: Tag: PROTOCOL_VERSION (0x420069), Type: STRUCTURE (0x01), Data: Tag: PROTOCOL_VERSION_MAJOR (0x42006a), Type: INTEGER (0x02), Data: 0x Tag: PROTOCOL_VERSION_MINOR (0x42006b), Type: INTEGER (0x02), Data: 0x Tag: MAXIMUM_RESPONSE_SIZE (0x420050), Type: INTEGER (0x02), Data: 0x Tag: BATCH_COUNT (0x42000d), Type: INTEGER (0x02), Data: 0x Tag: BATCH_ITEM (0x42000f), Type: STRUCTURE (0x01), Data: Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (QUERY) Tag: REQUEST_PAYLOAD (0x420079), Type: STRUCTURE (0x01), Data: Tag: QUERY_FUNCTION (0x420074), Type: ENUMERATION (0x05), Data: 0x (QUERY_OPERATIONS) Tag: QUERY_FUNCTION (0x420074), Type: ENUMERATION (0x05), Data: 0x (QUERY_OBJECTS) a b d Standards Track Draft Copyright OASIS Open All Rights Reserved. Page 6 of 10

7 f c f f 6b 6d f POST /kmip HTTP/ e 30 0d 0a d 61 3a 20 6e 6f 2d 1.0..Pragma: no d 0a d 43 6f 6e cache..cache-con f 6c 3a 20 6e 6f-2d d 0a trol: no-cache f 6e 6e f 6e 3a 20 6b Connection: keep d 61 6c d 0a-43 6f 6e e 74 2d -alive..content a c f Type: applicatio e 2f 6f d d 0d 0a n/octet-stream f 6e e 74 2d-4c 65 6e a 20 Content-Length: d 0a 0d 0a B. 00a x...b.w...hb. 00b a i... B.j... 00c b B.k... 00d B.P... 00e d B... 00f f B...8B c \...B y... B.t B.t Out: operations, objects, serverinformation Tag: RESPONSE_MESSAGE (0x42007b), Type: STRUCTURE (0x01), Data: Tag: RESPONSE_HEADER (0x42007a), Type: STRUCTURE (0x01), Data: Tag: PROTOCOL_VERSION (0x420069), Type: STRUCTURE (0x01), Data: Tag: PROTOCOL_VERSION_MAJOR (0x42006a), Type: INTEGER (0x02), Data: 0x Tag: PROTOCOL_VERSION_MINOR (0x42006b), Type: INTEGER (0x02), Data: 0x Tag: TIME_STAMP (0x420092), Type: DATE_TIME (0x09), Data: 0x feafb9f Wed Jun 27 22:25: Tag: BATCH_COUNT (0x42000d), Type: INTEGER (0x02), Data: 0x Tag: BATCH_ITEM (0x42000f), Type: STRUCTURE (0x01), Data: Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (QUERY) Tag: RESULT_STATUS (0x42007f), Type: ENUMERATION (0x05), Data: 0x (SUCCESS) Tag: RESPONSE_PAYLOAD (0x42007c), Type: STRUCTURE (0x01), Data: Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (QUERY) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (LOCATE) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (DESTROY) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x a (GET) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (CREATE) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (REGISTER) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x b (GET_ATTRIBUTES) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x c (GET_ATTRIBUTE_LIST) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x d (ADD_ATTRIBUTE) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x e (MODIFY_ATTRIBUTE) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x f (DELETE_ATTRIBUTE) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (ACTIVATE) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (REVOKE) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x a (POLL) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (CANCEL) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (CHECK) Standards Track Draft Copyright OASIS Open All Rights Reserved. Page 7 of 10

8 Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (GET_USAGE_ALLOCATION) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (CREATE_KEY_PAIR) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (RE_KEY) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (ARCHIVE) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (RECOVER) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (OBTAIN_LEASE) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x d (RE_KEY_KEY_PAIR) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (CERTIFY) Tag: OPERATION (0x42005c), Type: ENUMERATION (0x05), Data: 0x (RE_CERTIFY) Tag: OBJECT_TYPE (0x420057), Type: ENUMERATION (0x05), Data: 0x (CERTIFICATE) Tag: OBJECT_TYPE (0x420057), Type: ENUMERATION (0x05), Data: 0x (SYMMETRIC_KEY) Tag: OBJECT_TYPE (0x420057), Type: ENUMERATION (0x05), Data: 0x (SECRET_DATA) Tag: OBJECT_TYPE (0x420057), Type: ENUMERATION (0x05), Data: 0x (PUBLIC_KEY) Tag: OBJECT_TYPE (0x420057), Type: ENUMERATION (0x05), Data: 0x (PRIVATE_KEY) Tag: OBJECT_TYPE (0x420057), Type: ENUMERATION (0x05), Data: 0x (TEMPLATE) Tag: OBJECT_TYPE (0x420057), Type: ENUMERATION (0x05), Data: 0x (OPAQUE_OBJECT) Tag: OBJECT_TYPE (0x420057), Type: ENUMERATION (0x05), Data: 0x (SPLIT_KEY) 42007b a a b feafb9f42000d f c f c c c c c a c c c b c c c d c e c f c c c a c c c c c c c c c d c c f 31 2e f 4b 0d HTTP/ OK a 43 6f 6e e 74-2d a Content-Type: a c f 6e 2f 6f pplication/octet d d 0d-0a 43 6f 6e e 74 -stream..content d 4c 65 6e a d 0a 0d 0a -Length: b a B.{...B.z...H a B.i... B.j b B.k B f ea fb 9f d O...B... 00a f B b c B.\... 00c f B... 00d c c B....B.\... 00e c B.\... 00f c B.\ c B.\ a c B.\ c B.\... Standards Track Draft Copyright OASIS Open All Rights Reserved. Page 8 of 10

9 c B.\ b c B.\ c c B.\ d c B.\ e c B.\ f c B.\ c B.\... 01a c B.\... 01b a c B.\... 01c c B.\... 01d c B.\... 01e c B.\... 01f c B.\ c B.\ c B.\ c B.\ c B.\ d c B.\ c B.\ B.W B.W B.W B.W... 02a B.W... 02b B.W... 02c B.W... 02d B.W... 02e Standards Track Draft Copyright OASIS Open All Rights Reserved. Page 9 of 10

10 Appendix A. Acknowledgments The following individuals have participated in the creation of this specification and are gratefully acknowledged: Original HTTPS Profile Proposal: Alan Frindell, SafeNet, Inc. Original HTTPS Profile Contributors: Mathias Björkqvist, IBM Standards Track Draft Copyright OASIS Open All Rights Reserved. Page 10 of 10