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

Abstract

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.

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 September 26, 2019.

Copyright Notice

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.


Table of Contents

1. Introduction

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.

2. Terminology

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”.

3. HTTP and Gopher URL

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

4. The HTTP Exchange

4.1. The HTTP Request

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

4.2. The HTTP Response

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.

5. IANA Considerations

5.1. Registration of the “application/gopher” Media Type

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

6. Privacy Considerations

7. Security Considerations

8. Operational Considerations

9. Normative References

[RFC1436] Anklesaria, F., McCahill, M., Lindner, P., Johnson, D., Torrey, D. and B. Albert, "The Internet Gopher Protocol (a distributed document search and retrieval protocol)", RFC 1436, DOI 10.17487/RFC1436, March 1993.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997.
[RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, DOI 10.17487/RFC2818, May 2000.
[RFC4266] Hoffman, P., "The gopher URI Scheme", RFC 4266, DOI 10.17487/RFC4266, November 2005.
[RFC6570] Gregorio, J., Fielding, R., Hadley, M., Nottingham, M. and D. Orchard, "URI Template", RFC 6570, DOI 10.17487/RFC6570, March 2012.
[RFC7540] Belshe, M., Peon, R. and M. Thomson, "Hypertext Transfer Protocol Version 2 (HTTP/2)", RFC 7540, DOI 10.17487/RFC7540, May 2015.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018.

Authors' Addresses

Sebastiaan Deckers Commons Host EMail: sebdeckers83@gmail.com
Bryan English Independent EMail: bryan@bryanenglish.com