Saruman¶

A simply logic, configuration based, distributable and reliable extended-firewall.

Saruman is a extended firewall, meaning:

firewall
dns
dhcp
intruision detection
reverse proxy)

build by a former Iresam. It targets I-Resam need’s first but should be enough flexible to be used elsewhere.

saruman takes care of the boring bits for you.

Here’s an overview of the documentation we have for you. First the documentation on using saruman:

Saruman¶

A simply logic, configuration based, distributable and reliable extended-firewall.

Saruman is a extended firewall (meaning firewall + dns + dhcp +intruision detection + reverse proxy) build by a former Iresam. It targets I-Resam need’s first but should be enough flexible to be used elsewhere.

It still unstable and yet brings not that much. Try at your own risks.

Most important Urls¶

The full documentation is at saruman.readthedocs.org
We are on Pypi so we’re only an pip install saruman away from installation on your computer.
The code is at github.com/tychota/saruman.

And... we’re automatically being tested by Scrutinizer !

Technologies used¶

Saruman does require Python 3, and if possible the newest version (Python3.5 for now)
It does require an Celery broker : take RabbitMQ, it is good, fast and reliable.
It does only works on a recent linux machine : it requires nftables and iproute2 so a linux 4+ kernel would be a necessity.

Available commands¶

Saruman gives you three commands to manage the worker and one to run your firewall. Worker’s commands must be run in root since they manage main parts of your system. Firewall’s one doesn’t need this. The commands are:

saruman workers enable: start the celery workers on the machine.
saruman workers disable: start the celery workers on the machine.
saruman workers reload: restart the celery workers on the machine.
saruman firewall start: start the firewall

AMQP json-rpc api¶

Still infant

Options¶

Command line options¶

These command line options are supported by the release commands (saruman workers enable, saruman workers enable, saruman workers enable, saruman firewall start).

`-v, --verbose`	Run in verbose mode, printing a bit more, mostly only interesting for debugging.
`-h, --help`	Display help text

Assumptions¶

Saruman originated at Iresam so there are some assumptions build-in that might or might not fit you but I’m pretty sure it’ll probably fit :-)

In our case, saruman is run on a VM cluster so we have different VM handling different stuff For instance one for the netfilter firewall and router, one for dhcp, one for reverse proxy, one for admin site, one for AMQP broker so you have to tag the tasks you create so saruman could know which VM has to handle what.

That’s just the style we started with. Pretty clear and useful.

Improving saruman: report bugs, fork on github or email us¶

Did you find a bug? Do you have an improvement? Do you have questions? We run saruman as a proper open source project on github at https://github.com/tychota/saruman, so you have three basic options:

Report bugs or problems at https://github.com/tychota/saruman/issues ! And feature requests too ! Normally you’ll get a quick reply within a day or so, depending on our relative timezones. If you don’t get an answer within a few days, please send off a quick email to remind us.
Or make a fork, fix the bug or add something and open a pull request.

If you are going to fork saruman, take a look at Information for developers of saruman for setup and test running information.
You can mail Tycho Tatitscheff if you want to ask a question, too. Or if you want to tell us about an idea you have.

Credits¶

Tycho Tatitscheff is the originator and main author.
Zest software for their releases manager and also for inspiration (copy paste of most docs).

Information for developers of saruman¶

Running tests¶

We like to use Virtual env to get a simple environment and to use pytest to test. When you are in the root folder of your saruman checkout, do this:

$ virtualenv ~/venv/saruman --python=`which python3.5`  # Or a different python version.
$ source ~/venv/firewall/bin/activate
$ python setup.py test

Python versions¶

The tests currently pass on python 3.4 and 3.5. Travis continuous integration tests 3.4 and 3.5 for us automatically.

Necessary programs¶

To run the firewall and test, you need to have an AMQP broker ! On ubuntu:

$ sudo apt-get install rabbitmq

Complete documentation from the source code¶

saruman package¶

Subpackages¶

saruman.actions package¶

Submodules¶

saruman.actions.start module¶

saruman.app package¶

Submodules¶

saruman.app.queue module¶

saruman.conf package¶

Submodules¶

saruman.conf.celery module¶

saruman.helpers package¶

Submodules¶

saruman.helpers.check module¶

saruman.helpers.check.get_celery_worker_status()[source]¶

saruman.helpers.config module¶

saruman.helpers.error_handling module¶

saruman.helpers.error_handling.error_handling(*args, **kwds)[source]¶

saruman.helpers.exceptions module¶

exception saruman.helpers.exceptions.FirewallGenericError[source]¶: Bases: exceptions.Exception

saruman.helpers.logger module¶

saruman.tasks package¶

Subpackages¶

saruman.tasks.iproute2 package¶

Submodules¶

saruman.tasks.iproute2.interfaces module¶

saruman.tasks.kernel package¶

Submodules¶

saruman.tasks.kernel.modprobe module¶

tasks.kernel.modprobe¶

Contains all the functionalities that help loading or unloading a kernel module

class saruman.tasks.kernel.modprobe.Check[source]¶

Bases: celery.app.task.Task

Tache de vérification de l’activation d’un module dans le kernel

Vérifie si le module module_name est activé dans le kernel. Se réfère à une liste des modules autorisés (ainsi, l’utilisateur ne peut pas supprimer le module du filesystem par exemple). La tache tourne dans un context (:py:func:error_handling) qui gère les erreurs

acks_late = False¶

ignore_result = False¶

name = 'kernel.modules.check'¶

rate_limit = None¶

request_stack = <celery.utils.threads._LocalStack object>¶

run(module_name)[source]¶

Parameters:	module_name (str) – le nom du module à checker
Returns:	oui si le module est activé, non sinon
Return type:	bool

send_error_emails = False¶

serializer = 'json'¶

store_errors_even_if_ignored = False¶

track_started = False¶

class saruman.tasks.kernel.modprobe.Add[source]¶

Bases: celery.app.task.Task

Tache de vérification de l’activation d’un module dans le kernel

acks_late = False¶

ignore_result = False¶

name = 'kernel.modules.add'¶

rate_limit = None¶

request_stack = <celery.utils.threads._LocalStack object>¶

run(module_name)[source]¶

Parameters:	module_name (str) – le nom du module à checker

send_error_emails = False¶

serializer = 'json'¶

store_errors_even_if_ignored = False¶

track_started = False¶

class saruman.tasks.kernel.modprobe.AddWithArgs[source]¶

Bases: celery.app.task.Task

Tache de vérification de l’activation d’un module dans le kernel

acks_late = False¶

ignore_result = False¶

name = 'kernel.modules.addWithArgs'¶

rate_limit = None¶

request_stack = <celery.utils.threads._LocalStack object>¶

run(module_name, module_args)[source]¶

Parameters:	module_name (str) – le nom du module à checker module_args (dict) – un dictionnaire d’arguments

send_error_emails = False¶

serializer = 'json'¶

store_errors_even_if_ignored = False¶

track_started = False¶

class saruman.tasks.kernel.modprobe.Remove[source]¶

Bases: celery.app.task.Task

acks_late = False¶

ignore_result = False¶

name = 'kernel.modules.remove'¶

rate_limit = None¶

request_stack = <celery.utils.threads._LocalStack object>¶

run(module_name)[source]¶

send_error_emails = False¶

serializer = 'json'¶

store_errors_even_if_ignored = False¶

track_started = False¶

saruman.tasks.misc package¶

Submodules¶

saruman.tasks.misc.hello_world module¶

Entrypoints for saruman¶

Saruman use an unique cli-entrypoint, that use click to parse command line arguments

Changelog for Saruman¶

0.3.0 (2016-01-03)¶

big modifications of the documentation structure

0.2.3 (2016-01-03)¶

fixing badges and coverage in testing

0.2.2 (2016-01-03)¶

testing works

0.2.1 (2016-01-03)¶

fixing a lot of nasty issues

0.2.0 (2016-01-03)¶

adding sphinx documentation
adding CI coverage
fixing nasty unpack in modprobe.py

0.1.2 (2016-01-03)¶

fixing some typo.

0.1.1 (2016-01-03)¶

remove download urls as we use sdist

0.1.0 (2016-01-03)¶

add zest.release to perform check on release an better automation
add some yaml config files

Saruman¶

Saruman¶

Most important Urls¶

Technologies used¶

Available commands¶

AMQP json-rpc api¶

Options¶

Command line options¶

Assumptions¶

Further reading¶

Improving saruman: report bugs, fork on github or email us¶

Credits¶

Information for developers of saruman¶

Running tests¶

Python versions¶

Necessary programs¶

Complete documentation from the source code¶

saruman package¶

Subpackages¶

saruman.actions package¶

Submodules¶

saruman.app package¶

Submodules¶

saruman.conf package¶

Submodules¶

saruman.helpers package¶

Submodules¶

saruman.tasks package¶

Subpackages¶

Entrypoints for saruman¶

Changelog for Saruman¶

0.3.0 (2016-01-03)¶

0.2.3 (2016-01-03)¶

0.2.2 (2016-01-03)¶

0.2.1 (2016-01-03)¶

0.2.0 (2016-01-03)¶

0.1.2 (2016-01-03)¶

0.1.1 (2016-01-03)¶

0.1.0 (2016-01-03)¶