py-a1-router 0.1.0__tar.gz

py_a1_router-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/py-a1-router
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-tags: true
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.x"
+        
+      - name: Install build
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

py_a1_router-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+*.egg-info/
+dist/
+build/
+__pycache__/
+.venv/
+env/

py_a1_router-0.1.0/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: py-a1-router
+Version: 0.1.0
+Summary: A configuration wrapper for A1 routers
+Requires-Dist: requests
+Requires-Dist: pycryptodome

py_a1_router-0.1.0/README.md

@@ -0,0 +1,3 @@
+# A1 Router Wrapper Python Package
+
+documentation coming soon...

py_a1_router-0.1.0/pyproject.toml

@@ -0,0 +1,17 @@
+[build-system]
+requires = ["setuptools >= 84.0.0", "setuptools_scm >= 10.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "py-a1-router"
+dynamic = ["version"]
+description = "A configuration wrapper for A1 routers"
+dependencies = [
+    "requests",
+    "pycryptodome"
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools_scm]

py_a1_router-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

py_a1_router-0.1.0/src/a1_router/__init__.py

@@ -0,0 +1,3 @@
+from .router import Router
+
+__all__ = ["Router"]

py_a1_router-0.1.0/src/a1_router/core/base.py

@@ -0,0 +1,8 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ..router import Router
+
+class BaseModule:
+    def __init__(self, router: "Router"):
+        self._router = router

py_a1_router-0.1.0/src/a1_router/core/crypto.py

@@ -0,0 +1,31 @@
+import os, json, base64
+from Crypto.Cipher import AES, PKCS1_v1_5
+from Crypto.Util.Padding import pad, unpad
+
+def encrypt_payload(payload: dict, aes_key_bytes: bytes, b64_aes_key: str, rsa_key) -> dict:
+    iv_bytes = os.urandom(16)
+    b64_iv = base64.b64encode(iv_bytes).decode("utf-8")
+    plaintext = json.dumps(payload).encode("utf-8")
+    
+    cipher_aes = AES.new(aes_key_bytes, AES.MODE_CBC, iv_bytes)
+    ciphertext_bytes = cipher_aes.encrypt(pad(plaintext, AES.block_size))
+    b64_content = base64.b64encode(ciphertext_bytes).decode("utf-8")
+    
+    cipher_rsa = PKCS1_v1_5.new(rsa_key)
+    enc_aes_key = cipher_rsa.encrypt(b64_aes_key.encode("utf-8"))
+    b64_rsa_key = base64.b64encode(enc_aes_key).decode("utf-8")
+    
+    return {
+        "content": b64_content,
+        "key": b64_rsa_key,
+        "iv": b64_iv
+    }
+
+def decrypt_response(json_response: dict, aes_key_bytes: bytes) -> dict:
+    iv_bytes = base64.b64decode(json_response["iv"])[:16]
+    ciphertext_bytes = base64.b64decode(json_response["content"])
+    
+    cipher = AES.new(aes_key_bytes, AES.MODE_CBC, iv_bytes)
+    plaintext_bytes = unpad(cipher.decrypt(ciphertext_bytes), AES.block_size)
+    
+    return json.loads(plaintext_bytes.decode("utf-8"))

py_a1_router-0.1.0/src/a1_router/nat/__init__.py

@@ -0,0 +1,3 @@
+from .manager import NATManager
+
+__all__ = ["NATManager"]

py_a1_router-0.1.0/src/a1_router/nat/manager.py

@@ -0,0 +1,13 @@
+from typing import TYPE_CHECKING
+from .port_forwarding import PortForwarding
+
+if TYPE_CHECKING:
+    from ..router import Router
+
+class NATManager:
+    def __init__(self, router: "Router"):
+        self._router = router
+        self.port_forwarding = PortForwarding(router)
+        # Future domain additions:
+        # self.dmz = DMZ(router)
+        # self.triggering = PortTriggering(router)

py_a1_router-0.1.0/src/a1_router/nat/port_forwarding.py

@@ -0,0 +1,83 @@
+from typing import Literal
+
+from ..core.base import BaseModule
+
+class PortForwarding(BaseModule):
+    def get_all(self):
+        return self._router._encrypted_request("GET", "/cgi-bin/DAL?oid=nat")
+    
+    def get_one(self, index: int):
+        try:
+            index = int(index)
+        except (ValueError, TypeError):
+            raise ValueError("[nat.port_forwarding.get_one] Index must be int")
+        return self._router._encrypted_request("GET", f"/cgi-bin/DAL?oid=nat&DalGetOneObject=y&Index={index}")
+
+    def add(
+        self,
+        active: bool,
+        name: str,
+        external_port_start: int,
+        external_port_end: int,
+        internal_port_start: int,
+        internal_port_end: int,
+        internal_client_ip: str,
+        protocol: Literal["TCP", "UDP", "ALL"] = "TCP",
+        originating_ip: str = ""
+    ):
+        wan_ip = self._router.network.wan.get_ip()
+        rule = {
+            "Index": 0,
+            "referenceIndex": -1,
+            "Enable": active,
+            "Protocol": protocol,
+            "Description": name,
+            "Interface": "",
+            "ExternalPortStart": external_port_start,
+            "ExternalPortEnd": external_port_end,
+            "InternalPortStart": internal_port_start,
+            "InternalPortEnd": internal_port_end,
+            "InternalClient": internal_client_ip,
+            "SetOriginatingIP": bool(originating_ip),
+            "OriginatingIpAddress": originating_ip,
+            "WANIP": wan_ip,
+            "X_ZYXEL_AutoDetectWanStatus": True
+        }
+        return self._router._encrypted_request("POST", "/cgi-bin/DAL?oid=nat", rule)
+    
+    def delete(self, index: int):
+        try:
+            index = int(index)
+        except (ValueError, TypeError):
+            raise ValueError("[nat.port_forwarding.delete] Index must be int")
+        return self._router._encrypted_request("DELETE", f"/cgi-bin/DAL?oid=nat&Index={index}")
+
+    def edit(
+        self,
+        index: int,
+        active: bool,
+        name: str,
+        external_port_start: int,
+        external_port_end: int,
+        internal_port_start: int,
+        internal_port_end: int,
+        internal_client_ip: str,
+        protocol: Literal["TCP", "UDP", "ALL"] = "TCP",
+        originating_ip: str = ""
+    ):
+        rule = {
+            "Index": index,
+            "Enable": active,
+            "Protocol": protocol,
+            "Description": name,
+            "Interface": "",
+            "ExternalPortStart": external_port_start,
+            "ExternalPortEnd": external_port_end,
+            "InternalPortStart": internal_port_start,
+            "InternalPortEnd": internal_port_end,
+            "InternalClient": internal_client_ip,
+            "SetOriginatingIP": bool(originating_ip),
+            "OriginatingIpAddress": originating_ip,
+            "X_ZYXEL_AutoDetectWanStatus": True
+        }
+        return self._router._encrypted_request("PUT", "/cgi-bin/DAL?oid=nat", rule)

py_a1_router-0.1.0/src/a1_router/network/__init__.py

@@ -0,0 +1,3 @@
+from .manager import NetworkManager
+
+__all__ = ["NetworkManager"]

py_a1_router-0.1.0/src/a1_router/network/manager.py

@@ -0,0 +1,10 @@
+from typing import TYPE_CHECKING
+from .wan import WAN
+
+if TYPE_CHECKING:
+    from ..router import Router
+
+class NetworkManager:
+    def __init__(self, router: "Router"):
+        self._router = router
+        self.wan = WAN(router)

py_a1_router-0.1.0/src/a1_router/network/wan.py

@@ -0,0 +1,5 @@
+from ..core.base import BaseModule
+
+class WAN(BaseModule):
+    def get_ip(self) -> str:
+        return self._router._encrypted_request("GET", "/cgi-bin/getDefaultWANIP")

py_a1_router-0.1.0/src/a1_router/router.py

@@ -0,0 +1,88 @@
+import os, json, base64, requests
+from Crypto.PublicKey import RSA
+from typing import Literal
+
+from .core import crypto
+from .network import NetworkManager
+from .nat import NATManager
+
+class Router:
+    def __init__(self, ip: str, username: str, password: str, debug=False):
+        self.ip = ip
+        self.username = username
+        self.password = password
+        self.debug = debug
+        
+        self.session = requests.Session()
+        self.rsa_key = None
+        self.aes_key_bytes = None
+        self.b64_aes_key = None
+        
+        self.network = NetworkManager(self)
+        self.nat = NATManager(self)
+    
+    def _log(self, msg):
+        if self.debug:
+            print(msg)
+    
+    def login(self):
+        self._log("[*] Fetching RSAPublicKey...")
+        response = self.session.get(f"http://{self.ip}/getRSAPublickKey")
+        response.raise_for_status()
+
+        rsa_pub_pem = response.json().get("RSAPublicKey", "")
+
+        if not rsa_pub_pem:
+            raise ConnectionError(f"[status_code {response.status_code}] Unable to fetch RSAPublicKey.")
+        
+        self.rsa_key = RSA.import_key(rsa_pub_pem)
+        self.aes_key_bytes = os.urandom(32)
+        self.b64_aes_key = base64.b64encode(self.aes_key_bytes).decode("utf-8")
+        
+        encoded_password = base64.b64encode(self.password.encode("utf-8")).decode("utf-8")
+        login_payload = {
+            "Input_Account": self.username,
+            "Input_Passwd": encoded_password,
+            "RememberPassword": 0,
+            "SHA512_password": False
+        }
+        
+        response = self._encrypted_request("POST", "/UserLogin", login_payload)
+
+        session_key = response.get("sessionkey")
+        
+        if not session_key:
+            raise PermissionError("Login failed: No session key returned.")
+        
+        self.session.headers.update({
+            "CSRFToken": session_key,
+            "X-Requested-With": "XMLHttpRequest",
+            "Content-Type": "application/json"
+        })
+        
+        self._log(f"\n[*] Cookies: {self.session.cookies.get_dict()}")
+        self._log("[+] Login successful.")
+    
+    def _encrypt_payload(self, payload: dict):
+        return crypto.encrypt_payload(payload, self.aes_key_bytes, self.b64_aes_key, self.rsa_key)
+    
+    def _decrypt_response(self, json_response: dict):
+        return crypto.decrypt_response(json_response, self.aes_key_bytes)
+
+    def _encrypted_request(self, method: Literal["GET", "POST", "PUT", "DELETE"], location: str, payload: dict = None):
+        url = f"http://{self.ip}{location}"
+        
+        encrypted_payload = self._encrypt_payload(payload) if payload is not None else None
+        
+        response = self.session.request(method, url, json=encrypted_payload)
+        response.raise_for_status()
+        
+        decrypted_response = self._decrypt_response(response.json())
+        
+        if decrypted_response.get("result") != "ZCFG_SUCCESS":
+            raise RuntimeError(f"Router rejected request: {decrypted_response}")
+
+        self._log(f"\n[*] {method} {location}")
+        self._log(json.dumps(decrypted_response, indent=4))
+        
+        return decrypted_response

py_a1_router-0.1.0/src/py_a1_router.egg-info/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: py-a1-router
+Version: 0.1.0
+Summary: A configuration wrapper for A1 routers
+Requires-Dist: requests
+Requires-Dist: pycryptodome

py_a1_router-0.1.0/src/py_a1_router.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+.gitignore
+README.md
+pyproject.toml
+.github/workflows/publish.yml
+src/a1_router/__init__.py
+src/a1_router/router.py
+src/a1_router/core/base.py
+src/a1_router/core/crypto.py
+src/a1_router/nat/__init__.py
+src/a1_router/nat/manager.py
+src/a1_router/nat/port_forwarding.py
+src/a1_router/network/__init__.py
+src/a1_router/network/manager.py
+src/a1_router/network/wan.py
+src/py_a1_router.egg-info/PKG-INFO
+src/py_a1_router.egg-info/SOURCES.txt
+src/py_a1_router.egg-info/dependency_links.txt
+src/py_a1_router.egg-info/requires.txt
+src/py_a1_router.egg-info/scm_file_list.json
+src/py_a1_router.egg-info/scm_version.json
+src/py_a1_router.egg-info/top_level.txt

py_a1_router-0.1.0/src/py_a1_router.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

py_a1_router-0.1.0/src/py_a1_router.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests
+pycryptodome

py_a1_router-0.1.0/src/py_a1_router.egg-info/scm_file_list.json

@@ -0,0 +1,18 @@
+{
+  "files": [
+    ".github/workflows/publish.yml",
+    ".gitignore",
+    "README.md",
+    "pyproject.toml",
+    "src/a1_router/__init__.py",
+    "src/a1_router/core/base.py",
+    "src/a1_router/core/crypto.py",
+    "src/a1_router/nat/__init__.py",
+    "src/a1_router/nat/manager.py",
+    "src/a1_router/nat/port_forwarding.py",
+    "src/a1_router/network/__init__.py",
+    "src/a1_router/network/manager.py",
+    "src/a1_router/network/wan.py",
+    "src/a1_router/router.py"
+  ]
+}

py_a1_router-0.1.0/src/py_a1_router.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.1.0",
+  "distance": 0,
+  "node": "gafcc989b64b69cb6c879777805224e7e7566b613",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-08-25"
+}

py_a1_router-0.1.0/src/py_a1_router.egg-info/top_level.txt

@@ -0,0 +1 @@
+a1_router