cookbook 'iptables', '= 6.0.1'
iptables
(41) Versions
6.0.1
-
Follow132
Installs the iptables daemon and provides resources for managing rules
cookbook 'iptables', '= 6.0.1', :supermarket
knife supermarket install iptables
knife supermarket download iptables
iptables Cookbook
Installs iptables and provides a custom resource for adding and removing iptables rules
Requirements
Platforms
- Ubuntu/Debian
- RHEL/CentOS and derivatives
- Amazon Linux
Chef
- Chef 12.15+
Cookbooks
- none
Recipes
default
The default recipe will install iptables and provides a pair of resources for managing firewall rules for both iptables and ip6tables.
disabled
The disabled recipe will install iptables, disable the iptables service (on RHEL platforms), and flush the current iptables and ip6tables rules.
Attributes
default['iptables']['iptables_sysconfig'] and default['iptables']['ip6tables_sysconfig'] are hashes that are used to template /etc/sysconfig/iptables-config and /etc/sysconfig/ip6tables-config. The keys must be upper case and any key / value pair included will be added to the config file.
default['iptables']['persisted_rules_iptables'] and default['iptables']['persisted_rules_ip6tables'] are strings that are used to hold the location of the generated iptables-save/iptables-restore format file containing the firewall rules for the system.
default['iptables']['persisted_rules_template'] is a hash that contains the base structure for the generated persisted rule files containing the default tables and chains.
Custom Resource
chain
Use this resource to create ip(6)tables chains that can be later referenced in rules, this resource contains the same accumulated template resource that the rule resource does but only deals with the creation of chains.
| Property | Optional? | Type | Description |
|---|---|---|---|
source |
Yes | String | Source template for the generation of the persistent rules file |
cookbook |
Yes | String | Source cookbook for the generation of the persistent rules file |
config_file |
Yes | String | Persistent rules file to generate |
table |
Yes | String | The iptables table to create the chain on (defaults to filter) |
chain |
No | String, Array, Hash | The chain name and optionally default action and packet counts |
filemode |
Yes | String, Integer | Filemode of the the persistent rules file |
The chain property accepts entries in the following formats:
Chain without default action and packet counts (in this case default action will be set to -)
String
'NEWCHAIN'
Array of String
['NEWCHAIN1', 'NEWCHAIN2', 'NEWCHAIN3']
Hash
{ 'NEWCHAIN' => ''}
Chain with default action but no packet counts
String
'NEWCHAIN -'
Array of String
['NEWCHAIN1 ACCEPT', 'NEWCHAIN2 REJECT', 'NEWCHAIN3 DROP']
Hash
{ 'NEWCHAIN' => 'DROP'}
Chain with default action and packet counts
String
'NEWCHAIN ACCEPT [123:123]'
Array of String
['NEWCHAIN1 ACCEPT [0:0]', 'NEWCHAIN2 REJECT [1:1]', 'NEWCHAIN3 DROP [322:322]']
Hash
{ 'NEWCHAIN' => 'DROP [0:0]'}
chain6
The iptables_chain6 provides IPv6 support with the same behavior as the original iptables_chain.
rule
The custom resource contains an accumulated template resource which generates the persisted rule file which notifies the reload of the firewall rules at the end of the chef run. See Examples below.
NOTE: In the 5.0 release of this cookbook the iptables_rule definition was converted to an accumulated template resource. This changes the behavior of disabling iptables rules. Previously a rule needed to be disabled explicitly by calling the resource with :disable. Now as soon as a rule resource is no longer included in the chef run it will not be added to the accumulated template and will be automatically removed.
| Property | Optional? | Type | Description |
|---|---|---|---|
source |
Yes | String | Source template for the generation of the persistent rules file |
cookbook |
Yes | String | Source cookbook for the generation of the persistent rules file |
config_file |
Yes | String | Persistent rules file to generate |
table |
Yes | String | The iptables table to create the chain on (defaults to filter) |
chain |
No (1) | String | The chain name to be used if the rule is generated from properties |
match |
Yes | String | The match settings for the rule |
target |
No (1) | String | The target for the rule |
line |
No (2) | String | A string containing a complete iptables rule statement, no generation takes place |
comment |
Yes | String, True, False | The comment for the rule if a string, use resource name if true, no comment if false
|
extra_options |
Yes | String | Extra options to appended to the rule after the destination -j XXXXX
|
filemode |
Yes | String, Integer | Filemode of the the persistent rules file |
The resource can be called with one of two property sets:
-
chainandtargetare set (matchoptionally), in which caselineis ignored. -
chainandtargetare unset in which caselineused.
rule6
The iptables_rule6 provides IPv6 support with the same behavior as the original iptable_rule.
Usage
Add recipe[iptables] to your runlist to ensure iptables is installed and running on the system. Then create use iptables_rule/ip6tables_rule to add individual rules. See Examples.
Since certain chains can be used with multiple tables (e.g., PREROUTING), you might have to include the name of the table explicitly using the table property (i.e., *nat, *mangle, etc.), so that the resource can infer how to assemble the final ruleset file that is going to be loaded. Please note, that unless specified otherwise, rules will be added under the filter table by default.
Examples
To enable port 80, e.g. in an my_httpd cookbook, create the following rule resource:
# Port 80 for http iptables_chain 'fwr' do chain 'FWR' end iptables_rule 'httpd' do line '-A FWR -p tcp -m tcp --dport 80 -j ACCEPT' end
or to generate:
# Port 80 for http iptables_chain 'fwr' do chain 'FWR' end iptables_rule 'httpd' do chain 'FWR' match '-p tcp -m tcp --dport 80' target 'ACCEPT' end
To redirect port 80 to local port 8080, e.g., in the aforementioned my_httpd cookbook, create the following rule resource:
# Redirect anything on eth0 coming to port 80 to local port 8080 iptables_rule 'httpd' do table 'nat' chain 'PREROUTING' match '-i eth0 -p tcp --dport 80' target 'REDIRECT' extra_options '--to-port 8080' end
To create a rule without using the line property (you can optionally specify table when using line):
iptables_rule 'http_8080' do line '-A PREROUTING -i eth0 -p tcp --dport 80 -j REDIRECT --to-port 8080' table 'nat' end
Additionally, a rule can be marked as sensitive so it's contents does not get output to the the console or logged with the sensitive property set to true. The mode of the generated rule file can be set with the filemode property:
iptables_rule 'http_8080' do line '-A PREROUTING -i eth0 -p tcp --dport 80 -j REDIRECT --to-port 8080' table 'nat' sensitive true end
iptables_rule 'http_8080' do line '-A PREROUTING -i eth0 -p tcp --dport 80 -j REDIRECT --to-port 8080' table 'nat' sensitive true filemode '0600' end
To get attribute-driven rules you can (for example) feed a hash of attributes into named iptables.d files like this:
node.default['iptables']['rules']['http_80'] = '-A FWR -p tcp -m tcp --dport 80 -j ACCEPT' node.default['iptables']['rules']['http_443'] = [ '# an example with multiple lines', '-A FWR -p tcp -m tcp --dport 443 -j ACCEPT', ] node['iptables']['rules'].map do |rule_name, rule_body| iptables_rule rule_name do line [ rule_body ].flatten.join("\n") end end
License & Authors
Author: Cookbook Engineering Team (cookbooks@chef.io)
Copyright: 2008-2019, Chef Software, Inc.
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
iptables Cookbook CHANGELOG
This file is used to list changes made in each version of the iptables cookbook.
6.0.1 (2020-01-08)
- Update readme to require 12.15+ - @tas50
- Lazy eval the node attributes in the resources so we can override them and not fail on non-Linux platforms- @tas50
6.0.0 (2020-01-08)
- Rule resources refactored to accumulator style. See the new usage in the readme
- CentOS 8 support
5.0.0 (2020-01-08)
- Cookstyle fixes - @tas50
- name_attributes -> name_properties - @tas50
- Remove recipe and long_description metadata - @tas50
- Simplify platform check logic - @tas50
- Remove respond_to? from metadata.rb - @tas50
- Require Chef 12.15+ - @tas50
4.5.0 (2018-11-24)
- Add sensitive option to resources
- Added filemode property to generated rule files
4.4.1 (2018-09-11)
- Remove mention of matchers in the readme
- Add back support for RHEL 6 + fix Amazon Linux 2 support
- Add additional specs for the package installs so we don't break this in the future
4.4.0 (2018-09-10)
- Use persistent iptables package for Debian config
- Add IPv6 support to iptables_rule and Add iptables_rule6
- Extend disabled recipe for Fedora and Amazon distros
4.3.4 (2018-02-15)
- Fix converge failures in the custom resource introduced in 4.3.3
- Remove stove and tomlrb from the Gemfile
- use apt_update not apt cookbook in testing
- Add Amazon Linux to test kitchen
- Simplify the platform family check using our helpers
4.3.3 (2018-02-15)
- Don't use kind_of in the custom resource (FC117)
4.3.2 (2018-02-07)
- Fix FC108 to resolve test failures
- Switch from ServerSpec to InSpec
- Resolve ChefSpec warnings
- Remove ChefSpec matchers that are no longer needed since ChefSpec autogenerates these
4.3.1 (2017-11-06)
- Updating namespace for attribute-based rules in the readme
4.3.0 (2017-10-28)
- Add Amazon Linux support on Chef 13
4.2.1 (2017-09-08)
- Resolve deprecation warning
4.2.0 (2017-04-14)
- [GH-69] - Clearing out iptables rule files on RHEL with the iptables::disabled recipe
4.1.0 (2017-04-11)
- specify optional table property for use with lines
4.0.1 (2017-03-29)
- Update metadata to require Chef 12.10+ due to use of with_run_context
4.0.0 (2017-02-27)
- Remove EOL platforms from testing
- Require Chef 12.5 and remove compat_resource dependency
3.1.0 (2017-01-16)
- Update readme to include new attribute
- Check subcmd exit codes in rebuild-iptables script
- fixed iptables disabled recipe to flush iptables after disabling the service
3.0.1 (2016-10-10)
- Fix rules resource so rebuild-iptables only runs once
- Add tests for nested resources
- Add system ruby attribute so that it can be overridden
3.0.0 (2016-09-16)
- Remove kitchen cloud config
- Fix default specs to work properly on RHEL and other general spec cleanup
- Simplify testing and fix failing tests on RHEL
- allow using a file provider instead of a template
- rename 'content' to 'lines' and add documentation
- make the attributes example a bit more useful
- using iptables-restore logic for rhel - same as debian
- copy new config to default location in case of iptables restart
- refactored rebuild-iptables script
- Update supported os
- Use compat_resource to restore Chef 12.1 - 12.4 compatibility
v2.2.0 (2016-02-17)
- Remove the dependency on compat_resource cookbook. This fixes RHEL systems, but increases the required Chef version to 12.5 or later
v2.1.1 (2016-01-26)
- Fixed failures on RHEL in the disabled recipe
v2.1.0 (2016-01-25)
- Improved compatbility with Fedora
- Added management of the iptables sysconfig files using 2 new attributes. See the readme for more information
v2.0.2 (2016-01-15)
- Fixed rules not being rebuilt when using the disable action in the custom resource
v2.0.1 (2015-11-16)
- Added Chefspec matchers
v2.0.0 (2015-10-21)
- Migrated LWRP to Chef 12.5 custom resources format with backwards compatibility provided via compat_resource cookbook to 12.X family
- Added Start / enable of iptables service in the default recipe when on RHEL based systems and the management of /etc/sysconfig/iptables so the service can start
- Added removal of /etc/iptables.d/ to the disabled recipe to allow for reenabling later on
- Modified the iptables service disable in the disable recipe to only run when on RHEL based systems
- Expanded the serverspec tests and test kitchen suites to better test rules custom resource and disable recipe
v1.1.0 (2015-10-05)
- Fixed metadata description of the default recipe
- Added Kitchen CI config
- Added Chefspec unit tests
- Updated to our standard Rubocop config and resolve all warnings
- Added Travis CI config for lint / unit testing on Ruby 2/2.1/2.2
- Updated Contributing and Testing docs
- Added a maintainers doc
- Added a Gemfile with development and testing dependencies
- Added cookbook version and Travis CI badges to the readme
- Clarified in the readme that the minimum supported Chef release is 11.0
- Added a Rakefile easier testing
- Added a chefignore file to limit files that are uploaded to the Chef server
- Update to modern notification format to resolve Foodcritic warnings
- Added source_url and issues_url to the metadata for Supermarket
- Removed pre-Ruby 1.9 hash rockets
v1.0.0 (2015-04-29)
NOTE: This release includes breaking changes to the behavior of this cookbook. The iptables_rule definition was converted to a LWRP. This changes the behavior of disabling iptables rules. Previously a rule could be disabled by specifying enable false. You must now specify action :disable. Additionally the cookbook no longer installs the out of the box iptables rules. These were rules made assumptions about the operating environment and should not have been installed out of the box. This makes this recipe a library cookbook that can be better wrapped to meet the needs or your particular environment.
- Definition converted to a LWRP to providing why-run support and
- The out of the box iptables rules are no longer installed. If you need these rules you'll need to wrap the cookbook and use the LWRP to define these same rules.
- Removed all references to the roadmap and deprecation of the cookbook. It's not going anywhere any time soon
- Use platform_family to better support Debian derivatives
- Converted file / directory modes to strings to preserve the leading 0
- Added additional RHEL derivitive distributions to the metadata
- Expanded excluded files in the gitignore and chefignore files
- Included the latest contributing documentation to match the current process
v0.14.1 (2015-01-01)
- Fixing File.exists is deprecated for File.exist
v0.14.0 (2014-08-31)
- [#14] Adds basic testing suite including Berksfile
- [#14] Adds basic integration/post-converge tests
- [#14] Adds default prefix and postfix rules to disalow traffic
v0.13.2 (2014-04-09)
- [COOK-4496] Added Amazon Linux support
v0.13.0 (2014-03-19)
- [COOK-3927] Substitute Perl version of rebuild-iptables with Ruby version
v0.12.2 (2014-03-18)
- [COOK-4411] - Add newling to iptables.snat
v0.12.0
- [COOK-2213] - iptables disabled recipe
v0.11.0
- [COOK-1883] - add perl package so rebuild script works
v0.10.0
- [COOK-641] - be able to save output on rhel-family
- [COOK-655] - use a template from other cookbooks
v0.9.3
- Current public release.
Collaborator Number Metric
6.0.1 passed this metric
Contributing File Metric
6.0.1 passed this metric
Foodcritic Metric
6.0.1 passed this metric
No Binaries Metric
6.0.1 passed this metric
Testing File Metric
6.0.1 passed this metric
Version Tag Metric
6.0.1 passed this metric
6.0.1 passed this metric
6.0.1 passed this metric
Foodcritic Metric
6.0.1 passed this metric
No Binaries Metric
6.0.1 passed this metric
Testing File Metric
6.0.1 passed this metric
Version Tag Metric
6.0.1 passed this metric
6.0.1 passed this metric
6.0.1 passed this metric
Testing File Metric
6.0.1 passed this metric
Version Tag Metric
6.0.1 passed this metric
6.0.1 passed this metric
6.0.1 passed this metric
