Packer Plugin TSS

This plugin allows Packer to use a Thycotic Secret Server as a datasource.

Installation

Using pre-built releases

Using the packer init command

Starting from version 1.7, Packer supports a new packer init command allowing automatic installation of Packer plugins. Read the Packer documentation for more information.

To install this plugin, copy and paste this code into your Packer configuration . Then, run packer init .

packer {
  required_plugins {
    tss = {
      version = ">= 0.3.2"
      source  = "github.com/breed808/tss"
    }
  }
}

Manual installation

You can find pre-built binary releases of the plugin here. Once you have downloaded the latest archive corresponding to your target OS, uncompress it to retrieve the plugin binary file corresponding to your platform. To install the plugin, please follow the Packer documentation on installing a plugin.

From Source

If you prefer to build the plugin from its source code, clone the GitHub repository locally and run the command go build from the root directory. Upon successful compilation, a packer-plugin-tss plugin binary file can be found in the root directory. To install the compiled plugin, please follow the official Packer documentation on installing a plugin.

Usage

Add data blocks to use secrets from the Thycotic Secret Server. Note that a user account must be present in TSS with read access to the secret.

data "tss" "mock-data" {
  username = "testing" # TSS username
  password = "test123" # TSS password
  server_url = "https://my-thycotic-server.example.com/SecretServer"

  secret_id     = 500                      # ID of TSS secret to retrieve
  secret_fields = ["username", "password"] # Optional. Fields to retrieve from the TSS secret. If empty, all fields will be retrieved.
}

Retrieve all fields from Secret ID 500 :

data "tss" "mock-data" {
  username = "testing" # TSS username
  password = "test123" # TSS password
  server_url = "https://my-thycotic-server.example.com/SecretServer"

  secret_id     = 500
}

If the TSS user account uses LDAP for authentication, a domain must be specified:

data "tss" "mock-data" {
  username   = "testing" # TSS username
  password   = "test123" # TSS password
  server_url = "https://my-thycotic-server.example.com/SecretServer"
  domain     = "example.com" # Domain of user. I.E. testing@example.com

  secret_id      = 500                      # ID of TSS secret to retrieve
  secret_fields  = ["username", "password"] # Optional. Fields to retrieve from the TSS secret. If empty, all fields will be retrieved.
  exclude_fields = []                       # Optional. The listed fields will not be retrieved from the TSS secret.
}

The TSS datasource will return username and password fields that can be used for authentication by Packer. For example, a credential could be acquired for use with vSphere authentication:

source "null" "example" {
  communicator = "none"
}

data "tss" "mock-data" {
  username   = "testing" # TSS username
  password   = "test123" # TSS password
  server_url = "https://my-thycotic-server.example.com/SecretServer"

  secret_id      = 500                                # ID of TSS secret to retrieve
  secret_fields  = ["username", "password", "notes"]  # Fields to retrieve from the TSS secret
  exclude_fields = ["notes"]                          # 'notes' will not be retrieved, even when listed in 'secret_fields', as 'exclude_fields' takes precedence
}

build {
  sources = [
    "source.null.example"
  ]

  post-processors {
    post-processor "artifice" {
      files = ["output-vmware-iso/packer-vmware-iso.vmx"]
    }

    post-processor "vsphere" {
      keep_input_artifact = true
      vm_name             = "packerparty"
      vm_network          = "VM Network"
      cluster             = "123.45.678.1"
      datacenter          = "PackerDatacenter"
      datastore           = "datastore1"
      host                = "123.45.678.9"
      password            = data.tss.mock-data.fields.username
      username            = data.tss.mock-data.fields.password
    }
  }
}

NOTE: Packer does not seem to support sensitive values from custom data sources yet. If you are passing the variables to provisioners and wish to keep them sensitive, you can create a sensitive local.

local "my_secret_password" {
  expression = "${data.tss.mock-data.fields.password}"
  sensitive  = true
}

Packer Compatibility

This plugin is compatible with Packer >= v1.7.0