Sphirewall Wiki

architectural_design

2012-05-07T15:40:58-04:00

General There are two binary parts to Sphirewall as it stands. The kernel module, which acts as a packet transport mechanism and the sphirewalld daemon which at the time of writing this document controls everything. The kernel module is written in explicitly c as is required by Linux, and the daemon is written in a mixture of c and c++. There is no use of external c++ libraries such as Boost or the like.

architecture_overview

2010-06-19T00:09:05-04:00

Modules and Services Sphirewall is split into several separate binary files and services that all have the ability to perform certain tasks and communicate with each other as required. This communication is performed by socket api's provided through the Thrift Service

common_libraries

2012-05-07T15:40:58-04:00

Introduction The common libraries are a set of functions and classes that are reused throughout sphirewall. Please see the Doxygen Docs for specific details.

contributors_guide

2010-03-24T03:14:06-04:00

Anyone can contribute to the development of Sphirewall and we welcome and contributions both small and large. Drop by our irc channel or contact us using the details on our help page. We are an agile development team, so it is important that you commit as often as possible, and work in small increments.

core_daemon

2010-06-18T23:37:56-04:00

Introduction The core daemon is where all the packet processing and fun stuff happens. It is composed of a binary application that hooks into the kernel module and processes all packets based on user rules. Management of the core daemon is provided via a thrift service, and configuration files loaded on startup.

core_management_api

2012-05-07T15:40:58-04:00

current_features

2010-03-18T06:05:55-04:00

Major Features * Firewall System Stateful firewall system, including NAT and PAT translation for routing * Authentication User and Group management coupled into the Firewall. This means access to network resources can be managed based on user and group rather than just ip mac address like conventional firewalls * QOS Full QOS and Traffic Shaping * Intrusion Detection System Sphirewall has an internal ids and also can be used with snort. Attackers can be automatically blocked. * Bandw…

developers_guide

2010-05-31T06:08:33-04:00

This document is out of date Sphirewall Developers Guide This document is designed to help developers understand the how sphirewall operates at the system level, this alone means that there will be frequent mistakes in this document, so if you find something that doesn't appear to be right, please contact the team and we will remedy this.

faq_s

2010-03-17T21:05:18-04:00

On this page you will find answers to the most commonly asked questions and details regarding specific features. For more information, please consult the Documentation or contact the team. What is the purpose behind sphirewall? Sphirewall is an authenticating capture portal firewall for Linux, its build from the ground up and hooks directly into the linux kernel. Sphirewall was created by Michael Lawson-Searle, as an alternative to the proprietary authenticating firewalls that are available. …

kernel_module

2010-06-10T07:09:08-04:00

Introduction Sphirewall_queue is a kernel module written to hook into the kernel packet flow and pass them to the sphirewall daemon. Communication with the module is via netlink, a very fast kernel to userspace socket based communication system. This communication is abstracted out by a client library.

masterwriter

2012-05-07T15:40:58-04:00

Here's a must try. Professional freelance writing opportunities assistance with custom essays, term papers, research papers, thesis etc. Any difficulty. Any topic. Affordable prices. Order 100% custom-written term papers from a reputable custom writing. Quality assistance from professional writers.

new_architecture

2010-04-20T18:00:51-04:00

Introduction This document is an note for developers and people interested in the project regarding The new Architecture of Sphirewall. Once the changes are complete and a stable version has been released, this document will be merged in to the mainstream documentation.

packaging_sphirewall_-_the_debian_way

2010-06-19T01:59:09-04:00

Packaging Sphirewall Follow the follow steps: 1. Download the current source tree 2. Rename to sphirewalld directory to follow the debian standard: - 3. cd into that directory 4. run dh_make Running dh_make will have created the default set of debian directories, you can then customize the files within this directory

php_management_console

2010-10-14T04:31:40-04:00

Introduction The php management console is your point of call to manage sphirewall. Everything that sphirewall has to offer is configurable from the management console. To run the console you need apache with php5 installed. Installing Installing the console is simple, if you installed sphirewall via the packages or iso, it should already be up and running. Check by pointing your web browser to port 80 on the sphirewall host.

quick_start_guide

2012-05-11T13:29:48-04:00

Before diving into Sphirewall, it is recommended that you read the general Architecture Overview, dont worry this is very small. Installing Sphirewall There are several ways to get sphirewall. The easiest would be to download the deb package or install our debian iso. But if you want cutting edge, you must get the source code.

release_schedule

2010-10-14T04:34:47-04:00

The roadmap is now managed via Jira, here

roadmap

2012-05-07T15:40:58-04:00

The roadmap is now managed via Jira, here

scli

2010-05-31T05:58:46-04:00

Introduction The sphirewall cli interface also known as scli is a cisco like command like interface used to control the core daemon both locally and remotely. It uses the same api as the http management console. Scli, provides a fast way to manage the sphirewall daemon without the use of a web browser.

screen_shots

2010-10-16T04:46:56-04:00

setting_up_an_internet_gateway_firewall

2010-07-04T07:12:27-04:00

Guide to this Guide This guide is to help users get a kick start with Sphirewall. As a general rule, we dont agree in great lengths of User Documentation, as its normally just a bad excuse for a poor user interface. We assume sphirewall users are generally fairly knowledgeable regarding networking and firewall systems in general.

sphirewall_bandwidth_an_introduction

2010-04-03T05:24:05-04:00

Intro sphirewall_bandwidth is our datawarehousing and bandwidth reporting tool. It is slit into two parts, a Http Monitor and Analysis tool and the second a aggregated bandwidth monitoring tool. Both systems provide statistics to Sphirewall and in particular the Management Interface's Bandwidth Pages.

sphirewall_telnetd

2012-04-28T19:15:39-04:00

Introduction The sphirewall telnet daemon is simply an authentication portal for users. It is an optional daemon that can provide a easy authentication point. It is worth noting that communication via telnet can be sniffed, and so it is not recommended that you use this daemon.

sphirewallers_guide_to_thrift

2010-06-10T07:12:48-04:00

Thrift is a neat RPC framework that deals with serialization, communication and what not under the hood between several different languages. In short, you can very easily write fast rpc services that are accessible from several languages in minutes.

start

2012-04-28T18:34:56-04:00

NOTE: Currently sphirewall is going through a revamp, this means this information is somewhat out of date, and wont be updated until the next release, when its stable. Documents * Quick Start Guide * Setting up an internet gateway/firewall * User Guide * Architecture Overview * Screen Shots

unit_testing_gtest

2010-03-12T05:57:49-04:00

Unit testing in Sphirewall has only recently been introduced. I decided to go with the Google Test Framework as it offers several features above the other systems. To get started with GTest download it from: http://code.google.com/p/googletest/, if you are using a debian based distribution then you can use the package manager:

user_guide

2010-03-24T03:01:57-04:00

This document hasnt been created yet