Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.8] Adds kibana namespace requirement to CNVM and CSPM (backport #5154) #5179

Closed
wants to merge 1 commit into from
Closed

[8.8] Adds kibana namespace requirement to CNVM and CSPM (backport #5154) #5179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
283 changes: 283 additions & 0 deletions docs/cloud-native-security/cspm-get-started-aws.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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::<Management Account ID>:root"
},
"Action": "sts:AssumeRole"
},
{
"Effect": "Allow",
"Principal": {
"Service": "ec2.amazonaws.com"
},
"Action": "sts:AssumeRole"
}
]
}
```
====

** The AWS-managed `SecurityAudit` policy.

IMPORTANT: You must replace `<Management account ID>` 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::<Management Account ID>:role/cloudbeat-root"
},
"Action": "sts:AssumeRole"
}
]
}
```
====

IMPORTANT: You must replace `<Management account ID>` 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

* <<cspm-use-instance-role,Default instance role (recommended)>>
* <<cspm-use-keys-directly,Direct access keys>>
* <<cspm-use-temp-credentials,Temporary security credentials>>
* <<cspm-use-a-shared-credentials-file,Shared credentials file>>
* <<cspm-use-iam-arn, IAM role Amazon Resource Name (ARN)>>

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 <<cspm-setup-organization-manual, created a new role>>, `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 <<cspm-finish-manual, finish manual setup>>.

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, <<cspm-finish-manual, finish manual setup>>.

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/[email protected] --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, <<cspm-finish-manual, finish manual setup>>.

[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, <<cspm-finish-manual, finish manual setup>>.

[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**.
Loading