Network Working Group | S. Deckers |
Internet-Draft | Commons Host |
Intended status: Experimental | B. English |
Expires: September 26, 2019 | Independent |
March 25, 2019 |
Gopher over HTTPS (GoH)
draft-sebdeckers-gopher-over-https-latest
This document describes a protocol for sending Gopher requests and receiving Gopher responses over HTTPS. Each Gopher request-response pair is mapped to an HTTPS exchange.
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 September 26, 2019.
Copyright (c) 2019 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 Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
This document defines a specific protocol, Gopher over HTTPS (GoH), for sending Gopher [RFC1436] requests, as Gopher [RFC4266] URIs, and receiving Gopher responses over HTTPS [RFC7540], using https [RFC2818] URIs (and therefore TLS [RFC8446] security for integrity and confidentiality). Each Gopher request-response pair is mapped into an HTTPS exchange.
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.
A server that supports this protocol is called a “GoH server” to differentiate it from a “Gopher server”. Similarly, a client that supports this protocol is called a “GoH client”.
A GoH client is configured with a URI Template [RFC6570] which describes how to construct the URL to use for the HTTP request. Discovery of the URI Template is beyond the scope of this protocol. The single variable “url” is defined as the Gopher URI of the request.
Example URI Template:
https://goh.example.com/gopher-proxy{?url}
Given the Gopher URI of the Gopher request:
gopher://gopher.example.com
Results in the HTTPS request URI:
https://goh.example.com/gopher-proxy?url=gopher%3A%2F%2Fgopher.example.com
A GoH client encodes a single Gopher request into an HTTP request. The HTTP request MUST use the GET method. A GoH client SHOULD include an HTTP Accept request header field with the media type “application/gopher”.
Accept: application/gopher
A GoH server must include an HTTP Content-Type response header field with the media type “application/gopher” to indicate the body contains a Gopher response.
Content-Type: application/gopher
A GoH server response has the Gopher response as its body.
Type name: application
Subtype name: gopher
Required parameters: N/A
Optional parameters: N/A
Encoding considerations: This is either in text or binary format. The contents are a Gopher response as defined in RFC1436.
Security considerations: The content is a Gopher response. Security issues are not discussed in RFC1436.
Interoperability considerations: None.
Published specification: RFC XXXX.
Applications that use this media type: Gopher over HTTPS clients and servers, or other systems using Gopher responses.
Additional information:
Deprecated alias names for this type: N/A Magic number(s): N/A File extension(s): N/A Macintosh file type code(s): N/A
Person & email address to contact for further information: Sebastiaan Deckers sebdeckers83@gmail.com
Intended usage: COMMON
Restrictions on usage: N/A
Author: Sebastiaan Deckers sebdeckers83@gmail.com
Change controller: IESG