Skip to main content

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.

Source Distribution

airflowscan-0.1.3.1.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

airflowscan-0.1.3.1-py3-none-any.whl (35.5 kB view details)

Uploaded Python 3

File details

Details for the file airflowscan-0.1.3.1.tar.gz.

File metadata

  • Download URL: airflowscan-0.1.3.1.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.4

File hashes

Hashes for airflowscan-0.1.3.1.tar.gz
Algorithm Hash digest
SHA256 dd0634303ebfcf46ec3ef81c250a5fdb456a16584d10cd736cc8295b81b43c64
MD5 8b659337825528416daa9cc9e667ffe1
BLAKE2b-256 672449dfce34a079b5a00c1891696c4744577c9030249c68a2ae6d6999c43a4a

See more details on using hashes here.

File details

Details for the file airflowscan-0.1.3.1-py3-none-any.whl.

File metadata

  • Download URL: airflowscan-0.1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 35.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.4

File hashes

Hashes for airflowscan-0.1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b7b2b2f55cef26427e3612477ed7abc23b37327ec8dbb5face85df927e879fff
MD5 10c8624dd32c95c1b9d944a28a4cc2d4
BLAKE2b-256 b8196e728d049b770f764fa28a6883acbdf28a5dfd60d7f49b0992891a234739

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page