htp_config.h

Go to the documentation of this file.

/***************************************************************************
 * Copyright (c) 2009-2010 Open Information Security Foundation
 * Copyright (c) 2010-2013 Qualys, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 
 * - Neither the name of the Qualys, Inc. nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ***************************************************************************/

 
#ifndef HTP_CONFIG_H
#define HTP_CONFIG_H
 
#ifdef  __cplusplus
extern "C" {
#endif
 
#include "htp.h"

enum htp_decoder_ctx_t {
    HTP_DECODER_DEFAULTS = 0,

    HTP_DECODER_URLENCODED = 1,

    HTP_DECODER_URL_PATH = 2    
};

enum htp_server_personality_t {
    HTP_SERVER_MINIMAL = 0,

    HTP_SERVER_GENERIC = 1,

    HTP_SERVER_IDS = 2,

    HTP_SERVER_IIS_4_0 = 3,

    HTP_SERVER_IIS_5_0 = 4,

    HTP_SERVER_IIS_5_1 = 5,

    HTP_SERVER_IIS_6_0 = 6,

    HTP_SERVER_IIS_7_0 = 7,
 
    /* Mimics the behavior of IIS 7.5, as shipped with Windows 7. */
    HTP_SERVER_IIS_7_5 = 8,
 
    /* Mimics the behavior of Apache 2.x. */
    HTP_SERVER_APACHE_2 = 9
};

enum htp_unwanted_t {

    HTP_UNWANTED_IGNORE = 0,

    HTP_UNWANTED_400 = 400,

    HTP_UNWANTED_404 = 404
};

enum htp_url_encoding_handling_t {
    HTP_URL_DECODE_PRESERVE_PERCENT = 0,

    HTP_URL_DECODE_REMOVE_PERCENT = 1,

    HTP_URL_DECODE_PROCESS_INVALID = 2
};

htp_cfg_t *htp_config_create(void);

htp_cfg_t *htp_config_copy(htp_cfg_t *cfg);

void htp_config_destroy(htp_cfg_t *cfg);

void *htp_config_get_user_data(htp_cfg_t *cfg);

void htp_config_register_log(htp_cfg_t *cfg, int (*callback_fn)(htp_log_t *));

void htp_config_register_multipart_parser(htp_cfg_t *cfg);

void htp_config_register_request_start(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_request_body_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *));

void htp_config_register_request_complete(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_request_file_data(htp_cfg_t *cfg, int (*callback_fn)(htp_file_data_t *));

void htp_config_register_request_header_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *));

void htp_config_register_request_headers(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_request_line(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_request_uri_normalize(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_request_trailer(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_request_trailer_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *d));

void htp_config_register_response_body_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *));

void htp_config_register_response_complete(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_response_header_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *));

void htp_config_register_response_headers(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_response_line(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_response_start(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_response_trailer(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_response_trailer_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *d));

void htp_config_register_transaction_complete(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));

void htp_config_register_urlencoded_parser(htp_cfg_t *cfg);

void htp_config_set_backslash_convert_slashes(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);

void htp_config_set_bestfit_map(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, void *map);

void htp_config_set_bestfit_replacement_byte(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int replacement_byte);

void htp_config_set_control_chars_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted);

void htp_config_set_convert_lowercase(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);

htp_status_t htp_config_set_extract_request_files(htp_cfg_t *cfg, int extract_files, int limit);

void htp_config_set_field_limits(htp_cfg_t *cfg, size_t soft_limit, size_t hard_limit);

void htp_config_set_lzma_memlimit(htp_cfg_t *cfg, size_t memlimit);

void htp_config_set_lzma_layers(htp_cfg_t *cfg, int limit);

void htp_config_set_compression_bomb_limit(htp_cfg_t *cfg, size_t bomblimit);

void htp_config_set_compression_time_limit(htp_cfg_t *cfg, size_t useclimit);

void htp_config_set_max_tx(htp_cfg_t *cfg, uint32_t limit);

void htp_config_set_number_headers_limit(htp_cfg_t *cfg, uint32_t limit);

void htp_config_set_log_level(htp_cfg_t *cfg, enum htp_log_level_t log_level);

void htp_config_set_nul_encoded_terminates(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);

void htp_config_set_nul_encoded_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted);

void htp_config_set_nul_raw_terminates(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);

void htp_config_set_nul_raw_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted);

void htp_config_set_parse_request_auth(htp_cfg_t *cfg, int parse_request_auth);

void htp_config_set_parse_request_cookies(htp_cfg_t *cfg, int parse_request_cookies);

void htp_config_set_allow_space_uri(htp_cfg_t *cfg, int allow_space_uri);

void htp_config_set_path_separators_compress(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);

void htp_config_set_path_separators_decode(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);

void htp_config_set_path_separators_encoded_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted);

void htp_config_set_plusspace_decode(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);

void htp_config_set_response_decompression(htp_cfg_t *cfg, int enabled);

void htp_config_set_request_decompression(htp_cfg_t *cfg, int enabled);

htp_status_t htp_config_set_server_personality(htp_cfg_t *cfg, enum htp_server_personality_t personality);

void htp_config_set_tmpdir(htp_cfg_t *cfg, char *tmpdir);

void htp_config_set_tx_auto_destroy(htp_cfg_t *cfg, int tx_auto_destroy);

void htp_config_set_user_data(htp_cfg_t *cfg, void *user_data);

void htp_config_set_u_encoding_decode(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);

void htp_config_set_u_encoding_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted);

void htp_config_set_url_encoding_invalid_handling(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_url_encoding_handling_t handling);

void htp_config_set_url_encoding_invalid_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted);

void htp_config_set_utf8_convert_bestfit(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);

void htp_config_set_utf8_invalid_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted);

void htp_config_set_requestline_leading_whitespace_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted);

void htp_config_set_response_decompression_layer_limit(htp_cfg_t *cfg, int limit);
 
#ifdef  __cplusplus
}
#endif
 
#endif  /* HTP_CONFIG_H */