FastCGI Tools

Collaboration diagram for FastCGI Tools:

Data Structures
struct	ap_fcgi_header
	A structure that represents the fixed header fields at the beginning of a "FastCGI record" (i.e., the data prior to content data and padding). More...
struct	ap_fcgi_begin_request_body
	This represents the content data of the FastCGI record when the type is AP_FCGI_BEGIN_REQUEST. More...

Macros
#define	AP_FCGI_HEADER_LEN   8
#define	AP_FCGI_MAX_CONTENT_LEN   65535
#define	AP_FCGI_VERSION_1   1
#define	AP_FCGI_BEGIN_REQUEST   1
#define	AP_FCGI_ABORT_REQUEST   2
#define	AP_FCGI_END_REQUEST   3
#define	AP_FCGI_PARAMS   4
#define	AP_FCGI_STDIN   5
#define	AP_FCGI_STDOUT   6
#define	AP_FCGI_STDERR   7
#define	AP_FCGI_DATA   8
#define	AP_FCGI_GET_VALUES   9
#define	AP_FCGI_GET_VALUES_RESULT   10
#define	AP_FCGI_UNKNOWN_TYPE   11
#define	AP_FCGI_MAXTYPE   (AP_FCGI_UNKNOWN_TYPE)
#define	AP_FCGI_HDR_VERSION_OFFSET   0
#define	AP_FCGI_HDR_TYPE_OFFSET   1
#define	AP_FCGI_HDR_REQUEST_ID_B1_OFFSET   2
#define	AP_FCGI_HDR_REQUEST_ID_B0_OFFSET   3
#define	AP_FCGI_HDR_CONTENT_LEN_B1_OFFSET   4
#define	AP_FCGI_HDR_CONTENT_LEN_B0_OFFSET   5
#define	AP_FCGI_HDR_PADDING_LEN_OFFSET   6
#define	AP_FCGI_HDR_RESERVED_OFFSET   7
#define	AP_FCGI_RESPONDER   1
#define	AP_FCGI_AUTHORIZER   2
#define	AP_FCGI_FILTER   3
#define	AP_FCGI_KEEP_CONN   1 /* otherwise the application closes */
#define	AP_FCGI_BRB_ROLEB1_OFFSET   0
#define	AP_FCGI_BRB_ROLEB0_OFFSET   1
#define	AP_FCGI_BRB_FLAGS_OFFSET   2
#define	AP_FCGI_BRB_RESERVED0_OFFSET   3
#define	AP_FCGI_BRB_RESERVED1_OFFSET   4
#define	AP_FCGI_BRB_RESERVED2_OFFSET   5
#define	AP_FCGI_BRB_RESERVED3_OFFSET   6
#define	AP_FCGI_BRB_RESERVED4_OFFSET   7
#define	AP_FCGI_RESPONDER_STR   "RESPONDER"
#define	AP_FCGI_AUTHORIZER_STR   "AUTHORIZER"
#define	AP_FCGI_FILTER_STR   "FILTER"
#define	AP_FCGI_APACHE_ROLE_AUTHENTICATOR_STR   "AUTHENTICATOR"
#define	AP_FCGI_APACHE_ROLE_AUTHORIZER_STR   "AUTHORIZER"
#define	AP_FCGI_APACHE_ROLE_ACCESS_CHECKER_STR   "ACCESS_CHECKER"

Functions
void	ap_fcgi_header_to_array (ap_fcgi_header *h, unsigned char a[])
void	ap_fcgi_header_from_array (ap_fcgi_header *h, unsigned char a[])
void	ap_fcgi_header_fields_from_array (unsigned char *version, unsigned char *type, apr_uint16_t *request_id, apr_uint16_t *content_len, unsigned char *padding_len, unsigned char a[])
void	ap_fcgi_begin_request_body_to_array (ap_fcgi_begin_request_body *h, unsigned char a[])
void	ap_fcgi_fill_in_header (ap_fcgi_header *header, unsigned char type, apr_uint16_t request_id, apr_uint16_t content_len, unsigned char padding_len)
void	ap_fcgi_fill_in_request_body (ap_fcgi_begin_request_body *brb, int role, unsigned char flags)
apr_size_t	ap_fcgi_encoded_env_len (apr_table_t *env, apr_size_t maxlen, int *starting_elem)
apr_status_t	ap_fcgi_encode_env (request_rec *r, apr_table_t *env, void *buffer, apr_size_t buflen, int *starting_elem)

Detailed Description

Macro Definition Documentation

AP_FCGI_ABORT_REQUEST

#define AP_FCGI_ABORT_REQUEST   2

AP_FCGI_APACHE_ROLE_ACCESS_CHECKER_STR

#define AP_FCGI_APACHE_ROLE_ACCESS_CHECKER_STR   "ACCESS_CHECKER"

AP_FCGI_APACHE_ROLE_AUTHENTICATOR_STR

#define AP_FCGI_APACHE_ROLE_AUTHENTICATOR_STR   "AUTHENTICATOR"

FastCGI implementations that implement the AUTHORIZER role for Apache httpd and allow the application to participate in any of the Apache httpd AAA phases typically set the variable FCGI_APACHE_ROLE to one of these strings to indicate the specific AAA phase.

AP_FCGI_APACHE_ROLE_AUTHORIZER_STR

#define AP_FCGI_APACHE_ROLE_AUTHORIZER_STR   "AUTHORIZER"

AP_FCGI_AUTHORIZER

#define AP_FCGI_AUTHORIZER   2

AP_FCGI_AUTHORIZER_STR

#define AP_FCGI_AUTHORIZER_STR   "AUTHORIZER"

AP_FCGI_BEGIN_REQUEST

#define AP_FCGI_BEGIN_REQUEST   1

Possible values for the type field of ap_fcgi_header

AP_FCGI_BRB_FLAGS_OFFSET

#define AP_FCGI_BRB_FLAGS_OFFSET   2

AP_FCGI_BRB_RESERVED0_OFFSET

#define AP_FCGI_BRB_RESERVED0_OFFSET   3

AP_FCGI_BRB_RESERVED1_OFFSET

#define AP_FCGI_BRB_RESERVED1_OFFSET   4

AP_FCGI_BRB_RESERVED2_OFFSET

#define AP_FCGI_BRB_RESERVED2_OFFSET   5

AP_FCGI_BRB_RESERVED3_OFFSET

#define AP_FCGI_BRB_RESERVED3_OFFSET   6

AP_FCGI_BRB_RESERVED4_OFFSET

#define AP_FCGI_BRB_RESERVED4_OFFSET   7

AP_FCGI_BRB_ROLEB0_OFFSET

#define AP_FCGI_BRB_ROLEB0_OFFSET   1

AP_FCGI_BRB_ROLEB1_OFFSET

#define AP_FCGI_BRB_ROLEB1_OFFSET   0

Offsets of the various fields of ap_fcgi_begin_request_body

AP_FCGI_DATA

#define AP_FCGI_DATA   8

AP_FCGI_END_REQUEST

#define AP_FCGI_END_REQUEST   3

AP_FCGI_FILTER

#define AP_FCGI_FILTER   3

AP_FCGI_FILTER_STR

#define AP_FCGI_FILTER_STR   "FILTER"

AP_FCGI_GET_VALUES

#define AP_FCGI_GET_VALUES   9

AP_FCGI_GET_VALUES_RESULT

#define AP_FCGI_GET_VALUES_RESULT   10

AP_FCGI_HDR_CONTENT_LEN_B0_OFFSET

#define AP_FCGI_HDR_CONTENT_LEN_B0_OFFSET   5

AP_FCGI_HDR_CONTENT_LEN_B1_OFFSET

#define AP_FCGI_HDR_CONTENT_LEN_B1_OFFSET   4

AP_FCGI_HDR_PADDING_LEN_OFFSET

#define AP_FCGI_HDR_PADDING_LEN_OFFSET   6

AP_FCGI_HDR_REQUEST_ID_B0_OFFSET

#define AP_FCGI_HDR_REQUEST_ID_B0_OFFSET   3

AP_FCGI_HDR_REQUEST_ID_B1_OFFSET

#define AP_FCGI_HDR_REQUEST_ID_B1_OFFSET   2

AP_FCGI_HDR_RESERVED_OFFSET

#define AP_FCGI_HDR_RESERVED_OFFSET   7

AP_FCGI_HDR_TYPE_OFFSET

#define AP_FCGI_HDR_TYPE_OFFSET   1

AP_FCGI_HDR_VERSION_OFFSET

#define AP_FCGI_HDR_VERSION_OFFSET   0

Offsets of the various fields of ap_fcgi_header

AP_FCGI_HEADER_LEN

#define AP_FCGI_HEADER_LEN   8

AP_FCGI_KEEP_CONN

#define AP_FCGI_KEEP_CONN   1 /* otherwise the application closes */

AP_FCGI_MAX_CONTENT_LEN

#define AP_FCGI_MAX_CONTENT_LEN   65535

AP_FCGI_MAXTYPE

#define AP_FCGI_MAXTYPE   (AP_FCGI_UNKNOWN_TYPE)

AP_FCGI_PARAMS

#define AP_FCGI_PARAMS   4

AP_FCGI_RESPONDER

#define AP_FCGI_RESPONDER   1

AP_FCGI_RESPONDER_STR

#define AP_FCGI_RESPONDER_STR   "RESPONDER"

String forms for the value of the FCGI_ROLE envvar

AP_FCGI_STDERR

#define AP_FCGI_STDERR   7

AP_FCGI_STDIN

#define AP_FCGI_STDIN   5

AP_FCGI_STDOUT

#define AP_FCGI_STDOUT   6

AP_FCGI_UNKNOWN_TYPE

#define AP_FCGI_UNKNOWN_TYPE   11

AP_FCGI_VERSION_1

#define AP_FCGI_VERSION_1   1

Possible values for the version field of ap_fcgi_header

Function Documentation

ap_fcgi_begin_request_body_to_array()

void ap_fcgi_begin_request_body_to_array	(	ap_fcgi_begin_request_body *	h,
		unsigned char	a[]
	)

Pack ap_fcgi_begin_request_body

Parameters

h	The begin-request body to read from
a	The array to write to, of size AP_FCGI_HEADER_LEN

ap_fcgi_encode_env()

apr_status_t ap_fcgi_encode_env	(	request_rec *	r,
		apr_table_t *	env,
		void *	buffer,
		apr_size_t	buflen,
		int *	starting_elem
	)

Encode the next portion of the provided environment table using a buffer previously allocated.

Parameters

r	The request, for logging
env	The environment table
buffer	A buffer to contain the encoded environment table
buflen	The length of the buffer, previously computed by ap_fcgi_encoded_env_len().
starting_elem	On input, the next element of the table array to process in this FastCGI record. On output, the next element to process on the next FastCGI record.

Returns

APR_SUCCESS if a section could be encoded or APR_ENOSPC otherwise.

Note

The output starting_elem from ap_fcgi_encoded_env_len shouldn't be used as input to ap_fcgi_encode_env when building the same FastCGI record.

ap_fcgi_encoded_env_len()

apr_size_t ap_fcgi_encoded_env_len	(	apr_table_t *	env,
		apr_size_t	maxlen,
		int *	starting_elem
	)

Compute the buffer size needed to encode the next portion of the provided environment table.

Parameters

env	The environment table
maxlen	The maximum buffer size allowable, capped at AP_FCGI_MAX_CONTENT_LEN.
starting_elem	On input, the next element of the table array to process in this FastCGI record. On output, the next element to process on the next FastCGI record.

Returns

Size of buffer needed to encode the next part, or 0 if no more can be encoded. When 0 is returned: If starting_elem has reached the end of the table array, all has been encoded; otherwise, the next envvar can't be encoded within the specified limit.

Note

If an envvar can't be encoded within the specified limit, the caller can log a warning and increment starting_elem and try again or increase the limit or fail, as appropriate for the module.

ap_fcgi_fill_in_header()

void ap_fcgi_fill_in_header	(	ap_fcgi_header *	header,
		unsigned char	type,
		apr_uint16_t	request_id,
		apr_uint16_t	content_len,
		unsigned char	padding_len
	)

Fill in a FastCGI request header with the required field values.

Parameters

header	The header to fill in
type	The type of record
request_id	The request id
content_len	The amount of content which follows the header
padding_len	The amount of padding which follows the content

The header array must be at least AP_FCGI_HEADER_LEN bytes long.

ap_fcgi_fill_in_request_body()

void ap_fcgi_fill_in_request_body	(	ap_fcgi_begin_request_body *	brb,
		int	role,
		unsigned char	flags
	)

Fill in a FastCGI begin request body with the required field values.

Parameters

brb	The begin-request-body to fill in
role	AP_FCGI_RESPONDER or other roles
flags	0 or a combination of flags like AP_FCGI_KEEP_CONN

ap_fcgi_header_fields_from_array()

void ap_fcgi_header_fields_from_array	(	unsigned char *	version,
		unsigned char *	type,
		apr_uint16_t *	request_id,
		apr_uint16_t *	content_len,
		unsigned char *	padding_len,
		unsigned char	a[]
	)

Unpack header of FastCGI record into individual fields

Parameters

version	The version, on output
type	The type, on output
request_id	The request id, on output
content_len	The content length, on output
padding_len	The amount of padding following the content, on output
a	The array to read from, of size AP_FCGI_HEADER_LEN

ap_fcgi_header_from_array()

void ap_fcgi_header_from_array	(	ap_fcgi_header *	h,
		unsigned char	a[]
	)

Unpack header of FastCGI record into ap_fcgi_header

Parameters

h	The header to write to
a	The array to read from, of size AP_FCGI_HEADER_LEN

ap_fcgi_header_to_array()

void ap_fcgi_header_to_array	(	ap_fcgi_header *	h,
		unsigned char	a[]
	)

Pack ap_fcgi_header

Parameters

h	The header to read from
a	The array to write to, of size AP_FCGI_HEADER_LEN