---
title: "Cloudvisory User Guide 4.10.2"
slug: "cloudvisory-user-guide-4-10-2"
updated: 2026-08-31T16:36:20Z
published: 2026-08-31T16:36:20Z
canonical: "docs.trellix.com/cloudvisory-user-guide-4-10-2"
stale: true
---
> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trellix.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Cloudvisory User Guide 4.10.2
159
# Getting Started
> **!**
>
> INFO
>
> **LOGIN INFORMATION**
>
> As part of the onboarding process, the Cloudvisory team will provide credentials for your administrator. Please contact your Cloudvisory account representative if there are any problems.
## Log In
To log in, enter the credentials provided by Cloudvisory.

### First time log in
Use the username and password provided by your administrator/credentials sent to your registered email. For security reasons and to secure the account users are forced to change the password. Without resetting the password user will not be able to proceed further.

### First time On-Boarding provider account
Once the password is updated user can add provider accounts before proceeding further or you have an option to skip to the dashboard. Use the onscreen instruction to add provider account.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.

> **NOTE**
>
> Onscreen on-boarding will appear if the account has no provider account or for first time user login.
>
> See [On-Boarding_provider](/docs/cloudvisory-user-guide-4-10-2#) for more info.
## Log Out
You can manually log out by clicking Logout in the user dropdown menu on the top right corner of the application.
You will be automatically logged out after 30 minutes of inactivity.
Administrators can change the account password by clicking Change Password.

Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
5
# Support
Contact our product experts 24x7 via the FireEye online support portal, live Chat or our network of global customer support centers.
[Contact Fireeye Support](/docs/cloudvisory-user-guide-4-10-2#)
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
6
# Workload License
## What is a "Workload"?
A `Workload` is a discovered cloud asset that can perform work, communicated over a network and be associated with at least five (5) security controls which can be monitored and/or managed by Cloudvisory.
## What is the "Workload license Limit"?
The `Workload license Limit` entitles your Cloudvisory environment to protect a specific number of Workloads. For each active Workload, a single Workload-license is consumed from `Workload license Limit`.
When a Workload is deleted / terminated, Cloudvisory automatically detects and stores this change; in the process, the associated Workload-license is automatically returned to the available pool of licenses.
## Workload license Limit Alert
Cloudvisory automatically generates alerts when the system utilizes pre-defined percentages (80%, 90%, 95% and 100%) of the `Workload license Limit`. In order to provide visibility to users in the Cloudvisory UI, these alerts are shown in the “Dashboard” and also in the “Alerts” tab.
In order to provide visibility outside of the product, alerts are sent to users through customizable email templates.
- Utilizing 80% of `Workload license Limit` (Severity=LOW)
- Utilizing 90% of `Workload license Limit` (Severity=MEDIUM)
- Utilizing 95% of `Workload license Limit` (Severity=HIGH)
- Utilizing 100% of `Workload license Limit` (Severity=CRITICAL)
Cloudvisory generates a CRITICAL severity alert when the system utilizes 100% of the WORKLOAD LICENSE LIMIT.
Cloudvisory will keep protecting licensed workloads, though discovery of new workloads will stop once the TOTAL WORKLOADS exceeds the `Workload license Limit`.
## Requesting an update to Workload license Limit
Because cloud environments are dynamic by nature, Cloudvisory’s `Workload license Limit` is designed to allow for fluctuations in the number of managed workloads.
If you consistently have more Workloads to manage than your license allows, however, you may need to request an increase to your “`Workload license Limit`” for Cloudvisory:
### SaaS Deployments
If your deployment is created through AWS Marketplace, please go to [Cloudvisory Marketplace](/docs/cloudvisory-user-guide-4-10-2#) to increase `Workload license Limit`.
If your deployment is managed by FireEye (but not created through a cloud “Marketplace”), please contact the [FireEye Support](/docs/cloudvisory-user-guide-4-10-2#) team to request an increase to `Workload license Limit`.
### On-Premises/Remote Deployments
If your deployment is in your own datacenter, please contact your FireEye sales representative to request an increase to `Workload license Limit`. [Contact FireEye Support](/docs/cloudvisory-user-guide-4-10-2#)
# AWS (Deployed in AWS Cloud)
## Step-by-step guide
You need the following information to onboard an AWS (Cloud) Provider Account in Cloudvisory:
- **RoleARN:** The ARN of the AWS role which provides permission to access the aws account from Cloudvisory.
- **ExternalID:** To assume the RoleARN of the AWS role, users must be in the trusted account and provide this exact external ID.
### Get External ID
Go to Settings > Providers > AWS and click the "Get ExternalID"

- **S3BucketName:** The name of the S3 bucket for VPC flow log.
> **INFO**
>
> If you have workloads in one of following regions, follow the steps in "Onboard AWS Account in Cloudvisory (Data Center)" instead. By default, AWS has restricted these regions and disabled STS tokens for them.
>
> **Middle East (Bahrain), Africa (Cape Town), Asia Pacific (Hong Kong), Europe (Milan).**
## Configure Using a CloudFormation Template
Create a file named `cloudvisory-aws-onboard.yaml` and paste the following cloudformation template code in it.
You can also download the .yaml cloudformation template code [here](/docs/cloudvisory-user-guide-4-10-2#)
> **NOTE**
>
> Get the externalID from AWS tab from Providers page under settings menu. [Get externalID](/docs/cloudvisory-user-guide-4-10-2#)
cloudvisory-aws-onboard.yaml
```plaintext
AWSTemplateFormatVersion: 2010-09-09
Parameters:
CloudvisoryFlowS3BucketName:
Description: Bucket to collect vpc flows
Type: String
Default: cloudvisory-flows
CloudvisoryTrailName:
Description: Trail to collect cloudtrail logs
Type: String
Default: cloudvisory-trail
CloudvisoryTrailS3BucketName:
Description: Bucket to collect cloudtrail logs
Type: String
Default: cloudvisory-trail
CloudvisoryRoleName:
Description: Name of the IAM Role to be created by this template and used by FireEye Cloudvisory
Type: String
Default: cloudvisory-fireeye-service
ExternalAccountId:
Description: ID of the monitoring AWS account where the Cloudvisory deployment is running
Type: String
Default: "690625724779"
ExternalSecretId:
Description: Shared secret used to validate the trust relationship between the monitored and monitoring AWS accounts, This value must be get from Cloudvisory UI(Click 'Get External Id' in Aws tab in Provider page under Settings menu item)
Type: String
Default: "" # Copy the External ID by clicking "Get ExternalID" from Aws tab in Providers page under Settings menu item.
CloudvisoryFlowLogsPolicyEnable:
Description: Control the optional creation of the policy named by the 'CloudvisoryFlowLogsPolicyName' parameter
Type: String
Default: "enable"
CloudvisoryFlowLogsPolicyName:
Description: Name of the IAM Policy to be created and attached to the IAM Role ; grants Cloudvisory discovery permissions for VPC Flow Logs
Type: String
Default: cloudvisory-flow-permissions
CloudvisoryCloudtrailPolicyName:
Description: Name of the IAM Policy to be created and attached to the IAM Role ; grants Cloudvisory discovery permissions for VPC Flow Logs
Type: String
Default: cloudvisory-cloudtrail-permissions
```
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
```plaintext
CloudvisoryReadPolicyName:
Description: Name of the IAM Policy to be created and attached to the IAM Role ; grants Cloudvisory read permissions for AWS asset discovery
Type: String
Default: cloudvisory-read-permissions
CloudvisoryWritePolicyEnable:
Description: Control the optional creation of the policy named by the 'CloudvisoryWritePolicyName' parameter
Type: String
Default: "enable"
CloudvisoryWritePolicyName:
Description: Name of the IAM Policy to be created and attached to the IAM Role ; grants Cloudvisory write permissions for compliance remediation and policy enforcement
Type: String
Default: cloudvisory-write-permissions
Conditions:
CreateFlowLogsPolicy: !Equals [!Ref CloudvisoryFlowLogsPolicyEnable, "enable"]
CreateWritePolicy: !Equals [!Ref CloudvisoryWritePolicyEnable, "enable"]
Resources:
CVReadPolicy:
Type: AWS::IAM::Policy
DependsOn: CVServiceRole
Properties:
PolicyName: !Sub "${CloudvisoryReadPolicyName}"
PolicyDocument:
Statement:
- Action:
- ce:GetCostAndUsage
- ce:GetCostForecast
- cloudtrail:LookupEvents
- cognito-identity:DescribeIdentityPool
- cognito-identity:ListIdentities
- cognito-idp:DescribeUserPool
- cognito-idp:ListGroups
- cognito-idp:ListUsers
- dynamodb:DescribeBackup
- ecr:ListTagsForResource
- eks:DescribeUpdate
- eks:ListUpdates
- elasticfilesystem:DescribeTags
- iot:GetV2LoggingOptions
- lambda:GetFunction
- logs:FilterLogEvents
- logs:GetLogEvents
- s3:ListBucket
- ses:GetEmailIdentity
- ses:ListEmailIdentities
- sns:GetSubscriptionAttributes
- sns:ListSubscriptions
- sns:ListTagsForResource
- sqs:GetQueueUrl
- ssm:GetParametersByPath
Effect: Allow
Resource: "*"
Roles:
- Ref: CVServiceRole
CVFlowLogsPolicy:
Type: AWS::IAM::Policy
Condition: CreateFlowLogsPolicy
DependsOn:
- CVServiceRole
- CVFlowS3Bucket
Properties:
PolicyName: !Sub "${CloudvisoryFlowLogsPolicyName}"
PolicyDocument:
Statement:
- Action:
- ec2:CreateFlowLogs
- ec2:DeleteFlowLogs
- sqs:CreateQueue
- sqs:SetQueueAttributes
- sqs:GetQueueUrl
- sqs:ReceiveMessage
- sqs:DeleteMessage
- logs:CreateLogDelivery
- logs:PutRetentionPolicy
Effect: Allow
Resource: "*"
- Action:
- s3:PutBucketNotification
- s3:PutBucketPolicy
Effect: Allow
Resource: !GetAtt CVFlowS3Bucket.Arn
Roles:
- Ref: CVServiceRole
CVCloudTrailPolicy:
Type: AWS::IAM::Policy
DependsOn:
- CVServiceRole
- CVTrailS3Bucket
Properties:
PolicyName: !Sub "${CloudvisoryCloudtrailPolicyName}"
PolicyDocument:
Statement:
- Action:
- sqs:CreateQueue
- sqs:SetQueueAttributes
- sqs:GetQueueUrl
- sqs:ReceiveMessage
- sqs:DeleteMessage
Effect: Allow
Resource: "*"
- Action:
- s3:PutBucketNotification
- s3:PutBucketPolicy
Effect: Allow
Resource: !GetAtt CVTrailS3Bucket.Arn
Roles:
- Ref: CVServiceRole
```
```plaintext
CVWritePolicy:
Type: AWS::IAM::Policy
Condition: CreateWritePolicy
DependsOn: CVServiceRole
Properties:
PolicyName: !Sub "${CloudvisoryWritePolicyName}"
PolicyDocument:
Statement:
- Action:
- cloudtrail:StartLogging
- cloudtrail:UpdateTrail
- ec2:AuthorizeSecurityGroupEgress
- ec2:AuthorizeSecurityGroupIngress
- ec2:CreateFlowLogs
- ec2:CreateSecurityGroup
- ec2:CreateTags
- ec2:DeleteFlowLogs
- ec2:DeleteSecurityGroup
- ec2:ModifyInstanceAttribute
- ec2:ModifyNetworkInterfaceAttribute
- ec2:RevokeSecurityGroupEgress
- ec2:RevokeSecurityGroupIngress
- ecr:PutImageScanningConfiguration
- iam:DeleteAccessKey
- iam:DeleteLoginProfile
- iam:DetachGroupPolicy
- iam:DetachRolePolicy
- iam:DetachUserPolicy
- iam:PassRole
- iam:UpdateAccessKey
- iam:UpdateAccountPasswordPolicy
- kms:EnableKeyRotation
- logs:CreateLogGroup
- logs:CreateLogStream
- logs:PutLogEvents
- logs:PutRetentionPolicy
- rds:ModifyDBInstance
- s3:PutBucketAcl
- s3:PutBucketPublicAccessBlock
- s3:PutBucketTagging
- s3:PutBucketVersioning
- s3:PutEncryptionConfiguration
Effect: Allow
Resource: "*"
Roles:
- Ref: CVServiceRole
CVServiceRole:
Type: AWS::IAM::Role
Properties:
AssumeRolePolicyDocument:
Statement:
- Action: sts:AssumeRole
Condition:
StringEquals:
sts:ExternalId: !Sub "${ExternalSecretId}"
Effect: Allow
Principal:
AWS: !Sub "${ExternalAccountId}"
Description: IAM Role used by Cloudvisory service for asset discovery, compliance monitoring and (optional) policy enforcement
ManagedPolicyArns:
- arn:aws:iam::aws:policy/SecurityAudit
Path: /
RoleName: !Sub "${CloudvisoryRoleName}"
CVFlowS3Bucket:
Type: AWS::S3::Bucket
Properties:
BucketEncryption:
ServerSideEncryptionConfiguration:
- ServerSideEncryptionByDefault:
SSEAlgorithm: AES256
BucketName: !Join [ "-", [ !Sub "${CloudvisoryFlowS3BucketName}", !Ref "AWS::AccountId" ] ]
PublicAccessBlockConfiguration:
BlockPublicAcls: true
BlockPublicPolicy: true
IgnorePublicAcls: true
RestrictPublicBuckets: true
CVFlowS3BucketPolicy:
Type: AWS::S3::BucketPolicy
DependsOn:
- CVFlowS3Bucket
- CVServiceRole
Properties:
Bucket: !Ref CVFlowS3Bucket
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Principal:
Service: 'delivery.logs.amazonaws.com'
Action: s3:PutObject
Resource: !Join [ '', [ !GetAtt CVFlowS3Bucket.Arn, "/AWSLogs/*" ] ]
- Effect: Allow
Principal:
Service: 'delivery.logs.amazonaws.com'
Action: s3:GetBucketAcl
Resource: !GetAtt CVFlowS3Bucket.Arn
- Effect: Allow
Principal:
AWS: !GetAtt CVServiceRole.Arn
Action: s3:GetObject
Resource: !Join [ '', [ !GetAtt CVFlowS3Bucket.Arn, "/AWSLogs/", !Ref "AWS::AccountId", "/*" ] ]
- Effect: Allow
Principal:
AWS: !GetAtt CVServiceRole.Arn
Action: s3:DeleteObject
Resource: !Join [ '', [ !GetAtt CVFlowS3Bucket.Arn, "/AWSLogs/", !Ref "AWS::AccountId", "/*" ] ]
CVTrailsS3Bucket:
```
```plaintext
Type: AWS::S3::Bucket
Properties:
BucketEncryption:
ServerSideEncryptionConfiguration:
- ServerSideEncryptionByDefault:
SSEAlgorithm: AES256
BucketName: !Join [ "-", [ !Sub "${CloudvisoryTrailsS3BucketName}", !Ref "AWS::AccountId" ] ]
PublicAccessBlockConfiguration:
BlockPublicAcls: true
BlockPublicPolicy: true
IgnorePublicAcls: true
RestrictPublicBuckets: true
CVTrailsS3BucketPolicy:
Type: 'AWS::S3::BucketPolicy'
DependsOn:
- CVTrailsS3Bucket
- CVServiceRole
Properties:
Bucket: !Ref CVTrailsS3Bucket
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Principal:
Service: cloudtrail.amazonaws.com
Action: s3:GetBucketAcl
Resource: !GetAtt CVTrailsS3Bucket.Arn
- Effect: Allow
Principal:
Service: cloudtrail.amazonaws.com
Action: s3:PutObject
Resource: !Join [ "", [ !GetAtt CVTrailsS3Bucket.Arn, "/AWSLogs/", !Ref "AWS::AccountId", "/*" ] ]
Condition:
StringEquals:
s3:x-amz-acl: bucket-owner-full-control
- Effect: Allow
Principal:
AWS: !GetAtt CVServiceRole.Arn
Action: s3:GetObject
Resource: !Join [ "", [ !GetAtt CVTrailsS3Bucket.Arn, "/AWSLogs/", !Ref "AWS::AccountId", "/*" ] ]
- Effect: Allow
Principal:
AWS: !GetAtt CVServiceRole.Arn
Action: s3:DeleteObject
Resource: !Join [ "", [ !GetAtt CVTrailsS3Bucket.Arn, "/AWSLogs/", !Ref "AWS::AccountId", "/*" ] ]
CVTrail:
Type: AWS::CloudTrail::Trail
DependsOn:
- CVTrailsS3Bucket
- CVTrailsS3BucketPolicy
Properties:
IsLogging: true
IsMultiRegionTrail: true
IncludeGlobalServiceEvents: true
EnableLogFileValidation: true
S3BucketName: !Ref CVTrailsS3Bucket
TrailName: !Join [ "-", [ !Sub "${CloudvisoryTrailName}", !Ref "AWS::AccountId" ] ]
Outputs:
CVFlowBucketName:
Description: Name of the S3 Bucket created for VPC flow log discovery by FireEye Cloudvisory
Value: !Ref CVFlowS3Bucket
CVTrailBucketName:
Description: Name of the S3 Bucket created for Cloudtrail events by FireEye Cloudvisory
Value: !Ref CVTrailsS3Bucket
CVExternalId:
Description: Shared secret used to validate the trust relationship between the monitored and monitoring AWS accounts
Value: !Sub "${ExternalAccountId}"
CVServiceRoleArn:
Description: ARN of the IAM Role created for use by Cloudvisory service
Value: !GetAtt CVServiceRole.Arn
```
1. Log into [https://console.aws.amazon.com](https://console.aws.amazon.com).
2. Under the Management & Governance tab, select CloudFormation.
3. Click Create Stack.
4. Select 'Template is ready.'
5. Select 'Upload a template file.'
6. Click 'Change file' to upload the file.
7. Click Next.
Copyright © 2021 Cloudvisory Documentation, FireEye Inc.
## Create stack
Prerequisite - Prepare template
Prepare template
- Template is ready
- Use a sample template
- Create template in Designer
Specify template
Template source
- Amazon S3 URL
- Upload a template file
Upload a template file: cloudvisory-aws-discovery.yaml

### Specify stack details

1. Enter the stack name.
2. Review the 'CloudvisoryRoleName.'
3. Review the 'CloudvisoryS3BucketName'. Your account ID will be concatenated at the end.
4. Enter or review 'ExternalAccountId.'
5. Click Next.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
12
[IMAGE PLACEHOLDER: CloudFormation parameters screenshot showing fields and values. Visible labels and values: CloudvisoryReadPolicyName — cloudvisory-read-permissions; CloudvisoryRoleName — cloudvisory-fireeye-service (circled); CloudvisoryS3BucketName — cloudvisory-flows (circled); CloudvisoryWritePolicyEnable — enable; CloudvisoryWritePolicyName — cloudvisory-write-permissions; ExternalAccountId — [redacted]; ExternalSecretId — Cloudv1s0ry; Footer buttons: Cancel, Previous, Next (Next circled).]
13. Click Next again.
[IMAGE PLACEHOLDER: CloudFormation Permissions and Advanced options screenshot. Visible text: Permissions — Choose an IAM role to explicitly define how CloudFormation can create, modify, or delete resources in the stack. If you don't choose a role, CloudFormation uses permissions based on your user credentials. Learn more; IAM role - optional — Choose the IAM role for CloudFormation to use for all operations performed on the stack. Dropdown labelled "IAM role name" with sample placeholder "Sample-role-name" and a Remove button; Advanced options heading with expandable sections: - Stack policy — Defines the resources that you want to protect from unintentional updates during a stack update. - Rollback configuration — Specify alarms for CloudFormation to monitor when creating and updating the stack. If the operation breaches an alarm threshold, CloudFormation rolls it back. Learn more - Notification options - Stack creation options Footer buttons: Cancel, Previous, Next (Next circled).]
14. Click the checkbox to acknowlege and then click **Create Stack**.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
13

15. Copy these three output values for the Cloudvisory UI:

## Configure Using the AWS Console
> **NOTE**
>
> - Skip this section if you already run all steps in 'Configure using CloudFormation template'.
> - Get the externalID from AWS tab from Providers page under settings menu. [Get externalID](/docs/cloudvisory-user-guide-4-10-2#)
Steps to configure the RoleARN:
1. Log into [https://console.aws.amazon.com](https://console.aws.amazon.com).
2. Under the Security, Identity & Compliance tab, select IAM.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.

3. Click Roles and then click Create Role.

4. Select 'Another AWS account.'
5. Click Next.

6. Enter your Account ID (provided by the Cloudvisory team, 690625724779).
7. Select the 'useBaseUrlId external ID' checkbox.
8. Enter the External ID. (Please read the note in the begining of this section for External ID)
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
15
9. Click Next: Permissions.

10. Enter SecurityAudit in Find Policies to find the standard AWS audit policies.
The SecurityAudit policy provides access rights to discover AWS assets and run Cloudvisory compliance checks against them, if you plan to run remediation of compliance check failures.
11. Select the SecurityAudit Policy checkbox.
12. Click Next: Tags.

13. You can enter any tag/value (except the useBaseUrlId for Cloudvisory).
14. Click Next: Review.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
16
## Create role
### Add tags (optional)
IAM tags are key-value pairs you can add to your role. Tags can include user information, such as an email address, or can be descriptive, such as a job title. You can use the tags to organize, track, or control access for this role. Learn more

You can add 50 more tags.
1. Enter a Role name, for example, cvDiscoveryRole.
2. Enter Role Description.
3. Click 'Create role.'
4. Click the newly created role name to open it.

19. Copy the Role ARN.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.

This Role ARN and External ID will be the useBaseUrl to enter in the Cloudvisory UI.
## Permissions for asset discovery and compliance check:
1. Select the new role you created.
2. Create the inline policy `cvReadPermissions` by clicking **Add Inline Policy**. Use the following permissions:
cvReadPermissions
```plaintext
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ce:GetCostAndUsage",
"ce:GetCostForecast",
"cloudtrail:LookupEvents",
"cognito-identity:DescribeIdentityPool",
"cognito-identity:ListIdentities",
"cognito-idp:DescribeUserPool",
"cognito-idp:ListGroups",
"cognito-idp:ListUsers",
"dynamodb:DescribeBackup",
"ecr:ListTagsForResource",
"eks:DescribeUpdate",
"eks:ListUpdates",
"elasticfilesystem:DescribeTags",
"iot:GetV2LoggingOptions",
"lambda:GetFunction",
"logs:FilterLogEvents",
"logs:GetLogEvents",
"s3:ListBucket",
"ses:GetIdentity",
"ses:ListEmailIdentities",
"sns:GetSubscriptionAttributes",
"sns:ListSubscriptions",
"sns:ListTagsForResource",
"sqs:GetQueueUrl",
"ssm:GetParametersByPath"
],
"Resource": [
"*"
]
}
]
}
```
## Permissions for micro segmentation, enforcement and compliance check remediation:
1. Select the new role you created.
2. Create the inline policy `cvWritePermissions` by clicking **Add Inline Policy**. Use the following permissions:
cvWritePermissions
```plaintext
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
/* policy actions not fully visible in source image */
]
}
]
}
```
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
```plaintext
"Action": [
"cloudtrail:StartLogging",
"cloudtrail:UpdateTrail",
"ec2:AuthorizeSecurityGroupEgress",
"ec2:AuthorizeSecurityGroupIngress",
"ec2:CreateFlowLogs",
"ec2:CreateSecurityGroup",
"ec2:CreateTags",
"ec2:DeleteFlowLogs",
"ec2:DeleteSecurityGroup",
"ec2:ModifyInstanceAttribute",
"ec2:ModifyNetworkInterfaceAttribute",
"ec2:RevokeSecurityGroupEgress",
"ec2:RevokeSecurityGroupIngress",
"ecr:PutImageScanningConfiguration",
"iam:DeleteAccessKey",
"iam:DeleteLoginProfile",
"iam:DetachGroupPolicy",
"iam:DetachRolePolicy",
"iam:DetachUserPolicy",
"iam:PassRole",
"iam:UpdateAccessKey",
"iam:UpdateAccountPasswordPolicy",
"kms:EnableKeyRotation",
"logs:CreateLogGroup",
"logs:CreateLogStream",
"logs:PutLogEvents",
"logs:PutRetentionPolicy",
"rds:ModifyDBInstance",
"s3:PutBucketAcl",
"s3:PutBucketPublicAccessBlock",
"s3:PutBucketTagging",
"s3:PutBucketVersioning",
"s3:PutEncryptionConfiguration"
],
"Resource": [
"*"
]
}
]
}
```
### Permissions to collect and visualize VPC flows:
1. Select the new role you created.
2. Create the inline policy `cvVpcFlowPermissions` by clicking **Add Inline Policy**. Use the following permissions:
`cvVpcFlowPermissions`
```plaintext
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"ec2:CreateFlowLogs",
"ec2:DeleteFlowLogs",
"sqs:CreateQueue",
"sqs:SetQueueAttributes",
"sqs:GetQueueUrl",
"sqs:ReceiveMessage",
"sqs:DeleteMessage",
"logs:CreateLogDelivery",
"logs:PutRetentionPolicy"
],
"Effect": "Allow",
"Resource": "*"
},
{
"Action": [
"s3:PutBucketNotification",
"s3:PutBucketPolicy"
],
"Effect": "Allow",
"Resource": "
```
### Permissions to collect cloud-trail events:
1. Select the new role you created.
2. Create the inline policy `cvCloudtrailPermissions` by clicking **Add Inline Policy**. Use the following permissions:
`cvCloudtrailPermissions`
```plaintext
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"sqs:CreateQueue",
"sqs:SetQueueAttributes",
"sqs:GetQueueUrl",
"sqs:ReceiveMessage",
"sqs:DeleteMessage"
],
"Effect": "Allow",
"Resource": "*"
}
/* additional statements truncated in image */
]
}
```
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
19
```plaintext
{
},
{
"Action": [
"s3:PutBucketNotification",
"s3:PutBucketPolicy"
],
"Effect": "Allow",
"Resource": ""
]
}
```
## Create the S3 bucket for VPC flows
> **NOTE**
>
> Skip this section if you already run all steps in 'Configure using CloudFormation template'.
Ensure that the policy 'cvVpcFlowPermissions' mentioned above has been created for the role.
1. Log into [https://console.aws.amazon.com](https://console.aws.amazon.com) and navigate to the S3 service using the Services section.

2. On the Amazon S3 page, click 'Create bucket.'

3. On the Create Bucket page, enter a name for the S3 bucket in the Bucket Name field and select a region.
The bucket name must be unique in AWS in all accounts. You can use your aws account number with the 'csp' prefix. For example:
```plaintext
csp-[account number of your aws account]-vpcflows To get the account number, click the drop down in the top right corner and select My Account.
```

4. Ensure that the 'Block all public access' is selected.
5. Click Create Bucket to finish creating the bucket.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
20

## Create the CloudTrail trail
> NOTE
>
> Skip this section if you already run all steps in 'Configure using CloudFormation template'.
Ensure that the policy 'cvCloudtrailPermissions' mentioned above has been created for the role.
1. Log into [https://console.aws.amazon.com](https://console.aws.amazon.com) and navigate to the CloudTrail service using the Services section and select a desired region.

2. On the CloudTrail page, click Trails from the left-hand navigation and click 'Create trail.'

3. On the 'Choose trail attributes' page:
- Enter a name for the trail in the Trail Name field
- Specify a unique bucket name. The bucket name must be unique in AWS in all accounts. You can use your aws account number with the 'csp' prefix. For example:
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
csp-[account number of your aws account]-trail To get the account number, click the drop down in the top right corner and select My Account.
- Uncheck the 'Enabled' checkbox under 'Log file SSE-KMS encryption'

- Scroll down to the end and click on Next > Next > 'Create trail' buttons, to save the changes and finish.
## Permissions for discovering kubernetes resources in AWS EKS clusters
This section is optional if you don't have AWS EKS or if you want to do it later.
Cloudvisory discovers AWS EKS Clusters and also all assets from the cluster. The following additional permissions need to be added for each EKS cluster. You can use the aws cli (1.6 or later) and kubectl.
1. Check whether your aws credential has access to the EKS cluster. Replace `cluster name` with your cluster's name.
```plaintext
aws eks describe-cluster --name
```
2. If you don't have access, update your kubeconfig file. Replace `cluster region name` and `cluster name` with your cluster's name and region.
```plaintext
aws eks --region update-kubeconfig --name
```
> **CAUTION**
>
> Your aws credential must have permission to access EKS and your aws user must be included in the aws-auth config map. (https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html).
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
22
If not, please contact your AWS EKS cluster admin for help.
3. Add the ARN for `cspDiscoveryRole` to the aws-auth config map:
```plaintext
kubectl edit -n kube-system configmap/aws-auth
```
4. Add the following lines under mapRoles and update the `cspDiscoveryRole` ARN:
```plaintext
- rolearn:
username: Cloudvisoryuser
groups:
- system:masters
```
5. Save the change.
6. Confirm the new permissions:
```plaintext
kubectl describe configmap -n kube-system aws-auth
```
## Onboarding an AWS Account in Cloudvisory
1. Log into the Cloudvisory UI.
2. Click Admin Settings > Providers.
3. Click AWS on left panel
4. Click Add Account.
### Account information
1. Enter `Account Name`.
2. Enter Account Description (optional).
3. Enter `RoleARN`.
4. Enter `ExternalID`.
5. Enter S3 Bucket name (optional).
6. Enter AWS S3 bucket for CloudTrail (optional).
7. Choose AWS Cloud Type (Default, US Gov or China).
8. Click Next.
### Configure Compliance checks
1. Select an option:
- **Auto-Configure Compliance Checks:** If you select this option, Cloudvisory will create a default compliance group with this provider account and will enable default compliance checks.
- **Will Configure Manually :** If you select this option, you must configure the compliance group and add checks manually.
> [IMAGE PLACEHOLDER: Lightbulb icon in green tip box]
>
> **TIP**
>
> use **Auto-Configure Compliance Checks** (the default selection) and see how Cloudvisory configures the compliance group and checks after adding the provider account.
2. Click Next.
3. Review and click Submit.
## Add Account Information
1. 1. Account Information
2. 2. Configure Compliance Checks
3. 3. Review and Submit
Account Name (Required)
Account Name
65 characters left
### Access Parameters
RoleARN:
RoleARN
ExternalID:
CloudV1s0ry
S3 Bucket Name: (Optional)
S3 Bucket Name
Cloud-trail S3 Bucket Name: (Optional)
Cloud-trail S3 Bucket Name
AWS Cloud Type:
- Default
- US Gov
- China
Account Description (Optional):
Account Description
120 characters left
### Define Scope (Optional)
No Scopes Defined
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
24
# AWS (Deployed outside AWS Cloud)
## Step-by-step guide
Cloudvisory requires following information in order to onboard an AWS account:
- **Access Key:** The Access key ID of the AWS user, which provides permission to access the aws account from CSP.
- **Secret Key:** The Secret access key of the AWS user.
- **S3 Bucket for Flow:** The bucket where the network flows will be collected.
- **S3 Bucket for Cloudvisory:** The bucket where the clou-dtrail events will be collected.
## Configure the Access Key and Secret Key
1. Log into [https://console.aws.amazon.com](https://console.aws.amazon.com).
2. Under the Security, Identity & Compliance tab, select IAM.
[IMAGE PLACEHOLDER: A screenshot of the AWS Management Console services page showing many service categories; the 'IAM' entry is circled under the Security, Identity & Compliance section.]
1. Click Users.
2. Click Add User.
3. Enter User name (for example, cvDiscoveryUser).
4. Select the 'Programmatic access' checkbox.
5. Click Next:Permissions.

1. Select 'Attach existing policies directly.'
2. Enter 'SecurityAudit' in 'Filter policies'.
3. Select 'SecurityAudit'.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
25
11. Click Next:Tags.

12. Add Tag is not required. Click Next:Review.
13. Click Create User.

14. Copy the Access Key ID and Secret Access Key. These two values will be required in the Cloudvisory UI.
15. Click Close.
### Permissions for asset discovery and compliance check:
1. Select the new user you created (example: cvDiscoveryUser).
2. Create the inline policy cvReadPermissions by clicking Add Inline Policy. Use the following permissions:
**cvReadPermissions**
```plaintext
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ce:GetCostAndUsage",
"ce:GetCostForecast",
"cloudtrail:LookupEvents",
"cognito-identity:DescribeIdentityPool",
"cognito-identity:ListIdentities",
"cognito-idp:DescribeUserPool",
"cognito-idp:ListGroups",
"cognito-idp:ListUsers",
"dynamodb:DescribeBackup",
"ecr:ListTagsForResource",
"eks:DescribeUpdate"
```
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
```plaintext
{
"eks:ListUpdates",
"elasticfilesystem:DescribeTags",
"iot:GetV2LoggingOptions",
"lambda:GetFunction",
"logs:FilterLogEvents",
"logs:GetLogEvents",
"s3:ListBucket",
"ses:GetEmailIdentity",
"ses:ListEmailIdentities",
"sns:GetSubscriptionAttributes",
"sns:ListSubscriptions",
"sns:ListTagsForResource",
"sqs:GetQueueUrl",
"ssm:GetParametersByPath"
],
"Resource": [
"*"
]
}
]
```
### Permissions for micro segmentation, enforcement and compliance check remediation:
1. Select the new user you created.
2. Create the inline policy cvWritePermissions by clicking Add Inline Policy. Use the following permissions:
`cvWritePermissions`
```plaintext
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"cloudtrail:StartLogging",
"cloudtrail:UpdateTrail",
"ec2:AuthorizeSecurityGroupEgress",
"ec2:AuthorizeSecurityGroupIngress",
"ec2:CreateFlowLogs",
"ec2:CreateSecurityGroup",
"ec2:CreateTags",
"ec2:DeleteFlowLogs",
"ec2:DeleteSecurityGroup",
"ec2:ModifyInstanceAttribute",
"ec2:ModifyNetworkInterfaceAttribute",
"ec2:RevokeSecurityGroupEgress",
"ec2:RevokeSecurityGroupIngress",
"ecr:PutImageScanningConfiguration",
"iam:DeleteAccessKey",
"iam:DeleteLoginProfile",
"iam:DetachGroupPolicy",
"iam:DetachRolePolicy",
"iam:DetachUserPolicy",
"iam:PassRole",
"iam:UpdateAccessKey",
"iam:UpdateAccountPasswordPolicy",
"kms:EnableKeyRotation",
"logs:CreateLogGroup",
"logs:CreateLogStream",
"logs:PutLogEvents",
"logs:PutRetentionPolicy",
"rds:ModifyDBInstance",
"s3:PutBucketAcl",
"s3:PutBucketPublicAccessBlock",
"s3:PutBucketTagging",
"s3:PutBucketVersioning",
"s3:PutEncryptionConfiguration"
],
"Resource": [
"*"
]
}
]
}
```
### Permissions to collect and visualize VPC flows:
1. Select the new user you created.
2. Create the inline policy cvVpcFlowPermissions by clicking Add Inline Policy. Use the following permissions:
`cvVpcFlowPermissions`
```plaintext
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"ec2:CreateFlowLogs",
"ec2:DeleteFlowLogs",
"sqs:CreateQueue",
"sqs:SetQueueAttributes",
"sqs:GetQueueUrl",
"sqs:ReceiveMessage",
"sqs:DeleteMessage",
"logs:CreateLogDelivery",
"logs:PutRetentionPolicy"
]
}
]
}
```
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
27
## Permissions to collect cloud-trail events:
1. Select the new user you created.
2. Create the inline policy `cvCloudtrailPermissions` by clicking Add Inline Policy. Use the following permissions:
`cvCloudtrailPermissions`
```plaintext
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"sqs:CreateQueue",
"sqs:SetQueueAttributes",
"sqs:GetQueueUrl",
"sqs:ReceiveMessage",
"sqs:DeleteMessage"
],
"Effect": "Allow",
"Resource": "*"
},
{
"Action": [
"s3:PutBucketNotification",
"s3:PutBucketPolicy"
],
"Effect": "Allow",
"Resource": ""
}
]
}
```
## Create the S3 bucket for VPC flows
*Ensure that the policy* `cvVpcFlowPermissions` *mentioned above has been created for the user*
1. Log into [https://console.aws.amazon.com](https://console.aws.amazon.com) and navigate to the S3 service using the Services section.
2. 
3. On the Amazon S3 page, click 'Create bucket.'
4. 
5. On the Create Bucket page, enter a name for the S3 bucket in the Bucket Name field and select a region. The bucket name must be unique in AWS in all accounts. You can use your aws account number with the 'csp' prefix. For example:
> `csp-[account number of your aws account]-vpcflows`
>
> To get the account number, click the drop down in the top right corner and select My Account.
Copyright © 2021 Cloudvisory Documentation, FireEye Inc.
28

## Create bucket
4. Ensure that the 'Block all public access' is selected.
5. Click Create Bucket to finish creating the bucket.

## Create the CloudTrail trail
> Ensure that the policy 'cvCloudtrailPermissions' mentioned above has been created for the user
1. Log into https://console.aws.amazon.com and navigate to the CloudTrail service using the Services section and select a desired region.

2. On the CloudTrail page, click Trails from the left-hand navigation and click 'Create trail.'
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
29

3. On the 'Choose trail attributes' page:
- Enter a name for the trail in the Trail Name field
- Specify a unique bucket name. The bucket name must be unique in AWS in all accounts. You can use your aws account number with the 'csp' prefix. For example:
`csp-[account number of your aws account]-trail` To get the account number, click the drop down in the top right corner and select My Account.
- Uncheck the 'Enabled' checkbox under 'Log file SSE-KMS encryption'

- Scroll down to the end and click on Next > Next > 'Create trail' buttons, to save the changes and finish.
## Permissions for discovering kubernetes resources in AWS EKS clusters
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
30
Cloudvisory discovers AWS EKS Clusters and also all assets from the cluster. The following additional permissions need to be added for each EKS cluster. You can use the aws cli (1.6 or later) and kubectl.
1. Check whether your aws credential has access to the EKS cluster.
```plaintext
aws eks describe-cluster --name
```
2. If you don't have access, update your kubeconfig file. Replace "cluster-name" and "cluster region name" with your cluster's name and region.
```plaintext
aws eks --region update-kubeconfig --name
```
> **NOTE**
>
> Your aws credential must have permission to access EKS and your aws user must be included in the [aws-auth config map](/docs/cloudvisory-user-guide-4-10-2#). If not, please contact your AWS EKS cluster admin for help.
1. Add the ARN for `cspDiscoveryRole` in the aws-auth config map:
```plaintext
kubectl edit -n kube-system configmap/aws-auth
```
2. Add the following lines under mapRoles and update the cspDiscoveryRole ARN:
`cspDiscoveryUser`
```plaintext
- userarn:
username: cspDiscoveryUser
groups:
- system:masters
```
3. Save the change.
4. Confirm the new permissions:
```plaintext
kubectl describe configmap -n kube-system aws-auth
```
## Onboarding an AWS Account in Cloudvisory
1. Log into the Cloudvisory UI.
2. Click Admin Settings > Providers.
3. Click Add Account.
### Account information
1. Enter Account Name.
2. Enter Account Description (optional).
3. Enter the Access Key.
4. Enter the Secret Key.
5. Enter AWS S3 bucket for flows (optional).
6. Enter AWS S3 bucket for CloudTrail (optional).
7. Choose AWS Cloud Type (Default, US Gov or China).
8. Click Next.
### Configure Compliance checks
1. Select an option:
> **TIP**
>
> Use **Auto-Configure Compliance Checks** (the default selection) and see how Cloudvisory configures the compliance group and checks after adding the provider account.
- **Auto-Configure Compliance Checks**: If you select this option, Cloudvisory will create a default compliance group with this provider account and will enable default compliance checks.
- **Will Configure Manually** : If you select this, you must configure the compliance group and add checks manually.
2. Click Next.
3. Review and Click Submit.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
# Azure
## Step-by-step guide
You need the following information to onboard an Azure Provider Account in FireEye Cloudvisory Security Platform (Cloudvisory):
- **ClientId:** The Client ID (appId) of the CloudvisoryService, an Azure Active Directory Application.
- **ClientKey:** The Client Key (password) of the CloudvisoryService, an Azure Active Directory Application.
- **TenantId:** The Tenant ID of the CloudvisoryService Azure Active Directory Application.
- **FlowStorageResourceGroup:** The name of the ResourceGroup that is configured to gather all Azure NSG flows.
- **SubscriptionId:** One or more subscription IDs. This is optional.
## Task Overview
You can use either the Azure Cloud Shell or the Azure Portal to configure the account.
1. Configure the account using the Azure Cloud Shell *or*
2. Configure the account using the Azure Portal.
3. Configure additional permissions
4. Configure Azure flow logging
- Create Network Watchers in the Azure Portal
- Create an Azure storage account
5. Download flows by configuring a shared access signature in the storage account (optional)
6. Add the Azure account in Cloudvisory and configure compliance checks
## 1. Configure the Account Using Azure Cloud Shell
### 1.1 Launch the shell and check the list of subscriptions
1. Log into the Azure portal and click the **Cloud Shell** icon in the top-right corner. If you are doing this for first time, it may ask you to select a resource group, region and storage account. This document is for the Cloud Shell with bash script.
2. **Check Your Cloud Shell:**
- Copy the command below and execute it in the cloud shell. It should display the list of subscriptions in your tenant.
```plaintext
az account list --output table
```
Output:
```plaintext
Name CloudName SubscriptionId State IsDefault
---------- ---------- ----------------------------------- ------- ----------
cv1111 AzureCloud db7fc2fc-0d04-4bxxxxxxxxxxxxxxxx Enabled False
cv2222 AzureCloud f03a7b8a-67exxxxxxxxxxxxxxxxxxxx Enabled True
```
### 1.2 Create the Azure Active Directory application
- Copy the command below, replace `clientid` with your ClientID string, and execute it in the cloud shell. Copy the appId in a text editor.
```plaintext
az ad app create --display-name CloudvisoryService --identifier-uris https://www.cvapp-.cloudvisory.net/
```
Output:
```plaintext
{
"acceptMappedClaims": null,
"addIns": [],
"appId": "4c1805c3-6250-4246-8de1-a51768452286",
"appPermissions": null,
"appRoles": [],
...
"objectId": "62582d73-192a-4d0e-bb72-8e0348c8e089",
....
}
```
---
### 1.3 Configure the service principal for the CloudvisoryService Application
- Copy the command below, replace `appId` with the appID value collected in the previous step, and execute it in the cloud shell. Copy `objectId` in a text editor.
```plaintext
az ad sp create --id
```
---
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
Output:
```plaintext
{
...
"objectId": "da28ec8a-539a-4055-99d8-7600000da720",
"objectType": "ServicePrincipal",
...
}
```
### 1.4 Create the password or ClientKey for the CloudvisoryService application
1. Copy the command below, replace `objectId` with the value obtained in the previous step, and execute it in the cloud shell.
2. Copy the values of `appId` (for ClientId in Cloudvisory UI), `password` (for ClientKey in Cloudvisory UI), and `tenant` (for TenantId in Cloudvisory UI) in a text editor.
```plaintext
az ad app credential reset --id --append
```
Output:
```plaintext
{
"appId": "xx1805c3-6250-4246-8de1-a51768452286",
"name": "xx1805c3-6250-4246-8de1-a51768452286",
"password": "xx5a79e6-2e44-4037-9d21-d9b8fd57e88a",
"tenant": "xxcb6fa2-fae1-4c7e-8ef4-0f1a232cac69"
}
```
### 1.5 Assign a Role to the CloudvisoryService Application
Assign one of the following roles to the application:
- Azure built-in Reader Role and Readonly Azure Custom Roles (Recommended for Compliance Check run only, no remediation support)
- Azure built-in Contributor Role (Recommended for Compliance Check run and remediation support)
- Least Privilege Azure Custom Roles (Recommended for Compliance Check run and remediation support with least privilege)
The commands below will assign a Contributor role. To assign a Reader or Least Privilege role, see the topic **Azure Custom Roles**.
There are two ways to assign role a role:
- **At the Management Group level (recommended):** Allows Cloudvisory to access all the subscriptions of the group.
- **At the Subscriber level:** You must assign the role in each subscription.
**Assign the role to the Management group level (recommended).**
If you do not have a management group, you can easily create one in the Azure portal.
1. Find the management group ID: Execute the following command in the cloud shell and copy the ID from the output.
```plaintext
az account management-group list
```
Output:
```plaintext
{
...
"id": "/providers/Microsoft.Management/managementGroups/CloudvisoryMgmtGroup",
...
}
```
2. Create the role assignment: Copy the command below. Replace `object id of the service principal` with the object ID that you copied when you created the service principal. Replace `{id of the management group}` with the management group ID from step 1.
```plaintext
az role assignment create --role Contributor --assignee-object-id
BusinessUnitIds:
ConfigParms:
Tags:
- Key: Compliance Standards
Value:
- FireEye Demo B
DefaultSeverity: "MEDIUM"
Description: >
A sample check to illustrate a check supporting remediation.
Instructions: >
Can put HTML here for instructions on how to manually remediate here.
CanAutoRemediate: true
Service: "SSH"
Provider: "SSH"
MinimumRunInterval: 60
CheckType: "Custom SSH"
Category: "Example"
Version: "1.0.0"
ResultParams:
- File
- Desired-Value
- Actual-Value
CheckCode:
f="/tmp/some_file_to_test"
desired_perm='600'
desired_ownership="root:root"
```
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
```plaintext
if [ -f "$f" ]; then
perm=$(test_file_perms_le "$f" "$desired_perm")
if [ "$perm" -eq "$desired_perm" ]; then
ownership=$(get_ownership "$f")
if [ "$ownership" = "$desired_ownership" ]; then
add_fail_result "Details" "File ownership not correct" "File" "$f" "Desired-Value" "$desired_ownership" "Actual-Value" "$ownership"
else
add_pass_result "Details" "File ownership and permissions are correct" "File" "$f" "Desired-Value" "$desired_ownership" "Actual-Value" "$ownership"
fi
else
add_fail_result "Details" "File permissions are not correct" "File" "$f" "Desired-Value" "$desired_perm" "Actual-Value" "$perm"
fi
else
add_warn_result "Details" "File not found" "File" "$f"
fi
return_results 1
RemediationCode: |
```
```plaintext
#
# This is the code called when the user clicks remediate in the
# UI, this example code is setting the ownership of the file
# that failed the CheckCode above. The file name(s) are injected
# into the script below by the CSP calling program:
#
files='{{CLOUDVISORY_File}}'
desired_perm='600'
desired_ownership='root:root'
num=0
IFS="|"
for file in $files
do
num=$(expr "$num" + 1)
command=`sudo chmod $desired_perm $file > /dev/null`
retVal=$?
if [ "$retVal" -ne 0 ]; then
add_fail_result "Details" "chmod $desired_perm failed with return code: $retVal" "File" "$file"
else
command=`sudo chown $desired_ownership $file > /dev/null`
retVal=$?
if [ "$retVal" -ne 0 ]; then
add_fail_result "Details" "chown $desired_ownership failed with return code: $retVal" "File" "$file"
fi
fi
done
if [ "$num" -eq 0 ]; then
pass 1
else
return_results "$num"
fi
```
## Testing Your Checks
Once you have your yaml written, you'll need to test it. CV ships with a test program that allows you to run the code before deploying (below) for consumption by CV. You'll need to login to one of the 'consolidated' nodes where the 'cvcomptest' executable is installed. The easiest way to login to this system is to login to the inception server as the 'ansible' user, then ssh to one of the consolidated nodes, then change to the 'cvuser'.
> **NOTE**
>
> Contact your Cloudvisory representative if you don't know how to do this or have access to the inception server as the 'ansible' user.
1. Create/copy your yaml file to the directory read by the ssh compliance plugin:
1. % cp /tmp/mychecks.yaml /opt/cloudvisory/compliance/engine-2.3.9-compliancesvc/plugins/checks/ssh (make sure version is correct)
2. Create a json file with your SSH credentials, and set and environment variable (later used by the test program):
```plaintext
{
"Provider": {
"SSHCheckConfig": [
{
"Port": "22",
"Username": "YOUR_USER_NAME",
"KeyData": "YOUR_KEY",
"Targets": [
"YOUR_IP"
]
}
]
}
}
```
Note: KeyData must be in one line, For eg:
```plaintext
-----BEGIN RSA PRIVATE KEY-----
MIIJKQIBAAKCAgEAsuCNX/on3jXhXGIMrLf/9f1SHCd00JEuLK4p5UwcTr0ZFDmr
...
-----END RSA PRIVATE KEY-----
```
1. % cat /tmp/mysshcreds.json:
1. % export TESTCLI_PARAMS=/tmp/mysshcreds.json
2. % export TESTCLI_PLUGIN=/opt/cloudvisory/compliance/engine-2.3.9-compliancesvc/plugins/checks/ssh.so
3. Run the testcli, it should display your checks.
```plaintext
% cd /opt/cloudvisory/compliance/engine-2.3.9-compliancesvc
% ./cvcomptest
Attempting to load: /opt/cloudvisory/compliance/engine-2.3.8-compliancesvc/plugins/checks/ssh.so
+---------------------------------------+
| ID | NAME |
+---------------------------------------+
| ssh-999-001 | Check that illustrates |
| | returning a check |
| | failure |
+---------------------------------------+
```
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
```plaintext
| ssh-999-002 | Check that illustrates
| | returning a check warning
| ssh-999-003 | Check that illustrates success
| ssh-999-004 | Check that illustrates a check
| | that supports remediation
+------------+------------------------------------------------------+
```
### 4. Run a check:
```plaintext
command (or help): ssh-999-001
Enter 1 (run), 2 (remediate), or 3 (display): 1
RUN RESULTS----------------------------------------------------------------
SUMMARY: Check Failed: Check that illustrates returning a check failure
TOTAL CHECKS: 1, PASSED: 0, FAILED: 1, INFO: 0, WARN: 0, ERRORS: 0
Failures and Error Details:
+-----------+---------+------------------+---------------------------+----------+----------+
| # | ISERROR | SSHHOSTNAME | DETAILS | PROVIDER | CATEGORY |
+-----------+---------+------------------+---------------------------+----------+----------+
| 1 | false | 34.232.126.226 | This check has failed | SSH | Example |
+-----------+---------+------------------+---------------------------+----------+----------+
```
## Deploying your custom yaml file(s)
Once you've created the yaml file you wish to deploy, you then need to login to the FireEye Cloudvisory (CV) inception server (as the 'ansible' user), to deploy it (the file must exist somewhere on the filesystem of the inception server).
> NOTE
>
> Contact your Cloudvisory representative if you don't know how to do this or have access to this server.
our file name (or file names) are passed to the ansible playbook as an argument (with the ansible -e option). This playbook will stop the necessary CV services, copy the specified files to the necessary nodes, and then restart the services.
> NOTE
>
> The FireEye Cloudvisory UI will be briefly unavailable during this deployment
```plaintext
ansible-playbook /etc/ansible/playbooks/compliance/deploy-custom-ssh-checks.yml -e 'custom_files=/tmp/ssh_checks_1.yaml,/tmp/ssh_checks_2.yaml'
```
After the playbook runs successfully, it will take up to 10 minutes for your new checks to become visible in the UI, and to be available for inclusion in a Compliance Group.
> CAUTION
>
> ### Special Considerations
>
> 1. You must be careful to choose a unique 'Id:' and 'Version:' combination for your ssh checks. If you have two checks with the same Id/Version combination, CSP will only display one of the two (non-deterministic).
> 2. Upgrading CSP will require that you repeat the ansible playbook execution mentioned above to install your custom check with the new version of CSP.
# Custom Compliance Golang Checks
This document describes the process to build a custom check using the Golang programming language.
## Building Golang Plugin Checks
`Preconditions`
Plugins are a recent addition to the Go language, and in order to build a plugin that can be loaded by the Cloudvisory application there are a few specific steps which are necessary (these constraints are imposed by Golang's plugin architecture):
1. Golang version 1.10.3 (linux/amd64 architecture) is required.
2. The environment to build the plugin should have the same runtime environment as the system used to build the Cloudvisory application.
3. The same GOPATH directory structure as CSP is built with.
4. The complianceplugin github repo must be checked out in your GOPATH directory *(not satisfied with a glide/vendor dependency)*.
`Building the sample plugins`
Below are example steps for configuring an ubuntu instance to checkout and build the example checks:
1. Install an ubuntu 18 server.
2. Login to the server.
3. Install some needed packages:
```plaintext
sudo apt install make
sudo apt install golang-glide
sudo apt install gcc
cd /home/ubuntu
```
4. Install the correct version of go:
```plaintext
curl -L http://golang.org/dl/go1.10.3.linux-amd64.tar.gz | tar zxv
```
5. Export environment variables (can put these in ~/.bashrc file):
```plaintext
export GOPATH=/home/ubuntu/workspace/compliance_release/go << this path is important to deploy the custom check build with released version of compliance. If it is hotfix, it may be compliance_hotfix.
export GOROOT=/home/ubuntu/go/
export GOBIN=/home/ubuntu/go/bin/
export PATH=/home/ubuntu/go/bin:$PATH
```
6. Create the correct directory structure (very important):
```plaintext
mkdir -p ${GOPATH}/src/github.com/cloudvisory/
cd ${GOPATH}/src/github.com/cloudvisory/
```
7. Checkout the github/cloudvisory/complianceplugin repository (you will need to provide your github user name to your Cloudvisory support contact to access this private repo):
```plaintext
git clone https://github.com/cloudvisory/complianceplugin.git (enter your username and password when prompted)
git fetch --tags
git checkout (this version must match the CSP release of your installation)
```
## Description of plugin interface
In the complianceplugin repository, there is a types/types.go file which defines the interface that needs to be followed by a plugin so that it can be imported by Cloudvisory:
```plaintext
~/workspace/compliance_release/go/src/github.com/cloudvisory/complianceplugins$ tree types
types
└── types.go
```
In the sample directory, there is a very simple example check which doesn't do much, but implements the interface mentioned above and conveys the minimal code you need to build (customCheck001):
```plaintext
~/workspace/compliance_release/go/src/github.com/cloudvisory/complianceplugins$ tree sample
sample
├── custom_check.go
└── main.go
```
It is recommended that you get familiar with this code first, as well as ensure you can build the plugin before you go much further. To build the examples, run make:
```plaintext
~/workspace/compliance_release/go/src/github.com/cloudvisory/complianceplugins$ make
go build -buildmode=plugin -o custom.so sample/*.go
go build -buildmode=plugin -o custom_aws.so custom_aws/*.go
```
Once familiar with the simple example, you can dig deeper and see some examples of checks that interact with AWS and perform various checks and remediations:
```plaintext
~/workspace/compliance_release/go/src/github.com/cloudvisory/complianceplugins$ tree custom_aws
custom_aws
├── aws-500-001-v1_0_0.go
├── aws-500-002-v1_0_0.go
├── aws-500-003-v1_0_0.go
├── aws-500-004-v1_0_0.go
├── aws-500-005-v1_0_0.go
```
Copyright © 2021 Cloudvisory Documentation, FireEye Inc.
113
```plaintext
├─ aws-500-006-v1_0_0.go
└─ main.go
```
There are many helper methods in the custom_aws/main.go file that will be useful for extracting values that are passed in to your check at execution time (provider credentials, region, etc.). Spend a bit of time looking at these AWS examples, as they are working/realistic examples of provider interaction. You can now take these examples, and begin creating your own directory (parallel to the 'cloudvisory' directory in your GOPATH) to write y You can copy various *.go files, glide.yaml file (be sure to change your package name), and the Makefile to begin building your more useful custom plugin.
> **CAUTION**
>
> Ensure that when you run **glide up --quick** as opposed to simply **glide up** when building your plugin (this command is in the Makefile). It is necessary that the compliance plugin types interface dependency be satisfied in your GOPATH instead of the vendor directory - and this is accomplished with the **--quick** argument to glide. If this argument isn't specified when building your plugin, it will not load properly.
## Testing Golang Plugin Checks
Once you have your plugin built, you'll need to test it. CSP ships with a test program that allows you to run the code before deploying (below) for consumption by CSP. You'll need to login to one of the 'consolidated' nodes where the 'cvcomptest' executable is installed. The easiest way to login to this system is to login to the inception server as the 'ubuntu' user, then ssh to one of the consolidated nodes. Contact your Cloudvisory representative if you don't know how to do this or have access to the inception server as the 'ubuntu' user.
1. Create/copy your plugin file to the directory read by the compliance plugin:(*make sure Version is correct*)
```plaintext
cp custom.so /opt/cloudvisory/compliance/engine--compliancesvc/plugins/
```
2. Create a credentials file for your provider which will be read by the test program. The format of this file is similar to the input parameters for your custom check at runtime:
```plaintext
cat ~/aws_creds.json
```
```plaintext
{
"Parameters":{
"provideraccount":"AwsProvider"
},
"Provider":{
"Parameters":{
"AccessKey":"REDACTED",
"SecretKey":"REDACTED"
},
"Scope":[
{
"Key":"Region",
"Value":"us-west-2"
}
]
}
}
```
3. Export a variable that points to this file:
```plaintext
export TESTCLI_PARAMS=/home/ubuntu/aws_creds.json
```
4. Export another variable which tells the test program which plugin you wish to test:
```plaintext
export TESTCLI_PLUGIN=/opt/cloudvisory/compliance/engine--compliancesvc/plugins/checks/custom.so
```
5. Run the testcli, it should display your new checks:
```plaintext
% cd /opt/cloudvisory/compliance/engine-4.5.3-compliancesvc
% ./cvcomptest
Attempting to load: /opt/cloudvisory/compliance/engine-4.5.3-compliancesvc/plugins/checks/custom.so
+------------------------------------------------------+
| ID | NAME |
+------------------------------------------------------+
| custom-001 | Test Custom Check custom-001 |
+------------------------------------------------------+
```
6. You can call the Run() and Remediate() methods on your plugin from the test program:
```plaintext
command (or help): custom-001
Enter 1 (run), 2 (remediate), or 3 (display): 1
RUN RESULTS-------------------------------------------------------
SUMMARY: Custom Check 001 succeeded.
TOTAL CHECKS: 1, PASSED: 0, FAILED: 1, INFO: 0, WARN: 0, ERRORS: 0
Failures and Error Details:
+----+---------+---------------+----------+------------+
| # | ISERROR | REGION | PROVIDER | CATEGORY |
+----+---------+---------------+----------+------------+
| 1 | false | sample_region | Any | MONITORING |
+----+---------+---------------+----------+------------+
```
## Deploying your custom plugins
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
114
Once you've created the golang plugin file you wish to deploy, you then need to login to the CSP inception server (as the 'ubuntu' user), to deploy it (the file must exist somewhere on the filesystem of the inception server).
> [IMAGE PLACEHOLDER: Circular information icon with letter "i" inside]
>
> **NOTE**
>
> Contact your Cloudvisory representative if you don't know how to do this or have access to this server.
Your file name (or file names) are passed to the ansible playbook as an argument (with the ansible -e option). This playbook will stop the necessary CSP services, copy the specified files to the necessary nodes, and then restart the services.
> [IMAGE PLACEHOLDER: Circular information icon with letter "i" inside]
>
> **NOTE**
>
> The CSP UI will be briefly unavailable during this deployment
```plaintext
$ source /home/ubuntu/csp-ansible-installer/env/env.csp-ansible.local
$ csp-ansible.playbook.run compliance/deploy-custom-plugins.yml -e 'custom_files=/tmp/custom.so'
```
After the playbook runs successfully, it can take up to 10 minutes for your new checks to become visible in the UI, and to be available for inclusion in a Compliance Group.
> [IMAGE PLACEHOLDER: Yellow triangular caution icon with exclamation mark inside]
>
> **CAUTION**
>
> ### Special Considerations
>
> Upgrading CSP will require that you re-compile your plugin and repeat the ansible playbook execution mentioned above to install your custom plugin with the new version of CSP.
# Compliance Groups
## Definition
You can divide your accounts into compliance groups and configure compliance checks and reports for all the accounts in a group. Compliance groups are useful if you want to view your security posture by environment (for example, Development, Production, and Staging), business unit, location, and so on.

## Terms and Definition
### Compliance Groups
A Compliance Group is a group of Cloudvisory provider accounts that receive a collection of Compliance Checks for the purpose of configuring and reporting results.
### Compliance Groups Status
Compliance groups can be enabled or disabled. An enabled group will run all automated checks and generate automated reports. A disabled group will pause all automated checks and report generation.
### Account
Provider accounts can be assigned to compliance groups. The types of accounts will determine which checks can be configured in this group.
### Check Interval
All the checks in the Compliance Group can be configured to run at a given interval.
### Report Interval
The Compliance Group can be configured to automatically generate a report at a given interval.
### Alerts
All the active checks in a Compliance Group can be configured to trigger alerts. Alerts are displayed in the Cloudvisory UI and emails are sent to subscribers of the associated provider accounts.
## Create Compliance Groups
Consider the following things when you determine how to create and name compliance Groups.
- How do you want to report on compliance?
- By environment?
- By ownership?
- By Line of Business?
- By cloud provider?
- By site?
- How are your provider accounts currently structured?
This will often dictate how you can group accounts.
A provider account can only be associated with a single Compliance Group. If you only use a single provider account to discover and manage all your infrastructure, regardless of how it is used (development, production) or by whom it is used (team, business unit), then you also must use a single Compliance Group to check and report on compliance for those resources.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
[IMAGE PLACEHOLDER: "Create a New Compliance Group" dialog showing form fields for Name, Description, Notification Email and tabs labeled "1. General Information" and "2. Submit". Dark themed UI screenshot.]
## Step 1: Create a Compliance Group
1. Click on Create Group.
2. Enter a name for the group.
3. Enter a description (optional).
4. Click Next.
## Step 2: Select Accounts for the Group
> A provider account cannot be used in more than one group.
1. Select a provider from the dropdown.
2. Select one or more accounts to be assigned to this group.
3. Click Submit.
## Compliance Group Settings
Group-level settings define the behavior of the group. By default, group settings override the settings of the individual checks in the group. You can allow individual check settings to take precedence over group settings.
### Status
A compliance group can be Enabled or Disabled. When a group is disabled, the group's checks will not be run, reports will not be generated, and alerts/notifications will not be created. Disabling a compliance group is useful when you know its resources may be entering a maintenance window and you do not want compliance checks to be running.

### Check Interval
The interval at which Cloudvisory runs the compliance checks on the entire group. The group level interval overrides all individual check settings. You can retain each individual check's interval by selecting "Defined by Checks."
Individual checks specify their own minimum check interval. Some checks you may be able to run as often as every 5 minutes, while others you may only be able to run once per hour.
If you specify a compliance group check interval that is shorter than the minimum interval of a check within the compliance group, that check's minimum check interval will be used for that check only. For example, if you set the Compliance Group check interval to 1 hour, but there are some checks in the Compliance Group that have a minimum check interval of 6 hours, then for those checks only, the 6-hour interval will be used.
When choosing a check interval for a compliance group, consider how often you really need to run the check. Many cloud providers have rate-limiting enabled on their API endpoints, and setting too short an interval can trigger rate limiting.

*The Check Interval dropdown displays all the interval options for that group. "Define by Checks" means that the individual settings for each Compliance Check will take effect.*
### Report Generation
How often the compliance reports will be generated. Reports can be generated as frequently as hourly. For most compliance reporting, daily reports are sufficient. Remember that at any time, you can generate an on-demand report.

*The Report Generation dropdown displays all the interval options for that group. "On Demand" stops the automated report generation and requires users to generate reports manually.*
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
## Alert Notification
Alert notifications can be sent to administrators/operators by email if there are any compliance violations. The group-level alert notifications override all individual check settings, unless "Defined by Checks" is selected. Use the dropdown in the Alerts column.

*The compliance alert email notifications can be turned on or off for all of the checks within a group. "Define by Checks" means that the individual settings for the Compliance Checks will take effect.*
### Changing Multiple Compliance Group Settings
Settings such as enabling/disabling compliance groups, group-level check intervals, report generation and alert notifications can be set on multiple compliance groups simultaneously.

To change multiple settings simultaneously, select the checkboxes and use the Bulk Actions dropdown.

### Changing the Name or Description of a Compliance Group
To edit an existing compliance group, click the pencil icon on the right side of the table.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
118

*Clicking the edit icon opens a popup where you can change a Compliance Group's name and description.*
## Deleting Groups
Deleting a group stops all compliance check and automated report activity. Any prior reports will remain available in the historical view.
*Clicking the delete icon opens a popup to confirm the group's deletion.*

## Filtering/Sorting Compliance Groups
Click Toggle Filters to filter the Compliance groups. Use pagination and sorting to quickly find groups or refine your Compliance Groups search.

*Filters are on the left frame. Pagination can be found at the top and the bottom of the table. Sorting can be done at the header of each column.*
## Adding Compliance Checks to a Compliance Group
> Changes to the compliance group configuration settings do not affect any instances of compliance checks outside that group.
To configure the checks within a Compliance Group, click the Configure button on the right side of the screen.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
119

Clicking Configure displays a list of all of the compliance checks that are available for the Compliance Group. Available checks may vary depending on the types of associated provider accounts.
> No checks are visible in the Compliance Group if no provider accounts have been associated with the group. When one more provider accounts are associated, the relevant checks will appear. You may need to refresh the page.

Group-level settings, such as Group Alerts, Check Intervals or Report Generation, are displayed at the top of the screen. Some group-level settings override individual compliance check settings. To enable the individual check settings, open the Group Settings and select Defined by Check for the desired option.

By default, checks added to a group are inactive until you enable them.
## Compliance Check Settings within a Compliance Group
### Enable/Disable Check
Checks by default are inactive in Compliance Groups. To make a check active, click the "Inactive" toggle to change it to "Active." To disable a check for the group, change toggle to "Inactive" again.
When a check is inactive, the group will no longer run that check or show it in future reports. It will still be visible in reports that were generated when it was active.
Inactive checks in a compliance group are disabled only for that specific group. All instances of the check outside the group are still active.

*Clicking on enable/disable for a Compliance Check will open a popup to confirm your action.*
### Severity Level
The severity level of a specific compliance check can be changed in a group. Changing the severity affects the way the reports are scored and how alerts/notifications are propagated. Use the dropdown in the Severity column for the check.
> Changing this setting will not affect any instances of this compliance check in other Compliance Groups.
### Check Interval
If the the group setting for check interval is set to Defined by Checks, you can change the check interval for individual checks. Use the dropdown in the Interval column.
All checks have a minimum check interval defined. Some checks you may be able to run as often as every 5 minutes, while others you may only be able to run once per hour.
When choosing a check interval, keep in mind that many cloud providers have rate-limiting enabled on their API endpoints. Setting too small an interval can trigger rate limiting.
> **NOTE** Changing this setting will not affect any instances of this compliance check in other Compliance Groups.

### Auto Remediation
If auto remediation is enabled, then Cloudvisory will remediate the check as soon as a violation is detected. If auto remediation is not enabled for a check, push-button remediation is available from the summary reports and alerts screen. If the check does not support remediation, then N/A appears in the Auto Remediation field.
---
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
> **CAUTION**
>
> Take care when enabling auto-remediation. Make sure you understand what remediation means for the particular check.
Changing this setting will not affect any instances of this compliance check in other Compliance Groups.

*If a compliance check does not support remediation, "N/A" is displayed.*
## Alerts
Alert notifications can be turned on and off for any individual Compliance Check. These are administrative alerts that appear in the Cloudvisory UI and trigger email notifications to subscribers of alerts for the related provider account. To configure email subscriptions for administrative alerts, go to [Email Alert/Request Notifications](/docs/cloudvisory-user-guide-4-10-2#)
Changing this setting will not affect any instances of this compliance check in other Compliance Groups.

## Managing Compliance Group Accounts
Accounts can be added and deleted in compliance groups at any time. Click the edit (pencil) icon next to Manage Accounts.

Available accounts are displayed in the left panel. Select a checkbox to add an account.
*The account will be displayed under "Accounts to be Added".*

Accounts already in the group are displayed under Existing Accounts in the right panel. Select a checkbox to remove an account from the group.
*The account will be displayed under "Accounts to be Removed".*
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
# Email Alert/Request Notifications
You can specify the email addresses that will receive notifications of new alerts or requests. In order to receive alert notifications by email, you need to configure SMTP. For additional details on how to configure SMTP, please refer to Configure SMTP for Email Alert Notification Using Ansible below.
The Notifications landing page displays all the email addresses that will receive alert or request notifications. Click a row to display additional details about that subscription.
## Configure SMTP for Email Alert Notification Using Ansible
1. Log in to the management/inception server.
2. Source the environment file for the CSP deployment / site you need to manage:
```plaintext
. ~/csp-ansible-installer/env/env.your-site-environment-file.dev
```
3. Add the office-smtp.yml, gmail-smtp.yml, or relay-smtp.yml file at /home/ubuntu/csp-ansible-installer/files/{site}/csp_customizations/
#### office-smtp.yml
```plaintext
cv_manager_mail_provider office365: true
cv_manager_mail_enable: true
cv_manager_mail_host: 'smtp.office365.com'
cv_manager_mail_port: '587'
cv_manager_mail_username: ''
cv_manager_mail_password: ''
cv_manager_mail_smtp_auth: true
cv_manager_mail_smtp_ssl_enable: true
cv_manager_mail_from_address: ''
cv_manager_mail_reply_to_address: ''
cv_manager_mail_from_alias: 'CSP Contact'
```
#### gmail-smtp.yml
```plaintext
cv_manager_mail_enable: true
cv_manager_mail_host: 'smtp.gmail.com'
cv_manager_mail_port: '465'
cv_manager_mail_username: ''
cv_manager_mail_password: ''
cv_manager_mail_smtp_auth: true
cv_manager_mail_smtp_ssl_enable: true
cv_manager_mail_from_address: ''
cv_manager_mail_reply_to_address: ''
cv_manager_mail_from_alias: 'CSP Contact'
```
#### relay-smtp.yml
```plaintext
cv_manager_mail_enable: true
cv_manager_mail_host: 'mail.smtp2go.com'
cv_manager_mail_port: '2525'
cv_manager_mail_smtp_auth: false
cv_manager_mail_smtp_starttls_enable: false
cv_manager_mail_smtp_ssl_enable: false
cv_manager_mail_from_address: 'cloudvisory.test@cloudvisory.com'
cv_manager_mail_reply_to_address: 'cloudvisory.test@cloudvisory.com'
cv_manager_mail_from_alias: 'CSP Contact'
```
1. Run csp-ansible.config.
2. Run ansible commands to configure SMTP and restart the service.
# Exporting a Report
To export a report:
1. Click the report button.
2. Select the type of report you want.
3. 
Enter the report name and select a format for the report.
4. 
Click Download.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
123
# Historical Report
The historical view plots a chart with all the reports generated by the Compliance Group for a specified date range based on score, categories and severity.
## Viewing Historical Reports
From Reports > Compliance Reports click on "History"

The default report displays a graph with all the previously saved reports based on their scores. You can view the reports by Score, Categories or Severity. All the past reports are listed in chronological order.
## Changing the Date Range
To change the date range for the historical view, click on the date dropdown. The default date range is from 2 weeks ago to the current date. Use the dropdown on the left to specify the starting date and time, and the dropdown on the right to specify the end date.

## Sorting, Filtering and Pagination
### Sorting
By default, historical reports are sorted by the most recent first.
### Filtering
You can filter the report results with the filters on the left panel: by score, check passes, check fails and check errors.
### Pagination
By default, 25 results are displayed per page. To view more results at once, you can switch the setting to view more than 25.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
124
# Compliance Report
## Compliance Reports Overview
Compliance reports can be generated automatically or run on demand. Reports provide a snapshot into your compliance posture at a particular point in time. Cloudvisory retains reports for a year, and you can view and download these historical reports.
## View Reports Landing Page
> To view the reports, go to Reports > Compliance Groups

## Terms and Definitions
### Score
Compliance Report Scores are based on the passing and failing of the individual checks. 100% means all checks pass. 0% means no checks pass.
### Pass/Fail/Error/Total
Pass/Fail represent the number of checks that have passed or failed in that group. Errors are the number of checks that failed to run. Total represents the number of checks in that group.
### Status
The status indicates whether the report is running, disabled or deleted. If a group is running, then all of its automated processes are running. If a group is disabled, then all of its processes are paused. If a group is deleted, the group will no longer exist, but Cloudvisory will retain all of its old reports.
### Last Report Date
The last report date is the date when the last report was generated.
### CSP_ID
The CSP_ID is a unique ID assigned to the compliance checks within a report. This ID can be used for auditing, inspections, and investigation.
### First Seen
First seen is the time when an alert is first seen in the system.
### Number of Occurrences
The number of times that an alert has been triggered.
### Summary
The summary report provides an overview of the current health of that report. It indicates the current score broken down by risks and displays all the running checks within that group.
## Detail
The detailed report lists an exploded view of all of the passed and failed compliance checks and errors in that group. This report can be exported as a CSV, PDF or XLS file.
### History
The historical view allows you to view all the previously generated reports. You can access both the summary views and the detailed reports. Cloudvisory stores the reports for up to one year, but after 90 days it will only keep one report per day.
## Reports
The reports dropdown displays all the detail report options for that compliance group. All reports by default include a "Cloudvisory Detail Report".
Copyright © 2021 Cloudvisory Documentation, FireEye Inc.
125
# Compliance Reports Retention Details
| **Data Type** | **Retention Period** |
| --- | --- |
| Alert Details | 60 days |
| Check Result Details | 90 days |
| Reports | 360 day |
| Reports (interval less than 24 hours) | 90 days |
These retention intervals can be configured in the **application.properties** for the manager service.
## Creating Reports On Demand
On-demand reports can be generated in two ways.
- Click the Report dropdown on a specific Compliance group row and select a report type.

- Select one or more rows and select Generate Report from the Bulk Action menu.

*Generate a report for one or more groups by using the Bulk action dropdown menu*
A dialog box asks if you would like to run all the checks prior to generating the report. If you click Yes, all the checks will run before the report is created. If you click No, then the last check results will be used.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.

## Deleting Reports
Reports can be deleted by using the Report dropdown on a specific row, or by selecting multiple rows and using the Aulk action menu.
Deleting a compliance group report deletes all historic data for the compliance group.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
127
# Summary Report
## Summary Report
The summary report displays several metrics that provide a quick overview of the compliance group's health. The checks are sorted by severity and their pass percentages in order to display the items that are most critical first.

## Components
### Score Gauge
The score gauge displays the score of the compliance report.
### Risks by Severity
This chart displays the number of checks in each severity category that did not pass.
### Risks Found
The total number of check failures across the groups' compliance checks.
### Errors Found
The total number of checks that failed to run.
### Checks Passed
The total number of check passes across the groups' compliance checks.
### Total Checks
The sum of all the check passes and failures across the groups' compliance checks.
### Group Checks
The number of compliance checks in this group.
### Accounts
The number of accounts associated with this compliance group.
### Identified Risks over Time
The total risks within that group over a period of time.
### Risks by Categories
The total risks by category, such as Networking and IAM.
### Top 10 Risks
The top 10 offenders for Regions, Accounts and Collections.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
128
# Filtering
> Filter the summary report by clicking on the toggle filter icon.
You can filter the report by ID, severity, pass percentage and categories.

## Summary Report Check Detail
Click on a compliance check to open a window with the details for the check. This window contains the failed checks for that group check, a list of the errors, and remediation steps.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
129

## Tabs and Definition
Passed — The check was successful (expected result was obtained).
Failed — The check was unsuccessful (expected result was NOT obtained). If left unaddressed, this is considered a potential security risk.
Info — The check result cannot be determined by Cloudvisory and requires operator intervention. The check provides information on which you may choose to take action. For example, a check might return all users with the Admin role. It is up to the operator to review the appropriate usage of that role.
Warnings — The check could not determine a pass or fail due to improper permissions, rate limiting, missing data/file, or other reasons. You can view the details of the warning to determine how to rectify the situation.
Errors — The check could not be performed due to a malformed request, malformed response, or connectivity issue.
## Manual Remediation
To view the manual steps to remediate this check, click on "How To Remediate".

## Automatic Remediation
To remediate checks that can be remediated by Cloudvisory, click on the Remediate button.
## Notifications
You can specify the users who will receive notifications for failed checks.
1. Click on Notify. The exclamation mark next to the Notify button means there are no assigned recipients for that check.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
2. Enter the recipient's email address. You can also change the subject and edit the body with custom parameters.
3. Click Submit.
When a check fails, the owner of that check can be notified directly from the detail popup.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
131
# Network Groups
You group together network objects that handle the same types of traffic into a network group. Network groups allow you to classify different types of traffic. Any network object can belong to one or more network groups.
Cloudvisory is configured with a default network group called "Internet" with the network object internet, which represents the entire space of routable IP addresses. By default, all traffic is classified as traffic to or from the Internet. You should define additional network groups for all your network objects to classify your internal network traffic separately from Internet traffic.
## Viewing Network Groups

## Creating a Network Group
1. Click Add Network Group on the Network Groups tab.
2. Enter a name and a description. The name must be unique.
3. Select one or more network objects for the group.
4. Click Save.

## Editing a Network Group
To change the name of a group, click the edit icon next to the name.
To add or remove a network object from a network group:
1. Click the edit icon on the right.
2. To delete an existing network object, click the delete icon on the right.
3. To add a new network object, select the network object and click Add.

Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
132
# Tag Policies
Cloudvisory provides very strong dynamic policy orchestration using tag/metadata/labels.
You can define a policy with a list of unique tag and value combinations, and then add a list of inbound/outbound network rules. Cloudvisory dynamically discovers the workload from the provider, matches tag-value combinations, and creates appropriate network security group rules for the matching workload.
Note the following about the dynamic nature of network policy:
- A tag can be used in multiple policies, and multiple tags also can be added in one policy.
- Each tag name and value combination set must be unique across policies.
- For a policy to be applied to a workload, the workload must have all the tags included in the policy definition.
- Tags name and values are both case sensitive.
- When a tag is associated with a workload within Cloudvisory, the policies associated with the tag are applied to the workload.
- You can require explicit admin approval before policies are applied to the workload.
- Removing a tag from a workload will remove all policies depending on that tag from the workload.

## Adding Policies
To create a policy, follow these steps:
1. Click on "Add Policy" in the Network Policies Landing Page.
2. Select one or more tags and enter a name and description for the policy.
3. Click Review and Submit. You can add inbound and outbound rules on the next screen.

## Policy Details
Clicking on a policy takes you to the policy detail page. You can view the associated tags, edit the rules, view the associated workloads, change associated workload states, and delete the policy.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
133

## Adding Rules to a Network Policy
1. Click a network policy on the Tag Policies page.
2. Click the Inbound Rules or Outbound Rules tab.
3. Click Add Rule to add rules.
4. Click Submit when you are finished.

## Deleting Rules from a Network Policy
Rules can be deleted from the Policy Information page, Inbound Rules tab, or Outbound Rules tab.

## Tags
This tab shows the list of tags and values included in this network policy.
## Resources
This tab shows the list of workloads attached to this network policy.

To change the policy state, select one or more workloads and click Edit Selection.
## Activity
This tab shows the list of activity of the network policy.
## Deleting Network Policies
Policies can be deleted from the policy detail page.
## Changing the Network Policy Name and Description
To update the network policy name and description, click Edit Policy.
Copyright © 2021 Cloudvisory Documentation, FireEye Inc.
134

Update Name and Description and click Save.

Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
135
# Network Objects
Network objects represent routable network addresses inside and outside the enterprise network. Use network objects to classify and visualize discovered network traffic that is not associated with discovered Provider resources IP addresses. Network objects can be the target of Network Policy rules.
Each network object is configured with one or more address ranges specified in CIDR notation (for example, 10.1.1.0/24). If two network objects have CIDRs that overlap, flows are associated with the Network object that has the CIDR with the longest prefix (the largest mask size). Cloudvisory does not allow the same CIDR to be specified in multiple Network objects.
Cloudvisory is configured with a network object called 'internet' with CIDR 0.0.0.0/0, which represents the entire space of routable IP addresses. By default, all traffic is classified as traffic to or from the Internet. You should define additional network objects covering all the IP addresses in the internal enterprise network. This prevents internal network traffic from being classified as traffic to or from the Internet.
## Viewing Network Objects
> To view the network objects page, go to Governance > Network Groups. Click Network Objects.

## Creating a Network Object
1. Click Add Network Object on the Network Objects tab.
2. Enter a name and a description. The name must be unique.
3. Enter a range of IP addresses that will belong to the group.
4. Click Save.

## Editing Network Object
Click the edit icon next to the name to change the name. Name must be unique. To add a new address to an existing network object, click on Edit Icon on the right.
Copyright © 2021 Cloudvisory Documentation, FireEye Inc.
# jenny-nkg
 [New Address](/docs/cloudvisory-user-guide-4-10-2#)

#### Address
- 209.85.200.95/32 
- 34.71.36.196/32 
- 108.177.112.95/32 
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc. 137
# Network Security
Use the Network Security tab to create and manage security groups and security group rules across multiple providers.

## AWS - Create Security Group
1. Click the provider on the left and click New Security Group.
2. In the dialog box, enter information about the group. The information required depends on the provider. Click Save.
The new security group appears in the list.
3. When "Provisioned" is displayed in the State column, the group is ready. Go to Edit Security Group below to add rules and subnets.

## AWS - Edit Security Group
1. Click the row of the security group.
2. In the details pane on the right, click Edit Security Group.
3. Enter new rules on the Inbound or Outbound tab.

To attach a VM, click Attach Entities, then click VMs.

1. Click Attach VM and enter the VM information.
2. Click Review and confirm that the content is correct.
3. Click Submit.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
138

- Click 'Attach Entities', then, 'VMs', and 'Attach VM' button.
- Add Inbound and Outbound Rules
- Review and Submit Security Group
### Add Subnets (Azure Provider Only)
Click Azure on the left. The subnets are discovered and displayed.

### Azure - Attach Security Group
- Click a subnet and subnet detail will show up on the right side.
- Click 'Add Security Group' to select a network security group to attach

Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
# Flow Collector
To view, Go to **Settings > Flow Collector**
The Flow Collector collects data for the flow analytics. The **Flow Collector** page displays the flows and their status.
To turn the flow collection on or off for an individual agent, click ON or OFF in the Flow Monitoring Status column.

To turn the flow collection on or off for multiple agents simultaneously, select their checkboxes. Select **Bulk Action > Edit selection/Delete Selection**.
Click the number in the Resources column to display the list of servers attached to the agent.
To delete a flow collector, first turn it off. Then click the icon in the Delete column.
> i
>
> **NOTE**
>
> The flow collector may reappear and try to connect if it is running when you delete it. Before deleting, stop the flow collector.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc. 140
## Import & Export
Exporting your Cloudvisory configuration is good practice. The exported file is a valuable backup of all your provider account settings, configuration, and network policies that can be restored in a DR event or site migration.
### Importing a Cloudvisory Configuration
Import a previously exported Cloudvisory configuration file to create or override the Cloudvisory configuration or settings.
1. Click Choose File and select the zip-formatted exported file that you wish to import.
2. Click Import Data.
3. Enter the site name. If this exported file is from the same site, the name is populated already. Otherwise, get the site name from the management server.
4. Click Import Data. It may take a few minutes to import the file.

### Exporting a Cloudvisory Configuration
You can export settings or configurations for any of the Cloudvisory features listed below. The export is a zipped file that contains a YAML file that can be edited and imported to any Cloudvisory environment.
1. Select the objects that you wish to export and click Export Data.
2. Review the total number of objects being exported for each of the selected items.
3. Click Download to export the zipped YAML file with all the configurations and parameters.

Copyright © 2021 Cloudvisory Documentation, FireEye Inc.
141
# Providers
## View Provider Accounts
All supported providers can be viewed at System Settings > Providers.

## Add Provider Accounts
Some provider accounts require certain prerequisites to be met or settings to be configured. Refer to the onboarding document for the provider before adding an account.
[AWS (Deployed in AWS Cloud)](/docs/cloudvisory-user-guide-4-10-2#)
[AWS (Deployed outside AWS Cloud)](/docs/cloudvisory-user-guide-4-10-2#)
[Azure](/docs/cloudvisory-user-guide-4-10-2#)
[GCP](/docs/cloudvisory-user-guide-4-10-2#)
[Openstack](/docs/cloudvisory-user-guide-4-10-2#)
[Kubernetes](/docs/cloudvisory-user-guide-4-10-2#)
[SSH](/docs/cloudvisory-user-guide-4-10-2#)
## Edit Provider Account
**Provider account can be edited at Settings > Providers.**
Click on the edit icon on the right side of the selected provider account.
Make the changes to the available fields. When your changes are finished, click Save.
## View Account Information
Click the provider account name to view the provider account information.
## Edit Provider Icon Settings
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
### AWS Icon Configuration

**Name:** ProviderType

**Name:** AwsRegion

**Name:** AwsEc2Vpc

**Name:** AwsEc2LoadBalancerV1

**Name:** AwsEc2LoadBalancer

**Name:** AwsEcsContainerInstance

**Name:** Host

**Name:** AwsEks

**Name:** AwsEksNode

**Name:** KubernetesNamespace
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
143
# Alerts & Notifications
## Alerts
This section allows you to define the flow violation rollback settings. Flow violation rollback automatically reverts the security rule that caused the flow violation to its original state. Rollback is effective if a user creates rules in the Network Policies tab or Visualization tab and changes the workload state to enforced.

## Notifications
The Notifications page displays the email addresses that receive System Notifications , Request Notifications, or Compliance Notifications.

For each type of notification, you can configure one more email addresses with one or more provider accounts. One or more email templates are provided for each type.
### Add a New Email Address
1. Click Add New Email.
2. Enter the email address and select one or more provider accounts.

### Delete an Email Address
Delete an address by selecting the row using the check box.
### Add or Delete Account for Existing Email
You can delete or add more accounts for any email.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.

## Email Template
One or more email templates are provided for each type. Each of these can be viewed and updated.

Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
145
# Identity and Business Units
You can restrict access by creating unique user roles and attaching roles to business units. A role is a set of specific permissions. Each permission permits a specific task in Cloudvisory. A business unit groups one or more provider accounts together. Attaching a role to a business unit applies the role to all the accounts in the unit.
The **Settings > Identity & Business Units** page shows the roles, users, and business units.
## Roles
The 'appadmin' role includes all Cloudvisory UI permissions.
The 'appadmin' role must NOT be updated or deleted. Any role can be copied and modified.

## Create a Role
On the Roles tab, click New Role. Enter the Role Name and Description. Click Next.

Select the user permissions using checkboxes or copy the permissions from an existing role. Copying permissions from an existing role is recommended.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
146

Click Review and Submit.
Next, add one or more business units with the role to restrict user access.
## Add a Business Unit to a Role
Click the role and then click Business Units. Click Add Business Unit to select from existing business units. If there are no business units, see Create a Business Unit below.
A role assigned to no business units (0) means the user with the role has access to all provider accounts.


Select one or more business units and click Save.
## Business Units
Click the number in the Account Access or Attached Role column to see details.
## Create a Business Unit
Click Create Business Unit on the Business Unit tab.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
147

Enter a Business Unit Name and Description. Click Next.
Select one or more providers or provider accounts for the business under Objects Management. Click Next.


Click Review and Submit.

## Edit Roles and Business Units
Click a role to add or change permissions.
Click a business unit to add or remove accounts.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
148

To add an account or provider, click Add Account.

Select one or more provider or accounts to add. Click Submit. To remove an account from a business unit, click the Delete icon in its row.
## Users
Tighten security by creating unique user with roles with specified permissions and business units.

## Add a User
Click Add User on the Users tab. Enter the User Name and Password, and confirm the password. Click Select Roles to assign one or more roles to the user. Click Submit when you are finished.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
149

## Reset User Password
Administrators can reset the password for an user. Click Reset Password in the user row on the Users tab. Enter the new password. Confirm the password, then click Submit.

## Edit a User Role
Administrators can change the roles assigned to a user. Click Edit Role in the user row on the Users tab. Select a role and click Submit.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
150
## Edit User Details
User Name:
cvdeploytmpadmin
First Name:
Enter First Name
25 characters left
Last Name:
Enter Last Name
25 characters left
Email:
Example: user@domain.com
50 characters left
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
151
# System settings
## Configuration Tab
Cloudvisory compliance checks can be configured to send notifications automatically. Notifications are delivered to the administrator of the compliance group, if the customer notify configuration is set at group level, or at individual check level. In this configuration, the asset owner can also receive the email for the violation or remediation.
License alert can be sent to the owner by configuring email using **License Alerts Email Recipient**. The asset owner email address is set using a tag and value. Configure the tag name using the **Email Tag** option.

## License Tab
This tab allows to configure license by uploading the license file.

## Jira Tab
This tab allows the user to configure jira to track severity tickets.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
152
## Alerts, Notifications & System Settings
Notifications
Alerts
System Settings
Configuration License Jira
| | Name | Value |
| --- | --- | --- |
| | Jira URL | |
| | Jira Username | |
| | Jira Password | |
| | Jira Project Key | |
| | Jira Ticket Label | |
| | Jira Ticket Priority Low | |
| | Jira Ticket Priority Medium | |
| | Jira Ticket Priority High | |
| | Jira Ticket Priority Critical | |
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
153
# Scheduled Reports
The Scheduled Reports Inspector lists all reports that have been scheduled. You can edit some report settings or delete a scheduled report. You can filter the list to narrow down a search.
### Available Filters
Select a column heading to filter scheduled reports by frequency, name, status, or type.
`Frequency`, `Report Name`, `Report Status`, `Report Type`
### Edit Settings
Select a report and click the pencil icon in the Edit column to change settings of a scheduled report.
> **NOTE**
>
> You cannot modify the report's name or filters using the Scheduled Reports Inspector.

## Delete a Scheduled Report
Select a report and click the trash can icon in the Delete column to remove the report from the schedule.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
154
# Search Filters
Cloudvisory provides the following search filters to narrow down your seach results.
## Available Filters
> INFO
>
> Auto-Suggest is enabled for all search filter values except Named Values and Boolean Type: filters.
Action
**Definition:** The alert's action state: `acknowledged` or `unacknowledged`.
**Type:** Named Values
**Values:** `acknowledged`, `unacknowledged`
Alert Type
**Definition:** The type of event or action that triggered the alert.
**Type:** Named Values
**Values:** `Compliance`, `Enforcement`, `Flow`, `GCP Admin Add Group Member`, `GCP Admin Add User`, `GCP Admin Delete User`, `GCP Admin Remove Group Member`, `GCP App Engine Delete Service`, `GCP App Engine Update Service`, `GCP Compute Create Firewall Rule`, `GCP Compute Create Instance`, `GCP Compute Create Network`, `GCP Compute Create Subnet`, `GCP Compute Delete Firewall Rule`, `GCP Compute Delete Instance`, `GCP Compute Delete Network`, `GCP Compute Delete Subnet`, `GCP Compute Reset Instance`, `GCP Compute Start Instance`, `GCP Compute Stop Instance`, `GCP Compute Update Firewall Rule`, `GCP Iam Set Policy`, `GCP Kubernetes Create Cluster`, `GCP Kubernetes Delete Cluster`, `Membership`, `Move`, `Policy`, `Remediation`, `State`, `System`, `Threat`
Asset Name
**Definition:** The name given by the user to an asset, service or resource in a cloud provider registered in Cloudvisory.
**Type:** Alphanumeric
**Values:** User Input
ID
**Definition:** The unique identifier generated when an alert is triggered. IDs are usually alphanumeric values.
**Type:** Alphanumeric
**Values:** User Input
**Example:** 2e3a3f71-7c32-4366-935e-dffbef65da25
Provider Account
**Definition:** Name of a specific provider account of a cloud service provider that is registered in Cloudvisory.
**Type:** Alphanumeric
**Values:** User Input
**Example:** dev-vm1
Provider Type
**Definition:** Type of cloud service provider registered in Cloudvisory.
**Type:** Named Values
**Values:** Depend on the cloud service provider registered in Cloudvisory.
**Example:** AWS
Region
**Definition:** The provider account's geographic region associated with a particular asset.
**Type:** Named Values
**Values:** Depend on the cloud service provider registered in Cloudvisory.
**Example:** us-east-1(for AWS cloud provider)
Severity
**Definition:** Severity of the associated risk (compliance failure): CRITICAL, HIGH, MEDIUM or LOW.
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
**Type:** Named Values
**Values:** Critical High Medium Low
### Asset ID
**Definition:** Unique identification of the asset name on the cloud provider.
**Type:** Text
**Values:** User Input
### Asset Name
**Definition:** Name given to an asset on the cloud provider.
**Type:** Text
**Values:** User Input
### Asset Type
**Definition:** The service, resources and purpose of each asset on the cloud provider.
**Type:** Named Values
**Values:** Agent, AWS API Gateway, AWS Cloud Trail, AWS EBS Snapshot, AWS EBS Volume, AWS NAT Gateway, AWS Subnet, AWS VPC, AWS Elastic File System, AWS IAM Group, AWS IAM Policy, AWS IAM Role, AWS IAM User, AWS Lambda, AWS Region, AWS Route53, AWS S3 Bucket, AWS SNS Topic, Azure AKS, Azure API Management, Azure App Service, Azure Disk, Azure DNS Zone, Azure Function App, Azure IAM Role, Azure IAM Role Assign, Azure IAM User, Azure Postgres DB, Azure Postgres Server, Azure Resource Group, Azure Storage Account, Azure Subnet, Azure Subscription, Datacenter, GCP Alert Policy, GCP K8S Engine, GCP IAM Role, GCP IAM Service Account, GCP KMS Key, GCP Managed Zone, GCP Network, GCP Project, GCP Project Logging, GCP Region, GCP SQL Instance, GCP Storage Bucket, GCP Subnet, K8S Deployment, K8S Namespace, K8S Node, K8S Pod, K8S Service, Network Policy, OS Hypervisor, OS Identity Domain, OS Identity Group, OS Project, OS Identity Role, OS Identity User, OS Subnet, SecurityGroup, VM
### Category
**Definition:** Compliance check category, based on the cloud provider's resource and services.
**Type:** Named Values
**Values:** Access, AuthN and AuthZ, ACM, AKS, API Management, AppService, AWS IAM, Beanstalk, BILLING, BLOCK STORAGE, Cloud SQL Database Services, CloudFront, COMPUTE, DASHBOARD, Data Streaming, Database Services, DNS, EKS, GKE, IAM, Identity, Initial Setup, IoT, Logging, Logging and Auditing, Master Node (API Server), Master Node (Config Files), Master Node (Controller Manager), Master Node (etcd), Master Node (Pod Security Policies), Master Node (Scheduler), Master Node (security primitives), MONITORING, Network Configuration, Networking, NETWORKING (Security Group), PROJECT, Redshift, SECURITY, SECURITY GROUP, SQL DATABASE, SQL SERVER, STORAGE, System Maintenance, VM, Worker Node (Config Files), Worker Node (Kubelet)
### Check Action
**Definition:** Filter compliance checks based on the action taken: Run or Remediate.
**Type:** Named Values
**Values:** Run or Remediate
### Check ID
**Definition:** unique identification value of a compliance check.
**Type:** Alphanumeric
**Values:** User Input
**Example:** aws-100-070
### Cloudvisory User
**Definition:** Cloudvisory username.
**Type:** Alphanumeric or Email address
### Compliance Standard
**Definition:** Available compliance standards in Cloudvisory.
**Type:** Text
### Events
**Definition:** Filter compliance checks based on the event that occurred: CheckError, CheckException, CheckFailed, CheckInfo, CheckPassed and CheckWarning.
**Type:** Named Values
**Values:** CheckError, CheckException, CheckFailed, CheckInfo, CheckPassed and CheckWarning
### Remediable
Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
**Definition:** Whether in-line remediation is supported for a compliance check.
**Type:** Boolean
**Values:** True or False
VM
**Definition:** The name of a virtual machine (VM).
**Type:** Text
**Values:** User Input
Attribute
**Definition:** Contextual properties of an asset.
**Type:** Text
**Values:** User Input
Collection
**Definition:** Collection name. The names differ depending on cloud provider. for **AWS** the collection means **VPC**. For **Azure** the collection means **Resource Group**. For **GCP & OpenStack** the collection means **Project**.
**Type:** Text
**Values:** User Input
IP address
**Definition:** Filter by IP address.
**Type:** IP Address format
**Values:** User Input
Status
**Definition:** The status of an asset: Active, Inactive or Deleted.
**Type:** Named Values
**Values:** Active or Inactive
> **NOTE**
>
> In Infrastructure Inspector, enable the deleted assets value by selecting the top right **deleted** checkbox.
VM Tag
> **NOTE**
>
> In OpenStack, "tag" refers to metadata.
**Definition:** Tag name and tag value associated with a VM.
**Type:** Text
**Values:** User Input
# Integrate SSO using OPENID/SAML
## Configure CV using OPENID
CV requires following information from SSO provider for CV project.
1. openid_client_id
2. openid_client_secret
3. openid_accesstoken_uri
4. openid_userauthorization_uri
5. openid_jwks_uri
6. openid_username_attr: 'email'
7. openid_provider_scopes: 'openid,email,profile,groups,address'
8. openid_userinfo_uri
SSO provider will require the CV app URL as redirect URL
## Configure CV using SAML
This documentation is created after Okta SAML integration. It should be similar for any other SSO provider if they support SAML.
CV requires following from SSO provider:
1. entityId
2. metadata file
3. certificate file
SSO provider will require the following from CV:
1. CV entityId: cloudvisory-fireeye
2. CV app URL: https://{{CV FQDN}}/saml/SSO
Additionally, for CV role and SAML group mapping, please provide the group name attribute. This will be configured in saml.attribute.group. The default value is groups; groups is assumed to be an attribute name on the IdP side. The value must be a CSP role name (e.g. appadmin)
# Splunk Integration
## Configure Splunk
CV requires following information from Splunk:
1. index name
2. HEC URI
3. HEC token
### 1.1 Create custom indexes
**For example**
csp_compliance_failures csp_threat_flows
> **NOTE**
>
> Make sure default source type is _json.

### 1.2 Create HEC tokens for the indexes

Copyright © 2021 Cloudvisory Documentation, Fireeye Inc.
159