Skip to content

Commit

Permalink
feat: agentless host scanner [SSPROD-33067] (#14)
Browse files Browse the repository at this point in the history
* feat(cloudhostscanner): enables module

* fix:

* doc: generate terraform-docs

* doc: update readme

* doc: update readme
  • Loading branch information
iru committed Dec 12, 2023
1 parent 1add598 commit a982d1d
Show file tree
Hide file tree
Showing 9 changed files with 333 additions and 0 deletions.
92 changes: 92 additions & 0 deletions modules/services/agentless-scan/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# GCP Agentless Scanning Module




This module will deploy required resources for Sysdig to be able to scan hosts on your Google Cloud Account.


The following resources will be created on each instrumented project:
- For the **Resource Discovery**: Enable Sysdig to authenticate through a Workload Identity Pool (requires provider,
service account, role, and related bindings) in order to be able to discover the VPC/Instance/Volumes
- For the **Host Data Extraction**: Enable Sysdig to create a disk copy on our SaaS platform, to be able to extract
the data required for security assessment.

![permission-diagram.png](permission-diagram.png)

Organizational support will be added later on.

<br/><br/>

## Usage

For usage instructions refer to Sysdig official documentation.
While on Controlled Availability check with your Sysdig representative.
<br/><br/>

<!-- BEGIN_TF_DOCS -->
## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >=1.0 |
| <a name="requirement_google"></a> [google](#requirement\_google) | >= 4.1, < 5.0 |
| <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.1, < 4.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_google"></a> [google](#provider\_google) | >= 4.1, < 5.0 |
| <a name="provider_random"></a> [random](#provider\_random) | >= 3.1, < 4.0 |

## Modules

No modules.

## Resources

| Name | Type |
|------|------|
| [google_iam_workload_identity_pool.agentless](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/iam_workload_identity_pool) | resource |
| [google_iam_workload_identity_pool_provider.agentless](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/iam_workload_identity_pool_provider) | resource |
| [google_iam_workload_identity_pool_provider.agentless_gcp](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/iam_workload_identity_pool_provider) | resource |
| [google_project_iam_binding.admin-account-iam](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/project_iam_binding) | resource |
| [google_project_iam_binding.controller_custom](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/project_iam_binding) | resource |
| [google_project_iam_custom_role.controller](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/project_iam_custom_role) | resource |
| [google_project_iam_custom_role.worker_role](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/project_iam_custom_role) | resource |
| [google_service_account.controller](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/service_account) | resource |
| [google_service_account_iam_member.controller_custom](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/service_account_iam_member) | resource |
| [google_service_account_iam_member.controller_custom_gcp](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/service_account_iam_member) | resource |
| [random_id.suffix](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/id) | resource |
| [google_project.project](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/project) | data source |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_project_id"></a> [project\_id](#input\_project\_id) | GCP Project ID | `string` | n/a | yes |
| <a name="input_worker_identity"></a> [worker\_identity](#input\_worker\_identity) | Sysdig provided Identity for the Service Account in charge of performing the host disk analysis | `string` | n/a | yes |
| <a name="input_role_name"></a> [role\_name](#input\_role\_name) | Name for the Worker Role on the Customer infrastructure | `string` | `"SysdigAgentlessHostRole"` | no |
| <a name="input_suffix"></a> [suffix](#input\_suffix) | By default a random value will be autogenerated.<br/>Suffix word to enable multiple deployments with different naming<br/>(Workload Identity Pool and Providers have a soft deletion on Google Platform that will disallow name re-utilization) | `string` | `null` | no |
| <a name="input_sysdig_account_id"></a> [sysdig\_account\_id](#input\_sysdig\_account\_id) | Sysdig provided GCP Account designated for the host scan.<br/>One of `sysdig_backend` or `sysdig_account_id`must be provided | `string` | `null` | no |
| <a name="input_sysdig_backend"></a> [sysdig\_backend](#input\_sysdig\_backend) | Sysdig provided AWS Account designated for the host scan.<br/>One of `sysdig_backend` or `sysdig_account_id`must be provided | `string` | `null` | no |

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_controller_service_account"></a> [controller\_service\_account](#output\_controller\_service\_account) | n/a |
| <a name="output_json_payload"></a> [json\_payload](#output\_json\_payload) | n/a |
| <a name="output_project_id"></a> [project\_id](#output\_project\_id) | n/a |
| <a name="output_project_number"></a> [project\_number](#output\_project\_number) | n/a |
| <a name="output_workload_identity_pool_provider"></a> [workload\_identity\_pool\_provider](#output\_workload\_identity\_pool\_provider) | n/a |
<!-- END_TF_DOCS -->

## Authors

Module is maintained by [Sysdig](https://sysdig.com).

## License

Apache 2 Licensed. See LICENSE for full details.
125 changes: 125 additions & 0 deletions modules/services/agentless-scan/controller.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
resource "google_service_account" "controller" {
project = var.project_id
account_id = "sysdig-ahs-${local.suffix}"
display_name = "Sysdig Agentless Host Scanning"
}

resource "google_project_iam_custom_role" "controller" {
project = var.project_id
role_id = "${var.role_name}Controller${title(local.suffix)}"
title = "Role for Sysdig Agentless Host Workers"
permissions = [
# networks
"compute.networks.list",
"compute.networks.get",
# instances
"compute.instances.list",
"compute.instances.get",
# disks
"compute.disks.list",
"compute.disks.get",
# workload identity federation
"iam.serviceAccounts.getAccessToken",
]
}

resource "google_project_iam_binding" "controller_custom" {
project = var.project_id
role = google_project_iam_custom_role.controller.id

members = [
"serviceAccount:${google_service_account.controller.email}",
]
}

resource "google_iam_workload_identity_pool" "agentless" {
workload_identity_pool_id = "sysdig-ahs-${local.suffix}"
}

resource "google_iam_workload_identity_pool_provider" "agentless" {
count = var.sysdig_backend != null ? 1 : 0

lifecycle {
precondition {
condition = (var.sysdig_backend != null && var.sysdig_account_id == null)
error_message = "Cannot provide both sysdig_backend or sysdig_account_id"
}
}

workload_identity_pool_id = google_iam_workload_identity_pool.agentless.workload_identity_pool_id
workload_identity_pool_provider_id = "sysdig-ahs-${local.suffix}"
display_name = "Sysdig Agentless Controller"
description = "AWS identity pool provider for Sysdig Secure Agentless Host Scanning"
disabled = false

attribute_condition = "attribute.aws_account==\"${var.sysdig_backend}\""

attribute_mapping = {
"google.subject" = "assertion.arn"
"attribute.aws_account" = "assertion.account"
"attribute.role" = "assertion.arn.extract(\"/assumed-role/{role}/\")"
"attribute.session" = "assertion.arn.extract(\"/assumed-role/{role_and_session}/\").extract(\"/{session}\")"
}

aws {
account_id = var.sysdig_backend
}
}

resource "google_service_account_iam_member" "controller_custom" {
count = var.sysdig_backend != null ? 1 : 0

lifecycle {
precondition {
condition = (var.sysdig_backend != null && var.sysdig_account_id == null)
error_message = "Cannot provide both sysdig_backend or sysdig_account_id"
}
}

service_account_id = google_service_account.controller.name
role = "roles/iam.workloadIdentityUser"
member = "principalSet://iam.googleapis.com/${google_iam_workload_identity_pool.agentless.name}/attribute.aws_account/${var.sysdig_backend}"
}

resource "google_iam_workload_identity_pool_provider" "agentless_gcp" {
count = var.sysdig_account_id != null ? 1 : 0

lifecycle {
precondition {
condition = (var.sysdig_backend == null && var.sysdig_account_id != null)
error_message = "Cannot provide both sysdig_backend or sysdig_account_id"
}
}

workload_identity_pool_id = google_iam_workload_identity_pool.agentless.workload_identity_pool_id
workload_identity_pool_provider_id = "sysdig-ahs-${local.suffix}-gcp"
display_name = "Sysdig Agentless Controller"
description = "GCP identity pool provider for Sysdig Secure Agentless Host Scanning"
disabled = false

attribute_condition = "google.subject == \"${var.sysdig_account_id}\""

attribute_mapping = {
"google.subject" = "assertion.sub"
"attribute.sa_id" = "assertion.sub"
}

oidc {
issuer_uri = "https://accounts.google.com"
}
}

resource "google_service_account_iam_member" "controller_custom_gcp" {
count = var.sysdig_account_id != null ? 1 : 0

lifecycle {
precondition {
condition = (var.sysdig_backend == null && var.sysdig_account_id != null)
error_message = "Cannot provide both sysdig_backend or sysdig_account_id"
}
}

service_account_id = google_service_account.controller.name
role = "roles/iam.workloadIdentityUser"
member = "principalSet://iam.googleapis.com/${google_iam_workload_identity_pool.agentless.name}/attribute.sa_id/${var.sysdig_account_id}"
}
3 changes: 3 additions & 0 deletions modules/services/agentless-scan/data.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
data "google_project" "project" {
project_id = var.project_id
}
9 changes: 9 additions & 0 deletions modules/services/agentless-scan/locals.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
locals {
suffix = var.suffix == null ? random_id.suffix[0].hex : var.suffix
}


resource "random_id" "suffix" {
count = var.suffix == null ? 1 : 0
byte_length = 3
}
32 changes: 32 additions & 0 deletions modules/services/agentless-scan/outputs.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
output "project_id" {
value = var.project_id
}

output "project_number" {
value = data.google_project.project.number
}

output "controller_service_account" {
value = google_service_account.controller.email
}

output "workload_identity_pool_provider" {
value = var.sysdig_backend != null ? google_iam_workload_identity_pool_provider.agentless[0].name : var.sysdig_account_id != null ? google_iam_workload_identity_pool_provider.agentless_gcp[0].name : null
precondition {
condition = (var.sysdig_backend != null && var.sysdig_account_id == null) || (var.sysdig_backend == null && var.sysdig_account_id != null)
error_message = "Cannot provide both sysdig_backend or sysdig_account_id"
}
}

output "json_payload" {
value = jsonencode({
"projectId" = var.project_id
"projectNumber" = data.google_project.project.number
"serviceAccount" = google_service_account.controller.email
"identityProvider" = var.sysdig_backend != null ? google_iam_workload_identity_pool_provider.agentless[0].name : var.sysdig_account_id != null ? google_iam_workload_identity_pool_provider.agentless_gcp[0].name : null
})
precondition {
condition = (var.sysdig_backend != null && var.sysdig_account_id == null) || (var.sysdig_backend == null && var.sysdig_account_id != null)
error_message = "Cannot provide both sysdig_backend or sysdig_account_id"
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions modules/services/agentless-scan/provider.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
terraform {
required_version = ">=1.0"

required_providers {
google = {
source = "hashicorp/google"
version = ">= 4.1, < 5.0"
}
random = {
source = "hashicorp/random"
version = ">= 3.1, < 4.0"
}
}
}
37 changes: 37 additions & 0 deletions modules/services/agentless-scan/variables.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
variable "project_id" {
type = string
description = "GCP Project ID"
}

variable "worker_identity" {
type = string
description = "Sysdig provided Identity for the Service Account in charge of performing the host disk analysis"
}

variable "sysdig_backend" {
type = string
description = "Sysdig provided AWS Account designated for the host scan.<br/>One of `sysdig_backend` or `sysdig_account_id`must be provided"
default = null
}

variable "sysdig_account_id" {
type = string
description = "Sysdig provided GCP Account designated for the host scan.<br/>One of `sysdig_backend` or `sysdig_account_id`must be provided"
default = null
}


# optionals
variable "role_name" {
type = string
description = "Name for the Worker Role on the Customer infrastructure"
default = "SysdigAgentlessHostRole"
}



variable "suffix" {
type = string
description = "By default a random value will be autogenerated.<br/>Suffix word to enable multiple deployments with different naming<br/>(Workload Identity Pool and Providers have a soft deletion on Google Platform that will disallow name re-utilization)"
default = null
}
21 changes: 21 additions & 0 deletions modules/services/agentless-scan/worker.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
resource "google_project_iam_custom_role" "worker_role" {
project = var.project_id
role_id = "${var.role_name}Worker${title(local.suffix)}"
title = "${var.role_name} - Sysdig Agentless"
permissions = [
# general stuff
"compute.zoneOperations.get",
# disks
"compute.disks.get",
"compute.disks.useReadOnly",
]
}

resource "google_project_iam_binding" "admin-account-iam" {
project = var.project_id
role = google_project_iam_custom_role.worker_role.id

members = [
"serviceAccount:${var.worker_identity}",
]
}

0 comments on commit a982d1d

Please sign in to comment.