HTP  0.5
htp_core.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_CORE_H
40 #define HTP_CORE_H
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 typedef int htp_status_t;
47 
48 typedef struct htp_cfg_t htp_cfg_t;
49 typedef struct htp_conn_t htp_conn_t;
50 typedef struct htp_connp_t htp_connp_t;
51 typedef struct htp_file_t htp_file_t;
53 typedef struct htp_header_t htp_header_t;
55 typedef struct htp_log_t htp_log_t;
56 typedef struct htp_param_t htp_param_t;
58 typedef struct htp_tx_t htp_tx_t;
59 typedef struct htp_uri_t htp_uri_t;
60 typedef struct timeval htp_time_t;
61 
62 // Below are all htp_status_t return codes used by LibHTP. Enum is not
63 // used here to allow applications to define their own codes.
64 
68 #define HTP_ERROR_RESERVED -1000
69 
71 #define HTP_ERROR -1
72 
78 #define HTP_DECLINED 0
79 
81 #define HTP_OK 1
82 
87 #define HTP_DATA 2
88 
99 #define HTP_DATA_OTHER 3
100 
106 #define HTP_STOP 4
107 
112 #define HTP_DATA_BUFFER 5
113 
117 #define HTP_STATUS_RESERVED 1000
118 
129 
132 
135 
138 
141 };
142 
150 
153 
156 
159 };
160 
167 
170 
173 
176 
179 };
180 
182 
184 
186 };
187 
188 // Various flag bits. Even though we have a flag field in several places
189 // (header, transaction, connection), these fields are all in the same namespace
190 // because we may want to set the same flag in several locations. For example, we
191 // may set HTP_FIELD_FOLDED on the actual folded header, but also on the transaction
192 // that contains the header. Both uses are useful.
193 
194 // Connection flags are 8 bits wide.
195 #define HTP_CONN_PIPELINED 0x000000001
196 #define HTP_CONN_HTTP_0_9_EXTRA 0x000000002
197 
198 // All other flags are 64 bits wide.
199 #define HTP_FIELD_UNPARSEABLE 0x000000004
200 #define HTP_FIELD_INVALID 0x000000008
201 #define HTP_FIELD_FOLDED 0x000000010
202 #define HTP_FIELD_REPEATED 0x000000020
203 #define HTP_FIELD_LONG 0x000000040
204 #define HTP_FIELD_RAW_NUL 0x000000080
205 #define HTP_REQUEST_SMUGGLING 0x000000100
206 #define HTP_INVALID_FOLDING 0x000000200
207 #define HTP_REQUEST_INVALID_T_E 0x000000400
208 #define HTP_MULTI_PACKET_HEAD 0x000000800
209 #define HTP_HOST_MISSING 0x000001000
210 #define HTP_HOST_AMBIGUOUS 0x000002000
211 #define HTP_PATH_ENCODED_NUL 0x000004000
212 #define HTP_PATH_RAW_NUL 0x000008000
213 #define HTP_PATH_INVALID_ENCODING 0x000010000
214 #define HTP_PATH_INVALID 0x000020000
215 #define HTP_PATH_OVERLONG_U 0x000040000
216 #define HTP_PATH_ENCODED_SEPARATOR 0x000080000
217 #define HTP_PATH_UTF8_VALID 0x000100000 /* At least one valid UTF-8 character and no invalid ones. */
218 #define HTP_PATH_UTF8_INVALID 0x000200000
219 #define HTP_PATH_UTF8_OVERLONG 0x000400000
220 #define HTP_PATH_HALF_FULL_RANGE 0x000800000 /* Range U+FF00 - U+FFEF detected. */
221 #define HTP_STATUS_LINE_INVALID 0x001000000
222 #define HTP_HOSTU_INVALID 0x002000000 /* Host in the URI. */
223 #define HTP_HOSTH_INVALID 0x004000000 /* Host in the Host header. */
224 #define HTP_URLEN_ENCODED_NUL 0x008000000
225 #define HTP_URLEN_INVALID_ENCODING 0x010000000
226 #define HTP_URLEN_OVERLONG_U 0x020000000
227 #define HTP_URLEN_HALF_FULL_RANGE 0x040000000 /* Range U+FF00 - U+FFEF detected. */
228 #define HTP_URLEN_RAW_NUL 0x080000000
229 #define HTP_REQUEST_INVALID 0x100000000
230 #define HTP_REQUEST_INVALID_C_L 0x200000000
231 #define HTP_AUTH_INVALID 0x400000000
232 
233 #define HTP_HOST_INVALID ( HTP_HOSTU_INVALID | HTP_HOSTH_INVALID )
234 
235 // Logging-related constants.
236 #define HTP_LOG_MARK __FILE__,__LINE__
237 
249 };
250 
288 };
289 
290 // A collection of unique parser IDs.
294 
297 };
298 
299 // Protocol version constants; an enum cannot be
300 // used here because we allow any properly-formatted protocol
301 // version (e.g., 1.3), even those that do not actually exist.
302 #define HTP_PROTOCOL_INVALID -2
303 #define HTP_PROTOCOL_UNKNOWN -1
304 #define HTP_PROTOCOL_0_9 9
305 #define HTP_PROTOCOL_1_0 100
306 #define HTP_PROTOCOL_1_1 101
307 
308 // A collection of possible data sources.
312 
315 
318 
321 };
322 
323 #define HTP_STATUS_INVALID -1
324 #define HTP_STATUS_UNKNOWN 0
325 
339 };
340 
341 #ifdef __cplusplus
342 }
343 #endif
344 
345 #endif /* HTP_CORE_H */