HTTP Access Service Description Objects

Status of This Memo

This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶

This Internet-Draft will expire on 2 January 2023.¶

Copyright Notice

Copyright (c) 2022 IETF Trust and the persons identified as the document authors. All rights reserved.¶

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶

Table of Contents

1. Introduction

In HTTP/1.1, forward proxy service was originally defined in two ways: absolute-uri request form (encrypted at most hop-by-hop), and HTTP CONNECT (potentially encrypted end-to-end). Both of these services were effectively origin-scoped: the access service was a property of the origin, not associated with any particular path.¶

Recently, a variety of new standardized proxy-like services have emerged for HTTP. These new services are defined by a URI template or path, allowing distinct instances of the same service type to be served by a single origin. These services include:¶

• DNS over HTTPS [RFC8484]¶
• CONNECT-UDP [I-D.draft-ietf-masque-connect-udp]¶
• CONNECT-IP [I-D.draft-ietf-masque-connect-ip]¶
• Oblivious HTTP [I-D.draft-ietf-ohai-ohttp]¶

This specification provides a unified format for describing a collection of such access services, and a mechanism for reaching such services when the initial information contains only an HTTP origin.¶

2. Conventions and Definitions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶

3. Format

An access service collection is defined by a JSON dictionary containing keys specified in the corresponding registry (Section 6). Inclusion of each key is OPTIONAL. The corresponding media type is application/access-services+json.¶

The "dns", "udp", and "ip" keys are each defined to hold a JSON dictionary containing the key "template" with a value that is a URI template suitable for configuring DNS over HTTPS, CONNECT-UDP, or CONNECT-IP, respectively.¶

The "ohttp" key contains a dictionary with either or both of these keys:¶

• "relay", containing a dictionary with a "template" key indicating the Oblivious Relay's resource mapping. The template MUST contain a "gateway_uri" variable indicating the Oblivious Gateway Resource.¶
• "gateway", containing a dictionary with a "uri" key indicating the Oblivious Gateway Resource and a "key" key conveying its KeyConfig in base64.¶

If the Access Description is for a general-purpose proxy, all Oblivious Gateways and proxy targets (respectively) are presumed to be supported; otherwise the supported Gateways and targets must be understood from context (but see Section 4).¶

{
  "dns": {
    "template": "https://doh.example.com/dns-query{?dns}",
  },
  "udp": {
    "template":
        "https://proxy.example.org/masque{?target_host,target_port}"
  },
  "ip": {
    "template": "https://proxy.example.org/masque{?target,ip_proto}"
  },
  "ohttp": {
    "relay": {
      "template": "https://proxy.example.org/ohttp{?gateway_uri}"
    }
  }
}

{
  "dns": {
    "template": "https://doh.example.com/dns-query{?dns}",
  },
  "ohttp": {
    "gateway": {
      "uri": "https://example.com/ohttp/",
      "key": "(KeyConfig in Base64)"
    }
  }
}

4. Discovery from an Origin

In cases where the HTTP access service is identified only by an origin (e.g. when configured as a Secure Web Proxy), operators can publish an associated access service collection at the path "/.well-known/access-services", with the Content-Type "application/access-services+json".¶

When the "ohttp.gateway" URI appears in an Access Description at this location, all URIs on this origin (except the Oblivious Gateway URI) are presumed to be reachable as Oblivious Targets.¶

Clients MAY fetch this Access Description and use the indicated services (in addition to any origin-scoped services) automatically. Clients SHOULD use the description only while it is fresh according to its HTTP cache lifetime, refreshing it as needed.¶

5. Security Considerations

TODO Security¶

6. IANA Considerations

IANA is requested to open a Specification Required registry entitled "HTTP Access Service Descriptors", with the following initial contents:¶

IANA is requested to add the following entry to the "Well-Known URIs" registry:¶

IANA is requested to add the following entry to the "application" sub-registry of the "Media Types" registry:¶

• TODO: Full registration template for this Media Type.¶

Acknowledgments

TODO acknowledge.¶

Author's Address