Skip to main content

A tool to update Linode/ACC firewall rules with your current IP address.

Project description

acc-firewall_updater

A tool to automatically update the Akamai Connected Cloud (ACC) / Linode firewall rules to allow your IP.

Test, Scan, Build, & Publish PyPI version

Description

acc-fwu is a command-line tool to automatically update Linode/ACC firewall rules with your current IP address. This is particularly useful for dynamically updating firewall rules to allow access from changing IP addresses, like when you visit the gym or you're sat in an airport.

Features

  • Automatically detects your current public IP address
  • Creates firewall rules for TCP, UDP, and ICMP protocols
  • Saves configuration for easy subsequent usage
  • Supports dry-run mode to preview changes
  • Quiet mode for cron jobs and automation
  • Debug mode for troubleshooting
  • Input validation for security
  • Secure configuration file storage (owner-only permissions)
  • Interactive firewall selection - List and choose from available firewalls
  • Add mode - Accumulate multiple IP addresses (ideal for traveling)
  • LKE Control Plane ACL automation - Every run also syncs your public IP into every LKE and LKE-E cluster's Control Plane ACL (opt-out with --no-lke; use --lke for LKE-only mode)
  • Managed Database allow_list automation - Every run also syncs your public IP into every MySQL/PostgreSQL Managed Database allow_list (opt-out with --no-database; use --database for database-only mode)
  • Active firewall indicator - When the config file is used, acc-fwu prints the firewall ID and label it's operating on

Prerequisites

  • Python 3.9 or higher
  • Linode CLI configured with an API token
  • A Linode/ACC firewall ID

Installation

You can install the package via pip or pipx:

pipx install acc-fwu

Alternatively, you can install it directly from the source:

git clone https://github.com/johnybradshaw/acc-firewall_updater.git
cd acc-firewall_updater
pip install --use-pep517 .

For development installation, see BUILD.md.

Usage

First-time Setup

The first time you use acc-fwu, you'll need to provide your Linode/ACC Firewall ID and optionally the label for the rule you want to create or update:

acc-fwu --firewall_id <FIREWALL_ID> --label <RULE_LABEL>

For example:

acc-fwu --firewall_id 123456 --label "Allow-My-Current-IP"

This command will do two things:

  1. It will create or update the firewall rule with your current public IP address.
  2. It will save the firewall_id and label to a configuration file (~/.acc-fwu-config) for future use.

Subsequent Usage

After the initial setup, you can simply run acc-fwu without needing to provide the firewall_id and label again:

acc-fwu

This will:

  1. Load the saved firewall_id and label from the configuration file.
  2. Print the active firewall (for example Using saved firewall: ID 123456, label 'My-IP' (from ~/.acc-fwu-config)).
  3. Update the firewall rule with your current public IP address.
  4. Sync your current public IP into every LKE / LKE-E Control Plane ACL in your account. Pass --no-lke to skip this step.
  5. Sync your current public IP into every Managed Database (MySQL/PostgreSQL) allow_list in your account. Pass --no-database to skip this step.

Command-Line Options

usage: acc-fwu [-h] [--firewall_id FIREWALL_ID] [--label LABEL] [-d] [-r] [-a] [-l] [--lke] [--no-lke] [--database] [--no-database] [-q] [--dry-run] [-v]

Create, update, or remove Akamai Connected Cloud (Linode) firewall rules with your current IP address.

options:
  -h, --help            show this help message and exit
  --firewall_id FIREWALL_ID
                        The numeric ID of the Linode firewall.
  --label LABEL         Label for the firewall rule (alphanumeric, underscores, hyphens, max 32 chars).
  -d, --debug           Enable debug mode to show existing rules data.
  -r, --remove          Remove the specified rules from the firewall.
  -a, --add             Add IP to existing rules instead of replacing (useful for multiple locations).
  -l, --list            List available firewalls (or LKE clusters with --lke, or managed databases with --database) and exit.
  --lke                 Target LKE/LKE-E Control Plane ACLs only; skip firewall rules.
                        Adds (or removes with -r) your current public IP to every cluster's ACL.
  --no-lke              Skip the default LKE/LKE-E Control Plane ACL update.
                        By default, acc-fwu updates firewall rules, LKE ACLs, and managed database allow_lists.
  --database            Target managed database allow_lists only; skip firewall rules.
                        Adds (or removes with -r) your current public IP to every managed database's allow_list.
  --no-database         Skip the default managed database allow_list update.
                        By default, acc-fwu updates firewall rules, LKE ACLs, and managed database allow_lists.
  -q, --quiet           Suppress output messages (useful for cron/scripting).
  --dry-run             Show what would be done without making any changes.
  -v, --version         show program's version number and exit

Example: acc-fwu --firewall_id 12345 --label MyIP

Examples

Preview changes without applying them:

acc-fwu --firewall_id 123456 --label "My-IP" --dry-run

Run silently (for cron jobs):

acc-fwu --quiet  # Requires existing config file

Remove firewall rules:

acc-fwu --remove

Debug mode (shows existing rules):

acc-fwu --debug

Check version:

acc-fwu --version

List available firewalls:

acc-fwu --list

Add IP without replacing existing ones (great for traveling):

acc-fwu --add

First-time setup with interactive firewall selection:

# If no firewall_id is provided and no config exists,
# you'll be prompted to select from available firewalls
acc-fwu

Multi-Location Usage (Add Mode)

If you frequently travel and need to access your servers from multiple locations, use the --add flag:

# From home
acc-fwu --add

# Later, from a coffee shop
acc-fwu --add

# Later, from the airport
acc-fwu --add

Each location's IP address will be added to your firewall rules, allowing access from all locations. Without --add, your IP would be replaced each time.

To start fresh and remove all accumulated IPs:

acc-fwu --remove
acc-fwu  # Creates new rules with only your current IP

LKE / LKE-E Control Plane ACLs

acc-fwu automates Control Plane ACL updates for every LKE and LKE-Enterprise (LKE-E) cluster in your account. For each cluster it fetches the current ACL, then appends (or removes) your public IP — preserving the enabled state and any existing IPv4/IPv6 entries.

Default behaviour (since v0.3.1): every firewall update also syncs your IP into each cluster's Control Plane ACL. Accounts with no clusters see no extra output. Pass --no-lke to skip it, or --lke for LKE-only mode.

List all LKE / LKE-E clusters:

acc-fwu --lke --list

Skip the LKE step while still updating firewall rules:

acc-fwu --no-lke

LKE-only mode (skip firewall rule updates entirely):

acc-fwu --lke

Preview changes:

acc-fwu --lke --dry-run

Remove your current IP from every cluster's ACL:

acc-fwu --lke --remove

Run silently in a cron job:

# Refresh firewall rules + LKE ACLs every 15 minutes
*/15 * * * * /usr/local/bin/acc-fwu --quiet

# Or, LKE only
*/15 * * * * /usr/local/bin/acc-fwu --lke --quiet

Clusters whose ACL is disabled will still have the address stored, but acc-fwu prints a warning — the entry will not be enforced until you enable the ACL. Failures on individual clusters are logged and counted in the final summary but do not abort the run.

Managed Database allow_list

acc-fwu automates allow_list updates for every Linode Managed Database (MySQL and PostgreSQL) in your account. For each database it appends (or removes) your public IP, preserving any other entries already present.

Default behaviour: every firewall update also syncs your IP into each managed database's allow_list. Accounts with no databases see no extra output. Pass --no-database to skip it, or --database for database-only mode.

List all managed databases:

acc-fwu --database --list

Skip the database step while still updating firewall rules:

acc-fwu --no-database

Database-only mode (skip firewall rule updates entirely):

acc-fwu --database

Preview changes:

acc-fwu --database --dry-run

Remove your current IP from every database's allow_list:

acc-fwu --database --remove

Databases on engines other than mysql or postgresql are reported as a per-database skip. Failures on individual databases are logged and counted in the final summary but do not abort the run.

Cron Job Example

To automatically update your firewall rules (along with LKE / LKE-E Control Plane ACLs and Managed Database allow_lists) every hour:

# Update firewall rules + LKE ACLs + database allow_lists every hour
0 * * * * /usr/local/bin/acc-fwu --quiet

# Firewall only (skip LKE and database steps)
0 * * * * /usr/local/bin/acc-fwu --quiet --no-lke --no-database

Important: Before using --quiet mode, you must have a valid configuration file (~/.acc-fwu-config) with your firewall_id and label. Interactive firewall selection is not available in quiet mode. Run acc-fwu interactively first to set up your configuration.

Configuration File

The acc-fwu tool saves the firewall_id and label in a configuration file located at ~/.acc-fwu-config. This file is:

  • Automatically managed by the tool
  • Created with secure permissions (readable only by owner)
  • Uses standard INI format

You generally won't need to edit it manually.

Security

  • Input Validation: All inputs (firewall ID, labels, IP addresses) are validated before use
  • Secure Config Storage: Configuration file is created with 600 permissions (owner read/write only)
  • No Credential Storage: API tokens are read from the Linode CLI configuration, not stored separately
  • HTTPS Only: All API communications use HTTPS

Development

See BUILD.md for local development and testing instructions.

See RELEASE.md for information on creating releases.

The project uses multiple GitHub Actions workflows for quality assurance:

  • Test, Scan, Build, & Publish - Main CI/CD pipeline (lint, test, security scan, build, PyPI publish)
  • CodeQL Analysis - Automated code security scanning
  • Dependency Review - Reviews dependency changes in pull requests

License

This project is licensed under the GNU General Public License v3 (GPLv3) - see the LICENSE file for details.

Summary of Changes

2026-05-10 - v0.4.0

  • New Features:
    • Linode Managed Database (MySQL / PostgreSQL) allow_list updates now run by default alongside firewall and LKE updates — your public IP is added to (or removed from) every database's allow_list on each invocation. Pass --no-database to opt out, or use --database for a databases-only run. --lke and --database compose, e.g. acc-fwu --lke --database skips firewall and runs both.
    • Added --database --list to enumerate every Managed Database on the account (engine, ID, label, region, current allow_list).
    • VPC-attached databases (those with private_network set) are detected and skipped with a clear notice — the public IP we detect from ipify cannot reach a VPC-only endpoint, so updating their allow_list would be a no-op or worse, lock you out.
  • Improvements:
    • Standardized output across every deployment type (firewall, LKE, database). All three now emit identically shaped lifecycle messages — target identifier (<type> '<label>' (ID: <id>)), preamble, result, no-op, dry-run, skip, and summary — via a shared output.py module. No more per-deployment-type phrasing drift.
    • Remove, dry-run, and no-op paths in the firewall flow now also flow through the shared formatters and honour --quiet, so automated scripts get no output when they ask for none.
    • Public IP detection is process-cached via lru_cache, so a single run hits api.ipify.org exactly once across the firewall, LKE, and database paths instead of three times.
  • Dependency & Build Updates:
    • Upgraded certifi 2026.2.25 → 2026.4.22 and idna 3.11 → 3.13.
    • Relaxed setuptools-scm build requirement to >=9.2.2 to keep up with upstream and unblock Python 3.14 build environments.
  • Tests:
    • Total test count is now 172, up from 110. New modules: tests/test_databases.py (27 tests covering listing, allow_list mutation, orchestrator failure isolation, VPC skip) and tests/test_output.py (19 tests covering every shared formatter). Existing CLI and firewall test classes were extended for the new flags and shared output behaviour.

2026-04-18 - v0.3.1

  • New Features:
    • LKE/LKE-E Control Plane ACL updates now run by default alongside firewall rule updates — no separate invocation needed. Pass --no-lke to opt out, or keep --lke for LKE-only runs.
    • acc-fwu now prints the saved firewall (ID + label) it's operating on whenever configuration is loaded from ~/.acc-fwu-config, so you can see exactly which firewall is being touched.
    • --list tables (both firewalls and LKE clusters) now auto-size each column to its widest value, so long names like resilio-sync-jumpbox-fw-e4e83e29 no longer break alignment.
  • Dependency & Build Updates:
    • Upgraded requests 2.32.5 → 2.33.1 (addresses CVE-2026-25645, insecure temp file reuse in extract_zipped_paths).
    • Upgraded certifi to 2026.2.25 and charset-normalizer to 3.4.7.
    • Moved setuptools_scm to pyproject.toml build-system.requires so PEP 517 build isolation handles it, fixing the vcs_versioning import failure seen on Python 3.14 + setuptools 82.

2026-04-17 - v0.3.0

  • New Features:
    • Added --lke flag to automate Linode Kubernetes Engine (LKE) and LKE-Enterprise (LKE-E) Control Plane ACL updates. Combined with the existing flags: --lke adds your public IP to every cluster's ACL, --lke --remove removes it, --lke --list enumerates clusters, and --lke --dry-run previews the change set.
  • Improvements:
    • ACL updates preserve each cluster's existing enabled state and IPv6 entries, only mutating the IPv4 list.
    • Per-cluster failures (HTTP errors fetching or updating an ACL) are reported and counted without aborting the overall run.

2026-02-19 - v0.2.2

  • Bug Fixes:
    • Fixed list_firewalls() only returning the first page of results - users with many firewalls would see incomplete lists in both --list output and interactive selection. All pages are now fetched.
  • Improvements:
    • Extracted LINODE_API_PAGE_SIZE constant for the API page size value
    • Refactored code to reduce cognitive complexity: extracted helper functions in cli.py and firewall.py, added CONTENT_TYPE_JSON constant, simplified regex patterns

2026-01-05 - v0.2.1

  • Bug Fixes:
    • Fixed select_firewall() hanging in quiet mode - now raises an error immediately with guidance to configure firewall_id first
    • Quiet mode (--quiet) now properly fails fast in non-interactive environments (e.g., cron jobs) when no configuration exists

2026-01-02 - v0.2.0

  • New Features:
    • Added --list / -l flag to list available firewalls from your Linode account
    • Added --add / -a flag to append IP addresses to existing rules instead of replacing (useful when traveling between multiple locations)
    • Added interactive firewall selection when no firewall_id is configured
  • Improvements:
    • When running without a config file, the tool now prompts you to select from available firewalls
    • Better handling of multiple IP addresses per rule

2025-11-21 - v0.1.5

  • New Features:
    • Added --version / -v flag to display installed version
    • Added --dry-run flag to preview changes without applying them
    • Added --quiet / -q flag to suppress output for cron/scripting
  • Security Improvements:
    • Added input validation for firewall_id (numeric only)
    • Added input validation for labels (alphanumeric, underscores, hyphens, max 32 chars)
    • Added IP address validation
    • Configuration file now created with secure permissions (600)
  • Usability Improvements:
    • Proper exit codes (0 for success, 1 for errors)
    • Error messages now output to stderr
    • Improved help text with usage examples

2025-06-03 - v0.1.4

  • Security Fixes: Updated Python dependencies to resolve security vulnerabilities.

2024-10-01 - v0.1.3

  • Show IP Address: Now shows the current public IP address when it is updated.

2024-08-20 - v0.1.2

  • Fixes: Fixed issue with updating the firewall rule.

2024-08-18 - v0.1.1

  • Remove Firewall Rules: Instructions on how to remove the firewall rule.

2024-08-17 - v0.1.0

  • First-time Setup: Instructions on how to set the firewall_id and label the first time you use the tool.
  • Subsequent Usage: Information about running the tool without additional arguments after the initial setup.
  • Updating the Configuration: Guidance on how to change the stored firewall_id and label if needed.
  • Configuration File: Brief explanation of the config file and its location.

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

acc_fwu-0.4.0.tar.gz (67.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

acc_fwu-0.4.0-py3-none-any.whl (35.2 kB view details)

Uploaded Python 3

File details

Details for the file acc_fwu-0.4.0.tar.gz.

File metadata

  • Download URL: acc_fwu-0.4.0.tar.gz
  • Upload date:
  • Size: 67.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for acc_fwu-0.4.0.tar.gz
Algorithm Hash digest
SHA256 91c8a15f78c6468341dd16267d704c770b88b590a781bf8469c9c869cac66f25
MD5 94288fb59245d5214a2671cb19c92f17
BLAKE2b-256 bf680d60b3c9027df98df2b91e1ded4e4e5db221d47aa06c7f30b59242d5cb0f

See more details on using hashes here.

Provenance

The following attestation bundles were made for acc_fwu-0.4.0.tar.gz:

Publisher: python-app.yml on johnybradshaw/acc-firewall_updater

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file acc_fwu-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: acc_fwu-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 35.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for acc_fwu-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 318fe6d2165baa394b724546145a21d46b580418bae7413a02d4dbfdf33f36c9
MD5 024c2b12f80a29de13ef1d9683982f37
BLAKE2b-256 888024d919fdd7817e244f9a9d1a6ec77c4fb802d3ebee3d2022ee89a7a6cc77

See more details on using hashes here.

Provenance

The following attestation bundles were made for acc_fwu-0.4.0-py3-none-any.whl:

Publisher: python-app.yml on johnybradshaw/acc-firewall_updater

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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