From ed16034a253adcbf102b1d3feedfedaefa54d8fb Mon Sep 17 00:00:00 2001 From: Sergio Garcia <38561120+sergargar@users.noreply.github.com> Date: Thu, 11 May 2023 16:30:04 +0200 Subject: [PATCH] fix(README): order providers alphbetically (#2344) --- README.md | 53 +++++++++++++++++++++++------------------------------ 1 file changed, 23 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 43d10f63..e4f802a7 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,6 @@ Python Version PyPI Prowler Downloads PyPI Prowler-Cloud Downloads - Brew Prowler Downloads Docker Pulls Docker Docker @@ -116,22 +115,6 @@ Those credentials must be associated to a user or role with proper permissions t > If you want Prowler to send findings to [AWS Security Hub](https://aws.amazon.com/security-hub), make sure you also attach the custom policy [prowler-security-hub.json](https://github.com/prowler-cloud/prowler/blob/master/permissions/prowler-security-hub.json). -## Google Cloud Platform - -Prowler will follow the same credentials search as [Google authentication libraries](https://cloud.google.com/docs/authentication/application-default-credentials#search_order): - -1. [GOOGLE_APPLICATION_CREDENTIALS environment variable](https://cloud.google.com/docs/authentication/application-default-credentials#GAC) -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 - -> `prowler` will scan the project associated with the credentials. - ## Azure Prowler for Azure supports the following authentication types: @@ -180,6 +163,22 @@ Regarding the subscription scope, Prowler by default scans all the subscriptions - `Reader` +## Google Cloud Platform + +Prowler will follow the same credentials search as [Google authentication libraries](https://cloud.google.com/docs/authentication/application-default-credentials#search_order): + +1. [GOOGLE_APPLICATION_CREDENTIALS environment variable](https://cloud.google.com/docs/authentication/application-default-credentials#GAC) +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 + +> `prowler` will scan the project associated with the credentials. + # 💻 Basic Usage To run prowler, you will need to specify the provider (e.g aws or azure): @@ -245,14 +244,6 @@ prowler aws --profile custom-profile -f us-east-1 eu-south-2 ``` > By default, `prowler` will scan all AWS regions. -## Google Cloud Platform - -Optionally, you can provide the location of an application credential JSON file with the following argument: - -```console -prowler gcp --credentials-file path -``` - ## Azure With Azure you need to specify which auth method is going to be used: @@ -262,12 +253,14 @@ prowler azure [--sp-env-auth, --az-cli-auth, --browser-auth, --managed-identity- ``` > By default, `prowler` will scan all Azure subscriptions. -# 🎉 New Features +## Google Cloud Platform + +Optionally, you can provide the location of an application credential JSON file with the following argument: + +```console +prowler gcp --credentials-file path +``` -- Python: we got rid of all bash and it is now all in Python. -- Faster: huge performance improvements (same account from 2.5 hours to 4 minutes). -- Developers and community: we have made it easier to contribute with new checks and new compliance frameworks. We also included unit tests. -- Multi-cloud: in addition to AWS, we have added Azure, we plan to include GCP and OCI soon, let us know if you want to contribute! # 📃 License