cloud-mu 3.5.0 → 3.6.3

data/cookbooks/firewall/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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.
+

data/cookbooks/firewall/README.md

@@ -1,60 +1,79 @@
-firewall Cookbook
-=================
+# firewall Cookbook
 
-[![Build Status](https://travis-ci.org/chef-cookbooks/firewall.svg?branch=master)](http://travis-ci.org/chef-cookbooks/firewall)
 [![Cookbook Version](https://img.shields.io/cookbook/v/firewall.svg)](https://supermarket.chef.io/cookbooks/firewall)
+[![CI State](https://github.com/sous-chefs/firewall/workflows/ci/badge.svg)](https://github.com/sous-chefs/firewall/actions?query=workflow%3Aci)
+[![OpenCollective](https://opencollective.com/sous-chefs/backers/badge.svg)](#backers)
+[![OpenCollective](https://opencollective.com/sous-chefs/sponsors/badge.svg)](#sponsors)
+[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
 
 Provides a set of primitives for managing firewalls and associated rules.
 
 PLEASE NOTE - The resource/providers in this cookbook are under heavy development. An attempt is being made to keep the resource simple/stupid by starting with less sophisticated firewall implementations first and refactor/vet the resource definition with each successive provider.
 
-Requirements
-------------
-**Chef 12.5.x+** is required. We are currently testing against Chef 13. If you need Chef 11 support, please try pinning back to a version less than 2.0, e.g.:
-```
-depends 'firewall', '< 2.0'
+## Maintainers
+
+This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit [sous-chefs.org](https://sous-chefs.org/) or come chat with us on the Chef Community Slack in [#sous-chefs](https://chefcommunity.slack.com/messages/C2V7B88SF).
+
+## Requirements
+
+- Chef Infra Client 15.5+
+
+```ruby
+depends 'firewall'
 ```
 
 ### Supported firewalls and platforms
-* UFW - Ubuntu, Debian (except 9)
-* IPTables - Red Hat & CentOS, Ubuntu
-* FirewallD - Red Hat & CentOS >= 7.0 (IPv4 only support, [needs contributions/testing](https://github.com/chef-cookbooks/firewall/issues/86))
-* Windows Advanced Firewall - 2012 R2
+
+- UFW - Ubuntu, Debian (except 9)
+- IPTables - Red Hat & CentOS, Ubuntu
+- FirewallD - Red Hat & CentOS >= 7.0 (IPv4 only support, [needs contributions/testing](https://github.com/chef-cookbooks/firewall/issues/86))
+- Windows Advanced Firewall - 2012 R2
+- nftables
 
 Tested on:
-* Ubuntu 14.04, 16.04 with iptables, ufw
-* Debian 7, 8 with ufw
-* Debian 9 with iptables
-* CentOS 6 with iptables
-* CentOS 7.1 with firewalld
-* Windows Server 2012r2 with Windows Advanced Firewall
+
+- Ubuntu 16.04 with iptables, ufw
+- Debian 9 with iptables
+- Debian 11 with nftables
+- Debian 11 with new resources for firewalld
+- CentOS 6 with iptables
+- CentOS 7.1 with firewalld
+- Oracle 8 with nftables
+- Windows Server 2012r2 with Windows Advanced Firewall
 
 By default, Ubuntu chooses ufw. To switch to iptables, set this in an attribute file:
-```
+
+```ruby
 default['firewall']['ubuntu_iptables'] = true
 ```
 
 By default, Red Hat & CentOS >= 7.0 chooses firewalld. To switch to iptables, set this in an attribute file:
-```
+
+```ruby
 default['firewall']['redhat7_iptables'] = true
 ```
 
-# Considerations that apply to all firewall providers and resources
+In order to use nftables, just use the resource `nftables` and
+`nftables_rule`.  These resources are written in more modern design
+styles and are not configurable by node attributes.
+
+## Considerations that apply to all firewall providers and resources
 
 This cookbook comes with two resources, firewall and firewall rule. The typical usage scenario is as follows:
 
 - run the `:install` action on the `firewall` resource named 'default', which installs appropriate packages and configures services to start on boot and starts them
-
 - run the `:create` action on every `firewall_rule` resource, which adds to the list of rules that should be configured on the firewall. `firewall_rule` then automatically sends a delayed notification to the `firewall['default']` resource to run the `:restart` action.
-
 - run the delayed notification with action `:restart` on the `firewall` resource. if any rules are different than the last run, the provider will update the current state of the firewall rules to match the expected rules.
 
 There is a fundamental mismatch between the idea of a chef action and the action that should be taken on a firewall rule. For this reason, the chef action for a firewall_rule may be `:nothing` (the rule should not be present in the firewall) or `:create` (the rule should be present in the firewall), but the action taken on a packet in a firewall (`DROP`, `ACCEPT`, etc) is denoted as a `command` parameter on the `firewall_rule` resource.
 
-# iptables considerations
+The same points hold for the `nftables`- and `nftables_rule`-resources.
+
+## iptables considerations
 
 If you need to use a table other than `*filter`, the best way to do so is like so:
-```
+
+```ruby
 node.default['firewall']['iptables']['defaults'][:ruleset] = {
   '*filter' => 1,
   ':INPUT DROP' => 2,
@@ -72,7 +91,8 @@ node.default['firewall']['iptables']['defaults'][:ruleset] = {
 Note -- in order to support multiple hash keys containing the same rule, anything found after the underscore will be stripped for: `:OUTPUT :INPUT :POSTROUTING :PREROUTING COMMIT`. This allows an example like the above to be reduced to just repeated lines of `COMMIT` and `:OUTPUT ACCEPT` while still avoiding duplication of other things.
 
 Then it's trivial to add additional rules to the `*nat` table using the raw parameter:
-```
+
+```ruby
 firewall_rule "postroute" do
   raw "-A POSTROUTING -o eth1 -p tcp -d 172.28.128.21 -j SNAT --to-source 172.28.128.6"
   position 150
@@ -82,42 +102,57 @@ end
 Note that any line starting with `COMMIT` will become just `COMMIT`, as hash
 keys must be unique but we need multiple commit lines.
 
-# Recipes
+## nftables
+
+Please read the documentation for the
+[`nftables` resource](documentation/resource_nftables.md) and the
+[`nftables_rule` resource](documentation/resource_nftables_rule.md)
 
 ### default
+
 The default recipe creates a firewall resource with action install.
 
 ### disable_firewall
-Used to disable platform specific firewall. Many clouds have their own firewall configured outside of the OS instance such as AWS Security Groups.
-
-# Attributes
-
-* `default['firewall']['allow_ssh'] = false`, set true to open port 22 for SSH when the default recipe runs
-* `default['firewall']['allow_mosh'] = false`, set to true to open UDP ports 60000 - 61000 for [Mosh][0] when the default recipe runs
-* `default['firewall']['allow_winrm'] = false`, set true to open port 5989 for WinRM when the default recipe runs
-* `default['firewall']['allow_loopback'] = false`, set to true to allow all traffic on the loopback interface
-* `default['firewall']['allow_icmp'] = false`, set true to allow icmp protocol on supported OSes (note: ufw and windows implementations don't support this)
-
-* `default['firewall']['ubuntu_iptables'] = false`, set to true to use iptables on Ubuntu / Debian when using the default recipe
-* `default['firewall']['redhat7_iptables'] = false`, set to true to use iptables on Red Hat / CentOS 7 when using the default recipe
 
-* `default['firewall']['ufw']['defaults']` hash for template `/etc/default/ufw`
-* `default['firewall']['iptables']['defaults']` hash for default policies for 'filter' table's chains`
-
-* `default['firewall']['windows']['defaults']` hash to define inbound / outbound firewall policy on Windows platform
-
-* `default['firewall']['allow_established'] = true`, set to false if you don't want a related/established default rule on iptables
-* `default['firewall']['ipv6_enabled'] = true`, set to false if you don't want IPv6 related/established default rule on iptables (this enables ICMPv6, which is required for much of IPv6 communication)
-
-* `default['firewall']['firewalld']['permanent'] = false`, set to true if you want firewalld rules to be added with `--permanent` so they survive a reboot. This will be changed to `true` by default in a future major version release.
+Used to disable platform specific firewall. Many clouds have their own firewall configured outside of the OS instance such as AWS Security Groups.
 
-# Resources
+### firewalld
+
+A firewalld specific recipe creates a firewall resource with action install with the default zone (default: `drop`)
+
+## Attributes
+
+- `default['firewall']['allow_ssh'] = false`, set true to open port 22 for SSH when the default recipe runs
+- `default['firewall']['allow_mosh'] = false`, set to true to open UDP ports 60000 - 61000 for [Mosh][0] when the default recipe runs
+- `default['firewall']['allow_winrm'] = false`, set true to open port 5989 for WinRM when the default recipe runs
+- `default['firewall']['allow_loopback'] = false`, set to true to allow all traffic on the loopback interface
+- `default['firewall']['allow_icmp'] = false`, set true to allow icmp protocol on supported OSes (note: ufw and windows implementations don't support this)
+- `default['firewall']['ubuntu_iptables'] = false`, set to true to use iptables on Ubuntu / Debian when using the default recipe
+- `default['firewall']['redhat7_iptables'] = false`, set to true to use iptables on Red Hat / CentOS 7 when using the default recipe
+- `default['firewall']['ufw']['defaults']` hash for template `/etc/default/ufw`
+- `default['firewall']['iptables']['defaults']` hash for default policies for 'filter' table's chains`
+- `default['firewall']['windows']['defaults']` hash to define inbound / outbound firewall policy on Windows platform
+- `default['firewall']['allow_established'] = true`, set to false if you don't want a related/established default rule on iptables
+- `default['firewall']['ipv6_enabled'] = true`, set to false if you don't want IPv6 related/established default rule on iptables (this enables ICMPv6, which is required for much of IPv6 communication)
+- `default['firewall']['firewalld']['permanent'] = false`, set to true if you want firewalld rules to be added with `--permanent` so they survive a reboot. This will be changed to `true` by default in a future major version release.
+- `default['firewall']['firewalld']['permanent'] = false`, set to true if you want firewalld rules to be added with `--permanent` so they survive a reboot. This will be changed to `true` by default in a future major version release.
+- `default['firewall']['firewalld']['zone'] = 'drop'`, Default zone for firewall
+- `default['firewall']['firewalld']['loopback_zone'] = 'trusted'`, zone for loopback to be enabled (using `allow_loopback`)
+- `default['firewall']['firewalld']['icmp_zone'] = 'public'`, zone for icmp to be enabled (using `allow_icmp`)
+- `default['firewall']['firewalld']['ssh_zone'] = 'public'`, zone for ssh to be enabled (using `allow_ssh`)
+- `default['firewall']['firewalld']['mosh_zone'] = 'public'`, zone for mosh to be enabled (using `allow_mosh`)
+- `default['firewall']['firewalld']['established_zone'] = 'public'`, zone for loopback to be enabled (using `allow_established`)
+
+## Resources
+
+There is a separate folder for [`firewalld` resources](documentation/README.md).
 
 ### firewall
 
 ***NB***: The name 'default' of this resource is important as it is used for firewall_rule providers to locate the firewall resource. If you change it, you must also supply the same value to any firewall_rule resources using the `firewall_name` parameter.
 
 #### Actions
+
 - `:install` (*default action*): Install and Enable the firewall. This will ensure the appropriate packages are installed and that any services have been started.
 - `:disable`: Disable the firewall. Drop any rules and put the node in an unprotected state. Flush all current rules. Also erase any internal state used to detect when rules should be applied.
 - `:flush`: Flush all current rules. Also erase any internal state used to detect when rules should be applied.
@@ -133,8 +168,6 @@ Used to disable platform specific firewall. Many clouds have their own firewall
 - `enabled_zone` (firewalld only): The zone to set on firewalld when the firewall should be enabled. Can be any string in symbol form, e.g. :public, :drop, etc. Defaults to `:drop.`
 - `package_options`: Used to pass options to the package install of firewall
 
-#### Examples
-
 ```ruby
 # all defaults
 firewall 'default'
@@ -154,55 +187,37 @@ end
 ### firewall_rule
 
 #### Actions
-- `:create` (_default action_): If a firewall_rule runs this action, the rule will be recorded in a chef resource's internal state, and applied when providers automatically notify the firewall resource with action `:reload`. The notification happens automatically.
+
+- `:create` (*default action*): If a firewall_rule runs this action, the rule will be recorded in a chef resource's internal state, and applied when providers automatically notify the firewall resource with action `:reload`. The notification happens automatically.
 
 #### Parameters
 
 - `firewall_name`: the matching firewall resource that this rule applies to. Default value: `default`
-
 - `raw`: Used to pass an entire rule as a string, omitting all other parameters. This line will be directly loaded by `iptables-restore`, fed directly into `ufw` on the command line, or run using `firewall-cmd`.
-
-- `description` (_default: same as rule name_): Used to provide a comment that will be included when adding the firewall rule.
-
-- `include_comment` (_default: true_): Used to optionally exclude the comment in the rule.
-
-- `position` (_default: 50_): **relative** position to insert rule at. Position may be any integer between 0 < n < 100 (exclusive), and more than one rule may specify the same position.
-
+- `description` (*default: same as rule name*): Used to provide a comment that will be included when adding the firewall rule.
+- `include_comment` (*default: true*): Used to optionally exclude the comment in the rule.
+- `position` (*default: 50*): **relative** position to insert rule at. Position may be any integer between 0 < n < 100 (exclusive), and more than one rule may specify the same position.
 - `command`: What action to take on a particular packet
-
-  - `:allow` (_default action_): the rule should allow matching packets
-  - `:deny`: the rule should deny matching packets
-  - `:reject`: the rule should reject matching packets
-  - `:masqerade`: Masquerade the matching packets
-  - `:redirect`: Redirect the matching packets
-  - `:log`: Configure logging
-
+   - `:allow` (*default action*): the rule should allow matching packets
+   - `:deny`: the rule should deny matching packets
+   - `:reject`: the rule should reject matching packets
+   - `:masquerade`: Masquerade the matching packets
+   - `:redirect`: Redirect the matching packets
+   - `:log`: Configure logging
 - `stateful`: a symbol or array of symbols, such as ``[:related, :established]` that will be passed to the state module in iptables or firewalld.
-
-- `protocol`: `:tcp` (_default_), `:udp`, `:icmp`, `:none` or protocol number. Using protocol numbers is not supported using the ufw provider (default for debian/ubuntu systems).
-
-- `direction`: For ufw, direction of the rule. valid values are: `:in` (_default_), `:out`, `:pre`, `:post`.
-
-- `source` (_Default is `0.0.0.0/0` or `Anywhere`_): source ip address or subnet to filter.
-
-- `source_port` (_Default is nil_): source port for filtering packets.
-
+- `zone`: (*firewalld only*), a string, such as `public` that the rule will be applied.
+- `protocol`: `:tcp` (*default*), `:udp`, `:icmp`, `:none` or protocol number. Using protocol numbers is not supported using the ufw provider (default for debian/ubuntu systems).
+- `direction`: For ufw, direction of the rule. valid values are: `:in` (*default*), `:out`, `:pre`, `:post`.
+- `source` (*Default is `0.0.0.0/0` or `Anywhere`*): source ip address or subnet to filter.
+- `source_port` (*Default is nil*): source port for filtering packets.
 - `destination`: ip address or subnet to filter on packet destination, must be a valid IP
-
 - `port` or `dest_port`: target port number (ie. 22 to allow inbound SSH), or an array of incoming port numbers (ie. [80,443] to allow inbound HTTP & HTTPS).
-
-   NOTE: `protocol` attribute is required with multiple ports, or a range of incoming port numbers (ie. 60000..61000 to allow inbound mobile-shell. NOTE: `protocol`, or an attribute is required with a range of ports.
-
+  NOTE: `protocol` attribute is required with multiple ports, or a range of incoming port numbers (ie. 60000..61000 to allow inbound mobile-shell. NOTE: `protocol`, or an attribute is required with a range of ports.
 - `interface`: (source) interface to apply rule (ie. `eth0`).
-
 - `dest_interface`: interface where packets may be destined to go
-
 - `redirect_port`: redirected port for rules with command `:redirect`
-
 - `logging`: may be added to enable logging for a particular rule. valid values are: `:connections`, `:packets`. In the ufw provider, `:connections` logs new connections while `:packets` logs all packets.
 
-#### Examples
-
 ```ruby
 # open standard ssh port
 firewall_rule 'ssh' do
@@ -246,7 +261,7 @@ firewall_rule "VRRP" do
   raw "allow to 224.0.0.18"
 end
 
-# open UDP ports 60000..61000 for mobile shell (mosh.mit.edu), note
+# open UDP ports 60000..61000 for mobile shell (mosh.org), note
 # that the protocol attribute is required when using port_range
 firewall_rule 'mosh' do
   protocol   :udp
@@ -262,6 +277,13 @@ firewall_rule 'http/https' do
   command   :allow
 end
 
+# firewalld example of opening port 22 on public zone
+firewall_rule 'ssh' do
+  port    22
+  zone    "public"
+  command :allow
+end
+
 firewall 'default' do
   enabled false
   action :nothing
@@ -274,66 +296,71 @@ end
 
 Different providers will determine the current state of the rules differently -- parsing the output of a command, maintaining the state in a file, or some other way. If the firewall is adjusted from outside of chef (non-idempotent), it's possible that chef may be caught unaware of the current state of the firewall. The best workaround is to add a `:flush` action to the firewall resource as early as possible in the chef run, if you plan to modify the firewall state outside of chef.
 
-# Troubleshooting
+## Troubleshooting
 
 To figure out what the position values are for current rules, print the hash that contains the weights:
-```
+
+```ruby
 require pp
 default_firewall = resources(:firewall, 'default')
 pp default_firewall.rules
 ```
 
-# Development
+## Development
+
 This section details "quick development" steps. For a detailed explanation, see [[Contributing.md]].
 
 1. Clone this repository from GitHub:
 
-        $ git clone git@github.com:chef-cookbooks/firewall.git
+`$ git clone git@github.com:chef-cookbooks/firewall.git`
 
-2. Create a git branch
+1. Create a git branch
 
-        $ git checkout -b my_bug_fix
+`$ git checkout -b my_bug_fix`
 
-3. Install dependencies:
+1. Install dependencies:
 
-        $ bundle install
+`$ bundle install`
 
-4. Make your changes/patches/fixes, committing appropiately
-5. **Write tests**
-6. Run the tests:
-    - `bundle exec foodcritic -f any .`
-    - `bundle exec rspec`
-    - `bundle exec rubocop`
-    - `bundle exec kitchen test`
+1. Make your changes/patches/fixes, committing appropiately
+1. **Write tests**
+1. Run the tests:
 
-  In detail:
-    - Foodcritic will catch any Chef-specific style errors
-    - RSpec will run the unit tests
-    - Rubocop will check for Ruby-specific style errors
-    - Test Kitchen will run and converge the recipes
+- `bundle exec foodcritic -f any .`
+- `bundle exec rspec`
+- `bundle exec rubocop`
+- `bundle exec kitchen test`
 
+In detail:
 
-# License & Authors
-<!-- $ find -type f -iname "*.rb" -exec grep -i author '{}' \; | sort -k4 | uniq | sed 's/#/-/g' -->
-- Author:: Seth Chisamore (<schisamo@opscode.com>)
-- Author:: Ronald Doorn (<rdoorn@schubergphilis.com>)
-- Author:: Martin Smith (<martin@mbs3.org>)
-- Author:: Sander van Harmelen (<svanharmelen@schubergphilis.com>)
+- Foodcritic will catch any Chef-specific style errors
+- RSpec will run the unit tests
+- Rubocop will check for Ruby-specific style errors
+- Test Kitchen will run and converge the recipes
 
-```text
-Copyright:: 2011-2015, Chef Software, Inc
+## Contributors
 
-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
+This project exists thanks to all the people who [contribute.](https://opencollective.com/sous-chefs/contributors.svg?width=890&button=false)
 
-    http://www.apache.org/licenses/LICENSE-2.0
+### Backers
 
-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.
-```
+Thank you to all our backers!
+
+![https://opencollective.com/sous-chefs#backers](https://opencollective.com/sous-chefs/backers.svg?width=600&avatarHeight=40)
+
+### Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
+
+![https://opencollective.com/sous-chefs/sponsor/0/website](https://opencollective.com/sous-chefs/sponsor/0/avatar.svg?avatarHeight=100)
+![https://opencollective.com/sous-chefs/sponsor/1/website](https://opencollective.com/sous-chefs/sponsor/1/avatar.svg?avatarHeight=100)
+![https://opencollective.com/sous-chefs/sponsor/2/website](https://opencollective.com/sous-chefs/sponsor/2/avatar.svg?avatarHeight=100)
+![https://opencollective.com/sous-chefs/sponsor/3/website](https://opencollective.com/sous-chefs/sponsor/3/avatar.svg?avatarHeight=100)
+![https://opencollective.com/sous-chefs/sponsor/4/website](https://opencollective.com/sous-chefs/sponsor/4/avatar.svg?avatarHeight=100)
+![https://opencollective.com/sous-chefs/sponsor/5/website](https://opencollective.com/sous-chefs/sponsor/5/avatar.svg?avatarHeight=100)
+![https://opencollective.com/sous-chefs/sponsor/6/website](https://opencollective.com/sous-chefs/sponsor/6/avatar.svg?avatarHeight=100)
+![https://opencollective.com/sous-chefs/sponsor/7/website](https://opencollective.com/sous-chefs/sponsor/7/avatar.svg?avatarHeight=100)
+![https://opencollective.com/sous-chefs/sponsor/8/website](https://opencollective.com/sous-chefs/sponsor/8/avatar.svg?avatarHeight=100)
+![https://opencollective.com/sous-chefs/sponsor/9/website](https://opencollective.com/sous-chefs/sponsor/9/avatar.svg?avatarHeight=100)
 
-[0]: https://mosh.mit.edu/
+[0]: https://mosh.org

data/cookbooks/firewall/TODO.md

@@ -0,0 +1,6 @@
+# TODO
+
+- update for rhel-8+ nftables, RHEL docs recommend nftables for new firewalls <https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/configuring_and_managing_networking/getting-started-with-nftables_configuring-and-managing-networking>
+- fix windows tests
+- iptables' `-S` not supported in libraries/provider_firewall_iptables.rb
+- save action might not make sense for firewalls

data/cookbooks/firewall/attributes/firewalld.rb

@@ -1 +1,8 @@
 default['firewall']['firewalld']['permanent'] = false
+default['firewall']['firewalld']['zone'] = 'drop'
+
+default['firewall']['firewalld']['loopback_zone'] = 'trusted'
+default['firewall']['firewalld']['icmp_zone'] = 'public'
+default['firewall']['firewalld']['ssh_zone'] = 'public'
+default['firewall']['firewalld']['mosh_zone'] = 'public'
+default['firewall']['firewalld']['established_zone'] = 'public'

data/cookbooks/firewall/attributes/iptables.rb

@@ -5,9 +5,9 @@ default['firewall']['iptables']['defaults'][:policy] = {
 }
 default['firewall']['iptables']['defaults'][:ruleset] = {
   '*filter' => 1,
-  ":INPUT #{node['firewall']['iptables']['defaults'][:policy][:input]}" => 2,
-  ":FORWARD #{node['firewall']['iptables']['defaults'][:policy][:forward]}" => 3,
-  ":OUTPUT #{node['firewall']['iptables']['defaults'][:policy][:output]}" => 4,
+  ":INPUT #{node['firewall']['iptables']['defaults']['policy']['input']}" => 2,
+  ":FORWARD #{node['firewall']['iptables']['defaults']['policy']['forward']}" => 3,
+  ":OUTPUT #{node['firewall']['iptables']['defaults']['policy']['output']}" => 4,
   'COMMIT_FILTER' => 100,
 }