Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wert310 committed Nov 6, 2020
1 parent 0893ab7 commit 98febc4
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ Language-independent Synthesis of Firewall Policies
#### Docker Hub
Run `fws` using docker

- web nterface:
- Web interface:
```
docker run --rm -ti -p 5095:5095 wert310/fws
```
- command line:
- Command line:
```
docker run --rm -ti -v `pwd`:/mnt wert310/fws -m cli
```
Expand All @@ -29,10 +29,6 @@ Build the docker image
```
docker build -t wert310/fws .
```
And run it
```
docker run --rm -ti -v `pwd`:/mnt wert310/fws
```

#### Manual Installation
Install the required packages
Expand All @@ -55,7 +51,7 @@ the executable is `fws`.
#### Policy Analysis
* Loading a policy
```
$ fws
$ fws -m cli
FWS> ipt = load_policy(iptables, "examples/policies/iptables.rules", "examples/policies/interfaces_aliases.conf")
```
* Synthesizing the entire specification
Expand Down Expand Up @@ -88,7 +84,7 @@ the executable is `fws`.
FWS can be used in non-iteractive mode giving it an fws script as the first command line argument
```
$ fws script.fws
$ fws -m cli script.fws
```
#### Policy Verification
Expand All @@ -98,7 +94,7 @@ to spot possible differences in the `iptables`, `ipfw` and `pf` configurations.
```
$ source venv/bin/activate
$ cd examples
$ fws examples.fws
$ fws -m cli examples.fws
```
#### Policy Equivalence
The script `equivalence.fws` in the `examples` directory shows how the equivalence
Expand All @@ -107,13 +103,13 @@ are equivalent for the requirements of the firewall.
```
$ source venv/bin/activate
$ cd examples
$ fws equivalence.fws
$ fws -m cli equivalence.fws
```
#### Query Examples
The script `real_world.fws` in the `examples` directory shows some query examples on real
policies.
```
$ source venv/bin/activate
$ cd examples
$ fws real_world.fws
$ fws -m cli real_world.fws
```

0 comments on commit 98febc4

Please sign in to comment.