TIA-5022 009-2015 HTTP Protocol Binding (oneM2M TS-0009-v1 0 1).pdf

1、 TIA-5022.009 October 2015HTTP Protocol Binding (oneM2M TS-0009-v1.0.1) NOTICE TIA Engineering Standards and Publications are designed to serve the public interest through eliminating misunderstandings between manufacturers and purchasers, facilitating interchangeability and improvement of products,

2、 and assisting the purchaser in selecting and obtaining with minimum delay the proper product for their particular need. The existence of such Standards and Publications shall not in any respect preclude any member or non-member of TIA from manufacturing or selling products not conforming to such St

3、andards and Publications. Neither shall the existence of such Standards and Publications preclude their voluntary use by Non-TIA members, either domestically or internationally. Standards and Publications are adopted by TIA in accordance with the American National Standards Institute (ANSI) patent p

4、olicy. By such action, TIA does not assume any liability to any patent owner, nor does it assume any obligation whatever to parties adopting the Standard or Publication. This Standard does not purport to address all safety problems associated with its use or all applicable regulatory requirements. I

5、t is the responsibility of the user of this Standard to establish appropriate safety and health practices and to determine the applicability of regulatory limitations before its use. Any use of trademarks in this document are for information purposes and do not constitute an endorsement by TIA or th

6、is committee of the products or services of the company. (From Project No. TIA-PN-5022.009, formulated under the cognizance of the TIA TR-50 M2M- Smart Device Communications.) Published by TELECOMMUNICATIONS INDUSTRY ASSOCIATION Technology (b) there is no assurance that the Document will be approved

7、 by any Committee of TIA or any other body in its present or any other form; (c) the Document may be amended, modified or changed in the standards development or any editing process. The use or practice of contents of this Document may involve the use of intellectual property rights (“IPR”), includi

8、ng pending or issued patents, or copyrights, owned by one or more parties. TIA makes no search or investigation for IPR. When IPR consisting of patents and published pending patent applications are claimed and called to TIAs attention, a statement from the holder thereof is requested, all in accorda

9、nce with the Manual. TIA takes no position with reference to, and disclaims any obligation to investigate or inquire into, the scope or validity of any claims of IPR. TIA will neither be a party to discussions of any licensing terms or conditions, which are instead left to the parties involved, nor

10、will TIA opine or judge whether proposed licensing terms or conditions are reasonable or non-discriminatory. TIA does not warrant or represent that procedures or practices suggested or provided in the Manual have been complied with as respects the Document or its contents. If the Document contains o

11、ne or more Normative References to a document published by another organization (“other SSO”) engaged in the formulation, development or publication of standards (whether designated as a standard, specification, recommendation or otherwise), whether such reference consists of mandatory, alternate or

12、 optional elements (as defined in the TIA Procedures for American National Standards) then (i) TIA disclaims any duty or obligation to search or investigate the records of any other SSO for IPR or letters of assurance relating to any such Normative Reference; (ii) TIAs policy of encouragement of vol

13、untary disclosure (see TIA Procedures for American National Standards Annex C.1.2.3) of Essential Patent(s) and published pending patent applications shall apply; and (iii) Information as to claims of IPR in the records or publications of the other SSO shall not constitute identification to TIA of a

14、 claim of Essential Patent(s) or published pending patent applications. TIA does not enforce or monitor compliance with the contents of the Document. TIA does not certify, inspect, test or otherwise investigate products, designs or services or any claims of compliance with the contents of the Docume

15、nt. ALL WARRANTIES, EXPRESS OR IMPLIED, ARE DISCLAIMED, INCLUDING WITHOUT LIMITATION, ANY AND ALL WARRANTIES CONCERNING THE ACCURACY OF THE CONTENTS, ITS FITNESS OR APPROPRIATENESS FOR A PARTICULAR PURPOSE OR USE, ITS MERCHANTABILITY AND ITS NONINFRINGEMENT OF ANY THIRD PARTYS INTELLECTUAL PROPERTY

16、RIGHTS. TIA EXPRESSLY DISCLAIMS ANY AND ALL RESPONSIBILITIES FOR THE ACCURACY OF THE CONTENTS AND MAKES NO REPRESENTATIONS OR WARRANTIES REGARDING THE CONTENTS COMPLIANCE WITH ANY APPLICABLE STATUTE, RULE OR REGULATION, OR THE SAFETY OR HEALTH EFFECTS OF THE CONTENTS OR ANY PRODUCT OR SERVICE REFERR

17、ED TO IN THE DOCUMENT OR PRODUCED OR RENDERED TO COMPLY WITH THE CONTENTS. TIA SHALL NOT BE LIABLE FOR ANY AND ALL DAMAGES, DIRECT OR INDIRECT, ARISING FROM OR RELATING TO ANY USE OF THE CONTENTS CONTAINED HEREIN, INCLUDING WITHOUT LIMITATION ANY AND ALL INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIA

18、L DAMAGES (INCLUDING DAMAGES FOR LOSS OF BUSINESS, LOSS OF PROFITS, LITIGATION, OR THE LIKE), WHETHER BASED UPON BREACH OF CONTRACT, BREACH OF WARRANTY, TORT (INCLUDING NEGLIGENCE), PRODUCT LIABILITY OR OTHERWISE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. THE FOREGOING NEGATION OF DAMAGES

19、IS A FUNDAMENTAL ELEMENT OF THE USE OF THE CONTENTS HEREOF, AND THESE CONTENTS WOULD NOT BE PUBLISHED BY TIA WITHOUT SUCH LIMITATIONS. oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TTA, TTC) Page 2 of 13 This is a draft oneM2M document and should not be relied upon; the final version, if any,

20、 will be made available by oneM2M Partners Type 1. About oneM2M The purpose and goal of oneM2M is to develop technical specifications which address the need for a common M2M Service Layer that can be readily embedded within various hardware and software, and relied upon to connect the myriad of devi

21、ces in the field with M2M application servers worldwide. More information about oneM2M may be found at: http/www.oneM2M.org Copyright Notification No part of this document may be reproduced, in an electronic retrieval system or otherwise, except as authorized by written permission. The copyright and

22、 the foregoing restriction extend to reproduction in all media. 2015, oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TTA, TTC). All rights reserved. Notice of Disclaimer the final version, if any, will be made available by oneM2M Partners Type 1. Contents 1 Scope 4 2 References 4 2.1 Normative

23、 references . 4 2.2 Informative references . 4 3 Abbreviations . 5 4 Conventions . 5 5 Overview of HTTP Binding . 5 5.1 Introduction . 5 5.2 Request-Line 6 5.3 Status-Line . 6 6 HTTP Message Mapping . 6 6.1 Introduction . 6 6.2 Parameter Mappings on Request-Line 6 6.2.1 Method . 6 6.2.2 Request-Targ

24、et . 6 6.2.3 HTTP-Version 7 6.3 Status-Line . 7 6.3.1 HTTP-Version 7 6.3.2 Status-Code 7 6.3.3 Reason-Phrase 8 6.4 Header Fields . 8 6.4.1 Host 8 6.4.2 Accept 9 6.4.3 Content-type . 9 6.4.4 Content-Location 9 6.4.5 Content-Length . 9 6.4.6 Etag 9 6.4.8 X-M2M-RI . 9 6.4.12 X-M2M-OT 10 6.4.13 X-M2M-RS

25、T 10 6.4.16 X-M2M-EC 10 6.4.17 X-M2M-RSC 10 6.5 Message-body 10 6.6 Message Routing 10 7 Security Consideration . 10 7.1 Authentication on HTTP Request Message 10 7.2 Transport Layer Security 10 Annex A (informative): Example Procedures 11 A.1 resource creation 11 Annex B (informative): WebSocket 12

26、 B.1 Notification using WebSocket 12 History 13 oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TTA, TTC) Page 4 of 13 This is a draft oneM2M document and should not be relied upon; the final version, if any, will be made available by oneM2M Partners Type 1. 1 Scope The present document will co

27、ver the protocol specific part of communication protocol used by oneM2M compliant systems as RESTful HTTP binding. The scope of the present document is (not limited to as shown below): Binding oneM2M Protocol primitive types to HTTP method. Binding oneM2M response status codes (successful/unsuccessf

28、ul) to HTTP response codes. Binding oneM2M RESTful resources to HTTP resources. The present document is depending on Core Protocol specification (oneM2M TS-0004) for data types. 2 References 2.1 Normative references References are either specific (identified by date of publication and/or edition num

29、ber or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the reference document (including any amendments) applies. The following referenced documents are necessary for the application of the present document.

30、 1 IETF RFC 7230 (June 2014): “Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing“. 2 oneM2M TS-0003: Security Solutions. 3 oneM2M TS-0004: “Service Layer Core Protocol Specification“. 4 RFC7235: “Hypertext Transfer Protocol (HTTP/1.1): Authentication”, IETF, June 2014. 5 RFC6750: “T

31、he OAuth 2.0 Authorization Framework: Bearer Token Usage”, October 2012. 6 oneM2M TS-0011: Common Terminology. 7 oneM2M TS-0001: Functional Architecture. 2.2 Informative references References are either specific (identified by date of publication and/or edition number or version number) or non-speci

32、fic. For specific references, only the cited version applies. For non-specific references, the latest version of the reference document (including any amendments) applies. The following referenced documents are not necessary for the application of the present document but they assist the user with r

33、egard to a particular subject area. i.1 oneM2M Drafting Rules. NOTE: Available at http:/member.onem2m.org/Static_pages/Others/Rules_Pages/oneM2M-Drafting-Rules-V1_0.doc. i.2 IETF RFC 2617 (June 1999): “HTTP Authentication: Basic and Digest Access Authentication“. i.3 IETF RFC 6750 (October 2012): “T

34、he OAuth 2.0 Authorization Framework: Bearer Token Usage“. i.4 IETF RFC 6455 (December 2011):“The WebSocket Protocol“. oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TTA, TTC) Page 5 of 13 This is a draft oneM2M document and should not be relied upon; the final version, if any, will be made av

35、ailable by oneM2M Partners Type 1. i.5 oneM2M TS-0003: “Security Solutions“. 3 Abbreviations For the purposes of the present document, the following abbreviations those given in TS-0011-Common Terminology 6 apply: CSE-ID Common Service Entity Identifier HTTP Hyper Text Transfer Protocol TLS Trasport

36、 Layer Security URI Uniform Resource Identifier 4 Conventions The keywords “Shall“, “Shall not“, “May“, “Need not“, “Should“, “Should not“ in this document are to be interpreted as described in the oneM2M Drafting Rules i.1. 5 Overview of HTTP Binding This clause describes what oneM2M primitive para

37、meters can be mapped to HTTP request/response messages. 5.1 Introduction The present document assumes AE has the capability of HTTP Client, and CSE has the capability of both HTTP Client and Server. AEMN - C S E R e g i s t r a r o f A E IN - C S EMN - C S E H o s t i n g r e s o u r c e H T T PP r

38、o x y C l ie n tH T T PP r o x y S e r v e rH T T PS e r v e rH T T PS e r v e rM c a M c c M c cH T T P P r o x y U s eO r d i n a r yH T T PO r d i n a r yH T T PP o s s i b l e S y s t em C o n f i g u r at io n i n o n eM 2 M ar c h it ec t u r eP o s s i b l e S y s t em C o n f i g u r at io n

39、 w it h H T T PB in d i n gH T T PP r o t o c o lB in d i n gL eg en dRe q u es t ( ar r o w - h e ad s i d e p r o v i d es s er v i c e )Req u es t ( o p t io n al l y u s ed )n a m e A c t o rFigure 5.1-1 : Example of Mapping AE/CSE to HTTP Client and Server Single request primitive will be mappe

40、d to single HTTP request message, and single response primitive will be mapped to single HTTP response message. An HTTP request message consists of Request-Line, headers and message-body. An HTTP response message consists of Status-Line, headers and message-body 1. This clause describes how oneM2M r

41、equest/response primitives are mapped to HTTP messages at a high level. Corresponding details of each sub-clause are specified in clause 6. The Registrar CSE shall behave as proxy server(see 1). oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TTA, TTC) Page 6 of 13 This is a draft oneM2M docume

42、nt and should not be relied upon; the final version, if any, will be made available by oneM2M Partners Type 1. 5.2 Request-Line Method is mapped to the oneM2M Operation parameter. Request-URI is derived from the oneM2M To parameter, including a query string which carries specific primitive parameter

43、s. HTTP-Version is specified in clause 6. 5.3 Status-Line HTTP Version is specified in clause 6. Status-Code and Reason-Phrase are derived from the oneM2M Response Status Code parameter of the response primitive. 6 HTTP Message Mapping 6.1 Introduction Mapping between HTTP message and oneM2M primiti

44、ve shall be applied in the following cases: when the Originator sends a request primitive; when the Receiver receives a request primitive; when the Receiver sends a response primitive; when the Originator receives a response primitive. The following clauses specify how to map each oneM2M primitive p

45、arameter to a corresponding HTTP message field to compose a HTTP request/response message. 6.2 Parameter Mappings on Request-Line 6.2.1 Method The HTTP Method shall be specified according to the oneM2M Operation parameter of the request primitive. Table 6.2.1-1: HTTP Method Mapping oneM2M Operation

46、HTTP Method Create POST Retrieve GET Update PUT (full update) or POST (partial update) Delete DELETE Notify POST At the Receiver, an HTTP request message with POST method shall be mapped to a oneM2M Create or Notify request primitive in accordance with the value of the Operation parameter. 6.2.2 Req

47、uest-Target The path component of HTTP Request-Target shall be interpreted as the mapping of To parameter, and the query component (e.g. query-string) shall be interpreted as other primitive parameters (see 1). oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TTA, TTC) Page 7 of 13 This is a dra

48、ft oneM2M document and should not be relied upon; the final version, if any, will be made available by oneM2M Partners Type 1. The To parameter shall be mapped to in Request-Target. Only SP-Relative-Resource-ID and Absolute-Resource-ID forms (see clause 7.2 7) shall be applicable for To parameter. I

49、f To parameter is SP-Releative-Resource-ID form, then origin-form shall be used for Request-Target. If To parameter is Absolute-Resource-ID form, then absolute-form shall be used for Request-Target (see clause 6.2.3 3). The prefix string “http:“ shall be added to the absolute-form when the address is used in the absolute-form in the Request-Target. The request parameters which are not specified as oneM2M extension headers in clause 6.4 shall be specified as pair of field-name and value in query-string as sho