diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9ca390c --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.kitchen/* + diff --git a/.kitchen.yml b/.kitchen.yml new file mode 100644 index 0000000..90caff8 --- /dev/null +++ b/.kitchen.yml @@ -0,0 +1,27 @@ +driver: + name: docker_cli + +transport: + name: docker_cli + +provisioner: + name: ansible_playbook + hosts: localhost + require_ansible_repo: false + require_ansible_omnibus: true + require_chef_for_busser: true + ansible_verbose: false + ansible_version: <% if ENV['ANSIBLE_VERSION'] %><%= ENV['ANSIBLE_VERSION'] %><% else %><%= '2.4.4.0' %><% end %> + ansible_inventory: ./test/integration/inventory + +platforms: + - name: debian-9 + driver_config: + image: nishiki/ansible:stretch + command: /bin/systemd + volume: + - /sys/fs/cgroup:/sys/fs/cgroup:ro + security_opt: seccomp=unconfined + +suites: + - name: fail2ban diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ee81313 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +# CHANGELOG +## v1.0.0 (2018-08-06) + +* first version diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..0d96441 --- /dev/null +++ b/Gemfile @@ -0,0 +1,8 @@ +source 'https://rubygems.org' + +group :development do + gem 'kitchen-ansible' + gem 'kitchen-docker_cli' + gem 'rubocop', '0.50.0' + gem 'test-kitchen' +end diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..6fd0d29 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,92 @@ +GEM + remote: https://rubygems.org/ + specs: + ast (2.4.0) + builder (3.2.3) + erubis (2.7.0) + ffi (1.9.23) + gssapi (1.2.0) + ffi (>= 1.0.1) + gyoku (1.3.1) + builder (>= 2.1.2) + httpclient (2.8.3) + kitchen-ansible (0.47.5) + net-ssh (>= 3) + test-kitchen (~> 1.4) + kitchen-docker_cli (0.18.0) + test-kitchen (>= 1.3) + little-plugger (1.1.4) + logging (2.2.2) + little-plugger (~> 1.1) + multi_json (~> 1.10) + mixlib-install (3.9.3) + mixlib-shellout + mixlib-versioning + thor + mixlib-shellout (2.3.2) + mixlib-versioning (1.2.2) + multi_json (1.13.1) + net-scp (1.2.1) + net-ssh (>= 2.6.5) + net-ssh (4.2.0) + net-ssh-gateway (1.3.0) + net-ssh (>= 2.6.5) + nori (2.6.0) + parallel (1.12.1) + parser (2.5.0.2) + ast (~> 2.4.0) + powerpack (0.1.1) + rainbow (2.2.2) + rake + rake (12.3.1) + rubocop (0.50.0) + parallel (~> 1.10) + parser (>= 2.3.3.1, < 3.0) + powerpack (~> 0.1) + rainbow (>= 2.2.2, < 3.0) + ruby-progressbar (~> 1.7) + unicode-display_width (~> 1.0, >= 1.0.1) + ruby-progressbar (1.9.0) + rubyntlm (0.6.2) + rubyzip (1.2.1) + test-kitchen (1.20.0) + mixlib-install (~> 3.6) + mixlib-shellout (>= 1.2, < 3.0) + net-scp (~> 1.1) + net-ssh (>= 2.9, < 5.0) + net-ssh-gateway (~> 1.2) + thor (~> 0.19, < 0.19.2) + winrm (~> 2.0) + winrm-elevated (~> 1.0) + winrm-fs (~> 1.1.0) + thor (0.19.1) + unicode-display_width (1.3.0) + winrm (2.2.3) + builder (>= 2.1.2) + erubis (~> 2.7) + gssapi (~> 1.2) + gyoku (~> 1.0) + httpclient (~> 2.2, >= 2.2.0.2) + logging (>= 1.6.1, < 3.0) + nori (~> 2.0) + rubyntlm (~> 0.6.0, >= 0.6.1) + winrm-elevated (1.1.0) + winrm (~> 2.0) + winrm-fs (~> 1.0) + winrm-fs (1.1.1) + erubis (~> 2.7) + logging (>= 1.6.1, < 3.0) + rubyzip (~> 1.1) + winrm (~> 2.0) + +PLATFORMS + ruby + +DEPENDENCIES + kitchen-ansible + kitchen-docker_cli + rubocop (= 0.50.0) + test-kitchen + +BUNDLED WITH + 1.16.0 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f1bc6d1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 2018 Adrien Waksberg + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..261f0f4 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# Ansible role: Fail2ban +[![Version](https://img.shields.io/badge/latest_version-1.0.0-green.svg)](https://git.yaegashi.fr/nishiki/ansible-role-fail2ban/releases) +[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://git.yaegashi.fr/nishiki/ansible-role-fail2ban/src/branch/master/LICENSE) + +Install and configure Fail2ban + +## Requirements + +None + +## Role variables + +* `fail2ban_blocktype` - iptable policy for an ip banned (default: `DROP`) +* `fail2ban_bantime` - default ban time in second (default: `600`) +* `fail2ban_findtime` - default find time in second to count the retries (default: `600`) +* `fail2ban_maxretry` - default max retry before a ban (default: `6`) +* `fail2ban_ignoreip` - array with the ips ignored +* `fail2ban_filters` - array with custom filters +``` + - name: web + failregex: Login failed.*Remote IP.*'' +``` +* `fail2ban_jails` - array with the modules to enable +``` + - name: web + logpath: /var/log/web.log + filter: web + port: 80,443 + additional: + maxretry: 3 + bantime: 3600 +``` + +## How to use + + * Install: +``` +- hosts: server + roles: + - fail2ban +``` + +## Development +### Tests with docker + + * install [docker](https://docs.docker.com/engine/installation/) + * install ruby + * install bundler `gem install bundler` + * install dependencies `bundle install` + * run the tests `kitchen test` + +## License + +``` +Copyright (c) 2018 Adrien Waksberg + +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. +``` diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..2818bba --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,9 @@ +fail2ban_blocktype: DROP +fail2ban_bantime: 600 +fail2ban_findtime: 600 +fail2ban_maxretry: 6 +fail2ban_backend: polling +fail2ban_usedns: warn +fail2ban_ignoreip: [] +fail2ban_filters: [] +fail2ban_jails: [] diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100644 index 0000000..6fb1449 --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,2 @@ +- name: restart fail2ban + service: name=fail2ban state=restarted diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..0fe7e1d --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,63 @@ +- name: install fail2ban packages + apt: + name: '{{ item }}' + state: present + with_items: + - fail2ban + - whois + - bsd-mailx + tags: fail2ban + +- name: remove default config + file: + path: /etc/fail2ban/jail.d/defaults-debian.conf + state: absent + tags: fail2ban + +- name: copy main configuration + template: + src: jail.conf.j2 + dest: /etc/fail2ban/jail.conf + owner: root + group: root + mode: 0644 + notify: restart fail2ban + tags: fail2ban + +- name: copy iptables blocktype configuration + template: + src: iptables-blocktype.conf.j2 + dest: /etc/fail2ban/action.d/iptables-blocktype.conf + owner: root + group: root + mode: 0644 + notify: restart fail2ban + tags: fail2ban + +- name: copy fail2ban filters + template: + src: filter.conf.j2 + dest: '/etc/fail2ban/filter.d/{{ item.name }}.conf' + owner: root + group: root + mode: 0644 + with_items: '{{ fail2ban_filters }}' + notify: restart fail2ban + tags: fail2ban + +- name: copy jails file + template: + src: 'jails.conf.j2' + dest: '/etc/fail2ban/jail.d/jails.conf' + owner: root + group: root + mode: 0644 + notify: restart fail2ban + tags: fail2ban + +- name: enable and start fail2ban + service: + name: fail2ban + enabled: yes + state: started + tags: fail2ban diff --git a/templates/filter.conf.j2 b/templates/filter.conf.j2 new file mode 100644 index 0000000..c96b6f0 --- /dev/null +++ b/templates/filter.conf.j2 @@ -0,0 +1,7 @@ +; {{ ansible_managed }} +[INCLUDES] +before = common.conf + +[Definition] +failregex = {{ item.failregex }} +ignoreregex = {{ item.ignoreregex|default('') }} diff --git a/templates/iptables-blocktype.conf.j2 b/templates/iptables-blocktype.conf.j2 new file mode 100644 index 0000000..d954fc2 --- /dev/null +++ b/templates/iptables-blocktype.conf.j2 @@ -0,0 +1,6 @@ +; {{ ansible_managed }} +[INCLUDES] +after = iptables-blocktype.local + +[Init] +blocktype = {{ fail2ban_blocktype }} diff --git a/templates/jail.conf.j2 b/templates/jail.conf.j2 new file mode 100644 index 0000000..911ae82 --- /dev/null +++ b/templates/jail.conf.j2 @@ -0,0 +1,33 @@ +; {{ ansible_managed }} +[DEFAULT] + +ignoreip = 127.0.0.1/8{% for ip in fail2ban_ignoreip %} {{ ip }}{% endfor %} +ignorecommand = + +bantime = {{ fail2ban_bantime }} +findtime = {{ fail2ban_findtime }} +maxretry = {{ fail2ban_maxretry }} +backend = {{ fail2ban_backend }} +usedns = {{ fail2ban_usedns }} + +{% if fail2ban_mail is defined %} +destemail = {{ fail2ban_mail.destmail }} +sendername = {{ fail2ban_mail.sendername|default('Fail2Ban') }} +sender = {{ fail2ban_mail.sender_mail }} +mta = {{ fail2ban_mail.mta|default('mail') }} + +{% endif %} +banaction = iptables-multiport +protocol = tcp +chain = INPUT +action_ = %(banaction)s[name=%(__name__)s, port="%(port)s", protocol="%(protocol)s", chain="%(chain)s"] +action_mw = %(banaction)s[name=%(__name__)s, port="%(port)s", protocol="%(protocol)s", chain="%(chain)s"] +{% if fail2ban_mail is defined %} + %(mta)s-whois[name=%(__name__)s, dest="%(destemail)s", protocol="%(protocol)s", chain="%(chain)s", sendername="%(sendername)s"] + +{% endif %} +action_mwl = %(banaction)s[name=%(__name__)s, port="%(port)s", protocol="%(protocol)s", chain="%(chain)s"] +{% if fail2ban_mail is defined %} + %(mta)s-whois-lines[name=%(__name__)s, dest="%(destemail)s", logpath=%(logpath)s, chain="%(chain)s", sendername="%(sendername)s"] +{% endif %} +action = %(action_mw)s diff --git a/templates/jails.conf.j2 b/templates/jails.conf.j2 new file mode 100644 index 0000000..d83124c --- /dev/null +++ b/templates/jails.conf.j2 @@ -0,0 +1,14 @@ +; {{ ansible_managed }} +{% for jail in fail2ban_jails %} + +[{{ jail.name }}] +enabled = true +logpath = {{ jail.logpath }} +port = {{ jail.port }} +filter = {{ jail.filter }} +{% if jail.additional is defined %} +{% for option, value in jail.additional.iteritems() %} +{{ option }} = {{ value }} +{% endfor %} +{% endif %} +{% endfor %} diff --git a/test/integration/fail2ban/default.yml b/test/integration/fail2ban/default.yml new file mode 100644 index 0000000..f833998 --- /dev/null +++ b/test/integration/fail2ban/default.yml @@ -0,0 +1,19 @@ +- hosts: fail2ban + connection: local + vars: + fail2ban_jails: + - name: ssh + logpath: /var/log/alternatives.log + filter: sshd + port: 22 + - name: nextcloud + logpath: /var/log/alternatives.log + filter: nextcloud + port: 80,443 + additional: + maxretry: 2 + fail2ban_filters: + - name: nextcloud + failregex: Login failed.*Remote IP.*'' + roles: + - ansible-role-fail2ban diff --git a/test/integration/fail2ban/serverspec/fail2ban_spec.rb b/test/integration/fail2ban/serverspec/fail2ban_spec.rb new file mode 100644 index 0000000..adff4e7 --- /dev/null +++ b/test/integration/fail2ban/serverspec/fail2ban_spec.rb @@ -0,0 +1,42 @@ +require 'serverspec' + +set :backend, :exec + +describe package('fail2ban') do + it { should be_installed } +end + +describe file('/etc/fail2ban/jail.conf') do + it { should exist } + it { should be_file } + it { should be_mode 644 } + it { should be_owned_by 'root' } + it { should be_grouped_into 'root' } + it { should contain 'bantime = 600' } +end + +describe file('/etc/fail2ban/jail.d/jails.conf') do + it { should exist } + it { should be_file } + it { should be_mode 644 } + it { should be_owned_by 'root' } + it { should be_grouped_into 'root' } + it { should contain '[ssh]' } + it { should contain '[nextcloud]' } + it { should contain 'port = 80,443' } + it { should contain 'maxretry = 2' } +end + +describe file('/etc/fail2ban/filter.d/nextcloud.conf') do + it { should exist } + it { should be_file } + it { should be_mode 644 } + it { should be_owned_by 'root' } + it { should be_grouped_into 'root' } + it { should contain "failregex = Login failed.*Remote IP.*''" } +end + +describe service('fail2ban') do + it { should be_enabled } + it { should be_running.under('systemd') } +end diff --git a/test/integration/inventory b/test/integration/inventory new file mode 100644 index 0000000..91de0ff --- /dev/null +++ b/test/integration/inventory @@ -0,0 +1,2 @@ +[fail2ban] +localhost