Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Added configuration flag to separate resources requiring elevated pri… #3

Merged
merged 3 commits into from
May 17, 2018
Merged

Added configuration flag to separate resources requiring elevated pri… #3

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0fe3356
Added configuration flag to separate resources requiring elevated pri…
May 17, 2018
2ae22e8
Updated tests to use only_if as suggested by chris-rock. Now absorb …
May 17, 2018
583decc
Fix indentation.
May 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ export GCP_LOCATION=<region, defaults to europe-west2>
export GCP_ZONE=<zone, defaults to europe-west2-a>
```

Some resources require elevated privileges to create in GCP. These are disabled by default but can be activated via:
```bash
export GCP_ENABLE_PRIVILEGED_RESOURCES=1
```
This takes effect during the "plan" task as described in the next section. Affected terraform resources are included/excluded and associated inspec tests enabled/disabled accordingly.

3. Run the integration tests via:

```bash
Expand Down
11 changes: 4 additions & 7 deletions test/integration/build/gcp.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,6 @@ terraform {

variable "gcp_project_name" {}
variable "gcp_project_id" {}
# BELOW TO BE REMOVED as not used
variable "gcp_storage_account_name" {}
variable "gcp_admin_password" {}
# Set a unique string which will be appended to public facing items
# to ensure there are no clashes
#variable "suffix" {}

variable "gcp_location" {
default = "europe-west2"
}
Expand Down Expand Up @@ -70,6 +63,8 @@ variable "gcp_storage_bucket_name" {
default ="gcp-inspec"
}

variable "gcp_enable_privileged_resources" {}

provider "google" {
region = "${var.gcp_location}"
}
Expand Down Expand Up @@ -150,12 +145,14 @@ resource "google_compute_instance" "generic_windows_internal_vm_instance" {
}

resource "google_service_account" "generic_service_account_object_viewer" {
count = "${var.gcp_enable_privileged_resources}"
project = "${var.gcp_project_id}"
account_id = "object-viewer"
display_name = "${var.gcp_service_account_display_name}"
}

resource "google_project_iam_custom_role" "generic_project_iam_custom_role" {
count = "${var.gcp_enable_privileged_resources}"
project = "${var.gcp_project_id}"
role_id = "${var.gcp_project_iam_custom_role_id}"
title = "GCP Inspec Generic Project IAM Custom Role"
Expand Down
13 changes: 8 additions & 5 deletions test/integration/configuration/gcp_inspec_config.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,11 @@ module GCPInspecConfig

# Config for terraform / inspec in the below hash
@config = {
# Generic GCP resrource parameters
# Generic GCP resource parameters
:gcp_project_name => "SPaterson Project",
:gcp_project_id => "spaterson-project",
:gcp_project_number => "1041358276233",
# Determine the storage account name and the admin password
# BELOW two variables to be removed
:gcp_storage_account_name => (0...15).map { (65 + rand(26)).chr }.join.downcase,
:gcp_admin_password => Passgen::generate(length: 12, uppercase: true, lowercase: true, symbols: true, digits: true),
:gcp_location => "europe-west2",
:gcp_zone => "europe-west2-a",
:gcp_int_vm_name => "gcp-inspec-int-linux-vm",
Expand Down Expand Up @@ -61,7 +58,13 @@ module GCPInspecConfig
:gcp_kube_cluster_zone_extra2 => "europe-west2-c",
:gcp_kube_cluster_master_user => "gcp-inspec-kube-admin",
:gcp_kube_cluster_master_pass => Passgen::generate(length: 20, uppercase: true, lowercase: true, symbols: true, digits: true),
:gcp_kube_nodepool_name => "default-pool"
:gcp_kube_nodepool_name => "default-pool",
# Some resources require elevated privileges to create and therefore test against. The below flag is used to control
# both the terraform resource creation and the inspec test execution for those resources. Default behaviour is for this to
# be disabled meaning a user needs no special GCP privileges to run the integration test pack.
#
# Note, would prefer to use boolean true or false here but will revisit for a future version of tf, see here for more detail: https://www.terraform.io/docs/configuration/variables.html
:gcp_enable_privileged_resources => 0
}

def self.config
Expand Down
9 changes: 6 additions & 3 deletions test/integration/verify/controls/generic_iam_role.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@

gcp_project_id = attribute(:gcp_project_id, default: '', description: 'The GCP project identifier.')
gcp_project_iam_custom_role_id = attribute(:gcp_project_iam_custom_role_id, default: '', description: 'The GCP IAM custom role identifier.')
gcp_enable_privileged_resources = attribute(:gcp_enable_privileged_resources,default:false,description:'Flag to enable privileged resources requiring elevated privileges in GCP.')

control 'gcp-generic-iam-role' do

impact 1.0
title 'Ensure that the IAM role is correctly set up'

if gcp_enable_privileged_resources
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose we use only_if here

control do
   only_if { gcp_enable_privileged_resources == true}
end

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will update the tests accordingly, thanks!

describe google_project_iam_custom_role(project: gcp_project_id, name: gcp_project_iam_custom_role_id ) do
# stage of a role in the launch lifecycle, should be GA (can be ALPHA, BETA, or GA)
its('stage') { should eq "GA" }
its('name') { should match gcp_project_iam_custom_role_id }
# stage of a role in the launch lifecycle, should be GA (can be ALPHA, BETA, or GA)
its('stage') { should eq "GA" }
its('name') { should match gcp_project_iam_custom_role_id }
end
end
end
7 changes: 5 additions & 2 deletions test/integration/verify/controls/generic_iam_service_account.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@

gcp_project_id = attribute(:gcp_project_id, default: '', description: 'The GCP project identifier.')
gcp_service_account_display_name = attribute(:gcp_service_account_display_name, default: '', description: 'The GCP IAM Service Account display name.')
gcp_enable_privileged_resources = attribute(:gcp_enable_privileged_resources,default:false,description:'Flag to enable privileged resources requiring elevated privileges in GCP.')

control 'gcp-generic-iam-service-account' do

impact 1.0
title 'Ensure that the Service Account is correctly set up'

if gcp_enable_privileged_resources
describe google_service_account(project: gcp_project_id, name: gcp_service_account_display_name ) do
its('display_name') { should eq gcp_service_account_display_name }
its('project_id') { should eq gcp_project_id }
its('display_name') { should eq gcp_service_account_display_name }
its('project_id') { should eq gcp_project_id }
end
end
end