Awesome
<p align="center"> <img align="center" src="https://github.com/prowler-cloud/prowler/blob/master/docs/img/prowler-logo-black.png#gh-light-mode-only" width="50%" height="50%"> <img align="center" src="https://github.com/prowler-cloud/prowler/blob/master/docs/img/prowler-logo-white.png#gh-dark-mode-only" width="50%" height="50%"> </p> <p align="center"> <b><i>Prowler SaaS </b> and <b>Prowler Open Source</b> are as dynamic and adaptable as the environment theyβre meant to protect. Trusted by the leaders in security. </p> <p align="center"> <b>Learn more at <a href="https://prowler.com">prowler.com</i></b> </p> <p align="center"> <a href="https://goto.prowler.com/slack"><img width="30" height="30" alt="Prowler community on Slack" src="https://github.com/prowler-cloud/prowler/assets/38561120/3c8b4ec5-6849-41a5-b5e1-52bbb94af73a"></a> <br> <a href="https://goto.prowler.com/slack">Join our Prowler community!</a> </p> <hr> <p align="center"> <a href="https://goto.prowler.com/slack"><img alt="Slack Shield" src="https://img.shields.io/badge/slack-prowler-brightgreen.svg?logo=slack"></a> <a href="https://pypi.org/project/prowler/"><img alt="Python Version" src="https://img.shields.io/pypi/v/prowler.svg"></a> <a href="https://pypi.python.org/pypi/prowler/"><img alt="Python Version" src="https://img.shields.io/pypi/pyversions/prowler.svg"></a> <a href="https://pypistats.org/packages/prowler"><img alt="PyPI Prowler Downloads" src="https://img.shields.io/pypi/dw/prowler.svg?label=prowler%20downloads"></a> <a href="https://hub.docker.com/r/toniblyx/prowler"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/toniblyx/prowler"></a> <a href="https://hub.docker.com/r/toniblyx/prowler"><img alt="Docker" src="https://img.shields.io/docker/cloud/build/toniblyx/prowler"></a> <a href="https://hub.docker.com/r/toniblyx/prowler"><img alt="Docker" src="https://img.shields.io/docker/image-size/toniblyx/prowler"></a> <a href="https://gallery.ecr.aws/prowler-cloud/prowler"><img width="120" height=19" alt="AWS ECR Gallery" src="https://user-images.githubusercontent.com/3985464/151531396-b6535a68-c907-44eb-95a1-a09508178616.png"></a> <a href="https://codecov.io/gh/prowler-cloud/prowler"><img src="https://codecov.io/gh/prowler-cloud/prowler/graph/badge.svg?token=OflBGsdpDl"/></a> </p> <p align="center"> <a href="https://github.com/prowler-cloud/prowler"><img alt="Repo size" src="https://img.shields.io/github/repo-size/prowler-cloud/prowler"></a> <a href="https://github.com/prowler-cloud/prowler/issues"><img alt="Issues" src="https://img.shields.io/github/issues/prowler-cloud/prowler"></a> <a href="https://github.com/prowler-cloud/prowler/releases"><img alt="Version" src="https://img.shields.io/github/v/release/prowler-cloud/prowler?include_prereleases"></a> <a href="https://github.com/prowler-cloud/prowler/releases"><img alt="Version" src="https://img.shields.io/github/release-date/prowler-cloud/prowler"></a> <a href="https://github.com/prowler-cloud/prowler"><img alt="Contributors" src="https://img.shields.io/github/contributors-anon/prowler-cloud/prowler"></a> <a href="https://github.com/prowler-cloud/prowler"><img alt="License" src="https://img.shields.io/github/license/prowler-cloud/prowler"></a> <a href="https://twitter.com/ToniBlyx"><img alt="Twitter" src="https://img.shields.io/twitter/follow/toniblyx?style=social"></a> <a href="https://twitter.com/prowlercloud"><img alt="Twitter" src="https://img.shields.io/twitter/follow/prowlercloud?style=social"></a> </p> <hr> <p align="center"> <img align="center" src="/docs/img/prowler-cli-quick.gif" width="100%" height="100%"> </p>Description
Prowler is an Open Source security tool to perform AWS, Azure, Google Cloud and Kubernetes security best practices assessments, audits, incident response, continuous monitoring, hardening and forensics readiness, and also remediations! We have Prowler CLI (Command Line Interface) that we call Prowler Open Source and a service on top of it that we call <a href="https://prowler.com">Prowler SaaS</a>.
Prowler CLI
prowler <provider>
Prowler Dashboard
prowler dashboard
It contains hundreds of controls covering CIS, NIST 800, NIST CSF, CISA, RBI, FedRAMP, PCI-DSS, GDPR, HIPAA, FFIEC, SOC2, GXP, AWS Well-Architected Framework Security Pillar, AWS Foundational Technical Review (FTR), ENS (Spanish National Security Scheme) and your custom security frameworks.
Provider | Checks | Services | Compliance Frameworks | Categories |
---|---|---|---|---|
AWS | 553 | 77 -> prowler aws --list-services | 30 -> prowler aws --list-compliance | 9 -> prowler aws --list-categories |
GCP | 77 | 13 -> prowler gcp --list-services | 3 -> prowler gcp --list-compliance | 2 -> prowler gcp --list-categories |
Azure | 138 | 17 -> prowler azure --list-services | 4 -> prowler azure --list-compliance | 2 -> prowler azure --list-categories |
Kubernetes | 83 | 7 -> prowler kubernetes --list-services | 1 -> prowler kubernetes --list-compliance | 7 -> prowler kubernetes --list-categories |
π» Installation
Pip package
Prowler is available as a project in PyPI, thus can be installed using pip with Python >= 3.9, < 3.13:
pip install prowler
prowler -v
More details at https://docs.prowler.com
Containers
The available versions of Prowler are the following:
latest
: in sync withmaster
branch (bear in mind that it is not a stable version)v3-latest
: in sync withv3
branch (bear in mind that it is not a stable version)<x.y.z>
(release): you can find the releases here, those are stable releases.stable
: this tag always point to the latest release.v3-stable
: this tag always point to the latest release for v3.
The container images are available here:
From GitHub
Python >= 3.9, < 3.13 is required with pip and poetry:
git clone https://github.com/prowler-cloud/prowler
cd prowler
poetry shell
poetry install
python prowler.py -v
If you want to clone Prowler from Windows, use
git config core.longpaths true
to allow long file paths.
πβοΈ High level architecture
You can run Prowler from your workstation, a Kubernetes Job, a Google Compute Engine, an Azure VM, an EC2 instance, Fargate or any other container, CloudShell and many more.
Deprecations from v3
General
Allowlist
now is calledMutelist
.- The
--quiet
option has been deprecated, now use the--status
flag to select the finding's status you want to get from PASS, FAIL or MANUAL. - All
INFO
finding's status has changed toMANUAL
. - The CSV output format is common for all the providers.
We have deprecated some of our outputs formats:
- The native JSON is replaced for the JSON OCSF v1.1.0, common for all the providers.
AWS
- Deprecate the AWS flag --sts-endpoint-region since we use AWS STS regional tokens.
- To send only FAILS to AWS Security Hub, now use either
--send-sh-only-fails
or--security-hub --status FAIL
.
π Documentation
Install, Usage, Tutorials and Developer Guide is at https://docs.prowler.com/
π License
Prowler is licensed as Apache License 2.0 as specified in each file. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0