README 6.14 KB
Newer Older
1 2
modules/shorewall/manifests/init.pp - manage firewalling with shorewall 3.x

Varac's avatar
Varac committed
3 4
Puppet Module for Shorewall
---------------------------
Varac's avatar
Varac committed
5 6
This module manages the configuration of Shorewall (http://www.shorewall.net/)

7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
Copyright
---------

Copyright (C) 2007 David Schmitt <david@schmitt.edv-bus.at>
adapted by immerda project group - admin+puppet(at)immerda.ch
adapted by Puzzle ITC - haerry+puppet(at)puzzle.ch
Copyright (c) 2009 Riseup Networks - micah(shift+2)riseup.net
Copyright (c) 2010 intrigeri - intrigeri(at)boum.org
See LICENSE for the full license granted to you.

Based on the work of ADNET Ghislain <gadnet@aqueos.com> from AQUEOS
at https://reductivelabs.com/trac/puppet/wiki/AqueosShorewall

Merged from:
- git://git.puppet.immerda.ch/module-shorewall.git
- git://labs.riseup.net/module_shorewall
23

Varac's avatar
Varac committed
24 25 26
Todo
----
- check if shorewall compiles without errors, otherwise fail !
27

28 29 30 31 32 33 34 35 36 37
Configuration
-------------

If you need to install a specific version of shorewall other than
the default one that would be installed by 'ensure => present', then
you can set the following variable and that specific version will be
installed instead:

    $shorewall_ensure_version = "4.0.15-1"

Varac's avatar
Varac committed
38 39
Documentation
-------------
40

Varac's avatar
Varac committed
41
see also: http://reductivelabs.com/trac/puppet/wiki/Recipes/AqueosShorewall
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90

Torify
------

The shorewall::rules::torify define can be used to force some outgoing
TCP traffic through the Tor transparent proxy. The corresponding
non-TCP traffic is rejected accordingly.

Beware! This define only is part of a torified setup. DNS requests and
IPv6, amongst others, might leak network activity you would prefer not
to. You really need to read proper documentation about these matters
before using this feature e.g.:

  https://www.torproject.org/download/download.html.en#warning

The Tor transparent proxy location defaults to 127.0.0.1:9040 and can
be configured by setting the $tor_transparent_proxy_host and
$tor_transparent_proxy_port variables before including the main
shorewall class.

Example usage follows.

Torify any outgoing TCP traffic originating from user bob or alice and
aimed at 6.6.6.6 or 7.7.7.7:

  shorewall::rules::torify {
    'torify-some-bits':
      users        => [ 'bob', 'alice' ],
      destinations => [ '6.6.6.6', '7.7.7.7' ];
  }

Torify any outgoing TCP traffic to 8.8.8.8:

  shorewall::rules::torify {
    'torify-to-this-host':
      destinations  => [ '8.8.8.8' ];
  }

When no destination nor user is provided any outgoing TCP traffic (see
restrictions bellow) is torified. In that case the user running the
Tor client ($tor_user) is whitelisted; this variable defaults to
"debian-tor" on Debian systems and to "tor" on others. if this does
not suit your configuration you need to set the $tor_user variable
before including the main shorewall class.

When no destination is provided traffic directed to RFC1918 addresses
is by default allowed and (obviously) not torified. This behaviour can
be changed by setting the allow_rfc1918 parameter to false.

91 92 93
Torify any outgoing TCP traffic but
  - connections to RFC1918 addresses
  - connections from users bob and alice:
94

95
  $non_torified_users = [ 'bob', 'alice' ]
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
  shorewall::rules::torify {
    'torify-everything-but-lan':
  }

Torify any outgoing TCP traffic:

  shorewall::rules::torify {
    'torify-everything:
      allow_rfc1918 => false;
  }

In some cases (e.g. when providing no specific destination nor user
and denying access to RFC1918 addresses) UDP DNS requests may be
rejected. This is intentional: it does not make sense leaking -via DNS
requests- network activity that would otherwise be torified. In that
case you probably want to read proper documentation about such
matters, enable the Tor DNS resolver and redirect DNS requests through
it.

Varac's avatar
Varac committed
115 116 117
Example
-------

Varac's avatar
Varac committed
118 119 120
Example from node.pp:

node xy {
121
	$shorewall_startup="0"  # create shorewall ruleset but don't startup
Varac's avatar
Varac committed
122 123
	include config::site-shorewall
	shorewall::rule {
124 125 126 127
		'incoming-ssh': source => 'all', destination => '$FW',  action  => 'SSH(ACCEPT)', order => 200;
		'incoming-puppetmaster': source => 'all', destination => '$FW',  action  => 'Puppetmaster(ACCEPT)', order => 300;
		'incoming-imap': source => 'all', destination => '$FW',  action  => 'IMAP(ACCEPT)', order => 300;
		'incoming-smtp': source => 'all', destination => '$FW',  action  => 'SMTP(ACCEPT)', order => 300;
Varac's avatar
Varac committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
	}
}


class config::site-shorewall {
        include shorewall

	# If you want logging:
        #shorewall::params {
        #       'LOG':            value => 'debug';
        #	'MAILSERVER':     value => $shorewall_mailserver;
        #}

        shorewall::zone {'net':
                type => 'ipv4';
        }

        shorewall::rule_section { 'NEW':
                order => 10;
        }

        case $shorewall_rfc1918_maineth {
                '': {$shorewall_rfc1918_maineth = true }
        }

        case $shorewall_main_interface {
                '': { $shorewall_main_interface = 'eth0' }
        }

        shorewall::interface {"$shorewall_main_interface":
                zone    => 'net',
                rfc1918  => $shorewall_rfc1918_maineth,
                options => 'tcpflags,blacklist,nosmurfs';
        }

        shorewall::policy {
                'fw-to-fw':
                  sourcezone              =>      '$FW',
                  destinationzone         =>      '$FW',
                  policy                  =>      'ACCEPT',
                  order                   =>      100;
                'fw-to-net':
                sourcezone              =>      '$FW',
                destinationzone         =>      'net',
                policy                  =>      'ACCEPT',
                shloglevel              =>      '$LOG',
                order                   =>      110;
                'net-to-fw':
                sourcezone              =>      'net',
                destinationzone         =>      '$FW',
                policy                  =>      'DROP',
                shloglevel              =>      '$LOG',
                order                   =>      120;
        }       

        
        # default Rules : ICMP 
185
        shorewall::rule { 'allicmp-to-host': source => 'all', destination => '$FW', order  => 200, action  => 'AllowICMPs(ACCEPT)';
Varac's avatar
Varac committed
186 187 188 189 190
        }
 
}