mercadolibre/assimilator

Name: assimilator

Owner: MercadoLibre

Description: A Restful JSON API that controls policies and routes from different firewall brands.

Created: 2017-09-11 17:40:09.0

Updated: 2018-05-14 12:17:42.0

Pushed: 2018-05-14 12:17:41.0

Homepage:

Size: 141

Language: Python

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Assimilator

The first restful API to control all firewall brands. Configure any firewall with restful API calls, no more manual rule configuration. Centralize all your firewalls into one API.

Multiplatform

• [x] Palo Alto
• [x] Juniper
• [ ] Cisco
• [ ] Fortinet
• [ ] Checkpoint
• [ ] PfSense
• [ ] AWS

Authentication

• API key through HTTP headers.
• Flexible authorization, allow certain URI path with certain HTTP methods.

JSON

• All request/response body are in JSON. No more XML, plain text or custom responses.

Python

• Fully scripted in Python Flask.
• Easy to update and add new modules.
• Ready for any automatic task.

Open Source

• No more Panorama, CSM or NSM.
• Integrates with Apache2 with mod WSGI.
• Assimilator gives a full RESTful experience for free.

How it works

All firewalls share a common ground on their configuration, for example:

• List of commands showing the actual configuration (AKA the running configuration).
• Rules or policies filtering IP packets.
• Objects:
  • Addresses (i.e. 10.1.1.1 <-> Administration_Server).
  • Address group (i.e. Administration_Farm <-> [ Administration_Server01 , Administration_Server02 ]).
  • Port or service (i.e. TCP/80 <-> http).
  • Port or service group (i.e. Application_ports <-> { TCP/6600 , TCP/6610 }).
• Interfaces.
• Zones.
• Routing table.
• PBR (policy based route).

Assimilator makes it possible to configure via the five RESTful methods all these portions of configuration with JSON objects:

• GET: Show the object.
• POST: Add new object.
• PATCH: Append new data to object.
• PUT: Replace data in object.
• DELETE: Remove object from configuration.

URL Format

/api/site/resource

Example

est: GET /api/headquarters/config

onse: HTTP 200
nfig" : "<...>"}

est: POST /api/branch/rules
me" : "Test01", "from" : "trust", "to" : "untrust",
rce" : "10.1.1.1", "destination" : "8.8.8.8", "action" : "allow",
lication" : "junos-dns-udp"}
onse: HTTP 201

est: DELETE /api/branch1/rules
me" : "Permit Any"}
onse: HTTP 200


est: PUT /api/branch2/objects/address-group
me" : "Admin_Servers", "members" : [ "Server02" ] }
onse: HTTP 200


est: PATCH /api/paloalto/headquarters/route
me" : "internal", "destination" : "10.0.0.0/8", "next-hop" : "172.16.1.2" }
onse: HTTP 200

Installation

With Docker (recommended):

opt
clone https://github.com/mercadolibre/assimilator && cd assimilator
nerate_certificate.sh
er build -t assimilator /opt/assimilator/
er run -d -p 443:443/tcp assimilator

Without Docker:

opt
clone https://github.com/mercadolibre/assimilator && cd assimilator
nerate_certificate.sh
 ./install.sh

Documentation

Read the documentation.