cookbook 'shorewall_reloaded', '~> 0.3.2'
shorewall_reloaded (3) Versions 0.3.2 Follow2
Configures and install Shorewall
cookbook 'shorewall_reloaded', '~> 0.3.2', :supermarket
knife supermarket install shorewall_reloaded
knife supermarket download shorewall_reloaded
shorewall_reloaded Cookbook
Description
This cookbook is based on the original in the Chef Supermarket by charles-dyfis-net for CentOS.
Shorewall is a rather comprehensive and easy-to-use abstraction layer on top of iptables.
This cookbook installs, configures and manages Shorewall.
Requirements
Chef
Tested on 11.12.8 but newer and older version should work just fine.
Platform
The following platforms have been tested with this cookbook, meaning that the recipes run on these platforms without error:
- Ubuntu
- Debian
Capabilities
Creates pretty Shorewall configuration files intended to be aesthetically
comparable to hand-written ones.
The following is a typical example of output (in this case, for a rules file):
#
# Shorewall version 4 - Rules File
#
# For information on the settings in this file, type "man shorewall-rules"
#
# The manpage is also online at
# http://www.shorewall.net/manpages/shorewall-rules.html
#
############################################################################################################################
#ACTION SOURCE DEST PROTO DEST SOURCE ORIGINAL RATE USER/ MARK
# PORT PORT(S) DEST LIMIT GROUP
#SECTION ESTABLISHED
#SECTION RELATED
SECTION NEW
# Allow all from VM host
ACCEPT net:10.0.2.2 fw - - - - - - -
# Incoming SSH to firewall
ACCEPT all fw tcp 22 - - - - -
# Allow database load-balancer db1.vguest access to repmgr monitor
ACCEPT lan:192.168.123.10 \
fw tcp 5480 - - - - -
Note how line continuations are added as necessary to keep column alignment in place.
Attributes
shorewall_reloaded::default
<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><tt>['shorewall']['enabled']</tt></td>
<td>Boolean</td>
<td>Enable o disable Shorewall</td>
<td><tt>false</tt></td>
</tr>
<tr>
<td><tt>['shorewall']['default']['options']</tt></td>
<td>String</td>
<td>Global start/restart/stop options</td>
<td><tt></tt></td>
</tr>
<tr>
<td><tt>['shorewall']['default']['wait_interface']</tt></td>
<td>String</td>
<td>If your Shorewall configuration requires detection of the ip address of a ppp interface, you must list such interfaces in this attribute to get Shorewall to wait until the interface is configured</td>
<td><tt>false</tt></td>
</tr>
<tr>
<td><tt>['shorewall']['default']['startoptions']</tt></td>
<td>String</td>
<td>Start options</td>
<td><tt></tt></td>
</tr>
<tr>
<td><tt>['shorewall']['default']['restartoptions']</tt></td>
<td>String</td>
<td>Restart options</td>
<td><tt></tt></td>
</tr>
<tr>
<td><tt>['shorewall']['default']['initlog']</tt></td>
<td>String</td>
<td>Init Log. If it is /dev/null, will be used the STARTUP_LOG value defined in shorewall.conf</td>
<td><tt>/dev/null</tt></td>
</tr>
<tr>
<td><tt>['shorewall']['default']['safestop']</tt></td>
<td>Numeric</td>
<td>Set this to 1 to cause '/etc/init.d/shorewall stop' to place the firewall in a safe state rather than to open it</td>
<td><tt>0</tt></td>
</tr>
<tr>
<td><tt>['shorewall']['zones']</tt></td>
<td>Array</td>
<td>This is an array of hashes that contain the zones settings. Each item could have the following keys: <tt>zone</tt>, <tt>type</tt>, <tt>options</tt>, <tt>in_options</tt>, <tt>out_options</tt></td>
<td><tt>[]</tt></td>
</tr>
<tr>
<td><tt>['shorewall']['policy']</tt></td>
<td>Array</td>
<td>This is an array of hashes that contain the polices settings. Each item could have the following keys: <tt>source</tt>, <tt>dest</tt>, <tt>policy</tt>, <tt>log_level</tt>, <tt>limit</tt></td>
<td><tt>[]</tt></td>
</tr>
<tr>
<td><tt>['shorewall']['interfaces']</tt></td>
<td>Array</td>
<td>This is an array of hashes that contain the interfaces settings. Each item could have the following keys: <tt>zone</tt>, <tt>interface</tt>, <tt>broadcast</tt>, <tt>options</tt></td>
<td><tt>[]</tt></td>
</tr>
<tr>
<td><tt>['shorewall']['hosts']</tt></td>
<td>Array</td>
<td>This is an array of hashes that contain the hosts settings. Each item could have the following keys: <tt>zone</tt>, <tt>hosts</tt>, <tt>options</tt></td>
<td><tt>[]</tt></td>
</tr>
<tr>
<td><tt>['shorewall']['rules']</tt></td>
<td>Array</td>
<td>This is an array of hashes that contain the rules settings. Each item could have the following keys: <tt>action</tt>, <tt>source</tt>, <tt>dest</tt>, <tt>proto</tt>, <tt>dest_port</tt>, <tt>source_port</tt>, <tt>original_dest</tt>, <tt>rate_limit</tt>, <tt>user</tt>, <tt>fwmark</tt></td>
<td><tt>[]</tt></td>
</tr>
<tr>
<td><tt>['shorewall']['tunnels']</tt></td>
<td>Array</td>
<td>This is an array of hashes that contain the tunnels settings. Each item could have the following keys: <tt>type</tt>, <tt>zone</tt>, <tt>gateway</tt>, <tt>gateway_zones</tt></td>
<td><tt>[]</tt></td>
</tr>
</table>
For more details, see the attributes/default.rb
file.
Recipes
shorewall_reloaded::default
This cookbook installs and configures Shorewall in the node.
Usage
Just include shorewall_reloaded
in your node's run_list
:
{ "name":"my_node", "run_list": [ "recipe[shorewall_reloaded]" ] }
You need to set the zones, policies, rules, zones, interfaces in order to manage Shorewall by using this cookbook.
Examples:
- Setting zones:
json "shorewall": { "zones": [ { "zone": "fw", "type": "firewall" }, { "zone": "lan", "type": "ipv4" }, { "zone": "net", "type": "ipv4" } ] }
- Setting policies:
json "shorewall": { "policy": [ { "source": "fw", "dest": "all", "policy": "ACCEPT" }, { "source": "lan", "dest": "fw", "policy": "REJECT", "log": "DEBUG" }, { "source": "all", "dest": "all", "policy": "REJECT" } ] }
- Setting interfaces
json "shorewall": { "interfaces": [ { "zone": "net", "interface": "eth0", "broadcast": "detect", "options": "tcpflags,nosmurfs,routefilter,logmartians" }, { "zone": "lan", "interface": "eth1", "broadcast": "detect", "options": "tcpflags,nosmurfs,routefilter,logmartians" } ] }
- Setting rules
json "shorewall": { "rules": [ { "description": "Don't allow connection pickup from the net", "action": "Invalid(DROP)", "source": "net", "dest": "all" }, { "description": "Accept DNS connections from the firewall to the network", "action": "DNS(ACCEPT)", "source": "fw", "dest": "net" }, { "description": "Accept NTP connections from the firewall to the network", "action": "NTP(ACCEPT)", "source": "fw", "dest": "net" }, { "description": "Incoming SSH to firewall", "source": "all", "dest": "fw", "proto": "tcp", "dest_port": 22, "action": "ACCEPT" }, { "description": "Accept HTTP/HTTPS connections to internet", "action": "Web(ACCEPT)", "source": "fw", "dest": "net" }, { "description": "Allow Ping from the local network", "action": "Ping(ACCEPT)", "source": "loc", "dest": "fw" }, { "description": "Drop Ping from the \"bad\" net zone.. and prevent your log from being flooded..", "action": "Ping(DROP)", "source": "net", "dest": "fw" }, { "description": "Drop Ping from the \"bad\" net zone.. and prevent your log from being flooded..", "action": "ACCEPT", "source": "fw", "dest": "loc", "proto": "icmp" }, { "description": "Drop Ping from the \"bad\" net zone.. and prevent your log from being flooded..", "action": "ACCEPT", "source": "fw", "dest": "net", "proto": "icmp" } ] }
- Setting tunnels:
json "shorewall": { "tunnels": [ { "type": "ipsec", "zone": "net", "gateway": "0.0.0.0/0", "gateway_zones": "vpn" } ] }
Development
- Source hosted at GitHub
- Report issues/Questions/Feature requests on GitHub Issues
Contributing
- Fork the repository on Github
- Write your change
- Write tests for your change (if applicable)
- Run the tests, ensuring they all pass
- Submit a Pull Request using Github
License and Authors
Author:: Claudio Cesar Sanchez Tejeda demonccc@gmail.com
Copyright:: 2014, Claudio Cesar Sanchez Tejeda
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
shorewall_reloaded CHANGELOG
This file is used to list changes made in each version of the shorewall_reloaded cookbook.
0.3.0
- [Claudio Cesar Sanchez Tejeda] - A lot of changes...
0.1.0
- [Claudio Cesar Sanchez Tejeda] - Initial release of chef-shorewall_reloaded
Check the Markdown Syntax Guide for help with Markdown.
The Github Flavored Markdown page describes the differences between markdown on github and standard markdown.
Collaborator Number Metric
0.3.2 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.3.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.3.2 failed this metric
FC064: Ensure issues_url is set in metadata: shorewall_reloaded/metadata.rb:1
FC065: Ensure source_url is set in metadata: shorewall_reloaded/metadata.rb:1
FC066: Ensure chef_version is set in metadata: shorewall_reloaded/metadata.rb:1
FC069: Ensure standardized license defined in metadata: shorewall_reloaded/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.3.2 passed this metric
Testing File Metric
0.3.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.3.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.3.2 failed this metric
0.3.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.3.2 failed this metric
FC064: Ensure issues_url is set in metadata: shorewall_reloaded/metadata.rb:1
FC065: Ensure source_url is set in metadata: shorewall_reloaded/metadata.rb:1
FC066: Ensure chef_version is set in metadata: shorewall_reloaded/metadata.rb:1
FC069: Ensure standardized license defined in metadata: shorewall_reloaded/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.3.2 passed this metric
Testing File Metric
0.3.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.3.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.3.2 failed this metric
FC065: Ensure source_url is set in metadata: shorewall_reloaded/metadata.rb:1
FC066: Ensure chef_version is set in metadata: shorewall_reloaded/metadata.rb:1
FC069: Ensure standardized license defined in metadata: shorewall_reloaded/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
0.3.2 passed this metric
Testing File Metric
0.3.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.3.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.3.2 failed this metric
0.3.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number