Update README.md
1 file changed
tree: f5d42dd183545ad620bbf43eb273b71792be6506
  1. aardvark.png
  2. aardvark.py
  3. aardvark.yaml
  4. LICENSE
  5. pipservice-aardvark-proxy.service
  6. README.md
  7. requirements.txt
README.md

infrastructure-aardvark-proxy

Aardvark Proxy Middleman

This service acts as a middleman between frontend web servers and ticket submission services such as JIRA or BugZilla, and intercepts all data sent. Data is scanned for known offending words that are common in spam, and blocks the request if such are found.

diagram

Settings:

  • proxy_url: The backend service to proxy to if request is sane
  • spamurls: Specific honey-pot URLs that trigger a block regardless of the action
  • ignoreurls: Specific URLs that are exempt from spam detection
  • postmatches: A list of keywords and/or regexes that, if matched, will block the request
  • multimatch: A combination blocker. If a required keyword or regex is matched, the request will be blocked only if one or more auxiliary keywords/regexes are also matched

Pipservicing

To enable as a pipservice, add the following minimal hiera yaml to your node config:

pipservice:
  aardvark-proxy:
    tag: main

HTTPd configuration example

As Aardvark is a proxy middleman for specific purposes, you will preferably need a web server in front. The example below relays all POST requests for /foo/bar through Aardvark, while letting all GETs etc go directly to the backend service.

Assuming Aardvark is listening on port 4321 and the real backend service is on port 8080:

# Send all POST requests through Aardvark
RewriteEngine On
RewriteCond %{REQUEST_METHOD} POST
RewriteRule ^/(.*)$ http://localhost:4321/$1 [P]
# Rest goes to backend directly
ProxyPass / http://localhost:8080/foo/bar/