From 18f8cc955232c6b8de81c7303b1a8b689b2f2968 Mon Sep 17 00:00:00 2001 From: orianelou <126462046+orianelou@users.noreply.github.com> Date: Mon, 11 Dec 2023 11:12:32 +0200 Subject: [PATCH 1/2] Update README.md --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 49d6b1e..40f2a41 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,11 @@ An attachment gets HTTP data (URL, Header, Body, Response) from a hosting proces To deal with potential issues where the HTTP Transaction handler process is not responding, the Attachment implements a retry mechanism and configurable fail-open/fail-close mechanism. -This repository will host Attachment for different platforms. The first one is the open-appsec attachment for NGINX, implemented as a standard NGINX dynamically loadable module (plugin). +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 attachment compilation instructions -*We Provide an Example for compilation instructions on alpine, the attachment can be complied on other environments that match the environment hosting nginx, yet compilation instructions could need adjustments* +## open-appsec NGINX / Kong 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 server +### Compiling the attachment code for an existing NGINX/Kong server On your existing nginx server: 1. Run command to extract nginx compilation flags to a file @@ -58,13 +58,14 @@ On your compilation environment: $ ./attachments/nginx/ngx_module/nginx_version_configuration.sh --conf /tmp/nginx.ver build_out $ cmake -DCMAKE_INSTALL_PREFIX=build_out . $ make install + $ make package ``` -#### NGINX plugin associated libraries +#### NGINX plugin-associated libraries The NGINX plugin uses these libraries: shmem_ipc, compression_utils, and nginx_attachment_util. They can be found under the `lib` directory in the `` given to the CMake. -#### Deploying the attachment on an existing nginx server +#### Deploying the attachment on an existing NGINX/Kong 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/ @@ -72,7 +73,7 @@ They can be found under the `lib` directory in the `` 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 nginx/ingress-nginx docker +### Compiling the attachment code and creating a docker image for an existing kong/nginx/ingress-nginx docker This step requires Docker to be installed on your compilation environment @@ -89,9 +90,9 @@ This step requires Docker to be installed on your compilation environment $ make docker ``` -Later on, you can push the image to your own registry and use it as needed. +Later on, you can push the image to your registry and use it as needed. -For deployment on docker you can deploy it using the same docker command you used before with regular nginx container, just make sure to add the parameter `--ipc=host`. +For deployment on docker you can deploy it using the same docker command you used before with a regular nginx container, just make sure to add the parameter `--ipc=host`. ## License From e4bd5dff3493deb88a1284e84024a74591ca94eb Mon Sep 17 00:00:00 2001 From: orianelou <126462046+orianelou@users.noreply.github.com> Date: Mon, 11 Dec 2023 17:56:29 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 40f2a41..d25b649 100644 --- a/README.md +++ b/README.md @@ -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. open-appsec Attachments connect between processes that provide HTTP data and the open-appsec Agent 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 `` 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 `` 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 build_out $ cmake -DCMAKE_INSTALL_PREFIX=build_out -DOUTPUT_DOCKER_IMAGE= . $ make install