Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Static analysis tool to check Airflow configuration files for insecure settings

Project description

airflowscan

PyPI version Build Status codecov GitHub

Checklist and tools for increasing security of Apache Airflow.

DISCLAIMER

This project NOT AFFILIATED with the Apache Foundation and the Airflow project, and is not endorsed by them.

Contents

The purpose of this project is provide tools to increase security of Apache Airflow. installations. This projects provides the following tools:

  • Configuration file with hardened settings - see hardened_airflow.cfg.
  • Security checklist for hardening default installations - see CHECKLIST.MD.
  • Static analysis tool to check Airflow configuration files for insecure settings.
  • JSON schema document used for validation by the static analysis tool - see airflow_cfg.schema

Information for the Static Analysis Tool (airflowscan)

The static analysis tool can check an Airflow configuration file for settings related to security. The tool convers the config file to JSON, and then uses a JSON Schema to do the validation.

Requirements

Python 3 is required and you can find all required modules in the requirements.txt file. Only tested on Python 3.7 but should work on other 3.x releases. No plans to 2.x support at this time.

Installation

You can install this via PIP as follows:

pip install airflowscan
airflowscan

To download and run manually, do the following:

git clone https://github.com/nightwatchcybersecurity/airflowscan.git
cd airflowscan
pip -r requirements.txt
python -m airflowscan.cli

How to use

To scan a configuration file, do the following command:

airflowscan scan some_airflow.cfg

Reporting bugs and feature requests

Please use the GitHub issue tracker to report issues or suggest features: https://github.com/nightwatchcybersecurity/airflowscan

You can also send emai to research /at/ nightwatchcybersecurity [dot] com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for airflowscan, version 0.1.3.1
Filename, size File type Python version Upload date Hashes
Filename, size airflowscan-0.1.3.1-py3-none-any.whl (35.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size airflowscan-0.1.3.1.tar.gz (24.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page