diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..d51d9fa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** + - OS: [e.g. Debian Bullseye, CentOS 7, ...] + - Python Version [e.g. 3.6, 3.9, ...] + - PVE Version [e.g. 6.5, 7.1-8, ...] +- Monitoring Tool [e.g. Icinga2, Nagios, ...] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..c33ab80 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,29 @@ +on: [push, pull_request] +name: Linter + +jobs: + build: + if: + github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: "*" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install black ruff + + - name: Check styling with black + run: | + black --check *.py + + - name: Run ruff linter + run: | + ruff check *.py diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..41dd9eb --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..97792e9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,120 @@ + +# Contributing to check_opnsense + +First off, thanks for taking the time to contribute! ❤️ + +All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 + +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: +> - Star the project +> - Tweet about it +> - Refer this project in your project's readme +> - Mention the project at local meetups and tell your friends/colleagues + + +## Table of Contents + +- [I Have a Question](#i-have-a-question) +- [I Want To Contribute](#i-want-to-contribute) +- [Reporting Bugs](#reporting-bugs) +- [Suggesting Enhancements](#suggesting-enhancements) +- [Your First Code Contribution](#your-first-code-contribution) +- [Improving The Documentation](#improving-the-documentation) +- [Styleguides](#styleguides) +- [Commit Messages](#commit-messages) +- [Join The Project Team](#join-the-project-team) + + + +## I Have a Question + +> If you want to ask a question, we assume that you have read the available [Documentation](). + +Before you ask a question, it is best to search for existing [Issues](https://github.com/nbuchwitz/check_opnsense/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. + +If you then still feel the need to ask a question and need clarification, we recommend the following: + +- Open an [Issue](https://github.com/nbuchwitz/check_opnsense/issues/new). +- Provide as much context as you can about what you're running into. +- Provide project and platform versions (Python, os, icinga or other monitoring tool version etc), depending on what seems relevant. + +We will then take care of the issue as soon as possible. + +## I Want To Contribute + +> ### Legal Notice +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. + +### Reporting Bugs + + +#### Before Submitting a Bug Report + +A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. + +- Make sure that you are using the latest version. +- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [README](README.md). +- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/nbuchwitz/check_opnsense/issues?q=label%3Abug). +- Also make sure to search the internet to see if users outside of the GitHub community have discussed the issue. +- Collect information about the bug: +- Stack trace (Traceback) +- OS, Platform and Version (*BSD, Linux, x86, ARM) +- Version of the Python interpreter, icinga or monitoring tool version, depending on what seems relevant. +- Possibly your input and the output +- Can you reliably reproduce the issue? And can you also reproduce it with older versions? + + +#### How Do I Submit a Good Bug Report? + +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to . + +We use GitHub issues to track bugs and errors. If you run into an issue with the project: + +- Open an [Issue](https://github.com/nbuchwitz/check_opnsense/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) +- Explain the behavior you would expect and the actual behavior. +- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. +- Provide the information you collected in the previous section. + +Once it's filed, We will label the issue accordingly and try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, we will ask you for additional details. + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for check_opnsense, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. + + +#### Before Submitting an Enhancement + +- Make sure that you are using the latest version. +- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration. +- Perform a [search](https://github.com/nbuchwitz/check_opnsense/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. +- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. + + +#### How Do I Submit a Good Enhancement Suggestion? + +Enhancement suggestions are tracked as [GitHub issues](https://github.com/nbuchwitz/check_opnsense/issues). + +- Use a **clear and descriptive title** for the issue to identify the suggestion. +- Provide a **step-by-step description of the suggested enhancement** in as many details as possible. +- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. +- **Explain why this enhancement would be useful** to most check_opnsense users. You may also want to point out the other projects that solved it better and which could serve as inspiration. + +### Your First Code Contribution +1. Fork the repository and create a feature branch (eg. `git checkout -b my-feature`) +2. Make the changes in the code base +3. Update README.if if needed +4. Commit the changes. Keep in mind to break functionality into logical chunks, representet by one commit each. Also don't forget about the [format of the commit message](#commit-messages) and the [Developer Certificate of Origin (DCO)](https://wiki.linuxfoundation.org/dco) +5. Push your feature branch to your fork and open merge request + +## Styleguides +### Commit Messages + +The project commit messages are usually written according to the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) format. + +### Code Style + +The Python source code files are formatted with [black](https://github.com/psf/black). + + +## Attribution +This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)! diff --git a/README.md b/README.md index d45d624..625c134 100644 --- a/README.md +++ b/README.md @@ -10,17 +10,17 @@ This check command depends on the following python modules: **Installation on Debian / Ubuntu** ``` -apt install python-enum34 python-requests +apt install python3 python3-requests ``` -**Installation on Redhat 6 / CentOS 6** +**Installation on Rocky / Alma Linux 9** ``` -yum install python-argparse python-enum34 python34-requests +yum install python3 python3-requests ``` -**Installation on Redhat 7 / CentOS 7** +**Installation on FreeBSD** ``` -yum install python-enum34 python-requests +pkg install python3 py39-requests ``` ## Usage diff --git a/check_opnsense.py b/check_opnsense.py index 2d2cee7..5c4b756 100755 --- a/check_opnsense.py +++ b/check_opnsense.py @@ -23,26 +23,29 @@ # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # ------------------------------------------------------------------------------ -from __future__ import print_function +"""OPNsense monitoring check command for various monitoring systems like Icinga and others.""" + import sys +from typing import Dict, Union try: - from enum import Enum import argparse - import json - import requests - import urllib3 + from enum import Enum + import requests from requests.packages.urllib3.exceptions import InsecureRequestWarning - requests.packages.urllib3.disable_warnings(InsecureRequestWarning) - except ImportError as e: - print("Missing python module: {}".format(e.message)) + print(f"Missing python module: {e.msg}") sys.exit(255) +# Timeout for API requests in seconds +CHECK_API_TIMEOUT = 30 + + +class CheckState(Enum): + """Check return values.""" -class NagiosState(Enum): OK = 0 WARNING = 1 CRITICAL = 2 @@ -50,58 +53,62 @@ class NagiosState(Enum): class CheckOPNsense: - VERSION = '0.1.0' - API_URL = 'https://{}:{}/api/{}' + """Check command for OPNsense.""" - options = {} - perfdata = [] - checkResult = -1 - checkMessage = "" + VERSION = "0.1.0" + API_URL = "https://{host}:{port}/api/{uri}" - def checkOutput(self): - message = self.checkMessage + def check_output(self) -> None: + """Print check command output with perfdata and return code.""" + message = self.check_message if self.perfdata: - message += self.getPerfdata() - - self.output(self.checkResult, message) + message += self.get_perfdata() - def output(self, returnCode, message): - prefix = returnCode.name + self.output(self.check_result, message) - message = '{} - {}'.format(prefix, message) + @staticmethod + def output(rc: CheckState, message: str) -> None: + """Print message to stdout and exit with given return code.""" + prefix = rc.name + print(f"{prefix} - {message}") + sys.exit(rc.value) - print(message) - sys.exit(returnCode.value) + def get_url(self, command: str) -> str: + """Get API url for specific command.""" + return self.API_URL.format(host=self.options.hostname, port=self.options.port, uri=command) - def getURL(self, part): - return self.API_URL.format(self.options.hostname, self.options.port, part) - - def request(self, url, method='get', **kwargs): + def request(self, url: str, method: str = "get", **kwargs: Dict) -> Union[Dict, None]: + """Execute request against OPNsense API and return json data.""" response = None try: - if method == 'post': + if method == "post": response = requests.post( url, verify=not self.options.api_insecure, auth=(self.options.api_key, self.options.api_secret), - data=kwargs.get('data', None), - timeout=5 + data=kwargs.get("data", None), + timeout=CHECK_API_TIMEOUT, ) - elif method == 'get': + elif method == "get": response = requests.get( url, auth=(self.options.api_key, self.options.api_secret), verify=not self.options.api_insecure, - params=kwargs.get('params', None) + params=kwargs.get("params", None), + timeout=CHECK_API_TIMEOUT, ) else: - self.output(NagiosState.CRITICAL, "Unsupport request method: {}".format(method)) + self.output(CheckState.CRITICAL, f"Unsupport request method: {method}") except requests.exceptions.ConnectTimeout: - self.output(NagiosState.UNKNOWN, "Could not connect to OPNsense: Connection timeout") + self.output(CheckState.UNKNOWN, "Could not connect to OPNsense: Connection timeout") except requests.exceptions.SSLError: - self.output(NagiosState.UNKNOWN, "Could not connect to OPNsense: Certificate validation failed") + self.output( + CheckState.UNKNOWN, "Could not connect to OPNsense: Certificate validation failed" + ) except requests.exceptions.ConnectionError: - self.output(NagiosState.UNKNOWN, "Could not connect to OPNsense: Failed to resolve hostname") + self.output( + CheckState.UNKNOWN, "Could not connect to OPNsense: Failed to resolve hostname" + ) if response.ok: return response.json() @@ -113,70 +120,121 @@ def request(self, url, method='get', **kwargs): elif response.status_code == 403: message += "Access denied. Please check if API user has sufficient permissions." else: - message += "HTTP error code was {}".format(response.status_code) + message += f"HTTP error code was {response.status_code}" - self.output(NagiosState.UNKNOWN, message) + self.output(CheckState.UNKNOWN, message) - def check(self): - self.checkResult = NagiosState.OK + def get_perfdata(self) -> str: + """Get perfdata string.""" + perfdata = "" - if self.options.mode == 'updates': - self.checkUpdates() - else: - message = "Check mode '{}' not known".format(self.options.mode) - self.output(NagiosState.UNKNOWN, message) - - self.checkOutput() - - def parseOptions(self): - p = argparse.ArgumentParser(description='Check command OPNsense firewall monitoring') - - api_opts = p.add_argument_group('API Options') + if self.perfdata: + perfdata = "|" + perfdata += " ".join(self.perfdata) - api_opts.add_argument("-H", "--hostname", required=True, help="OPNsense hostname or ip address") - api_opts.add_argument("-p", "--port", required=False, dest='port', help="OPNsense https-api port", default=80) - api_opts.add_argument("--api-key", dest='api_key', required=True, - help="API key (See OPNsense user manager)") - api_opts.add_argument("--api-secret", dest='api_secret', required=True, - help="API key (See OPNsense user manager)") - api_opts.add_argument("-k", "--insecure", dest='api_insecure', action='store_true', default=False, - help="Don't verify HTTPS certificate") + return perfdata - check_opts = p.add_argument_group('Check Options') + def check(self) -> None: + """Execute the real check command.""" + self.check_result = CheckState.OK - check_opts.add_argument("-m", "--mode", - choices=('updates',), - required=True, - help="Mode to use.") - check_opts.add_argument('-w', '--warning', dest='treshold_warning', type=float, - help='Warning treshold for check value') - check_opts.add_argument('-c', '--critical', dest='treshold_critical', type=float, - help='Critical treshold for check value') + if self.options.mode == "updates": + self.check_updates() + else: + message = "Check mode '{}' not known".format(self.options.mode) + self.output(CheckState.UNKNOWN, message) + + self.check_output() + + def parse_args(self) -> None: + """Parse CLI arguments.""" + p = argparse.ArgumentParser(description="Check command OPNsense firewall monitoring") + + api_opts = p.add_argument_group("API Options") + + api_opts.add_argument( + "-H", "--hostname", required=True, help="OPNsense hostname or ip address" + ) + api_opts.add_argument( + "-p", + "--port", + required=False, + dest="port", + help="OPNsense https-api port", + default=443, + type=int, + ) + api_opts.add_argument( + "--api-key", dest="api_key", required=True, help="API key (See OPNsense user manager)" + ) + api_opts.add_argument( + "--api-secret", + dest="api_secret", + required=True, + help="API key (See OPNsense user manager)", + ) + api_opts.add_argument( + "-k", + "--insecure", + dest="api_insecure", + action="store_true", + default=False, + help="Don't verify HTTPS certificate", + ) + + check_opts = p.add_argument_group("Check Options") + + check_opts.add_argument( + "-m", "--mode", choices=("updates",), required=True, help="Mode to use." + ) + check_opts.add_argument( + "-w", + "--warning", + dest="treshold_warning", + type=float, + help="Warning treshold for check value", + ) + check_opts.add_argument( + "-c", + "--critical", + dest="treshold_critical", + type=float, + help="Critical treshold for check value", + ) options = p.parse_args() self.options = options - def checkUpdates(self): - url = self.getURL('core/firmware/status') + def check_updates(self) -> None: + """Check opnsense for system updates.""" + url = self.get_url("core/firmware/status") data = self.request(url) - if data['status'] == 'ok' and data['status_upgrade_action'] == 'all': - count = data['updates'] + if data["status"] == "ok" and data["status_upgrade_action"] == "all": + count = data["updates"] - self.checkResult = NagiosState.WARNING - self.checkMessage = "{} pending updates".format(count) + self.check_result = CheckState.WARNING + self.check_message = "{} pending updates".format(count) - if data['upgrade_needs_reboot']: - self.checkResult = NagiosState.CRITICAL - self.checkMessage = "{}. Subsequent reboot required.".format(self.checkMessage) + if data["upgrade_needs_reboot"]: + self.check_result = CheckState.CRITICAL + self.check_message = "{}. Subsequent reboot required.".format(self.check_message) else: - self.checkMessage = "System up to date" + self.check_message = "System up to date" + + def __init__(self) -> None: + self.options = {} + self.perfdata = [] + self.check_result = CheckState.UNKNOWN + self.check_message = "" - def __init__(self): - self.parseOptions() + self.parse_args() + + if self.options.api_insecure: + # disable urllib3 warning about insecure requests + requests.packages.urllib3.disable_warnings(category=InsecureRequestWarning) opnsense = CheckOPNsense() opnsense.check() - diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..26d8314 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,20 @@ +[tool.black] +line-length = 100 + +[tool.ruff] +line-length = 100 +lint.select = [ + "ANN", # flake8-annotations + "B", # flake8-bugbear + "D", # pydocstyle + "E", # pycodestyle + "F", # Pyflakes + "Q", # flake8-quotes +] +lint.ignore = [ + "ANN101", # missing-type-self + "D107", # undocumented-public-init +] + +[tool.ruff.lint.mccabe] +max-complexity = 10