Skip to main content

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

Metadata

Release files for airflowscan 0.1.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for airflowscan 0.1.3.1
File Size Uploaded
airflowscan-0.1.3.1.tar.gz 24.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for airflowscan 0.1.3.1
File Interpreter ABI Platform
airflowscan-0.1.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 59.8 kB

Release files / airflowscan-0.1.3.1.tar.gz

Download URL airflowscan-0.1.3.1.tar.gz
Size 24.4 kB
Tags Source
SHA-256 checksum
How to use checksums
dd0634303ebfcf46ec3ef81c250a5fdb456a16584d10cd736cc8295b81b43c64
BLAKE2b-256 checksum
How to use checksums
672449dfce34a079b5a00c1891696c4744577c9030249c68a2ae6d6999c43a4a
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / airflowscan-0.1.3.1-py3-none-any.whl

Download URL airflowscan-0.1.3.1-py3-none-any.whl
Size 35.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b7b2b2f55cef26427e3612477ed7abc23b37327ec8dbb5face85df927e879fff
BLAKE2b-256 checksum
How to use checksums
b8196e728d049b770f764fa28a6883acbdf28a5dfd60d7f49b0992891a234739
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

0.1.3.1 This release

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page