From 856afb3966f526964367bf014ff82b9420f33178 Mon Sep 17 00:00:00 2001 From: Nacho Rivera Date: Mon, 27 Nov 2023 13:58:45 +0100 Subject: [PATCH] chore(update): rebase from master (#3067) Signed-off-by: dependabot[bot] Signed-off-by: r3drun3 Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: John Mastron <14130495+mtronrd@users.noreply.github.com> Co-authored-by: John Mastron Co-authored-by: Sergio Garcia Co-authored-by: Sergio Garcia <38561120+sergargar@users.noreply.github.com> Co-authored-by: sergargar Co-authored-by: Pepe Fagoaga Co-authored-by: github-actions Co-authored-by: simone ragonesi <102741679+R3DRUN3@users.noreply.github.com> Co-authored-by: Johnny Lu Co-authored-by: Vajrala Venkateswarlu <59252985+venkyvajrala@users.noreply.github.com> Co-authored-by: Ignacio Dominguez --- README.md | 6 +- docs/getting-started/requirements.md | 6 +- docs/tutorials/azure/use-non-default-cloud.md | 16 + docs/tutorials/custom-checks-metadata.md | 43 ++ docs/tutorials/gcp/authentication.md | 6 +- mkdocs.yml | 2 + poetry.lock | 493 ++++++++++++++++-- prowler/__main__.py | 32 +- prowler/config/config.py | 6 +- prowler/config/config.yaml | 2 +- .../custom_checks_metadata_example.yaml | 15 + prowler/lib/check/check.py | 9 + prowler/lib/check/checks_loader.py | 4 + prowler/lib/check/custom_checks_metadata.py | 77 +++ prowler/lib/cli/parser.py | 15 +- prowler/lib/outputs/file_descriptors.py | 37 +- prowler/lib/outputs/html.py | 7 +- prowler/lib/outputs/json.py | 10 +- .../providers/aws/aws_regions_by_service.json | 160 +++++- .../providers/aws/lib/allowlist/allowlist.py | 186 ++++--- .../providers/aws/lib/arguments/arguments.py | 1 + .../policy_condition_parser.py | 7 +- .../aws/lib/security_hub/security_hub.py | 11 +- .../accessanalyzer_enabled.py | 26 +- ...ges_external_public_publishing_disabled.py | 2 +- .../codeartifact/codeartifact_service.py | 43 +- .../ec2_securitygroup_not_used.py | 10 +- .../providers/aws/services/ec2/ec2_service.py | 8 +- .../guardduty_centrally_managed.py | 2 +- .../guardduty_no_high_severity_findings.py | 2 +- .../providers/aws/services/iam/iam_service.py | 144 +++-- .../rds_instance_deprecated_engine_version.py | 9 +- .../providers/aws/services/sqs/sqs_service.py | 78 ++- prowler/providers/azure/azure_provider.py | 26 +- .../azure/lib/arguments/arguments.py | 27 + .../azure/lib/audit_info/audit_info.py | 2 + .../providers/azure/lib/audit_info/models.py | 17 +- .../providers/azure/lib/exception/__init__.py | 0 .../azure/lib/exception/exception.py | 11 + .../providers/azure/lib/regions/__init__.py | 0 .../providers/azure/lib/regions/regions.py | 38 ++ .../providers/azure/lib/service/service.py | 16 +- prowler/providers/common/audit_info.py | 24 +- prowler/providers/common/clean.py | 32 ++ prowler/providers/common/outputs.py | 15 + prowler/providers/gcp/gcp_provider.py | 15 - prowler/providers/gcp/lib/service/service.py | 20 +- pyproject.toml | 20 +- tests/config/config_test.py | 2 +- .../lib/check/custom_checks_metadata_test.py | 164 ++++++ .../custom_checks_metadata_example.yaml | 15 + ...tom_checks_metadata_example_not_valid.yaml | 5 + tests/lib/cli/parser_test.py | 52 ++ tests/lib/outputs/slack_test.py | 2 + tests/providers/aws/audit_info_utils.py | 2 + .../aws/lib/allowlist/allowlist_test.py | 370 ++++++++----- .../policy_condition_parser_test.py | 72 +++ .../aws/lib/security_hub/security_hub_test.py | 163 +++--- .../accessanalyzer_enabled_test.py | 39 ++ ...xternal_public_publishing_disabled_test.py | 10 +- .../ec2_securitygroup_not_used_test.py | 85 +++ .../guardduty_centrally_managed_test.py | 25 + ...uardduty_no_high_severity_findings_test.py | 23 + ...sqs_queues_not_publicly_accessible_test.py | 66 +-- ...ues_server_side_encryption_enabled_test.py | 25 +- .../aws/services/sqs/sqs_service_test.py | 16 + .../azure/lib/regions/regions_test.py | 50 ++ tests/providers/common/audit_info_test.py | 105 +++- tests/providers/common/clean_test.py | 87 ++++ tests/providers/common/common_outputs_test.py | 18 +- 70 files changed, 2582 insertions(+), 552 deletions(-) create mode 100644 docs/tutorials/azure/use-non-default-cloud.md create mode 100644 docs/tutorials/custom-checks-metadata.md create mode 100644 prowler/config/custom_checks_metadata_example.yaml create mode 100644 prowler/lib/check/custom_checks_metadata.py create mode 100644 prowler/providers/azure/lib/exception/__init__.py create mode 100644 prowler/providers/azure/lib/exception/exception.py create mode 100644 prowler/providers/azure/lib/regions/__init__.py create mode 100644 prowler/providers/azure/lib/regions/regions.py create mode 100644 prowler/providers/common/clean.py create mode 100644 tests/lib/check/custom_checks_metadata_test.py create mode 100644 tests/lib/check/fixtures/custom_checks_metadata_example.yaml create mode 100644 tests/lib/check/fixtures/custom_checks_metadata_example_not_valid.yaml create mode 100644 tests/providers/azure/lib/regions/regions_test.py create mode 100644 tests/providers/common/clean_test.py diff --git a/README.md b/README.md index 3dd8df5dc2..82ab6fe4ee 100644 --- a/README.md +++ b/README.md @@ -178,11 +178,7 @@ Prowler will follow the same credentials search as [Google authentication librar 2. [User credentials set up by using the Google Cloud CLI](https://cloud.google.com/docs/authentication/application-default-credentials#personal) 3. [The attached service account, returned by the metadata server](https://cloud.google.com/docs/authentication/application-default-credentials#attached-sa) -Those credentials must be associated to a user or service account with proper permissions to do all checks. To make sure, add the following roles to the member associated with the credentials: - - - Viewer - - Security Reviewer - - Stackdriver Account Viewer +Those credentials must be associated to a user or service account with proper permissions to do all checks. To make sure, add the `Viewer` role to the member associated with the credentials. > By default, `prowler` will scan all accessible GCP Projects, use flag `--project-ids` to specify the projects to be scanned. diff --git a/docs/getting-started/requirements.md b/docs/getting-started/requirements.md index 999f2fa886..d758cb7211 100644 --- a/docs/getting-started/requirements.md +++ b/docs/getting-started/requirements.md @@ -97,10 +97,6 @@ Prowler will follow the same credentials search as [Google authentication librar 2. [User credentials set up by using the Google Cloud CLI](https://cloud.google.com/docs/authentication/application-default-credentials#personal) 3. [The attached service account, returned by the metadata server](https://cloud.google.com/docs/authentication/application-default-credentials#attached-sa) -Those credentials must be associated to a user or service account with proper permissions to do all checks. To make sure, add the following roles to the member associated with the credentials: - - - Viewer - - Security Reviewer - - Stackdriver Account Viewer +Those credentials must be associated to a user or service account with proper permissions to do all checks. To make sure, add the `Viewer` role to the member associated with the credentials. > By default, `prowler` will scan all accessible GCP Projects, use flag `--project-ids` to specify the projects to be scanned. diff --git a/docs/tutorials/azure/use-non-default-cloud.md b/docs/tutorials/azure/use-non-default-cloud.md new file mode 100644 index 0000000000..50e9422433 --- /dev/null +++ b/docs/tutorials/azure/use-non-default-cloud.md @@ -0,0 +1,16 @@ +# Use non default Azure regions + +Microsoft provides clouds for compliance with regional laws, which are available for your use. +By default, Prowler uses `AzureCloud` cloud which is the comercial one. (you can list all the available with `az cloud list --output table`). + +At the time of writing this documentation the available Azure Clouds from different regions are the following: +- AzureCloud +- AzureChinaCloud +- AzureUSGovernment +- AzureGermanCloud + +If you want to change the default one you must include the flag `--azure-region`, i.e.: + +```console +prowler azure --az-cli-auth --azure-region AzureChinaCloud +``` diff --git a/docs/tutorials/custom-checks-metadata.md b/docs/tutorials/custom-checks-metadata.md new file mode 100644 index 0000000000..6a32238d06 --- /dev/null +++ b/docs/tutorials/custom-checks-metadata.md @@ -0,0 +1,43 @@ +# Custom Checks Metadata + +In certain organizations, the severity of specific checks might differ from the default values defined in the check's metadata. For instance, while `s3_bucket_level_public_access_block` could be deemed `critical` for some organizations, others might assign a different severity level. + +The custom metadata option offers a means to override default metadata set by Prowler + +You can utilize `--custom-checks-metadata-file` followed by the path to your custom checks metadata YAML file. + +## Available Fields + +The list of supported check's metadata fields that can be override are listed as follows: + +- Severity + +## File Syntax + +This feature is available for all the providers supported in Prowler since the metadata format is common between all the providers. The following is the YAML format for the custom checks metadata file: +```yaml title="custom_checks_metadata.yaml" +CustomChecksMetadata: + aws: + Checks: + s3_bucket_level_public_access_block: + Severity: high + s3_bucket_no_mfa_delete: + Severity: high + azure: + Checks: + storage_infrastructure_encryption_is_enabled: + Severity: medium + gcp: + Checks: + compute_instance_public_ip: + Severity: critical +``` + +## Usage + +Executing the following command will assess all checks and generate a report while overriding the metadata for those checks: +```sh +prowler --custom-checks-metadata-file +``` + +This customization feature enables organizations to tailor the severity of specific checks based on their unique requirements, providing greater flexibility in security assessment and reporting. diff --git a/docs/tutorials/gcp/authentication.md b/docs/tutorials/gcp/authentication.md index f4f46d08dd..35977dab5d 100644 --- a/docs/tutorials/gcp/authentication.md +++ b/docs/tutorials/gcp/authentication.md @@ -22,8 +22,4 @@ Prowler will follow the same credentials search as [Google authentication librar 2. [User credentials set up by using the Google Cloud CLI](https://cloud.google.com/docs/authentication/application-default-credentials#personal) 3. [The attached service account, returned by the metadata server](https://cloud.google.com/docs/authentication/application-default-credentials#attached-sa) -Those credentials must be associated to a user or service account with proper permissions to do all checks. To make sure, add the following roles to the member associated with the credentials: - - - Viewer - - Security Reviewer - - Stackdriver Account Viewer +Those credentials must be associated to a user or service account with proper permissions to do all checks. To make sure, add the `Viewer` role to the member associated with the credentials. diff --git a/mkdocs.yml b/mkdocs.yml index d06c747a17..86761e4f68 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -38,6 +38,7 @@ nav: - Logging: tutorials/logging.md - Allowlist: tutorials/allowlist.md - Check Aliases: tutorials/check-aliases.md + - Custom Metadata: tutorials/custom-checks-metadata.md - Ignore Unused Services: tutorials/ignore-unused-services.md - Pentesting: tutorials/pentesting.md - Developer Guide: developer-guide/introduction.md @@ -56,6 +57,7 @@ nav: - Boto3 Configuration: tutorials/aws/boto3-configuration.md - Azure: - Authentication: tutorials/azure/authentication.md + - Non default clouds: tutorials/azure/use-non-default-cloud.md - Subscriptions: tutorials/azure/subscriptions.md - Google Cloud: - Authentication: tutorials/gcp/authentication.md diff --git a/poetry.lock b/poetry.lock index 0a53bee52e..667e7f6659 100644 --- a/poetry.lock +++ b/poetry.lock @@ -11,15 +11,32 @@ files = [ {file = "about_time-4.2.1-py3-none-any.whl", hash = "sha256:8bbf4c75fe13cbd3d72f49a03b02c5c7dca32169b6d49117c257e7eb3eaee341"}, ] +[[package]] +name = "adal" +version = "1.2.7" +description = "Note: This library is already replaced by MSAL Python, available here: https://pypi.org/project/msal/ .ADAL Python remains available here as a legacy. The ADAL for Python library makes it easy for python application to authenticate to Azure Active Directory (AAD) in order to access AAD protected web resources." +optional = false +python-versions = "*" +files = [ + {file = "adal-1.2.7-py2.py3-none-any.whl", hash = "sha256:2a7451ed7441ddbc57703042204a3e30ef747478eea022c70f789fc7f084bc3d"}, + {file = "adal-1.2.7.tar.gz", hash = "sha256:d74f45b81317454d96e982fd1c50e6fb5c99ac2223728aea8764433a39f566f1"}, +] + +[package.dependencies] +cryptography = ">=1.1.0" +PyJWT = ">=1.0.0,<3" +python-dateutil = ">=2.1.0,<3" +requests = ">=2.0.0,<3" + [[package]] name = "alive-progress" -version = "3.1.4" +version = "3.1.5" description = "A new kind of Progress Bar, with real-time throughput, ETA, and very cool animations!" optional = false python-versions = ">=3.7, <4" files = [ - {file = "alive-progress-3.1.4.tar.gz", hash = "sha256:74a95d8d0d42bc99d3a3725dbd06ebb852245f1b64e301a7c375b92b22663f7b"}, - {file = "alive_progress-3.1.4-py3-none-any.whl", hash = "sha256:c80ad87ce9c1054b01135a87fae69ecebbfc2107497ae87cbe6aec7e534903db"}, + {file = "alive-progress-3.1.5.tar.gz", hash = "sha256:42e399a66c8150dc507602dff7b7953f105ef11faf97ddaa6d27b1cbf45c4c98"}, + {file = "alive_progress-3.1.5-py3-none-any.whl", hash = "sha256:347220c1858e3abe137fa0746895668c04df09c5261a13dc03f05795e8a29be5"}, ] [package.dependencies] @@ -58,6 +75,41 @@ docs = ["furo", "myst-parser", "sphinx", "sphinx-notfound-page", "sphinxcontrib- tests = ["attrs[tests-no-zope]", "zope-interface"] tests-no-zope = ["cloudpickle", "hypothesis", "mypy (>=1.1.1)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "pytest-xdist[psutil]"] +[[package]] +name = "aws-sam-translator" +version = "1.80.0" +description = "AWS SAM Translator is a library that transform SAM templates into AWS CloudFormation templates" +optional = false +python-versions = ">=3.7, <=4.0, !=4.0" +files = [ + {file = "aws-sam-translator-1.80.0.tar.gz", hash = "sha256:36afb8b802af0180a35efa68a8ab19d5d929d0a6a649a0101e8a4f8e1f05681f"}, + {file = "aws_sam_translator-1.80.0-py3-none-any.whl", hash = "sha256:f00215f9314cef1bbbdbd7520e3b0c75a76b88bdc3f0dedb6a2c69a12e904b12"}, +] + +[package.dependencies] +boto3 = ">=1.19.5,<2.dev0" +jsonschema = ">=3.2,<5" +pydantic = ">=1.8,<3" +typing-extensions = ">=4.4,<5" + +[package.extras] +dev = ["black (==23.3.0)", "boto3 (>=1.23,<2)", "boto3-stubs[appconfig,serverlessrepo] (>=1.19.5,<2.dev0)", "coverage (>=5.3,<8)", "dateparser (>=1.1,<2.0)", "importlib-metadata", "mypy (>=1.3.0,<1.4.0)", "parameterized (>=0.7,<1.0)", "pytest (>=6.2,<8)", "pytest-cov (>=2.10,<5)", "pytest-env (>=0.6,<1)", "pytest-rerunfailures (>=9.1,<12)", "pytest-xdist (>=2.5,<4)", "pyyaml (>=6.0,<7.0)", "requests (>=2.28,<3.0)", "ruamel.yaml (==0.17.21)", "ruff (==0.0.284)", "tenacity (>=8.0,<9.0)", "types-PyYAML (>=6.0,<7.0)", "types-jsonschema (>=3.2,<4.0)"] + +[[package]] +name = "aws-xray-sdk" +version = "2.12.1" +description = "The AWS X-Ray SDK for Python (the SDK) enables Python developers to record and emit information from within their applications to the AWS X-Ray service." +optional = false +python-versions = ">=3.7" +files = [ + {file = "aws-xray-sdk-2.12.1.tar.gz", hash = "sha256:0bbfdbc773cfef4061062ac940b85e408297a2242f120bcdfee2593209b1e432"}, + {file = "aws_xray_sdk-2.12.1-py2.py3-none-any.whl", hash = "sha256:f6803832dc08d18cc265e2327a69bfa9ee41c121fac195edc9745d04b7a566c3"}, +] + +[package.dependencies] +botocore = ">=1.11.3" +wrapt = "*" + [[package]] name = "awsipranges" version = "0.3.3" @@ -212,13 +264,13 @@ msrest = ">=0.7.1" [[package]] name = "azure-storage-blob" -version = "12.18.3" +version = "12.19.0" description = "Microsoft Azure Blob Storage Client Library for Python" optional = false python-versions = ">=3.7" files = [ - {file = "azure-storage-blob-12.18.3.tar.gz", hash = "sha256:d8ced0deee3367fa3d4f3d1a03cd9edadf4440c0a371f503d623fa6c807554ee"}, - {file = "azure_storage_blob-12.18.3-py3-none-any.whl", hash = "sha256:c278dde2ac41857a68d615c9f2b36d894ba877a7e84d62795603c7e79d0bb5e9"}, + {file = "azure-storage-blob-12.19.0.tar.gz", hash = "sha256:26c0a4320a34a3c2a1b74528ba6812ebcb632a04cd67b1c7377232c4b01a5897"}, + {file = "azure_storage_blob-12.19.0-py3-none-any.whl", hash = "sha256:7bbc2c9c16678f7a420367fef6b172ba8730a7e66df7f4d7a55d5b3c8216615b"}, ] [package.dependencies] @@ -435,6 +487,29 @@ files = [ [package.dependencies] pycparser = "*" +[[package]] +name = "cfn-lint" +version = "0.83.3" +description = "Checks CloudFormation templates for practices and behaviour that could potentially be improved" +optional = false +python-versions = ">=3.7, <=4.0, !=4.0" +files = [ + {file = "cfn-lint-0.83.3.tar.gz", hash = "sha256:cb1b5da6f3f15742f07f89006b9cc6ca459745f350196b559688ac0982111c5f"}, + {file = "cfn_lint-0.83.3-py3-none-any.whl", hash = "sha256:7acb5c40b6ae454006bfa19d586c67d0c4ed9a6dbb344fd470bc773981a0642a"}, +] + +[package.dependencies] +aws-sam-translator = ">=1.79.0" +jschema-to-python = ">=1.2.3,<1.3.0" +jsonpatch = "*" +jsonschema = ">=3.0,<5" +junit-xml = ">=1.9,<2.0" +networkx = ">=2.4,<4" +pyyaml = ">5.4" +regex = ">=2021.7.1" +sarif-om = ">=1.0.4,<1.1.0" +sympy = ">=1.0.0" + [[package]] name = "charset-normalizer" version = "3.1.0" @@ -757,6 +832,24 @@ toml = "*" conda = ["pyyaml"] pipenv = ["pipenv"] +[[package]] +name = "ecdsa" +version = "0.18.0" +description = "ECDSA cryptographic signature library (pure python)" +optional = false +python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" +files = [ + {file = "ecdsa-0.18.0-py2.py3-none-any.whl", hash = "sha256:80600258e7ed2f16b9aa1d7c295bd70194109ad5a30fdee0eaeefef1d4c559dd"}, + {file = "ecdsa-0.18.0.tar.gz", hash = "sha256:190348041559e21b22a1d65cee485282ca11a6f81d503fddb84d5017e9ed1e49"}, +] + +[package.dependencies] +six = ">=1.9.0" + +[package.extras] +gmpy = ["gmpy"] +gmpy2 = ["gmpy2"] + [[package]] name = "exceptiongroup" version = "1.1.1" @@ -902,13 +995,13 @@ grpcio-gcp = ["grpcio-gcp (>=0.2.2,<1.0dev)"] [[package]] name = "google-api-python-client" -version = "2.105.0" +version = "2.108.0" description = "Google API Client Library for Python" optional = false python-versions = ">=3.7" files = [ - {file = "google-api-python-client-2.105.0.tar.gz", hash = "sha256:0a8b32cfc2d9b3c1868ae6faef7ee1ab9c89a6cec30be709ea9c97f9a3e5902d"}, - {file = "google_api_python_client-2.105.0-py2.py3-none-any.whl", hash = "sha256:571ce7c41e53415e385aab5a955725f71780550683ffcb71596f5809677d40b7"}, + {file = "google-api-python-client-2.108.0.tar.gz", hash = "sha256:6396efca83185fb205c0abdbc1c2ee57b40475578c6af37f6d0e30a639aade99"}, + {file = "google_api_python_client-2.108.0-py2.py3-none-any.whl", hash = "sha256:9d1327213e388943ebcd7db5ce6e7f47987a7e6874e3e1f6116010eea4a0e75d"}, ] [package.dependencies] @@ -987,6 +1080,17 @@ files = [ [package.extras] test = ["pytest", "sphinx", "sphinx-autobuild", "twine", "wheel"] +[[package]] +name = "graphql-core" +version = "3.2.3" +description = "GraphQL implementation for Python, a port of GraphQL.js, the JavaScript reference implementation for GraphQL." +optional = false +python-versions = ">=3.6,<4" +files = [ + {file = "graphql-core-3.2.3.tar.gz", hash = "sha256:06d2aad0ac723e35b1cb47885d3e5c45e956a53bc1b209a9fc5369007fe46676"}, + {file = "graphql_core-3.2.3-py3-none-any.whl", hash = "sha256:5766780452bd5ec8ba133f8bf287dc92713e3868ddd83aee4faab9fc3e303dc3"}, +] + [[package]] name = "httplib2" version = "0.22.0" @@ -1101,6 +1205,74 @@ files = [ {file = "jmespath-1.0.1.tar.gz", hash = "sha256:90261b206d6defd58fdd5e85f478bf633a2901798906be2ad389150c5c60edbe"}, ] +[[package]] +name = "jschema-to-python" +version = "1.2.3" +description = "Generate source code for Python classes from a JSON schema." +optional = false +python-versions = ">= 2.7" +files = [ + {file = "jschema_to_python-1.2.3-py3-none-any.whl", hash = "sha256:8a703ca7604d42d74b2815eecf99a33359a8dccbb80806cce386d5e2dd992b05"}, + {file = "jschema_to_python-1.2.3.tar.gz", hash = "sha256:76ff14fe5d304708ccad1284e4b11f96a658949a31ee7faed9e0995279549b91"}, +] + +[package.dependencies] +attrs = "*" +jsonpickle = "*" +pbr = "*" + +[[package]] +name = "jsondiff" +version = "2.0.0" +description = "Diff JSON and JSON-like structures in Python" +optional = false +python-versions = "*" +files = [ + {file = "jsondiff-2.0.0-py3-none-any.whl", hash = "sha256:689841d66273fc88fc79f7d33f4c074774f4f214b6466e3aff0e5adaf889d1e0"}, + {file = "jsondiff-2.0.0.tar.gz", hash = "sha256:2795844ef075ec8a2b8d385c4d59f5ea48b08e7180fce3cb2787be0db00b1fb4"}, +] + +[[package]] +name = "jsonpatch" +version = "1.33" +description = "Apply JSON-Patches (RFC 6902)" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*" +files = [ + {file = "jsonpatch-1.33-py2.py3-none-any.whl", hash = "sha256:0ae28c0cd062bbd8b8ecc26d7d164fbbea9652a1a3693f3b956c1eae5145dade"}, + {file = "jsonpatch-1.33.tar.gz", hash = "sha256:9fcd4009c41e6d12348b4a0ff2563ba56a2923a7dfee731d004e212e1ee5030c"}, +] + +[package.dependencies] +jsonpointer = ">=1.9" + +[[package]] +name = "jsonpickle" +version = "3.0.2" +description = "Python library for serializing any arbitrary object graph into JSON" +optional = false +python-versions = ">=3.7" +files = [ + {file = "jsonpickle-3.0.2-py3-none-any.whl", hash = "sha256:4a8442d97ca3f77978afa58068768dba7bff2dbabe79a9647bc3cdafd4ef019f"}, + {file = "jsonpickle-3.0.2.tar.gz", hash = "sha256:e37abba4bfb3ca4a4647d28bb9f4706436f7b46c8a8333b4a718abafa8e46b37"}, +] + +[package.extras] +docs = ["jaraco.packaging (>=3.2)", "rst.linker (>=1.9)", "sphinx"] +testing = ["ecdsa", "feedparser", "gmpy2", "numpy", "pandas", "pymongo", "pytest (>=3.5,!=3.7.3)", "pytest-black-multipy", "pytest-checkdocs (>=1.2.3)", "pytest-cov", "pytest-flake8 (>=1.1.1)", "scikit-learn", "sqlalchemy"] +testing-libs = ["simplejson", "ujson"] + +[[package]] +name = "jsonpointer" +version = "2.4" +description = "Identify specific nodes in a JSON document (RFC 6901)" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*" +files = [ + {file = "jsonpointer-2.4-py2.py3-none-any.whl", hash = "sha256:15d51bba20eea3165644553647711d150376234112651b4f1811022aecad7d7a"}, + {file = "jsonpointer-2.4.tar.gz", hash = "sha256:585cee82b70211fa9e6043b7bb89db6e1aa49524340dde8ad6b63206ea689d88"}, +] + [[package]] name = "jsonschema" version = "4.18.0" @@ -1153,6 +1325,20 @@ files = [ [package.dependencies] referencing = ">=0.28.0" +[[package]] +name = "junit-xml" +version = "1.9" +description = "Creates JUnit XML test result documents that can be read by tools such as Jenkins" +optional = false +python-versions = "*" +files = [ + {file = "junit-xml-1.9.tar.gz", hash = "sha256:de16a051990d4e25a3982b2dd9e89d671067548718866416faec14d9de56db9f"}, + {file = "junit_xml-1.9-py2.py3-none-any.whl", hash = "sha256:ec5ca1a55aefdd76d28fcc0b135251d156c7106fa979686a4b48d62b761b4732"}, +] + +[package.dependencies] +six = "*" + [[package]] name = "lazy-object-proxy" version = "1.9.0" @@ -1365,13 +1551,13 @@ min-versions = ["babel (==2.9.0)", "click (==7.0)", "colorama (==0.4)", "ghp-imp [[package]] name = "mkdocs-material" -version = "9.4.7" +version = "9.4.10" description = "Documentation that simply works" optional = true python-versions = ">=3.8" files = [ - {file = "mkdocs_material-9.4.7-py3-none-any.whl", hash = "sha256:4d698d52bb6a6a3c452ab854481c4cdb68453a0420956a6aee2de55fe15fe610"}, - {file = "mkdocs_material-9.4.7.tar.gz", hash = "sha256:e704e001c9ef17291e1d3462c202425217601653e18f68f85d28eff4690e662b"}, + {file = "mkdocs_material-9.4.10-py3-none-any.whl", hash = "sha256:207c4ebc07faebb220437d2c626edb0c9760c82ccfc484500bd3eb30dfce988c"}, + {file = "mkdocs_material-9.4.10.tar.gz", hash = "sha256:421adedaeaa461dcaf55b8d406673934ade3d4f05ed9819e4cc7b4ee1d646a62"}, ] [package.dependencies] @@ -1421,53 +1607,84 @@ test = ["pytest", "pytest-cov"] [[package]] name = "moto" -version = "4.2.7" +version = "4.2.9" description = "" optional = false python-versions = ">=3.7" files = [ - {file = "moto-4.2.7-py2.py3-none-any.whl", hash = "sha256:3e0ef388900448485cd6eff18e9f7fcaa6cf4560b6fb536ba2e2e1278a5ecc59"}, - {file = "moto-4.2.7.tar.gz", hash = "sha256:1298006aaa6996b886658eb194cac0e3a5679c9fcce6cb13e741ccc5a7247abb"}, + {file = "moto-4.2.9-py2.py3-none-any.whl", hash = "sha256:c85289d13d15d5274d0a643381af1f1b03d7ee88f0943c9d2d6c28e6177a298a"}, + {file = "moto-4.2.9.tar.gz", hash = "sha256:24de81eeaa450a20b57c5cdf9a757ea5216bddc7db798e335d2de1f2376bf324"}, ] [package.dependencies] +aws-xray-sdk = {version = ">=0.93,<0.96 || >0.96", optional = true, markers = "extra == \"all\""} boto3 = ">=1.9.201" botocore = ">=1.12.201" +cfn-lint = {version = ">=0.40.0", optional = true, markers = "extra == \"all\""} cryptography = ">=3.3.1" +docker = {version = ">=3.0.0", optional = true, markers = "extra == \"all\""} +ecdsa = {version = "!=0.15", optional = true, markers = "extra == \"all\""} +graphql-core = {version = "*", optional = true, markers = "extra == \"all\""} Jinja2 = ">=2.10.1" +jsondiff = {version = ">=1.1.2", optional = true, markers = "extra == \"all\""} +multipart = {version = "*", optional = true, markers = "extra == \"all\""} +openapi-spec-validator = {version = ">=0.5.0", optional = true, markers = "extra == \"all\""} +py-partiql-parser = {version = "0.4.2", optional = true, markers = "extra == \"all\""} +pyparsing = {version = ">=3.0.7", optional = true, markers = "extra == \"all\""} python-dateutil = ">=2.1,<3.0.0" +python-jose = {version = ">=3.1.0,<4.0.0", extras = ["cryptography"], optional = true, markers = "extra == \"all\""} +PyYAML = {version = ">=5.1", optional = true, markers = "extra == \"all\""} requests = ">=2.5" responses = ">=0.13.0" +setuptools = {version = "*", optional = true, markers = "extra == \"all\""} +sshpubkeys = {version = ">=3.1.0", optional = true, markers = "extra == \"all\""} werkzeug = ">=0.5,<2.2.0 || >2.2.0,<2.2.1 || >2.2.1" xmltodict = "*" [package.extras] -all = ["PyYAML (>=5.1)", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "ecdsa (!=0.15)", "graphql-core", "jsondiff (>=1.1.2)", "multipart", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.4.1)", "pyparsing (>=3.0.7)", "python-jose[cryptography] (>=3.1.0,<4.0.0)", "setuptools", "sshpubkeys (>=3.1.0)"] +all = ["PyYAML (>=5.1)", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "ecdsa (!=0.15)", "graphql-core", "jsondiff (>=1.1.2)", "multipart", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.4.2)", "pyparsing (>=3.0.7)", "python-jose[cryptography] (>=3.1.0,<4.0.0)", "setuptools", "sshpubkeys (>=3.1.0)"] apigateway = ["PyYAML (>=5.1)", "ecdsa (!=0.15)", "openapi-spec-validator (>=0.5.0)", "python-jose[cryptography] (>=3.1.0,<4.0.0)"] apigatewayv2 = ["PyYAML (>=5.1)"] appsync = ["graphql-core"] awslambda = ["docker (>=3.0.0)"] batch = ["docker (>=3.0.0)"] -cloudformation = ["PyYAML (>=5.1)", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "ecdsa (!=0.15)", "graphql-core", "jsondiff (>=1.1.2)", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.4.1)", "pyparsing (>=3.0.7)", "python-jose[cryptography] (>=3.1.0,<4.0.0)", "setuptools", "sshpubkeys (>=3.1.0)"] +cloudformation = ["PyYAML (>=5.1)", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "ecdsa (!=0.15)", "graphql-core", "jsondiff (>=1.1.2)", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.4.2)", "pyparsing (>=3.0.7)", "python-jose[cryptography] (>=3.1.0,<4.0.0)", "setuptools", "sshpubkeys (>=3.1.0)"] cognitoidp = ["ecdsa (!=0.15)", "python-jose[cryptography] (>=3.1.0,<4.0.0)"] ds = ["sshpubkeys (>=3.1.0)"] -dynamodb = ["docker (>=3.0.0)", "py-partiql-parser (==0.4.1)"] -dynamodbstreams = ["docker (>=3.0.0)", "py-partiql-parser (==0.4.1)"] +dynamodb = ["docker (>=3.0.0)", "py-partiql-parser (==0.4.2)"] +dynamodbstreams = ["docker (>=3.0.0)", "py-partiql-parser (==0.4.2)"] ebs = ["sshpubkeys (>=3.1.0)"] ec2 = ["sshpubkeys (>=3.1.0)"] efs = ["sshpubkeys (>=3.1.0)"] eks = ["sshpubkeys (>=3.1.0)"] glue = ["pyparsing (>=3.0.7)"] iotdata = ["jsondiff (>=1.1.2)"] -proxy = ["PyYAML (>=5.1)", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=2.5.1)", "ecdsa (!=0.15)", "graphql-core", "jsondiff (>=1.1.2)", "multipart", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.4.1)", "pyparsing (>=3.0.7)", "python-jose[cryptography] (>=3.1.0,<4.0.0)", "setuptools", "sshpubkeys (>=3.1.0)"] -resourcegroupstaggingapi = ["PyYAML (>=5.1)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "ecdsa (!=0.15)", "graphql-core", "jsondiff (>=1.1.2)", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.4.1)", "pyparsing (>=3.0.7)", "python-jose[cryptography] (>=3.1.0,<4.0.0)", "sshpubkeys (>=3.1.0)"] +proxy = ["PyYAML (>=5.1)", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=2.5.1)", "ecdsa (!=0.15)", "graphql-core", "jsondiff (>=1.1.2)", "multipart", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.4.2)", "pyparsing (>=3.0.7)", "python-jose[cryptography] (>=3.1.0,<4.0.0)", "setuptools", "sshpubkeys (>=3.1.0)"] +resourcegroupstaggingapi = ["PyYAML (>=5.1)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "ecdsa (!=0.15)", "graphql-core", "jsondiff (>=1.1.2)", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.4.2)", "pyparsing (>=3.0.7)", "python-jose[cryptography] (>=3.1.0,<4.0.0)", "sshpubkeys (>=3.1.0)"] route53resolver = ["sshpubkeys (>=3.1.0)"] -s3 = ["PyYAML (>=5.1)", "py-partiql-parser (==0.4.1)"] -s3crc32c = ["PyYAML (>=5.1)", "crc32c", "py-partiql-parser (==0.4.1)"] -server = ["PyYAML (>=5.1)", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "ecdsa (!=0.15)", "flask (!=2.2.0,!=2.2.1)", "flask-cors", "graphql-core", "jsondiff (>=1.1.2)", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.4.1)", "pyparsing (>=3.0.7)", "python-jose[cryptography] (>=3.1.0,<4.0.0)", "setuptools", "sshpubkeys (>=3.1.0)"] +s3 = ["PyYAML (>=5.1)", "py-partiql-parser (==0.4.2)"] +s3crc32c = ["PyYAML (>=5.1)", "crc32c", "py-partiql-parser (==0.4.2)"] +server = ["PyYAML (>=5.1)", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "ecdsa (!=0.15)", "flask (!=2.2.0,!=2.2.1)", "flask-cors", "graphql-core", "jsondiff (>=1.1.2)", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.4.2)", "pyparsing (>=3.0.7)", "python-jose[cryptography] (>=3.1.0,<4.0.0)", "setuptools", "sshpubkeys (>=3.1.0)"] ssm = ["PyYAML (>=5.1)"] xray = ["aws-xray-sdk (>=0.93,!=0.96)", "setuptools"] +[[package]] +name = "mpmath" +version = "1.3.0" +description = "Python library for arbitrary-precision floating-point arithmetic" +optional = false +python-versions = "*" +files = [ + {file = "mpmath-1.3.0-py3-none-any.whl", hash = "sha256:a0b2b9fe80bbcd81a6647ff13108738cfb482d481d826cc0e02f5b35e5c88d2c"}, + {file = "mpmath-1.3.0.tar.gz", hash = "sha256:7a28eb2a9774d00c7bc92411c19a89209d5da7c4c9a9e227be8330a23a25b91f"}, +] + +[package.extras] +develop = ["codecov", "pycodestyle", "pytest (>=4.6)", "pytest-cov", "wheel"] +docs = ["sphinx"] +gmpy = ["gmpy2 (>=2.1.0a4)"] +tests = ["pytest (>=4.6)"] + [[package]] name = "msal" version = "1.24.1" @@ -1537,6 +1754,33 @@ requests-oauthlib = ">=0.5.0" [package.extras] async = ["aiodns", "aiohttp (>=3.0)"] +[[package]] +name = "msrestazure" +version = "0.6.4" +description = "AutoRest swagger generator Python client runtime. Azure-specific module." +optional = false +python-versions = "*" +files = [ + {file = "msrestazure-0.6.4-py2.py3-none-any.whl", hash = "sha256:3de50f56147ef529b31e099a982496690468ecef33f0544cb0fa0cfe1e1de5b9"}, + {file = "msrestazure-0.6.4.tar.gz", hash = "sha256:a06f0dabc9a6f5efe3b6add4bd8fb623aeadacf816b7a35b0f89107e0544d189"}, +] + +[package.dependencies] +adal = ">=0.6.0,<2.0.0" +msrest = ">=0.6.0,<2.0.0" +six = "*" + +[[package]] +name = "multipart" +version = "0.2.4" +description = "Parser for multipart/form-data." +optional = false +python-versions = "*" +files = [ + {file = "multipart-0.2.4-py3-none-any.whl", hash = "sha256:5aec990820b8a9e94f9c164fbeb58cf118cfbde2854865b67a9a730edd1fb9d1"}, + {file = "multipart-0.2.4.tar.gz", hash = "sha256:06ba205360bc7096fefe618e4f1e9b2cdb890b4f2157053a81f386912a2522cb"}, +] + [[package]] name = "mypy-extensions" version = "1.0.0" @@ -1548,6 +1792,24 @@ files = [ {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"}, ] +[[package]] +name = "networkx" +version = "3.2.1" +description = "Python package for creating and manipulating graphs and networks" +optional = false +python-versions = ">=3.9" +files = [ + {file = "networkx-3.2.1-py3-none-any.whl", hash = "sha256:f18c69adc97877c42332c170849c96cefa91881c99a7cb3e95b7c659ebdc1ec2"}, + {file = "networkx-3.2.1.tar.gz", hash = "sha256:9f1bb5cf3409bf324e0a722c20bdb4c20ee39bf1c30ce8ae499c8502b0b5e0c6"}, +] + +[package.extras] +default = ["matplotlib (>=3.5)", "numpy (>=1.22)", "pandas (>=1.4)", "scipy (>=1.9,!=1.11.0,!=1.11.1)"] +developer = ["changelist (==0.4)", "mypy (>=1.1)", "pre-commit (>=3.2)", "rtoml"] +doc = ["nb2plots (>=0.7)", "nbconvert (<7.9)", "numpydoc (>=1.6)", "pillow (>=9.4)", "pydata-sphinx-theme (>=0.14)", "sphinx (>=7)", "sphinx-gallery (>=0.14)", "texext (>=0.6.7)"] +extra = ["lxml (>=4.6)", "pydot (>=1.4.2)", "pygraphviz (>=1.11)", "sympy (>=1.10)"] +test = ["pytest (>=7.2)", "pytest-cov (>=4.0)"] + [[package]] name = "oauthlib" version = "3.2.2" @@ -1725,6 +1987,20 @@ files = [ {file = "protobuf-4.23.0.tar.gz", hash = "sha256:5f1eba1da2a2f3f7df469fccddef3cc060b8a16cfe3cc65961ad36b4dbcf59c5"}, ] +[[package]] +name = "py-partiql-parser" +version = "0.4.2" +description = "Pure Python PartiQL Parser" +optional = false +python-versions = "*" +files = [ + {file = "py-partiql-parser-0.4.2.tar.gz", hash = "sha256:9c99d545be7897c6bfa97a107f6cfbcd92e359d394e4f3b95430e6409e8dd1e1"}, + {file = "py_partiql_parser-0.4.2-py3-none-any.whl", hash = "sha256:f3f34de8dddf65ed2d47b4263560bbf97be1ecc6bd5c61da039ede90f26a10ce"}, +] + +[package.extras] +dev = ["black (==22.6.0)", "flake8", "mypy (==0.971)", "pytest"] + [[package]] name = "pyasn1" version = "0.5.0" @@ -1885,8 +2161,7 @@ astroid = ">=3.0.1,<=3.1.0-dev0" colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""} dill = [ {version = ">=0.2", markers = "python_version < \"3.11\""}, - {version = ">=0.3.7", markers = "python_version >= \"3.12\""}, - {version = ">=0.3.6", markers = "python_version >= \"3.11\" and python_version < \"3.12\""}, + {version = ">=0.3.6", markers = "python_version >= \"3.11\""}, ] isort = ">=4.2.5,<6" mccabe = ">=0.6,<0.8" @@ -1988,13 +2263,13 @@ pytest = "*" [[package]] name = "pytest-xdist" -version = "3.3.1" +version = "3.4.0" description = "pytest xdist plugin for distributed testing, most importantly across multiple CPUs" optional = false python-versions = ">=3.7" files = [ - {file = "pytest-xdist-3.3.1.tar.gz", hash = "sha256:d5ee0520eb1b7bcca50a60a518ab7a7707992812c578198f8b44fdfac78e8c93"}, - {file = "pytest_xdist-3.3.1-py3-none-any.whl", hash = "sha256:ff9daa7793569e6a68544850fd3927cd257cc03a7ef76c95e86915355e82b5f2"}, + {file = "pytest-xdist-3.4.0.tar.gz", hash = "sha256:3a94a931dd9e268e0b871a877d09fe2efb6175c2c23d60d56a6001359002b832"}, + {file = "pytest_xdist-3.4.0-py3-none-any.whl", hash = "sha256:e513118bf787677a427e025606f55e95937565e06dfaac8d87f55301e57ae607"}, ] [package.dependencies] @@ -2020,6 +2295,28 @@ files = [ [package.dependencies] six = ">=1.5" +[[package]] +name = "python-jose" +version = "3.3.0" +description = "JOSE implementation in Python" +optional = false +python-versions = "*" +files = [ + {file = "python-jose-3.3.0.tar.gz", hash = "sha256:55779b5e6ad599c6336191246e95eb2293a9ddebd555f796a65f838f07e5d78a"}, + {file = "python_jose-3.3.0-py2.py3-none-any.whl", hash = "sha256:9b1376b023f8b298536eedd47ae1089bcdb848f1535ab30555cd92002d78923a"}, +] + +[package.dependencies] +cryptography = {version = ">=3.4.0", optional = true, markers = "extra == \"cryptography\""} +ecdsa = "!=0.15" +pyasn1 = "*" +rsa = "*" + +[package.extras] +cryptography = ["cryptography (>=3.4.0)"] +pycrypto = ["pyasn1", "pycrypto (>=2.6.0,<2.7.0)"] +pycryptodome = ["pyasn1", "pycryptodome (>=3.3.1,<4.0.0)"] + [[package]] name = "pywin32" version = "306" @@ -2125,7 +2422,7 @@ rpds-py = ">=0.7.0" name = "regex" version = "2023.8.8" description = "Alternative regular expression module, to replace re." -optional = true +optional = false python-versions = ">=3.6" files = [ {file = "regex-2023.8.8-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:88900f521c645f784260a8d346e12a1590f79e96403971241e64c3a265c8ecdb"}, @@ -2548,6 +2845,21 @@ setuptools = ">=19.3" github = ["jinja2 (>=3.1.0)", "pygithub (>=1.43.3)"] gitlab = ["python-gitlab (>=1.3.0)"] +[[package]] +name = "sarif-om" +version = "1.0.4" +description = "Classes implementing the SARIF 2.1.0 object model." +optional = false +python-versions = ">= 2.7" +files = [ + {file = "sarif_om-1.0.4-py3-none-any.whl", hash = "sha256:539ef47a662329b1c8502388ad92457425e95dc0aaaf995fe46f4984c4771911"}, + {file = "sarif_om-1.0.4.tar.gz", hash = "sha256:cd5f416b3083e00d402a92e449a7ff67af46f11241073eea0461802a3b5aef98"}, +] + +[package.dependencies] +attrs = "*" +pbr = "*" + [[package]] name = "schema" version = "0.7.5" @@ -2609,13 +2921,13 @@ files = [ [[package]] name = "slack-sdk" -version = "3.23.0" +version = "3.24.0" description = "The Slack API Platform SDK for Python" optional = false python-versions = ">=3.6.0" files = [ - {file = "slack_sdk-3.23.0-py2.py3-none-any.whl", hash = "sha256:2a8513505cced20ceee22b5b49c11d9545caa6234b56bf0ad47133ea5b357d10"}, - {file = "slack_sdk-3.23.0.tar.gz", hash = "sha256:9d6ebc4ff74e7983e1b27dbdb0f2bb6fc3c2a2451694686eaa2be23bbb085a73"}, + {file = "slack_sdk-3.24.0-py2.py3-none-any.whl", hash = "sha256:cae64f0177a53d34cca59cc691d4535edd18929843a936b97cea421db9e4fbfe"}, + {file = "slack_sdk-3.24.0.tar.gz", hash = "sha256:741ea5381e65f4407d24ed81203912cbd6bfe807a6704b1d3c5ad346c86000b6"}, ] [package.extras] @@ -2633,6 +2945,24 @@ files = [ {file = "smmap-5.0.0.tar.gz", hash = "sha256:c840e62059cd3be204b0c9c9f74be2c09d5648eddd4580d9314c3ecde0b30936"}, ] +[[package]] +name = "sshpubkeys" +version = "3.3.1" +description = "SSH public key parser" +optional = false +python-versions = ">=3" +files = [ + {file = "sshpubkeys-3.3.1-py2.py3-none-any.whl", hash = "sha256:946f76b8fe86704b0e7c56a00d80294e39bc2305999844f079a217885060b1ac"}, + {file = "sshpubkeys-3.3.1.tar.gz", hash = "sha256:3020ed4f8c846849299370fbe98ff4157b0ccc1accec105e07cfa9ae4bb55064"}, +] + +[package.dependencies] +cryptography = ">=2.1.4" +ecdsa = ">=0.13" + +[package.extras] +dev = ["twine", "wheel", "yapf"] + [[package]] name = "stevedore" version = "5.0.0" @@ -2647,6 +2977,20 @@ files = [ [package.dependencies] pbr = ">=2.0.0,<2.1.0 || >2.1.0" +[[package]] +name = "sympy" +version = "1.12" +description = "Computer algebra system (CAS) in Python" +optional = false +python-versions = ">=3.8" +files = [ + {file = "sympy-1.12-py3-none-any.whl", hash = "sha256:c3588cd4295d0c0f603d0f2ae780587e64e2efeedb3521e46b9bb1d08d184fa5"}, + {file = "sympy-1.12.tar.gz", hash = "sha256:ebf595c8dac3e0fdc4152c51878b498396ec7f30e7a914d6071e674d49420fb8"}, +] + +[package.dependencies] +mpmath = ">=0.19" + [[package]] name = "tabulate" version = "0.9.0" @@ -2846,6 +3190,85 @@ MarkupSafe = ">=2.1.1" [package.extras] watchdog = ["watchdog (>=2.3)"] +[[package]] +name = "wrapt" +version = "1.16.0" +description = "Module for decorators, wrappers and monkey patching." +optional = false +python-versions = ">=3.6" +files = [ + {file = "wrapt-1.16.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:ffa565331890b90056c01db69c0fe634a776f8019c143a5ae265f9c6bc4bd6d4"}, + {file = "wrapt-1.16.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:e4fdb9275308292e880dcbeb12546df7f3e0f96c6b41197e0cf37d2826359020"}, + {file = "wrapt-1.16.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bb2dee3874a500de01c93d5c71415fcaef1d858370d405824783e7a8ef5db440"}, + {file = "wrapt-1.16.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:2a88e6010048489cda82b1326889ec075a8c856c2e6a256072b28eaee3ccf487"}, + {file = "wrapt-1.16.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ac83a914ebaf589b69f7d0a1277602ff494e21f4c2f743313414378f8f50a4cf"}, + {file = "wrapt-1.16.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:73aa7d98215d39b8455f103de64391cb79dfcad601701a3aa0dddacf74911d72"}, + {file = "wrapt-1.16.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:807cc8543a477ab7422f1120a217054f958a66ef7314f76dd9e77d3f02cdccd0"}, + {file = "wrapt-1.16.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:bf5703fdeb350e36885f2875d853ce13172ae281c56e509f4e6eca049bdfb136"}, + {file = "wrapt-1.16.0-cp310-cp310-win32.whl", hash = "sha256:f6b2d0c6703c988d334f297aa5df18c45e97b0af3679bb75059e0e0bd8b1069d"}, + {file = "wrapt-1.16.0-cp310-cp310-win_amd64.whl", hash = "sha256:decbfa2f618fa8ed81c95ee18a387ff973143c656ef800c9f24fb7e9c16054e2"}, + {file = "wrapt-1.16.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:1a5db485fe2de4403f13fafdc231b0dbae5eca4359232d2efc79025527375b09"}, + {file = "wrapt-1.16.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:75ea7d0ee2a15733684badb16de6794894ed9c55aa5e9903260922f0482e687d"}, + {file = "wrapt-1.16.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a452f9ca3e3267cd4d0fcf2edd0d035b1934ac2bd7e0e57ac91ad6b95c0c6389"}, + {file = "wrapt-1.16.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:43aa59eadec7890d9958748db829df269f0368521ba6dc68cc172d5d03ed8060"}, + {file = "wrapt-1.16.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:72554a23c78a8e7aa02abbd699d129eead8b147a23c56e08d08dfc29cfdddca1"}, + {file = "wrapt-1.16.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:d2efee35b4b0a347e0d99d28e884dfd82797852d62fcd7ebdeee26f3ceb72cf3"}, + {file = "wrapt-1.16.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:6dcfcffe73710be01d90cae08c3e548d90932d37b39ef83969ae135d36ef3956"}, + {file = "wrapt-1.16.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:eb6e651000a19c96f452c85132811d25e9264d836951022d6e81df2fff38337d"}, + {file = "wrapt-1.16.0-cp311-cp311-win32.whl", hash = "sha256:66027d667efe95cc4fa945af59f92c5a02c6f5bb6012bff9e60542c74c75c362"}, + {file = "wrapt-1.16.0-cp311-cp311-win_amd64.whl", hash = "sha256:aefbc4cb0a54f91af643660a0a150ce2c090d3652cf4052a5397fb2de549cd89"}, + {file = "wrapt-1.16.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:5eb404d89131ec9b4f748fa5cfb5346802e5ee8836f57d516576e61f304f3b7b"}, + {file = "wrapt-1.16.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:9090c9e676d5236a6948330e83cb89969f433b1943a558968f659ead07cb3b36"}, + {file = "wrapt-1.16.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:94265b00870aa407bd0cbcfd536f17ecde43b94fb8d228560a1e9d3041462d73"}, + {file = "wrapt-1.16.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f2058f813d4f2b5e3a9eb2eb3faf8f1d99b81c3e51aeda4b168406443e8ba809"}, + {file = "wrapt-1.16.0-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:98b5e1f498a8ca1858a1cdbffb023bfd954da4e3fa2c0cb5853d40014557248b"}, + {file = "wrapt-1.16.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:14d7dc606219cdd7405133c713f2c218d4252f2a469003f8c46bb92d5d095d81"}, + {file = "wrapt-1.16.0-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:49aac49dc4782cb04f58986e81ea0b4768e4ff197b57324dcbd7699c5dfb40b9"}, + {file = "wrapt-1.16.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:418abb18146475c310d7a6dc71143d6f7adec5b004ac9ce08dc7a34e2babdc5c"}, + {file = "wrapt-1.16.0-cp312-cp312-win32.whl", hash = "sha256:685f568fa5e627e93f3b52fda002c7ed2fa1800b50ce51f6ed1d572d8ab3e7fc"}, + {file = "wrapt-1.16.0-cp312-cp312-win_amd64.whl", hash = "sha256:dcdba5c86e368442528f7060039eda390cc4091bfd1dca41e8046af7c910dda8"}, + {file = "wrapt-1.16.0-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:d462f28826f4657968ae51d2181a074dfe03c200d6131690b7d65d55b0f360f8"}, + {file = "wrapt-1.16.0-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a33a747400b94b6d6b8a165e4480264a64a78c8a4c734b62136062e9a248dd39"}, + {file = "wrapt-1.16.0-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b3646eefa23daeba62643a58aac816945cadc0afaf21800a1421eeba5f6cfb9c"}, + {file = "wrapt-1.16.0-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3ebf019be5c09d400cf7b024aa52b1f3aeebeff51550d007e92c3c1c4afc2a40"}, + {file = "wrapt-1.16.0-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:0d2691979e93d06a95a26257adb7bfd0c93818e89b1406f5a28f36e0d8c1e1fc"}, + {file = "wrapt-1.16.0-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:1acd723ee2a8826f3d53910255643e33673e1d11db84ce5880675954183ec47e"}, + {file = "wrapt-1.16.0-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:bc57efac2da352a51cc4658878a68d2b1b67dbe9d33c36cb826ca449d80a8465"}, + {file = "wrapt-1.16.0-cp36-cp36m-win32.whl", hash = "sha256:da4813f751142436b075ed7aa012a8778aa43a99f7b36afe9b742d3ed8bdc95e"}, + {file = "wrapt-1.16.0-cp36-cp36m-win_amd64.whl", hash = "sha256:6f6eac2360f2d543cc875a0e5efd413b6cbd483cb3ad7ebf888884a6e0d2e966"}, + {file = "wrapt-1.16.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:a0ea261ce52b5952bf669684a251a66df239ec6d441ccb59ec7afa882265d593"}, + {file = "wrapt-1.16.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7bd2d7ff69a2cac767fbf7a2b206add2e9a210e57947dd7ce03e25d03d2de292"}, + {file = "wrapt-1.16.0-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9159485323798c8dc530a224bd3ffcf76659319ccc7bbd52e01e73bd0241a0c5"}, + {file = "wrapt-1.16.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a86373cf37cd7764f2201b76496aba58a52e76dedfaa698ef9e9688bfd9e41cf"}, + {file = "wrapt-1.16.0-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:73870c364c11f03ed072dda68ff7aea6d2a3a5c3fe250d917a429c7432e15228"}, + {file = "wrapt-1.16.0-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:b935ae30c6e7400022b50f8d359c03ed233d45b725cfdd299462f41ee5ffba6f"}, + {file = "wrapt-1.16.0-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:db98ad84a55eb09b3c32a96c576476777e87c520a34e2519d3e59c44710c002c"}, + {file = "wrapt-1.16.0-cp37-cp37m-win32.whl", hash = "sha256:9153ed35fc5e4fa3b2fe97bddaa7cbec0ed22412b85bcdaf54aeba92ea37428c"}, + {file = "wrapt-1.16.0-cp37-cp37m-win_amd64.whl", hash = "sha256:66dfbaa7cfa3eb707bbfcd46dab2bc6207b005cbc9caa2199bcbc81d95071a00"}, + {file = "wrapt-1.16.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1dd50a2696ff89f57bd8847647a1c363b687d3d796dc30d4dd4a9d1689a706f0"}, + {file = "wrapt-1.16.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:44a2754372e32ab315734c6c73b24351d06e77ffff6ae27d2ecf14cf3d229202"}, + {file = "wrapt-1.16.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8e9723528b9f787dc59168369e42ae1c3b0d3fadb2f1a71de14531d321ee05b0"}, + {file = "wrapt-1.16.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:dbed418ba5c3dce92619656802cc5355cb679e58d0d89b50f116e4a9d5a9603e"}, + {file = "wrapt-1.16.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:941988b89b4fd6b41c3f0bfb20e92bd23746579736b7343283297c4c8cbae68f"}, + {file = "wrapt-1.16.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:6a42cd0cfa8ffc1915aef79cb4284f6383d8a3e9dcca70c445dcfdd639d51267"}, + {file = "wrapt-1.16.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:1ca9b6085e4f866bd584fb135a041bfc32cab916e69f714a7d1d397f8c4891ca"}, + {file = "wrapt-1.16.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:d5e49454f19ef621089e204f862388d29e6e8d8b162efce05208913dde5b9ad6"}, + {file = "wrapt-1.16.0-cp38-cp38-win32.whl", hash = "sha256:c31f72b1b6624c9d863fc095da460802f43a7c6868c5dda140f51da24fd47d7b"}, + {file = "wrapt-1.16.0-cp38-cp38-win_amd64.whl", hash = "sha256:490b0ee15c1a55be9c1bd8609b8cecd60e325f0575fc98f50058eae366e01f41"}, + {file = "wrapt-1.16.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9b201ae332c3637a42f02d1045e1d0cccfdc41f1f2f801dafbaa7e9b4797bfc2"}, + {file = "wrapt-1.16.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:2076fad65c6736184e77d7d4729b63a6d1ae0b70da4868adeec40989858eb3fb"}, + {file = "wrapt-1.16.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c5cd603b575ebceca7da5a3a251e69561bec509e0b46e4993e1cac402b7247b8"}, + {file = "wrapt-1.16.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b47cfad9e9bbbed2339081f4e346c93ecd7ab504299403320bf85f7f85c7d46c"}, + {file = "wrapt-1.16.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f8212564d49c50eb4565e502814f694e240c55551a5f1bc841d4fcaabb0a9b8a"}, + {file = "wrapt-1.16.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:5f15814a33e42b04e3de432e573aa557f9f0f56458745c2074952f564c50e664"}, + {file = "wrapt-1.16.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:db2e408d983b0e61e238cf579c09ef7020560441906ca990fe8412153e3b291f"}, + {file = "wrapt-1.16.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:edfad1d29c73f9b863ebe7082ae9321374ccb10879eeabc84ba3b69f2579d537"}, + {file = "wrapt-1.16.0-cp39-cp39-win32.whl", hash = "sha256:ed867c42c268f876097248e05b6117a65bcd1e63b779e916fe2e33cd6fd0d3c3"}, + {file = "wrapt-1.16.0-cp39-cp39-win_amd64.whl", hash = "sha256:eb1b046be06b0fce7249f1d025cd359b4b80fc1c3e24ad9eca33e0dcdb2e4a35"}, + {file = "wrapt-1.16.0-py3-none-any.whl", hash = "sha256:6906c4100a8fcbf2fa735f6059214bb13b97f75b1a61777fcf6432121ef12ef1"}, + {file = "wrapt-1.16.0.tar.gz", hash = "sha256:5f370f952971e7d17c7d1ead40e49f32345a7f7a5373571ef44d800d06b1899d"}, +] + [[package]] name = "xlsxwriter" version = "3.1.0" @@ -2888,5 +3311,5 @@ docs = ["mkdocs", "mkdocs-material"] [metadata] lock-version = "2.0" -python-versions = "^3.9" -content-hash = "6ed432b0310655c247da3b4f542b9410842fb46de838408b99b6e61fb367cf38" +python-versions = ">=3.9,<3.12" +content-hash = "653c89aa68d9924b75c01a3dd894fdffc57fb899d46dcc23728e0543a3fc24e9" diff --git a/prowler/__main__.py b/prowler/__main__.py index 7cb07e3624..a6151dec98 100644 --- a/prowler/__main__.py +++ b/prowler/__main__.py @@ -26,6 +26,10 @@ from prowler.lib.check.check import ( ) from prowler.lib.check.checks_loader import load_checks_to_execute from prowler.lib.check.compliance import update_checks_metadata_with_compliance +from prowler.lib.check.custom_checks_metadata import ( + parse_custom_checks_metadata_file, + update_checks_metadata, +) from prowler.lib.cli.parser import ProwlerArgumentParser from prowler.lib.logger import logger, set_logging_config from prowler.lib.outputs.compliance import display_compliance_table @@ -47,6 +51,7 @@ from prowler.providers.common.audit_info import ( set_provider_audit_info, set_provider_execution_parameters, ) +from prowler.providers.common.clean import clean_provider_local_output_directories from prowler.providers.common.outputs import set_provider_output_options from prowler.providers.common.quick_inventory import run_provider_quick_inventory @@ -67,6 +72,7 @@ def prowler(): checks_folder = args.checks_folder severities = args.severity compliance_framework = args.compliance + custom_checks_metadata_file = args.custom_checks_metadata_file if not args.no_banner: print_banner(args) @@ -96,9 +102,19 @@ def prowler(): bulk_compliance_frameworks = bulk_load_compliance_frameworks(provider) # Complete checks metadata with the compliance framework specification - update_checks_metadata_with_compliance( + bulk_checks_metadata = update_checks_metadata_with_compliance( bulk_compliance_frameworks, bulk_checks_metadata ) + # Update checks metadata if the --custom-checks-metadata-file is present + custom_checks_metadata = None + if custom_checks_metadata_file: + custom_checks_metadata = parse_custom_checks_metadata_file( + provider, custom_checks_metadata_file + ) + bulk_checks_metadata = update_checks_metadata( + bulk_checks_metadata, custom_checks_metadata + ) + if args.list_compliance: print_compliance_frameworks(bulk_compliance_frameworks) sys.exit() @@ -174,7 +190,11 @@ def prowler(): findings = [] if len(checks_to_execute): findings = execute_checks( - checks_to_execute, provider, audit_info, audit_output_options + checks_to_execute, + provider, + audit_info, + audit_output_options, + custom_checks_metadata, ) else: logger.error( @@ -246,7 +266,10 @@ def prowler(): for region in security_hub_regions: # Save the regions where AWS Security Hub is enabled if verify_security_hub_integration_enabled_per_region( - region, audit_info.audit_session + audit_info.audited_partition, + region, + audit_info.audit_session, + audit_info.audited_account, ): aws_security_enabled_regions.append(region) @@ -301,6 +324,9 @@ def prowler(): if checks_folder: remove_custom_checks_module(checks_folder, provider) + # clean local directories + clean_provider_local_output_directories(args) + # If there are failed findings exit code 3, except if -z is input if not args.ignore_exit_code_3 and stats["total_fail"] > 0: sys.exit(3) diff --git a/prowler/config/config.py b/prowler/config/config.py index 2038761182..859907b186 100644 --- a/prowler/config/config.py +++ b/prowler/config/config.py @@ -11,7 +11,7 @@ from prowler.lib.logger import logger timestamp = datetime.today() timestamp_utc = datetime.now(timezone.utc).replace(tzinfo=timezone.utc) -prowler_version = "3.11.0" +prowler_version = "3.11.3" html_logo_url = "https://github.com/prowler-cloud/prowler/" html_logo_img = "https://user-images.githubusercontent.com/3985464/113734260-7ba06900-96fb-11eb-82bc-d4f68a1e2710.png" square_logo_img = "https://user-images.githubusercontent.com/38561120/235905862-9ece5bd7-9aa3-4e48-807a-3a9035eb8bfb.png" @@ -70,7 +70,9 @@ def check_current_version(): if latest_version != prowler_version: return f"{prowler_version_string} (latest is {latest_version}, upgrade for the latest features)" else: - return f"{prowler_version_string} (it is the latest version, yay!)" + return ( + f"{prowler_version_string} (You are running the latest version, yay!)" + ) except requests.RequestException: return f"{prowler_version_string}" except Exception: diff --git a/prowler/config/config.yaml b/prowler/config/config.yaml index 89568e777b..86a03b5a3b 100644 --- a/prowler/config/config.yaml +++ b/prowler/config/config.yaml @@ -2,7 +2,7 @@ aws: # AWS Global Configuration - # aws.allowlist_non_default_regions --> Set to True to allowlist failed findings in non-default regions for GuardDuty, SecurityHub, DRS and Config + # aws.allowlist_non_default_regions --> Set to True to allowlist failed findings in non-default regions for AccessAnalyzer, GuardDuty, SecurityHub, DRS and Config allowlist_non_default_regions: False # If you want to allowlist/mute failed findings only in specific regions, create a file with the following syntax and run it with `prowler aws -w allowlist.yaml`: # Allowlist: diff --git a/prowler/config/custom_checks_metadata_example.yaml b/prowler/config/custom_checks_metadata_example.yaml new file mode 100644 index 0000000000..ed11065333 --- /dev/null +++ b/prowler/config/custom_checks_metadata_example.yaml @@ -0,0 +1,15 @@ +CustomChecksMetadata: + aws: + Checks: + s3_bucket_level_public_access_block: + Severity: high + s3_bucket_no_mfa_delete: + Severity: high + azure: + Checks: + storage_infrastructure_encryption_is_enabled: + Severity: medium + gcp: + Checks: + compute_instance_public_ip: + Severity: critical diff --git a/prowler/lib/check/check.py b/prowler/lib/check/check.py index deabd70dc9..ce5e23cf9d 100644 --- a/prowler/lib/check/check.py +++ b/prowler/lib/check/check.py @@ -16,6 +16,7 @@ from colorama import Fore, Style import prowler from prowler.config.config import orange_color from prowler.lib.check.compliance_models import load_compliance_framework +from prowler.lib.check.custom_checks_metadata import update_check_metadata from prowler.lib.check.models import Check, load_check_metadata from prowler.lib.logger import logger from prowler.lib.outputs.outputs import report @@ -416,6 +417,7 @@ def execute_checks( provider: str, audit_info: Any, audit_output_options: Provider_Output_Options, + custom_checks_metadata: Any, ) -> list: # List to store all the check's findings all_findings = [] @@ -461,6 +463,7 @@ def execute_checks( audit_info, services_executed, checks_executed, + custom_checks_metadata, ) all_findings.extend(check_findings) @@ -506,6 +509,7 @@ def execute_checks( audit_info, services_executed, checks_executed, + custom_checks_metadata, ) all_findings.extend(check_findings) @@ -531,6 +535,7 @@ def execute( audit_info: Any, services_executed: set, checks_executed: set, + custom_checks_metadata: Any, ): # Import check module check_module_path = ( @@ -541,6 +546,10 @@ def execute( check_to_execute = getattr(lib, check_name) c = check_to_execute() + # Update check metadata to reflect that in the outputs + if custom_checks_metadata and custom_checks_metadata["Checks"].get(c.CheckID): + c = update_check_metadata(c, custom_checks_metadata["Checks"][c.CheckID]) + # Run check check_findings = run_check(c, audit_output_options) diff --git a/prowler/lib/check/checks_loader.py b/prowler/lib/check/checks_loader.py index 6a0a92db50..c82a601e1f 100644 --- a/prowler/lib/check/checks_loader.py +++ b/prowler/lib/check/checks_loader.py @@ -36,6 +36,10 @@ def load_checks_to_execute( # Check check's severity if bulk_checks_metadata[check].Severity in severities: checks_to_execute.add(check) + if service_list: + checks_to_execute = ( + recover_checks_from_service(service_list, provider) & checks_to_execute + ) # Handle if there are checks passed using -C/--checks-file elif checks_file: diff --git a/prowler/lib/check/custom_checks_metadata.py b/prowler/lib/check/custom_checks_metadata.py new file mode 100644 index 0000000000..87acb97ab5 --- /dev/null +++ b/prowler/lib/check/custom_checks_metadata.py @@ -0,0 +1,77 @@ +import sys + +import yaml +from jsonschema import validate + +from prowler.lib.logger import logger + +valid_severities = ["critical", "high", "medium", "low", "informational"] +custom_checks_metadata_schema = { + "type": "object", + "properties": { + "Checks": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "properties": { + "Severity": { + "type": "string", + "enum": valid_severities, + } + }, + "required": ["Severity"], + "additionalProperties": False, + } + }, + "additionalProperties": False, + } + }, + "required": ["Checks"], + "additionalProperties": False, +} + + +def parse_custom_checks_metadata_file(provider: str, parse_custom_checks_metadata_file): + """parse_custom_checks_metadata_file returns the custom_checks_metadata object if it is valid, otherwise aborts the execution returning the ValidationError.""" + try: + with open(parse_custom_checks_metadata_file) as f: + custom_checks_metadata = yaml.safe_load(f)["CustomChecksMetadata"][provider] + validate(custom_checks_metadata, schema=custom_checks_metadata_schema) + return custom_checks_metadata + except Exception as error: + logger.critical( + f"{error.__class__.__name__} -- {error}[{error.__traceback__.tb_lineno}]" + ) + sys.exit(1) + + +def update_checks_metadata(bulk_checks_metadata, custom_checks_metadata): + """update_checks_metadata returns the bulk_checks_metadata with the check's metadata updated based on the custom_checks_metadata provided.""" + try: + # Update checks metadata from CustomChecksMetadata file + for check, custom_metadata in custom_checks_metadata["Checks"].items(): + check_metadata = bulk_checks_metadata.get(check) + if check_metadata: + bulk_checks_metadata[check] = update_check_metadata( + check_metadata, custom_metadata + ) + return bulk_checks_metadata + except Exception as error: + logger.critical( + f"{error.__class__.__name__} -- {error}[{error.__traceback__.tb_lineno}]" + ) + sys.exit(1) + + +def update_check_metadata(check_metadata, custom_metadata): + """update_check_metadata updates the check_metadata fields present in the custom_metadata and returns the updated version of the check_metadata. If some field is not present or valid the check_metadata is returned with the original fields.""" + try: + if custom_metadata: + for attribute in custom_metadata: + try: + setattr(check_metadata, attribute, custom_metadata[attribute]) + except ValueError: + pass + finally: + return check_metadata diff --git a/prowler/lib/cli/parser.py b/prowler/lib/cli/parser.py index 28f1e59a53..8db0782174 100644 --- a/prowler/lib/cli/parser.py +++ b/prowler/lib/cli/parser.py @@ -49,6 +49,7 @@ Detailed documentation at https://docs.prowler.cloud self.__init_exclude_checks_parser__() self.__init_list_checks_parser__() self.__init_config_parser__() + self.__init_custom_checks_metadata_parser__() # Init Providers Arguments init_providers_parser(self) @@ -220,7 +221,7 @@ Detailed documentation at https://docs.prowler.cloud group.add_argument( "-s", "--services", nargs="+", help="List of services to be executed." ) - group.add_argument( + common_checks_parser.add_argument( "--severity", nargs="+", help="List of severities to be executed [informational, low, medium, high, critical]", @@ -286,3 +287,15 @@ Detailed documentation at https://docs.prowler.cloud default=default_config_file_path, help="Set configuration file path", ) + + def __init_custom_checks_metadata_parser__(self): + # CustomChecksMetadata + custom_checks_metadata_subparser = ( + self.common_providers_parser.add_argument_group("Custom Checks Metadata") + ) + custom_checks_metadata_subparser.add_argument( + "--custom-checks-metadata-file", + nargs="?", + default=None, + help="Path for the custom checks metadata YAML file. See example prowler/config/custom_checks_metadata_example.yaml for reference and format. See more in https://docs.prowler.cloud/en/latest/tutorials/custom-checks-metadata/", + ) diff --git a/prowler/lib/outputs/file_descriptors.py b/prowler/lib/outputs/file_descriptors.py index a2339e1257..9b5def4d22 100644 --- a/prowler/lib/outputs/file_descriptors.py +++ b/prowler/lib/outputs/file_descriptors.py @@ -12,8 +12,6 @@ from prowler.config.config import ( from prowler.lib.logger import logger from prowler.lib.outputs.html import add_html_header from prowler.lib.outputs.models import ( - Aws_Check_Output_CSV, - Azure_Check_Output_CSV, Check_Output_CSV_AWS_CIS, Check_Output_CSV_AWS_ISO27001_2013, Check_Output_CSV_AWS_Well_Architected, @@ -21,19 +19,18 @@ from prowler.lib.outputs.models import ( Check_Output_CSV_GCP_CIS, Check_Output_CSV_Generic_Compliance, Check_Output_MITRE_ATTACK, - Gcp_Check_Output_CSV, generate_csv_fields, ) from prowler.lib.utils.utils import file_exists, open_file from prowler.providers.aws.lib.audit_info.models import AWS_Audit_Info -from prowler.providers.azure.lib.audit_info.models import Azure_Audit_Info +from prowler.providers.common.outputs import get_provider_output_model from prowler.providers.gcp.lib.audit_info.models import GCP_Audit_Info def initialize_file_descriptor( filename: str, output_mode: str, - audit_info: AWS_Audit_Info, + audit_info: Any, format: Any = None, ) -> TextIOWrapper: """Open/Create the output file. If needed include headers or the required format""" @@ -75,27 +72,15 @@ def fill_file_descriptors(output_modes, output_directory, output_filename, audit for output_mode in output_modes: if output_mode == "csv": filename = f"{output_directory}/{output_filename}{csv_file_suffix}" - if isinstance(audit_info, AWS_Audit_Info): - file_descriptor = initialize_file_descriptor( - filename, - output_mode, - audit_info, - Aws_Check_Output_CSV, - ) - if isinstance(audit_info, Azure_Audit_Info): - file_descriptor = initialize_file_descriptor( - filename, - output_mode, - audit_info, - Azure_Check_Output_CSV, - ) - if isinstance(audit_info, GCP_Audit_Info): - file_descriptor = initialize_file_descriptor( - filename, - output_mode, - audit_info, - Gcp_Check_Output_CSV, - ) + output_model = get_provider_output_model( + audit_info.__class__.__name__ + ) + file_descriptor = initialize_file_descriptor( + filename, + output_mode, + audit_info, + output_model, + ) file_descriptors.update({output_mode: file_descriptor}) elif output_mode == "json": diff --git a/prowler/lib/outputs/html.py b/prowler/lib/outputs/html.py index 6e381bda52..820681b094 100644 --- a/prowler/lib/outputs/html.py +++ b/prowler/lib/outputs/html.py @@ -338,8 +338,9 @@ def add_html_footer(output_filename, output_directory): def get_aws_html_assessment_summary(audit_info): try: if isinstance(audit_info, AWS_Audit_Info): - if not audit_info.profile: - audit_info.profile = "ENV" + profile = ( + audit_info.profile if audit_info.profile is not None else "default" + ) if isinstance(audit_info.audited_regions, list): audited_regions = " ".join(audit_info.audited_regions) elif not audit_info.audited_regions: @@ -361,7 +362,7 @@ def get_aws_html_assessment_summary(audit_info):
  • AWS-CLI Profile: """ - + audit_info.profile + + profile + """
  • diff --git a/prowler/lib/outputs/json.py b/prowler/lib/outputs/json.py index f43360ff48..6f1403cf05 100644 --- a/prowler/lib/outputs/json.py +++ b/prowler/lib/outputs/json.py @@ -31,6 +31,7 @@ from prowler.lib.outputs.models import ( unroll_dict_to_list, ) from prowler.lib.utils.utils import hash_sha512, open_file, outputs_unix_timestamp +from prowler.providers.aws.lib.audit_info.models import AWS_Audit_Info def fill_json_asff(finding_output, audit_info, finding, output_options): @@ -155,6 +156,11 @@ def fill_json_ocsf(audit_info, finding, output_options) -> Check_Output_JSON_OCS aws_org_uid = "" account = None org = None + profile = "" + if isinstance(audit_info, AWS_Audit_Info): + profile = ( + audit_info.profile if audit_info.profile is not None else "default" + ) if ( hasattr(audit_info, "organizations_metadata") and audit_info.organizations_metadata @@ -249,9 +255,7 @@ def fill_json_ocsf(audit_info, finding, output_options) -> Check_Output_JSON_OCS original_time=outputs_unix_timestamp( output_options.unix_timestamp, timestamp ), - profiles=[audit_info.profile] - if hasattr(audit_info, "organizations_metadata") - else [], + profiles=[profile], ) compliance = Compliance_OCSF( status=generate_json_ocsf_status(finding.status), diff --git a/prowler/providers/aws/aws_regions_by_service.json b/prowler/providers/aws/aws_regions_by_service.json index 68abb57346..96b19504e2 100644 --- a/prowler/providers/aws/aws_regions_by_service.json +++ b/prowler/providers/aws/aws_regions_by_service.json @@ -498,17 +498,6 @@ ] } }, - "appfabric": { - "regions": { - "aws": [ - "ap-northeast-1", - "eu-west-1", - "us-east-1" - ], - "aws-cn": [], - "aws-us-gov": [] - } - }, "appflow": { "regions": { "aws": [ @@ -674,10 +663,13 @@ "regions": { "aws": [ "ap-northeast-1", + "ap-south-1", "ap-southeast-1", "ap-southeast-2", "eu-central-1", "eu-west-1", + "eu-west-2", + "eu-west-3", "us-east-1", "us-east-2", "us-west-2" @@ -805,7 +797,10 @@ "cn-north-1", "cn-northwest-1" ], - "aws-us-gov": [] + "aws-us-gov": [ + "us-gov-east-1", + "us-gov-west-1" + ] } }, "artifact": { @@ -1013,6 +1008,17 @@ ] } }, + "aws-appfabric": { + "regions": { + "aws": [ + "ap-northeast-1", + "eu-west-1", + "us-east-1" + ], + "aws-cn": [], + "aws-us-gov": [] + } + }, "awshealthdashboard": { "regions": { "aws": [ @@ -2068,17 +2074,24 @@ "ap-east-1", "ap-northeast-1", "ap-northeast-2", + "ap-northeast-3", "ap-south-1", + "ap-south-2", "ap-southeast-1", "ap-southeast-2", + "ap-southeast-3", + "ap-southeast-4", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", + "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", + "il-central-1", + "me-central-1", "me-south-1", "sa-east-1", "us-east-1", @@ -2299,15 +2312,22 @@ "ap-northeast-2", "ap-northeast-3", "ap-south-1", + "ap-south-2", "ap-southeast-1", "ap-southeast-2", + "ap-southeast-3", + "ap-southeast-4", "ca-central-1", "eu-central-1", + "eu-central-2", "eu-north-1", "eu-south-1", + "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", + "il-central-1", + "me-central-1", "me-south-1", "sa-east-1", "us-east-1", @@ -2467,6 +2487,7 @@ "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", + "ap-southeast-4", "ca-central-1", "eu-central-1", "eu-central-2", @@ -2941,6 +2962,7 @@ "cn-northwest-1" ], "aws-us-gov": [ + "us-gov-east-1", "us-gov-west-1" ] } @@ -3615,6 +3637,7 @@ "ap-south-1", "ap-southeast-1", "ap-southeast-2", + "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", @@ -3622,6 +3645,7 @@ "eu-west-1", "eu-west-2", "eu-west-3", + "me-central-1", "me-south-1", "sa-east-1", "us-east-1", @@ -3642,15 +3666,19 @@ "emr-serverless": { "regions": { "aws": [ + "af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", + "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", + "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", + "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", @@ -4336,16 +4364,6 @@ "aws-us-gov": [] } }, - "gamesparks": { - "regions": { - "aws": [ - "ap-northeast-1", - "us-east-1" - ], - "aws-cn": [], - "aws-us-gov": [] - } - }, "glacier": { "regions": { "aws": [ @@ -5605,6 +5623,44 @@ ] } }, + "launch-wizard": { + "regions": { + "aws": [ + "af-south-1", + "ap-east-1", + "ap-northeast-1", + "ap-northeast-2", + "ap-northeast-3", + "ap-south-1", + "ap-south-2", + "ap-southeast-1", + "ap-southeast-2", + "ap-southeast-3", + "ca-central-1", + "eu-central-1", + "eu-north-1", + "eu-south-1", + "eu-west-1", + "eu-west-2", + "eu-west-3", + "me-central-1", + "me-south-1", + "sa-east-1", + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2" + ], + "aws-cn": [ + "cn-north-1", + "cn-northwest-1" + ], + "aws-us-gov": [ + "us-gov-east-1", + "us-gov-west-1" + ] + } + }, "launchwizard": { "regions": { "aws": [ @@ -5718,6 +5774,7 @@ "eu-central-2", "eu-north-1", "eu-south-1", + "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", @@ -5801,6 +5858,7 @@ "eu-central-2", "eu-north-1", "eu-south-1", + "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", @@ -6062,6 +6120,15 @@ ] } }, + "managedblockchain-query": { + "regions": { + "aws": [ + "us-east-1" + ], + "aws-cn": [], + "aws-us-gov": [] + } + }, "managedservices": { "regions": { "aws": [ @@ -6388,11 +6455,18 @@ "aws": [ "af-south-1", "ap-northeast-1", + "ap-northeast-2", + "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", + "ap-southeast-4", + "ca-central-1", "eu-central-1", + "eu-north-1", "eu-west-1", + "eu-west-3", + "sa-east-1", "us-east-1", "us-east-2", "us-west-2" @@ -6703,6 +6777,7 @@ "eu-west-1", "eu-west-2", "eu-west-3", + "il-central-1", "me-central-1", "me-south-1", "sa-east-1", @@ -7079,8 +7154,11 @@ "regions": { "aws": [ "ap-northeast-1", + "ap-northeast-2", + "ap-south-1", "ap-southeast-1", "ap-southeast-2", + "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", @@ -7152,6 +7230,41 @@ "aws-us-gov": [] } }, + "pca-connector-ad": { + "regions": { + "aws": [ + "af-south-1", + "ap-east-1", + "ap-northeast-1", + "ap-northeast-2", + "ap-northeast-3", + "ap-south-1", + "ap-south-2", + "ap-southeast-1", + "ap-southeast-2", + "ap-southeast-3", + "ap-southeast-4", + "ca-central-1", + "eu-central-1", + "eu-central-2", + "eu-north-1", + "eu-south-1", + "eu-south-2", + "eu-west-1", + "eu-west-2", + "eu-west-3", + "me-central-1", + "me-south-1", + "sa-east-1", + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2" + ], + "aws-cn": [], + "aws-us-gov": [] + } + }, "personalize": { "regions": { "aws": [ @@ -8801,6 +8914,7 @@ "eu-west-1", "eu-west-2", "eu-west-3", + "il-central-1", "me-central-1", "me-south-1", "sa-east-1", @@ -9928,6 +10042,7 @@ "ap-northeast-2", "ap-northeast-3", "ap-south-1", + "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-4", @@ -10344,6 +10459,7 @@ "eu-central-1", "eu-west-1", "eu-west-2", + "il-central-1", "sa-east-1", "us-east-1", "us-west-2" diff --git a/prowler/providers/aws/lib/allowlist/allowlist.py b/prowler/providers/aws/lib/allowlist/allowlist.py index b63340f70e..6789ff9e92 100644 --- a/prowler/providers/aws/lib/allowlist/allowlist.py +++ b/prowler/providers/aws/lib/allowlist/allowlist.py @@ -135,7 +135,12 @@ def allowlist_findings( def is_allowlisted( - allowlist: dict, audited_account: str, check: str, region: str, resource: str, tags + allowlist: dict, + audited_account: str, + check: str, + finding_region: str, + finding_resource: str, + finding_tags, ): try: allowlisted_checks = {} @@ -150,15 +155,15 @@ def is_allowlisted( if "*" in allowlist["Accounts"]: checks_multi_account = allowlist["Accounts"]["*"]["Checks"] allowlisted_checks.update(checks_multi_account) + # Test if it is allowlisted if is_allowlisted_in_check( allowlisted_checks, audited_account, - audited_account, check, - region, - resource, - tags, + finding_region, + finding_resource, + finding_tags, ): is_finding_allowlisted = True @@ -171,23 +176,29 @@ def is_allowlisted( def is_allowlisted_in_check( - allowlisted_checks, audited_account, account, check, region, resource, tags + allowlisted_checks, + audited_account, + check, + finding_region, + finding_resource, + finding_tags, ): try: # Default value is not allowlisted is_check_allowlisted = False + for allowlisted_check, allowlisted_check_info in allowlisted_checks.items(): # map lambda to awslambda allowlisted_check = re.sub("^lambda", "awslambda", allowlisted_check) - # extract the exceptions + + # Check if the finding is excepted exceptions = allowlisted_check_info.get("Exceptions") - # Check if there are exceptions if is_excepted( exceptions, audited_account, - region, - resource, - tags, + finding_region, + finding_resource, + finding_tags, ): # Break loop and return default value since is excepted break @@ -201,13 +212,27 @@ def is_allowlisted_in_check( or check == allowlisted_check or re.search(allowlisted_check, check) ): - if is_allowlisted_in_region( - allowlisted_regions, - allowlisted_resources, - allowlisted_tags, - region, - resource, - tags, + allowlisted_in_check = True + allowlisted_in_region = is_allowlisted_in_region( + allowlisted_regions, finding_region + ) + allowlisted_in_resource = is_allowlisted_in_resource( + allowlisted_resources, finding_resource + ) + allowlisted_in_tags = is_allowlisted_in_tags( + allowlisted_tags, finding_tags + ) + + # For a finding to be allowlisted requires the following set to True: + # - allowlisted_in_check -> True + # - allowlisted_in_region -> True + # - allowlisted_in_tags -> True or allowlisted_in_resource -> True + # - excepted -> False + + if ( + allowlisted_in_check + and allowlisted_in_region + and (allowlisted_in_tags or allowlisted_in_resource) ): is_check_allowlisted = True @@ -220,25 +245,11 @@ def is_allowlisted_in_check( def is_allowlisted_in_region( - allowlist_regions, allowlist_resources, allowlisted_tags, region, resource, tags + allowlisted_regions, + finding_region, ): try: - # By default is not allowlisted - is_region_allowlisted = False - # If there is a *, it affects to all regions - if "*" in allowlist_regions or region in allowlist_regions: - for elem in allowlist_resources: - if is_allowlisted_in_tags( - allowlisted_tags, - elem, - resource, - tags, - ): - is_region_allowlisted = True - # if we find the element there is no point in continuing with the loop - break - - return is_region_allowlisted + return __is_item_matched__(allowlisted_regions, finding_region) except Exception as error: logger.critical( f"{error.__class__.__name__} -- {error}[{error.__traceback__.tb_lineno}]" @@ -246,25 +257,9 @@ def is_allowlisted_in_region( sys.exit(1) -def is_allowlisted_in_tags(allowlisted_tags, elem, resource, tags): +def is_allowlisted_in_tags(allowlisted_tags, finding_tags): try: - # By default is not allowlisted - is_tag_allowlisted = False - # Check if it is an * - if elem == "*": - elem = ".*" - # Check if there are allowlisted tags - if allowlisted_tags: - for allowlisted_tag in allowlisted_tags: - if re.search(allowlisted_tag, tags): - is_tag_allowlisted = True - break - - else: - if re.search(elem, resource): - is_tag_allowlisted = True - - return is_tag_allowlisted + return __is_item_matched__(allowlisted_tags, finding_tags) except Exception as error: logger.critical( f"{error.__class__.__name__} -- {error}[{error.__traceback__.tb_lineno}]" @@ -272,7 +267,25 @@ def is_allowlisted_in_tags(allowlisted_tags, elem, resource, tags): sys.exit(1) -def is_excepted(exceptions, audited_account, region, resource, tags): +def is_allowlisted_in_resource(allowlisted_resources, finding_resource): + try: + return __is_item_matched__(allowlisted_resources, finding_resource) + + except Exception as error: + logger.critical( + f"{error.__class__.__name__} -- {error}[{error.__traceback__.tb_lineno}]" + ) + sys.exit(1) + + +def is_excepted( + exceptions, + audited_account, + finding_region, + finding_resource, + finding_tags, +): + """is_excepted returns True if the account, region, resource and tags are excepted""" try: excepted = False is_account_excepted = False @@ -281,39 +294,50 @@ def is_excepted(exceptions, audited_account, region, resource, tags): is_tag_excepted = False if exceptions: excepted_accounts = exceptions.get("Accounts", []) + is_account_excepted = __is_item_matched__( + excepted_accounts, audited_account + ) + excepted_regions = exceptions.get("Regions", []) + is_region_excepted = __is_item_matched__(excepted_regions, finding_region) + excepted_resources = exceptions.get("Resources", []) + is_resource_excepted = __is_item_matched__( + excepted_resources, finding_resource + ) + excepted_tags = exceptions.get("Tags", []) - if exceptions: - if audited_account in excepted_accounts: - is_account_excepted = True - if region in excepted_regions: - is_region_excepted = True - for excepted_resource in excepted_resources: - if re.search(excepted_resource, resource): - is_resource_excepted = True - for tag in excepted_tags: - if tag in tags: - is_tag_excepted = True - if ( - ( - (excepted_accounts and is_account_excepted) - or not excepted_accounts - ) - and ( - (excepted_regions and is_region_excepted) - or not excepted_regions - ) - and ( - (excepted_resources and is_resource_excepted) - or not excepted_resources - ) - and ((excepted_tags and is_tag_excepted) or not excepted_tags) - ): - excepted = True + is_tag_excepted = __is_item_matched__(excepted_tags, finding_tags) + + if ( + is_account_excepted + and is_region_excepted + and is_resource_excepted + and is_tag_excepted + ): + excepted = True return excepted except Exception as error: logger.critical( f"{error.__class__.__name__} -- {error}[{error.__traceback__.tb_lineno}]" ) sys.exit(1) + + +def __is_item_matched__(matched_items, finding_items): + """__is_item_matched__ return True if any of the matched_items are present in the finding_items, otherwise returns False.""" + try: + is_item_matched = False + if matched_items and (finding_items or finding_items == ""): + for item in matched_items: + if item == "*": + item = ".*" + if re.search(item, finding_items): + is_item_matched = True + break + return is_item_matched + except Exception as error: + logger.critical( + f"{error.__class__.__name__} -- {error}[{error.__traceback__.tb_lineno}]" + ) + sys.exit(1) diff --git a/prowler/providers/aws/lib/arguments/arguments.py b/prowler/providers/aws/lib/arguments/arguments.py index 9ffe46a2fb..96fab145db 100644 --- a/prowler/providers/aws/lib/arguments/arguments.py +++ b/prowler/providers/aws/lib/arguments/arguments.py @@ -126,6 +126,7 @@ def init_parser(self): default=None, help="Path for allowlist yaml file. See example prowler/config/aws_allowlist.yaml for reference and format. It also accepts AWS DynamoDB Table or Lambda ARNs or S3 URIs, see more in https://docs.prowler.cloud/en/latest/tutorials/allowlist/", ) + # Based Scans aws_based_scans_subparser = aws_parser.add_argument_group("AWS Based Scans") aws_based_scans_parser = aws_based_scans_subparser.add_mutually_exclusive_group() diff --git a/prowler/providers/aws/lib/policy_condition_parser/policy_condition_parser.py b/prowler/providers/aws/lib/policy_condition_parser/policy_condition_parser.py index 99a404069f..020aedc505 100644 --- a/prowler/providers/aws/lib/policy_condition_parser/policy_condition_parser.py +++ b/prowler/providers/aws/lib/policy_condition_parser/policy_condition_parser.py @@ -56,12 +56,15 @@ def is_account_only_allowed_in_condition( ): # if there is an arn/account without the source account -> we do not consider it safe # here by default we assume is true and look for false entries - is_condition_valid = True + is_condition_key_restrictive = True for item in condition_statement[condition_operator][value]: if source_account not in item: - is_condition_valid = False + is_condition_key_restrictive = False break + if is_condition_key_restrictive: + is_condition_valid = True + # value is a string elif isinstance( condition_statement[condition_operator][value], diff --git a/prowler/providers/aws/lib/security_hub/security_hub.py b/prowler/providers/aws/lib/security_hub/security_hub.py index 4b1553127e..c8aa716843 100644 --- a/prowler/providers/aws/lib/security_hub/security_hub.py +++ b/prowler/providers/aws/lib/security_hub/security_hub.py @@ -14,9 +14,11 @@ def prepare_security_hub_findings( findings: [], audit_info: AWS_Audit_Info, output_options, enabled_regions: [] ) -> dict: security_hub_findings_per_region = {} - # Create a key per region - for region in audit_info.audited_regions: + + # Create a key per audited region + for region in enabled_regions: security_hub_findings_per_region[region] = [] + for finding in findings: # We don't send the INFO findings to AWS Security Hub if finding.status == "INFO": @@ -47,8 +49,10 @@ def prepare_security_hub_findings( def verify_security_hub_integration_enabled_per_region( + partition: str, region: str, session: session.Session, + aws_account_number: str, ) -> bool: f"""verify_security_hub_integration_enabled returns True if the {SECURITY_HUB_INTEGRATION_NAME} is enabled for the given region. Otherwise returns false.""" prowler_integration_enabled = False @@ -62,7 +66,8 @@ def verify_security_hub_integration_enabled_per_region( security_hub_client.describe_hub() # Check if Prowler integration is enabled in Security Hub - if "prowler/prowler" not in str( + security_hub_prowler_integration_arn = f"arn:{partition}:securityhub:{region}:{aws_account_number}:product-subscription/{SECURITY_HUB_INTEGRATION_NAME}" + if security_hub_prowler_integration_arn not in str( security_hub_client.list_enabled_products_for_import() ): logger.error( diff --git a/prowler/providers/aws/services/accessanalyzer/accessanalyzer_enabled/accessanalyzer_enabled.py b/prowler/providers/aws/services/accessanalyzer/accessanalyzer_enabled/accessanalyzer_enabled.py index 608cfe1889..2b51630b13 100644 --- a/prowler/providers/aws/services/accessanalyzer/accessanalyzer_enabled/accessanalyzer_enabled.py +++ b/prowler/providers/aws/services/accessanalyzer/accessanalyzer_enabled/accessanalyzer_enabled.py @@ -19,17 +19,23 @@ class accessanalyzer_enabled(Check): f"IAM Access Analyzer {analyzer.name} is enabled." ) - elif analyzer.status == "NOT_AVAILABLE": - report.status = "FAIL" - report.status_extended = ( - f"IAM Access Analyzer in account {analyzer.name} is not enabled." - ) - else: - report.status = "FAIL" - report.status_extended = ( - f"IAM Access Analyzer {analyzer.name} is not active." - ) + if analyzer.status == "NOT_AVAILABLE": + report.status = "FAIL" + report.status_extended = f"IAM Access Analyzer in account {analyzer.name} is not enabled." + + else: + report.status = "FAIL" + report.status_extended = ( + f"IAM Access Analyzer {analyzer.name} is not active." + ) + if ( + accessanalyzer_client.audit_config.get( + "allowlist_non_default_regions", False + ) + and not analyzer.region == accessanalyzer_client.region + ): + report.status = "WARNING" findings.append(report) diff --git a/prowler/providers/aws/services/codeartifact/codeartifact_packages_external_public_publishing_disabled/codeartifact_packages_external_public_publishing_disabled.py b/prowler/providers/aws/services/codeartifact/codeartifact_packages_external_public_publishing_disabled/codeartifact_packages_external_public_publishing_disabled.py index aa7f3d6b27..db5d85dece 100644 --- a/prowler/providers/aws/services/codeartifact/codeartifact_packages_external_public_publishing_disabled/codeartifact_packages_external_public_publishing_disabled.py +++ b/prowler/providers/aws/services/codeartifact/codeartifact_packages_external_public_publishing_disabled/codeartifact_packages_external_public_publishing_disabled.py @@ -16,7 +16,7 @@ class codeartifact_packages_external_public_publishing_disabled(Check): report = Check_Report_AWS(self.metadata()) report.region = repository.region report.resource_id = package.name - report.resource_arn = repository.arn + report.resource_arn = f"{repository.arn}/{package.namespace + ':' if package.namespace else ''}{package.name}" report.resource_tags = repository.tags if package.latest_version.origin.origin_type in ( diff --git a/prowler/providers/aws/services/codeartifact/codeartifact_service.py b/prowler/providers/aws/services/codeartifact/codeartifact_service.py index 8581e3f10c..d0d6a65701 100644 --- a/prowler/providers/aws/services/codeartifact/codeartifact_service.py +++ b/prowler/providers/aws/services/codeartifact/codeartifact_service.py @@ -63,7 +63,7 @@ class CodeArtifact(AWSService): list_packages_parameters = { "domain": self.repositories[repository].domain_name, "domainOwner": self.repositories[repository].domain_owner, - "repository": repository, + "repository": self.repositories[repository].name, } packages = [] for page in list_packages_paginator.paginate( @@ -83,18 +83,37 @@ class CodeArtifact(AWSService): ] ) # Get Latest Package Version - latest_version_information = ( - regional_client.list_package_versions( - domain=self.repositories[repository].domain_name, - domainOwner=self.repositories[ - repository - ].domain_owner, - repository=repository, - format=package_format, - package=package_name, - sortBy="PUBLISHED_TIME", + if package_namespace: + latest_version_information = ( + regional_client.list_package_versions( + domain=self.repositories[ + repository + ].domain_name, + domainOwner=self.repositories[ + repository + ].domain_owner, + repository=self.repositories[repository].name, + format=package_format, + namespace=package_namespace, + package=package_name, + sortBy="PUBLISHED_TIME", + ) + ) + else: + latest_version_information = ( + regional_client.list_package_versions( + domain=self.repositories[ + repository + ].domain_name, + domainOwner=self.repositories[ + repository + ].domain_owner, + repository=self.repositories[repository].name, + format=package_format, + package=package_name, + sortBy="PUBLISHED_TIME", + ) ) - ) latest_version = "" latest_origin_type = "UNKNOWN" latest_status = "Published" diff --git a/prowler/providers/aws/services/ec2/ec2_securitygroup_not_used/ec2_securitygroup_not_used.py b/prowler/providers/aws/services/ec2/ec2_securitygroup_not_used/ec2_securitygroup_not_used.py index d7d9daa810..8a232b33be 100644 --- a/prowler/providers/aws/services/ec2/ec2_securitygroup_not_used/ec2_securitygroup_not_used.py +++ b/prowler/providers/aws/services/ec2/ec2_securitygroup_not_used/ec2_securitygroup_not_used.py @@ -18,10 +18,18 @@ class ec2_securitygroup_not_used(Check): report.status = "PASS" report.status_extended = f"Security group {security_group.name} ({security_group.id}) it is being used." sg_in_lambda = False + sg_associated = False for function in awslambda_client.functions.values(): if security_group.id in function.security_groups: sg_in_lambda = True - if len(security_group.network_interfaces) == 0 and not sg_in_lambda: + for sg in ec2_client.security_groups: + if security_group.id in sg.associated_sgs: + sg_associated = True + if ( + len(security_group.network_interfaces) == 0 + and not sg_in_lambda + and not sg_associated + ): report.status = "FAIL" report.status_extended = f"Security group {security_group.name} ({security_group.id}) it is not being used." diff --git a/prowler/providers/aws/services/ec2/ec2_service.py b/prowler/providers/aws/services/ec2/ec2_service.py index b57a90a7d6..4838f04115 100644 --- a/prowler/providers/aws/services/ec2/ec2_service.py +++ b/prowler/providers/aws/services/ec2/ec2_service.py @@ -117,6 +117,7 @@ class EC2(AWSService): if not self.audit_resources or ( is_resource_filtered(arn, self.audit_resources) ): + associated_sgs = [] # check if sg has public access to all ports all_public_ports = False for ingress_rule in sg["IpPermissions"]: @@ -128,7 +129,10 @@ class EC2(AWSService): in self.audited_checks ): all_public_ports = True - break + # check associated security groups + for sg_group in ingress_rule.get("UserIdGroupPairs", []): + if sg_group.get("GroupId"): + associated_sgs.append(sg_group["GroupId"]) self.security_groups.append( SecurityGroup( name=sg["GroupName"], @@ -138,6 +142,7 @@ class EC2(AWSService): ingress_rules=sg["IpPermissions"], egress_rules=sg["IpPermissionsEgress"], public_ports=all_public_ports, + associated_sgs=associated_sgs, vpc_id=sg["VpcId"], tags=sg.get("Tags"), ) @@ -464,6 +469,7 @@ class SecurityGroup(BaseModel): id: str vpc_id: str public_ports: bool + associated_sgs: list network_interfaces: list[str] = [] ingress_rules: list[dict] egress_rules: list[dict] diff --git a/prowler/providers/aws/services/guardduty/guardduty_centrally_managed/guardduty_centrally_managed.py b/prowler/providers/aws/services/guardduty/guardduty_centrally_managed/guardduty_centrally_managed.py index eb9666fd73..fb6aa64c26 100644 --- a/prowler/providers/aws/services/guardduty/guardduty_centrally_managed/guardduty_centrally_managed.py +++ b/prowler/providers/aws/services/guardduty/guardduty_centrally_managed/guardduty_centrally_managed.py @@ -6,7 +6,7 @@ class guardduty_centrally_managed(Check): def execute(self): findings = [] for detector in guardduty_client.detectors: - if detector.id: + if detector.id and detector.enabled_in_account: report = Check_Report_AWS(self.metadata()) report.region = detector.region report.resource_id = detector.id diff --git a/prowler/providers/aws/services/guardduty/guardduty_no_high_severity_findings/guardduty_no_high_severity_findings.py b/prowler/providers/aws/services/guardduty/guardduty_no_high_severity_findings/guardduty_no_high_severity_findings.py index d4ae724299..ad38fd96e6 100644 --- a/prowler/providers/aws/services/guardduty/guardduty_no_high_severity_findings/guardduty_no_high_severity_findings.py +++ b/prowler/providers/aws/services/guardduty/guardduty_no_high_severity_findings/guardduty_no_high_severity_findings.py @@ -6,7 +6,7 @@ class guardduty_no_high_severity_findings(Check): def execute(self): findings = [] for detector in guardduty_client.detectors: - if detector.id: + if detector.id and detector.enabled_in_account: report = Check_Report_AWS(self.metadata()) report.region = detector.region report.resource_id = detector.id diff --git a/prowler/providers/aws/services/iam/iam_service.py b/prowler/providers/aws/services/iam/iam_service.py index 7bb79988f5..ca31b14ac5 100644 --- a/prowler/providers/aws/services/iam/iam_service.py +++ b/prowler/providers/aws/services/iam/iam_service.py @@ -139,7 +139,10 @@ class IAM(AWSService): logger.warning( f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) - + else: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) except Exception as error: logger.error( f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" @@ -208,14 +211,24 @@ class IAM(AWSService): reuse_prevention=reuse_prevention, hard_expiry=hard_expiry, ) - except Exception as error: - if "NoSuchEntity" in str(error): + + except ClientError as error: + if error.response["Error"]["Code"] == "NoSuchEntity": # Password policy does not exist stored_password_policy = None + logger.warning( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) else: logger.error( f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) + + except Exception as error: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + finally: return stored_password_policy @@ -268,17 +281,22 @@ class IAM(AWSService): logger.info("IAM - List Attached Group Policies...") try: for group in self.groups: - list_attached_group_policies_paginator = self.client.get_paginator( - "list_attached_group_policies" - ) - attached_group_policies = [] - for page in list_attached_group_policies_paginator.paginate( - GroupName=group.name - ): - for attached_group_policy in page["AttachedPolicies"]: - attached_group_policies.append(attached_group_policy) + try: + list_attached_group_policies_paginator = self.client.get_paginator( + "list_attached_group_policies" + ) + attached_group_policies = [] + for page in list_attached_group_policies_paginator.paginate( + GroupName=group.name + ): + for attached_group_policy in page["AttachedPolicies"]: + attached_group_policies.append(attached_group_policy) - group.attached_policies = attached_group_policies + group.attached_policies = attached_group_policies + except Exception as error: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) except Exception as error: logger.error( f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" @@ -337,18 +355,33 @@ class IAM(AWSService): logger.info("IAM - List Attached User Policies...") try: for user in self.users: - attached_user_policies = [] - get_user_attached_policies_paginator = self.client.get_paginator( - "list_attached_user_policies" - ) - for page in get_user_attached_policies_paginator.paginate( - UserName=user.name - ): - for policy in page["AttachedPolicies"]: - attached_user_policies.append(policy) + try: + attached_user_policies = [] + get_user_attached_policies_paginator = self.client.get_paginator( + "list_attached_user_policies" + ) + for page in get_user_attached_policies_paginator.paginate( + UserName=user.name + ): + for policy in page["AttachedPolicies"]: + attached_user_policies.append(policy) - user.attached_policies = attached_user_policies + user.attached_policies = attached_user_policies + except ClientError as error: + if error.response["Error"]["Code"] == "NoSuchEntity": + logger.warning( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + else: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + + except Exception as error: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) except Exception as error: logger.error( f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" @@ -371,10 +404,19 @@ class IAM(AWSService): role.attached_policies = attached_role_policies except ClientError as error: - if error.response["Error"]["Code"] == "NoSuchEntityException": + if error.response["Error"]["Code"] == "NoSuchEntity": logger.warning( f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) + else: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + + except Exception as error: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) except Exception as error: logger.error( @@ -639,8 +681,16 @@ class IAM(AWSService): response = self.client.list_role_tags(RoleName=role.name)["Tags"] role.tags = response except ClientError as error: - if error.response["Error"]["Code"] == "NoSuchEntityException": + if error.response["Error"]["Code"] == "NoSuchEntity": role.tags = [] + else: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + except Exception as error: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) except Exception as error: logger.error( @@ -653,8 +703,12 @@ class IAM(AWSService): response = self.client.list_user_tags(UserName=user.name)["Tags"] user.tags = response except ClientError as error: - if error.response["Error"]["Code"] == "NoSuchEntityException": + if error.response["Error"]["Code"] == "NoSuchEntity": user.tags = [] + else: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) except Exception as error: logger.error( @@ -664,13 +718,22 @@ class IAM(AWSService): try: for policy in self.policies: try: - response = self.client.list_policy_tags(PolicyArn=policy.arn)[ - "Tags" - ] - policy.tags = response + if policy.type != "Inline": + response = self.client.list_policy_tags(PolicyArn=policy.arn)[ + "Tags" + ] + policy.tags = response except ClientError as error: - if error.response["Error"]["Code"] == "NoSuchEntityException": + if error.response["Error"]["Code"] == "NoSuchEntity": policy.tags = [] + else: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + except Exception as error: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) except Exception as error: logger.error( @@ -697,9 +760,19 @@ class IAM(AWSService): ] except ClientError as error: + if error.response["Error"]["Code"] == "NoSuchEntity": + logger.warning( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + else: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + except Exception as error: logger.error( f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) + except Exception as error: logger.error( f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" @@ -717,6 +790,15 @@ class IAM(AWSService): "AccessKeyMetadata" ] except ClientError as error: + if error.response["Error"]["Code"] == "NoSuchEntity": + logger.warning( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + else: + logger.error( + f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + except Exception as error: logger.error( f"{self.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) diff --git a/prowler/providers/aws/services/rds/rds_instance_deprecated_engine_version/rds_instance_deprecated_engine_version.py b/prowler/providers/aws/services/rds/rds_instance_deprecated_engine_version/rds_instance_deprecated_engine_version.py index c2e32ef112..6bf0ea1b42 100644 --- a/prowler/providers/aws/services/rds/rds_instance_deprecated_engine_version/rds_instance_deprecated_engine_version.py +++ b/prowler/providers/aws/services/rds/rds_instance_deprecated_engine_version/rds_instance_deprecated_engine_version.py @@ -13,9 +13,14 @@ class rds_instance_deprecated_engine_version(Check): report.resource_arn = db_instance.arn report.resource_tags = db_instance.tags report.status_extended = f"RDS instance {db_instance.id} is using a deprecated engine {db_instance.engine} with version {db_instance.engine_version}." - if ( - db_instance.engine_version + hasattr( + rds_client.db_engines.get(db_instance.region, {}).get( + db_instance.engine, {} + ), + "engine_versions", + ) + and db_instance.engine_version in rds_client.db_engines[db_instance.region][ db_instance.engine ].engine_versions diff --git a/prowler/providers/aws/services/sqs/sqs_service.py b/prowler/providers/aws/services/sqs/sqs_service.py index b04c666a0e..bdc3e6a92d 100644 --- a/prowler/providers/aws/services/sqs/sqs_service.py +++ b/prowler/providers/aws/services/sqs/sqs_service.py @@ -16,23 +16,30 @@ class SQS(AWSService): super().__init__(__class__.__name__, audit_info) self.queues = [] self.__threading_call__(self.__list_queues__) - self.__get_queue_attributes__(self.regional_clients) + self.__get_queue_attributes__() self.__list_queue_tags__() def __list_queues__(self, regional_client): logger.info("SQS - describing queues...") try: list_queues_paginator = regional_client.get_paginator("list_queues") - for page in list_queues_paginator.paginate(): + # The SQS API uses nonstandard pagination + # you must specify a PageSize if there are more than 1000 queues + for page in list_queues_paginator.paginate( + PaginationConfig={"PageSize": 1000} + ): if "QueueUrls" in page: for queue in page["QueueUrls"]: - arn = f"arn:{self.audited_partition}:sqs:{regional_client.region}:{self.audited_account}:{queue}" + # the queue name is the last path segment of the url + queue_name = queue.split("/")[-1] + arn = f"arn:{self.audited_partition}:sqs:{regional_client.region}:{self.audited_account}:{queue_name}" if not self.audit_resources or ( is_resource_filtered(arn, self.audit_resources) ): self.queues.append( Queue( arn=arn, + name=queue_name, id=queue, region=regional_client.region, ) @@ -42,28 +49,46 @@ class SQS(AWSService): f"{regional_client.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) - def __get_queue_attributes__(self, regional_clients): + def __get_queue_attributes__(self): try: logger.info("SQS - describing queue attributes...") for queue in self.queues: - regional_client = regional_clients[queue.region] - queue_attributes = regional_client.get_queue_attributes( - QueueUrl=queue.id, AttributeNames=["All"] - ) - if "Attributes" in queue_attributes: - if "Policy" in queue_attributes["Attributes"]: - queue.policy = loads(queue_attributes["Attributes"]["Policy"]) - if "KmsMasterKeyId" in queue_attributes["Attributes"]: - queue.kms_key_id = queue_attributes["Attributes"][ - "KmsMasterKeyId" - ] - if "SqsManagedSseEnabled" in queue_attributes["Attributes"]: - if ( - queue_attributes["Attributes"]["SqsManagedSseEnabled"] - == "true" - ): - queue.kms_key_id = "SqsManagedSseEnabled" - + try: + regional_client = self.regional_clients[queue.region] + queue_attributes = regional_client.get_queue_attributes( + QueueUrl=queue.id, AttributeNames=["All"] + ) + if "Attributes" in queue_attributes: + if "Policy" in queue_attributes["Attributes"]: + queue.policy = loads( + queue_attributes["Attributes"]["Policy"] + ) + if "KmsMasterKeyId" in queue_attributes["Attributes"]: + queue.kms_key_id = queue_attributes["Attributes"][ + "KmsMasterKeyId" + ] + if "SqsManagedSseEnabled" in queue_attributes["Attributes"]: + if ( + queue_attributes["Attributes"]["SqsManagedSseEnabled"] + == "true" + ): + queue.kms_key_id = "SqsManagedSseEnabled" + except ClientError as error: + if ( + error.response["Error"]["Code"] + == "AWS.SimpleQueueService.NonExistentQueue" + ): + logger.warning( + f"{regional_client.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + else: + logger.error( + f"{regional_client.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + except Exception as error: + logger.error( + f"{regional_client.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) except Exception as error: logger.error( f"{regional_client.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" @@ -87,6 +112,14 @@ class SQS(AWSService): logger.warning( f"{regional_client.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) + else: + logger.error( + f"{regional_client.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + except Exception as error: + logger.error( + f"{regional_client.region} -- {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) except Exception as error: logger.error( @@ -96,6 +129,7 @@ class SQS(AWSService): class Queue(BaseModel): id: str + name: str arn: str region: str policy: dict = None diff --git a/prowler/providers/azure/azure_provider.py b/prowler/providers/azure/azure_provider.py index 2f054ec99e..52f5459a50 100644 --- a/prowler/providers/azure/azure_provider.py +++ b/prowler/providers/azure/azure_provider.py @@ -7,6 +7,7 @@ from msgraph.core import GraphClient from prowler.lib.logger import logger from prowler.providers.azure.lib.audit_info.models import Azure_Identity_Info +from prowler.providers.azure.lib.regions.regions import get_regions_config class Azure_Provider: @@ -18,12 +19,14 @@ class Azure_Provider: managed_entity_auth: bool, subscription_ids: list, tenant_id: str, + region: str, ): logger.info("Instantiating Azure Provider ...") - self.credentials = self.__set_credentials__( + self.region_config = self.__get_region_config__(region) + self.credentials = self.__get_credentials__( az_cli_auth, sp_env_auth, browser_auth, managed_entity_auth, tenant_id ) - self.identity = self.__set_identity_info__( + self.identity = self.__get_identity_info__( self.credentials, az_cli_auth, sp_env_auth, @@ -32,7 +35,10 @@ class Azure_Provider: subscription_ids, ) - def __set_credentials__( + def __get_region_config__(self, region): + return get_regions_config(region) + + def __get_credentials__( self, az_cli_auth, sp_env_auth, browser_auth, managed_entity_auth, tenant_id ): # Browser auth creds cannot be set with DefaultAzureCredentials() @@ -52,6 +58,8 @@ class Azure_Provider: exclude_shared_token_cache_credential=True, # Azure Auth using PowerShell is not supported exclude_powershell_credential=True, + # set Authority of a Microsoft Entra endpoint + authority=self.region_config["authority"], ) except Exception as error: logger.critical("Failed to retrieve azure credentials") @@ -61,7 +69,6 @@ class Azure_Provider: sys.exit(1) else: try: - print(tenant_id) credentials = InteractiveBrowserCredential(tenant_id=tenant_id) except Exception as error: logger.critical("Failed to retrieve azure credentials") @@ -83,7 +90,7 @@ class Azure_Provider: ) sys.exit(1) - def __set_identity_info__( + def __get_identity_info__( self, credentials, az_cli_auth, @@ -153,7 +160,11 @@ class Azure_Provider: logger.info( "Trying to subscriptions and tenant ids to populate identity structure ..." ) - subscriptions_client = SubscriptionClient(credential=credentials) + subscriptions_client = SubscriptionClient( + credential=credentials, + base_url=self.region_config["base_url"], + credential_scopes=self.region_config["credential_scopes"], + ) if not subscription_ids: logger.info("Scanning all the Azure subscriptions...") for subscription in subscriptions_client.subscriptions.list(): @@ -195,3 +206,6 @@ class Azure_Provider: def get_identity(self): return self.identity + + def get_region_config(self): + return self.region_config diff --git a/prowler/providers/azure/lib/arguments/arguments.py b/prowler/providers/azure/lib/arguments/arguments.py index 5c1316e672..30cf7a33d7 100644 --- a/prowler/providers/azure/lib/arguments/arguments.py +++ b/prowler/providers/azure/lib/arguments/arguments.py @@ -1,3 +1,6 @@ +from argparse import ArgumentTypeError + + def init_parser(self): """Init the Azure Provider CLI parser""" azure_parser = self.subparsers.add_parser( @@ -40,3 +43,27 @@ def init_parser(self): default=None, help="Azure Tenant ID to be used with --browser-auth option", ) + # Regions + azure_regions_subparser = azure_parser.add_argument_group("Regions") + azure_regions_subparser.add_argument( + "--azure-region", + nargs="?", + default="AzureCloud", + type=validate_azure_region, + help="Azure region from `az cloud list --output table`, by default AzureCloud", + ) + + +def validate_azure_region(region): + """validate_azure_region validates if the region passed as argument is valid""" + regions_allowed = [ + "AzureChinaCloud", + "AzureUSGovernment", + "AzureGermanCloud", + "AzureCloud", + ] + if region not in regions_allowed: + raise ArgumentTypeError( + f"Region {region} not allowed, allowed regions are {' '.join(regions_allowed)}" + ) + return region diff --git a/prowler/providers/azure/lib/audit_info/audit_info.py b/prowler/providers/azure/lib/audit_info/audit_info.py index 62144444db..098f63c77e 100644 --- a/prowler/providers/azure/lib/audit_info/audit_info.py +++ b/prowler/providers/azure/lib/audit_info/audit_info.py @@ -1,6 +1,7 @@ from prowler.providers.azure.lib.audit_info.models import ( Azure_Audit_Info, Azure_Identity_Info, + Azure_Region_Config, ) azure_audit_info = Azure_Audit_Info( @@ -9,4 +10,5 @@ azure_audit_info = Azure_Audit_Info( audit_resources=None, audit_metadata=None, audit_config=None, + azure_region_config=Azure_Region_Config(), ) diff --git a/prowler/providers/azure/lib/audit_info/models.py b/prowler/providers/azure/lib/audit_info/models.py index dcbe1adec0..978ec34259 100644 --- a/prowler/providers/azure/lib/audit_info/models.py +++ b/prowler/providers/azure/lib/audit_info/models.py @@ -13,6 +13,13 @@ class Azure_Identity_Info(BaseModel): subscriptions: dict = {} +class Azure_Region_Config(BaseModel): + name: str = "" + authority: str = None + base_url: str = "" + credential_scopes: list = [] + + @dataclass class Azure_Audit_Info: credentials: DefaultAzureCredential @@ -20,12 +27,20 @@ class Azure_Audit_Info: audit_resources: Optional[Any] audit_metadata: Optional[Any] audit_config: dict + azure_region_config: Azure_Region_Config def __init__( - self, credentials, identity, audit_metadata, audit_resources, audit_config + self, + credentials, + identity, + audit_metadata, + audit_resources, + audit_config, + azure_region_config, ): self.credentials = credentials self.identity = identity self.audit_metadata = audit_metadata self.audit_resources = audit_resources self.audit_config = audit_config + self.azure_region_config = azure_region_config diff --git a/prowler/providers/azure/lib/exception/__init__.py b/prowler/providers/azure/lib/exception/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/prowler/providers/azure/lib/exception/exception.py b/prowler/providers/azure/lib/exception/exception.py new file mode 100644 index 0000000000..51fe95d001 --- /dev/null +++ b/prowler/providers/azure/lib/exception/exception.py @@ -0,0 +1,11 @@ +class AzureException(Exception): + """ + Exception raised when dealing with Azure Provider/Azure audit info instance + + Attributes: + message -- message to be displayed + """ + + def __init__(self, message): + self.message = message + super().__init__(self.message) diff --git a/prowler/providers/azure/lib/regions/__init__.py b/prowler/providers/azure/lib/regions/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/prowler/providers/azure/lib/regions/regions.py b/prowler/providers/azure/lib/regions/regions.py new file mode 100644 index 0000000000..a9d29d7eca --- /dev/null +++ b/prowler/providers/azure/lib/regions/regions.py @@ -0,0 +1,38 @@ +from azure.identity import AzureAuthorityHosts +from msrestazure.azure_cloud import ( + AZURE_CHINA_CLOUD, + AZURE_GERMAN_CLOUD, + AZURE_US_GOV_CLOUD, +) + + +def get_regions_config(region): + allowed_regions = { + "AzureCloud": { + "authority": None, + "base_url": "https://management.azure.com", + "credential_scopes": ["https://management.azure.com/.default"], + }, + "AzureChinaCloud": { + "authority": AzureAuthorityHosts.AZURE_CHINA, + "base_url": AZURE_CHINA_CLOUD.endpoints.resource_manager, + "credential_scopes": [ + AZURE_CHINA_CLOUD.endpoints.resource_manager + "/.default" + ], + }, + "AzureUSGovernment": { + "authority": AzureAuthorityHosts.AZURE_GOVERNMENT, + "base_url": AZURE_US_GOV_CLOUD.endpoints.resource_manager, + "credential_scopes": [ + AZURE_US_GOV_CLOUD.endpoints.resource_manager + "/.default" + ], + }, + "AzureGermanCloud": { + "authority": AzureAuthorityHosts.AZURE_GERMANY, + "base_url": AZURE_GERMAN_CLOUD.endpoints.resource_manager, + "credential_scopes": [ + AZURE_GERMAN_CLOUD.endpoints.resource_manager + "/.default" + ], + }, + } + return allowed_regions[region] diff --git a/prowler/providers/azure/lib/service/service.py b/prowler/providers/azure/lib/service/service.py index f45747c50d..305f25898e 100644 --- a/prowler/providers/azure/lib/service/service.py +++ b/prowler/providers/azure/lib/service/service.py @@ -9,17 +9,27 @@ class AzureService: audit_info: Azure_Audit_Info, ): self.clients = self.__set_clients__( - audit_info.identity.subscriptions, audit_info.credentials, service + audit_info.identity.subscriptions, + audit_info.credentials, + service, + audit_info.azure_region_config, ) self.subscriptions = audit_info.identity.subscriptions - def __set_clients__(self, subscriptions, credentials, service): + def __set_clients__(self, subscriptions, credentials, service, region_config): clients = {} try: for display_name, id in subscriptions.items(): clients.update( - {display_name: service(credential=credentials, subscription_id=id)} + { + display_name: service( + credential=credentials, + subscription_id=id, + base_url=region_config.base_url, + credential_scopes=region_config.credential_scopes, + ) + } ) except Exception as error: logger.error( diff --git a/prowler/providers/common/audit_info.py b/prowler/providers/common/audit_info.py index d2ee136183..ec8b302b5c 100644 --- a/prowler/providers/common/audit_info.py +++ b/prowler/providers/common/audit_info.py @@ -26,7 +26,11 @@ from prowler.providers.aws.lib.resource_api_tagging.resource_api_tagging import ) from prowler.providers.azure.azure_provider import Azure_Provider from prowler.providers.azure.lib.audit_info.audit_info import azure_audit_info -from prowler.providers.azure.lib.audit_info.models import Azure_Audit_Info +from prowler.providers.azure.lib.audit_info.models import ( + Azure_Audit_Info, + Azure_Region_Config, +) +from prowler.providers.azure.lib.exception.exception import AzureException from prowler.providers.gcp.gcp_provider import GCP_Provider from prowler.providers.gcp.lib.audit_info.audit_info import gcp_audit_info from prowler.providers.gcp.lib.audit_info.models import GCP_Audit_Info @@ -63,7 +67,7 @@ GCP Account: {Fore.YELLOW}[{profile}]{Style.RESET_ALL} GCP Project IDs: {Fore.Y report = f""" This report is being generated using the identity below: -Azure Tenant IDs: {Fore.YELLOW}[{" ".join(audit_info.identity.tenant_ids)}]{Style.RESET_ALL} Azure Tenant Domain: {Fore.YELLOW}[{audit_info.identity.domain}]{Style.RESET_ALL} +Azure Tenant IDs: {Fore.YELLOW}[{" ".join(audit_info.identity.tenant_ids)}]{Style.RESET_ALL} Azure Tenant Domain: {Fore.YELLOW}[{audit_info.identity.domain}]{Style.RESET_ALL} Azure Region: {Fore.YELLOW}[{audit_info.azure_region_config.name}]{Style.RESET_ALL} Azure Subscriptions: {Fore.YELLOW}{printed_subscriptions}{Style.RESET_ALL} Azure Identity Type: {Fore.YELLOW}[{audit_info.identity.identity_type}]{Style.RESET_ALL} Azure Identity ID: {Fore.YELLOW}[{audit_info.identity.identity_id}]{Style.RESET_ALL} """ @@ -282,17 +286,21 @@ Azure Identity Type: {Fore.YELLOW}[{audit_info.identity.identity_type}]{Style.RE browser_auth = arguments.get("browser_auth") managed_entity_auth = arguments.get("managed_entity_auth") tenant_id = arguments.get("tenant_id") + + logger.info("Checking if region is different than default one") + region = arguments.get("azure_region") + if ( not az_cli_auth and not sp_env_auth and not browser_auth and not managed_entity_auth ): - raise Exception( + raise AzureException( "Azure provider requires at least one authentication method set: [--az-cli-auth | --sp-env-auth | --browser-auth | --managed-identity-auth]" ) if (not browser_auth and tenant_id) or (browser_auth and not tenant_id): - raise Exception( + raise AzureException( "Azure Tenant ID (--tenant-id) is required only for browser authentication mode" ) @@ -303,9 +311,17 @@ Azure Identity Type: {Fore.YELLOW}[{audit_info.identity.identity_type}]{Style.RE managed_entity_auth, subscription_ids, tenant_id, + region, ) azure_audit_info.credentials = azure_provider.get_credentials() azure_audit_info.identity = azure_provider.get_identity() + region_config = azure_provider.get_region_config() + azure_audit_info.azure_region_config = Azure_Region_Config( + name=region, + authority=region_config["authority"], + base_url=region_config["base_url"], + credential_scopes=region_config["credential_scopes"], + ) if not arguments.get("only_logs"): self.print_azure_credentials(azure_audit_info) diff --git a/prowler/providers/common/clean.py b/prowler/providers/common/clean.py new file mode 100644 index 0000000000..d06e1e6941 --- /dev/null +++ b/prowler/providers/common/clean.py @@ -0,0 +1,32 @@ +import importlib +import sys +from shutil import rmtree + +from prowler.config.config import default_output_directory +from prowler.lib.logger import logger + + +def clean_provider_local_output_directories(args): + """ + clean_provider_local_output_directories cleans deletes local custom dirs when output is sent to remote provider storage + """ + try: + # import provider cleaning function + provider_clean_function = f"clean_{args.provider}_local_output_directories" + getattr(importlib.import_module(__name__), provider_clean_function)(args) + except AttributeError as attribute_exception: + logger.info( + f"Cleaning local output directories not initialized for provider {args.provider}: {attribute_exception}" + ) + except Exception as error: + logger.critical( + f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) + sys.exit(1) + + +def clean_aws_local_output_directories(args): + """clean_aws_provider_local_output_directories deletes local custom dirs when output is sent to remote provider storage for aws provider""" + if args.output_bucket or args.output_bucket_no_assume: + if args.output_directory != default_output_directory: + rmtree(args.output_directory) diff --git a/prowler/providers/common/outputs.py b/prowler/providers/common/outputs.py index 1360764505..58567df1e8 100644 --- a/prowler/providers/common/outputs.py +++ b/prowler/providers/common/outputs.py @@ -29,6 +29,21 @@ def set_provider_output_options( return provider_output_options +def get_provider_output_model(audit_info_class_name): + """ + get_provider_output_model returns the model _Check_Output_CSV for each provider + """ + # from AWS_Audit_Info -> AWS -> aws -> Aws + output_provider = audit_info_class_name.split("_", 1)[0].lower().capitalize() + output_provider_model_name = f"{output_provider}_Check_Output_CSV" + output_provider_models_path = "prowler.lib.outputs.models" + output_provider_model = getattr( + importlib.import_module(output_provider_models_path), output_provider_model_name + ) + + return output_provider_model + + @dataclass class Provider_Output_Options: is_quiet: bool diff --git a/prowler/providers/gcp/gcp_provider.py b/prowler/providers/gcp/gcp_provider.py index fe8ae67da0..7f5b700f99 100644 --- a/prowler/providers/gcp/gcp_provider.py +++ b/prowler/providers/gcp/gcp_provider.py @@ -3,10 +3,8 @@ import sys from google import auth from googleapiclient import discovery -from googleapiclient.discovery import Resource from prowler.lib.logger import logger -from prowler.providers.gcp.lib.audit_info.models import GCP_Audit_Info class GCP_Provider: @@ -92,16 +90,3 @@ class GCP_Provider: f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) return [] - - -def generate_client( - service: str, - api_version: str, - audit_info: GCP_Audit_Info, -) -> Resource: - try: - return discovery.build(service, api_version, credentials=audit_info.credentials) - except Exception as error: - logger.error( - f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" - ) diff --git a/prowler/providers/gcp/lib/service/service.py b/prowler/providers/gcp/lib/service/service.py index 7b8b44e1c7..30bcc5a2e7 100644 --- a/prowler/providers/gcp/lib/service/service.py +++ b/prowler/providers/gcp/lib/service/service.py @@ -3,10 +3,11 @@ import threading import google_auth_httplib2 import httplib2 from colorama import Fore, Style +from google.oauth2.credentials import Credentials from googleapiclient import discovery +from googleapiclient.discovery import Resource from prowler.lib.logger import logger -from prowler.providers.gcp.gcp_provider import generate_client from prowler.providers.gcp.lib.audit_info.models import GCP_Audit_Info @@ -25,7 +26,9 @@ class GCPService: self.api_version = api_version self.default_project_id = audit_info.default_project_id self.region = region - self.client = generate_client(service, api_version, audit_info) + self.client = self.__generate_client__( + service, api_version, audit_info.credentials + ) # Only project ids that have their API enabled will be scanned self.project_ids = self.__is_api_active__(audit_info.project_ids) @@ -66,3 +69,16 @@ class GCPService: f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) return project_ids + + def __generate_client__( + self, + service: str, + api_version: str, + credentials: Credentials, + ) -> Resource: + try: + return discovery.build(service, api_version, credentials=credentials) + except Exception as error: + logger.error( + f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" + ) diff --git a/pyproject.toml b/pyproject.toml index 003906fb4a..99a7318c81 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -22,10 +22,10 @@ packages = [ {include = "prowler"} ] readme = "README.md" -version = "3.11.0" +version = "3.11.3" [tool.poetry.dependencies] -alive-progress = "3.1.4" +alive-progress = "3.1.5" awsipranges = "0.3.3" azure-identity = "1.15.0" azure-mgmt-authorization = "4.0.0" @@ -33,21 +33,23 @@ azure-mgmt-security = "5.0.0" azure-mgmt-sql = "3.0.1" azure-mgmt-storage = "21.1.0" azure-mgmt-subscription = "3.1.1" -azure-storage-blob = "12.18.3" +azure-storage-blob = "12.19.0" boto3 = "1.26.165" botocore = "1.29.165" colorama = "0.4.6" detect-secrets = "1.4.0" -google-api-python-client = "2.105.0" +google-api-python-client = "2.108.0" google-auth-httplib2 = "^0.1.0" +jsonschema = "4.18.0" mkdocs = {version = "1.5.3", optional = true} -mkdocs-material = {version = "9.4.7", optional = true} +mkdocs-material = {version = "9.4.10", optional = true} msgraph-core = "0.2.2" +msrestazure = "^0.6.4" pydantic = "1.10.13" -python = "^3.9" +python = ">=3.9,<3.12" schema = "0.7.5" shodan = "1.30.1" -slack-sdk = "3.23.0" +slack-sdk = "3.24.0" tabulate = "0.9.0" [tool.poetry.extras] @@ -61,13 +63,13 @@ docker = "6.1.3" flake8 = "6.1.0" freezegun = "1.2.2" mock = "5.1.0" -moto = "4.2.7" +moto = {extras = ["all"], version = "4.2.9"} openapi-spec-validator = "0.7.1" pylint = "3.0.2" pytest = "7.4.3" pytest-cov = "4.1.0" pytest-randomly = "3.15.0" -pytest-xdist = "3.3.1" +pytest-xdist = "3.4.0" safety = "2.3.5" vulture = "2.10" diff --git a/tests/config/config_test.py b/tests/config/config_test.py index ab116d35e9..7f2c0d5652 100644 --- a/tests/config/config_test.py +++ b/tests/config/config_test.py @@ -63,7 +63,7 @@ class Test_Config: def test_check_current_version_with_latest(self): assert ( check_current_version() - == f"Prowler {MOCK_PROWLER_VERSION} (it is the latest version, yay!)" + == f"Prowler {MOCK_PROWLER_VERSION} (You are running the latest version, yay!)" ) @mock.patch( diff --git a/tests/lib/check/custom_checks_metadata_test.py b/tests/lib/check/custom_checks_metadata_test.py new file mode 100644 index 0000000000..c7f12459d9 --- /dev/null +++ b/tests/lib/check/custom_checks_metadata_test.py @@ -0,0 +1,164 @@ +import logging +import os + +import pytest + +from prowler.lib.check.custom_checks_metadata import ( + parse_custom_checks_metadata_file, + update_check_metadata, + update_checks_metadata, +) +from prowler.lib.check.models import ( + Check_Metadata_Model, + Code, + Recommendation, + Remediation, +) + +CUSTOM_CHECKS_METADATA_FIXTURE_FILE = f"{os.path.dirname(os.path.realpath(__file__))}/fixtures/custom_checks_metadata_example.yaml" +CUSTOM_CHECKS_METADATA_FIXTURE_FILE_NOT_VALID = f"{os.path.dirname(os.path.realpath(__file__))}/fixtures/custom_checks_metadata_example_not_valid.yaml" + +AWS_PROVIDER = "aws" +AZURE_PROVIDER = "azure" +GCP_PROVIDER = "gcp" + +S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_NAME = "s3_bucket_level_public_access_block" +S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_SEVERITY = "medium" + + +class TestCustomChecksMetadata: + def get_custom_check_metadata(self): + return Check_Metadata_Model( + Provider="aws", + CheckID=S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_NAME, + CheckTitle="Check S3 Bucket Level Public Access Block.", + CheckType=["Data Protection"], + CheckAliases=[], + ServiceName="s3", + SubServiceName="", + ResourceIdTemplate="arn:partition:s3:::bucket_name", + Severity=S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_SEVERITY, + ResourceType="AwsS3Bucket", + Description="Check S3 Bucket Level Public Access Block.", + Risk="Public access policies may be applied to sensitive data buckets.", + RelatedUrl="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html", + Remediation=Remediation( + Code=Code( + NativeIaC="", + Terraform="https://docs.bridgecrew.io/docs/bc_aws_s3_20#terraform", + CLI="aws s3api put-public-access-block --region --public-access-block-configuration BlockPublicAcls=true,IgnorePublicAcls=true,BlockPublicPolicy=true,RestrictPublicBuckets=true --bucket ", + Other="https://github.com/cloudmatos/matos/tree/master/remediations/aws/s3/s3/block-public-access", + ), + Recommendation=Recommendation( + Text="You can enable Public Access Block at the bucket level to prevent the exposure of your data stored in S3.", + Url="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html", + ), + ), + Categories=[], + DependsOn=[], + RelatedTo=[], + Notes="", + Compliance=[], + ) + + def test_parse_custom_checks_metadata_file_for_aws(self): + assert parse_custom_checks_metadata_file( + AWS_PROVIDER, CUSTOM_CHECKS_METADATA_FIXTURE_FILE + ) == { + "Checks": { + "s3_bucket_level_public_access_block": {"Severity": "high"}, + "s3_bucket_no_mfa_delete": {"Severity": "high"}, + } + } + + def test_parse_custom_checks_metadata_file_for_azure(self): + assert parse_custom_checks_metadata_file( + AZURE_PROVIDER, CUSTOM_CHECKS_METADATA_FIXTURE_FILE + ) == {"Checks": {"sqlserver_auditing_enabled": {"Severity": "high"}}} + + def test_parse_custom_checks_metadata_file_for_gcp(self): + assert parse_custom_checks_metadata_file( + GCP_PROVIDER, CUSTOM_CHECKS_METADATA_FIXTURE_FILE + ) == {"Checks": {"bigquery_dataset_cmk_encryption": {"Severity": "low"}}} + + def test_parse_custom_checks_metadata_file_for_aws_validation_error(self, caplog): + caplog.set_level(logging.CRITICAL) + + with pytest.raises(SystemExit) as error: + parse_custom_checks_metadata_file( + AWS_PROVIDER, CUSTOM_CHECKS_METADATA_FIXTURE_FILE_NOT_VALID + ) + assert error.type == SystemExit + assert error.value.code == 1 + assert "'Checks' is a required property" in caplog.text + + def test_update_checks_metadata(self): + updated_severity = "high" + bulk_checks_metadata = { + S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_NAME: self.get_custom_check_metadata(), + } + custom_checks_metadata = { + "Checks": { + S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_NAME: { + "Severity": updated_severity + }, + } + } + + bulk_checks_metadata_updated = update_checks_metadata( + bulk_checks_metadata, custom_checks_metadata + ).get(S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_NAME) + + assert bulk_checks_metadata_updated.Severity == updated_severity + + def test_update_checks_metadata_not_present_field(self): + bulk_checks_metadata = { + S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_NAME: self.get_custom_check_metadata(), + } + custom_checks_metadata = { + "Checks": { + S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_NAME: { + "RandomField": "random_value" + }, + } + } + + bulk_checks_metadata_updated = update_checks_metadata( + bulk_checks_metadata, custom_checks_metadata + ).get(S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_NAME) + + assert ( + bulk_checks_metadata_updated.Severity + == S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_SEVERITY + ) + + def test_update_check_metadata(self): + updated_severity = "high" + custom_checks_metadata = {"Severity": updated_severity} + + check_metadata_updated = update_check_metadata( + self.get_custom_check_metadata(), custom_checks_metadata + ) + assert check_metadata_updated.Severity == updated_severity + + def test_update_check_metadata_not_present_field(self): + custom_checks_metadata = {"RandomField": "random_value"} + + check_metadata_updated = update_check_metadata( + self.get_custom_check_metadata(), custom_checks_metadata + ) + assert ( + check_metadata_updated.Severity + == S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_SEVERITY + ) + + def test_update_check_metadata_none_custom_metadata(self): + custom_checks_metadata = None + + check_metadata_updated = update_check_metadata( + self.get_custom_check_metadata(), custom_checks_metadata + ) + assert ( + check_metadata_updated.Severity + == S3_BUCKET_LEVEL_PUBLIC_ACCESS_BLOCK_SEVERITY + ) diff --git a/tests/lib/check/fixtures/custom_checks_metadata_example.yaml b/tests/lib/check/fixtures/custom_checks_metadata_example.yaml new file mode 100644 index 0000000000..744051e4b2 --- /dev/null +++ b/tests/lib/check/fixtures/custom_checks_metadata_example.yaml @@ -0,0 +1,15 @@ +CustomChecksMetadata: + aws: + Checks: + s3_bucket_level_public_access_block: + Severity: high + s3_bucket_no_mfa_delete: + Severity: high + azure: + Checks: + sqlserver_auditing_enabled: + Severity: high + gcp: + Checks: + bigquery_dataset_cmk_encryption: + Severity: low diff --git a/tests/lib/check/fixtures/custom_checks_metadata_example_not_valid.yaml b/tests/lib/check/fixtures/custom_checks_metadata_example_not_valid.yaml new file mode 100644 index 0000000000..a5f7b06cbc --- /dev/null +++ b/tests/lib/check/fixtures/custom_checks_metadata_example_not_valid.yaml @@ -0,0 +1,5 @@ +CustomChecksMetadata: + aws: + Check: + s3_bucket_level_public_access_block: + Severity: high diff --git a/tests/lib/cli/parser_test.py b/tests/lib/cli/parser_test.py index e09f366d12..a307c541f6 100644 --- a/tests/lib/cli/parser_test.py +++ b/tests/lib/cli/parser_test.py @@ -1,9 +1,11 @@ import uuid +from argparse import ArgumentTypeError import pytest from mock import patch from prowler.lib.cli.parser import ProwlerArgumentParser +from prowler.providers.azure.lib.arguments.arguments import validate_azure_region prowler_command = "prowler" @@ -502,6 +504,18 @@ class Test_Parser: assert service_1 in parsed.services assert service_2 in parsed.services + def test_checks_parser_services_with_severity(self): + argument1 = "--services" + service_1 = "iam" + argument2 = "--severity" + severity = "low" + command = [prowler_command, argument1, service_1, argument2, severity] + parsed = self.parser.parse(command) + assert len(parsed.services) == 1 + assert service_1 in parsed.services + assert len(parsed.severity) == 1 + assert severity in parsed.severity + def test_checks_parser_informational_severity(self): argument = "--severity" severity = "informational" @@ -1038,6 +1052,14 @@ class Test_Parser: assert parsed.subscription_ids[0] == subscription_1 assert parsed.subscription_ids[1] == subscription_2 + def test_parser_azure_region(self): + argument = "--azure-region" + region = "AzureChinaCloud" + command = [prowler_command, "azure", argument, region] + parsed = self.parser.parse(command) + assert parsed.provider == "azure" + assert parsed.azure_region == region + # Test AWS flags with Azure provider def test_parser_azure_with_aws_flag(self, capsys): command = [prowler_command, "azure", "-p"] @@ -1080,3 +1102,33 @@ class Test_Parser: assert len(parsed.project_ids) == 2 assert parsed.project_ids[0] == project_1 assert parsed.project_ids[1] == project_2 + + def test_validate_azure_region_valid_regions(self): + expected_regions = [ + "AzureChinaCloud", + "AzureUSGovernment", + "AzureGermanCloud", + "AzureCloud", + ] + input_regions = [ + "AzureChinaCloud", + "AzureUSGovernment", + "AzureGermanCloud", + "AzureCloud", + ] + for region in input_regions: + assert validate_azure_region(region) in expected_regions + + def test_validate_azure_region_invalid_regions(self): + expected_regions = [ + "AzureChinaCloud", + "AzureUSGovernment", + "AzureGermanCloud", + "AzureCloud", + ] + invalid_region = "non-valid-region" + with pytest.raises( + ArgumentTypeError, + match=f"Region {invalid_region} not allowed, allowed regions are {' '.join(expected_regions)}", + ): + validate_azure_region(invalid_region) diff --git a/tests/lib/outputs/slack_test.py b/tests/lib/outputs/slack_test.py index b66093567e..02e572ea6f 100644 --- a/tests/lib/outputs/slack_test.py +++ b/tests/lib/outputs/slack_test.py @@ -11,6 +11,7 @@ from prowler.providers.aws.lib.audit_info.models import AWS_Audit_Info from prowler.providers.azure.lib.audit_info.models import ( Azure_Audit_Info, Azure_Identity_Info, + Azure_Region_Config, ) from prowler.providers.common.models import Audit_Metadata from prowler.providers.gcp.lib.audit_info.models import GCP_Audit_Info @@ -76,6 +77,7 @@ class Test_Slack_Integration: audit_resources=None, audit_metadata=None, audit_config=None, + azure_region_config=Azure_Region_Config(), ) assert create_message_identity("aws", aws_audit_info) == ( f"AWS Account *{aws_audit_info.audited_account}*", diff --git a/tests/providers/aws/audit_info_utils.py b/tests/providers/aws/audit_info_utils.py index d2598a8c4a..596c3809de 100644 --- a/tests/providers/aws/audit_info_utils.py +++ b/tests/providers/aws/audit_info_utils.py @@ -5,9 +5,11 @@ from prowler.providers.common.models import Audit_Metadata AWS_REGION_US_EAST_1 = "us-east-1" AWS_REGION_EU_WEST_1 = "eu-west-1" +AWS_REGION_EU_WEST_2 = "eu-west-2" AWS_PARTITION = "aws" AWS_ACCOUNT_NUMBER = "123456789012" AWS_ACCOUNT_ARN = f"arn:aws:iam::{AWS_ACCOUNT_NUMBER}:root" +AWS_COMMERCIAL_PARTITION = "aws" # Mocked AWS Audit Info diff --git a/tests/providers/aws/lib/allowlist/allowlist_test.py b/tests/providers/aws/lib/allowlist/allowlist_test.py index 4bd624be39..d54c19c881 100644 --- a/tests/providers/aws/lib/allowlist/allowlist_test.py +++ b/tests/providers/aws/lib/allowlist/allowlist_test.py @@ -8,15 +8,18 @@ from prowler.providers.aws.lib.allowlist.allowlist import ( is_allowlisted, is_allowlisted_in_check, is_allowlisted_in_region, + is_allowlisted_in_resource, is_allowlisted_in_tags, is_excepted, parse_allowlist_file, ) from prowler.providers.aws.lib.audit_info.models import AWS_Audit_Info from prowler.providers.common.models import Audit_Metadata - -AWS_ACCOUNT_NUMBER = "123456789012" -AWS_REGION = "us-east-1" +from tests.providers.aws.audit_info_utils import ( + AWS_ACCOUNT_NUMBER, + AWS_REGION_EU_WEST_1, + AWS_REGION_US_EAST_1, +) class Test_Allowlist: @@ -56,7 +59,7 @@ class Test_Allowlist: def test_s3_allowlist(self): audit_info = self.set_mocked_audit_info() # Create bucket and upload allowlist yaml - s3_resource = resource("s3", region_name=AWS_REGION) + s3_resource = resource("s3", region_name=AWS_REGION_US_EAST_1) s3_resource.create_bucket(Bucket="test-allowlist") s3_resource.Object("test-allowlist", "allowlist.yaml").put( Body=open( @@ -75,7 +78,7 @@ class Test_Allowlist: def test_dynamo_allowlist(self): audit_info = self.set_mocked_audit_info() # Create table and put item - dynamodb_resource = resource("dynamodb", region_name=AWS_REGION) + dynamodb_resource = resource("dynamodb", region_name=AWS_REGION_US_EAST_1) table_name = "test-allowlist" params = { "TableName": table_name, @@ -97,7 +100,7 @@ class Test_Allowlist: Item={ "Accounts": "*", "Checks": "iam_user_hardware_mfa_enabled", - "Regions": ["eu-west-1", AWS_REGION], + "Regions": [AWS_REGION_EU_WEST_1, AWS_REGION_US_EAST_1], "Resources": ["keyword"], } ) @@ -107,7 +110,7 @@ class Test_Allowlist: in parse_allowlist_file( audit_info, "arn:aws:dynamodb:" - + AWS_REGION + + AWS_REGION_US_EAST_1 + ":" + str(AWS_ACCOUNT_NUMBER) + ":table/" @@ -119,7 +122,7 @@ class Test_Allowlist: def test_dynamo_allowlist_with_tags(self): audit_info = self.set_mocked_audit_info() # Create table and put item - dynamodb_resource = resource("dynamodb", region_name=AWS_REGION) + dynamodb_resource = resource("dynamodb", region_name=AWS_REGION_US_EAST_1) table_name = "test-allowlist" params = { "TableName": table_name, @@ -152,7 +155,7 @@ class Test_Allowlist: in parse_allowlist_file( audit_info, "arn:aws:dynamodb:" - + AWS_REGION + + AWS_REGION_US_EAST_1 + ":" + str(AWS_ACCOUNT_NUMBER) + ":table/" @@ -169,7 +172,7 @@ class Test_Allowlist: "*": { "Checks": { "check_test": { - "Regions": [AWS_REGION, "eu-west-1"], + "Regions": [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1], "Resources": ["prowler", "^test", "prowler-pro"], } } @@ -183,7 +186,7 @@ class Test_Allowlist: finding_1.check_metadata = MagicMock finding_1.check_metadata.CheckID = "check_test" finding_1.status = "FAIL" - finding_1.region = AWS_REGION + finding_1.region = AWS_REGION_US_EAST_1 finding_1.resource_id = "prowler" finding_1.resource_tags = [] @@ -195,6 +198,66 @@ class Test_Allowlist: assert len(allowlisted_findings) == 1 assert allowlisted_findings[0].status == "WARNING" + def test_is_allowlisted_with_everything_excepted(self): + allowlist = { + "Accounts": { + "*": { + "Checks": { + "athena_*": { + "Regions": "*", + "Resources": "*", + "Tags": "*", + "Exceptions": { + "Accounts": ["*"], + "Regions": ["*"], + "Resources": ["*"], + "Tags": ["*"], + }, + } + } + } + } + } + + assert not is_allowlisted( + allowlist, + AWS_ACCOUNT_NUMBER, + "athena_1", + AWS_REGION_US_EAST_1, + "prowler", + "", + ) + + def test_is_allowlisted_with_default_allowlist(self): + allowlist = { + "Accounts": { + "*": { + "Checks": { + "*": { + "Tags": ["*"], + "Regions": ["*"], + "Resources": ["*"], + "Exceptions": { + "Tags": [], + "Regions": [], + "Accounts": [], + "Resources": [], + }, + } + } + } + } + } + + assert is_allowlisted( + allowlist, + AWS_ACCOUNT_NUMBER, + "athena_1", + AWS_REGION_US_EAST_1, + "prowler", + "", + ) + def test_is_allowlisted(self): # Allowlist example allowlist = { @@ -202,7 +265,7 @@ class Test_Allowlist: "*": { "Checks": { "check_test": { - "Regions": [AWS_REGION, "eu-west-1"], + "Regions": [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1], "Resources": ["prowler", "^test", "prowler-pro"], } } @@ -211,22 +274,37 @@ class Test_Allowlist: } assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "prowler", "" - ) - - assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "prowler-test", "" - ) - - assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "test-prowler", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "prowler", + "", ) assert is_allowlisted( allowlist, AWS_ACCOUNT_NUMBER, "check_test", - AWS_REGION, + AWS_REGION_US_EAST_1, + "prowler-test", + "", + ) + + assert is_allowlisted( + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "test-prowler", + "", + ) + + assert is_allowlisted( + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, "prowler-pro-test", "", ) @@ -244,7 +322,7 @@ class Test_Allowlist: "*": { "Checks": { "check_test": { - "Regions": [AWS_REGION, "eu-west-1"], + "Regions": [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1], "Resources": [".*"], } } @@ -253,15 +331,30 @@ class Test_Allowlist: } assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "prowler", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "prowler", + "", ) assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "prowler-test", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "prowler-test", + "", ) assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "test-prowler", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "test-prowler", + "", ) assert not ( @@ -277,7 +370,7 @@ class Test_Allowlist: "*": { "Checks": { "check_test": { - "Regions": [AWS_REGION, "eu-west-1"], + "Regions": [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1], "Resources": ["*"], } } @@ -286,15 +379,30 @@ class Test_Allowlist: } assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "prowler", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "prowler", + "", ) assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "prowler-test", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "prowler-test", + "", ) assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "test-prowler", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "test-prowler", + "", ) assert not ( @@ -310,7 +418,7 @@ class Test_Allowlist: "*": { "Checks": { "check_test_2": { - "Regions": [AWS_REGION, "eu-west-1"], + "Regions": [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1], "Resources": ["*"], } } @@ -318,7 +426,7 @@ class Test_Allowlist: AWS_ACCOUNT_NUMBER: { "Checks": { "check_test": { - "Regions": [AWS_REGION], + "Regions": [AWS_REGION_US_EAST_1], "Resources": ["*"], } } @@ -327,19 +435,39 @@ class Test_Allowlist: } assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test_2", AWS_REGION, "prowler", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test_2", + AWS_REGION_US_EAST_1, + "prowler", + "", ) assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "prowler", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "prowler", + "", ) assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "prowler-test", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "prowler-test", + "", ) assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "test-prowler", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "test-prowler", + "", ) assert not ( @@ -354,7 +482,7 @@ class Test_Allowlist: AWS_ACCOUNT_NUMBER: { "Checks": { "check_test": { - "Regions": [AWS_REGION], + "Regions": [AWS_REGION_US_EAST_1], "Resources": ["prowler"], } } @@ -363,7 +491,12 @@ class Test_Allowlist: } assert is_allowlisted( - allowlist, AWS_ACCOUNT_NUMBER, "check_test", AWS_REGION, "prowler", "" + allowlist, + AWS_ACCOUNT_NUMBER, + "check_test", + AWS_REGION_US_EAST_1, + "prowler", + "", ) assert not ( @@ -373,47 +506,27 @@ class Test_Allowlist: ) def test_is_allowlisted_in_region(self): - # Allowlist example - allowlisted_regions = [AWS_REGION, "eu-west-1"] - allowlisted_resources = ["*"] + allowlisted_regions = [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1] + finding_region = AWS_REGION_US_EAST_1 - assert is_allowlisted_in_region( - allowlisted_regions, allowlisted_resources, None, AWS_REGION, "prowler", "" - ) + assert is_allowlisted_in_region(allowlisted_regions, finding_region) - assert is_allowlisted_in_region( - allowlisted_regions, - allowlisted_resources, - None, - AWS_REGION, - "prowler-test", - "", - ) + def test_is_allowlisted_in_region_wildcard(self): + allowlisted_regions = ["*"] + finding_region = AWS_REGION_US_EAST_1 - assert is_allowlisted_in_region( - allowlisted_regions, - allowlisted_resources, - None, - AWS_REGION, - "test-prowler", - "", - ) + assert is_allowlisted_in_region(allowlisted_regions, finding_region) - assert not ( - is_allowlisted_in_region( - allowlisted_regions, - allowlisted_resources, - None, - "us-east-2", - "test", - "", - ) - ) + def test_is_not_allowlisted_in_region(self): + allowlisted_regions = [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1] + finding_region = "eu-west-2" + + assert not is_allowlisted_in_region(allowlisted_regions, finding_region) def test_is_allowlisted_in_check(self): allowlisted_checks = { "check_test": { - "Regions": [AWS_REGION, "eu-west-1"], + "Regions": [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1], "Resources": ["*"], } } @@ -421,9 +534,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "check_test", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler", "", ) @@ -431,9 +543,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "check_test", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler-test", "", ) @@ -441,9 +552,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "check_test", - AWS_REGION, + AWS_REGION_US_EAST_1, "test-prowler", "", ) @@ -452,7 +562,6 @@ class Test_Allowlist: is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "check_test", "us-east-2", "test", @@ -464,7 +573,7 @@ class Test_Allowlist: # Allowlist example allowlisted_checks = { "s3_*": { - "Regions": [AWS_REGION, "eu-west-1"], + "Regions": [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1], "Resources": ["*"], } } @@ -472,9 +581,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "s3_bucket_public_access", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler", "", ) @@ -482,9 +590,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "s3_bucket_no_mfa_delete", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler-test", "", ) @@ -492,9 +599,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "s3_bucket_policy_public_write_access", - AWS_REGION, + AWS_REGION_US_EAST_1, "test-prowler", "", ) @@ -503,9 +609,8 @@ class Test_Allowlist: is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "iam_user_hardware_mfa_enabled", - AWS_REGION, + AWS_REGION_US_EAST_1, "test", "", ) @@ -514,7 +619,7 @@ class Test_Allowlist: def test_is_allowlisted_lambda_generic_check(self): allowlisted_checks = { "lambda_*": { - "Regions": [AWS_REGION, "eu-west-1"], + "Regions": [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1], "Resources": ["*"], } } @@ -522,9 +627,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "awslambda_function_invoke_api_operations_cloudtrail_logging_enabled", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler", "", ) @@ -532,9 +636,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "awslambda_function_no_secrets_in_code", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler", "", ) @@ -542,9 +645,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "awslambda_function_no_secrets_in_variables", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler", "", ) @@ -552,9 +654,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "awslambda_function_not_publicly_accessible", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler", "", ) @@ -562,9 +663,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "awslambda_function_url_cors_policy", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler", "", ) @@ -572,9 +672,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "awslambda_function_url_public", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler", "", ) @@ -582,9 +681,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "awslambda_function_using_supported_runtimes", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler", "", ) @@ -592,7 +690,7 @@ class Test_Allowlist: def test_is_allowlisted_lambda_concrete_check(self): allowlisted_checks = { "lambda_function_no_secrets_in_variables": { - "Regions": [AWS_REGION, "eu-west-1"], + "Regions": [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1], "Resources": ["*"], } } @@ -600,9 +698,8 @@ class Test_Allowlist: assert is_allowlisted_in_check( allowlisted_checks, AWS_ACCOUNT_NUMBER, - AWS_ACCOUNT_NUMBER, "awslambda_function_no_secrets_in_variables", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler", "", ) @@ -614,7 +711,7 @@ class Test_Allowlist: "*": { "Checks": { "check_test": { - "Regions": [AWS_REGION, "eu-west-1"], + "Regions": [AWS_REGION_US_EAST_1, AWS_REGION_EU_WEST_1], "Resources": ["*"], "Tags": ["environment=dev", "project=.*"], } @@ -627,7 +724,7 @@ class Test_Allowlist: allowlist, AWS_ACCOUNT_NUMBER, "check_test", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler", "environment=dev", ) @@ -636,7 +733,7 @@ class Test_Allowlist: allowlist, AWS_ACCOUNT_NUMBER, "check_test", - AWS_REGION, + AWS_REGION_US_EAST_1, "prowler-test", "environment=dev | project=prowler", ) @@ -654,56 +751,45 @@ class Test_Allowlist: def test_is_allowlisted_in_tags(self): allowlist_tags = ["environment=dev", "project=prowler"] - allowlist_resource = "*" + + assert is_allowlisted_in_tags(allowlist_tags, "environment=dev") assert is_allowlisted_in_tags( allowlist_tags, - "*", - "prowler", - "environment=dev", - ) - - assert is_allowlisted_in_tags( - allowlist_tags, - allowlist_resource, - "prowler-test", "environment=dev | project=prowler", ) assert not ( is_allowlisted_in_tags( allowlist_tags, - allowlist_resource, - "test", "environment=pro", ) ) def test_is_allowlisted_in_tags_regex(self): allowlist_tags = ["environment=(dev|test)", ".*=prowler"] - allowlist_resource = "*" assert is_allowlisted_in_tags( allowlist_tags, - allowlist_resource, - "prowler-test", "environment=test | proj=prowler", ) assert is_allowlisted_in_tags( allowlist_tags, - allowlist_resource, - "prowler-test", "env=prod | project=prowler", ) assert not is_allowlisted_in_tags( allowlist_tags, - allowlist_resource, - "prowler-test", "environment=prod | project=myproj", ) + def test_is_allowlisted_in_tags_with_no_tags_in_finding(self): + allowlist_tags = ["environment=(dev|test)", ".*=prowler"] + finding_tags = "" + + assert not is_allowlisted_in_tags(allowlist_tags, finding_tags) + def test_is_excepted(self): # Allowlist example exceptions = { @@ -737,6 +823,28 @@ class Test_Allowlist: "environment=test", ) + def test_is_excepted_all_wildcard(self): + exceptions = { + "Accounts": ["*"], + "Regions": ["*"], + "Resources": ["*"], + "Tags": ["*"], + } + assert is_excepted( + exceptions, AWS_ACCOUNT_NUMBER, "eu-south-2", "test", "environment=test" + ) + assert not is_excepted( + exceptions, AWS_ACCOUNT_NUMBER, "eu-south-2", "test", None + ) + + def test_is_not_excepted(self): + exceptions = { + "Accounts": [AWS_ACCOUNT_NUMBER], + "Regions": ["eu-central-1", "eu-south-3"], + "Resources": ["test"], + "Tags": ["environment=test", "project=.*"], + } + assert not is_excepted( exceptions, AWS_ACCOUNT_NUMBER, @@ -760,3 +868,11 @@ class Test_Allowlist: "test", "environment=pro", ) + + def test_is_allowlisted_in_resource(self): + allowlist_resources = ["prowler", "^test", "prowler-pro"] + + assert is_allowlisted_in_resource(allowlist_resources, "prowler") + assert is_allowlisted_in_resource(allowlist_resources, "prowler-test") + assert is_allowlisted_in_resource(allowlist_resources, "test-prowler") + assert not is_allowlisted_in_resource(allowlist_resources, "random") diff --git a/tests/providers/aws/lib/policy_condition_parser/policy_condition_parser_test.py b/tests/providers/aws/lib/policy_condition_parser/policy_condition_parser_test.py index 14d454711d..4e8e71ccec 100644 --- a/tests/providers/aws/lib/policy_condition_parser/policy_condition_parser_test.py +++ b/tests/providers/aws/lib/policy_condition_parser/policy_condition_parser_test.py @@ -1282,3 +1282,75 @@ class Test_policy_condition_parser: assert not is_account_only_allowed_in_condition( condition_statement, TRUSTED_AWS_ACCOUNT_NUMBER ) + + def test_condition_parser_two_lists_unrestrictive(self): + condition_statement = { + "StringLike": { + "AWS:ResourceAccount": [ + TRUSTED_AWS_ACCOUNT_NUMBER, + NON_TRUSTED_AWS_ACCOUNT_NUMBER, + ] + }, + "ArnLike": { + "AWS:SourceArn": [ + f"arn:aws:cloudtrail:*:{TRUSTED_AWS_ACCOUNT_NUMBER}:trail/*", + f"arn:aws:cloudtrail:*:{NON_TRUSTED_AWS_ACCOUNT_NUMBER}:trail/*", + ] + }, + } + assert not is_account_only_allowed_in_condition( + condition_statement, TRUSTED_AWS_ACCOUNT_NUMBER + ) + + def test_condition_parser_two_lists_both_restrictive(self): + condition_statement = { + "StringLike": { + "AWS:ResourceAccount": [ + TRUSTED_AWS_ACCOUNT_NUMBER, + ] + }, + "ArnLike": { + "AWS:SourceArn": [ + f"arn:aws:cloudtrail:*:{TRUSTED_AWS_ACCOUNT_NUMBER}:trail/*", + ] + }, + } + assert is_account_only_allowed_in_condition( + condition_statement, TRUSTED_AWS_ACCOUNT_NUMBER + ) + + def test_condition_parser_two_lists_first_restrictive(self): + condition_statement = { + "StringLike": { + "AWS:ResourceAccount": [ + TRUSTED_AWS_ACCOUNT_NUMBER, + ] + }, + "ArnLike": { + "AWS:SourceArn": [ + f"arn:aws:cloudtrail:*:{TRUSTED_AWS_ACCOUNT_NUMBER}:trail/*", + f"arn:aws:cloudtrail:*:{NON_TRUSTED_AWS_ACCOUNT_NUMBER}:trail/*", + ] + }, + } + assert is_account_only_allowed_in_condition( + condition_statement, TRUSTED_AWS_ACCOUNT_NUMBER + ) + + def test_condition_parser_two_lists_second_restrictive(self): + condition_statement = { + "StringLike": { + "AWS:ResourceAccount": [ + TRUSTED_AWS_ACCOUNT_NUMBER, + NON_TRUSTED_AWS_ACCOUNT_NUMBER, + ] + }, + "ArnLike": { + "AWS:SourceArn": [ + f"arn:aws:cloudtrail:*:{TRUSTED_AWS_ACCOUNT_NUMBER}:trail/*", + ] + }, + } + assert is_account_only_allowed_in_condition( + condition_statement, TRUSTED_AWS_ACCOUNT_NUMBER + ) diff --git a/tests/providers/aws/lib/security_hub/security_hub_test.py b/tests/providers/aws/lib/security_hub/security_hub_test.py index 6c81d2e43e..dad3a7103e 100644 --- a/tests/providers/aws/lib/security_hub/security_hub_test.py +++ b/tests/providers/aws/lib/security_hub/security_hub_test.py @@ -6,7 +6,6 @@ from mock import MagicMock, patch from prowler.config.config import prowler_version, timestamp_utc from prowler.lib.check.models import Check_Report, load_check_metadata -from prowler.providers.aws.lib.audit_info.models import AWS_Audit_Info # from prowler.providers.aws.lib.audit_info.models import AWS_Audit_Info from prowler.providers.aws.lib.security_hub.security_hub import ( @@ -14,11 +13,13 @@ from prowler.providers.aws.lib.security_hub.security_hub import ( prepare_security_hub_findings, verify_security_hub_integration_enabled_per_region, ) -from prowler.providers.common.models import Audit_Metadata - -AWS_ACCOUNT_ID = "123456789012" -AWS_REGION_1 = "eu-west-1" -AWS_REGION_2 = "eu-west-2" +from tests.providers.aws.audit_info_utils import ( + AWS_ACCOUNT_NUMBER, + AWS_COMMERCIAL_PARTITION, + AWS_REGION_EU_WEST_1, + AWS_REGION_EU_WEST_2, + set_mocked_aws_audit_info, +) # Mocking Security Hub Get Findings make_api_call = botocore.client.BaseClient._make_api_call @@ -32,7 +33,7 @@ def mock_make_api_call(self, operation_name, kwarg): } if operation_name == "DescribeHub": return { - "HubArn": f"arn:aws:securityhub:{AWS_REGION_1}:{AWS_ACCOUNT_ID}:hub/default", + "HubArn": f"arn:aws:securityhub:{AWS_REGION_EU_WEST_1}:{AWS_ACCOUNT_NUMBER}:hub/default", "SubscribedAt": "2023-02-07T09:45:43.742Z", "AutoEnableControls": True, "ControlFindingGenerator": "STANDARD_CONTROL", @@ -41,7 +42,7 @@ def mock_make_api_call(self, operation_name, kwarg): if operation_name == "ListEnabledProductsForImport": return { "ProductSubscriptions": [ - f"arn:aws:securityhub:{AWS_REGION_1}:{AWS_ACCOUNT_ID}:product-subscription/prowler/prowler", + f"arn:aws:securityhub:{AWS_REGION_EU_WEST_1}:{AWS_ACCOUNT_NUMBER}:product-subscription/prowler/prowler", ] } @@ -49,32 +50,6 @@ def mock_make_api_call(self, operation_name, kwarg): class Test_SecurityHub: - def set_mocked_audit_info(self): - return AWS_Audit_Info( - session_config=None, - original_session=None, - audit_session=None, - audited_account=AWS_ACCOUNT_ID, - audited_account_arn=f"arn:aws:iam::{AWS_ACCOUNT_ID}:root", - audited_identity_arn="test-arn", - audited_user_id="test", - audited_partition="aws", - profile="default", - profile_region="eu-west-1", - credentials=None, - assumed_role_info=None, - audited_regions=["eu-west-2", "eu-west-1"], - organizations_metadata=None, - audit_resources=None, - mfa_enabled=False, - audit_metadata=Audit_Metadata( - services_scanned=0, - expected_checks=[], - completed_checks=0, - audit_progress=0, - ), - ) - def generate_finding(self, status, region): finding = Check_Report( load_check_metadata( @@ -104,14 +79,18 @@ class Test_SecurityHub: @patch("botocore.client.BaseClient._make_api_call", new=mock_make_api_call) def test_verify_security_hub_integration_enabled_per_region(self): - session = self.set_mocked_session(AWS_REGION_1) - assert verify_security_hub_integration_enabled_per_region(AWS_REGION_1, session) + session = self.set_mocked_session(AWS_REGION_EU_WEST_1) + assert verify_security_hub_integration_enabled_per_region( + AWS_COMMERCIAL_PARTITION, AWS_REGION_EU_WEST_1, session, AWS_ACCOUNT_NUMBER + ) def test_prepare_security_hub_findings_enabled_region_not_quiet(self): - enabled_regions = [AWS_REGION_1] + enabled_regions = [AWS_REGION_EU_WEST_1] output_options = self.set_mocked_output_options(is_quiet=False) - findings = [self.generate_finding("PASS", AWS_REGION_1)] - audit_info = self.set_mocked_audit_info() + findings = [self.generate_finding("PASS", AWS_REGION_EU_WEST_1)] + audit_info = set_mocked_aws_audit_info( + audited_regions=[AWS_REGION_EU_WEST_1, AWS_REGION_EU_WEST_2] + ) assert prepare_security_hub_findings( findings, @@ -119,11 +98,11 @@ class Test_SecurityHub: output_options, enabled_regions, ) == { - AWS_REGION_1: [ + AWS_REGION_EU_WEST_1: [ { "SchemaVersion": "2018-10-08", - "Id": f"prowler-iam_user_accesskey_unused-{AWS_ACCOUNT_ID}-{AWS_REGION_1}-ee26b0dd4", - "ProductArn": f"arn:aws:securityhub:{AWS_REGION_1}::product/prowler/prowler", + "Id": f"prowler-iam_user_accesskey_unused-{AWS_ACCOUNT_NUMBER}-{AWS_REGION_EU_WEST_1}-ee26b0dd4", + "ProductArn": f"arn:aws:securityhub:{AWS_REGION_EU_WEST_1}::product/prowler/prowler", "RecordState": "ACTIVE", "ProductFields": { "ProviderName": "Prowler", @@ -131,7 +110,7 @@ class Test_SecurityHub: "ProwlerResourceName": "test", }, "GeneratorId": "prowler-iam_user_accesskey_unused", - "AwsAccountId": f"{AWS_ACCOUNT_ID}", + "AwsAccountId": f"{AWS_ACCOUNT_NUMBER}", "Types": ["Software and Configuration Checks"], "FirstObservedAt": timestamp_utc.strftime("%Y-%m-%dT%H:%M:%SZ"), "UpdatedAt": timestamp_utc.strftime("%Y-%m-%dT%H:%M:%SZ"), @@ -144,7 +123,7 @@ class Test_SecurityHub: "Type": "AwsIamAccessAnalyzer", "Id": "test", "Partition": "aws", - "Region": f"{AWS_REGION_1}", + "Region": f"{AWS_REGION_EU_WEST_1}", } ], "Compliance": { @@ -160,55 +139,117 @@ class Test_SecurityHub: }, } ], - AWS_REGION_2: [], } def test_prepare_security_hub_findings_quiet_INFO_finding(self): - enabled_regions = [AWS_REGION_1] + enabled_regions = [AWS_REGION_EU_WEST_1] output_options = self.set_mocked_output_options(is_quiet=False) - findings = [self.generate_finding("INFO", AWS_REGION_1)] - audit_info = self.set_mocked_audit_info() + findings = [self.generate_finding("INFO", AWS_REGION_EU_WEST_1)] + audit_info = set_mocked_aws_audit_info( + audited_regions=[AWS_REGION_EU_WEST_1, AWS_REGION_EU_WEST_2] + ) assert prepare_security_hub_findings( findings, audit_info, output_options, enabled_regions, - ) == {AWS_REGION_1: [], AWS_REGION_2: []} + ) == {AWS_REGION_EU_WEST_1: []} def test_prepare_security_hub_findings_disabled_region(self): - enabled_regions = [AWS_REGION_1] + enabled_regions = [AWS_REGION_EU_WEST_1] output_options = self.set_mocked_output_options(is_quiet=False) - findings = [self.generate_finding("PASS", AWS_REGION_2)] - audit_info = self.set_mocked_audit_info() + findings = [self.generate_finding("PASS", AWS_REGION_EU_WEST_2)] + audit_info = set_mocked_aws_audit_info( + audited_regions=[AWS_REGION_EU_WEST_1, AWS_REGION_EU_WEST_2] + ) assert prepare_security_hub_findings( findings, audit_info, output_options, enabled_regions, - ) == {AWS_REGION_1: [], AWS_REGION_2: []} + ) == {AWS_REGION_EU_WEST_1: []} def test_prepare_security_hub_findings_quiet(self): - enabled_regions = [AWS_REGION_1] + enabled_regions = [AWS_REGION_EU_WEST_1] output_options = self.set_mocked_output_options(is_quiet=True) - findings = [self.generate_finding("PASS", AWS_REGION_1)] - audit_info = self.set_mocked_audit_info() + findings = [self.generate_finding("PASS", AWS_REGION_EU_WEST_1)] + audit_info = set_mocked_aws_audit_info( + audited_regions=[AWS_REGION_EU_WEST_1, AWS_REGION_EU_WEST_2] + ) assert prepare_security_hub_findings( findings, audit_info, output_options, enabled_regions, - ) == {AWS_REGION_1: [], AWS_REGION_2: []} + ) == {AWS_REGION_EU_WEST_1: []} + + def test_prepare_security_hub_findings_no_audited_regions(self): + enabled_regions = [AWS_REGION_EU_WEST_1] + output_options = self.set_mocked_output_options(is_quiet=False) + findings = [self.generate_finding("PASS", AWS_REGION_EU_WEST_1)] + audit_info = set_mocked_aws_audit_info() + + assert prepare_security_hub_findings( + findings, + audit_info, + output_options, + enabled_regions, + ) == { + AWS_REGION_EU_WEST_1: [ + { + "SchemaVersion": "2018-10-08", + "Id": f"prowler-iam_user_accesskey_unused-{AWS_ACCOUNT_NUMBER}-{AWS_REGION_EU_WEST_1}-ee26b0dd4", + "ProductArn": f"arn:aws:securityhub:{AWS_REGION_EU_WEST_1}::product/prowler/prowler", + "RecordState": "ACTIVE", + "ProductFields": { + "ProviderName": "Prowler", + "ProviderVersion": prowler_version, + "ProwlerResourceName": "test", + }, + "GeneratorId": "prowler-iam_user_accesskey_unused", + "AwsAccountId": f"{AWS_ACCOUNT_NUMBER}", + "Types": ["Software and Configuration Checks"], + "FirstObservedAt": timestamp_utc.strftime("%Y-%m-%dT%H:%M:%SZ"), + "UpdatedAt": timestamp_utc.strftime("%Y-%m-%dT%H:%M:%SZ"), + "CreatedAt": timestamp_utc.strftime("%Y-%m-%dT%H:%M:%SZ"), + "Severity": {"Label": "LOW"}, + "Title": "Ensure Access Keys unused are disabled", + "Description": "test", + "Resources": [ + { + "Type": "AwsIamAccessAnalyzer", + "Id": "test", + "Partition": "aws", + "Region": f"{AWS_REGION_EU_WEST_1}", + } + ], + "Compliance": { + "Status": "PASSED", + "RelatedRequirements": [], + "AssociatedStandards": [], + }, + "Remediation": { + "Recommendation": { + "Text": "Run sudo yum update and cross your fingers and toes.", + "Url": "https://myfp.com/recommendations/dangerous_things_and_how_to_fix_them.html", + } + }, + } + ], + } @patch("botocore.client.BaseClient._make_api_call", new=mock_make_api_call) def test_batch_send_to_security_hub_one_finding(self): - enabled_regions = [AWS_REGION_1] + enabled_regions = [AWS_REGION_EU_WEST_1] output_options = self.set_mocked_output_options(is_quiet=False) - findings = [self.generate_finding("PASS", AWS_REGION_1)] - audit_info = self.set_mocked_audit_info() - session = self.set_mocked_session(AWS_REGION_1) + findings = [self.generate_finding("PASS", AWS_REGION_EU_WEST_1)] + audit_info = set_mocked_aws_audit_info( + audited_regions=[AWS_REGION_EU_WEST_1, AWS_REGION_EU_WEST_2] + ) + session = self.set_mocked_session(AWS_REGION_EU_WEST_1) security_hub_findings = prepare_security_hub_findings( findings, diff --git a/tests/providers/aws/services/accessanalyzer/accessanalyzer_enabled/accessanalyzer_enabled_test.py b/tests/providers/aws/services/accessanalyzer/accessanalyzer_enabled/accessanalyzer_enabled_test.py index 17f35627f1..3a0178e953 100644 --- a/tests/providers/aws/services/accessanalyzer/accessanalyzer_enabled/accessanalyzer_enabled_test.py +++ b/tests/providers/aws/services/accessanalyzer/accessanalyzer_enabled/accessanalyzer_enabled_test.py @@ -33,6 +33,7 @@ class Test_accessanalyzer_enabled: def test_one_analyzer_not_available(self): # Include analyzers to check accessanalyzer_client = mock.MagicMock + accessanalyzer_client.region = AWS_REGION_1 accessanalyzer_client.analyzers = [ Analyzer( arn=AWS_ACCOUNT_ARN, @@ -65,8 +66,46 @@ class Test_accessanalyzer_enabled: assert result[0].region == AWS_REGION_1 assert result[0].resource_tags == [] + def test_one_analyzer_not_available_allowlisted(self): + # Include analyzers to check + accessanalyzer_client = mock.MagicMock + accessanalyzer_client.region = AWS_REGION_2 + accessanalyzer_client.audit_config = {"allowlist_non_default_regions": True} + accessanalyzer_client.analyzers = [ + Analyzer( + arn=AWS_ACCOUNT_ARN, + name=AWS_ACCOUNT_NUMBER, + status="NOT_AVAILABLE", + tags=[], + type="", + region=AWS_REGION_1, + ) + ] + with mock.patch( + "prowler.providers.aws.services.accessanalyzer.accessanalyzer_service.AccessAnalyzer", + accessanalyzer_client, + ): + from prowler.providers.aws.services.accessanalyzer.accessanalyzer_enabled.accessanalyzer_enabled import ( + accessanalyzer_enabled, + ) + + check = accessanalyzer_enabled() + result = check.execute() + + assert len(result) == 1 + assert result[0].status == "WARNING" + assert ( + result[0].status_extended + == f"IAM Access Analyzer in account {AWS_ACCOUNT_NUMBER} is not enabled." + ) + assert result[0].resource_id == AWS_ACCOUNT_NUMBER + assert result[0].resource_arn == AWS_ACCOUNT_ARN + assert result[0].region == AWS_REGION_1 + assert result[0].resource_tags == [] + def test_two_analyzers(self): accessanalyzer_client = mock.MagicMock + accessanalyzer_client.region = AWS_REGION_1 accessanalyzer_client.analyzers = [ Analyzer( arn=AWS_ACCOUNT_ARN, diff --git a/tests/providers/aws/services/codeartifact/codeartifact_packages_external_public_publishing_disabled/codeartifact_packages_external_public_publishing_disabled_test.py b/tests/providers/aws/services/codeartifact/codeartifact_packages_external_public_publishing_disabled/codeartifact_packages_external_public_publishing_disabled_test.py index bcbe13e743..668f00e0a3 100644 --- a/tests/providers/aws/services/codeartifact/codeartifact_packages_external_public_publishing_disabled/codeartifact_packages_external_public_publishing_disabled_test.py +++ b/tests/providers/aws/services/codeartifact/codeartifact_packages_external_public_publishing_disabled/codeartifact_packages_external_public_publishing_disabled_test.py @@ -110,7 +110,10 @@ class Test_codeartifact_packages_external_public_publishing_disabled: assert len(result) == 1 assert result[0].region == AWS_REGION assert result[0].resource_id == "test-package" - assert result[0].resource_arn == repository_arn + assert ( + result[0].resource_arn + == repository_arn + "/" + package_namespace + ":" + package_name + ) assert result[0].resource_tags == [] assert result[0].status == "FAIL" assert ( @@ -167,7 +170,10 @@ class Test_codeartifact_packages_external_public_publishing_disabled: assert len(result) == 1 assert result[0].region == AWS_REGION assert result[0].resource_id == "test-package" - assert result[0].resource_arn == repository_arn + assert ( + result[0].resource_arn + == repository_arn + "/" + package_namespace + ":" + package_name + ) assert result[0].resource_tags == [] assert result[0].status == "PASS" assert ( diff --git a/tests/providers/aws/services/ec2/ec2_securitygroup_not_used/ec2_securitygroup_not_used_test.py b/tests/providers/aws/services/ec2/ec2_securitygroup_not_used/ec2_securitygroup_not_used_test.py index cf216574d3..81b0ea5062 100644 --- a/tests/providers/aws/services/ec2/ec2_securitygroup_not_used/ec2_securitygroup_not_used_test.py +++ b/tests/providers/aws/services/ec2/ec2_securitygroup_not_used/ec2_securitygroup_not_used_test.py @@ -244,3 +244,88 @@ class Test_ec2_securitygroup_not_used: assert result[0].resource_id == sg.id assert result[0].resource_details == sg_name assert result[0].resource_tags == [] + + @mock_ec2 + @mock_lambda + def test_ec2_associated_sg(self): + # Create EC2 Mocked Resources + ec2 = resource("ec2", AWS_REGION_US_EAST_1) + ec2_client = client("ec2", region_name=AWS_REGION_US_EAST_1) + vpc_id = ec2_client.create_vpc(CidrBlock="10.0.0.0/16")["Vpc"]["VpcId"] + sg_name = "test-sg" + sg_name1 = "test-sg1" + sg = ec2.create_security_group( + GroupName=sg_name, Description="test", VpcId=vpc_id + ) + sg1 = ec2.create_security_group( + GroupName=sg_name1, Description="test1", VpcId=vpc_id + ) + + ec2_client.authorize_security_group_ingress( + GroupId=sg.id, + IpPermissions=[ + { + "IpProtocol": "-1", + "UserIdGroupPairs": [ + { + "GroupId": sg1.id, + "Description": "Allow traffic from source SG", + } + ], + } + ], + ) + + from prowler.providers.aws.services.awslambda.awslambda_service import Lambda + from prowler.providers.aws.services.ec2.ec2_service import EC2 + + current_audit_info = set_mocked_aws_audit_info( + audited_regions=["us-east-1", "eu-west-1"] + ) + + with mock.patch( + "prowler.providers.aws.lib.audit_info.audit_info.current_audit_info", + new=current_audit_info, + ), mock.patch( + "prowler.providers.aws.services.ec2.ec2_securitygroup_not_used.ec2_securitygroup_not_used.ec2_client", + new=EC2(current_audit_info), + ), mock.patch( + "prowler.providers.aws.services.ec2.ec2_securitygroup_not_used.ec2_securitygroup_not_used.awslambda_client", + new=Lambda(current_audit_info), + ): + # Test Check + from prowler.providers.aws.services.ec2.ec2_securitygroup_not_used.ec2_securitygroup_not_used import ( + ec2_securitygroup_not_used, + ) + + check = ec2_securitygroup_not_used() + result = check.execute() + + # One custom sg + assert len(result) == 2 + assert result[0].status == "FAIL" + assert result[0].region == AWS_REGION_US_EAST_1 + assert ( + result[0].status_extended + == f"Security group {sg_name} ({sg.id}) it is not being used." + ) + assert ( + result[0].resource_arn + == f"arn:{current_audit_info.audited_partition}:ec2:{AWS_REGION_US_EAST_1}:{current_audit_info.audited_account}:security-group/{sg.id}" + ) + assert result[0].resource_id == sg.id + assert result[0].resource_details == sg_name + assert result[0].resource_tags == [] + assert result[1].status == "PASS" + assert result[1].region == AWS_REGION_US_EAST_1 + assert ( + result[1].status_extended + == f"Security group {sg_name1} ({sg1.id}) it is being used." + ) + assert ( + result[1].resource_arn + == f"arn:{current_audit_info.audited_partition}:ec2:{AWS_REGION_US_EAST_1}:{current_audit_info.audited_account}:security-group/{sg1.id}" + ) + assert result[1].resource_id == sg1.id + assert result[1].resource_details == sg_name1 + assert result[1].resource_tags == [] diff --git a/tests/providers/aws/services/guardduty/guardduty_centrally_managed/guardduty_centrally_managed_test.py b/tests/providers/aws/services/guardduty/guardduty_centrally_managed/guardduty_centrally_managed_test.py index 3f3afa6ed3..19cc667c00 100644 --- a/tests/providers/aws/services/guardduty/guardduty_centrally_managed/guardduty_centrally_managed_test.py +++ b/tests/providers/aws/services/guardduty/guardduty_centrally_managed/guardduty_centrally_managed_test.py @@ -62,6 +62,31 @@ class Test_guardduty_centrally_managed: assert result[0].region == AWS_REGION assert result[0].resource_arn == DETECTOR_ARN + def test_not_enabled_account_detector(self): + guardduty_client = mock.MagicMock + guardduty_client.detectors = [] + guardduty_client.detectors.append( + Detector( + id=AWS_ACCOUNT_NUMBER, + region=AWS_REGION, + arn=DETECTOR_ARN, + enabled_in_account=False, + ) + ) + + with mock.patch( + "prowler.providers.aws.services.guardduty.guardduty_service.GuardDuty", + guardduty_client, + ): + # Test Check + from prowler.providers.aws.services.guardduty.guardduty_centrally_managed.guardduty_centrally_managed import ( + guardduty_centrally_managed, + ) + + check = guardduty_centrally_managed() + result = check.execute() + assert len(result) == 0 + def test_detector_centralized_managed(self): guardduty_client = mock.MagicMock guardduty_client.detectors = [] diff --git a/tests/providers/aws/services/guardduty/guardduty_no_high_severity_findings/guardduty_no_high_severity_findings_test.py b/tests/providers/aws/services/guardduty/guardduty_no_high_severity_findings/guardduty_no_high_severity_findings_test.py index 5f82583f1f..456169324a 100644 --- a/tests/providers/aws/services/guardduty/guardduty_no_high_severity_findings/guardduty_no_high_severity_findings_test.py +++ b/tests/providers/aws/services/guardduty/guardduty_no_high_severity_findings/guardduty_no_high_severity_findings_test.py @@ -58,6 +58,29 @@ class Test_guardduty_no_high_severity_findings: assert result[0].resource_arn == DETECTOR_ARN assert result[0].region == AWS_REGION + def test_not_enabled_account_detector(self): + guardduty_client = mock.MagicMock + guardduty_client.detectors = [] + guardduty_client.detectors.append( + Detector( + id=AWS_ACCOUNT_NUMBER, + arn=DETECTOR_ARN, + region=AWS_REGION, + enabled_in_account=False, + ) + ) + with mock.patch( + "prowler.providers.aws.services.guardduty.guardduty_service.GuardDuty", + guardduty_client, + ): + from prowler.providers.aws.services.guardduty.guardduty_no_high_severity_findings.guardduty_no_high_severity_findings import ( + guardduty_no_high_severity_findings, + ) + + check = guardduty_no_high_severity_findings() + result = check.execute() + assert len(result) == 0 + def test_high_findings(self): guardduty_client = mock.MagicMock guardduty_client.detectors = [] diff --git a/tests/providers/aws/services/sqs/sqs_queues_not_publicly_accessible/sqs_queues_not_publicly_accessible_test.py b/tests/providers/aws/services/sqs/sqs_queues_not_publicly_accessible/sqs_queues_not_publicly_accessible_test.py index e53778f2e2..cb679d2627 100644 --- a/tests/providers/aws/services/sqs/sqs_queues_not_publicly_accessible/sqs_queues_not_publicly_accessible_test.py +++ b/tests/providers/aws/services/sqs/sqs_queues_not_publicly_accessible/sqs_queues_not_publicly_accessible_test.py @@ -7,8 +7,11 @@ from prowler.providers.aws.services.sqs.sqs_service import Queue AWS_REGION = "eu-west-1" AWS_ACCOUNT_NUMBER = "123456789012" -queue_id = str(uuid4()) -topic_arn = f"arn:aws:sqs:{AWS_REGION}:{AWS_ACCOUNT_NUMBER}:{queue_id}" +test_queue_name = str(uuid4()) +test_queue_url = ( + f"https://sqs.{AWS_REGION}.amazonaws.com/{AWS_ACCOUNT_NUMBER}/{test_queue_name}" +) +test_queue_arn = f"arn:aws:sqs:{AWS_REGION}:{AWS_ACCOUNT_NUMBER}:{test_queue_name}" test_restricted_policy = { "Version": "2012-10-17", @@ -19,7 +22,7 @@ test_restricted_policy = { "Effect": "Allow", "Principal": {"AWS": {AWS_ACCOUNT_NUMBER}}, "Action": "sqs:ReceiveMessage", - "Resource": topic_arn, + "Resource": test_queue_arn, } ], } @@ -33,7 +36,7 @@ test_public_policy = { "Effect": "Allow", "Principal": "*", "Action": "sqs:ReceiveMessage", - "Resource": topic_arn, + "Resource": test_queue_arn, } ], } @@ -47,7 +50,7 @@ test_public_policy_with_condition_same_account_not_valid = { "Effect": "Allow", "Principal": "*", "Action": "sqs:ReceiveMessage", - "Resource": topic_arn, + "Resource": test_queue_arn, "Condition": { "DateGreaterThan": {"aws:CurrentTime": "2009-01-31T12:00Z"}, "DateLessThan": {"aws:CurrentTime": "2009-01-31T15:00Z"}, @@ -65,7 +68,7 @@ test_public_policy_with_condition_same_account = { "Effect": "Allow", "Principal": "*", "Action": "sqs:ReceiveMessage", - "Resource": topic_arn, + "Resource": test_queue_arn, "Condition": { "StringEquals": {"aws:SourceAccount": f"{AWS_ACCOUNT_NUMBER}"} }, @@ -82,7 +85,7 @@ test_public_policy_with_condition_diff_account = { "Effect": "Allow", "Principal": "*", "Action": "sqs:ReceiveMessage", - "Resource": topic_arn, + "Resource": test_queue_arn, "Condition": {"StringEquals": {"aws:SourceAccount": "111122223333"}}, } ], @@ -110,10 +113,11 @@ class Test_sqs_queues_not_publicly_accessible: sqs_client.queues = [] sqs_client.queues.append( Queue( - id=queue_id, + id=test_queue_url, + name=test_queue_name, region=AWS_REGION, policy=test_restricted_policy, - arn="arn_test", + arn=test_queue_arn, ) ) with mock.patch( @@ -129,8 +133,8 @@ class Test_sqs_queues_not_publicly_accessible: assert len(result) == 1 assert result[0].status == "PASS" assert search("is not public", result[0].status_extended) - assert result[0].resource_id == queue_id - assert result[0].resource_arn == "arn_test" + assert result[0].resource_id == test_queue_url + assert result[0].resource_arn == test_queue_arn assert result[0].resource_tags == [] assert result[0].region == AWS_REGION @@ -139,10 +143,11 @@ class Test_sqs_queues_not_publicly_accessible: sqs_client.queues = [] sqs_client.queues.append( Queue( - id=queue_id, + id=test_queue_url, + name=test_queue_name, region=AWS_REGION, policy=test_public_policy, - arn="arn_test", + arn=test_queue_arn, ) ) with mock.patch( @@ -161,8 +166,8 @@ class Test_sqs_queues_not_publicly_accessible: "is public because its policy allows public access", result[0].status_extended, ) - assert result[0].resource_id == queue_id - assert result[0].resource_arn == "arn_test" + assert result[0].resource_id == test_queue_url + assert result[0].resource_arn == test_queue_arn assert result[0].resource_tags == [] assert result[0].region == AWS_REGION @@ -172,10 +177,11 @@ class Test_sqs_queues_not_publicly_accessible: sqs_client.audited_account = AWS_ACCOUNT_NUMBER sqs_client.queues.append( Queue( - id=queue_id, + id=test_queue_url, + name=test_queue_name, region=AWS_REGION, policy=test_public_policy_with_condition_same_account_not_valid, - arn="arn_test", + arn=test_queue_arn, ) ) with mock.patch( @@ -194,8 +200,8 @@ class Test_sqs_queues_not_publicly_accessible: "is public because its policy allows public access", result[0].status_extended, ) - assert result[0].resource_id == queue_id - assert result[0].resource_arn == "arn_test" + assert result[0].resource_id == test_queue_url + assert result[0].resource_arn == test_queue_arn assert result[0].resource_tags == [] assert result[0].region == AWS_REGION @@ -205,10 +211,11 @@ class Test_sqs_queues_not_publicly_accessible: sqs_client.audited_account = AWS_ACCOUNT_NUMBER sqs_client.queues.append( Queue( - id=queue_id, + id=test_queue_url, + name=test_queue_name, region=AWS_REGION, policy=test_public_policy_with_condition_same_account, - arn="arn_test", + arn=test_queue_arn, ) ) with mock.patch( @@ -225,10 +232,10 @@ class Test_sqs_queues_not_publicly_accessible: assert result[0].status == "PASS" assert ( result[0].status_extended - == f"SQS queue {queue_id} is not public because its policy only allows access from the same account." + == f"SQS queue {test_queue_url} is not public because its policy only allows access from the same account." ) - assert result[0].resource_id == queue_id - assert result[0].resource_arn == "arn_test" + assert result[0].resource_id == test_queue_url + assert result[0].resource_arn == test_queue_arn assert result[0].resource_tags == [] assert result[0].region == AWS_REGION @@ -238,10 +245,11 @@ class Test_sqs_queues_not_publicly_accessible: sqs_client.audited_account = AWS_ACCOUNT_NUMBER sqs_client.queues.append( Queue( - id=queue_id, + id=test_queue_url, + name=test_queue_name, region=AWS_REGION, policy=test_public_policy_with_condition_diff_account, - arn="arn_test", + arn=test_queue_arn, ) ) with mock.patch( @@ -258,9 +266,9 @@ class Test_sqs_queues_not_publicly_accessible: assert result[0].status == "FAIL" assert ( result[0].status_extended - == f"SQS queue {queue_id} is public because its policy allows public access, and the condition does not limit access to resources within the same account." + == f"SQS queue {test_queue_url} is public because its policy allows public access, and the condition does not limit access to resources within the same account." ) - assert result[0].resource_id == queue_id - assert result[0].resource_arn == "arn_test" + assert result[0].resource_id == test_queue_url + assert result[0].resource_arn == test_queue_arn assert result[0].resource_tags == [] assert result[0].region == AWS_REGION diff --git a/tests/providers/aws/services/sqs/sqs_queues_server_side_encryption_enabled/sqs_queues_server_side_encryption_enabled_test.py b/tests/providers/aws/services/sqs/sqs_queues_server_side_encryption_enabled/sqs_queues_server_side_encryption_enabled_test.py index ff1f880803..7afbb48a78 100644 --- a/tests/providers/aws/services/sqs/sqs_queues_server_side_encryption_enabled/sqs_queues_server_side_encryption_enabled_test.py +++ b/tests/providers/aws/services/sqs/sqs_queues_server_side_encryption_enabled/sqs_queues_server_side_encryption_enabled_test.py @@ -8,8 +8,11 @@ AWS_REGION = "eu-west-1" AWS_ACCOUNT_NUMBER = "123456789012" test_kms_key_id = str(uuid4()) -queue_id = str(uuid4()) -topic_arn = f"arn:aws:sqs:{AWS_REGION}:{AWS_ACCOUNT_NUMBER}:{queue_id}" +test_queue_name = str(uuid4()) +test_queue_url = ( + f"https://sqs.{AWS_REGION}.amazonaws.com/{AWS_ACCOUNT_NUMBER}/{test_queue_name}" +) +test_queue_arn = f"arn:aws:sqs:{AWS_REGION}:{AWS_ACCOUNT_NUMBER}:{test_queue_name}" class Test_sqs_queues_server_side_encryption_enabled: @@ -33,10 +36,11 @@ class Test_sqs_queues_server_side_encryption_enabled: sqs_client.queues = [] sqs_client.queues.append( Queue( - id=queue_id, + id=test_queue_url, + name=test_queue_name, region=AWS_REGION, kms_key_id=test_kms_key_id, - arn="arn_test", + arn=test_queue_arn, ) ) with mock.patch( @@ -52,17 +56,18 @@ class Test_sqs_queues_server_side_encryption_enabled: assert len(result) == 1 assert result[0].status == "PASS" assert search("is using Server Side Encryption", result[0].status_extended) - assert result[0].resource_id == queue_id - assert result[0].resource_arn == "arn_test" + assert result[0].resource_id == test_queue_url + assert result[0].resource_arn == test_queue_arn def test_queues_no_encryption(self): sqs_client = mock.MagicMock sqs_client.queues = [] sqs_client.queues.append( Queue( - id=queue_id, + id=test_queue_url, + name=test_queue_name, region=AWS_REGION, - arn="arn_test", + arn=test_queue_arn, ) ) with mock.patch( @@ -80,5 +85,5 @@ class Test_sqs_queues_server_side_encryption_enabled: assert search( "is not using Server Side Encryption", result[0].status_extended ) - assert result[0].resource_id == queue_id - assert result[0].resource_arn == "arn_test" + assert result[0].resource_id == test_queue_url + assert result[0].resource_arn == test_queue_arn diff --git a/tests/providers/aws/services/sqs/sqs_service_test.py b/tests/providers/aws/services/sqs/sqs_service_test.py index c3a71dc518..72779a56dc 100644 --- a/tests/providers/aws/services/sqs/sqs_service_test.py +++ b/tests/providers/aws/services/sqs/sqs_service_test.py @@ -110,9 +110,25 @@ class Test_SQS_Service: sqs = SQS(audit_info) assert len(sqs.queues) == 1 assert sqs.queues[0].id == queue["QueueUrl"] + assert sqs.queues[0].name == test_queue + assert sqs.queues[0].name == sqs.queues[0].arn.split(":")[-1] + assert sqs.queues[0].name == sqs.queues[0].id.split("/")[-1] + assert sqs.queues[0].arn == test_queue_arn assert sqs.queues[0].region == AWS_REGION assert sqs.queues[0].tags == [{"test": "test"}] + # moto does not properly mock this and is hardcoded to return 1000 queues + # so this test currently always fails + # @mock_sqs + # # Test SQS list queues for over 1000 queues + # def test__list_queues__pagination_over_a_thousand(self): + # sqs_client = client("sqs", region_name=AWS_REGION) + # for i in range(0,1050): + # sqs_client.create_queue(QueueName=f"{test_queue}-{i}", tags={"test": "test"}) + # audit_info = self.set_mocked_audit_info() + # sqs = SQS(audit_info) + # assert len(sqs.queues) > 1000 + @mock_sqs # Test SQS list queues def test__get_queue_attributes__(self): diff --git a/tests/providers/azure/lib/regions/regions_test.py b/tests/providers/azure/lib/regions/regions_test.py new file mode 100644 index 0000000000..acf9d2b1f9 --- /dev/null +++ b/tests/providers/azure/lib/regions/regions_test.py @@ -0,0 +1,50 @@ +from azure.identity import AzureAuthorityHosts +from msrestazure.azure_cloud import ( + AZURE_CHINA_CLOUD, + AZURE_GERMAN_CLOUD, + AZURE_US_GOV_CLOUD, +) + +from prowler.providers.azure.lib.regions.regions import get_regions_config + + +class Test_azure_regions: + def test_get_regions_config(self): + allowed_regions = [ + "AzureCloud", + "AzureChinaCloud", + "AzureUSGovernment", + "AzureGermanCloud", + ] + expected_output = { + "AzureCloud": { + "authority": None, + "base_url": "https://management.azure.com", + "credential_scopes": ["https://management.azure.com/.default"], + }, + "AzureChinaCloud": { + "authority": AzureAuthorityHosts.AZURE_CHINA, + "base_url": AZURE_CHINA_CLOUD.endpoints.resource_manager, + "credential_scopes": [ + AZURE_CHINA_CLOUD.endpoints.resource_manager + "/.default" + ], + }, + "AzureUSGovernment": { + "authority": AzureAuthorityHosts.AZURE_GOVERNMENT, + "base_url": AZURE_US_GOV_CLOUD.endpoints.resource_manager, + "credential_scopes": [ + AZURE_US_GOV_CLOUD.endpoints.resource_manager + "/.default" + ], + }, + "AzureGermanCloud": { + "authority": AzureAuthorityHosts.AZURE_GERMANY, + "base_url": AZURE_GERMAN_CLOUD.endpoints.resource_manager, + "credential_scopes": [ + AZURE_GERMAN_CLOUD.endpoints.resource_manager + "/.default" + ], + }, + } + + for region in allowed_regions: + region_config = get_regions_config(region) + assert region_config == expected_output[region] diff --git a/tests/providers/common/audit_info_test.py b/tests/providers/common/audit_info_test.py index d8c9b5d7d5..2f09c986a8 100644 --- a/tests/providers/common/audit_info_test.py +++ b/tests/providers/common/audit_info_test.py @@ -11,7 +11,9 @@ from prowler.providers.azure.azure_provider import Azure_Provider from prowler.providers.azure.lib.audit_info.models import ( Azure_Audit_Info, Azure_Identity_Info, + Azure_Region_Config, ) +from prowler.providers.azure.lib.exception.exception import AzureException from prowler.providers.common.audit_info import ( Audit_Info, get_tagged_resources, @@ -31,6 +33,7 @@ mock_azure_audit_info = Azure_Audit_Info( audit_metadata=None, audit_resources=None, audit_config=None, + azure_region_config=Azure_Region_Config(), ) mock_set_audit_info = Audit_Info() @@ -132,8 +135,8 @@ class Test_Set_Audit_Info: "prowler.providers.common.audit_info.azure_audit_info", new=mock_azure_audit_info, ) - @patch.object(Azure_Provider, "__set_credentials__", new=mock_set_azure_credentials) - @patch.object(Azure_Provider, "__set_identity_info__", new=mock_set_identity_info) + @patch.object(Azure_Provider, "__get_credentials__", new=mock_set_azure_credentials) + @patch.object(Azure_Provider, "__get_identity_info__", new=mock_set_identity_info) def test_set_audit_info_azure(self): provider = "azure" arguments = { @@ -150,11 +153,109 @@ class Test_Set_Audit_Info: "browser_auth": None, "managed_entity_auth": None, "config_file": default_config_file_path, + "azure_region": "AzureCloud", } audit_info = set_provider_audit_info(provider, arguments) assert isinstance(audit_info, Azure_Audit_Info) + @patch( + "prowler.providers.common.audit_info.azure_audit_info", + new=mock_azure_audit_info, + ) + @patch.object(Azure_Provider, "__get_credentials__", new=mock_set_azure_credentials) + @patch.object(Azure_Provider, "__get_identity_info__", new=mock_set_identity_info) + def test_set_azure_audit_info_not_auth_methods(self): + arguments = { + "profile": None, + "role": None, + "session_duration": None, + "external_id": None, + "regions": None, + "organizations_role": None, + "subscriptions": None, + # We need to set exactly one auth method + "az_cli_auth": None, + "sp_env_auth": None, + "browser_auth": None, + "managed_entity_auth": None, + "config_file": default_config_file_path, + "azure_region": "AzureCloud", + } + + with pytest.raises(AzureException) as exception: + _ = Audit_Info().set_azure_audit_info(arguments) + assert exception.type == AzureException + assert ( + exception.value.args[0] + == "Azure provider requires at least one authentication method set: [--az-cli-auth | --sp-env-auth | --browser-auth | --managed-identity-auth]" + ) + + @patch( + "prowler.providers.common.audit_info.azure_audit_info", + new=mock_azure_audit_info, + ) + @patch.object(Azure_Provider, "__get_credentials__", new=mock_set_azure_credentials) + @patch.object(Azure_Provider, "__get_identity_info__", new=mock_set_identity_info) + def test_set_azure_audit_info_browser_auth_but_not_tenant_id(self): + arguments = { + "profile": None, + "role": None, + "session_duration": None, + "external_id": None, + "regions": None, + "organizations_role": None, + "subscriptions": None, + # We need to set exactly one auth method + "az_cli_auth": None, + "sp_env_auth": None, + "browser_auth": True, + "managed_entity_auth": None, + "config_file": default_config_file_path, + "azure_region": "AzureCloud", + } + + with pytest.raises(AzureException) as exception: + _ = Audit_Info().set_azure_audit_info(arguments) + assert exception.type == AzureException + assert ( + exception.value.args[0] + == "Azure Tenant ID (--tenant-id) is required only for browser authentication mode" + ) + + @patch( + "prowler.providers.common.audit_info.azure_audit_info", + new=mock_azure_audit_info, + ) + @patch.object(Azure_Provider, "__get_credentials__", new=mock_set_azure_credentials) + @patch.object(Azure_Provider, "__get_identity_info__", new=mock_set_identity_info) + def test_set_azure_audit_info_tenant_id_but_no_browser_auth(self): + arguments = { + "profile": None, + "role": None, + "session_duration": None, + "external_id": None, + "regions": None, + "organizations_role": None, + "subscriptions": None, + # We need to set exactly one auth method + "az_cli_auth": True, + "sp_env_auth": None, + "browser_auth": None, + "managed_entity_auth": None, + "config_file": default_config_file_path, + "azure_region": "AzureCloud", + "tenant_id": "test-tenant-id", + } + + with pytest.raises(AzureException) as exception: + _ = Audit_Info().set_azure_audit_info(arguments) + assert exception.type == AzureException + assert ( + exception.value.args[0] + == "Azure Tenant ID (--tenant-id) is required only for browser authentication mode" + ) + @patch.object(GCP_Provider, "__set_credentials__", new=mock_set_gcp_credentials) @patch.object(GCP_Provider, "get_project_ids", new=mock_get_project_ids) @patch.object(Audit_Info, "print_gcp_credentials", new=mock_print_audit_credentials) diff --git a/tests/providers/common/clean_test.py b/tests/providers/common/clean_test.py new file mode 100644 index 0000000000..7b58217a77 --- /dev/null +++ b/tests/providers/common/clean_test.py @@ -0,0 +1,87 @@ +import importlib +import logging +import tempfile +from argparse import Namespace +from os import path + +from mock import patch + +from prowler.providers.common.clean import clean_provider_local_output_directories + + +class Test_Common_Clean: + def set_provider_input_args(self, provider): + set_args_function = f"set_{provider}_input_args" + args = getattr( + getattr(importlib.import_module(__name__), __class__.__name__), + set_args_function, + )(self) + return args + + def set_aws_input_args(self): + args = Namespace() + args.provider = "aws" + args.output_bucket = "test-bucket" + args.output_bucket_no_assume = None + return args + + def set_azure_input_args(self): + args = Namespace() + args.provider = "azure" + return args + + def test_clean_provider_local_output_directories_non_initialized(self, caplog): + provider = "azure" + input_args = self.set_provider_input_args(provider) + caplog.set_level(logging.INFO) + clean_provider_local_output_directories(input_args) + assert ( + f"Cleaning local output directories not initialized for provider {provider}:" + in caplog.text + ) + + def test_clean_aws_local_output_directories_non_default_dir_output_bucket(self): + provider = "aws" + input_args = self.set_provider_input_args(provider) + with tempfile.TemporaryDirectory() as temp_dir: + input_args.output_directory = temp_dir + clean_provider_local_output_directories(input_args) + assert not path.exists(input_args.output_directory) + + def test_clean_aws_local_output_directories_non_default_dir_output_bucket_no_assume( + self, + ): + provider = "aws" + input_args = self.set_provider_input_args(provider) + input_args.output_bucket = None + input_args.output_bucket_no_assume = "test" + with tempfile.TemporaryDirectory() as temp_dir: + input_args.output_directory = temp_dir + clean_provider_local_output_directories(input_args) + assert not path.exists(input_args.output_directory) + + def test_clean_aws_local_output_directories_default_dir_output_bucket(self): + provider = "aws" + input_args = self.set_provider_input_args(provider) + with tempfile.TemporaryDirectory() as temp_dir: + with patch( + "prowler.providers.common.clean.default_output_directory", new=temp_dir + ): + input_args.output_directory = temp_dir + clean_provider_local_output_directories(input_args) + assert path.exists(input_args.output_directory) + + def test_clean_aws_local_output_directories_default_dir_output_bucket_no_assume( + self, + ): + provider = "aws" + input_args = self.set_provider_input_args(provider) + input_args.output_bucket_no_assume = "test" + input_args.ouput_bucket = None + with tempfile.TemporaryDirectory() as temp_dir: + with patch( + "prowler.providers.common.clean.default_output_directory", new=temp_dir + ): + input_args.output_directory = temp_dir + clean_provider_local_output_directories(input_args) + assert path.exists(input_args.output_directory) diff --git a/tests/providers/common/common_outputs_test.py b/tests/providers/common/common_outputs_test.py index a756b72315..3e24091b65 100644 --- a/tests/providers/common/common_outputs_test.py +++ b/tests/providers/common/common_outputs_test.py @@ -9,12 +9,14 @@ from prowler.providers.aws.lib.audit_info.audit_info import AWS_Audit_Info from prowler.providers.azure.lib.audit_info.audit_info import ( Azure_Audit_Info, Azure_Identity_Info, + Azure_Region_Config, ) from prowler.providers.common.models import Audit_Metadata from prowler.providers.common.outputs import ( Aws_Output_Options, Azure_Output_Options, Gcp_Output_Options, + get_provider_output_model, set_provider_output_options, ) from prowler.providers.gcp.lib.audit_info.models import GCP_Audit_Info @@ -33,6 +35,7 @@ class Test_Common_Output_Options: audit_metadata=None, audit_resources=None, audit_config=None, + azure_region_config=Azure_Region_Config(), ) return audit_info @@ -332,7 +335,7 @@ class Test_Common_Output_Options: AWS Account: {audit_info.audited_account}
  • - AWS-CLI Profile: {audit_info.profile} + AWS-CLI Profile: default
  • Audited Regions: All Regions @@ -391,3 +394,16 @@ class Test_Common_Output_Options: """ ) + + def test_get_provider_output_model(self): + audit_info_class_names = [ + "AWS_Audit_Info", + "GCP_Audit_Info", + "Azure_Audit_Info", + ] + for class_name in audit_info_class_names: + provider_prefix = class_name.split("_", 1)[0].lower().capitalize() + assert ( + get_provider_output_model(class_name).__name__ + == f"{provider_prefix}_Check_Output_CSV" + )