feat: add vault variant (c1af8b6b) · Commits · to be continuous... / Dependency-Track

README.md

+59 −3

Original line number	Diff line number	Diff line
		@@ -31,7 +31,7 @@ Add the following to your `gitlab-ci.yml`:
		include:
		# 1: include the template
		- project: "to-be-continuous/dependency-track"
		ref: "1.0.0"
		ref: "1.1.0"
		file: "/templates/gitlab-ci-dependency-track.yml"

		variables:
		@@ -188,8 +188,64 @@ Here are some advices about your secrets (variables marked with a :lock:):
		- [protected](https://docs.gitlab.com/ee/ci/variables/#protect-a-custom-variable) if you want to secure some
		secrets
		you don't want everyone in the project to have access to (for instance production secrets).
		2. In case a secret
		2. Manage them using the [Vault variant](#vault-variant)
		3. In case a secret
		contains [characters that prevent it from being masked](https://docs.gitlab.com/ee/ci/variables/#masked-variable-requirements),
		simply define its value as the [Base64](https://en.wikipedia.org/wiki/Base64) encoded value prefixed with `@b64@`:
		it will then be possible to mask it and the template will automatically decode it prior to using it.
		3. Don't forget to escape special characters (ex: `$` -> `$$`).
		4. Don't forget to escape special characters (ex: `$` -> `$$`).

		## Variants

		### Vault variant

		This variant allows delegating your secrets management to a [Vault](https://www.vaultproject.io/) server.

		#### Configuration

		In order to be able to communicate with the Vault server, the variant requires the additional configuration parameters:

		\| Name \| Description \| Default value \|
		\| ----------------- \| -------------------------------------- \| ----------------- \|
		\| `TBC_VAULT_IMAGE` \| The [Vault Secrets Provider](https://gitlab.com/to-be-continuous/tools/vault-secrets-provider) image to use (can be overridden) \| `registry.gitlab.com/to-be-continuous/tools/vault-secrets-provider:master` \|
		\| `VAULT_BASE_URL` \| The Vault server base API url \| _none_ \|
		\| `VAULT_OIDC_AUD` \| The `aud` claim for the JWT \| `$CI_SERVER_URL` \|
		\| :lock: `VAULT_ROLE_ID` \| The [AppRole](https://www.vaultproject.io/docs/auth/approle) RoleID \| must be defined \|
		\| :lock: `VAULT_SECRET_ID` \| The [AppRole](https://www.vaultproject.io/docs/auth/approle) SecretID \| must be defined \|

		#### Usage

		Then you may retrieve any of your secret(s) from Vault using the following syntax:

		```
		@url@http://vault-secrets-provider/api/secrets/{secret_path}?field={field}
		```

		With:

		\| Name \| Description \|
		\| -------------------------------- \| -------------------------------------- \|
		\| `secret_path` (_path parameter_) \| this is your secret location in the Vault server \|
		\| `field` (_query parameter_) \| parameter to access a single basic field from the secret JSON payload \|

		#### Example

		```yaml
		include:
		# main template
		- project: 'to-be-continuous/dependency-track'
		ref: '1.1.0'
		file: '/templates/gitlab-ci-dependency-track.yml'
		# Vault variant
		- project: 'to-be-continuous/dependency-track'
		ref: '1.1.0'
		file: '/templates/gitlab-ci-dependency-track-vault.yml'

		variables:
		# audience claim for JWT
		VAULT_OIDC_AUD: "https://vault.acme.host"
		# Secret managed by Vault
		DEPTRACK_API_KEY: "@url@http://vault-secrets-provider/api/secrets/b7ecb6ebabc231/runner/prod/deptrack?field=api-key"
		VAULT_BASE_URL: "https://vault.acme.host/v1"
		# $VAULT_ROLE_ID and $VAULT_SECRET_ID defined as a secret CI/CD variable
		```

kicker.json

+37 −0

Original line number	Diff line number	Diff line
		@@ -60,5 +60,42 @@
		"default": "*/.cyclonedx.json */.cyclonedx.xml",
		"advanced": true
		}
		],
		"variants": [
		{
		"id": "vault",
		"name": "Vault",
		"description": "Retrieve secrets from a [Vault](https://www.vaultproject.io/) server",
		"template_path": "templates/gitlab-ci-dependency-track-vault.yml",
		"variables": [
		{
		"name": "TBC_VAULT_IMAGE",
		"description": "The [Vault Secrets Provider](https://gitlab.com/to-be-continuous/tools/vault-secrets-provider) image to use",
		"default": "registry.gitlab.com/to-be-continuous/tools/vault-secrets-provider:master",
		"advanced": true
		},
		{
		"name": "VAULT_BASE_URL",
		"description": "The Vault server base API url"
		},
		{
		"name": "VAULT_OIDC_AUD",
		"description": "The `aud` claim for the JWT",
		"default": "$CI_SERVER_URL"
		},
		{
		"name": "VAULT_ROLE_ID",
		"description": "The [AppRole](https://www.vaultproject.io/docs/auth/approle) RoleID",
		"mandatory": true,
		"secret": true
		},
		{
		"name": "VAULT_SECRET_ID",
		"description": "The [AppRole](https://www.vaultproject.io/docs/auth/approle) SecretID",
		"mandatory": true,
		"secret": true
		}
		]
		}
		]
		}

templates/gitlab-ci-dependency-track-vault.yml

0 → 100644

+32 −0

Original line number	Diff line number	Diff line
		# =====================================================================================================================
		# === Vault template variant
		# =====================================================================================================================
		spec:
		inputs:
		vault-base-url:
		description: The Vault server base API url
		default: ''
		vault-oidc-aud:
		description: The `aud` claim for the JWT
		default: $CI_SERVER_URL
		---
		variables:
		# variabilized vault-secrets-provider image
		TBC_VAULT_IMAGE: registry.gitlab.com/to-be-continuous/tools/vault-secrets-provider:latest
		# variables have to be explicitly declared in the YAML to be exported to the service
		VAULT_ROLE_ID: "$VAULT_ROLE_ID"
		VAULT_SECRET_ID: "$VAULT_SECRET_ID"
		VAULT_OIDC_AUD: $[[ inputs.vault-oidc-aud ]]
		VAULT_BASE_URL: $[[ inputs.vault-base-url ]]

		dependency-track:
		services:
		- name: "$TBC_TRACKING_IMAGE"
		command: ["--service", "dependency-track", "1.1.0"]
		- name: "$TBC_VAULT_IMAGE"
		alias: "vault-secrets-provider"
		variables:
		VAULT_JWT_TOKEN: "$VAULT_JWT_TOKEN"
		id_tokens:
		VAULT_JWT_TOKEN:
		aud: "$VAULT_OIDC_AUD"