Gecko [ www.vortexaion.com ]

Name	Size	Permission	Date
ap_compat.h	1.08 KB	-rw-rw-rw-	2006-07-12 00:33
ap_config.h	6.65 KB	-rw-rw-rw-	2012-08-15 03:59
ap_config_layout.h	1.21 KB	-rw-rw-rw-	2022-01-02 15:34
ap_expr.h	14.09 KB	-rw-rw-rw-	2020-02-21 02:33
ap_hooks.h	6.01 KB	-rw-rw-rw-	2011-09-23 22:08
ap_listen.h	5.85 KB	-rw-rw-rw-	2016-05-30 23:26
ap_mmn.h	39.26 KB	-rw-rw-rw-	2023-08-29 11:23
ap_mpm.h	10.68 KB	-rw-rw-rw-	2020-04-23 16:32
ap_provider.h	3.55 KB	-rw-rw-rw-	2012-07-03 23:29
ap_regex.h	11.43 KB	-rw-rw-rw-	2022-02-28 13:56
ap_regkey.h	9.18 KB	-rw-rw-rw-	2011-09-23 17:38
ap_release.h	3.15 KB	-rw-rw-rw-	2023-10-16 17:28
ap_slotmem.h	7.26 KB	-rw-rw-rw-	2013-11-17 22:10
ap_socache.h	9.39 KB	-rw-rw-rw-	2012-02-11 00:47
apache_noprobes.h	15.93 KB	-rw-rw-rw-	2012-04-05 00:11
apr.h	18.28 KB	-rw-rw-rw-	2023-03-27 15:53
apr_allocator.h	6.25 KB	-rw-rw-rw-	2018-08-25 17:48
apr_anylock.h	5.06 KB	-rw-rw-rw-	2007-01-15 21:00
apr_atomic.h	6.25 KB	-rw-rw-rw-	2018-09-17 22:20
apr_base64.h	3.86 KB	-rw-rw-rw-	2012-12-23 00:24
apr_buckets.h	64.71 KB	-rw-rw-rw-	2021-09-18 17:25
apr_crypto.h	20.18 KB	-rw-rw-rw-	2017-06-14 00:28
apr_cstr.h	11.42 KB	-rw-rw-rw-	2016-12-03 22:49
apr_date.h	3.57 KB	-rw-rw-rw-	2007-01-15 21:00
apr_dbd.h	23.88 KB	-rw-rw-rw-	2017-04-02 21:57
apr_dbm.h	8.62 KB	-rw-rw-rw-	2008-11-21 08:20
apr_dso.h	2.73 KB	-rw-rw-rw-	2006-08-03 14:55
apr_encode.h	30.98 KB	-rw-rw-rw-	2022-10-18 11:38
apr_env.h	2.12 KB	-rw-rw-rw-	2009-09-26 00:07
apr_errno.h	55.08 KB	-rw-rw-rw-	2016-03-03 18:11
apr_escape.h	17.65 KB	-rw-rw-rw-	2018-08-26 14:24
apr_escape_test_char.h	1.4 KB	-rw-rw-rw-	2023-03-27 15:53
apr_file_info.h	17.59 KB	-rw-rw-rw-	2018-08-26 14:01
apr_file_io.h	43.11 KB	-rw-rw-rw-	2017-03-30 23:53
apr_fnmatch.h	6.23 KB	-rw-rw-rw-	2014-04-15 17:55
apr_general.h	7.36 KB	-rw-rw-rw-	2018-08-26 14:01
apr_getopt.h	6 KB	-rw-rw-rw-	2006-08-03 14:55
apr_global_mutex.h	7.38 KB	-rw-rw-rw-	2017-04-08 01:20
apr_hash.h	10.36 KB	-rw-rw-rw-	2020-11-08 10:13
apr_hooks.h	12.71 KB	-rw-rw-rw-	2013-10-03 17:32
apr_inherit.h	2.14 KB	-rw-rw-rw-	2013-10-03 17:29
apr_ldap.h	5.76 KB	-rw-rw-rw-	2023-01-24 11:36
apr_ldap_init.h	5.81 KB	-rw-rw-rw-	2009-02-19 10:04
apr_ldap_option.h	8.65 KB	-rw-rw-rw-	2009-02-19 10:04
apr_ldap_rebind.h	3.19 KB	-rw-rw-rw-	2009-02-19 10:04
apr_ldap_url.h	3.83 KB	-rw-rw-rw-	2009-02-19 10:04
apr_lib.h	8.47 KB	-rw-rw-rw-	2014-01-16 22:26
apr_md4.h	4.55 KB	-rw-rw-rw-	2007-01-15 21:00
apr_md5.h	6.37 KB	-rw-rw-rw-	2012-07-06 15:41
apr_memcache.h	17.25 KB	-rw-rw-rw-	2010-11-26 16:39
apr_mmap.h	5.18 KB	-rw-rw-rw-	2013-10-03 17:29
apr_network_io.h	36.95 KB	-rw-rw-rw-	2019-05-04 18:44
apr_optional.h	2.8 KB	-rw-rw-rw-	2007-01-15 21:00
apr_optional_hooks.h	3.9 KB	-rw-rw-rw-	2013-10-03 17:32
apr_perms_set.h	1.93 KB	-rw-rw-rw-	2014-04-28 16:08
apr_poll.h	21.04 KB	-rw-rw-rw-	2016-03-25 03:19
apr_pools.h	31.73 KB	-rw-rw-rw-	2022-06-18 00:09
apr_portable.h	20.56 KB	-rw-rw-rw-	2018-08-26 14:01
apr_proc_mutex.h	7.04 KB	-rw-rw-rw-	2017-04-08 01:20
apr_queue.h	4.12 KB	-rw-rw-rw-	2013-10-03 17:32
apr_random.h	5.07 KB	-rw-rw-rw-	2007-07-21 06:16
apr_redis.h	16.07 KB	-rw-rw-rw-	2017-09-27 20:02
apr_reslist.h	7.19 KB	-rw-rw-rw-	2013-10-03 17:32
apr_ring.h	19.28 KB	-rw-rw-rw-	2022-01-06 14:11
apr_rmm.h	4.8 KB	-rw-rw-rw-	2007-01-15 21:00
apr_sdbm.h	6.14 KB	-rw-rw-rw-	2007-10-23 13:59
apr_sha1.h	3.91 KB	-rw-rw-rw-	2007-01-15 21:00
apr_shm.h	9.48 KB	-rw-rw-rw-	2014-04-28 17:15
apr_signal.h	2.8 KB	-rw-rw-rw-	2007-08-05 19:48
apr_siphash.h	6.16 KB	-rw-rw-rw-	2017-06-15 00:00
apr_skiplist.h	14.56 KB	-rw-rw-rw-	2018-08-25 17:48
apr_strings.h	14.92 KB	-rw-rw-rw-	2018-08-26 14:01
apr_strmatch.h	2.69 KB	-rw-rw-rw-	2007-01-15 21:00
apr_support.h	1.65 KB	-rw-rw-rw-	2006-08-03 14:55
apr_tables.h	19.4 KB	-rw-rw-rw-	2020-11-08 09:24
apr_thread_cond.h	5.53 KB	-rw-rw-rw-	2007-06-29 21:20
apr_thread_mutex.h	4.51 KB	-rw-rw-rw-	2017-04-08 01:20
apr_thread_pool.h	11.14 KB	-rw-rw-rw-	2008-05-07 23:45
apr_thread_proc.h	36.11 KB	-rw-rw-rw-	2019-03-08 16:52
apr_thread_rwlock.h	4.78 KB	-rw-rw-rw-	2006-08-03 14:55
apr_time.h	7.62 KB	-rw-rw-rw-	2016-03-05 03:40
apr_uri.h	6.61 KB	-rw-rw-rw-	2009-01-07 22:39
apr_user.h	5.34 KB	-rw-rw-rw-	2013-10-03 17:29
apr_uuid.h	2.13 KB	-rw-rw-rw-	2007-01-15 21:00
apr_version.h	5.44 KB	-rw-rw-rw-	2023-04-13 11:38
apr_want.h	3.01 KB	-rw-rw-rw-	2012-08-15 00:48
apr_xlate.h	6.42 KB	-rw-rw-rw-	2007-01-15 21:00
apr_xml.h	12.54 KB	-rw-rw-rw-	2016-06-14 01:57
apu.h	4.76 KB	-rw-rw-rw-	2023-01-24 11:36
apu_errno.h	5.49 KB	-rw-rw-rw-	2009-01-07 22:35
apu_version.h	4.33 KB	-rw-rw-rw-	2023-02-01 09:56
apu_want.h	1.55 KB	-rw-rw-rw-	2023-01-24 11:36
cache_common.h	2.02 KB	-rw-rw-rw-	2013-05-29 00:30
expat.h	43.55 KB	-rw-rw-rw-	2022-10-25 19:09
heartbeat.h	1.62 KB	-rw-rw-rw-	2014-06-17 16:06
http_config.h	57.78 KB	-rw-rw-rw-	2022-02-23 16:39
http_connection.h	7.15 KB	-rw-rw-rw-	2021-09-26 18:11
http_core.h	37.25 KB	-rw-rw-rw-	2023-08-29 11:23
http_log.h	36.82 KB	-rw-rw-rw-	2016-08-25 16:48
http_main.h	3.25 KB	-rw-rw-rw-	2012-03-26 02:24
http_protocol.h	42.06 KB	-rw-rw-rw-	2022-06-01 16:34
http_request.h	26.34 KB	-rw-rw-rw-	2021-08-10 12:27
http_ssl.h	14.93 KB	-rw-rw-rw-	2022-08-22 00:26
http_vhost.h	4.61 KB	-rw-rw-rw-	2021-05-27 17:08
httpd.h	94.69 KB	-rw-rw-rw-	2022-03-09 16:04
mod_auth.h	4.55 KB	-rw-rw-rw-	2020-02-21 02:33
mod_cache.h	7.27 KB	-rw-rw-rw-	2011-12-03 20:02
mod_cgi.h	2.5 KB	-rw-rw-rw-	2011-09-23 17:38
mod_core.h	3.43 KB	-rw-rw-rw-	2012-09-24 13:49
mod_dav.h	100.22 KB	-rw-rw-rw-	2023-01-09 16:52
mod_dbd.h	4.18 KB	-rw-rw-rw-	2011-09-23 17:38
mod_http2.h	4.69 KB	-rw-rw-rw-	2023-08-29 11:23
mod_include.h	4.01 KB	-rw-rw-rw-	2011-09-23 17:38
mod_log_config.h	2.5 KB	-rw-rw-rw-	2011-09-23 17:38
mod_proxy.h	64.99 KB	-rw-rw-rw-	2023-03-31 18:33
mod_request.h	1.65 KB	-rw-rw-rw-	2011-02-18 20:40
mod_rewrite.h	1.41 KB	-rw-rw-rw-	2014-01-23 16:33
mod_so.h	1.23 KB	-rw-rw-rw-	2011-11-30 12:21
mod_ssl.h	4.99 KB	-rw-rw-rw-	2019-07-30 15:23
mod_ssl_openssl.h	4.79 KB	-rw-rw-rw-	2019-07-30 15:23
mod_status.h	2.45 KB	-rw-rw-rw-	2006-07-12 00:33
mod_watchdog.h	7.55 KB	-rw-rw-rw-	2014-09-05 18:19
mpm_common.h	17.39 KB	-rw-rw-rw-	2021-08-10 12:43
os.h	4.5 KB	-rw-rw-rw-	2021-04-21 05:10
scoreboard.h	9.98 KB	-rw-rw-rw-	2020-02-21 02:33
util_cfgtree.h	3.17 KB	-rw-rw-rw-	2011-09-23 17:38
util_charset.h	2.28 KB	-rw-rw-rw-	2014-11-01 11:19
util_cookies.h	4.99 KB	-rw-rw-rw-	2012-01-09 15:18
util_ebcdic.h	2.78 KB	-rw-rw-rw-	2014-11-01 11:19
util_fcgi.h	10.02 KB	-rw-rw-rw-	2020-02-21 02:33
util_filter.h	26.46 KB	-rw-rw-rw-	2013-04-15 16:37
util_ldap.h	18.33 KB	-rw-rw-rw-	2023-07-07 16:03
util_md5.h	2.19 KB	-rw-rw-rw-	2014-07-17 02:11
util_mutex.h	9.29 KB	-rw-rw-rw-	2011-10-09 22:35
util_script.h	9.8 KB	-rw-rw-rw-	2012-01-09 15:18
util_time.h	4.22 KB	-rw-rw-rw-	2023-07-18 01:16
util_varbuf.h	8.28 KB	-rw-rw-rw-	2014-07-19 21:22
util_xml.h	1.36 KB	-rw-rw-rw-	2014-07-19 21:22
zconf.h	16.83 KB	-rw-rw-rw-	2023-04-18 01:35
zlib.h	96.4 KB	-rw-rw-rw-	2023-08-18 12:45

Rename

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file  util_fcgi.h
 * @brief FastCGI protocol definitions and support routines
 *
 * @defgroup APACHE_CORE_FASTCGI FastCGI Tools
 * @ingroup  APACHE_CORE
 * @{
 */

#ifndef APACHE_UTIL_FCGI_H
#define APACHE_UTIL_FCGI_H

#ifdef __cplusplus
extern "C" {
#endif

#include "httpd.h"

/**
 * @brief 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).
 */
typedef struct {
    /** See values for version, below */
    unsigned char version;
    /** See values for type, below */
    unsigned char type;
    /** request id, in two parts */
    unsigned char requestIdB1;
    unsigned char requestIdB0;
    /** content length, in two parts */
    unsigned char contentLengthB1;
    unsigned char contentLengthB0;
    /** padding length */
    unsigned char paddingLength;
    /** 8-bit reserved field */
    unsigned char reserved;
} ap_fcgi_header;

/*
 * Number of bytes in the header portion of a FastCGI record
 * (i.e., ap_fcgi_header structure).  Future versions of the
 * protocol may increase the size.
 */
#define AP_FCGI_HEADER_LEN  8

/*
 * Maximum number of bytes in the content portion of a FastCGI record.
 */
#define AP_FCGI_MAX_CONTENT_LEN 65535

/**
 * Possible values for the version field of ap_fcgi_header
 */
#define AP_FCGI_VERSION_1 1

/**
 * Possible values for the type field of ap_fcgi_header
 */
#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)

/**
 * Offsets of the various fields of ap_fcgi_header
 */
#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

/**
 * @brief This represents the content data of the FastCGI record when
 * the type is AP_FCGI_BEGIN_REQUEST.
 */
typedef struct {
    /**
     * role, in two parts
     * See values for role, below
     */
    unsigned char roleB1;
    unsigned char roleB0;
    /**
     * flags
     * See values for flags bits, below
     */
    unsigned char flags;
    /** reserved */
    unsigned char reserved[5];
} ap_fcgi_begin_request_body;

/*
 * Values for role component of ap_fcgi_begin_request_body
 */
#define AP_FCGI_RESPONDER  1
#define AP_FCGI_AUTHORIZER 2
#define AP_FCGI_FILTER     3

/*
 * Values for flags bits of ap_fcgi_begin_request_body
 */
#define AP_FCGI_KEEP_CONN  1  /* otherwise the application closes */

/**
 * Offsets of the various fields of ap_fcgi_begin_request_body
 */
#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

/**
 * Pack ap_fcgi_header
 * @param h The header to read from
 * @param a The array to write to, of size AP_FCGI_HEADER_LEN
 */
AP_DECLARE(void) ap_fcgi_header_to_array(ap_fcgi_header *h,
                                         unsigned char a[]);

/**
 * Unpack header of FastCGI record into ap_fcgi_header
 * @param h The header to write to
 * @param a The array to read from, of size AP_FCGI_HEADER_LEN
 */
AP_DECLARE(void) ap_fcgi_header_from_array(ap_fcgi_header *h,
                                           unsigned char a[]);

/**
 * Unpack header of FastCGI record into individual fields
 * @param version The version, on output
 * @param type The type, on output
 * @param request_id The request id, on output
 * @param content_len The content length, on output
 * @param padding_len The amount of padding following the content, on output
 * @param a The array to read from, of size AP_FCGI_HEADER_LEN
 */
AP_DECLARE(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[]);

/**
 * Pack ap_fcgi_begin_request_body
 * @param h The begin-request body to read from
 * @param a The array to write to, of size AP_FCGI_HEADER_LEN
 */
AP_DECLARE(void) ap_fcgi_begin_request_body_to_array(ap_fcgi_begin_request_body *h,
                                                     unsigned char a[]);

/**
 * Fill in a FastCGI request header with the required field values.
 * @param header The header to fill in
 * @param type The type of record
 * @param request_id The request id
 * @param content_len The amount of content which follows the header
 * @param padding_len The amount of padding which follows the content
 *
 * The header array must be at least AP_FCGI_HEADER_LEN bytes long.
 */
AP_DECLARE(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 begin request body with the required field values.
 * @param brb The begin-request-body to fill in
 * @param role AP_FCGI_RESPONDER or other roles
 * @param flags 0 or a combination of flags like AP_FCGI_KEEP_CONN
 */
AP_DECLARE(void) ap_fcgi_fill_in_request_body(ap_fcgi_begin_request_body *brb,
                                              int role,
                                              unsigned char flags);

/**
 * Compute the buffer size needed to encode the next portion of
 * the provided environment table.
 * @param env The environment table
 * @param maxlen The maximum buffer size allowable, capped at 
 * AP_FCGI_MAX_CONTENT_LEN.
 * @param 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.
 * @return 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_DECLARE(apr_size_t) ap_fcgi_encoded_env_len(apr_table_t *env,
                                               apr_size_t maxlen,
                                               int *starting_elem);

/**
 * Encode the next portion of the provided environment table using
 * a buffer previously allocated.
 * @param r The request, for logging
 * @param env The environment table
 * @param buffer A buffer to contain the encoded environment table
 * @param buflen The length of the buffer, previously computed by
 * ap_fcgi_encoded_env_len().
 * @param 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.
 * @return 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_DECLARE(apr_status_t) ap_fcgi_encode_env(request_rec *r,
                                            apr_table_t *env,
                                            void *buffer,
                                            apr_size_t buflen,
                                            int *starting_elem);

/**
 * String forms for the value of the FCGI_ROLE envvar
 */
#define AP_FCGI_RESPONDER_STR   "RESPONDER"
#define AP_FCGI_AUTHORIZER_STR  "AUTHORIZER"
#define AP_FCGI_FILTER_STR      "FILTER"

/**
 * 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.
 */
#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"

#ifdef __cplusplus
}
#endif

#endif  /* !APACHE_UTIL_FCGI_H */
/** @} */