pynipper-ng
pynipper-ng copied to clipboard
syn-4ck
Configuration security analyzer for network devices. Pynipper-ng is an evolution of nipper-ng, updated and translated to python. [ALPHA version]
pynipper-ng 🔧
Repository stats:
This project passes:
✔️ Snyk code & open-source ✔️ SonarCloud ✔️ Trivy ✔️ GitGuardian ✔️ CodeQL ✔️ Flake8
What is pynipper-ng? ❔
pynipper-ng is a configuration security analyzer for network devices. The goal of this tool is check the vulnerabilities and misconfigurations of routers, firewalls and switches reporting the issues in a simple way.
This tool is based on nipper-ng, updated and translated to Python. The project wants to improve the set of rules that detect security misconfigurations of the network devices using multiple standard benchmarks (like CIS Benchmark) and integrate the tool with APIs (like PSIRT Cisco API) to scan known vulnerabilities.
- Official documentation: https://pynipper-ng.readthedocs.io/
Install 🧰
If you want to install the tool, please review the installation docs.
Available using Python and Docker!
Quickstart and options 💻
pynipper-ng -d IOS_ROUTER -i tests\test_data\cisco_ios_example.conf -o HTML -f ./report.html -x
Options ☑️
| Flag | OPTION | DESCRIPTION | MANDATORY? | DEFAULT VALUE |
|---|---|---|---|---|
| -h | --help | Display a help message | NO | N/A |
| -d | --device | Device type to analyze (1) | YES | |
| -i | --input | Configuration device file to analyze (file contains standard output redirection of show configuration command) |
YES | |
| -o | --output-type | Report type (HTML or JSON) | NO | HTML |
| -f | --output-filename | Report filename | NO | report.html |
| -x | --offline | Disable APIs integration | NO | True |
| -c | --configuration | Configuration file to pynipper-ng (2) | NO | default.conf |
(1) Check here the devices supported
(2) Check Pynipper-ng configuration file to know more about it.
Pynipper-ng Configuration File 📂
The configuration file is used to define some properties and customize the scans.
Pynipper-ng Configuration File: PSIRT Cisco API 📁
To use the PSIRT Cisco API you must provide the API keys. To get it: https://apiconsole.cisco.com/
[Cisco]
CLIENT_ID = <your-client-id>
CLIENT_SECRET = <your-client-secret-token>
Contributing 👪
Contribution are welcome! Please follow the steps defined in CONTRIBUTING file and share your improvements with the community.
CISCO IOS API integration 🗺️
Get your credentials and put into the configuration file.
Pynipper plugins 🏗️
Pynipper-ng detects device configuration weaknesses based on plugins. Pynipper plugins checks into the network device configuration with regex if a property is set or not, and report it when this is not secure.
Implements your plugins 🖱️
You can implements your own plugins. You should clone the repository and create the plugins in src/analyze/cisco/<device_type>/plugins. To improve the pynipper-ng tool you can contribute adding your work :).
To create your own plugins, follow this guidelines
Security and Quality
This project passes:
✔️ Snyk code & open-source ✔️ SonarCloud ✔️ Trivy ✔️ GitGuardian ✔️ CodeQL ✔️ Flake8
syn-4ck