RFC 8307

Well-Known URIs for the WebSocket Protocol

📅 published January 2018, from ietf

RFC 8307: Well-Known URIs for the WebSocket Protocol 🦋

okay bestie, here's the deets 💖 This doc is RFC 8307, called Well-Known URIs for the WebSocket Protocol. It's written by Carsten Bormann from Universitaet Bremen TZI, and it's dated January 2018 📅. The category is Standards Track, and the ISSN is 2070-1721. It updates RFC 6455 (that's the WebSocket spec) 🔥. The header doesn't list anything it obsoletes.

Abstract ✨

okay so RFC 5785 gives us a path prefix, /.well-known/, for well-known URIs 🎀 It was built specifically for the "http" and "https" schemes. This memo formally updates RFC 6455, which defines the WebSocket URI schemes, so that "ws" and "wss" can use well-known URIs too 💅

Status of This Memo 📜

This is an Internet Standards Track document 🌈

This document comes from the Internet Engineering Task Force (IETF) 🌸 It represents the consensus of the IETF community, got public review, and was approved for publication by the Internet Engineering Steering Group (IESG). If you want more on Internet Standards, check Section 2 of RFC 7841 🧚

For the current status, any errata, and how to send feedback, go to https://www.rfc-editor.org/info/rfc8307 💜

Copyright (c) 2018 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, since 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 they're provided without warranty as described in the Simplified BSD License 🫶

Table of Contents 🗂️

1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
2.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   2
3.  Security Considerations . . . . . . . . . . . . . . . . . . .   2
4.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   3
  4.1.  Normative References  . . . . . . . . . . . . . . . . . .   3
  4.2.  Informative References  . . . . . . . . . . . . . . . . .   3
Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   3

1. Introduction 🎀

okay so [RFC5785] defines the /.well-known path prefix that well-known URIs use 🌷 It also has an IANA registry of URI suffixes for forming those URIs, which is lowkey iconic 👑

In [RFC5785], this mechanism is specifically defined for the "http" and "https" URI schemes (now defined in [RFC7230]). Other schemes like "coap" and "coaps" [RFC7252] have since picked it up too, and they share the registry of URI suffixes with HTTP(S) 🍓

[RFC6455] defines the WebSocket URI schemes, "ws" and "wss". It does not define the use of well-known URIs for those schemes 😭

so this memo formally updates [RFC6455] to extend the use of [RFC5785] well-known URIs to the URI schemes "ws" and "wss" 💅✨

Well-known URIs for "ws" and "wss" share the registry for URI suffixes established by [RFC5785]. This memo doesn't change the registry or its IANA considerations 🧚

2. IANA Considerations 📋

This document does not require any IANA actions 💜

3. Security Considerations 🔥

⚠️ This section is serious business, bestie, so read it carefully!

The Security Considerations of [RFC5785] apply and need to be considered for all well-known URIs 🙈

It has always been possible to form "ws" and "wss" URIs so that they map to well-known HTTP(S) URIs when you use the procedure in Section 4 of [RFC6455]. Formally making the well-known URI mechanism available for "ws" and "wss" doesn't create any new security considerations 🌸

However, now that well-known URIs are available for the WebSocket Protocol, applications that want to define well-known URI suffixes specifically for WebSocket use also need to think about whether the resources available under the equivalent HTTP(S) URI, formed by Section 4 of [RFC6455], could cause any information disclosure or other security problems. This is a big deal, so please don't skip it 😭💀

4. References 📚

4.1. Normative References

[RFC5785]  Nottingham, M. and E. Hammer-Lahav, "Defining Well-Known
           Uniform Resource Identifiers (URIs)", RFC 5785,
           DOI 10.17487/RFC5785, April 2010,
           <https://www.rfc-editor.org/info/rfc5785>.

[RFC6455]  Fette, I. and A. Melnikov, "The WebSocket Protocol",
           RFC 6455, DOI 10.17487/RFC6455, December 2011,
           <https://www.rfc-editor.org/info/rfc6455>.

4.2. Informative References

[RFC7230]  Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
           Protocol (HTTP/1.1): Message Syntax and Routing",
           RFC 7230, DOI 10.17487/RFC7230, June 2014,
           <https://www.rfc-editor.org/info/rfc7230>.

[RFC7252]  Shelby, Z., Hartke, K., and C. Bormann, "The Constrained
           Application Protocol (CoAP)", RFC 7252,
           DOI 10.17487/RFC7252, June 2014,
           <https://www.rfc-editor.org/info/rfc7252>.

Author's Address 🧸

Carsten Bormann
Universitaet Bremen TZI
Postfach 330440
Bremen  D-28359
Germany

Phone: +49-421-218-63921
Email: cabo@tzi.org

That's the whole tea, bestie! 🌈💖

📦 where this page comes from