Libmodsecurity is the one component of the ModSecurity v3 project

The library codebase serves as a software to ModSecurity connections taking in online traffic and applying traditional ModSecurity operating. Overall, it gives the ability to load/interpret principles printed in the ModSecurity SecRules structure and implement them to HTTP articles offered by the application via connections.

To bring about this paperwork, be sure to use the doxygen power with all the offered setting document, aˆ?doxygen

• All Apache dependencies have-been removed
• Greater show
• Additional features
• Unique architecture

Libmodsecurity are a whole rewrite on the ModSecurity program. Whenever it was initially devised the ModSecurity job begun as merely an Apache component. With time your panels was extended, as a result of popular need, to compliment various other programs like (yet not restricted to) Nginx and IIS. To be able to offer the raising interest in added platform support, it’s became essential to take away the Apache dependencies root this venture, rendering it much more platform independent.

Because of this objective we rearchitected Libmodsecurity so that it is no longer dependent on the Apache web host (both at compilation and during runtime). One side effects for this is the fact that across all networks people can expect increasing results. In addition, there is taken this chance to place the foundation for many new features that users have now been long pursuing. For instance the audience is seeking natively help auditlogs from inside the JSON format, together with a host of different features in future variations.

The ‘ModSecurity’ department not any longer contains the conventional component reasoning (for Nginx, Apache, and IIS) which has traditionally come packaged altogether. Rather, this part just provides the library portion (libmodsecurity) with this project. This library was ingested with what we termed ‘Connectors’ these connectors will program with your webserver and offer the collection with a common structure that it understands. Each of these connections is managed as a different GitHub venture. For-instance, the Nginx connector is supplied because of the ModSecurity-nginx venture (

Maintaining these fittings separated allows each job getting different release cycles, problems and developing woods. Also, it means whenever you put in ModSecurity v3 you only become exactly what you want, no extras you may not use.

Prior to starting the collection process, ensure that you have got all the dependencies set up. Read the subsection aˆ?Dependenciesaˆ? for additional facts.

After the compilation ensure that there are not any problems on your build/platform. We strongly suggest the usage of the machine exams and regression examinations. These test utilities can be found in subfolder aˆ?tests’.

As a powerful library, don’t forget that libmodsecurity ought to be setup to a location (folder) in which you OS is looking for vibrant libraries.

This library is written in C++ making use of the C++11 expectations. Additionally, it uses Flex and Yacc to make the aˆ?Sec regulations Languageaˆ? parser. Additional, mandatory dependencies add YAJL, as ModSecurity utilizes JSON for making logs and its evaluation platform, libpcre (not yet compulsory) for handling typical expressions in SecRules, and libXML2 (not yet required) which is used for parsing XML needs.

Others dependencies are connected with operators given within SecRules or setup directives that can not needed for compilation. A brief list of such dependencies is really as follows:

To generate this records, be sure to utilize the doxygen utility utilizing the provided arrangement document, aˆ?doxygen

• libinjection needs the user and
• curl will become necessary when it comes down to directive SecRemoteRules.

If those libraries were lacking ModSecurity can be gathered without the assistance your driver together with setting directive SecRemoteRules.

The collection documentation is created within code in Doxygen style. cfgaˆ?, present using “doc/” subfolder. This will produce HTML formatted records including use instances.