From b7985e8103bff7645d9d31fc837546166dcd24fa Mon Sep 17 00:00:00 2001 From: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com> Date: Mon, 6 May 2024 21:07:02 -0400 Subject: [PATCH] Adds kibana namespace requirement to CNVM and CSPM (#5154) * Updates requirements section for CNVM and CSPM * minor updates - adds attribute (cherry picked from commit 5df1b3a2863e3b27884fa77b42b108bd9ea866da) # Conflicts: # docs/cloud-native-security/cspm-get-started-aws.asciidoc # docs/cloud-native-security/cspm-get-started-azure.asciidoc # docs/cloud-native-security/cspm-get-started-gcp.asciidoc # docs/cloud-native-security/cspm.asciidoc --- .../cspm-get-started-aws.asciidoc | 283 ++++++++++++++++++ .../cspm-get-started-azure.asciidoc | 171 +++++++++++ .../cspm-get-started-gcp.asciidoc | 168 +++++++++++ docs/cloud-native-security/cspm.asciidoc | 7 + .../vuln-management-get-started.asciidoc | 1 + .../vuln-management-overview.asciidoc | 1 + 6 files changed, 631 insertions(+) create mode 100644 docs/cloud-native-security/cspm-get-started-aws.asciidoc create mode 100644 docs/cloud-native-security/cspm-get-started-azure.asciidoc create mode 100644 docs/cloud-native-security/cspm-get-started-gcp.asciidoc diff --git a/docs/cloud-native-security/cspm-get-started-aws.asciidoc b/docs/cloud-native-security/cspm-get-started-aws.asciidoc new file mode 100644 index 0000000000..4870f9ae62 --- /dev/null +++ b/docs/cloud-native-security/cspm-get-started-aws.asciidoc @@ -0,0 +1,283 @@ +[[cspm-get-started]] += Get started with CSPM for AWS + +[discrete] +[[cspm-overview]] +== Overview + +This page explains how to get started monitoring the security posture of your cloud assets using the Cloud Security Posture Management (CSPM) feature. + +.Requirements +[sidebar] +-- +* The CSPM integration is available to all {ecloud} users. On-premise deployments require an https://www.elastic.co/pricing[Enterprise subscription]. +* CSPM only works in the `Default` {kib} space. Installing the CSPM integration on a different {kib} space will not work. +* CSPM is supported on commercial cloud only. Government cloud is not supported (https://github.com/elastic/enhancements[request support]). +* To view posture data, you need `read` privileges for the following {es} indices: +** `logs-cloud_security_posture.findings_latest-*` +** `logs-cloud_security_posture.scores-*` +** `Logs-cloud_security_posture.findings` +* The user who gives the CSPM integration AWS permissions must be an AWS account `admin`. +-- + +[discrete] +[[cspm-setup]] +== Set up CSPM for AWS + +You can set up CSPM for AWS either by enroling a single cloud account, or by enroling an organization containing multiple accounts. Either way, first you will add the CSPM integration, then enable cloud account access. + +[discrete] +[[cspm-add-and-name-integration]] +== Add the CSPM integration +. From the Elastic Security *Get started* page, click *Add integrations*. +. Search for `CSPM`, then click on the result. +. Click *Add Cloud Security Posture Management (CSPM)*. +. Select *AWS*, then either *AWS Organization* to onboard multiple accounts, or *Single Account* to onboard an individual account. +. Give your integration a name that matches the purpose or team of the AWS account/organization you want to monitor, for example, `dev-aws-account`. + + +[discrete] +[[cspm-set-up-cloud-access-section]] +== Set up cloud account access +The CSPM integration requires access to AWS’s built-in https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_job-functions.html#jf_security-auditor[`SecurityAudit` IAM policy] in order to discover and evaluate resources in your cloud account. There are several ways to provide access. + +For most use cases, the simplest option is to use AWS CloudFormation to automatically provision the necessary resources and permissions in your AWS account. This method, as well as several manual options, are described below. + +[discrete] +[[cspm-set-up-cloudformation]] +=== CloudFormation (recommended) +. In the *Add Cloud Security Posture Management (CSPM) integration* menu, under *Setup Access*, select *CloudFormation*. +. In a new browser tab or window, log in as an admin to the AWS account or organization you want to onboard. +. Return to your {kib} tab. Click *Save and continue* at the bottom of the page. +. Review the information, then click *Launch CloudFormation*. +. A CloudFormation template appears in a new browser tab. +. For organization-level deployments only, you must enter the ID of the organizational unit where you want to deploy into the `OrganizationalUnitIds` field in the CloudFormation template. You can find it in the AWS console under *AWS Organizations -> AWS Accounts* (it appears under the organization name). +. (Optional) Switch to the AWS region where you want to deploy using the controls in the upper right corner. +. Tick the checkbox under *Capabilities* to authorize the creation of necessary resources. ++ +image::images/cspm-cloudformation-template.png[The Add permissions screen in AWS] ++ +. At the bottom of the template, select *Create stack*. + +When you return to {kib}, click *View assets* to review the data being collected by your new integration. + + +[discrete] +[[cspm-setup-organization-manual]] +== Manual authentication for organization-level onboarding + +NOTE: If you're onboarding a single account instead of an organization, skip this section. + +When using manual authentication to onboard at the organization level, you need to configure the necessary permissions using the AWS console for the organization where you want to deploy: + +* In the organization's management account (root account), create an IAM role called `cloudbeat-root` (the name is important). The role needs several policies: + +** The following inline policy: + +.Click to expand policy +[%collapsible] +==== +``` +{ + "Version": "2012-10-17", + "Statement": [ + { + "Action": [ + "organizations:List*", + "organizations:Describe*" + ], + "Resource": "*", + "Effect": "Allow" + }, + { + "Action": [ + "sts:AssumeRole" + ], + "Resource": "*", + "Effect": "Allow" + } + ] +} +``` +==== + +** The following trust policy: + +.Click to expand policy +[%collapsible] +==== +``` +{ + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam:::root" + }, + "Action": "sts:AssumeRole" + }, + { + "Effect": "Allow", + "Principal": { + "Service": "ec2.amazonaws.com" + }, + "Action": "sts:AssumeRole" + } + ] +} +``` +==== + +** The AWS-managed `SecurityAudit` policy. + +IMPORTANT: You must replace `` in the trust policy with your AWS account ID. + +* Next, for each account you want to scan in the organization, create an IAM role named `cloudbeat-securityaudit` with the following policies: +** The AWS-managed `SecurityAudit` policy. +** The following trust policy: + +.Click to expand policy +[%collapsible] +==== +``` +{ + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam:::role/cloudbeat-root" + }, + "Action": "sts:AssumeRole" + } + ] +} +``` +==== + +IMPORTANT: You must replace `` in the trust policy with your AWS account ID. + +After creating the necessary roles, authenticate using one of the manual authentication methods. + +IMPORTANT: When deploying to an organization using any of the authentication methods below, you need to make sure that the credentials you provide grant permission to assume `cloudbeat-root` privileges. + +[discrete] +[[cspm-set-up-manual]] +== Manual authentication methods + +* <> +* <> +* <> +* <> +* <> + +IMPORTANT: Whichever method you use to authenticate, make sure AWS’s built-in https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_job-functions.html#jf_security-auditor[`SecurityAudit` IAM policy] is attached. + +[discrete] +[[cspm-use-instance-role]] +=== Option 1 - Default instance role + +NOTE: If you are deploying to an AWS organization instead of an AWS account, you should already have <>, `cloudbeat-root`. Skip to step 2 "Attach your new IAM role to an EC2 instance", and attach this role. You can use either an existing or new EC2 instance. + +Follow AWS's https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html[IAM roles for Amazon EC2] documentation to create an IAM role using the IAM console, which automatically generates an instance profile. + +. Create an IAM role: +.. In AWS, go to your IAM dashboard. Click *Roles*, then *Create role*. +.. On the *Select trusted entity* page, under **Trusted entity type**, select *AWS service*. +.. Under **Use case**, select *EC2*. Click *Next*. ++ +image::images/cspm-aws-auth-1.png[The Select trusted entity screen in AWS] ++ +.. On the *Add permissions* page, search for and select `SecurityAudit`. Click *Next*. ++ +image::images/cspm-aws-auth-2.png[The Add permissions screen in AWS] ++ +.. On the *Name, review, and create* page, name your role, then click *Create role*. +. Attach your new IAM role to an EC2 instance: +.. In AWS, select an EC2 instance. +.. Select *Actions > Security > Modify IAM role*. ++ +image::images/cspm-aws-auth-3.png[The EC2 page in AWS, showing the Modify IAM role option] ++ +.. On the *Modify IAM role* page, search for and select your new IAM role. +.. Click *Update IAM role*. +.. Return to {kib} and <>. + +IMPORTANT: Make sure to deploy the CSPM integration to this EC2 instance. When completing setup in {kib}, in the *Setup Access* section, select *Assume role* and leave *Role ARN* empty. Click *Save and continue*. + +[discrete] +[[cspm-use-keys-directly]] +=== Option 2 - Direct access keys +Access keys are long-term credentials for an IAM user or AWS account root user. To use access keys as credentials, you must provide the `Access key ID` and the `Secret Access Key`. After you provide credentials, <>. + +For more details, refer to https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html[Access Keys and Secret Access Keys]. + +IMPORTANT: You must select *Programmatic access* when creating the IAM user. + +[discrete] +[[cspm-use-temp-credentials]] +=== Option 3 - Temporary security credentials +You can configure temporary security credentials in AWS to last for a specified duration. They consist of an access key ID, a secret access key, and a security token, which is typically found using `GetSessionToken`. + +Because temporary security credentials are short term, once they expire, you will need to generate new ones and manually update the integration's configuration to continue collecting cloud posture data. Update the credentials before they expire to avoid data loss. + +NOTE: IAM users with multi-factor authentication (MFA) enabled need to submit an MFA code when calling `GetSessionToken`. For more details, refer to AWS's https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html[Temporary Security Credentials] documentation. + +You can use the AWS CLI to generate temporary credentials. For example, you could use the following command if you have MFA enabled: + +[source,console] +---------------------------------- +sts get-session-token --serial-number arn:aws:iam::1234:mfa/your-email@example.com --duration-seconds 129600 --token-code 123456 +---------------------------------- + +The output from this command includes the following fields, which you should provide when configuring the KSPM integration: + +* `Access key ID`: The first part of the access key. +* `Secret Access Key`: The second part of the access key. +* `Session Token`: The required token when using temporary security credentials. + +After you provide credentials, <>. + +[discrete] +[[cspm-use-a-shared-credentials-file]] +=== Option 4 - Shared credentials file +If you use different AWS credentials for different tools or applications, you can use profiles to define multiple access keys in the same configuration file. For more details, refer to AWS' https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html[Shared Credentials Files] documentation. + +Instead of providing the `Access key ID` and `Secret Access Key` to the integration, provide the information required to locate the access keys within the shared credentials file: + +* `Credential Profile Name`: The profile name in the shared credentials file. +* `Shared Credential File`: The directory of the shared credentials file. + +If you don't provide values for all configuration fields, the integration will use these defaults: + +- If `Access key ID`, `Secret Access Key`, and `ARN Role` are not provided, then the integration will check for `Credential Profile Name`. +- If there is no `Credential Profile Name`, the default profile will be used. +- If `Shared Credential File` is empty, the default directory will be used. + - For Linux or Unix, the shared credentials file is located at `~/.aws/credentials`. + +After providing credentials, <>. + +[discrete] +[[cspm-use-iam-arn]] +=== Option 5 - IAM role Amazon Resource Name (ARN) +An IAM role Amazon Resource Name (ARN) is an IAM identity that you can create in your AWS account. You define the role's permissions. Roles do not have standard long-term credentials such as passwords or access keys. Instead, when you assume a role, it provides temporary security credentials for your session. + +To use an IAM role ARN, select *Assume role* under *Preferred manual method*, enter the ARN, and continue to Finish manual setup. + +[discrete] +[[cspm-finish-manual]] +== Finish manual setup +Once you’ve provided AWS credentials, under *Where to add this integration*: + +If you want to monitor an AWS account or organization where you have not yet deployed {agent}: + +* Select *New Hosts*. +* Name the {agent} policy. Use a name that matches the purpose or team of the cloud account or accounts you want to monitor. For example, `dev-aws-account`. +* Click *Save and continue*, then *Add {agent} to your hosts*. The *Add agent* wizard appears and provides {agent} binaries, which you can download and deploy to your AWS account. + +If you want to monitor an AWS account or organization where you have already deployed {agent}: + +* Select **Existing hosts**. +* Select an agent policy that applies the AWS account you want to monitor. +* Click **Save and continue**. diff --git a/docs/cloud-native-security/cspm-get-started-azure.asciidoc b/docs/cloud-native-security/cspm-get-started-azure.asciidoc new file mode 100644 index 0000000000..732e2ae8cd --- /dev/null +++ b/docs/cloud-native-security/cspm-get-started-azure.asciidoc @@ -0,0 +1,171 @@ +[[cspm-get-started-azure]] += Get started with CSPM for Azure + +[discrete] +[[cspm-overview-azure]] +== Overview + +This page explains how to get started monitoring the security posture of your cloud assets using the Cloud Security Posture Management (CSPM) feature. + +.Requirements +[sidebar] +-- +* The CSPM integration is available to all {ecloud} users. On-premise deployments require an https://www.elastic.co/pricing[Enterprise subscription]. +* CSPM only works in the `Default` {kib} space. Installing the CSPM integration on a different {kib} space will not work. +* CSPM is supported on commercial cloud only. Government cloud is not supported (https://github.com/elastic/enhancements[request support]). +* To view posture data, you need `read` privileges for the following {es} indices: +** `logs-cloud_security_posture.findings_latest-*` +** `logs-cloud_security_posture.scores-*` +** `logs-cloud_security_posture.findings` +* The user who gives the CSPM integration permissions in Azure must be an Azure subscription `admin`. +-- + +[discrete] +[[cspm-setup-azure]] +== Set up CSPM for Azure + +You can set up CSPM for Azure by by enrolling an Azure organization (management group) containing multiple subscriptions, or by enrolling a single subscription. Either way, first add the CSPM integration, then enable cloud account access. + + +[discrete] +[[cspm-add-and-name-integration-azure]] +=== Add your CSPM integration +. From the Elastic Security *Get started* page, click *Add integrations*. +. Search for `CSPM`, then click on the result. +. Click *Add Cloud Security Posture Management (CSPM)*. +. Under **Configure integration**, select **Azure**, then select either **Azure Organization** or **Single Subscription**, depending on which resources you want to monitor. +. Give your integration a name that matches the purpose or team of the Azure resources you want to monitor, for example, `azure-CSPM-dev-1`. + +[discrete] +[[cspm-set-up-cloud-access-section-azure]] +=== Set up cloud account access + +NOTE: To set up CSPM for an Azure organization or subscription, you will need admin privileges for that organization or subscription. + +For most users, the simplest option is to use an Azure Resource Manager (ARM) template to automatically provision the necessary resources and permissions in Azure. If you prefer a more hands-on approach or require a specific configuration not supported by the ARM template, you can use one of the manual setup options described below. + +[discrete] +[[cspm-set-up-ARM]] +== ARM template setup (recommended) + +NOTE: If you are deploying to an Azure organization, you need the following permissions: `Microsoft.Resources/deployments/*`, `Microsoft.Authorization/roleAssignments/write`. You also need to https://learn.microsoft.com/en-us/azure/role-based-access-control/elevate-access-global-admin[elevate access to manage all Azure subscriptions and management groups]. + +. Under *Setup Access*, select *ARM Template*. +. Under **Where to add this integration**: +.. Select **New Hosts**. +.. Name the {agent} policy. Use a name that matches the resources you want to monitor. For example, `azure-dev-policy`. Click **Save and continue**. The *ARM Template deployment* window appears. +.. In a new tab, log in to the Azure portal, then return to {kib} and click **Launch ARM Template**. This will open the ARM template in Azure. +.. If you are deploying to an Azure organization, select the management group you want to monitor from the drop-down menu. Next, enter the subscription ID of the subscription where you want to deploy the VM that will scan your resources. +.. Copy the `Fleet URL` and `Enrollment Token` that appear in {kib} to the corresponding fields in the ARM Template, then click **Review + create**. +.. (Optional) Change the `Resource Group Name` parameter. Otherwise the name of the resource group defaults to a timestamp prefixed with `cloudbeat-`. +. Return to {kib} and wait for the confirmation of data received from your new integration. Then you can click **View Assets** to see your data. + +[discrete] +[[cspm-set-up-manual-azure]] +== Manual setup + +For manual setup, multiple authentication methods are available: + +* Managed identity (recommended) +* Service principal with client secret +* Service principal with client certificate + +[discrete] +[[cspm-azure-managed-identity-setup]] +=== Option 1: Managed identity (recommended) + +This method involves creating an Azure VM (or using an existing one), giving it read access to the resources you want to monitor with CSPM, and installing {agent} on it. + +. Go to the Azure portal to https://portal.azure.com/#create/Microsoft.VirtualMachine-ARM[create a new Azure VM]. +. Follow the setup process, and make sure you enable **System assigned managed identity** under the **Management** tab. +. Go to your Azure subscription list and select the subscription or management group you want to monitor with CSPM. +. Go to **Access control (IAM)**, and select **Add Role Assignment**. +. Select the `Reader` function role, assign access to **Managed Identity**, then select your VM. + +After assigning the role: + +. Return to the **Add CSPM** page in {kib}. +. Under **Configure integration**, select **Azure**. Under **Setup access**, select **Manual**. +. Under **Where to add this integration**, select **New hosts**. +. Click **Save and continue**, then follow the instructions to install {agent} on your Azure VM. + +Wait for the confirmation that {kib} received data from your new integration. Then you can click **View Assets** to see your data. + +[discrete] +[[cspm-azure-client-secret]] +=== Option 2: Service principal with client secret + +Before using this method, you must have set up a https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in[Microsoft Entra application and service principal that can access resources]. + +. On the **Add Cloud Security Posture Management (CSPM) integration** page, scroll to the **Setup access** section, then select **Manual**. +. Under **Preferred manual method**, select **Service principal with Client Secret**. +. Go to the **Registered apps** section of https://ms.portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps[Microsoft Entra ID]. +. Click on **New Registration**, name your app and click **Register**. +. Copy your new app's `Directory (tenant) ID` and `Application (client) ID`. Paste them into the corresponding fields in {kib}. +. Return to the Azure portal. Select **Certificates & secrets**, then go to the **Client secrets** tab. Click **New client secret**. +. Copy the new secret. Paste it into the corresponding field in {kib}. +. Return to Azure. Go to your Azure subscription list and select the subscription or management group you want to monitor with CSPM. +. Go to **Access control (IAM)** and select **Add Role Assignment**. +. Select the `Reader` function role, assign access to **User, group, or service principal**, and select your new app. +. Return to the **Add CSPM** page in {kib}. +. Under **Where to add this integration**, select **New hosts**. +. Click **Save and continue**, then follow the instructions to install {agent} on your selected host. + +Wait for the confirmation that {kib} received data from your new integration. Then you can click **View Assets** to see your data. + +[discrete] +[[cspm-azure-client-certificate]] +=== Option 3: Service principal with client certificate + +Before using this method, you must have set up a https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in[Microsoft Entra application and service principal that can access resources]. + +. On the **Add Cloud Security Posture Management (CSPM) integration** page, under **Setup access**, select **Manual**. +. Under **Preferred manual method**, select **Service principal with client certificate**. +. Go to the **Registered apps** section of https://ms.portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps[Microsoft Entra ID]. +. Click on **New Registration**, name your app and click **Register**. +. Copy your new app's `Directory (tenant) ID` and `Application (client) ID`. Paste them into the corresponding fields in {kib}. +. Return to Azure. Go to your Azure subscription list and select the subscription or management group you want to monitor with CSPM. +. Go to **Access control (IAM)** and select **Add Role Assignment**. +. Select the `Reader` function role, assign access to **User, group, or service principal**, and select your new app. + +Next, create a certificate. If you intend to use a password-protected certificate, you must use a pkcs12 certificate. Otherwise, you must use a pem certificate. + +Create a pkcs12 certificate, for example: +```shell +# Create PEM file +openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes + +# Create pkcs12 bundle using legacy flag (CLI will ask for export password) +openssl pkcs12 -legacy -export -out bundle.p12 -inkey key.pem -in cert.pem +``` + +Create a PEM certificate, for example: +```shell +# Generate certificate signing request (csr) and key +openssl req -new -newkey rsa:4096 -nodes -keyout cert.key -out cert.csr + +# Generate PEM and self-sign with key +openssl x509 -req -sha256 -days 365 -in cert.csr -signkey cert.key -out signed.pem + +# Create bundle +cat cert.key > bundle.pem +cat signed.pem >> bundle.pem +``` + +After creating your certificate: + +. Return to Azure. +. Navigate to the **Certificates & secrets** menu. Select the **Certificates** tab. +. Click **Upload certificate**. +.. If you're using a PEM certificate that was created using the example commands above, upload `signed.pem`. +.. If you're using a pkcs12 certificate that was created using the example commands above, upload `cert.pem`. +. Upload the certificate bundle to the VM where you will deploy {agent}. +.. If you're using a PEM certificate that was created using the example commands above, upload `bundle.pem`. +.. If you're using a pkcs12 certificate that was created using the example commands above, upload `bundle.p12`. +. Return to the **Add CSPM** page in {kib}. +. For **Client Certificate Path**, enter the full path to the certificate that you uploaded to the host where you will install {agent}. +. If you used a pkcs12 certificate, enter its password under **Client Certificate Password**. +. Under **Where to add this integration**, select **New hosts**. +. Click **Save and continue**, then follow the instructions to install {agent} on your selected host. + +Wait for the confirmation that {kib} received data from your new integration. Then you can click **View Assets** to see your data. diff --git a/docs/cloud-native-security/cspm-get-started-gcp.asciidoc b/docs/cloud-native-security/cspm-get-started-gcp.asciidoc new file mode 100644 index 0000000000..3745844ae5 --- /dev/null +++ b/docs/cloud-native-security/cspm-get-started-gcp.asciidoc @@ -0,0 +1,168 @@ +[[cspm-get-started-gcp]] += Get started with CSPM for GCP + +[discrete] +[[cspm-overview-gcp]] +== Overview + +This page explains how to get started monitoring the security posture of your GCP cloud assets using the Cloud Security Posture Management (CSPM) feature. + +.Requirements +[sidebar] +-- +* The CSPM integration is available to all {ecloud} users. On-premise deployments require an https://www.elastic.co/pricing[Enterprise subscription]. +* CSPM only works in the `Default` {kib} space. Installing the CSPM integration on a different {kib} space will not work. +* CSPM is supported on commercial cloud only. Government cloud is not supported (https://github.com/elastic/enhancements[request support]). +* To view posture data, you need `read` privileges for the following {es} indices: +** `logs-cloud_security_posture.findings_latest-*` +** `logs-cloud_security_posture.scores-*` +** `Logs-cloud_security_posture.findings` +* The user who gives the CSPM integration GCP permissions must be a GCP project `admin`. +-- + +[discrete] +[[cspm-setup-gcp]] +== Initial setup + +You can set up CSPM for GCP either by enroling a single project, or by enroling an organization containing multiple projects. Either way, you need to first add the CSPM integration, then enable cloud account access. + + +[discrete] +[[cspm-add-and-name-integration-gcp]] +=== Add your CSPM integration +. From the Elastic Security *Get started* page, click *Add integrations*. +. Search for `CSPM`, then click on the result. +. Click *Add Cloud Security Posture Management (CSPM)*. +. Under *Configure integration*, select *GCP*, then either *GCP Organization* (recommended) or *Single Account*. +. Give your integration a name that matches the purpose or team of the GCP account you want to monitor, for example, `dev-gcp-project`. + + +[discrete] +[[cspm-set-up-cloud-access-section-gcp]] +=== Set up cloud account access + +NOTE: To set up CSPM for a GCP project, you need admin privileges for the project. + +For most users, the simplest option is to use a Google Cloud Shell script to automatically provision the necessary resources and permissions in your GCP account. This method, as well as two manual options, are described below. + +[discrete] +[[cspm-set-up-cloudshell]] +== Cloud Shell script setup (recommended) + +. Under **Setup Access**, select **Google Cloud Shell**. Enter your GCP Project ID, and for GCP Organization deployments, your GCP Organization ID. +. Under **Where to add this integration**: +.. Select **New Hosts**. +.. Name the {agent} policy. Use a name that matches the purpose or team of the cloud account or accounts you want to monitor. For example, `dev-gcp-account`. +.. Click **Save and continue**, then **Add {agent} to your hosts**. The **Add agent** wizard appears and provides {agent} binaries, which you can download and deploy to a VM in your GCP account. +. Click **Save and continue**. +. Copy the command that appears, then click **Launch Google Cloud Shell**. It opens in a new window. +. Check the box to trust Elastic's `cloudbeat` repo, then click **Confirm** ++ +image::images/cspm-cloudshell-trust.png[The cloud shell confirmation popup] ++ +NOTE: Google has deprecated its old Cloud Shell editor. If you continue to use it, you may encounter the following message: ++ +image::images/cspm-cloudshell-old-editor.png[The cloud shell switch editor popup] ++ +If the message appears, click **X** or **Try the new Editor** and follow the next steps. When you switch to the new editor, your context should remain unchanged. +. In Google Cloud Shell, execute the command you copied. Once it finishes, return to {kib} and wait for the confirmation of data received from your new integration. Then you can click **View Assets** to see your data. + +NOTE: If you encounter any issues running the command, return to {kib} and navigate again to Google Cloud Shell. + +NOTE: During Cloud Shell setup, the CSPM integration adds roles to Google's default service account, which enables custom role creation and attachment of the service account to a compute instance. +After setup, these roles are removed from the service account. If you attempt to delete the deployment but find the deployment manager lacks necessary permissions, consider adding the missing roles to the service account: +https://cloud.google.com/iam/docs/understanding-roles#resourcemanager.projectIamAdmin[Project IAM Admin], https://cloud.google.com/iam/docs/understanding-roles#iam.roleAdmin[Role Administrator]. + +[discrete] +[[cspm-set-up-manual-gcp-org]] +== Manual authentication (GCP organization) + +To authenticate manually to monitor a GCP organization, you'll need to create a new GCP service account, assign it the necessary roles, generate credentials, then provide those credentials to the CSPM integration. + +Use the following commands, after replacing `` with the name of your new service account, `` with your GCP organization's ID, and `` with the GCP project ID of the project where you want to provision the compute instance that will run CSPM. + +Create a new service account: +``` +gcloud iam service-accounts create \ + --description="Elastic agent service account for CSPM" \ + --display-name="Elastic agent service account for CSPM" \ + --project= +``` + +Assign the necessary roles to the service account: +``` +gcloud organizations add-iam-policy-binding \ + --member=serviceAccount:@.iam.gserviceaccount.com \ + --role=roles/cloudasset.viewer + +gcloud organizations add-iam-policy-binding \ + --member=serviceAccount:@.iam.gserviceaccount.com \ + --role=roles/browser +``` +NOTE: The `Cloud Asset Viewer` role grants read access to cloud asset metadata. The `Browser` role grants read access to the project hierarchy. + +Download the credentials JSON (first, replace `` with the location where you want to save it): +``` +gcloud iam service-accounts keys create \ + --iam-account=@.iam.gserviceaccount.com +``` + +Keep the credentials JSON in a secure location; you will need it later. + +Provide credentials to the CSPM integration: + +. On the CSPM setup screen under **Setup Access**, select **Manual**. +. Enter your GCP **Organization ID**. Enter the GCP **Project ID** of the project where you want to provision the compute instance that will run CSPM. +. Select **Credentials JSON**, and enter the value you generated earlier. +. Under **Where to add this integration**, select **New Hosts**. +. Name the {agent} policy. Use a name that matches the purpose or team of the cloud account or accounts you want to monitor. For example, `dev-gcp-account`. +. Click **Save and continue**, then follow the instructions to install {agent} in your chosen GCP project. + +Wait for the confirmation that {kib} received data from your new integration. Then you can click **View Assets** to see your data. + +[discrete] +[[cspm-set-up-manual-gcp-project]] +== Manual authentication (GCP project) + +To authenticate manually to monitor an individual GCP project, you'll need to create a new GCP service account, assign it the necessary roles, generate credentials, then provide those credentials to the CSPM integration. + +Use the following commands, after replacing `` with the name of your new service account, and `` with your GCP project ID. + +Create a new service account: +``` +gcloud iam service-accounts create \ + --description="Elastic agent service account for CSPM" \ + --display-name="Elastic agent service account for CSPM" \ + --project= +``` + +Assign the necessary roles to the service account: +``` +gcloud projects add-iam-policy-binding \ + --member=serviceAccount:@.iam.gserviceaccount.com \ + --role=roles/cloudasset.viewer + +gcloud projects add-iam-policy-binding \ + --member=serviceAccount:@.iam.gserviceaccount.com \ + --role=roles/browser +``` +NOTE: The `Cloud Asset Viewer` role grants read access to cloud asset metadata. The `Browser` role grants read access to the project hierarchy. + +Download the credentials JSON (first, replace `` with the location where you want to save it): +``` +gcloud iam service-accounts keys create \ + --iam-account=@.iam.gserviceaccount.com +``` + +Keep the credentials JSON in a secure location; you will need it later. + +Provide credentials to the CSPM integration: + +. On the CSPM setup screen under **Setup Access**, select **Manual**. +. Enter your GCP **Project ID**. +. Select **Credentials JSON**, and enter the value you generated earlier. +. Under **Where to add this integration**, select **New Hosts**. +. Name the {agent} policy. Use a name that matches the purpose or team of the cloud account or accounts you want to monitor. For example, `dev-gcp-account`. +. Click **Save and continue**, then follow the instructions to install {agent} in your chosen GCP project. + +Wait for the confirmation that {kib} received data from your new integration. Then you can click **View Assets** to see your data. diff --git a/docs/cloud-native-security/cspm.asciidoc b/docs/cloud-native-security/cspm.asciidoc index 2571557e72..1e6639ba14 100644 --- a/docs/cloud-native-security/cspm.asciidoc +++ b/docs/cloud-native-security/cspm.asciidoc @@ -8,8 +8,15 @@ This feature currently supports Amazon Web Services (AWS). For a step-by-step ge .Requirements [sidebar] -- +<<<<<<< HEAD * The CSPM integration is available to all {ecloud} users. On-premise deployments require an https://www.elastic.co/pricing[Enterprise subscription]. * {stack} version 8.7 or greater. +======= +* CSPM is available to all {ecloud} users. On-premise deployments require an https://www.elastic.co/pricing[Enterprise subscription]. +* {stack} version 8.10 or greater. +* CSPM only works in the `Default` {kib} space. Installing the CSPM integration on a different {kib} space will not work. +* CSPM is supported on commercial cloud only. Government cloud is not supported (https://github.com/elastic/enhancements[request support]). +>>>>>>> 5df1b3a2 (Adds kibana namespace requirement to CNVM and CSPM (#5154)) -- [discrete] diff --git a/docs/cloud-native-security/vuln-management-get-started.asciidoc b/docs/cloud-native-security/vuln-management-get-started.asciidoc index b65b378158..6736d9a4bc 100644 --- a/docs/cloud-native-security/vuln-management-get-started.asciidoc +++ b/docs/cloud-native-security/vuln-management-get-started.asciidoc @@ -8,6 +8,7 @@ This page explains how to set up Cloud Native Vulnerability Management (CNVM). -- * CNVM is available to all {ecloud} users. On-premise deployments require an https://www.elastic.co/pricing[Enterprise subscription]. * Requires {stack} and {agent} version 8.8 or higher. +* CNVM only works in the `Default` {kib} space. Installing the CNVM integration on a different {kib} space will not work. * To view vulnerability scan findings, you need at least `read` privileges for the following indices: ** `logs-cloud_security_posture.vulnerabilities-*` ** `logs-cloud_security_posture.vulnerabilities_latest-*` diff --git a/docs/cloud-native-security/vuln-management-overview.asciidoc b/docs/cloud-native-security/vuln-management-overview.asciidoc index 894f045b9a..974eb21530 100644 --- a/docs/cloud-native-security/vuln-management-overview.asciidoc +++ b/docs/cloud-native-security/vuln-management-overview.asciidoc @@ -12,6 +12,7 @@ NOTE: CNVM currently only supports AWS EC2 Linux workloads. -- * CNVM is available to all {ecloud} users. On-premise deployments require an https://www.elastic.co/pricing[Enterprise subscription]. * Requires {stack} and {agent} version 8.8 or higher. +* CNVM only works in the `Default` {kib} space. Installing the CNVM integration on a different {kib} space will not work. * To view vulnerability scan findings, you need at least `read` privileges for the following indices: ** `logs-cloud_security_posture.vulnerabilities-*` ** `logs-cloud_security_posture.vulnerabilities_latest-*`