github_mirrors/attachment
3
0
Fork 1
mirror of https://github.com/openappsec/attachment.git synced 2025-06-28 16:41:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
orianelou 2023-12-11 17:56:29 +02:00 committed by GitHub
parent 18f8cc9552
commit e4bd5dff34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -5,7 +5,7 @@
## About
open-appsec is a machine learning security engine that preemptively and automatically prevent threats against Web Application & APIs.
open-appsec is a machine learning security engine that preemptively and automatically prevents threats against Web Application & APIs.
<strong>open-appsec Attachments</strong> connect between processes that provide HTTP data and the <strong>open-appsec Agent</strong> security logic.
@ -16,7 +16,7 @@ To deal with potential issues where the HTTP Transaction handler process is not
This repository will host Attachments for different platforms. The first one is the open-appsec attachment for NGINX, implemented as a standard NGINX dynamically loadable module (plugin).
## open-appsec NGINX / Kong attachment compilation instructions
## open-appsec NGINX attachment compilation instructions
*We provide an example for compilation instructions on Alpine, the attachment can be comiplied on other environments that match the environment hosting nginx, yet compilation instructions could need adjustment*
The attachment can be compiled to support an existing nginx server or an nginx/ingress-nginxdocker.
@ -37,7 +37,7 @@ Before compiling, ensure the latest development versions of the following librar
$ apk add pcre-dev libxml2-dev zlib-dev openssl-dev geoip-dev linux-headers python3
```
### Compiling the attachment code for an existing NGINX/Kong server
### Compiling the attachment code for an existing NGINX server
On your existing nginx server:
1. Run command to extract nginx compilation flags to a file
@ -45,16 +45,18 @@ On your existing nginx server:
```bash
$ nginx -V &> /tmp/nginx.ver
```
On your compilation environment:
1. Clone this repository
2. Copy the file created on your nginx server (the previous section) to your compilation environment to the path /tmp/nginx.ver
3. Run Configuration script
4. Run CMake command
5. Run make command
6. Run make package command
7. install
```bash
$ git clone https://github.com/openappsec/attachment.git
$ cd attachment
$ ./attachments/nginx/ngx_module/nginx_version_configuration.sh --conf /tmp/nginx.ver build_out
$ cmake -DCMAKE_INSTALL_PREFIX=build_out .
$ make install
@ -65,7 +67,7 @@ On your compilation environment:
The NGINX plugin uses these libraries: shmem_ipc, compression_utils, and nginx_attachment_util.
They can be found under the `lib` directory in the `<output path>` given to the CMake.
#### Deploying the attachment on an existing NGINX/Kong server
#### Deploying the attachment on an existing NGINX server
1. Copy the associated libraries to /usr/lib on your existing nginx server
2. Copy the nginx attachment file lib/libngx_module.so to the following path on your existing nginx server: /usr/lib/nginx/modules/
@ -73,7 +75,7 @@ They can be found under the `lib` directory in the `<output path>` given to the
`load_module /usr/lib/nginx/modules/libngx_module.so;`
4. Restart your nginx server.
### Compiling the attachment code and creating a docker image for an existing kong/nginx/ingress-nginx docker
### Compiling the attachment code and creating a docker image for an existing nginx/ingress-nginx docker
This step requires Docker to be installed on your compilation environment
@ -84,6 +86,7 @@ This step requires Docker to be installed on your compilation environment
```bash
$ git clone https://github.com/openappsec/attachment.git
$ cd attachment
$ ./attachments/nginx/ngx_module/nginx_version_configuration.sh --docker <input docker image> build_out
$ cmake -DCMAKE_INSTALL_PREFIX=build_out -DOUTPUT_DOCKER_IMAGE=<output docker image> .
$ make install