Skip to main content

Performs static analysis on network device configuration files.

Project description

Note: Still in active development and potentially subject to major changes - keep this in mind when using this.

Netlint

Build workflog Documentation Status

Performs static analysis on network device configuration files.

Linters have long since been a standard way of assessing code quality in the software development world. This project aims to take that idea and apply it to the world of network device configuration files.

Find the latest copy of the documentation here.

Potential uses of this tool are

  • Linting network device configurations generated in CI/CD automation pipelines
  • Assistance when building out new configurations for both traditional and automated deployment
  • Basic security auditing of configuration files

Example usage

Below is an example of how to use this based on one of the faulty test configurations (executed from the project root):

$  netlint --nos cisco_ios tests/cisco_ios/configurations/faulty.conf
IOS101 Plaintext user passwords in configuration.
-> username test password ing
IOS102 HTTP server not disabled
-> ip http server
-> ip http secure-server
IOS103 Console line unauthenticated
-> line con 0

Installation

There are multiple ways of installing this software.

A package is available on PyPI, therefore you can simply install with pip install netlint and then simply run netlint.

If you prefer to install directly from GitHub, here is how you would go about that.

$ git clone https://github.com/Kircheneer/netlint.git
$ cd netlint
$ pip install .
$ netlint --help
Usage: netlint [OPTIONS] COMMAND [ARGS]...

  Lint network device configuration files.

  [...]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netlint-0.1.2.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

netlint-0.1.2-py3-none-any.whl (37.9 kB view details)

Uploaded Python 3

File details

Details for the file netlint-0.1.2.tar.gz.

File metadata

  • Download URL: netlint-0.1.2.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.5 CPython/3.9.2 Windows/10

File hashes

Hashes for netlint-0.1.2.tar.gz
Algorithm Hash digest
SHA256 c6b711ac2982c6d975d705c57e01d9dc926b4be7ec2e1d5f11604fa63ef49665
MD5 319162bacb7335f754dc944c8a1f5453
BLAKE2b-256 d680d76cf0ea25b300bb439d5a16ec9e5256699f191ced8810d58e2c4a02b9b1

See more details on using hashes here.

File details

Details for the file netlint-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: netlint-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 37.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.5 CPython/3.9.2 Windows/10

File hashes

Hashes for netlint-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 26bcc862be7473ac8b39ed983b0b49a8cc2d5b537da3465b72f44d71509c46e6
MD5 d6e337b12266222abd26af92957b07af
BLAKE2b-256 93500cf9935bbeacefe22fcff0d573fdd84ad3943c94b27e940f25461a1aff61

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page