HTP  0.5
htp.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_H
40 #define _HTP_H
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 #include <sys/time.h>
47 
48 #include "htp_version.h"
49 #include "htp_core.h"
50 
51 #include "bstr.h"
52 #include "htp_base64.h"
53 #include "htp_config.h"
54 #include "htp_connection_parser.h"
55 #include "htp_decompressors.h"
56 #include "htp_hooks.h"
57 #include "htp_list.h"
58 #include "htp_multipart.h"
59 #include "htp_table.h"
60 #include "htp_transaction.h"
61 #include "htp_urlencoded.h"
62 #include "htp_utf8_decoder.h"
63 
67 struct htp_conn_t {
69  char *client_addr;
70 
73 
75  char *server_addr;
76 
79 
86 
89 
91  uint8_t flags;
92 
95 
98 
101 
104 };
105 
111 struct htp_file_t {
114 
117 
119  int64_t len;
120 
122  char *tmpname;
123 
125  int fd;
126 };
127 
134 
136  const unsigned char *data;
137 
139  size_t len;
140 };
141 
145 struct htp_log_t {
148 
151 
153  const char *msg;
154 
157 
159  int code;
160 
162  const char *file;
163 
165  unsigned int line;
166 };
167 
171 struct htp_header_t {
174 
177 
179  uint64_t flags;
180 };
181 
185 struct htp_param_t {
188 
191 
194 
197 
202  void *parser_data;
203 };
204 
208 struct htp_tx_t {
211 
214 
217 
223 
225  void *user_data;
226 
227 
228  // Request fields
229 
231  unsigned int request_ignored_lines;
232 
235 
238 
241 
250 
253 
259 
267 
276 
284 
285  /* HTTP 1.1 RFC
286  *
287  * 4.3 Message Body
288  *
289  * The message-body (if any) of an HTTP message is used to carry the
290  * entity-body associated with the request or response. The message-body
291  * differs from the entity-body only when a transfer-coding has been
292  * applied, as indicated by the Transfer-Encoding header field (section
293  * 14.41).
294  *
295  * message-body = entity-body
296  * | <entity-body encoded as per Transfer-Encoding>
297  */
298 
308 
318 
321 
328 
331 
338 
346 
352 
358 
364 
370 
376 
379 
382 
385 
388 
391 
399 
405 
406 
407  // Response fields
408 
411 
414 
417 
423 
429 
435 
441 
444 
447 
450 
451  /* HTTP 1.1 RFC
452  *
453  * 4.3 Message Body
454  *
455  * The message-body (if any) of an HTTP message is used to carry the
456  * entity-body associated with the request or response. The message-body
457  * differs from the entity-body only when a transfer-coding has been
458  * applied, as indicated by the Transfer-Encoding header field (section
459  * 14.41).
460  *
461  * message-body = entity-body
462  * | <entity-body encoded as per Transfer-Encoding>
463  */
464 
474 
484 
492 
498 
505 
514 
521 
522 
523  // Common fields
524 
529  uint64_t flags;
530 
533 
536 };
537 
545 
547  const unsigned char *data;
548 
550  size_t len;
551 
557  int is_last;
558 };
559 
566 struct htp_uri_t {
569 
572 
575 
578 
581 
588 
591 
594 
599 };
600 
606 void htp_uri_free(htp_uri_t *uri);
607 
613 htp_uri_t *htp_uri_alloc(void);
614 
627 void htp_log(htp_connp_t *connp, const char *file, int line, enum htp_log_level_t level, int code, const char *fmt, ...);
628 
640 htp_status_t htp_urldecode_inplace(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, bstr *input, uint64_t *flags);
641 
656 htp_status_t htp_urldecode_inplace_ex(htp_cfg_t *cfg, enum htp_decoder_ctx_t ctx, bstr *input, uint64_t *flags, int *expected_status_code);
657 
663 char *htp_get_version(void);
664 
665 #ifdef __cplusplus
666 }
667 #endif
668 
669 #endif /* _HTP_H */