aerleon

Aerleon

Generate firewall configs for multiple firewall platforms from a single platform-agnostic configuration language through a command line tool and Python API.

Aerleon is a fork of Capirca with the following major additions:

• YAML policy and network definition files and pol2yaml, a converter from Capirca policy DSL to YAML.
• Network definitions with FQDN data.
• New firewall platforms can be added through plugins.
• Typed Python APIs for ACL generation and aclcheck queries.
• A SLSA-compatible verifiable release process.
• A detailed regression test suite.
• Many bug fixes and performance enhancements.

Prerequisites

Aerleon requires Python 3.10 or higher.

Installation Steps

You can install Aerleon using one of the following package managers:

Option 1: pip (Python Package Index)

Install Aerleon using pip:

pip install aerleon

Option 2: Homebrew (macOS/Linux)

Install Aerleon using Homebrew:

brew install aerleon

Overview

Aerleon provides a command line tool and a Python API to generate configs for multiple firewall platforms from a single platform-agnostic configuration language. Supported platforms include Cisco, Juniper, Palo Alto Networks, and many others.

A getting started guide is available to walk through the basics of using Aerleon.

Documentation

Full documentation can be found at https://aerleon.readthedocs.io/en/latest/.

Contributing

Contributions are welcome. Please review the contributing guidelines and code of conduct.

Contact

Official Communication Channels

• Issues: GitHub Issues.
• Discussions: GitHub Discussions.
• Community Chat: Slack Server.

Maintainers

• Rob Ankeny (ankenyr@gmail.com)
• Jason Benterou (jason.benterou@gmail.com)

Version History

Refer to the changelog for version updates.

Resources

• Getting Started Guide
• Blog Post: Safe ACL Change through Model-based Analysis
• Aerleon Slack

Credits

Files and code included in this project from Capirca are copyright Google and are included under the terms of the Apache License, Version 2.0. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Contributors who wish to modify files bearing a copyright notice are obligated by the terms of the Apache License, Version 2.0 to include at the top of the file a prominent notice stating as much. Copyright notices must not be removed from files in this repository.

This README file and other documentation files may contain phrases and sections that are copyright Google. This file and other documentation files are modified from the original by the Aerleon Project Team.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!