fastcgi

Documentation

Overview

Package fastcgi has middleware that acts as a FastCGI client. Requests that get forwarded to FastCGI stop the middleware execution chain. The most common use for this package is to serve PHP websites via php-fpm.

Index

• Constants
• Variables
• type Client
• type FCGIClient
  • func DialTimeout(network string, address string, timeout time.Duration) (fcgi *FCGIClient, err error)
  • func (c *FCGIClient) Close() error
  • func (c *FCGIClient) Do(p map[string]string, req io.Reader) (r io.Reader, err error)
  • func (c *FCGIClient) Get(p map[string]string) (resp *http.Response, err error)
  • func (c *FCGIClient) Head(p map[string]string) (resp *http.Response, err error)
  • func (c *FCGIClient) Options(p map[string]string) (resp *http.Response, err error)
  • func (c *FCGIClient) Post(p map[string]string, method string, bodyType string, body io.Reader, l int) (resp *http.Response, err error)
  • func (c *FCGIClient) PostFile(p map[string]string, data url.Values, file map[string]string) (resp *http.Response, err error)
  • func (c *FCGIClient) PostForm(p map[string]string, data url.Values) (resp *http.Response, err error)
  • func (c *FCGIClient) Request(p map[string]string, req io.Reader) (resp *http.Response, err error)
  • func (c *FCGIClient) SetReadTimeout(t time.Duration) error
  • func (c *FCGIClient) SetSendTimeout(t time.Duration) error
  • func (c *FCGIClient) StdErr() bytes.Buffer
• type Handler
  • func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)
• type LogError
  • func (l LogError) Error() string
• type Rule
  • func (r Rule) AllowedPath(requestPath string) bool

Constants

const (
	// BeginRequest is the begin request flag.
	BeginRequest uint8 = iota + 1
	// AbortRequest is the abort request flag.
	AbortRequest
	// EndRequest is the end request flag.
	EndRequest
	// Params is the parameters flag.
	Params
	// Stdin is the standard input flag.
	Stdin
	// Stdout is the standard output flag.
	Stdout
	// Stderr is the standard error flag.
	Stderr
	// Data is the data flag.
	Data
	// GetValues is the get values flag.
	GetValues
	// GetValuesResult is the get values result flag.
	GetValuesResult
	// UnknownType is the unknown type flag.
	UnknownType
	// MaxType is the maximum type flag.
	MaxType = UnknownType
)

const (
	// Responder is the responder flag.
	Responder uint8 = iota + 1
	// Authorizer is the authorizer flag.
	Authorizer
	// Filter is the filter flag.
	Filter
)

const (
	// RequestComplete is the completed request flag.
	RequestComplete uint8 = iota
	// CantMultiplexConns is the multiplexed connections flag.
	CantMultiplexConns
	// Overloaded is the overloaded flag.
	Overloaded
	// UnknownRole is the unknown role flag.
	UnknownRole
)

const (
	// MaxConns is the maximum connections flag.
	MaxConns string = "MAX_CONNS"
	// MaxRequests is the maximum requests flag.
	MaxRequests string = "MAX_REQS"
	// MultiplexConns is the multiplex connections flag.
	MultiplexConns string = "MPXS_CONNS"
)

const FCGIHeaderLen uint8 = 8

FCGIHeaderLen describes header length.

const FCGIKeepConn uint8 = 1

FCGIKeepConn describes keep connection mode.

const FCGIListenSockFileno uint8 = 0

FCGIListenSockFileno describes listen socket file number.

const FCGINullRequestID uint8 = 0

FCGINullRequestID describes the null request ID.

const Version1 uint8 = 1

Version1 describes the version.

Variables

var (

	// ErrIndexMissingSplit describes an index configuration error.
	ErrIndexMissingSplit = errors.New("configured index file(s) must include split value")
)

Types

type Client

type Client interface {
	Get(pair map[string]string) (response *http.Response, err error)
	Head(pair map[string]string) (response *http.Response, err error)
	Options(pairs map[string]string) (response *http.Response, err error)
	Post(pairs map[string]string, method string, bodyType string, body io.Reader, contentLength int) (response *http.Response, err error)
	Close() error
	StdErr() bytes.Buffer
	SetReadTimeout(time.Duration) error
	SetSendTimeout(time.Duration) error
}

Client interface

type FCGIClient

type FCGIClient struct {
	// contains filtered or unexported fields
}

FCGIClient implements a FastCGI client, which is a standard for interfacing external applications with Web servers.

func DialTimeout

func DialTimeout(network string, address string, timeout time.Duration) (fcgi *FCGIClient, err error)

DialTimeout connects to the fcgi responder at the specified network address, using default net.Dialer. See func net.Dial for a description of the network and address parameters.

func (*FCGIClient) Close

func (c *FCGIClient) Close() error

Close closes fcgi connnection.

func (*FCGIClient) Do

func (c *FCGIClient) Do(p map[string]string, req io.Reader) (r io.Reader, err error)

Do made the request and returns a io.Reader that translates the data read from fcgi responder out of fcgi packet before returning it.

func (*FCGIClient) Get

func (c *FCGIClient) Get(p map[string]string) (resp *http.Response, err error)

Get issues a GET request to the fcgi responder.

func (*FCGIClient) Head

func (c *FCGIClient) Head(p map[string]string) (resp *http.Response, err error)

Head issues a HEAD request to the fcgi responder.

func (*FCGIClient) Options

func (c *FCGIClient) Options(p map[string]string) (resp *http.Response, err error)

Options issues an OPTIONS request to the fcgi responder.

func (*FCGIClient) Post

func (c *FCGIClient) Post(p map[string]string, method string, bodyType string, body io.Reader, l int) (resp *http.Response, err error)

Post issues a POST request to the fcgi responder. with request body in the format that bodyType specified

func (*FCGIClient) PostFile

func (c *FCGIClient) PostFile(p map[string]string, data url.Values, file map[string]string) (resp *http.Response, err error)

PostFile issues a POST to the fcgi responder in multipart(RFC 2046) standard, with form as a string key to a list values (url.Values), and/or with file as a string key to a list file path.

func (*FCGIClient) PostForm

func (c *FCGIClient) PostForm(p map[string]string, data url.Values) (resp *http.Response, err error)

PostForm issues a POST to the fcgi responder, with form as a string key to a list values (url.Values)

func (*FCGIClient) Request

func (c *FCGIClient) Request(p map[string]string, req io.Reader) (resp *http.Response, err error)

Request returns a HTTP Response with Header and Body from fcgi responder

func (*FCGIClient) SetReadTimeout

func (c *FCGIClient) SetReadTimeout(t time.Duration) error

SetReadTimeout sets the read timeout for future calls that read from the fcgi responder. A zero value for t means no timeout will be set.

func (*FCGIClient) SetSendTimeout

func (c *FCGIClient) SetSendTimeout(t time.Duration) error

SetSendTimeout sets the read timeout for future calls that send data to the fcgi responder. A zero value for t means no timeout will be set.

func (*FCGIClient) StdErr

func (c *FCGIClient) StdErr() bytes.Buffer

StdErr returns stderr stream

type Handler

type Handler struct {
	Next    httpserver.Handler
	Rules   []Rule
	Root    string
	FileSys http.FileSystem

	// These are sent to CGI scripts in env variables
	SoftwareName    string
	SoftwareVersion string
	ServerName      string
	ServerPort      string
}

Handler is a middleware type that can handle requests as a FastCGI client.

func (Handler) ServeHTTP

func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

ServeHTTP satisfies the httpserver.Handler interface.

type LogError

type LogError string

LogError is a non fatal error that allows requests to go through.

func (LogError) Error

func (l LogError) Error() string

Error satisfies error interface.

type Rule

type Rule struct {
	// The base path to match. Required.
	Path string

	// The address of the FastCGI server. Required.
	Address string

	// Always process files with this extension with fastcgi.
	Ext string

	// Use this directory as the fastcgi root directory. Defaults to the root
	// directory of the parent virtual host.
	Root string

	// The path in the URL will be split into two, with the first piece ending
	// with the value of SplitPath. The first piece will be assumed as the
	// actual resource (CGI script) name, and the second piece will be set to
	// PATH_INFO for the CGI script to use.
	SplitPath string

	// If the URL ends with '/' (which indicates a directory), these index
	// files will be tried instead.
	IndexFiles []string

	// Environment Variables
	EnvVars [][2]string

	// Ignored paths
	IgnoredSubPaths []string

	// The duration used to set a deadline when reading from the FastCGI server.
	ReadTimeout time.Duration

	// The duration used to set a deadline when sending to the FastCGI server.
	SendTimeout time.Duration
	// contains filtered or unexported fields
}

Rule represents a FastCGI handling rule. It is parsed from the fastcgi directive in the Caddyfile, see setup.go.

func (Rule) AllowedPath

func (r Rule) AllowedPath(requestPath string) bool

AllowedPath checks if requestPath is not an ignored path.