prowler 5.15.1__tar.gz → 5.16.0__tar.gz

prowler-5.16.0/PKG-INFO

@@ -0,0 +1,413 @@
+Metadata-Version: 2.3
+Name: prowler
+Version: 5.16.0
+Summary: Prowler is an Open Source security tool to perform AWS, GCP and Azure security best practices assessments, audits, incident response, continuous monitoring, hardening and forensics readiness. 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.
+License: Apache-2.0
+Author: Toni de la Fuente
+Author-email: toni@blyx.com
+Maintainer: Prowler Engineering
+Maintainer-email: engineering@prowler.com
+Requires-Python: >3.9.1,<3.13
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Dist: alibabacloud-gateway-oss-util (==0.0.3)
+Requires-Dist: alibabacloud-rds20140815 (==12.0.0)
+Requires-Dist: alibabacloud-sls20201230 (==5.9.0)
+Requires-Dist: alibabacloud_actiontrail20200706 (==2.4.1)
+Requires-Dist: alibabacloud_credentials (==1.0.3)
+Requires-Dist: alibabacloud_cs20151215 (==6.1.0)
+Requires-Dist: alibabacloud_ecs20140526 (==7.2.5)
+Requires-Dist: alibabacloud_oss20190517 (==1.0.6)
+Requires-Dist: alibabacloud_ram20150501 (==1.2.0)
+Requires-Dist: alibabacloud_sas20181203 (==6.1.0)
+Requires-Dist: alibabacloud_sts20150401 (==1.1.6)
+Requires-Dist: alibabacloud_tea_openapi (==0.4.1)
+Requires-Dist: alibabacloud_vpc20160428 (==6.13.0)
+Requires-Dist: alive-progress (==3.3.0)
+Requires-Dist: awsipranges (==0.3.3)
+Requires-Dist: azure-identity (==1.21.0)
+Requires-Dist: azure-keyvault-keys (==4.10.0)
+Requires-Dist: azure-mgmt-apimanagement (==5.0.0)
+Requires-Dist: azure-mgmt-applicationinsights (==4.1.0)
+Requires-Dist: azure-mgmt-authorization (==4.0.0)
+Requires-Dist: azure-mgmt-compute (==34.0.0)
+Requires-Dist: azure-mgmt-containerregistry (==12.0.0)
+Requires-Dist: azure-mgmt-containerservice (==34.1.0)
+Requires-Dist: azure-mgmt-cosmosdb (==9.7.0)
+Requires-Dist: azure-mgmt-databricks (==2.0.0)
+Requires-Dist: azure-mgmt-keyvault (==10.3.1)
+Requires-Dist: azure-mgmt-loganalytics (==12.0.0)
+Requires-Dist: azure-mgmt-monitor (==6.0.2)
+Requires-Dist: azure-mgmt-network (==28.1.0)
+Requires-Dist: azure-mgmt-postgresqlflexibleservers (==1.1.0)
+Requires-Dist: azure-mgmt-rdbms (==10.1.0)
+Requires-Dist: azure-mgmt-recoveryservices (==3.1.0)
+Requires-Dist: azure-mgmt-recoveryservicesbackup (==9.2.0)
+Requires-Dist: azure-mgmt-resource (==23.3.0)
+Requires-Dist: azure-mgmt-search (==9.1.0)
+Requires-Dist: azure-mgmt-security (==7.0.0)
+Requires-Dist: azure-mgmt-sql (==3.0.1)
+Requires-Dist: azure-mgmt-storage (==22.1.1)
+Requires-Dist: azure-mgmt-subscription (==3.1.1)
+Requires-Dist: azure-mgmt-web (==8.0.0)
+Requires-Dist: azure-monitor-query (==2.0.0)
+Requires-Dist: azure-storage-blob (==12.24.1)
+Requires-Dist: boto3 (==1.39.15)
+Requires-Dist: botocore (==1.39.15)
+Requires-Dist: colorama (==0.4.6)
+Requires-Dist: cryptography (==44.0.1)
+Requires-Dist: dash (==3.1.1)
+Requires-Dist: dash-bootstrap-components (==2.0.3)
+Requires-Dist: detect-secrets (==1.5.0)
+Requires-Dist: dulwich (==0.23.0)
+Requires-Dist: google-api-python-client (==2.163.0)
+Requires-Dist: google-auth-httplib2 (>=0.1,<0.3)
+Requires-Dist: h2 (==4.3.0)
+Requires-Dist: jsonschema (==4.23.0)
+Requires-Dist: kubernetes (==32.0.1)
+Requires-Dist: markdown (==3.9.0)
+Requires-Dist: microsoft-kiota-abstractions (==1.9.2)
+Requires-Dist: msgraph-sdk (==1.23.0)
+Requires-Dist: numpy (==2.0.2)
+Requires-Dist: oci (==2.160.3)
+Requires-Dist: pandas (==2.2.3)
+Requires-Dist: py-iam-expand (==0.1.0)
+Requires-Dist: py-ocsf-models (==0.5.0)
+Requires-Dist: pydantic (>=2.0,<3.0)
+Requires-Dist: pygithub (==2.5.0)
+Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
+Requires-Dist: pytz (==2025.1)
+Requires-Dist: schema (==0.7.5)
+Requires-Dist: shodan (==1.31.0)
+Requires-Dist: slack-sdk (==3.34.0)
+Requires-Dist: tabulate (==0.9.0)
+Requires-Dist: tzlocal (==5.3.1)
+Project-URL: Changelog, https://github.com/prowler-cloud/prowler/releases
+Project-URL: Documentation, https://docs.prowler.com
+Project-URL: Homepage, https://github.com/prowler-cloud/prowler
+Project-URL: Issue tracker, https://github.com/prowler-cloud/prowler/issues
+Description-Content-Type: text/markdown
+
+<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</b> is the Open Cloud Security platform trusted by thousands to automate security and compliance in any cloud environment. With hundreds of ready-to-use checks and compliance frameworks, Prowler delivers real-time, customizable monitoring and seamless integrations, making cloud security simple, scalable, and cost-effective for organizations of any size.
+</p>
+<p align="center">
+<b>Secure ANY cloud at AI Speed 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 Downloads" src="https://img.shields.io/pypi/dw/prowler.svg?label=downloads"></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://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>
+  <a href="https://insights.linuxfoundation.org/project/prowler-cloud-prowler"><img src="https://insights.linuxfoundation.org/api/badge/health-score?project=prowler-cloud-prowler"/></a>
+</p>
+<p align="center">
+    <a href="https://github.com/prowler-cloud/prowler/releases"><img alt="Version" src="https://img.shields.io/github/v/release/prowler-cloud/prowler"></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/issues"><img alt="Issues" src="https://img.shields.io/github/issues/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-cloud.gif" width="100%" height="100%">
+</p>
+
+# Description
+
+**Prowler** is the world’s most widely used _open-source cloud security platform_ that automates security and compliance across **any cloud environment**. With hundreds of ready-to-use security checks, remediation guidance, and compliance frameworks, Prowler is built to _“Secure ANY cloud at AI Speed”_. Prowler delivers **AI-driven**, **customizable**, and **easy-to-use** assessments, dashboards, reports, and integrations, making cloud security **simple**, **scalable**, and **cost-effective** for organizations of any size.
+
+Prowler includes hundreds of built-in controls to ensure compliance with standards and frameworks, including:
+
+- **Prowler ThreatScore:** Weighted risk prioritization scoring that helps you focus on the most critical security findings first
+- **Industry Standards:** CIS, NIST 800, NIST CSF, CISA, and MITRE ATT&CK
+- **Regulatory Compliance and Governance:** RBI, FedRAMP, PCI-DSS, and NIS2
+- **Frameworks for Sensitive Data and Privacy:** GDPR, HIPAA, and FFIEC
+- **Frameworks for Organizational Governance and Quality Control:** SOC2, GXP, and ISO 27001
+- **Cloud-Specific Frameworks:** AWS Foundational Technical Review (FTR), AWS Well-Architected Framework, and BSI C5
+- **National Security Standards:** ENS (Spanish National Security Scheme) and KISA ISMS-P (Korean)
+- **Custom Security Frameworks:** Tailored to your needs
+
+## Prowler App / Prowler Cloud
+
+Prowler App / [Prowler Cloud](https://cloud.prowler.com/) is a web-based application that simplifies running Prowler across your cloud provider accounts. It provides a user-friendly interface to visualize the results and streamline your security assessments.
+
+![Prowler App](docs/images/products/overview.png)
+![Risk Pipeline](docs/images/products/risk-pipeline.png)
+![Threat Map](docs/images/products/threat-map.png)
+
+
+>For more details, refer to the [Prowler App Documentation](https://docs.prowler.com/projects/prowler-open-source/en/latest/#prowler-app-installation)
+
+## Prowler CLI
+
+```console
+prowler <provider>
+```
+![Prowler CLI Execution](docs/img/short-display.png)
+
+
+## Prowler Dashboard
+
+```console
+prowler dashboard
+```
+![Prowler Dashboard](docs/images/products/dashboard.png)
+
+# Prowler at a Glance
+> [!Tip]
+> For the most accurate and up-to-date information about checks, services, frameworks, and categories, visit [**Prowler Hub**](https://hub.prowler.com).
+
+
+| Provider | Checks | Services | [Compliance Frameworks](https://docs.prowler.com/projects/prowler-open-source/en/latest/tutorials/compliance/) | [Categories](https://docs.prowler.com/projects/prowler-open-source/en/latest/tutorials/misc/#categories) | Support | Interface |
+|---|---|---|---|---|---|---|
+| AWS | 584 | 85 | 40 | 17 | Official | UI, API, CLI |
+| GCP | 89 | 17 | 14 | 5 | Official | UI, API, CLI |
+| Azure | 169 | 22 | 15 | 8 | Official | UI, API, CLI |
+| Kubernetes | 84 | 7 | 6 | 9 | Official | UI, API, CLI |
+| GitHub | 20 | 2 | 1 | 2 | Official | UI, API, CLI |
+| M365 | 70 | 7 | 3 | 2 | Official | UI, API, CLI |
+| OCI | 52 | 15 | 1 | 12 | Official | UI, API, CLI |
+| Alibaba Cloud | 63 | 10 | 1 | 9 | Official | CLI |
+| IaC | [See `trivy` docs.](https://trivy.dev/latest/docs/coverage/iac/) | N/A | N/A | N/A | Official | UI, API, CLI |
+| MongoDB Atlas | 10 | 4 | 0 | 3 | Official | UI, API, CLI |
+| LLM | [See `promptfoo` docs.](https://www.promptfoo.dev/docs/red-team/plugins/) | N/A | N/A | N/A | Official | CLI |
+| NHN | 6 | 2 | 1 | 0 | Unofficial | CLI |
+
+> [!Note]
+> The numbers in the table are updated periodically.
+
+
+
+> [!Note]
+> Use the following commands to list Prowler's available checks, services, compliance frameworks, and categories:
+> - `prowler <provider> --list-checks`
+> - `prowler <provider> --list-services`
+> - `prowler <provider> --list-compliance`
+> - `prowler <provider> --list-categories`
+
+# 💻 Installation
+
+## Prowler App
+
+Prowler App offers flexible installation methods tailored to various environments:
+
+> For detailed instructions on using Prowler App, refer to the [Prowler App Usage Guide](https://docs.prowler.com/projects/prowler-open-source/en/latest/tutorials/prowler-app/).
+
+### Docker Compose
+
+**Requirements**
+
+* `Docker Compose` installed: https://docs.docker.com/compose/install/.
+
+**Commands**
+
+``` console
+curl -LO https://raw.githubusercontent.com/prowler-cloud/prowler/refs/heads/master/docker-compose.yml
+curl -LO https://raw.githubusercontent.com/prowler-cloud/prowler/refs/heads/master/.env
+docker compose up -d
+```
+
+> Containers are built for `linux/amd64`.
+
+### Configuring Your Workstation for Prowler App
+
+If your workstation's architecture is incompatible, you can resolve this by:
+
+- **Setting the environment variable**: `DOCKER_DEFAULT_PLATFORM=linux/amd64`
+- **Using the following flag in your Docker command**: `--platform linux/amd64`
+
+> Once configured, access the Prowler App at http://localhost:3000. Sign up using your email and password to get started.
+
+### Common Issues with Docker Pull Installation
+
+> [!Note]
+  If you want to use AWS role assumption (e.g., with the "Connect assuming IAM Role" option), you may need to mount your local `.aws` directory into the container as a volume (e.g., `- "${HOME}/.aws:/home/prowler/.aws:ro"`). There are several ways to configure credentials for Docker containers. See the [Troubleshooting](./docs/troubleshooting.md) section for more details and examples.
+
+You can find more information in the [Troubleshooting](./docs/troubleshooting.md) section.
+
+
+### From GitHub
+
+**Requirements**
+
+* `git` installed.
+* `poetry` v2 installed: [poetry installation](https://python-poetry.org/docs/#installation).
+* `pnpm` installed: [pnpm installation](https://pnpm.io/installation).
+* `Docker Compose` installed: https://docs.docker.com/compose/install/.
+
+**Commands to run the API**
+
+``` console
+git clone https://github.com/prowler-cloud/prowler
+cd prowler/api
+poetry install
+eval $(poetry env activate)
+set -a
+source .env
+docker compose up postgres valkey -d
+cd src/backend
+python manage.py migrate --database admin
+gunicorn -c config/guniconf.py config.wsgi:application
+```
+> [!IMPORTANT]
+> As of Poetry v2.0.0, the `poetry shell` command has been deprecated. Use `poetry env activate` instead for environment activation.
+>
+> If your Poetry version is below v2.0.0, continue using `poetry shell` to activate your environment.
+> For further guidance, refer to the Poetry Environment Activation Guide https://python-poetry.org/docs/managing-environments/#activating-the-environment.
+
+> After completing the setup, access the API documentation at http://localhost:8080/api/v1/docs.
+
+**Commands to run the API Worker**
+
+``` console
+git clone https://github.com/prowler-cloud/prowler
+cd prowler/api
+poetry install
+eval $(poetry env activate)
+set -a
+source .env
+cd src/backend
+python -m celery -A config.celery worker -l info -E
+```
+
+**Commands to run the API Scheduler**
+
+``` console
+git clone https://github.com/prowler-cloud/prowler
+cd prowler/api
+poetry install
+eval $(poetry env activate)
+set -a
+source .env
+cd src/backend
+python -m celery -A config.celery beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler
+```
+
+**Commands to run the UI**
+
+``` console
+git clone https://github.com/prowler-cloud/prowler
+cd prowler/ui
+pnpm install
+pnpm run build
+pnpm start
+```
+
+> Once configured, access the Prowler App at http://localhost:3000. Sign up using your email and password to get started.
+
+## Prowler CLI
+### Pip package
+Prowler CLI is available as a project in [PyPI](https://pypi.org/project/prowler-cloud/). Consequently, it can be installed using pip with Python >3.9.1, <3.13:
+
+```console
+pip install prowler
+prowler -v
+```
+>For further guidance, refer to [https://docs.prowler.com](https://docs.prowler.com/projects/prowler-open-source/en/latest/#prowler-cli-installation)
+
+### Containers
+
+**Available Versions of Prowler CLI**
+
+The following versions of Prowler CLI are available, depending on your requirements:
+
+- `latest`: Synchronizes with the `master` branch. Note that this version is not stable.
+- `v4-latest`: Synchronizes with the `v4` branch. Note that this version is not stable.
+- `v3-latest`: Synchronizes with the `v3` branch. Note that this version is not stable.
+- `<x.y.z>` (release): Stable releases corresponding to specific versions. You can find the complete list of releases [here](https://github.com/prowler-cloud/prowler/releases).
+- `stable`: Always points to the latest release.
+- `v4-stable`: Always points to the latest release for v4.
+- `v3-stable`: Always points to the latest release for v3.
+
+The container images are available here:
+- Prowler CLI:
+    - [DockerHub](https://hub.docker.com/r/prowlercloud/prowler/tags)
+    - [AWS Public ECR](https://gallery.ecr.aws/prowler-cloud/prowler)
+- Prowler App:
+    - [DockerHub - Prowler UI](https://hub.docker.com/r/prowlercloud/prowler-ui/tags)
+    - [DockerHub - Prowler API](https://hub.docker.com/r/prowlercloud/prowler-api/tags)
+
+### From GitHub
+
+Python >3.9.1, <3.13 is required with pip and Poetry:
+
+``` console
+git clone https://github.com/prowler-cloud/prowler
+cd prowler
+eval $(poetry env activate)
+poetry install
+python prowler-cli.py -v
+```
+> [!IMPORTANT]
+> To clone Prowler on Windows, configure Git to support long file paths by running the following command: `git config core.longpaths true`.
+
+> [!IMPORTANT]
+> As of Poetry v2.0.0, the `poetry shell` command has been deprecated. Use `poetry env activate` instead for environment activation.
+>
+> If your Poetry version is below v2.0.0, continue using `poetry shell` to activate your environment.
+> For further guidance, refer to the Poetry Environment Activation Guide https://python-poetry.org/docs/managing-environments/#activating-the-environment.
+
+# ✏️ High level architecture
+
+## Prowler App
+**Prowler App** is composed of four key components:
+
+- **Prowler UI**: A web-based interface, built with Next.js, providing a user-friendly experience for executing Prowler scans and visualizing results.
+- **Prowler API**: A backend service, developed with Django REST Framework, responsible for running Prowler scans and storing the generated results.
+- **Prowler SDK**: A Python SDK designed to extend the functionality of the Prowler CLI for advanced capabilities.
+- **Prowler MCP Server**: A Model Context Protocol server that provides AI tools for Lighthouse, the AI-powered security assistant. This is a critical dependency for Lighthouse functionality.
+
+![Prowler App Architecture](docs/products/img/prowler-app-architecture.png)
+
+## Prowler CLI
+
+**Running Prowler**
+
+Prowler can be executed across various environments, offering flexibility to meet your needs. It can be run from:
+
+- Your own workstation
+
+- A Kubernetes Job
+
+- Google Compute Engine
+
+- Azure Virtual Machines (VMs)
+
+- Amazon EC2 instances
+
+- AWS Fargate or other container platforms
+
+- CloudShell
+
+And many more environments.
+
+![Architecture](docs/img/architecture.png)
+
+# 📖 Documentation
+
+For installation instructions, usage details, tutorials, and the Developer Guide, visit https://docs.prowler.com/
+
+# 📃 License
+
+Prowler is licensed under the Apache License 2.0.
+
+A copy of the License is available at <http://www.apache.org/licenses/LICENSE-2.0>
+