README
1LibHTP
2============================================================================
3Copyright 2009-2010 Open Information Security Foundation
4Copyright 2010-2013 Qualys, Inc.
5============================================================================
6
7LibHTP is a security-aware parser for the HTTP protocol and the related bits
8and pieces. The goals of the project, in the order of importance, are as
9follows:
10
11 1. Completeness of coverage; LibHTP must be able to parse virtually all
12 traffic that is found in practice.
13
14 2. Permissive parsing; LibHTP must never fail to parse a stream that would
15 be parsed by some other web server.
16
17 3. Awareness of evasion techniques; LibHTP must be able to detect and
18 effectively deal with various evasion techniques, producing, where
19 practical, identical or practically identical results as the web
20 server processing the same traffic stream.
21
22 4. Performance; The performance must be adequate for the desired tasks.
23 Completeness and security are often detrimental to performance. Our
24 idea of handling the conflicting requirements is to put the library
25 user in control, allowing him to choose the most desired library
26 characteristic.
27
28 | IMPORTANT LIBHTP IS NOT YET CONSIDERED STABLE. USE AT YOUR OWN RISK. DO NOT
29 | USE IN PRODUCTION. WORK IS CURRENTLY UNDER WAY TO ENSURE THAT
30 | LIBHTP IS SECURE AND THAT IT PERFORMS WELL.
31
32 | STATUS LIBHTP IS VERY YOUNG AT THIS POINT. IT WILL BE SOME TIME BEFORE
33 | IT CAN BE CONSIDER COMPLETE. AT THE MOMENT, THE FOCUS OF DEVELOPMENT
34 | IS ON ACHIEVING THE FIRST TWO GOALS.
35
36See the LICENSE, COPYING and NOTICE files distributed with this work for
37information regarding licensing, copying and copyright ownership.
38
39
40INSTALLATION
41------------
42
43Assuming you're using an already packaged version of LibHTP, the installation
44process should be as simple as:
45
46 $ sudo chmod u+x autogen.sh
47 $ ./autogen.sh
48 $ ./configure
49 $ make
50 $ sudo make install
51
52If you've retrieved your LibHTP directly from the repository, you will need
53to perform the following steps first:
54
55 1. Update the version number in VERSION.
56
57 2. Run autogen.sh, which will update the build system.
58
59
60
61DOCUMENTATION
62-------------
63
64The best documentation at this time is the code itself and the Doxygen output (which
65should be all right). There's also a quick start guide in the doc/ folder, which
66should give you enough information to get going.
67
68
69LICENSE
70-------
71
72LibHTP is licensed under the BSD 3-Clause license (also known as "BSD New" and
73"BSD Simplified".) The complete text of the license is enclosed in the file LICENSE.
74
75