Skip to content

Latest commit

 

History

History
98 lines (69 loc) · 4.12 KB

README.md

File metadata and controls

98 lines (69 loc) · 4.12 KB
Raw

NGINX App Protect Tools

This repo is a quickstart for using the App Protect converter tools released in v2.3 in your CI/CD pipeline. The tool examples use Ubuntu 20.04 in a Docker container to highlight that these tools can be used in a fast, yet ephemeral manner.

The available tools are:

  • Policy Converter - Converts XML format ASM/AWAF security policy to App Protect JSON declarative format.

  • Signature Report Tool - Exports signature metadata of the signatures installed on a system.

  • User-defined Signatures Converter - Converts ASM/AWAF user-defined signatures to App Protect JSON format. While the Docker container in this repo can potentially be used to convert user-defined signatures, the scripts have not been implemented to do so at this time.

Dependencies

The examples below require Docker and jq to be installed on the host to function properly.

App Protect Tool Instructions

Copy your NGINX repo Certificate and Key files to the license directory.

Then, build the tools container:

DOCKER_BUILDKIT=1 docker build --no-cache --secret id=nginx-crt,src=license/nginx-repo.crt --secret id=nginx-key,src=license/nginx-repo.key -t app-protect-tools .

NOTE: If you need to change the signature package to be reported on, you must alter the Dockerfile to install the desired signature package, then rebuild the container before running the signature port commands.

Policy Converter Tool

Run the policy converter and save nap_policy.json and nap_policy.yaml files to local tmp directory:

docker run -v $(pwd)/tmp:/tmp --entrypoint "sh" app-protect-tools convert.sh

Signature Report Tool

Run the signature report tool against the signatures installed when the container was built:

docker run -v $(pwd)/tmp:/tmp --entrypoint "sh" app-protect-tools signature-report.sh

Get the revision date of the signature package:

 cat tmp/signature-report.json | jq '.revisionDatetime'

Check which signatures are linked to CVEs:

cat tmp/signature-report.json | jq '.signatures[] | select(.hasCve==true)'

Or, get the count of the above"

cat tmp/signature-report.json | jq '[.signatures[] | select(.hasCve==true)] | length'

Get the count of all app Denial of Service type signatures"

cat tmp/signature-report.json | jq '[.signatures[] | select(.attackType.name=="Denial of Service")] | length'

Find a specific signature by ID:

cat tmp/signature-report.json | jq '.signatures[] | select(.signatureId==200000018)'

From the signature list, generate and export 50 signature override policy fragments per URL

cat tmp/signature-report.json | jq '[.signatures[] | select(.hasCve==true)] | .[0:50] | to_entries | map({ "method": "*", "name": ("/test" + (.value.signatureId | tostring) + "*"), "protocol": "http", "type": "wildcard", "wildcardOrder": (.key+1), "signatureOverrides": [ { "enabled": false, "signatureId": .value.signatureId }]})'

Validating a Policy Against the App Protect Schema

This is an example as to how you can use the Ajv Validator CLI to validate a JSON policy file against the NGINX App Protect JSON schema. NOTE: This example does not use the Docker container above.

  1. Export the JSON schema from App Protect using the instructions here. Though it is best to export the schema from the version of App Protect that is installed, you may optionally use a copy of the schema file as of App Protect 3.6 is included in the root of this repo.

  2. Install Node.js

  3. Install the ajv-cli validator npm package globally:

npm install -g ajv-cli
  1. Install the ajv-formats npm package globally:
npm install ajv-formats -g
  1. Perform the policy validation:
ajv validate -d <path to json policy>  -s <path to json schema> -c ajv-formats