CredHub Credential Types

Page last updated:

This topic describes the different credential types supported by CredHub.

CredHub supports different types of credentials to simplify generating and managing multi-part credentials. For example, a TLS certificate contains three parts: the root certificate authority (CA), the certificate, and the private key. CredHub supports all three parts, which helps keep connection requests from being rejected erroneously.

Credential Types

CredHub supports the following credential types:

Type Description
value A single string value for arbitrary configurations and other non-generated or validated strings.
json An arbitrary JSON object for static configurations with many values.
user Three string values for username, password, and password hash.
password A single string value for passwords and other random string credentials. Values for this type can be automatically generated.
certificate An object containing a root CA, certificate, and private key. Use this type for key pair apps that utilize a certificate, such as TLS connections. Values for this type can be automatically generated.
rsa An object containing an RSA public key and private key without a certificate. Values for this type can be automatically generated.
ssh An object containing an SSH-formatted public key and private key. Values for this type can be automatically generated.

Each credential type supports distinct parameters for customizing how credentials are generated. These include minimum password lengths, required characters, and certificate fields. For more information, see Generate Credentials in the CredHub API documentation.

For every credential type, secret values are encrypted before storage. For instance, the private key of a certificate-type credential and the password of a user-type credential are encrypted before storage. For JSON and Value type credentials, the full contents are encrypted before storage.

Consuming CredHub Types in Releases

The BOSH Director interpolates the key value from the credential response for a deployment variable.

For example, in a deployment containing the password credential referenced above, BOSH substitutes "nZaowPHTl0CQYVyYA0nV7ayHVulCBU3WTmwJKiZm" for the variable. The behavior is similar for other credential types as well. For example, if the certificate credential is referenced above, BOSH substitutes the object below:

{
  "ca": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
  "certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
  "private_key": "-----BEGIN EXAMPLE RSA PRIVATE KEY-----...-----END EXAMPLE RSA PRIVATE KEY-----"
}

Similarly, the object could be translated into YAML format:

  ca: |
    -----BEGIN CERTIFICATE-----
    ...
    -----END CERTIFICATE------
  certificate: |
    -----BEGIN CERTIFICATE-----
    ...
    -----END CERTIFICATE------
  private_key: |
    -----BEGIN EXAMPLE RSA PRIVATE KEY-----
    ...
    -----END EXAMPLE RSA PRIVATE KEY------

If you want to leverage a non-string typed credential, update your release to properly consume the new format. The following example shows how to configure a release to accept the certificate credential referenced above. It includes an example to instruct users on how to define the values if they are not using a CredHub credential.

Release Job Spec

---
name: demo

properties:
  demo.tls:
    description: "Certificate and private key for TLS connection to API"
    example: |
        ca: |
          -----BEGIN CERTIFICATE-----
          ...
          -----END CERTIFICATE-----
        certificate: |
          -----BEGIN CERTIFICATE-----
          ...
          -----END CERTIFICATE-----
        private_key: |
          -----BEGIN EXAMPLE RSA PRIVATE KEY-----
          ...
          -----END EXAMPLE RSA PRIVATE KEY-----

Job Template ERB

erb
api-ca=demo.tls.ca
api-certificate=demo.tls.certificate
api-private-key=demo.tls.private_key

Deployment Manifest

---
name: demo-deploy

instance_groups:
  properties:
    demo:
      tls: ((demo-tls))

Updating a release for other types is similar to the example above, being mindful of the key name for each value you wish to consume.

Enabling CredHub Automatic Generation in Releases

CredHub and BOSH are integrated to automatically generate missing credential values on deployment. To enable automatic generation, the release or manifest requires the correct configuration.

The sample below demonstrates how to configure a job release spec to provide generation parameters. When you provide details in a release spec, use attributes that do not vary per deployment, such as type and password attributes.

Release Job Spec

---
name: demo

properties:
  demo.admin_password:
    description: "Password for admin user"
    type: password
    parameters:
      length: 40

  demo.tls:
    description: "Certificate and private key for TLS connection to API"
    type: certificate
    parameters:
      key_length: 4096

You can also define these generation parameters in the deployment itself, as shown in the example below. Use this for generation parameters that are deployment-specific, such as a certificate common name.

Deployment Manifest

---
name: demo-deploy

variables:
- name: demo-password
  type: password
  options:
    length: 40
- name: demo-ca
  type: certificate
  options:
    is_ca: true
    common_name: 'Demo Certificate Authority'
- name: demo-tls
  type: certificate
  options:
    ca: demo-ca
    common_name: example.com
    alternative_names:
    - example.com
    - www.example.com
    extended_key_usage:
    - client_auth

instance_groups:
  properties:
    demo:
      admin-password: ((demo-password))
      tls: ((demo-tls))
Create a pull request or raise an issue on the source for this page in GitHub