idnits 2.17.1 draft-ietf-cdni-media-type-03.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (September 29, 2015) is 3125 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Unused Reference: 'RFC2119' is defined on line 227, but no explicit reference was found in the text ** Obsolete normative reference: RFC 5226 (Obsoleted by RFC 8126) -- Obsolete informational reference (is this intentional?): RFC 7159 (Obsoleted by RFC 8259) Summary: 1 error (**), 0 flaws (~~), 2 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 CDNI K. Ma 3 Internet-Draft Ericsson 4 Intended status: Informational September 29, 2015 5 Expires: April 1, 2016 7 CDNI Media Type Registration 8 draft-ietf-cdni-media-type-03 10 Abstract 12 This document defines the standard media type used by the Content 13 Delivery Network Interconnection (CDNI) protocol suite, including the 14 registration procedure and recommended usage of the required payload- 15 type parameter . 17 Status of This Memo 19 This Internet-Draft is submitted in full conformance with the 20 provisions of BCP 78 and BCP 79. 22 Internet-Drafts are working documents of the Internet Engineering 23 Task Force (IETF). Note that other groups may also distribute 24 working documents as Internet-Drafts. The list of current Internet- 25 Drafts is at http://datatracker.ietf.org/drafts/current/. 27 Internet-Drafts are draft documents valid for a maximum of six months 28 and may be updated, replaced, or obsoleted by other documents at any 29 time. It is inappropriate to use Internet-Drafts as reference 30 material or to cite them other than as "work in progress." 32 This Internet-Draft will expire on April 1, 2016. 34 Copyright Notice 36 Copyright (c) 2015 IETF Trust and the persons identified as the 37 document authors. All rights reserved. 39 This document is subject to BCP 78 and the IETF Trust's Legal 40 Provisions Relating to IETF Documents 41 (http://trustee.ietf.org/license-info) in effect on the date of 42 publication of this document. Please review these documents 43 carefully, as they describe your rights and restrictions with respect 44 to this document. Code Components extracted from this document must 45 include Simplified BSD License text as described in Section 4.e of 46 the Trust Legal Provisions and are provided without warranty as 47 described in the Simplified BSD License. 49 Table of Contents 51 1. Introduction and Scope . . . . . . . . . . . . . . . . . . . 2 52 2. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 2 53 2.1. CDNI Media Type . . . . . . . . . . . . . . . . . . . . . 2 54 2.2. CDNI Payload Type Parameter Registry . . . . . . . . . . 4 55 3. References . . . . . . . . . . . . . . . . . . . . . . . . . 5 56 3.1. Normative References . . . . . . . . . . . . . . . . . . 5 57 3.2. Informative References . . . . . . . . . . . . . . . . . 6 58 Appendix A. Acknowledgment . . . . . . . . . . . . . . . . . . . 6 59 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 6 61 1. Introduction and Scope 63 The CDNI working group is developing a set of protocols to enable the 64 interconnection of multiple CDNs, as discussed in [RFC6770]. The 65 CDNI protocol suite consists of multiple HTTP-based interfaces, many 66 of which transfer various JSON encoded payloads [RFC7159]. The main 67 interfaces (i.e., CDNI Control interface, CDNI Footprint & 68 Capabilities Advertisement interface, CDNI Request Routing 69 Redirection interface, CDNI Metadata interface, and CDNI Logging 70 interface) are described in [RFC7336]. It is desirable to be able to 71 indicate the type of object carried in the HTTP entity-body without 72 having to register separate media types for each CDNI object. To 73 accomplish this aims, this document defines a single new media type 74 for CDNI that includes a required payload-type parameter. A separate 75 registry of CDNI payload-type parameters is also defined. CDNI 76 protocol specifications may register interface-specific payload- 77 types, specifying the payload encoding and parsing semantics for that 78 message (e.g., JSON serialization for a CDNI metadata object). The 79 same payload-type parameter may also be used as references for other 80 purposes (e.g., referencing CDNI metadata objects from CDNI 81 capability advertisement objects). 83 2. IANA Considerations 85 This section contains the CDNI media type registration request for 86 IANA, as well as the payload-type parameter registry definition for 87 IANA. 89 2.1. CDNI Media Type 91 Type name: application 93 Subtype name: cdni 95 Required parameters: 97 ptype 99 The required parameter "ptype" describes the type of CDNI 100 message contained in the message payload, as registered in the 101 CDNI Payload Type Parameter Registry (Section 2.2) defined 102 below. 104 Optional parameters: none 106 Encoding considerations: 108 The CDNI protocol suite includes interfaces with JSON encoded 109 messages which may be 8bit or binary, as well as generic logging 110 information which may be 7bit or binary. 112 Security considerations: 114 CDNI interfaces that return JSON encoded data may be 115 (mis)interpreted if parsed by non-CDNI or non-compliant CDNI 116 implementations. In addition, CDNI logging information is likely 117 to transfer large amounts of data which may overload unexpecting 118 clients. The individual CDNI interface specifications provide 119 more detailed analysis of security and privacy concerns, and 120 define the requirements for authentication, authorization, 121 confidentiality, integrity, and privacy for each interface. 123 Interoperability considerations: 125 The required ptype field is intended to fully describe the 126 structure and parsing of CDNI messages, as enforced by the ptype 127 registry designated expert. 129 Published specification: RFCthis 131 Applications that use this media type: 133 CDNI is intended for use between interconnected CDNs for sharing 134 configuration and logging data, as well as for issuing content 135 management and redirection requests. 137 Fragment identifier considerations: N/A 139 Additional information: N/A 141 Deprecated alias names for this type: N/A 143 Magic number(s): N/A 144 File extension(s): N/A 146 Macintosh file type code(s): N/A 148 Person & email address to contact for further information: 150 Kevin Ma 152 Intended usage: LIMITED USE 154 Restrictions on usage: 156 This media type is intended only for use in CDNI protocol message 157 exchanges. 159 Author: IETF CDNI working group 161 Change controller: IETF CDNI working group 163 Provisional registration: no 165 2.2. CDNI Payload Type Parameter Registry 167 The IANA is requested to create a new "CDNI Payload Type" registry. 168 The "CDNI Payload Type" namespace defines the valid values for the 169 required "ptype" parameter of the "application/cdni" media type. The 170 CDNI Payload Type is an ASCII string value, consisting of only 171 visible (printing) characters, but excluding equal signs (=), double 172 quotes ("), and semicolons (;), and not exceeding 256 characters in 173 length. 175 ptype = 1*256(ptype-char) 176 ptype-char = %x21 / %23-3A / %x3C / %x3E-7E 177 ; Includes ALPHA, DIGIT, and other printables 178 ; Excludes equal signs (=), double quotes ("), semicolons (;) 180 Additions to the CDNI Payload Type namespace will conform to the 181 "Specification Required" policy as defined in [RFC5226]. The 182 designated expert will verify that new type definitions do not 183 duplicate existing type definitions (in name or functionality), 184 prevent gratuitous additions to the namespace, and prevent any 185 additions to the namespace which would impair the interoperability of 186 CDNI implementations. The designated expert will review the 187 specification, even if it is a Standards Track RFC, to verify that it 188 contains the following information: 190 o The review will verify that the specification contains a 191 reasonably defined purpose for the new payload type, where the 192 purpose is related to an existing or proposed CDNI interface and 193 does not duplicate the functionality of any existing CDNI protocol 194 feature without specifying a rational reason (e.g., updating an 195 obsolete feature), a method for detecting and handling conflicts 196 (e.g., a versioning system with prioritization matrix), and a 197 suggested migration path (e.g., deprecation of the overlapped 198 feature, or justification for co-existence). 200 o The review will verify that the specification contains information 201 as to which CDNI interface the new payload type pertains/affects. 202 The payload type may be applicable to multiple CDNI interfaces, 203 but the justification for the new payload type will include a 204 reasonable relationship to at least one standards track CDNI 205 interface. 207 o The review will verify that the specification contains sufficient 208 detail about the data encoding (e.g., JSON serialization for new 209 CDNI metadata or capability advertisement objects, or ABNF and 210 description for new CDNI logging file formats) to allow senders 211 and receivers of the new payload type to implement compliant and 212 interoperable payload parsers. 214 The registry contains the Payload Type, and the specification 215 describing the Payload Type. The registry will initially be 216 unpopulated. 218 +--------------+---------------+ 219 | Payload Type | Specification | 220 +--------------+---------------+ 221 +--------------+---------------+ 223 3. References 225 3.1. Normative References 227 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 228 Requirement Levels", BCP 14, RFC 2119, 229 DOI 10.17487/RFC2119, March 1997, 230 . 232 [RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an 233 IANA Considerations Section in RFCs", BCP 26, RFC 5226, 234 DOI 10.17487/RFC5226, May 2008, 235 . 237 3.2. Informative References 239 [RFC6770] Bertrand, G., Ed., Stephan, E., Burbridge, T., Eardley, 240 P., Ma, K., and G. Watson, "Use Cases for Content Delivery 241 Network Interconnection", RFC 6770, DOI 10.17487/RFC6770, 242 November 2012, . 244 [RFC7159] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 245 Interchange Format", RFC 7159, DOI 10.17487/RFC7159, March 246 2014, . 248 [RFC7336] Peterson, L., Davie, B., and R. van Brandenburg, Ed., 249 "Framework for Content Distribution Network 250 Interconnection (CDNI)", RFC 7336, DOI 10.17487/RFC7336, 251 August 2014, . 253 Appendix A. Acknowledgment 255 This document is the culmination of the efforts of many in the CDNI 256 working group, including (in alphabetical order): Francois Le 257 Faucheur, Daryl Malas, Rob Murray, Ben Niven-Jenkins, Iuniana 258 Oprescu, Jon Peterson, and Jan Seedorf. 260 Author's Address 262 Kevin J. Ma 263 Ericsson 264 43 Nagog Park 265 Acton, MA 01720 266 USA 268 Phone: +1 978-844-5100 269 Email: kevin.j.ma@ericsson.com