Skip to content

Latest commit

 

History

History
executable file
·
293 lines (227 loc) · 10.6 KB

README.md

File metadata and controls

executable file
·
293 lines (227 loc) · 10.6 KB
Raw

CyberArk Conjur Buildpack

The CyberArk Conjur Buildpack is a supply buildpack that installs scripts to provide convenient and secure access to secrets stored in Conjur.

The buildpack supplies scripts to your application that do the following:

  • Examine your app to determine the secrets to fetch using a secrets.yml file in the app root folder or configured location.

  • Retrieve credentials stored in your app's VCAP_SERVICES environment variable to communicate with the bound cyberark-conjur service instance of the Conjur Service Broker.

  • Authenticate using the Conjur credentials, fetch the relevant secrets from Conjur, and inject them into the session environment variables at the start of the app. The secrets are only available to the app process.

Requirements

  • Your app must be bound to a Conjur service instance. For more information on binding your application to a Conjur service instance, see the Conjur Service Broker documentation.

  • Your app must have a secrets.yml file in its root directory or in a configured location.

  • Using this buildpack requires using multiple buildpacks, because this is not a final buildpack and your app will still need to also invoke a language buildpack. To use Cloud Foundry with multiple buildpacks, you must ensure your Cloud Foundry CLI version is greater than 6.38. See the CloudFoundry documentation on multiple buildpacks for more information.

How Does the Buildpack Work?

The buildpack uses a supply script to copy files into the application's dependency directory under a subdirectory corresponding to the buildpack's index. The lib/0001_retrieve-secrets.sh script is copied into a profile.d subdirectory so that it will run automatically when the app starts and the conjur-env binary is copied to a vendor subdirectory. In other words, your application will end up with the following two files:

- $DEPS_DIR/$BUILDPACK_INDEX/profile.d/0001-retrieve-secrets.sh
- $DEPS_DIR/$BUILDPACK_INDEX/vendor/conjur-env

The profile.d script is run automatically when the application starts and is responsible for retrieving secrets and injecting them into the app's session environment variables.

The conjur-env binary leverages the Conjur Go API and Summon to authenticate with Conjur and retrieve secrets using the application identity provided by the Conjur Service Broker.

Getting Started

The Conjur Buildpack can be included in a CloudFoundry application as an online buildpack, using the GitHub repository address, or installed into a CloudFoundry foundation.

For documentation on how to use the online buildpack, see using below for details.

Installing the Conjur Buildpack

Before you begin, ensure you are logged into your CF deployment via the CF CLI.

To install the Conjur Buildpack, download a ZIP of the latest release, unzip the release into its own directory, and run the upload.sh script:

# Download latest version of the Conjur Buildpack
wget -q --show-progress \
  -O "${PWD}/conjur_buildpack.zip" \
  $(curl -s \
  "https://api.github.com/repos/cyberark/cloudfoundry-conjur-buildpack/releases/latest" \
  | jq '.assets[0].browser_download_url' \
  | sed 's/"//g')

# Create the buildpack in your remote stack
cf create-buildpack conjur_buildpack conjur_buildpack.zip 1

The '1' will place it at the top of the detection priority. This is recommended to ensure proper installation of the secret retrieval script.

Alternatively, you can clone the entire repository, and run the following commands:

./package.sh
./upload.sh

The ./package.sh script will run buildpack-packager within the buildpack directory and create a .ZIP file. upload.sh will run cf create-buildpack similar to the command above, as well as removing prior instances of the Conjur Buildpack with cf delete-buildpack.

Earlier versions of the Conjur Buildpack (v0.x) may be installed by cloning the repository and running ./upload.sh.

Using the Conjur Buildpack

Create a secrets.yml File

For each application that will be using the Conjur Buildpack you must create a secrets.yml file. The secrets.yml file gives a mapping of environment variable name to a location where a secret is stored in Conjur. For more information about creating this file, see the Summon documentation. There are no sensitive values in the file itself, so it can safely be checked into source control.

The following is an example of a secrets.yml file

AWS_ACCESS_KEY_ID: !var aws/prod/iam/user/robot/access_key_id
AWS_SECRET_ACCESS_KEY: !var aws/prod/iam/user/robot/secret_access_key
AWS_REGION: us-east-1
SSL_CERT: !var:file ssl/certs/private

The above example could resolve to the following environment variables:

AWS_ACCESS_KEY_ID: AKIAI44QH8DHBEXAMPLE
AWS_SECRET_ACCESS_KEY: je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY
AWS_REGION: us-east-1
SSL_CERT: /tmp/ssl-cert.pem

Note: Since the buildpack injects secrets into the application runtime environment using the bash export method, environment variable names included in the secret.yml file must be valid shell variable names. In particular, they may contain upper or lowercase letters, numbers, and underscores only.

Configuring the secrets.yml Location

Some final buildpacks do not allow deploying the secrets.yml file to the application root directory at runtime. In this case, the runtime location of the secrets.yml file may be configured by setting the SECRETS_YAML_PATH environment variable to its relative path.

This can be configured in the application's manifest.yml:

---
applications:
- name: my-app
  services:
  - conjur
  buildpacks:
  - conjur_buildpack
  - ruby_buildpack
  env:
    SECRETS_YAML_PATH: lib/secrets.yml

Alternatively, this may be set using the Cloud Foundry CLI:

$ cf set-env {Application Name} SECRETS_YAML_PATH {Relative Path to secrets.yml}
$ cf restage {Application Name}
Using environments in your secrets.yml

Secrets in the secrets.yml file can be grouped into sections called environments. The Conjur Buildpack will inject all secrets in the common section regardless of the environment the app is running in. To load environment-specific secrets at runtime, set the SECRETS_YAML_ENVIRONMENT environment variable to the string value of the environment's YAML key.

In the example below, the secrets.yml file has two custom environments, staging and production. To invoke the buildpack and ask it to inject the staging secrets into the application environment, the application manifest is updated to set SECRETS_YAML_ENVIRONMENT to staging.

Given a secrets.yml file that contains the following:

common:
  DB_USER: path/to/usernamr
  DB_NAME: db-name
  DB_HOST: path/to/host_url

staging:
  DB_PASS: /path/to/staging_password

production:
  DB_PASS: path/to/prod_password

Update the application manifest to request the staging secrets:

---
applications:
- name: my-app
  services:
  - conjur
  buildpacks:
  - conjur_buildpack
  - ruby_buildpack
  env:
    SECRETS_YAML_PATH: lib/secrets.yml
    SECRETS_YAML_ENVIRONMENT: staging

At runtime, the following environment variables will be available in the application environment:

  DB_USER: db-user
  DB_NAME: db-name
  DB_HOST: db-host.example.com
  DB_PASS: staging_password

Invoke the Installed Buildpack at Deploy Time

When you deploy your application, ensure it is bound to a Conjur service instance and add the Conjur Buildpack to your cf push command:

cf push my-app -b conjur_buildpack ... -b final_buildpack

Alternatively, the buildpacks may be specified in the application manifest, for example:

---
applications:
- name: my-app
  services:
  - conjur
  buildpacks:
  - conjur_buildpack
  - ruby_buildpack

When your application starts, the Conjur Buildpack will inject the secrets specified in the secrets.yml file into the application process as environment variables.

Note: If you add the Conjur buildpack to your manifest or cf push command but don't also explicitly include the language buildpack, Cloud Foundry will see that the Conjur buildpack is not a "final buildpack" and will fail to invoke it. To use this buildpack, you must follow the instructions for using multiple buildpacks and specify both the Conjur buildpack and the final, language buildpack for your app (in that order).

Invoking the Online Buildpack at Deploy Time

To use the CyberArk Conjur Buildpack as an online buildpack, use the GitHub repository address instead of specifying the installed buildpack name. This may be done with the cf push command or using the manifest file.

cf push my-app -b https://github.com/cyberark/cloudfoundry-conjur-buildpack#latest ... -b final_buildpack
---
applications:
- name: my-app
  services:
  - conjur
  buildpacks:
  - https://github.com/cyberark/cloudfoundry-conjur-buildpack#latest
  - ruby_buildpack

We recommend users specifically reference the latest branch when using the online version of the buildpack. The latest branch is up-to-date with the latest tagged buildpack release. You may also opt to reference a specific release version TAG by referring to the online buildpack as:

https://github.com/cyberark/cloudfoundry-conjur-buildpack#TAG

Contributing

We welcome contributions of all kinds to the Conjur Buildpack. For instructions on how to get started and descriptions of our development workflows, please see our contributing guide.

License

This repository is licensed under Apache License 2.0 - see LICENSE for more details.