Samiksha Jaiswal (Editor)

Simple Common Gateway Interface

Updated on
Edit
Like
Comment
Share on FacebookTweet on TwitterShare on LinkedInShare on Reddit

The Simple Common Gateway Interface (SCGI) is a protocol for applications to interface with HTTP servers, as an alternative to the CGI protocol. It is similar to FastCGI but is designed to be easier to implement and crucially, permits CGI operations where the CGI operation has significant latency (e.g. contacting an external database).

Contents

Specification

The client connects to a SCGI server over a reliable stream protocol allowing transmission of 8-bit bytes. The client begins by sending a request. When the SCGI server sees the end of the request it sends back a response and closes the connection. The format of the response is not specified by this protocol.

Request format

A request consists of a number of headers and a body. The format of the headers is:

headers ::= header* header ::= name NUL value NUL name ::= notnull+ value ::= notnull* notnull ::= <01> | <02> | <03> | … | <ff> NUL = <00>

Duplicate names are not allowed in the headers. The first header must have the name "CONTENT_LENGTH" and a value that is the length of the body in decimal. The "CONTENT_LENGTH" header must always be present, even if its value is "0". There must also always be a header with the name "SCGI" and a value of "1". In order to facilitate the transition from CGI, standard CGI environment variables should be provided as SCGI headers.

The headers are sent to the server application encoded as a netstring. The body is sent following the headers and its length is specified by the "CONTENT_LENGTH" header.

Example

The web server (an SCGI client) opens a connection and sends the concatenation of the following strings:

"70:" "CONTENT_LENGTH" <00> "56" <00> "SCGI" <00> "1" <00> "REQUEST_METHOD" <00> "POST" <00> "REQUEST_URI" <00> "/deepthought" <00> "," "What is the answer to life, the Universe and everything?"

The web application (SCGI server) sends the following response:

"Status: 200 OK" <0d 0a> "Content-Type: text/plain" <0d 0a> "" <0d 0a> "42"

The SCGI server then closes the connection.

Web servers that implement SCGI

  • Apache HTTP Server
  • Cherokee
  • Lighttpd
  • Mathopd - with unofficial patch
  • Microsoft Internet Information Services with ISAPI SCGI extension
  • nginx
  • Avuna HTTPD
  • Language bindings for the SCGI API

  • Cobra
  • Haskell
  • Java, with SCGI connector
  • Lisp
  • Perl, with the SCGI Package
  • PHP
  • Python
  • Racket, with the scgi: Web Server HTTP SCGI and CGI
  • Ruby
  • Scheme
  • Tcl
  • Nim
  • References

    Simple Common Gateway Interface Wikipedia