This specification aims to formalize the Rack protocol. You can (and should) use Rack::Lint to enforce it. When you develop middleware, be sure to add a Lint before and after to catch all mistakes.

Rack applications

A Rack application is a Ruby object (not a class) that responds to call. It takes exactly one argument, the environment and returns an Array of exactly three values: The status, the headers, and the body.

The Environment

The environment must be an instance of Hash that includes CGI-like headers. The application is free to modify the environment. The environment is required to include these variables (adopted from PEP333), except when they’d be empty, but see below.

REQUEST_METHOD

The HTTP request method, such as “GET” or “POST”. This cannot ever be an empty string, and so is always required.

SCRIPT_NAME

The initial portion of the request URL’s “path” that corresponds to the application object, so that the application knows its virtual “location”. This may be an empty string, if the application corresponds to the “root” of the server.

PATH_INFO

The remainder of the request URL’s “path”, designating the virtual “location” of the request’s target within the application. This may be an empty string, if the request URL targets the application root and does not have a trailing slash. This value may be percent-encoded when I originating from a URL.

QUERY_STRING

The portion of the request URL that follows the ?, if any. May be empty, but is always required!

SERVER_NAME, SERVER_PORT

When combined with SCRIPT_NAME and PATH_INFO, these variables can be used to complete the URL. Note, however, that HTTP_HOST, if present, should be used in preference to SERVER_NAME for reconstructing the request URL. SERVER_NAME and SERVER_PORT can never be empty strings, and so are always required.

HTTP_ Variables

Variables corresponding to the client-supplied HTTP request headers (i.e., variables whose names begin with HTTP_). The presence or absence of these variables should correspond with the presence or absence of the appropriate HTTP header in the request. See <a href=“tools.ietf.org/html/rfc3875#section-4.1.18”> RFC3875 section 4.1.18</a> for specific behavior.

In addition to this, the Rack environment must include these Rack-specific variables:

rack.version

The Array [1,1], representing this version of Rack.

rack.url_scheme

http or https, depending on the request URL.

rack.input

See below, the input stream.

rack.errors

See below, the error stream.

rack.multithread

true if the application object may be simultaneously invoked by another thread in the same process, false otherwise.

rack.multiprocess

true if an equivalent application object may be simultaneously invoked by another process, false otherwise.

rack.run_once

true if the server expects (but does not guarantee!) that the application will only be invoked this one time during the life of its containing process. Normally, this will only be true for a server based on CGI (or something similar).

rack.hijack?

present and true if the server supports connection hijacking. See below, hijacking.

rack.hijack

an object responding to call that must be called at least once before using rack.hijack_io. It is recommended call return rack.hijack_io as well as setting it in env if necessary.

rack.hijack_io

if rack.hijack? is true, and rack.hijack has received call, this will contain an object resembling an IO. See hijacking.

Additional environment specifications have approved to standardized middleware APIs. None of these are required to be implemented by the server.

rack.session

A hash like interface for storing request session data. The store must implement: store(key, value) (aliased as []=); fetch(key, default = nil) (aliased as []); delete(key); clear;

rack.logger

A common object interface for logging messages. The object must implement:

info(message, &block)
debug(message, &block)
warn(message, &block)
error(message, &block)
fatal(message, &block)

The server or the application can store their own data in the environment, too. The keys must contain at least one dot, and should be prefixed uniquely. The prefix rack. is reserved for use with the Rack core distribution and other accepted specifications and must not be used otherwise. The environment must not contain the keys HTTP_CONTENT_TYPE or HTTP_CONTENT_LENGTH (use the versions without HTTP_). The CGI keys (named without a period) must have String values. There are the following restrictions:

The Input Stream

The input stream is an IO-like object which contains the raw HTTP POST data. When applicable, its external encoding must be “ASCII-8BIT” and it must be opened in binary mode, for Ruby 1.9 compatibility. The input stream must respond to gets, each, read and rewind.

The Error Stream

The error stream must respond to puts, write and flush.

Hijacking

Request (before status)

If rack.hijack? is true then rack.hijack must respond to call. rack.hijack must return the io that will also be assigned (or is already present, in rack.hijack_io.

rack.hijack_io must respond to: read, write, read_nonblock, write_nonblock, flush, close, close_read, close_write, closed?

The semantics of these IO methods must be a best effort match to those of a normal ruby IO or Socket object, using standard arguments and raising standard exceptions. Servers are encouraged to simply pass on real IO objects, although it is recognized that this approach is not directly compatible with SPDY and HTTP 2.0.

IO provided in rack.hijack_io should preference the IO::WaitReadable and IO::WaitWritable APIs wherever supported.

There is a deliberate lack of full specification around rack.hijack_io, as semantics will change from server to server. Users are encouraged to utilize this API with a knowledge of their server choice, and servers may extend the functionality of hijack_io to provide additional features to users. The purpose of rack.hijack is for Rack to “get out of the way”, as such, Rack only provides the minimum of specification and support.

If rack.hijack? is false, then rack.hijack should not be set.

If rack.hijack? is false, then rack.hijack_io should not be set.

Response (after headers)

It is also possible to hijack a response after the status and headers have been sent. In order to do this, an application may set the special header rack.hijack to an object that responds to call accepting an argument that conforms to the rack.hijack_io protocol.

After the headers have been sent, and this hijack callback has been called, the application is now responsible for the remaining lifecycle of the IO. The application is also responsible for maintaining HTTP semantics. Of specific note, in almost all cases in the current SPEC, applications will have wanted to specify the header Connection:close in HTTP/1.1, and not Connection:keep-alive, as there is no protocol for returning hijacked sockets to the web server. For that purpose, use the body streaming API instead (progressively yielding strings via each).

Servers must ignore the body part of the response tuple when the rack.hijack response API is in use.

The special response header rack.hijack must only be set if the request env has rack.hijack? true.

Conventions

The Response

The Status

This is an HTTP status. When parsed as integer (to_i), it must be greater than or equal to 100.

The Headers

The header must respond to each, and yield values of key and value. Special headers starting “rack.” are for communicating with the server, and must not be sent back to the client. The header keys must be Strings. The header must not contain a Status key, contain keys with : or newlines in their name, contain keys names that end in - or _, but only contain keys that consist of letters, digits, _ or - and start with a letter. The values of the header must be Strings, consisting of lines (for multiple header values, e.g. multiple Set-Cookie values) seperated by “n”. The lines must not contain characters below 037.

The Content-Type

There must not be a Content-Type, when the Status is 1xx, 204, 205 or 304.

The Content-Length

There must not be a Content-Length header when the Status is 1xx, 204, 205 or 304.

The Body

The Body must respond to each and must only yield String values. The Body itself should not be an instance of String, as this will break in Ruby 1.9. If the Body responds to close, it will be called after iteration. If the body is replaced by a middleware after action, the original body must be closed first, if it repsonds to close. If the Body responds to to_path, it must return a String identifying the location of a file whose contents are identical to that produced by calling each; this may be used by the server as an alternative, possibly more efficient way to transport the response. The Body commonly is an Array of Strings, the application instance itself, or a File-like object.

Thanks

Some parts of this specification are adopted from PEP333: Python Web Server Gateway Interface v1.0 (www.python.org/dev/peps/pep-0333/). I’d like to thank everyone involved in that effort.

[Validate]

Generated with the Darkfish Rdoc Generator 2.