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

README update

Browse Source
This commit is contained in:
noam 2022-07-07 19:12:23 +03:00
parent f04852f5d7
commit 43a85c67a0
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

@ -1,4 +1,4 @@
am<div align=center> <div align=center>
<img src="https://i2-s3-ui-static-content-prod-10.s3.eu-west-1.amazonaws.com/elpis/tree-no-bg-256.png" width="100" height="100"> <img src="https://i2-s3-ui-static-content-prod-10.s3.eu-west-1.amazonaws.com/elpis/tree-no-bg-256.png" width="100" height="100">
<h1>openappsec/attachement</h1> <h1>openappsec/attachement</h1>
</div> </div>
@ -7,14 +7,14 @@ am<div align=center>
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 prevent 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. <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 additiona 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. The attachment does not keep any state and has no security logic.
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
@ -27,13 +27,13 @@ This repository will host Attachment for different platforms. The first one is t
```bash ```bash
$ git clone https://github.com/openappsec/attachment.git $ git clone https://github.com/openappsec/attachment.git
$ cd attachment/ $ cd attachment/
$ cmake -DCMAKE_INSTALL_PREFIX=build_out . $ cmake -DCMAKE_INSTALL_PREFIX=build_out .
$ make install $ make install
``` ```
### NGINX plugin ### NGINX plugin
NGINX Plugins are built per specific version. NGINX Plugins are built per specific version.
1. Get nginx source code from [nginx.org](http://nginx.org/), e.g. version 1.23.0 (see [nginx compatibility](http://nginx.org/en/docs/njs/compatibility.html)) 1. Get nginx source code from [nginx.org](http://nginx.org/), e.g. version 1.23.0 (see [nginx compatibility](http://nginx.org/en/docs/njs/compatibility.html))
2. Run make modules 2. Run make modules
@ -53,13 +53,11 @@ NGINX Plugins are built per specific version.
The NGINX plugin uses these libraries: shmem_ipc, compression_utils, and nginx_attachment_util. 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. They can be found under the `lib` directory in the `<output path>` given to the CMake.
## Join the open-appssec Community! ## 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. 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.