acc-fwu 0.2.3

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

acc-firewall_updater

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

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 - Apply your current IP to every LKE and LKE-E cluster's Control Plane ACL with a single command

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. Update the firewall rule with your current public IP address.

Command-Line Options

usage: acc-fwu [-h] [--firewall_id FIREWALL_ID] [--label LABEL] [-d] [-r] [-a] [-l] [--lke] [-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) and exit.
  --lke                 Target LKE/LKE-E Control Plane ACLs instead of firewall rules.
                        Adds (or removes with -r) your current public IP to every cluster's ACL.
  -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

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

List all LKE / LKE-E clusters:

acc-fwu --lke --list

Add your current IP to every cluster's Control Plane ACL (idempotent):

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 LKE ACLs every 15 minutes
*/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.

Cron Job Example

To automatically update your firewall rules every hour:

# Update firewall rules every hour
0 * * * * /usr/local/bin/acc-fwu --quiet

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-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.