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:
noam 2022-07-12 19:17:03 +03:00
parent 43a85c67a0
commit 69fd7510e4
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -9,12 +9,11 @@ open-appsec is a machine learning security engine that preemptively and automati
<strong>open-appsec Attachments</strong> connect between processes that provide HTTP data and the <strong>open-appsec Agent</strong> security logic. <strong>open-appsec Attachments</strong> connect between processes that provide HTTP data and the <strong>open-appsec Agent</strong> security logic.
An attachment gets HTTP data (URL, Header, Body, Response) from a hosting process and delivers it to an open-appsec process known as HTTP Transaction handler. The attachment does not keep any state and has no security logic. An attachment gets HTTP data (URL, Header, Body, Response) from a hosting process and delivers it to an open-appsec process known as HTTP Transaction handler.
To deal with potential issues where the HTTP Transaction handler process is not responding, the Attachment implements a retry mechanism and 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.
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 Attachment 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 ## open-appsec NGINX attachment compilation instructions
@ -40,7 +39,10 @@ NGINX Plugins are built per specific version.
```bash ```bash
$ module_path=/<absolute-path>/attachment $ module_path=/<absolute-path>/attachment
$ wget 'http://nginx.org/download/nginx-1.23.0.tar.gz' $ wget 'https://nginx.org/download/nginx-1.23.0.tar.gz'
$ sha256sum nginx-1.23.0.tar.gz
820acaa35b9272be9e9e72f6defa4a5f2921824709f8aa4772c78ab31ed94cd1 nginx-1.23.0.tar.gz
$ tar -xzvf nginx-1.23.0.tar.gz $ tar -xzvf nginx-1.23.0.tar.gz
$ cd nginx-1.23.0/ $ cd nginx-1.23.0/
@ -54,10 +56,6 @@ The NGINX plugin uses these libraries: shmem_ipc, compression_utils, and nginx_a
They can be found under the `lib` directory in the `<output path>` given to the CMake. They can be found under the `lib` directory in the `<output path>` given to the CMake.
## Join the open-appssec Community!
The open-appssec community (https://openappsec.io/community) is committed to fostering an open and welcoming environment, allowing engagement with other users and developers.
## License ## License
open-appsec/attachment is open source and available under the Apache 2.0 license. open-appsec/attachment is open source and available under the Apache 2.0 license.