realloc / cookbook-firewalld

Chef recipe to manage firewalld ports

firewalld LWRP

Firewalld is the userland interface to dynamically managing a Linux firewall, introduced in Fedora 15 and Centos/RHEL 7.

Resource Overview

This firewalld cookbook provides three resources for adding and removing services, ports, and rules.

service

The firewalld_service resource will add the service for a zone to the current and permanent configurations. The service name is one of the firewalld provided services. To get a list of the supported services, use firewall-cmd --get-services. If zone is omitted, default zone will be used.

Actions

• :add - add the service to the current and permanent configuration
• :remove - remove the service from the current and permanent configuration

Attributes

Attribute	Description	Example	Default
service	(name attribute) the service to manage	http
zone	firewalld zone to add or remove service from	public	(none, uses default zone)

Default action adds a service to the firewall:

firewalld_service 'http'

This will allow access to the http service in the default zone.

:add

Add the service to zone. If zone is omitted, default zone will be used.

firewalld_service 'tftp' do
	action :add
	zone   'public'
end

:remove

Removes the service from zone. If zone is omitted, default zone will be used.

firewalld_service 'telnet' do
action :remove
zone   'public'
end

port

The firewalld_port resource will add the port for a zone to the current and permanent configurations. If zone is omitted, default zone will be used.

Actions

• :add - add the port to the current and permanent configuration
• :remove - remove the port from the current and permanent configuration

Attributes

Attribute	Description	Example	Default
port	(name attribute) the port to manage	993/tcp
zone	firewalld zone to add or remove port from	public	(none, uses default zone)

Default action adds a port to the firewall:

firewalld_port '993/tcp'

This will allow access to TCP port 993 in the default zone.

:add

Add the port to zone. If zone is omitted, default zone will be used.

firewalld_port '993/tcp' do
  action :add
  zone   'public'
end

:remove

Removes the port from zone. If zone is omitted, default zone will be used.

firewalld_port '993/tcp' do
	action :remove
	zone   'public'
end

rich_rule

The firewalld_rich_rule resource allows you to create complex rules directly onto the firewall. It will load the rule into the running config and pass it to firewalld with the --permanent flag, to persist it after a reload.

Actions

• :add - add the rich rule to the current and permanent configuration
• :remove - remove the rich rule from the current and permanent configuration

Attributes

The attributes for rich_rule map directly to the firewall-cmd (1) command-line parameters. More can be read here: Complex Firewall Rules with Rich Language and firewalld.richlanguage (5).

Attribute	Description	Example	Default
name	(name attribute) The name of the resource. This is not passed to firewall-cmd.	ssh_add
zone	firewalld zone to add or remove port from	public	(none, uses default zone)
family	IP family. Choice of 'ipv4' or 'ipv6'.	ipv6	ipv4
source_address	Limits the origin of a connection attempt to a specific range of IPs.	192.168.100.5/32	(none, not limited)
destination_address	Limits the target of a connection attempt to a specific range of IPs.	192.168.100.5/32	(none, not limited)
service_name	The service name is one of the firewalld provided services. To get a list of the supported services, use firewall-cmd --get-services.	ssh
port_number	Can be a single integer or a port range, for example '5060-5062'. The protocol can be specified. Requires that port_protocol attribute be specified also.	5060
port_protocol	The protocol for the specified port, can be 'tcp' or 'udp'. Requires that port_number attribute be specified also.	tcp
log_prefix	Logs new connection attempts with kernel logging. This will prepend the log lines with this prefix.	ssh
log_level	Can be one of 'emerg', 'alert', 'error', 'warning', 'notice', 'info', or 'debug'.	info
limit_value	Limits the rate at which logs are written.	1/m	1/m - one write per minute
firewall_action	Can be one of 'accept', 'reject', or 'drop'. This is the behavior by which all traffic that matches the rule will be handled.	accept

:add

# This opens the ssh service to ip `192.168.100.5` and logs at a rate of
# 1 entry per minute with a prefix of ssh on each log entry.
#

firewalld_rich_rule "ssh_add" do
  zone 'public'
  family 'ipv4'
  source_address '192.168.100.5/32'
  service_name 'ssh'
  log_prefix 'ssh'
  log_level 'info'
  limit_value '1/m'
  firewall_action 'accept'
  action :add
end

Recipes

• default - installs and enables firewalld.
• disable - disable firewalld and use iptables if node[:firewalld][:iptables_fallback] is set.
• enable - revert to firewalld if node[:firewalld][:iptables_fallback] is set.

Usage

If you're using Berkshelf, just add firewalld to your Berksfile and metadata.rb:

# Berksfile
cookbook 'firewalld'

# metadata.rb
depends 'firewalld'

Contributing

1. Fork the project
2. Create a feature branch corresponding to you change
3. Commit and test thoroughly
4. Create a Pull Request on github

License & Authors

• Author:: Jeff Hutchison [email protected]
• Author:: Manuel Toledo [email protected]

Copyright 2015, Jeff Hutchison

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.