Merge pull request #1 from asdfdotdev/development

Refactor to package

Author: chrislarrycarl

.editorconfig

@@ -10,32 +10,6 @@ trim_trailing_whitespace = true
 end_of_line = lf
 charset = utf-8
 
-# Docstrings and comments use max_line_length = 79
-[*.py]
-max_line_length = 119
-
-# Use 2 spaces for the HTML files
-[*.html]
-indent_size = 2
-
-# The JSON files contain newlines inconsistently
-[*.json]
-indent_size = 2
-insert_final_newline = ignore
-
-[**/admin/js/vendor/**]
-indent_style = ignore
-indent_size = ignore
-
-# Minified JavaScript files shouldn't be changed
-[**.min.js]
-indent_style = ignore
-insert_final_newline = ignore
-
-# Makefiles always use tabs for indentation
-[Makefile]
-indent_style = tab
-
-# Batch files use tabs for indentation
-[*.bat]
-indent_style = tab
+[{*.js,*.json,*.yml,.bablerc}]
+indent_style = space
+indent_size = 2

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -1,16 +1,18 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Create a report to help us improve fail2slack
 title: ''
 labels: ''
 assignees: ''
 
 ---
 
 **Describe the bug**
+
 A clear and concise description of what the bug is.
 
 **To Reproduce**
+
 Steps to reproduce the behavior:
 
 

.gitignore

@@ -1,6 +1,7 @@
 **/.DS_Store
-.idea
-*config.py
-**/*.log
-__pycache__/
-**/*.pyc
+.idea/
+**/__pycache__/
+**/build/
+**/dist/
+**/*.egg-info/
+.coverage

.travis.yml

@@ -0,0 +1,21 @@
+dist: xenial
+language: python
+
+python:
+  - "3.6"
+  - "3.7"
+  - "3.7.4"
+  - "3.8-dev"
+
+install:
+  - pip install -r requirements.txt
+  - pip install codecov
+  - pip install coverage
+
+script:
+  - python -m unittest discover
+  - coverage run --source fail2slack -m test.test_fail2slack
+
+after_success:
+  - codecov
+

README.md

@@ -1,46 +1,42 @@
-# fail2slack
+# fail2slack.py
 
-A friendly little script that can package up your fail2ban vault statuses and send them to you over slack.
+[![Build Status](https://travis-ci.org/asdfdotdev/fail2slack.svg?branch=master)](https://travis-ci.org/asdfdotdev/fail2slack) [![codecov](https://codecov.io/gh/asdfdotdev/fail2slack/branch/master/graph/badge.svg)](https://codecov.io/gh/asdfdotdev/fail2slack) 
 
-## Setup
+A Python package for sending fail2ban jail status updates to Slack.
 
-Create fail2slackconfig.py
+## Compatibility
 
-```
-$ cp fail2slackconfig.dist.py fail2slackconfig.py
-``` 
-
-[Setup your Slack webhook](https://api.slack.com/incoming-webhooks) and add it to the config file:
+[![Python Version](https://img.shields.io/pypi/pyversions/fail2slack)](https://pypi.org/project/fail2slack) [![Module Version](https://img.shields.io/pypi/v/fail2slack)](https://pypi.org/project/fail2slack)
 
-```
-webhook_url = 'https://hooks.slack.com/YOUR/WEBHOOK/URL'
-```
+fail2slack is developed for, and tested with, recent versions of Python.
 
-Select the vaults you want to report on:
+## Installation
 
 ```
-vaults = [
-    'apache-auth', 'apache-badbots', 'apache-botsearch',
-    'apache-fakegooglebot', 'apache-modsecurity', 'apache-nohome',
-    'apache-noscript', 'apache-overflows', 'apache-shellshock',
-    'php-url-fopen', 'sshd'
-]
+pip install fail2slack
 ```
 
-## Usage
-
-fail2slack should play nicely with Python v2 & v3. It can be run as a file or from the shell.
+Install fail2slack using the Python package installer.
 
-
-## Output
-
-The current failed/banned counts will be compiled for all selected vaults and sent via the webhook.
+## Usage
 
 ```
-vault-name
-    Failed: CURRENT (TOTAL), Banned: CURRENT (TOTAL)
+usage: fail2slack [-h] [-w WEBHOOK] [-d DELIVERY] [-j JAILS [JAILS ...]]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -w WEBHOOK, --webhook WEBHOOK
+                        Slack webhook URL. Required if delivery method is 1.
+  -d DELIVERY, --delivery DELIVERY
+                        Delivery method: 0 = print, 1 = Slack webhook.
+  -j JAILS [JAILS ...], --jails JAILS [JAILS ...]
+                        Jails to include in status report. Required.
 ```
 
-## Providing Feedback
+## Tests
+
+For instructions on running test check out the [README](./test#readme).
+
+## Contributing
 
-Please reference our [code of conduct](./.github/CODE_OF_CONDUCT.md) and [contributing](./.github/CONTRIBUTING.md) guides.
+If you'd like to contribute to fail2slack please reference our [code of conduct](./.github/CODE_OF_CONDUCT.md) and [contributing](./.github/CONTRIBUTING.md) guides.

fail2slack.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+__name__ = 'fail2slack'
+__version__ = '0.1'

fail2slack/__init__.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# fail2slack
+#
+# Copyright 2018-present Chris Carlevato (https://github.com/asdfdotdev)
+# License http://www.gnu.org/licenses/gpl-2.0.html
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 2.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+import sys
+from .jails import *
+from .settings import Settings
+from .delivery import Delivery
+
+
+def main():
+    settings = Settings()
+    settings.process_args(sys.argv)
+    delivery = Delivery(settings)
+
+    delivery.output(
+        get_jails_status(
+            settings.get_jails()
+        )
+    )
+
+
+if __name__ == '__main__':
+    main()

fail2slack/__main__.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+
+import sys
+
+
+class Delivery:
+
+    def __init__(self, settings):
+        self._delivery_method = settings.get_delivery_method()
+        self._webhook_url = settings.get_webhook_url()
+
+    def output(self, jail_data):
+        """
+        Output update message based on current settings.
+        :param jail_data: array of jail data (failed/banned)
+        :return: void
+        """
+        message = self.generate_message(self, jail_data)
+
+        if 1 == self._delivery_method:
+            self.slack_output(self, message)
+        else:
+            self.print_output(self, message)
+
+    @staticmethod
+    def generate_message(self, jail_data):
+        """
+        Generate update message using jail data.
+        :param jail_data: array of jail data (failed/banned)
+        :return: string formatting update message
+        """
+        message = ''
+
+        for jail in jail_data:
+            message += "*{0}*\n\tFailed: {1} ({2}), Banned: {3} ({4})\n".format(*jail)
+
+        return message
+
+    @staticmethod
+    def print_output(self, message):
+        """
+        Output message to a stream, or to sys.stdout by default.
+        :param message: string message
+        :return: void
+        """
+        print(message)
+
+    @staticmethod
+    def slack_output(self, message):
+        """
+        Send message to slack via webhook.
+        :param message: string message
+        :return: void
+        """
+        import requests
+        import json
+
+        response = requests.post(
+            self._webhook_url,
+            data=json.dumps({'text': message}),
+            headers={'Content-Type': 'application/json'}
+        )
+
+        if response.status_code != 200:
+            sys.exit("Slack webhook connection failed with error: {0} ({1})".format(response.text, response.status_code))

fail2slack/delivery.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+
+import re
+import subprocess
+import sys
+
+
+def get_jails_status(active_jails):
+    jails_status = []
+
+    try:
+        for jail in active_jails:
+            jail_output = subprocess.check_output("fail2ban-client status " + jail, shell=True).decode('utf-8')
+
+            current_failed_count = 0
+            total_failed_count = 0
+            current_banned_count = 0
+            total_banned_count = 0
+
+            current_failed = re.search(r"Currently failed:(.*\b)", jail_output, re.IGNORECASE | re.MULTILINE)
+            total_failed = re.search(r"Total failed:(.*\b)", jail_output, re.IGNORECASE | re.MULTILINE)
+            current_banned = re.search(r"Currently banned:(.*\b)", jail_output, re.IGNORECASE | re.MULTILINE)
+            total_banned = re.search(r"Total banned:(.*\b)", jail_output, re.IGNORECASE | re.MULTILINE)
+
+            if current_failed:
+                current_failed_count = current_failed.group(1).strip()
+
+            if total_failed:
+                total_failed_count = total_failed.group(1).strip()
+
+            if current_banned:
+                current_banned_count = current_banned.group(1).strip()
+
+            if total_banned:
+                total_banned_count = total_banned.group(1).strip()
+
+            jails_status.append([
+                jail,
+                current_failed_count,
+                total_failed_count,
+                current_banned_count,
+                total_banned_count
+            ])
+    except subprocess.CalledProcessError:
+        sys.exit("Unable to get fail2ban-client status. Confirm it is available and you have permission to use it.")
+
+    return jails_status