diff --git a/reference/html/index.html b/reference/html/index.html index 447cc678..62fc30cf 100644 --- a/reference/html/index.html +++ b/reference/html/index.html @@ -118,6 +118,7 @@ $(addBlockSwitches);
  • GCP-GCE authentication
  • GCP-IAM authentication
  • Kubernetes authentication
  • +
  • Pivotal CloudFoundry authentication
  • Secret Backends @@ -1529,6 +1530,77 @@ The authentication is role based and the role is bound to a service account name +
    +

    Pivotal CloudFoundry authentication

    +
    +

    The pcf +auth backend provides a secure introduction mechanism for applications running within Pivotal’s CloudFoundry instances allowing automated retrieval of a Vault token. +Unlike most Vault authentication backends, this backend does not require first-deploying, or provisioning security-sensitive credentials (tokens, username/password, client certificates, etc.) as identity provisioning is handled by PCF itself. +Instead, it treats PCF as a Trusted Third Party and uses the managed instance identity.

    +
    +
    +
    Example 26. bootstrap.yml with required PCF Authentication properties
    +
    +
    +
    +
    spring.cloud.vault:
    +    authentication: PCF
    +    pcf:
    +        role: my-dev-role
    +
    +
    +
    +
    +
    +
    Example 27. bootstrap.yml with all PCF Authentication properties
    +
    +
    +
    +
    spring.cloud.vault:
    +    authentication: PCF
    +    pcf:
    +        role: my-dev-role
    +        pcf-path: path
    +        instance-certificate: /etc/cf-instance-credentials/instance.crt
    +        instance-key: /etc/cf-instance-credentials/instance.key
    +
    +
    +
    +
    +
    +
      +
    • +

      role sets the name of the role against which the login is being attempted.

      +
    • +
    • +

      pcf-path sets the path of the PCF mount to use.

      +
    • +
    • +

      instance-certificate sets the path to the PCF instance identity certificate. +Defaults to ${CF_INSTANCE_CERT} env variable.

      +
    • +
    • +

      instance-key sets the path to the PCF instance identity key. +Defaults to ${CF_INSTANCE_KEY} env variable.

      +
    • +
    +
    +
    + + + + + +
    + + +PCF authentication requires BouncyCastle (bcpkix-jdk15on) to be on the classpath for RSA PSS signing. +
    +
    + +
    @@ -1778,7 +1850,7 @@ The Consul integration requires the spring-cloud-vault-config-consul
    -
    Example 26. pom.xml
    +
    Example 28. pom.xml
    @@ -1848,7 +1920,7 @@ the property name by setting spring.cloud.vault.consul.token-property
    -
    Example 27. pom.xml
    +
    Example 29. pom.xml
    @@ -1923,7 +1995,7 @@ by setting spring.cloud.vault.rabbitmq.username-property and dependency.

    -
    Example 28. pom.xml
    +
    Example 30. pom.xml
    @@ -2034,7 +2106,7 @@ generic database backend. Make sure to specify the appropriate backend path, e.g. spring.cloud.vault.mysql.role.backend=database.

    -
    Example 29. pom.xml
    +
    Example 31. pom.xml
    diff --git a/reference/html/spring-cloud-vault.html b/reference/html/spring-cloud-vault.html index 447cc678..62fc30cf 100644 --- a/reference/html/spring-cloud-vault.html +++ b/reference/html/spring-cloud-vault.html @@ -118,6 +118,7 @@ $(addBlockSwitches);
  • GCP-GCE authentication
  • GCP-IAM authentication
  • Kubernetes authentication
  • +
  • Pivotal CloudFoundry authentication
  • Secret Backends @@ -1529,6 +1530,77 @@ The authentication is role based and the role is bound to a service account name +
    +

    Pivotal CloudFoundry authentication

    +
    +

    The pcf +auth backend provides a secure introduction mechanism for applications running within Pivotal’s CloudFoundry instances allowing automated retrieval of a Vault token. +Unlike most Vault authentication backends, this backend does not require first-deploying, or provisioning security-sensitive credentials (tokens, username/password, client certificates, etc.) as identity provisioning is handled by PCF itself. +Instead, it treats PCF as a Trusted Third Party and uses the managed instance identity.

    +
    +
    +
    Example 26. bootstrap.yml with required PCF Authentication properties
    +
    +
    +
    +
    spring.cloud.vault:
    +    authentication: PCF
    +    pcf:
    +        role: my-dev-role
    +
    +
    +
    +
    +
    +
    Example 27. bootstrap.yml with all PCF Authentication properties
    +
    +
    +
    +
    spring.cloud.vault:
    +    authentication: PCF
    +    pcf:
    +        role: my-dev-role
    +        pcf-path: path
    +        instance-certificate: /etc/cf-instance-credentials/instance.crt
    +        instance-key: /etc/cf-instance-credentials/instance.key
    +
    +
    +
    +
    +
    +
      +
    • +

      role sets the name of the role against which the login is being attempted.

      +
    • +
    • +

      pcf-path sets the path of the PCF mount to use.

      +
    • +
    • +

      instance-certificate sets the path to the PCF instance identity certificate. +Defaults to ${CF_INSTANCE_CERT} env variable.

      +
    • +
    • +

      instance-key sets the path to the PCF instance identity key. +Defaults to ${CF_INSTANCE_KEY} env variable.

      +
    • +
    +
    +
    + + + + + +
    + + +PCF authentication requires BouncyCastle (bcpkix-jdk15on) to be on the classpath for RSA PSS signing. +
    +
    + +
    @@ -1778,7 +1850,7 @@ The Consul integration requires the spring-cloud-vault-config-consul
    -
    Example 26. pom.xml
    +
    Example 28. pom.xml
    @@ -1848,7 +1920,7 @@ the property name by setting spring.cloud.vault.consul.token-property
    -
    Example 27. pom.xml
    +
    Example 29. pom.xml
    @@ -1923,7 +1995,7 @@ by setting spring.cloud.vault.rabbitmq.username-property and dependency.

    -
    Example 28. pom.xml
    +
    Example 30. pom.xml
    @@ -2034,7 +2106,7 @@ generic database backend. Make sure to specify the appropriate backend path, e.g. spring.cloud.vault.mysql.role.backend=database.

    -
    Example 29. pom.xml
    +
    Example 31. pom.xml