mnot@mnot.net https://www.mnot.net/

Applications and Real-Time HTTP HTTP API HTTP is often used as a substrate for other application protocols (a.k.a. HTTP-based APIs). This document specifies best practices for these protocols’ use of HTTP. Discussion of this draft takes place on the HTTP working group mailing list (ietf-http-wg@w3.org), which is archived at https://lists.w3.org/Archives/Public/ietf-http-wg/. Working Group information can be found at http://httpwg.github.io/; source code and issues list for this draft can be found at https://github.com/httpwg/http-extensions/labels/bcp56bis.

HTTP is often used as a substrate for applications other than Web browsing; this is sometimes referred to as creating “HTTP-based APIs”, or just “HTTP APIs”. This is done for a variety of reasons, including: familiarity by implementers, specifiers, administrators, developers and users, availability of a variety of client, server and proxy implementations, ease of use, availability of Web browsers, reuse of existing mechanisms like authentication and encryption, presence of HTTP servers and clients in target deployments, and its ability to traverse firewalls. These protocols are often ad hoc; they are intended for only deployment by one or a few servers, and consumption by a limited set of clients. As a result, a body of practices and tools has arisen around defining HTTP-based APIs that favours these conditions. However, when such a protocol is standarised, it is typically deployed on multiple uncoordinated servers, implemented a number of times, and consumed by a broader variety of clients. Such diversity brings a different set of concerns, and tools and practices intended for a single-server deployment might not be suitable. For example, HTTP-based APIs deployed in these circumstances need to more carefully consider how extensibility and evolution of the service will be handled, how different deployment requirements will be accommodated, and how clients will evolve with the API. More generally, application protocols using HTTP face a number of design decisions, including: Should it define a new URL scheme? Use new ports? Should it use standard HTTP methods and status codes, or define new ones? How can the maximum value be extracted from the use of HTTP? How does it coexist with other uses of HTTP – especially Web browsing? How can interoperability problems and “protocol dead ends” be avoided? This document contains best current practices regarding the use of HTTP by applications other than Web browsing. defines what applications it applies to; surveys the properties of HTTP that are important to preserve, and conveys best practices for those applications that do use HTTP. It is written primarily to guide IETF efforts to define application protocols using HTTP for deployment on the Internet, but might be applicable in other situations. Note that the requirements herein do not necessarily apply to the development of generic HTTP extensions.

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 when, and only when, they appear in all capitals, as shown here.

Different applications have different goals when using HTTP. In this document, we say an application is “using HTTP” when any of the following conditions are true: The transport port in use is 80 or 443, The URL scheme “http” or “https” is used, The ALPN protocol ID generically identifies HTTP (e.g., “http/1.1”, “h2”, “h2c”), or The IANA registries defined for HTTP are updated or modified. When an application is using HTTP, all of the requirements of the HTTP protocol suite are in force (including but not limited to , , , , , and ). An application might not be using HTTP according to this definition, but still relying upon the HTTP specifications in some manner. For example, an application might wish to avoid re-specifying parts of the message format, but change others; or, it might want to use a different set of methods. Such applications are referred to as “protocols based upon HTTP” in this document. These have more freedom to modify protocol operations, but are also likely to lose at least a portion of the benefits outlined above, as most HTTP implementations won’t be easily adaptable to these changes, and as the protocol diverges from HTTP, the benefit of mindshare will be lost. Protocols that are based upon HTTP MUST NOT reuse HTTP’s URL schemes, transport ports, ALPN protocol IDs or IANA registries; rather, they are encouraged to establish their own.

There are many ways that applications using HTTP are defined and deployed, and sometimes they are brought to the IETF for standardisation. In that process, what might be workable for deployment in a limited fashion isn’t appropriate for standardisation and the corresponding broader deployment. This section examines the facets of the protocol that are important to preserve in these situations.

When writing an application’s specification, it’s often tempting to specify exactly how HTTP is to be implemented, supported and used. However, this can easily lead to an unintended profile of HTTP’s behaviour. For example, it’s common to see specifications with language like this:

This forms an expectation in the client that the response will always be 201 Created, when in fact there are a number of reasons why the status code might differ in a real deployment. If the client does not anticipate this, the application’s deployment is brittle. Much of the value of HTTP is in its generic semantics – that is, the protocol elements defined by HTTP are potentially applicable to every resource, not specific to a particular context. Application-specific semantics are expressed in the payload; mostly, in the body, but also in header fields. This allows a HTTP message to be examined by generic HTTP software (e.g., HTTP servers, intermediaries, client implementations), and its handling to be correctly determined. It also allows people to leverage their knowledge of HTTP semantics without special-casing them for a particular application. Therefore, applications that use HTTP MUST NOT re-define, refine or overlay the semantics of defined protocol elements. Instead, they should focus their specifications on protocol elements that are specific to that application; namely their HTTP resources. See for details.

Another common practice is assuming that the HTTP server’s name space (or a portion thereof) is exclusively for the use of a single application. This effectively overlays special, application-specific semantics onto that space, precludes other applications from using it. As explained in , such “squatting” on a part of the URL space by a standard usurps the server’s authority over its own resources, can cause deployment issues, and is therefore bad practice in standards. Instead of statically defining URL components like paths, it is RECOMMENDED that applications using HTTP define links in payloads, to allow flexibility in deployment. Using runtime links in this fashion has a number of other benefits – especially when an application is to have multiple implementations and/or deployments (as is often the case for those that are standardised). For example, navigating with a link allows a request to be routed to a different server without the overhead of a redirection, thereby supporting deployment across machines well. It also becomes possible to “mix and match” different applications on the same server, and offers a natural mechanism for extensibility, versioning and capability management, since the document containing the links can also contain information about their targets. Using links also offers a form of cache invalidation that’s seen on the Web; when a resource’s state changes, the application can change its link to it so that a fresh copy is always fetched.

HTTP offers a number of features to applications, such as: Message framing Multiplexing (in HTTP/2) Integration with TLS Support for intermediaries (proxies, gateways, Content Delivery Networks) Client authentication Content negotiation for format, language, and other features Caching for server scalability, latency and bandwidth reduction, and reliability Granularity of access control (through use of a rich space of URLs) Partial content to selectively request part of a response The ability to interact with the application easily using a Web browser Applications that use HTTP are encouraged to utilise the various features that the protocol offers, so that their users receive the maximum benefit from it, and to allow it to be deployed in a variety of situations. This document does not require specific features to be used, since the appropriate design tradeoffs are highly specific to a given situation. However, following the practices in is a good starting point.

This section contains best practices regarding the use of HTTP by applications, including practices for specific HTTP protocol elements.

When specifying the use of HTTP, an application SHOULD use as the primary reference; it is not necessary to reference all of the specifications in the HTTP suite unless there are specific reasons to do so (e.g., a particular feature is called out). Applications using HTTP SHOULD NOT specify a minimum version of HTTP to be used; because it is a hop-by-hop protocol, a HTTP connection can be handled by implementations that are not controlled by the application; for example, proxies, CDNs, firewalls and so on. Requiring a particular version of HTTP makes it difficult to use in these situations, and harms interoperability for little reason (since HTTP’s semantics are stable between protocol versions). However, if an application’s deployment would benefit from the use of a particular version of HTTP (for example, HTTP/2’s multiplexing), this SHOULD be noted. Applications using HTTP MUST NOT specify a maximum version, to preserve the protocol’s ability to evolve. When specifying examples of protocol interactions, applications SHOULD document both the request and response messages, with full headers, preferably in HTTP/1.1 format. For example:

Applications that use HTTP should focus on defining the following application-specific protocol elements: Media types , often based upon a format convention such as JSON , HTTP header fields, as per , and The behaviour of resources, as identified by link relations . By composing these protocol elements, an application can define a set of resources, identified by link relations, that implement specified behaviours, including: Retrieval of their state using GET, in one or more formats identified by media type; Resource creation or update using POST or PUT, with an appropriately identified request body format; Data processing using POST and identified request and response body format(s); and Resource deletion using DELETE. For example, an application might specify:

HTTP does not mandate some behaviours that have nevertheless become very common; if these are not explicitly specified by applications using HTTP, there may be confusion and interoperability problems. This section recommends default handling for these mechanisms. Redirect handling - Applications need to specify how redirects are expected to be handled; see . Cookies - Applications using HTTP MUST explicitly reference the Cookie specification if they are required. Certificates - Applications using HTTP MUST specify that TLS certificates are to be checked according to when HTTPS is used. In general, applications using HTTP ought to align their usage as closely as possible with Web browsers, to avoid interoperability issues when they are used. See . If an application using HTTP has browser compatibility as a goal, client interaction ought to be defined in terms of , since that is the abstraction that browsers use for HTTP; it enforces many of these best practices. Applications using HTTP MUST NOT require HTTP features that are usually negotiated to be supported. For example, requiring that clients support responses with a certain content-encoding (, Section 3.1.2.2) instead of negotiating for it (, Section 5.3.4) means that otherwise conformant clients cannot interoperate with the application. Applications MAY encourage the implementation of such features, though.

In HTTP, URLs are opaque identifiers under the control of the server. As outlined in , standards cannot usurp this space, since it might conflict with existing resources, and constrain implementation and deployment. In other words, applications that use HTTP shouldn’t associate application semantics with specific URL paths on arbitrary servers. Doing so inappropriately conflates the identity of the resource (its URL) with the capabilities that resource supports, bringing about many of the same interoperability problems that warns of. For example, specifying that a “GET to the URL /foo retrieves a bar document” is bad practice. Likewise, specifying “The widget API is at the path /bar” violates . Instead, applications that use HTTP are encouraged to ensure that URLs are discovered at runtime, allowing HTTP-based services to describe their own capabilities. One way to do this is to use typed links to convey the URIs that are in use, as well as the semantics of the resources that they identify. See for details.

Generally, a client will begin interacting with a given application server by requesting an initial document that contains information about that particular deployment, potentially including links to other relevant resources. Applications that use HTTP are encouraged to allow an arbitrary URL to be used as that entry point. For example, rather than specifying “the initial document is at “/foo/v1”, they should allow a deployment to use any URL as the entry point for the application. In cases where doing so is impractical (e.g., it is not possible to convey a whole URL, but only a hostname) standard applications that use HTTP can request a well-known URL as an entry point.

Applications that use HTTP will typically employ the “http” and/or “https” URL schemes. “https” is RECOMMENDED to provide authentication, integrity and confidentiality, as well as mitigate pervasive monitoring attacks . However, application-specific schemes can be defined as well. When defining an URL scheme for an application using HTTP, there are a number of tradeoffs and caveats to keep in mind: Unmodified Web browsers will not support the new scheme. While it is possible to register new URL schemes with Web browsers (e.g. registerProtocolHandler() in , as well as several proprietary approaches), support for these mechanisms is not shared by all browsers, and their capabilities vary. Existing non-browser clients, intermediaries, servers and associated software will not recognise the new scheme. For example, a client library might fail to dispatch the request; a cache might refuse to store the response, and a proxy might fail to forward the request. Because URLs occur in HTTP artefacts commonly, often being generated automatically (e.g., in the Location response header), it can be difficult to assure that the new scheme is used consistently. The resources identified by the new scheme will still be available using “http” and/or “https” URLs. Those URLs can “leak” into use, which can present security and operability issues. For example, using a new scheme to assure that requests don’t get sent to a “normal” Web site is likely to fail. Features that rely upon the URL’s origin , such as the Web’s same-origin policy, will be impacted by a change of scheme. HTTP-specific features such as cookies , authentication , caching , HSTS , and CORS might or might not work correctly, depending on how they are defined and implemented. Generally, they are designed and implemented with an assumption that the URL will always be “http” or “https”. Web features that require a secure context will likely treat a new scheme as insecure. See for more information about minting new URL schemes.

Applications that use HTTP can use the applicable default port (80 for HTTP, 443 for HTTPS), or they can be deployed upon other ports. This decision can be made at deployment time, or might be encouraged by the application’s specification (e.g., by registering a port for that application). If a non-default port is used, it needs to be reflected in the authority of all URLs for that resource; the only mechanism for changing a default port is changing the scheme (see ). Using a port other than the default has privacy implications (i.e., the protocol can now be distinguished from other traffic), as well as operability concerns (as some networks might block or otherwise interfere with it). Privacy implications should be documented in Security Considerations. See for further guidance.

Applications that use HTTP MUST confine themselves to using registered HTTP methods such as GET, POST, PUT, DELETE, and PATCH. New HTTP methods are rare; they are required to be registered with IETF Review (see ), and are also required to be generic. That means that they need to be potentially applicable to all resources, not just those of one application. While historically some applications (e.g., ) have defined non-generic methods, now forbids this. When authors believe that a new method is required, they are encouraged to engage with the HTTP community early, and document their proposal as a separate HTTP extension, rather than as part of an application’s specification.

GET is one of the most common and useful HTTP methods; its retrieval semantics allow caching, side-effect free linking and forms the basis of many of the benefits of using HTTP. A common use of GET is to perform queries, often using the query component of the URL; this is a familiar pattern from Web browsing, and the results can be cached, improving efficiency of an often expensive process. In some cases, however, GET might be unwieldy for expressing queries, because of the limited syntax of the URL; in particular, if binary data forms part of the query terms, it needs to be encoded to conform to URL syntax. While this is not an issue for short queries, it can become one for larger query terms, or ones which need to sustain a high rate of requests. Additionally, some HTTP implementations limit the size of URLs they support – although modern HTTP software has much more generous limits than previously (typically, considerably more than 8000 octets, as required by , Section 3.1.1). In these cases, an application using HTTP might consider using POST to express queries in the request body; doing so avoids encoding overhead and URL length limits in implementations. However, in doing so it should be noted that the benefits of GET such as caching and linking to query results are lost. Therefore, applications using HTTP that feel a need to allow POST queries ought consider allowing both methods. Applications that use HTTP SHOULD NOT define GET requests to have side effects, since implementations can and do retry HTTP GET requests that fail. Finally, note that while HTTP allows GET requests to have a body syntactically, this is done only to allow parsers to be generic; as per , Section 4.3.1, a body on a GET has no meaning, and will be either ignored or rejected by generic HTTP software.

The OPTIONS method was defined for metadata retrieval, and is used both by WebDAV and CORS . Because HTTP-based APIs often need to retrieve metadata about resources, it is often considered for their use. However, OPTIONS does have significant limitations: It isn’t possible to link to the metadata with a simple URL, because OPTIONS is not the default GET method. OPTIONS responses are not cacheable, because HTTP caches operate on representations of the resource (i.e., GET and HEAD). If OPTIONS responses are cached separately, their interaction with HTTP cache expiry, secondary keys and other mechanisms needs to be considered. OPTIONS is “chatty” - always separating metadata out into a separate request increases the number of requests needed to interact with the application. Implementation support for OPTIONS is not universal; some servers do not expose the ability to respond to OPTIONS requests without significant effort. Instead of OPTIONS, one of these alternative approaches might be more appropriate: For server-wide metadata, create a well-known URI , or using an already existing one if it’s appropriate (e.g., HostMeta ). For metadata about a specific resource, use a Link response header, or a link in the representation format for that resource. See . Note that the Link header is available on HEAD responses, which is useful if the client wants to discover a resource’s capabilities before they interact with it.

The primary function of a HTTP status code is to convey semantics for the benefit of generic HTTP software, not to convey application-specific semantics. In particular, status codes are often generated or overwritten by intermediaries, as well as server and client implementations; for example, when network errors are encountered, a captive portal is present, when an implementation is overloaded, or it thinks it is under attack. As a result, the status code that a server-side application generates and the one that the client software receives often differ. This means that status codes are not a reliable way to carry application-specific signals. Specifying that a particular status code has a specific meaning in the context of an application can have unintended side effects; if that status code is generated by a generic HTTP component can lead clients to believe that the application is in a state that wasn’t intended. Instead, applications using HTTP should specify the implications of general classes of responses (e.g., “successful response” for 2xx; “client error” for 4xx and “server error” for 5xx), conveying any application-specific information in the message body and/or HTTP header fields, not the status code. provides one way for applications using HTTP to do so for error conditions. There are limited exceptions to this; for example, applications might use 201 (Created) or 404 (Not Found) to convey application semantics that are compatible with the generic HTTP semantics of those status codes. In general, though, applications should resist the temptation to map their semantics into fine-grained status codes. Because the set of registered HTTP status codes can expand, applications using HTTP should explicitly point out that clients ought to be able to handle all applicable status codes gracefully (i.e., falling back to the generic n00 semantics of a given status code; e.g., 499 can be safely handled as 400 by clients that don’t recognise it). This is preferable to creating a “laundry list” of potential status codes, since such a list is never complete. Applications using HTTP MUST NOT re-specify the semantics of HTTP status codes, even if it is only by copying their definition. They MUST NOT require specific reason phrases to be used; the reason phrase has no function in HTTP, and is not guaranteed to be preserved by implementations, and the reason phrase is not carried at all in the message format. Applications that use HTTP MUST only use registered HTTP status codes. As with methods, new HTTP status codes are rare, and required (by ) to be registered with IETF review. Similarly, HTTP status codes are generic; they are required (by ) to be potentially applicable to all resources, not just to those of one application. When authors believe that a new status code is required, they are encouraged to engage with the HTTP community early, and document their proposal as a separate HTTP extension, rather than as part of an application’s specification.

The 3xx series of status codes specified in , Section 6.4 are used to direct the user agent to another resource to satisfy the request. The most common of these are 301, 302, 307 and 308 (), all of which use the Location response header field to indicate where the client should send the request to. There are two ways that this group of status codes differ: Whether they are permanent or temporary. Permanent redirects can be used to update links stored in the client (e.g., bookmarks), whereas temporary ones can not. Note that this has no effect on HTTP caching; it is completely separate. Whether they allow the redirected request to change the request method from POST to GET. Web browsers generally do change POST to GET for 301 and 302; therefore, 308 and 307 were created to allow redirection without changing the method. This table summarises their relationships:   Permanent Temporary Allows changing the request method from POST to GET 301 302 Does not allow changing the request method 308 307 As noted in , a user agent is allowed to automatically follow a 3xx redirect that has a Location response header field, even if they don’t understand the semantics of the specific status code. However, they aren’t required to do so; therefore, if an application using HTTP desires redirects to be automatically followed, it needs to explicitly specify the circumstances when this is required. Applications using HTTP SHOULD specify that 301 and 302 responses change the subsequent request method from POST (but no other method) to GET, to be compatible with browsers. Generally, when a redirected request is made, its header fields are copied from the original request’s. However, they can be modified by various mechanisms; e.g., sent Authorization () and Cookie () headers will change if the origin (and sometimes path) of the request changes. Applications using HTTP SHOULD specify if any request headers need to be modified or removed upon a redirect; however, this behaviour cannot be relied upon, since a generic client (like a browser) will be unaware of such requirements.

Applications that use HTTP MAY define new HTTP header fields. Typically, using HTTP header fields is appropriate in a few different situations: Their content is useful to intermediaries (who often wish to avoid parsing the body), and/or Their content is useful to generic HTTP software (e.g., clients, servers), and/or It is not possible to include their content in the message body (usually because a format does not allow it). New header fields MUST be registered, as per and . See , Section 8.3.1 for guidelines to consider when minting new header fields. provides a common structure for new header fields, and avoids many issues in their parsing and handling; it is RECOMMENDED that new header fields use it. It is RECOMMENDED that header field names be short (even when HTTP/2 header compression is in effect, there is an overhead) but appropriately specific. In particular, if a header field is specific to an application, an identifier for that application SHOULD form a prefix to the header field name, separated by a “-“. For example, if the “example” application needs to create three headers, they might be called “example-foo”, “example-bar” and “example-baz”. Note that the primary motivation here is to avoid consuming more generic header names, not to reserve a portion of the namespace for the application; see for related considerations. The semantics of existing HTTP header fields MUST NOT be re-defined without updating their registration or defining an extension to them (if allowed). For example, an application using HTTP cannot specify that the Location header has a special meaning in a certain context. See for the interaction between headers and HTTP caching; in particular, request headers that are used to “select” a response have impact there, and need to be carefully considered. See for considerations regarding header fields that carry application state (e.g., Cookie).

There are many potential formats for payloads; for example, JSON , XML , and CBOR . Best practices for their use are out of scope for this document. Applications SHOULD register distinct media types for each format they define; this makes it possible to identify them unambiguously and negotiate for their use. See for more information.

HTTP caching is one of the primary benefits of using HTTP for applications; it provides scalability, reduces latency and improves reliability. Furthermore, HTTP caches are readily available in browsers and other clients, networks as forward and reverse proxies, Content Delivery Networks and as part of server software. Assigning even a short freshness lifetime (, Section 4.2) – e.g., 5 seconds – allows a response to be reused to satisfy multiple clients, and/or a single client making the same request repeatedly. In general, if it is safe to reuse something, consider assigning a freshness lifetime; cache implementations take active measures to remove content intelligently when they are out of space, so “it will fill up the cache” is not a valid concern. The most common method for specifying freshness is the max-age response directive (, Section 5.2.2.8). The Expires header (, Section 5.3) can also be used, but it is not necessary to specify it; all modern cache implementations support Cache-Control, and specifying freshness as a delta is both more convenient in most cases, and less error-prone. Understand that stale responses (e.g., one with “Cache-Control: max-age=0”) can be reused when the cache is disconnected from the origin server; this can be useful for handling network issues. See , Section 4.2.4, and also for additional controls over stale content. Stale responses can be refreshed by assigning a validator, saving both transfer bandwidth and latency for large responses; see . If an application defines a request header field that might be used by a server to change the response’s headers or body, authors should point out that this has implications for caching; in general, such resources need to either make their responses uncacheable (e.g., with the “no-store” cache-control directive defined in , Section 5.2.2.3) or consistently send the Vary response header (, Section 7.1.4). For example, this response:

can be stored for 60 seconds by both private and shared caches, can be revalidated with If-None-Match, and varies on the Accept-Encoding request header field. In some situations, responses without explicit cache directives (e.g., Cache-Control or Expires) will be stored and served using a heuristic freshness lifetime; see , Section 4.2.2. As the heuristic is not under control of the application, it is generally preferable to set an explicit freshness lifetime. If caching of a response is not desired, the appropriate response directive is “Cache-Control: no-store”. This only need be sent in situations where the response might be cached; see , Section 3. Note that “Cache-Control: no-cache” allows a response to be stored, just not reused by a cache; it does not prevent caching (despite its name). For example, this response cannot be stored or reused by a cache:

When an application has a need to express a lifetime that’s separate from the freshness lifetime, this should be expressed separately, either in the response’s body or in a separate header field. When this happens, the relationship between HTTP caching and that lifetime need to be carefully considered, since the response will be used as long as it is considered fresh. Like other functions, HTTP caching is generic; it does not have knowledge of the application in use. Therefore, caching extensions need to be backwards-compatible, as per , Section 5.2.3.

Applications that use HTTP MAY use stateful cookies to identify a client and/or store client-specific data to contextualise requests. When used, it is important to carefully specify the scoping and use of cookies; if the application exposes sensitive data or capabilities (e.g., by acting as an ambient authority), exploits are possible. Mitigations include using a request-specific token to assure the intent of the client. Applications MUST NOT make assumptions about the relationship between separate requests on a single transport connection; doing so breaks many of the assumptions of HTTP as a stateless protocol, and will cause problems in interoperability, security, operability and evolution.

Applications that use HTTP MAY use HTTP authentication to identify clients. The Basic authentication scheme MUST NOT be used unless the underlying transport is authenticated, integrity-protected and confidential (e.g., as provided the “HTTPS” URL scheme, or another using TLS). The Digest scheme MUST NOT be used unless the underlying transport is similarly secure, or the chosen hash algorithm is not “MD5”. With HTTPS, clients might also be authenticated using certificates . When used, it is important to carefully specify the scoping and use of authentication; if the application exposes sensitive data or capabilities (e.g., by acting as an ambient authority), exploits are possible. Mitigations include using a request-specific token to assure the intent of the client.

Even if there is not an intent for an application that uses HTTP to be used with a Web browser, its resources will remain available to browsers and other HTTP clients. This means that all such applications need to consider how browsers will interact with them, particularly regarding security. For example, if an application’s state can be changed using a POST request, a Web browser can easily be coaxed into making that request by a HTML form on an arbitrary Web site. Or, If content returned from the application’s resources is under control of an attacker (for example, part of the request is reflected in the response, or the response contains external information that might be under the control of the attacker), a cross-site scripting attack is possible, whereby an attacker can inject code into the browser and access data and capabilities on that origin. This is only a small sample of the kinds of issues that applications using HTTP must consider. Generally, the best approach is to consider the application actually as a Web application, and to follow best practices for their secure development. A complete enumeration of such practices is out of scope for this document, but some considerations include: Using an application-specific media type in the Content-Type header, and requiring clients to fail if it is not used Using X-Content-Type-Options: nosniff to assure that content under attacker control can’t be coaxed into a form that is interpreted as active content by a Web browser Using Content-Security-Policy to constrain the capabilities of active content (such as HTML ), thereby mitigating Cross-Site Scripting attacks Using Referrer-Policy to prevent sensitive data in URLs from being leaked in the Referer request header Using the ‘HttpOnly’ flag on Cookies to assure that cookies are not exposed to browser scripting languages Avoiding use of compression on any sensitive information (e.g., authentication tokens, passwords), as the scripting environment offered by Web browsers allows an attacker to repeatedly probe the compression space; if the attacker has access to the path of the communication, they can use this capability to recover that information. Depending on how they are intended to be deployed, specifications for applications using HTTP might require the use of these mechanisms in specific ways, or might merely point them out in Security Considerations. An example of a HTTP response from an application that does not intend for its content to be treated as active by browsers might look like this:

If an application using HTTP has browser compatibility as a goal, client interaction ought to be defined in terms of , since that is the abstraction that browsers use for HTTP; it enforces many of these best practices.

Because the origin is how many HTTP capabilities are scoped, applications also need to consider how deployments might interact with other applications (including Web browsing) on the same origin. For example, if Cookies are used to carry application state, they will be sent with all requests to the origin by default, unless scoped by path, and the application might receive cookies from other applications on the origin. This can lead to security issues, as well as collision in cookie names. One solution to these issues is to require a dedicated hostname for the application, so that it has a unique origin. However, it is often desirable to allow multiple applications to be deployed on a single hostname; doing so provides the most deployment flexibility and enables them to be “mixed” together (See for details). Therefore, applications using HTTP should strive to allow multiple applications on an origin. To enable this, when specifying the use of Cookies, HTTP authentication realms , or other origin-wide HTTP mechanisms, applications using HTTP SHOULD NOT mandate the use of a particular identifier, but instead let deployments configure them. Consideration SHOULD be given to scoping them to part of the origin, using their specified mechanisms for doing so. Modern Web browsers constrain the ability of content from one origin to access resources from another, to avoid leaking private information. As a result, applications that wish to expose cross-origin data to browsers will need to implement the CORS protocol; see .

HTTP/2 adds the ability for servers to “push” request/response pairs to clients in , Section 8.2. While server push seems like a natural fit for many common application semantics (e.g., “fanout” and publish/subscribe), a few caveats should be noted: Server push is hop-by-hop; that is, it is not automatically forwarded by intermediaries. As a result, it might not work easily (or at all) with proxies, reverse proxies, and Content Delivery Networks. Server push can have negative performance impact on HTTP when used incorrectly; in particular, if there is contention with resources that have actually been requested by the client. Server push is implemented differently in different clients, especially regarding interaction with HTTP caching, and capabilities might vary. APIs for server push are currently unavailable in some implementations, and vary widely in others. In particular, there is no current browser API for it. Server push is not supported in HTTP/1.1 or HTTP/1.0. Server push does not form part of the “core” semantics of HTTP, and therefore might not be supported by future versions of the protocol. Applications wishing to optimise cases where the client can perform work related to requests before the full response is available (e.g., fetching links for things likely to be contained within) might benefit from using the 103 (Early Hints) status code; see . Applications using server push directly need to enforce the requirements regarding authority in , Section 8.2, to avoid cross-origin push attacks.

It’s often necessary to introduce new features into application protocols, and change existing ones. In HTTP, backwards-incompatible changes are possible using a number of mechanisms: Using a distinct link relation type to identify a URL for a resource that implements the new functionality Using a distinct media type to identify formats that enable the new functionality Using a distinct HTTP header field to implement new functionality outside the message body

This document has no requirements for IANA.

discusses the impact of using stateful mechanisms in the protocol as ambient authority, and suggests a mitigation. requires support for ‘https’ URLs, and discourages the use of ‘http’ URLs, to provide authentication, integrity and confidentiality, as well as mitigate pervasive monitoring attacks. highlights the implications of Web browsers’ capabilities on applications that use HTTP. discusses the issues that arise when applications are deployed on the same origin as Web sites (and other applications). highlights risks of using HTTP/2 server push in a manner other than specified. Applications that use HTTP in a manner that involves modification of implementations – for example, requiring support for a new URL scheme, or a non-standard method – risk having those implementations “fork” from their parent HTTP implementations, with the possible result that they do not benefit from patches and other security improvements incorporated upstream.

HTTP clients can expose a variety of information to servers. Besides information that’s explicitly sent as part of an application’s operation (for example, names and other user-entered data), and “on the wire” (which is one of the reasons https is recommended in ), other information can be gathered through less obvious means – often by connecting activities of a user over time. This includes session information, tracking the client through fingerprinting, and mobile code. Session information includes things like the IP address of the client, TLS session tickets, Cookies, ETags stored in the client’s cache, and other stateful mechanisms. Applications are advised to avoid using session mechanisms unless they are unavoidable or necessary for operation, in which case these risks needs to be documented. When they are used, implementations should be encouraged to allow clearing such state. Fingerprinting uses unique aspects of a client’s messages and behaviours to connect disparate requests and connections. For example, the User-Agent request header conveys specific information about the implementation; the Accept-Language request header conveys the users’ preferred language. In combination, a number of these markers can be used to uniquely identify a client, impacting its control over its data. As a result, applications are advised to specify that clients should only emit the information they need to function in requests. Finally, if an application exposes the ability to run mobile code, great care needs to be taken, since any ability to observe its environment can be used as an opportunity to both fingerprint the client and to obtain and manipulate private data (including session information). For example, access to high-resolution timers (even indirectly) can be used to profile the underlying hardware, creating a unique identifier for the system. Applications are advised avoid allowing the use of mobile code where possible; when it cannot be avoided, the resulting system’s security properties need be carefully scrutinised.

The Hypertext Transfer Protocol (HTTP) is a stateless application-level protocol for distributed, collaborative, hypertext information systems. This document provides an overview of HTTP architecture and its associated terminology, defines the "http" and "https" Uniform Resource Identifier (URI) schemes, defines the HTTP/1.1 message syntax and parsing requirements, and describes related security concerns for implementations. In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. This document describes a Transport Layer Security (TLS) extension for application-layer protocol negotiation within the TLS handshake. For instances in which multiple application protocols are supported on the same TCP or UDP port, this extension allows the application layer to negotiate which protocol will be used within the TLS connection. The Hypertext Transfer Protocol (HTTP) is a stateless \%application- level protocol for distributed, collaborative, hypertext information systems. This document defines the semantics of HTTP/1.1 messages, as expressed by request methods, request header fields, response status codes, and response header fields, along with the payload of messages (metadata and body content) and mechanisms for content negotiation. The Hypertext Transfer Protocol (HTTP) is a stateless application- level protocol for distributed, collaborative, hypertext information systems. This document defines HTTP/1.1 conditional requests, including metadata header fields for indicating state changes, request header fields for making preconditions on such state, and rules for constructing the responses to a conditional request when one or more preconditions evaluate to false. The Hypertext Transfer Protocol (HTTP) is a stateless application- level protocol for distributed, collaborative, hypertext information systems. This document defines range requests and the rules for constructing and combining responses to those requests. The Hypertext Transfer Protocol (HTTP) is a stateless \%application- level protocol for distributed, collaborative, hypertext information systems. This document defines HTTP caches and the associated header fields that control cache behavior or indicate cacheable response messages. The Hypertext Transfer Protocol (HTTP) is a stateless application- level protocol for distributed, collaborative, hypermedia information systems. This document defines the HTTP Authentication framework. This specification describes an optimized expression of the semantics of the Hypertext Transfer Protocol (HTTP), referred to as HTTP version 2 (HTTP/2). HTTP/2 enables a more efficient use of network resources and a reduced perception of latency by introducing header field compression and allowing multiple concurrent exchanges on the same connection. It also introduces unsolicited push of representations from servers to clients.This specification is an alternative to, but does not obsolete, the HTTP/1.1 message syntax. HTTP's existing semantics remain unchanged. Section 1.1.1 of RFC 3986 defines URI syntax as "a federated and extensible naming system wherein each scheme's specification may further restrict the syntax and semantics of identifiers using that scheme." In other words, the structure of a URI is defined by its scheme. While it is common for schemes to further delegate their substructure to the URI's owner, publishing independent standards that mandate particular forms of URI substructure is inappropriate, because that essentially usurps ownership. This document further describes this problematic practice and provides some acceptable alternatives for use in standards. This document defines procedures for the specification and registration of media types for use in HTTP, MIME, and other Internet protocols. This memo documents an Internet Best Current Practice. This specification defines a model for the relationships between resources on the Web ("links") and the type of those relationships ("link relation types").It also defines the serialisation of such links in HTTP headers with the Link header field. This memo describes how to use Transport Layer Security (TLS) to secure Hypertext Transfer Protocol (HTTP) connections over the Internet. This memo provides information for the Internet community. This document defines the concept of an "origin", which is often used as the scope of authority or privilege by user agents. Typically, user agents isolate content retrieved from different origins to prevent malicious web site operators from interfering with the operation of benign web sites. In addition to outlining the principles that underlie the concept of origin, this document details how to determine the origin of a URI and how to serialize an origin into a string. It also defines an HTTP header field, named "Origin", that indicates which origins are associated with an HTTP request. [STANDARDS-TRACK] This specification defines registration procedures for the message header fields used by Internet mail, HTTP, Netnews and other applications. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. Historically, designers and implementers of application protocols have often distinguished between standardized and unstandardized parameters by prefixing the names of unstandardized parameters with the string "X-" or similar constructs. In practice, that convention causes more problems than it solves. Therefore, this document deprecates the convention for newly defined parameters with textual (as opposed to numerical) names in application protocols. This memo documents an Internet Best Current Practice. WHATWG WHATWG JavaScript Object Notation (JSON) is a lightweight, text-based, language-independent data interchange format. It was derived from the ECMAScript Programming Language Standard. JSON defines a small set of formatting rules for the portable representation of structured data.This document removes inconsistencies with other specifications of JSON, repairs specification errors, and offers experience-based interoperability guidance. This document defines the HTTP Cookie and Set-Cookie header fields. These header fields can be used by HTTP servers to store state (called cookies) at HTTP user agents, letting the servers maintain a stateful session over the mostly stateless HTTP protocol. Although cookies have many historical infelicities that degrade their security and privacy, the Cookie and Set-Cookie header fields are widely used on the Internet. This document obsoletes RFC 2965. [STANDARDS-TRACK] IAB The Domain Name System (DNS) provides an essential service on the Internet, mapping structured names to a variety of data, usually IP addresses. These names appear in email addresses, Uniform Resource Identifiers (URIs), and other application-layer identifiers that are often rendered to human users. Because of this, there has been a strong demand to acquire names that have significance to people, through equivalence to registered trademarks, company names, types of services, and so on. There is a danger in this trend; the humans and automata that consume and use such names will associate specific semantics with some names and thereby make assumptions about the services that are, or should be, provided by the hosts associated with the names. Those assumptions can often be false, resulting in a variety of failure conditions. This document discusses this problem in more detail and makes recommendations on how it can be avoided. This memo provides information for the Internet community. This memo defines a path prefix for "well-known locations", "/.well-known/", in selected Uniform Resource Identifier (URI) schemes. [STANDARDS-TRACK] Pervasive monitoring is a technical attack that should be mitigated in the design of IETF protocols, where possible. This specification defines a mechanism enabling web sites to declare themselves accessible only via secure connections and/or for users to be able to direct their user agent(s) to interact with given sites only over secure connections. This overall policy is referred to as HTTP Strict Transport Security (HSTS). The policy is declared by web sites via the Strict-Transport-Security HTTP response header field and/or by other means, such as user agent configuration, for example. [STANDARDS-TRACK] This document updates the guidelines and recommendations, as well as the IANA registration processes, for the definition of Uniform Resource Identifier (URI) schemes. It obsoletes RFC 4395. This document provides recommendations to designers of application and service protocols on how to use the transport protocol port number space and when to request a port assignment from IANA. It provides designer guidance to requesters or users of port numbers on how to interact with IANA using the processes defined in RFC 6335; thus, this document complements (but does not update) that document. This document defines extensions to the Web Distributed Authoring and Versioning (WebDAV) protocol to specify a standard way of accessing, managing, and sharing calendaring and scheduling information based on the iCalendar format. This document defines the "calendar-access" feature of CalDAV. [STANDARDS-TRACK] Web Distributed Authoring and Versioning (WebDAV) consists of a set of methods, headers, and content-types ancillary to HTTP/1.1 for the management of resource properties, creation and management of resource collections, URL namespace manipulation, and resource locking (collision avoidance).RFC 2518 was published in February 1999, and this specification obsoletes RFC 2518 with minor revisions mostly due to interoperability experience. [STANDARDS-TRACK] This specification describes a method for locating host metadata as well as information about individual resources controlled by the host. [STANDARDS-TRACK] This document defines a "problem detail" as a way to carry machine- readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs. This document specifies the additional Hypertext Transfer Protocol (HTTP) status code 308 (Permanent Redirect). This document describes a set of data types and algorithms associated with them that are intended to make it easier and safer to define and handle HTTP header fields. It is intended for use by new specifications of HTTP header fields as well as revisions of existing header field specifications when doing so does not cause interoperability issues. The Concise Binary Object Representation (CBOR) is a data format whose design goals include the possibility of extremely small code size, fairly small message size, and extensibility without the need for version negotiation. These design goals make it different from earlier binary serializations such as ASN.1 and MessagePack. This document defines two independent HTTP Cache-Control extensions that allow control over the use of stale responses by caches. This document is not an Internet Standards Track specification; it is published for informational purposes. This document defines the "Basic" Hypertext Transfer Protocol (HTTP) authentication scheme, which transmits credentials as user-id/ password pairs, encoded using Base64. The Hypertext Transfer Protocol (HTTP) provides a simple challenge- response authentication mechanism that may be used by a server to challenge a client request and by a client to provide authentication information. This document defines the HTTP Digest Authentication scheme that can be used with the HTTP authentication mechanism. This document specifies Version 1.2 of the Transport Layer Security (TLS) protocol. The TLS protocol provides communications security over the Internet. The protocol allows client/server applications to communicate in a way that is designed to prevent eavesdropping, tampering, or message forgery. [STANDARDS-TRACK] This memo introduces an informational HTTP status code that can be used to convey hints that help a client make preparations for processing the final response. Recently there has been widespread interest in using Hypertext Transfer Protocol (HTTP) as a substrate for other applications-level protocols. This document recommends technical particulars of such use, including use of default ports, URL schemes, and HTTP security mechanisms. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.

captured the Best Current Practice in the early 2000’s, based on the concerns facing protocol designers at the time. Use of HTTP has changed considerably since then, and as a result this document is substantially different. As a result, the changes are too numerous to list individually.