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 NOTICE

Browse Source
This commit is contained in:
noam 2022-07-07 19:05:57 +03:00
parent 7e8e141c53
commit f04852f5d7
2 changed files with 39 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
NOTICE
View File

@ -1,4 +1,4 @@
Agent Repo Demo2 open-appsec Attachments
Copyright 2022 Check Point Software Technologies Copyright 2022 Check Point Software Technologies
This product includes software developed at This product includes software developed at

48
README.md
View File

@ -1,13 +1,29 @@
# attachment am<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">
<h1>openappsec/attachement</h1>
</div>
## NGINX attachment compilation instructions ## About
### Compiling this repository 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.
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.
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)
## open-appsec NGINX attachment compilation instructions
### Compiling the attachment code
1. Clone this repository 1. Clone this repository
2. Run CMake command (we recommand something like `cmake -DCMAKE_INSTALL_PREFIX=<output path> <repository path>`). 2. Run CMake command
3. From the repositoy directory run `make install` 3. Run make install command
For example:
```bash ```bash
$ git clone https://github.com/openappsec/attachment.git $ git clone https://github.com/openappsec/attachment.git
$ cd attachment/ $ cd attachment/
@ -15,12 +31,14 @@ For example:
$ make install $ make install
``` ```
### For the NGINX plugin ### NGINX plugin
Grab the nginx source code from [nginx.org](http://nginx.org/), for example,
the version 1.23.0 (see [nginx compatibility](http://nginx.org/en/docs/njs/compatibility.html)), and then build the source with this module: 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))
2. Run make modules
```bash ```bash
$ module_path=/absolute/path/to/attachment $ module_path=/<absolute-path>/attachment
$ wget 'http://nginx.org/download/nginx-1.23.0.tar.gz' $ wget 'http://nginx.org/download/nginx-1.23.0.tar.gz'
$ tar -xzvf nginx-1.23.0.tar.gz $ tar -xzvf nginx-1.23.0.tar.gz
@ -35,3 +53,13 @@ the version 1.23.0 (see [nginx compatibility](http://nginx.org/en/docs/njs/compa
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!
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
open-appsec/attachment is open source and available under the Apache 2.0 license.