Skip to main content

Wrapper library to import / export multiple remote rules and easily create, modify and delete rules.

Project description

Welcome to Cloudflare WAF Custom rules library 👋

Previously known as Cloudflare Firewall Rules

Website  Donate  Contributions  Tested on Python 3.12  License  Size 

A Cloudflare wrapper to bulk add / edit your WAF custom rules using Cloudflare's API.

This library is a wrapper that aims to easily create, modify, delete rules. It also provides a way to import & export new rules in your domain's firewall.

If you have several rules that you want to duplicate among your domains, this module is made for you!

A complete documentation can be found at: https://quentiumyt.github.io/Cloudflare-Firewall-Rules/

📥 Installation

pip install cf_rules

# OR

git clone https://github.com/QuentiumYT/Cloudflare-Firewall-Rules.git
cd Cloudflare-Firewall-Rules/
pip install .

🚀 Usage

You have 2 auth methods available:

A Global API Key or a specific API Token generated from here: https://dash.cloudflare.com/profile/api-tokens

Cloudflare Global API Key

Cloudflare Key

Using a Global API Key, you will have access to everything allowed by a Cloudflare account. It can access all domains from every account you have, this might be overpowered...

Cloudflare API Token

An API token is recommended to keep control of specific domains only. You will need to give the correct permissions for Cloudflare's WAF Custom rules to work.

The required permissions are "Zone.Zone, Zone.Firewall Services"

Cloudflare Token

Here is a token creation example:

Cloudflare Token

💨 Quickstart

You can use any example scripts in the examples folder, just create a .env file

I might add more examples in the future, but everything is in the docs :)


Create any Python file in the cloned directory and paste these lines

from cf_rules import Cloudflare

cf = Cloudflare()
cf.auth_key("<your-address@email.com>", "<your-global-api-key>")
# OR
cf.auth_token("<your-specific-bearer-token>")

domains = cf.domains[0].name

print(domains)
# >>> ['example.com']

cf.export_rules("example.com")
# Creates a text file for every rule you have on your domain

cf.create_rule("example.com", "My Bad Bots FW rule", "Bad Bots", "challenge")
# Create a new rule with the content of the "Bad bots.txt" file with the challenge action

cf.update_rule("example.com", "My Bad Bots FW rule", "Bad Bots lib")
# Change the rule's expression to the content of the "Bad bots lib.txt" file

🤝 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change and join your fork with the modifications.
Please make sure to test your suggestions before committing.

If you don't feel comfortable coding, you can submit your idea about what you would like to see implemented.

Any PR with small code examples or better documentation changes is appreciated :)

👤 Author

Quentin L.

Please ✰ this repository if this project helped you!

📖 License

Apache 2.0


Made withby QuentiumYT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cf_rules-2.0.0.tar.gz (24.3 kB view hashes)

Uploaded Source

Built Distribution

cf_rules-2.0.0-py3-none-any.whl (20.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page