idnits 2.17.1 draft-schwartz-masque-access-descriptions-00.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 (7 April 2022) is 750 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Outdated reference: A later version (-13) exists of draft-ietf-masque-connect-ip-01 == Outdated reference: A later version (-15) exists of draft-ietf-masque-connect-udp-08 == Outdated reference: A later version (-10) exists of draft-ietf-ohai-ohttp-01 Summary: 0 errors (**), 0 flaws (~~), 4 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Multiplexed Application Substrate over QUIC Encryption B. M. Schwartz 3 Internet-Draft Google LLC 4 Intended status: Standards Track 7 April 2022 5 Expires: 9 October 2022 7 HTTP Access Service Description Objects 8 draft-schwartz-masque-access-descriptions-00 10 Abstract 12 HTTP proxies can operate several different kinds of access services. 13 This specification provides a format for identifying a collection of 14 such services. 16 About This Document 18 This note is to be removed before publishing as an RFC. 20 Status information for this document may be found at 21 https://datatracker.ietf.org/doc/draft-schwartz-masque-access- 22 descriptions/. 24 Source for this draft and an issue tracker can be found at 25 https://github.com/bemasc/access-services. 27 Status of This Memo 29 This Internet-Draft is submitted in full conformance with the 30 provisions of BCP 78 and BCP 79. 32 Internet-Drafts are working documents of the Internet Engineering 33 Task Force (IETF). Note that other groups may also distribute 34 working documents as Internet-Drafts. The list of current Internet- 35 Drafts is at https://datatracker.ietf.org/drafts/current/. 37 Internet-Drafts are draft documents valid for a maximum of six months 38 and may be updated, replaced, or obsoleted by other documents at any 39 time. It is inappropriate to use Internet-Drafts as reference 40 material or to cite them other than as "work in progress." 42 This Internet-Draft will expire on 9 October 2022. 44 Copyright Notice 46 Copyright (c) 2022 IETF Trust and the persons identified as the 47 document authors. All rights reserved. 49 This document is subject to BCP 78 and the IETF Trust's Legal 50 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 51 license-info) in effect on the date of publication of this document. 52 Please review these documents carefully, as they describe your rights 53 and restrictions with respect to this document. Code Components 54 extracted from this document must include Revised BSD License text as 55 described in Section 4.e of the Trust Legal Provisions and are 56 provided without warranty as described in the Revised BSD License. 58 Table of Contents 60 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 61 2. Conventions and Definitions . . . . . . . . . . . . . . . . . 3 62 3. Format . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 63 3.1. Examples . . . . . . . . . . . . . . . . . . . . . . . . 3 64 4. Discovery from an Origin . . . . . . . . . . . . . . . . . . 4 65 5. Security Considerations . . . . . . . . . . . . . . . . . . . 5 66 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5 67 7. Normative References . . . . . . . . . . . . . . . . . . . . 5 68 Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 6 69 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 6 71 1. Introduction 73 In HTTP/1.1, forward proxy service was originally defined in two 74 ways: absolute-uri request form (encrypted at most hop-by-hop), and 75 HTTP CONNECT (potentially encrypted end-to-end). Both of these 76 services were effectively origin-scoped: the access service was a 77 property of the origin, not associated with any particular path. 79 Recently, a variety of new standardized proxy-like services have 80 emerged for HTTP. These new services are defined by a URI template 81 or path, allowing distinct instances of the same service type to be 82 served by a single origin. These services include: 84 * DNS over HTTPS [RFC8484] 86 * CONNECT-UDP [I-D.draft-ietf-masque-connect-udp] 88 * CONNECT-IP [I-D.draft-ietf-masque-connect-ip] 90 * Oblivious HTTP [I-D.draft-ietf-ohai-ohttp] 92 This specification provides a unified format for describing a 93 collection of such access services, and a mechanism for reaching such 94 services when the initial information contains only an HTTP origin. 96 2. Conventions and Definitions 98 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 99 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 100 "OPTIONAL" in this document are to be interpreted as described in 101 BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all 102 capitals, as shown here. 104 3. Format 106 An access service collection is defined by a JSON dictionary 107 containing keys specified in the corresponding registry (Section 6). 108 Inclusion of each key is OPTIONAL. 110 The "dns", "udp", and "ip" keys are each defined to hold a JSON 111 dictionary containing the key "template" with a value that is a URI 112 template suitable for configuring DNS over HTTPS, CONNECT-UDP, or 113 CONNECT-IP, respectively. 115 The "ohttp" key contains a dictionary with either or both of these 116 keys: 118 * "proxy", containing a dictionary with a "template" key indicating 119 the Oblivious Proxy's resource mapping. The template MUST contain 120 a "request_uri" variable indicating the Oblivious Request 121 Resource. 123 * "request", containing a dictionary with a "uri" key indicating the 124 Oblivious Request Resource and a "key" key conveying its KeyConfig 125 in base64. 127 If the Access Description is for a general-purpose proxy, all 128 Oblivious Request Resources and Targets (respectively) are presumed 129 to be supported; otherwise the supported Resources and Targets must 130 be understood from context (but see Section 4). 132 3.1. Examples 133 { 134 "dns": { 135 "template": "https://doh.example.com/dns-query{?dns}", 136 }, 137 "udp": { 138 "template": 139 "https://proxy.example.org/masque{?target_host,target_port}" 140 }, 141 "ip": { 142 "template": "https://proxy.example.org/masque{?target,ip_proto}" 143 }, 144 "ohttp": { 145 "proxy": { 146 "template": "https://proxy.example.org/ohttp{?request_uri}" 147 } 148 } 149 } 151 Figure 1: A proxy with UDP, IP, DNS, and Oblivious HTTP support 153 { 154 "dns": { 155 "template": "https://doh.example.com/dns-query{?dns}", 156 }, 157 "ohttp": { 158 "request": { 159 "uri": "https://example.com/ohttp/", 160 "key": "(KeyConfig in Base64)" 161 } 162 } 163 } 165 Figure 2: An Oblivious DNS over HTTPS service 167 4. Discovery from an Origin 169 In cases where the HTTP access service is identified only by an 170 origin (e.g. when configured as a Secure Web Proxy), operators can 171 publish an associated access service collection at the path "/.well- 172 known/access-services", with the Content-Type "application/json". 174 When the "ohttp.request" URI appears in an Access Description at this 175 location, all URIs on this origin (except the Oblivious Request URI) 176 are presumed to be reachable as Oblivious Request Targets. 178 Clients MAY fetch this Access Description and use the indicated 179 services (in addition to any origin-scoped services) automatically. 180 Clients SHOULD use the description only while it is fresh according 181 to its HTTP cache lifetime, refreshing it as needed. 183 5. Security Considerations 185 TODO Security 187 6. IANA Considerations 189 IANA is requested to open a Specification Required registry entitled 190 "HTTP Access Service Descriptors", with the following initial 191 contents: 193 +=======+=================+ 194 | Key | Specification | 195 +=======+=================+ 196 | dns | (This document) | 197 +-------+-----------------+ 198 | udp | (This document) | 199 +-------+-----------------+ 200 | ip | (This document) | 201 +-------+-----------------+ 202 | ohttp | (This document) | 203 +-------+-----------------+ 205 Table 1 207 IANA is requested to add the following entry to the "Well-Known URIs" 208 registry 210 +=================+==========+=========+=============+==============+ 211 | URI Suffix |Change |Reference| Status | Related | 212 | |Controller| | | Information | 213 +=================+==========+=========+=============+==============+ 214 | access-services |IETF |(This | provisional | Sub-registry | 215 | | |document)| | at (link) | 216 +-----------------+----------+---------+-------------+--------------+ 218 Table 2 220 7. Normative References 222 [I-D.draft-ietf-masque-connect-ip] 223 Pauly, T., Schinazi, D., Chernyakhovsky, A., Kuehlewind, 224 M., and M. Westerlund, "IP Proxying Support for HTTP", 225 Work in Progress, Internet-Draft, draft-ietf-masque- 226 connect-ip-01, 4 March 2022, 227 . 230 [I-D.draft-ietf-masque-connect-udp] 231 Schinazi, D., "UDP Proxying Support for HTTP", Work in 232 Progress, Internet-Draft, draft-ietf-masque-connect-udp- 233 08, 21 March 2022, . 236 [I-D.draft-ietf-ohai-ohttp] 237 Thomson, M. and C. A. Wood, "Oblivious HTTP", Work in 238 Progress, Internet-Draft, draft-ietf-ohai-ohttp-01, 15 239 February 2022, . 242 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 243 Requirement Levels", BCP 14, RFC 2119, 244 DOI 10.17487/RFC2119, March 1997, 245 . 247 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 248 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 249 May 2017, . 251 [RFC8484] Hoffman, P. and P. McManus, "DNS Queries over HTTPS 252 (DoH)", RFC 8484, DOI 10.17487/RFC8484, October 2018, 253 . 255 Acknowledgments 257 TODO acknowledge. 259 Author's Address 261 Benjamin M. Schwartz 262 Google LLC 263 Email: bemasc@google.com