Rules Engine¶

Added in version 0.6.

The rules engine is a straightforward yet powerful configuration tool that allows you to write small scripts applied at various stages of the request lifecycle. This can be used to enforce security policies, cache policies, add headers, modify responses, and more.

Example¶

TOML

[rules."*"."GET *"]

on_request = """
from harp.http import HttpResponse

if request.headers.get("Authorization") == "I'm root, let me in":
    response = HttpResponse("Ok, then.")
else:
    request.headers["Via"] = "Ferrata"
"""

on_remote_request = """
if not request.headers.get("Authorization"):
    request.headers["Authorization"] = "Passphrase I shall pass."
"""

on_remote_response = """
response.headers["Cache-Control"] = "max-age=3600"
"""

on_response = """
response.headers["X-Signature"] = "Best regards, Joe."
"""

Documentation ¶