Batfish is a network configuration analysis tool that can find bugs and guarantee the correctness of (planned or current) network configurations. It enables network engineers to rapidly and safely evolve their network, without fear of outages or security breaches.
Java ANTLR Shell
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

NEW: Stay in touch via Slack: Join

What is Batfish?

Batfish is a network configuration analysis tool that can find bugs and guarantee the correctness of (planned or current) network configurations. It enables network engineers to rapidly and safely evolve their network, without fear of outages or security breaches.

Batfish does not require access to network devices. It only needs offline configuration files, e.g., pulled from RANCID or template authoring tools.

The developers of Batfish include folks from Intentionet, University of California Los Angeles, University of Southern California, and Microsoft Research. See www.batfish.org for technical information on how it works.

What kinds of correctness checks does Batfish support?

Batfish supports many types of correctness checks, including

  1. Compliance and best-practices guidelines, e.g.:
  • Flag undefined-but-referenced or defined-but-unreferenced structures (e.g., ACLs, route maps)
  • Ensure that all interface MTUs are per the network's standard
  • AAA, SNMP, and NTP configuration is correct
  • Devices can only be accessed using SSHv2 and password is not null
  • Logging is on
  1. Consistency of configuration across two or more devices, e.g.:
  • BGP sessions are compatibly configured across neighbors
  • IPSec/VPN tunnels compatibly configured with the same key
  • All interface IP addresses are unique
  • Identically-named structures (e.g., ACLs, route maps) across devices have identical functionality
  1. Checks on data flow, e.g.:
  • Path (shape) between two devices is as expected (e.g., traverses a firewall, valley-free routing)
  • Number of paths between two devices is as expected (i.e., correct multi-path configuration)
  • Paths for two devices inside the data center never leaves the data center
  • Certain services (e.g., DNS) are globally reachable and not blocked by any ACL in the network
  • Certain sensitive services can be reached only from specific subnets or devices
  • All pairs of top-of-rack switches can reach each other
  1. Fault-tolerance, e.g.:
  • End-to-end reachability is not impacted for any flow after any single-link or -device failure
  • Traffic correctly fails over after a failure
  1. "Differential" analysis of two sets of configuration, e.g.:
  • End-to-end reachability is identical across new and old configurations
  • Planned ACL changes have no collateral damage, e.g., relative to the current configuration, only flows that are intended to be (un)blocked are (un)blocked; no other flow is impacted.
  • Two configurations, potentially from different vendors, are semantically equivalent

These checks are performed by asking questions about configurations. See here for the list of questions.

How do I get started?

If you are a DIYer, go to Batfish Wiki

Batfish is being maintained and released as a commercial product by Intentionet. If you'd like a hosted service, drop a line to info@intentionet.com.

What configuration formats does Batfish support?

Batfish supports configurations for a large and growing set of (physical and virtual) devices, including:

  • Arista
  • Aruba
  • AWS VPCs
  • Cisco (Nexus, IOS, IOS-XR, ASA)
  • Dell Force10
  • Foundry
  • iptables (on hosts)
  • Juniper (JunOS, SRX)
  • MRV
  • Quagga
  • Quanta
  • VyOS

If you'd like support for additional vendors or currently-unsupported configuration features, file feature requests or bug reports using the GitHub issue tracker and we'll try to fix. Or, you can -- we welcome pull requests! :)