HTP  0.5
htp_config.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (c) 2009-2010 Open Information Security Foundation
3  * Copyright (c) 2010-2013 Qualys, Inc.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * - Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12 
13  * - Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16 
17  * - Neither the name of the Qualys, Inc. nor the names of its
18  * contributors may be used to endorse or promote products derived from
19  * this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  ***************************************************************************/
33 
39 #ifndef HTP_CONFIG_H
40 #define HTP_CONFIG_H
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 #include "htp.h"
47 
54 
57 
60 };
61 
71 
74 
77 
80 
83 
86 
89 
92 
93  /* Mimics the behavior of IIS 7.5, as shipped with Windows 7. */
95 
96  /* Mimics the behavior of Apache 2.x. */
98 };
99 
104 
107 
110 
113 };
114 
121 
124 
127 };
128 
137 
150 
156 void htp_config_destroy(htp_cfg_t *cfg);
157 
165 
173 void htp_config_register_log(htp_cfg_t *cfg, int (*callback_fn)(htp_log_t *));
174 
182 
190 void htp_config_register_request_start(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
191 
198 void htp_config_register_request_body_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *));
199 
206 void htp_config_register_request_complete(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
207 
214 void htp_config_register_request_file_data(htp_cfg_t *cfg, int (*callback_fn)(htp_file_data_t *));
215 
222 void htp_config_register_request_header_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *));
223 
230 void htp_config_register_request_headers(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
231 
238 void htp_config_register_request_line(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
239 
246 void htp_config_register_request_uri_normalize(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
247 
254 void htp_config_register_request_trailer(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
255 
262 void htp_config_register_request_trailer_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *d));
263 
270 void htp_config_register_response_body_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *));
271 
278 void htp_config_register_response_complete(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
279 
286 void htp_config_register_response_header_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *));
287 
294 void htp_config_register_response_headers(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
295 
302 void htp_config_register_response_line(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
303 
310 void htp_config_register_response_start(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
311 
318 void htp_config_register_response_trailer(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
319 
326 void htp_config_register_response_trailer_data(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_data_t *d));
327 
334 void htp_config_register_transaction_complete(htp_cfg_t *cfg, int (*callback_fn)(htp_tx_t *));
335 
343 
354 
367 void htp_config_set_bestfit_map(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, void *map);
368 
378 void htp_config_set_bestfit_replacement_byte(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int replacement_byte);
379 
388 
398 void htp_config_set_convert_lowercase(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);
399 
416 htp_status_t htp_config_set_extract_request_files(htp_cfg_t *cfg, int extract_files, int limit);
417 
427 void htp_config_set_field_limits(htp_cfg_t *cfg, size_t soft_limit, size_t hard_limit);
428 
435 void htp_config_set_lzma_memlimit(htp_cfg_t *cfg, size_t memlimit);
436 
443 void htp_config_set_compression_bomb_limit(htp_cfg_t *cfg, size_t bomblimit);
444 
451 void htp_config_set_log_level(htp_cfg_t *cfg, enum htp_log_level_t log_level);
452 
462 void htp_config_set_nul_encoded_terminates(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);
463 
472 
480 void htp_config_set_nul_raw_terminates(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);
481 
492 
499 void htp_config_set_parse_request_auth(htp_cfg_t *cfg, int parse_request_auth);
500 
507 void htp_config_set_parse_request_cookies(htp_cfg_t *cfg, int parse_request_cookies);
508 
521 
533 void htp_config_set_path_separators_decode(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);
534 
543 
553 void htp_config_set_plusspace_decode(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);
554 
561 void htp_config_set_response_decompression(htp_cfg_t *cfg, int enabled);
562 
571 
579 void htp_config_set_tmpdir(htp_cfg_t *cfg, char *tmpdir);
580 
589 void htp_config_set_tx_auto_destroy(htp_cfg_t *cfg, int tx_auto_destroy);
590 
597 void htp_config_set_user_data(htp_cfg_t *cfg, void *user_data);
598 
607 void htp_config_set_u_encoding_decode(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);
608 
617 
626 
635 
644 void htp_config_set_utf8_convert_bestfit(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled);
645 
656 
665 
673 
674 #ifdef __cplusplus
675 }
676 #endif
677 
678 #endif /* HTP_CONFIG_H */
679 
htp_file_data_t
Definition: htp.h:131
htp_config_register_log
void htp_config_register_log(htp_cfg_t *cfg, int(*callback_fn)(htp_log_t *))
Definition: htp_config.c:387
HTP_UNWANTED_400
@ HTP_UNWANTED_400
Definition: htp_config.h:109
HTP_UNWANTED_404
@ HTP_UNWANTED_404
Definition: htp_config.h:112
htp_tx_t
Definition: htp.h:208
htp_config_set_path_separators_compress
void htp_config_set_path_separators_compress(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled)
Definition: htp_config.c:779
htp_config_set_convert_lowercase
void htp_config_set_convert_lowercase(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled)
Definition: htp_config.c:803
HTP_URL_DECODE_PRESERVE_PERCENT
@ HTP_URL_DECODE_PRESERVE_PERCENT
Definition: htp_config.h:120
htp_log_level_t
htp_log_level_t
Definition: htp_core.h:246
htp_config_set_utf8_invalid_unwanted
void htp_config_set_utf8_invalid_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted)
Definition: htp_config.c:899
htp_config_set_field_limits
void htp_config_set_field_limits(htp_cfg_t *cfg, size_t soft_limit, size_t hard_limit)
Definition: htp_config.c:506
htp_config_set_lzma_memlimit
void htp_config_set_lzma_memlimit(htp_cfg_t *cfg, size_t memlimit)
Definition: htp_config.c:512
HTP_DECODER_URL_PATH
@ HTP_DECODER_URL_PATH
Definition: htp_config.h:59
HTP_URL_DECODE_PROCESS_INVALID
@ HTP_URL_DECODE_PROCESS_INVALID
Definition: htp_config.h:126
htp_config_set_user_data
void htp_config_set_user_data(htp_cfg_t *cfg, void *user_data)
Definition: htp_config.c:672
htp_config_register_response_line
void htp_config_register_response_line(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:467
htp_config_register_request_complete
void htp_config_register_request_complete(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:397
htp_url_encoding_handling_t
htp_url_encoding_handling_t
Definition: htp_config.h:118
htp_config_register_multipart_parser
void htp_config_register_multipart_parser(htp_cfg_t *cfg)
Definition: htp_config.c:392
htp_config_register_response_start
void htp_config_register_response_start(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:472
htp_config_register_response_headers
void htp_config_register_response_headers(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:462
HTP_SERVER_IDS
@ HTP_SERVER_IDS
Definition: htp_config.h:76
htp_config_set_url_encoding_invalid_handling
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)
Definition: htp_config.c:707
htp_config_register_response_trailer
void htp_config_register_response_trailer(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:477
htp_config_get_user_data
void * htp_config_get_user_data(htp_cfg_t *cfg)
Definition: htp_config.c:382
htp_server_personality_t
htp_server_personality_t
Definition: htp_config.h:65
htp_config_set_response_decompression
void htp_config_set_response_decompression(htp_cfg_t *cfg, int enabled)
Definition: htp_config.c:541
htp_config_register_response_header_data
void htp_config_register_response_header_data(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_data_t *))
Definition: htp_config.c:457
htp_config_set_requestline_leading_whitespace_unwanted
void htp_config_set_requestline_leading_whitespace_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted)
Definition: htp_config.c:911
htp_config_set_compression_bomb_limit
void htp_config_set_compression_bomb_limit(htp_cfg_t *cfg, size_t bomblimit)
Definition: htp_config.c:517
HTP_SERVER_APACHE_2
@ HTP_SERVER_APACHE_2
Definition: htp_config.h:97
htp_config_register_transaction_complete
void htp_config_register_transaction_complete(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:487
htp_config_set_nul_raw_unwanted
void htp_config_set_nul_raw_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted)
Definition: htp_config.c:875
htp_config_set_parse_request_cookies
void htp_config_set_parse_request_cookies(htp_cfg_t *cfg, int parse_request_cookies)
Definition: htp_config.c:536
HTP_SERVER_IIS_4_0
@ HTP_SERVER_IIS_4_0
Definition: htp_config.h:79
htp_config_register_request_body_data
void htp_config_register_request_body_data(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_data_t *))
Definition: htp_config.c:402
HTP_SERVER_IIS_7_5
@ HTP_SERVER_IIS_7_5
Definition: htp_config.h:94
HTP_SERVER_IIS_7_0
@ HTP_SERVER_IIS_7_0
Definition: htp_config.h:91
htp_config_register_urlencoded_parser
void htp_config_register_urlencoded_parser(htp_cfg_t *cfg)
Definition: htp_config.c:492
htp_config_register_request_trailer_data
void htp_config_register_request_trailer_data(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_data_t *d))
Definition: htp_config.c:442
htp_config_set_path_separators_encoded_unwanted
void htp_config_set_path_separators_encoded_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted)
Definition: htp_config.c:887
htp_config_set_nul_encoded_unwanted
void htp_config_set_nul_encoded_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted)
Definition: htp_config.c:863
htp_cfg_t
Definition: htp_config_private.h:123
htp_config_set_plusspace_decode
void htp_config_set_plusspace_decode(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled)
Definition: htp_config.c:791
htp_config_register_request_line
void htp_config_register_request_line(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:427
HTP_UNWANTED_IGNORE
@ HTP_UNWANTED_IGNORE
Definition: htp_config.h:106
htp_config_set_backslash_convert_slashes
void htp_config_set_backslash_convert_slashes(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled)
Definition: htp_config.c:755
htp.h
htp_config_set_nul_encoded_terminates
void htp_config_set_nul_encoded_terminates(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled)
Definition: htp_config.c:731
htp_status_t
int htp_status_t
Definition: htp_core.h:46
HTP_DECODER_DEFAULTS
@ HTP_DECODER_DEFAULTS
Definition: htp_config.h:53
htp_config_destroy
void htp_config_destroy(htp_cfg_t *cfg)
Definition: htp_config.c:355
htp_decoder_ctx_t
htp_decoder_ctx_t
Definition: htp_config.h:51
HTP_URL_DECODE_REMOVE_PERCENT
@ HTP_URL_DECODE_REMOVE_PERCENT
Definition: htp_config.h:123
htp_config_set_url_encoding_invalid_unwanted
void htp_config_set_url_encoding_invalid_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted)
Definition: htp_config.c:851
HTP_SERVER_IIS_6_0
@ HTP_SERVER_IIS_6_0
Definition: htp_config.h:88
htp_config_register_request_trailer
void htp_config_register_request_trailer(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:437
htp_config_register_response_trailer_data
void htp_config_register_response_trailer_data(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_data_t *d))
Definition: htp_config.c:482
htp_config_set_u_encoding_unwanted
void htp_config_set_u_encoding_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted)
Definition: htp_config.c:827
htp_config_copy
htp_cfg_t * htp_config_copy(htp_cfg_t *cfg)
Definition: htp_config.c:181
HTP_DECODER_URLENCODED
@ HTP_DECODER_URLENCODED
Definition: htp_config.h:56
htp_config_set_nul_raw_terminates
void htp_config_set_nul_raw_terminates(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled)
Definition: htp_config.c:719
htp_config_register_response_body_data
void htp_config_register_response_body_data(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_data_t *))
Definition: htp_config.c:447
htp_config_set_control_chars_unwanted
void htp_config_set_control_chars_unwanted(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, enum htp_unwanted_t unwanted)
Definition: htp_config.c:839
HTP_SERVER_GENERIC
@ HTP_SERVER_GENERIC
Definition: htp_config.h:73
HTP_SERVER_IIS_5_1
@ HTP_SERVER_IIS_5_1
Definition: htp_config.h:85
htp_config_register_request_headers
void htp_config_register_request_headers(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:422
htp_config_register_response_complete
void htp_config_register_response_complete(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:452
htp_config_set_log_level
void htp_config_set_log_level(htp_cfg_t *cfg, enum htp_log_level_t log_level)
Definition: htp_config.c:526
htp_config_register_request_start
void htp_config_register_request_start(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:432
htp_config_set_extract_request_files
htp_status_t htp_config_set_extract_request_files(htp_cfg_t *cfg, int extract_files, int limit)
Definition: htp_config.c:498
htp_config_set_tmpdir
void htp_config_set_tmpdir(htp_cfg_t *cfg, char *tmpdir)
Definition: htp_config.c:662
htp_config_register_request_file_data
void htp_config_register_request_file_data(htp_cfg_t *cfg, int(*callback_fn)(htp_file_data_t *))
Definition: htp_config.c:407
htp_config_set_u_encoding_decode
void htp_config_set_u_encoding_decode(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled)
Definition: htp_config.c:743
HTP_SERVER_MINIMAL
@ HTP_SERVER_MINIMAL
Definition: htp_config.h:70
htp_config_create
htp_cfg_t * htp_config_create(void)
Definition: htp_config.c:148
htp_config_set_parse_request_auth
void htp_config_set_parse_request_auth(htp_cfg_t *cfg, int parse_request_auth)
Definition: htp_config.c:531
htp_unwanted_t
htp_unwanted_t
Definition: htp_config.h:103
htp_config_set_utf8_convert_bestfit
void htp_config_set_utf8_convert_bestfit(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled)
Definition: htp_config.c:815
htp_config_set_response_decompression_layer_limit
void htp_config_set_response_decompression_layer_limit(htp_cfg_t *cfg, int limit)
Definition: htp_config.c:917
htp_tx_data_t
Definition: htp.h:551
htp_config_set_bestfit_map
void htp_config_set_bestfit_map(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, void *map)
Definition: htp_config.c:683
HTP_SERVER_IIS_5_0
@ HTP_SERVER_IIS_5_0
Definition: htp_config.h:82
htp_config_register_request_header_data
void htp_config_register_request_header_data(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_data_t *))
Definition: htp_config.c:417
htp_config_set_tx_auto_destroy
void htp_config_set_tx_auto_destroy(htp_cfg_t *cfg, int tx_auto_destroy)
Definition: htp_config.c:667
htp_config_set_bestfit_replacement_byte
void htp_config_set_bestfit_replacement_byte(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int replacement_byte)
Definition: htp_config.c:695
htp_config_register_request_uri_normalize
void htp_config_register_request_uri_normalize(htp_cfg_t *cfg, int(*callback_fn)(htp_tx_t *))
Definition: htp_config.c:412
htp_config_set_path_separators_decode
void htp_config_set_path_separators_decode(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, int enabled)
Definition: htp_config.c:767
htp_log_t
Definition: htp.h:145
htp_config_set_server_personality
htp_status_t htp_config_set_server_personality(htp_cfg_t *cfg, enum htp_server_personality_t personality)
Definition: htp_config.c:546