Skip to content

ip_list_manager.md

Latest commit

 

History

History
83 lines (68 loc) · 2.95 KB

ip_list_manager.md

File metadata and controls

83 lines (68 loc) · 2.95 KB

IP List Manager

IP List Manager is a tool that automates tasks the synchronization of IP lists across multiple Cloudflare accounts. It is designed to help Cloudflare users efficiently manage allowlists, blocklists, and trusted IP ranges.

cf-box % python3 cloudflare_ip_list_manager.py
📌 Managing IP lists for F************i@g****.com's Account (ID: 1e7ed1...0fbe52)
📌 Managing IP lists for L********o@g****.com's Account (ID: b2f381...099a43)
📄 Report saved: reports/cf_sync_2025-01-31_11-29-56.md

Warning

Set your GitHub repository visibility to private before to populate config.yaml and execute the runner.

Features

  • ✅ Automatic IP list synchronization with Cloudflare's API.
  • ✅ Supports multiple accounts and IP lists via a YAML configuration.
  • ✅ Fetches IPs from external sources (JSON and plaintext).
  • ✅ Caches IP lists locally to avoid unnecessary API requests.
  • ✅ Optimized bulk update to avoid multiple requests for rulesets endpoints.

Requirements

  • Python 3.7+
  • requests
  • pyyaml

Install Dependencies

pip install -r requirements.txt

Configuration

The script uses a config.yaml file to define accounts, IP lists, and sources.

Example config.yaml

accounts:
  - id: "1e7ed1e7e9b2dfdfb15ed609d30fbe52"
    name: "Example Cloudflare Account"
    lists:
      - name: "trusted_aws_ips"
        sync_from: "https://raw.githubusercontent.com/lord-alfred/ipranges/main/aws.json"
        type: "json"
      - name: "bad_ips"
        sync_from: "https://github.com/stamparm/ipsum/raw/refs/heads/master/levels/3.txt"
        type: "text"
    notifications:
      webhook: "https://your-webhook-url.com"

Usage

Set API Token

Ensure your Cloudflare API token is set as an environment variable or as GitHub Actions Repository Secret:

export CLOUDFLARE_API_TOKEN="your_cloudflare_api_token"

Run the Script

python cloudflare_ip_list_manager.py

How It Works

  1. Reads the config.yaml for accounts and IP list definitions.
  2. Fetches the current Cloudflare IP lists to compare with external sources.
  3. Downloads IPs from the specified sources (JSON or plaintext files).
  4. Checks for changes to avoid unnecessary API updates.
  5. Bulk updates Cloudflare IP lists to comply with rate limits.
  6. Caches results to minimize external requests.

Cloudflare API Rate Limit Handling

  • Cloudflare limits API requests to ~1,200 per 5 minutes per account.
  • The script uses a single bulk update instead of multiple small updates.
  • Implements 300-600s backoff when rate-limited.

Contributing

Feel free to submit pull requests and improve the project.

License

This project is licensed under the MIT License.

Disclaimer

This tool is not affiliated with or officially supported by Cloudflare.