nightagent 0.0.0__tar.gz

nightagent-0.0.0/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

nightagent-0.0.0/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: nightagent
+Version: 0.0.0
+Summary: Automatically Detect and Repair Common Firewall Issues
+Home-page: https://github.com/gocarta/nightagent
+Download-URL: https://github.com/gocarta/nightagent/tarball/download
+Author: Daniel J. Dufour
+Author-email: daniel.j.dufour@gmail.com
+Keywords: data,python
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: netmiko
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# nightagent
+> Automatically Detect and Repair Common Firewall Issues
+
+## install
+```
+pip install nightagent
+```
+
+## usage (in cli)
+```sh
+> nightagent --device-type paloalto_panos --hostname 192.168.1.1 --username admin monitor
+> password: 
+> secret: 
+```
+

nightagent-0.0.0/README.md

@@ -0,0 +1,15 @@
+# nightagent
+> Automatically Detect and Repair Common Firewall Issues
+
+## install
+```
+pip install nightagent
+```
+
+## usage (in cli)
+```sh
+> nightagent --device-type paloalto_panos --hostname 192.168.1.1 --username admin monitor
+> password: 
+> secret: 
+```
+

nightagent-0.0.0/nightagent/__init__.py

@@ -0,0 +1,205 @@
+# /// script
+# requires-python = ">=3.10"
+# dependencies = [
+#     "netmiko",
+# ]
+# ///
+
+import argparse
+from netmiko import ConnectHandler
+import getpass
+import re
+from time import sleep
+
+
+class NightAgent:
+    def __init__(self, device_type: str, hostname: str, username: str, password: str, secret: str, port: int = 22):
+        self.device_type = device_type
+        self.hostname = hostname
+        self.username = username
+        self.password = password
+        self.secret = secret
+        self.port = port
+        self.connection = None
+
+    def login(self) -> bool:
+        try:
+            self.connection = ConnectHandler(
+                device_type=self.device_type,
+                host=self.hostname,
+                username=self.username,
+                password=self.password,
+                secret=self.secret,                
+            )
+            print("[nightagent] logged in")
+            self.connection.enable()
+            print("[nightagent] entered enable mode")
+            sleep(0.5)
+            self._disable_paging()
+            print("[nightagent] disabled paging")
+            return True
+        except Exception as e:
+            print(f"[nightagent] failed to login: {e}")
+            return False
+
+    def logout(self):
+        if self.connection:
+            try:
+                self.connection.disconnect()
+                print("[nightagent] logged out and closed SSH connection")
+                return True
+            except Exception as e:
+                print(f"[nightagent] exception while attempting to log out: {e}")
+                return False
+        else:
+            print("[nightagent] you are not logged in, so no need to log out")
+            return True
+
+    def _disable_paging(self):
+        if self.device_type in ["arista_eos", "cisco_ios", "cisco_nxos", "cisco_xe", "cisco_xr"]:
+            self.connection.send_command("terminal length 0")
+        elif self.device_type in ["cisco_asa"]:
+            self.connection.send_command("terminal pager 0")
+        # elif self.device_type in ["fortinet"]:
+        #     self.connection.send_command("config system console\nset output standard\nend")
+        elif self.device_type in ["hp_procurve"]:
+            self.connection.send_command("no page")
+        elif self.device_type in ["juniper_junos"]:
+            self.connection.send_command("terminal length 0")
+        elif self.device_type in ["paloalto_panos"]:
+            self.connection.send_command("set cli pager off")
+
+    def _run_command_on_firewall(self, command: str) -> str:
+        if not self.connection:
+            raise RuntimeError("[nightagent] can't run command on firewall because you haven't logged in yet")
+
+        print(f'[nightagent] executing command: "{command}"')
+        output = self.connection.send_command(command)
+        print(f'[nightagent] finished command: "{command}"')
+        return output
+
+    def check_tunnel_health(self) -> bool:
+        if not self.connection:
+            raise Exception("[nightagent] can't check tunnel health because you need to log in first")
+
+        output = self._run_command_on_firewall("show vpn-sessiondb detail l2l")
+
+        # print("[nightagent] show vpn-sessiondb detail l2l:\n", output)
+
+        indicators = {
+            "Rekey Left(D)": r"Rekey Left\(D\): (\d+) K-Bytes",
+            "Bytes Tx": r"Bytes Tx {0,10}: ?([0-9]+)",
+            "Pkts Tx": r"Pkts Tx {0,10}: ?([0-9]+)",
+            "Bytes Rx": r"Bytes Rx {0,10}: ?([0-9]+)",
+            "Pkts Rx": r"Pkts Rx {0,10}: ?([0-9]+)",
+        }
+
+        for name, pattern in indicators.items():
+            matches = re.findall(pattern, output)
+            if not matches:
+                print(f"[WARN] Could not find indicator: {name}")
+                return False
+
+            for match in matches:
+                value = int(match)
+                if value == 0:
+                    print(f"[nightagent] detected unhealthy tunnel because {name} is {value}")
+                    return False
+
+        return True
+
+    def clear_security_associations(self):
+        print("[nightagent] clearing IPsec security associations")
+        self._run_command_on_firewall("clear crypto ipsec sa")
+        print("[nightagent] finished clearing IPsec security associations")
+
+    def monitor(self, recheck_time: int = 15, doublecheck_time: int = 60, ask: bool = False):
+        number_of_exceptions = 0
+        while True:
+            try:
+                print(f"[nightagent] sleeping {recheck_time} seconds")
+                sleep(recheck_time)
+
+                print("[nightagent] logging in")
+                sleep(1)
+                self.login()
+
+
+                print("[nightagent] checking tunnel health")
+                sleep(1)
+                healthy = self.check_tunnel_health()
+                if healthy:
+                    print("[nightagent] tunnel is healthy")
+                    sleep(1)
+                else:
+                    print("[nightagent] tunnel is unhealthy")
+                    sleep(1)
+                    print(f"[nightagent] pausing {doublecheck_time} before double-checking")
+                    sleep(doublecheck_time)
+                    healthy = self.check_tunnel_health()
+                    if healthy is False:
+                        print("[nightagent] tunnel is still unhealthy, so clear security associations")
+                        if ask is False or input("type yes to proceed").lower() in ["y", "yes"]:
+                            self.clear_security_associations()
+                            print("[nightagent] sleeping 5 minutes to let tunnel rebuild before checking again")
+                            sleep(5 * 60)
+
+                sleep(0.5)
+
+                print("[nightagent] logging out")
+                self.logout()
+            except Exception as e:
+                print(e)
+                number_of_exceptions += 1
+
+                if number_of_exceptions >= 3:
+                    print("[nightagent] hit maximum number of exceptions, so returning from monitor")
+                    return False
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="nightagent",
+        description="NightAgent - automatically check and fix firewall issues",
+    )
+
+    parser.add_argument("--device-type", required=False, help="Netmiko device_type (e.g. paloalto_panos)")
+    parser.add_argument("--hostname", required=False, help="Firewall hostname or IP")
+    parser.add_argument("--username", required=False, help="SSH username")
+    parser.add_argument("--password", required=False, help="SSH password")
+    parser.add_argument("--secret", required=False, help="SSH secret")
+    parser.add_argument("--port", type=int, default=22, help="SSH port (default: 22)")
+
+    # Actions
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    monitor = subparsers.add_parser("monitor", help="Continuously monitor tunnel health")
+    monitor.add_argument("--recheck", type=int, default=15, help="Seconds between checks")
+    monitor.add_argument("--doublecheck", type=int, default=60, help="Seconds before re‑check")
+    monitor.add_argument("--ask", action="store_true", help="Ask/prompt before clearing security associations")
+
+    args = parser.parse_args()
+
+    device_type = args.device_type or input("device-type: ")
+    hostname = args.hostname or input("hostname: ").strip()
+    username = args.username or input("username: ").strip()
+    password = args.password or getpass.getpass("password: ")
+    secret = args.secret or getpass.getpass("secret: ")
+
+    agent = NightAgent(
+        device_type=device_type,
+        hostname=hostname,
+        username=username,
+        password=password,
+        secret=secret,
+        port=args.port,
+    )
+
+    if args.command == "monitor":
+        agent.monitor(
+            recheck_time=args.recheck,
+            doublecheck_time=args.doublecheck,
+            ask=args.ask,
+        )
+
+if __name__ == "__main__":
+    main()

nightagent-0.0.0/nightagent.egg-info/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: nightagent
+Version: 0.0.0
+Summary: Automatically Detect and Repair Common Firewall Issues
+Home-page: https://github.com/gocarta/nightagent
+Download-URL: https://github.com/gocarta/nightagent/tarball/download
+Author: Daniel J. Dufour
+Author-email: daniel.j.dufour@gmail.com
+Keywords: data,python
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: netmiko
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# nightagent
+> Automatically Detect and Repair Common Firewall Issues
+
+## install
+```
+pip install nightagent
+```
+
+## usage (in cli)
+```sh
+> nightagent --device-type paloalto_panos --hostname 192.168.1.1 --username admin monitor
+> password: 
+> secret: 
+```
+

nightagent-0.0.0/nightagent.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+setup.cfg
+setup.py
+nightagent/__init__.py
+nightagent.egg-info/PKG-INFO
+nightagent.egg-info/SOURCES.txt
+nightagent.egg-info/dependency_links.txt
+nightagent.egg-info/entry_points.txt
+nightagent.egg-info/requires.txt
+nightagent.egg-info/top_level.txt

nightagent-0.0.0/nightagent.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

nightagent-0.0.0/nightagent.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+nightagent = nightagent.__init__:main

nightagent-0.0.0/nightagent.egg-info/requires.txt

@@ -0,0 +1 @@
+netmiko

nightagent-0.0.0/nightagent.egg-info/top_level.txt

@@ -0,0 +1 @@
+nightagent

nightagent-0.0.0/setup.cfg

@@ -0,0 +1,7 @@
+[metadata]
+description-file = README.md
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

nightagent-0.0.0/setup.py

@@ -0,0 +1,39 @@
+from setuptools import setup
+from os import path
+
+this_directory = path.abspath(path.dirname(__file__))
+
+with open(path.join(this_directory, "README.md")) as f:
+    long_description = f.read()
+
+setup(
+    name="nightagent",
+    packages=["nightagent"],
+    package_dir={"nightagent": "nightagent"},
+    package_data={
+        "nightagent": [
+            "__init__.py",
+        ]
+    },
+    entry_points={
+        'console_scripts': ['nightagent=nightagent.__init__:main'],
+    },    
+    version="0.0.0",
+    description="Automatically Detect and Repair Common Firewall Issues",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="Daniel J. Dufour",
+    author_email="daniel.j.dufour@gmail.com",
+    url="https://github.com/gocarta/nightagent",
+    download_url="https://github.com/gocarta/nightagent/tarball/download",
+    keywords=["data", "python"],
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Programming Language :: Python :: 3",
+        "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
+        "Operating System :: OS Independent",
+    ],
+    install_requires=[
+        "netmiko",
+    ],
+)