CyberArk Conjur Service Broker for PCF (Beta)
WARNING: The CyberArk Conjur Service Broker for PCF tile is currently in beta and is intended for evaluation and test purposes only. Do not use this product in a PCF production environment.
This documentation describes the CyberArk Conjur Service Broker for Pivotal Cloud Foundry (PCF). This Service Broker provides Conjur machine identity management and authentication, policy-based authorization, and other Conjur services to your PCF applications and microservices.
The CyberArk Conjur Service Broker for PCF registers a service broker with PCF and exposes its service plans on the Marketplace. Developers can then create applications that access a Conjur appliance. The Service Broker provides the interface between your PCF applications and a Conjur appliance.
The CyberArk Conjur Service Broker for PCF installs a buildpack that includes the Conjur Summon tool. Summon fetches secrets from Conjur using the binding ID from your PCF service as the unique application identity.
CyberArk Conjur Service Broker for PCF includes the following key features:
- After you configure the tile and bind applications to service instances, your PCF applications, containers, and microservices assume a host identity in Conjur. This identity enables secure access to secret values and policy grants stored in Conjur.
- If you have an existing Conjur appliance, you can grant privileges to PCF applications to access the existing Conjur secrets through Conjur policy.
- Conjur integrates easily into the PCF environment and the PCF developer workflow.
- The strong authentication model provided by Conjur is available to PCF applications.
- The Conjur role-based policy model for authorizations applies to applications running in PCF.
- Access to secrets is configurable at the PCF application level, making it easy to ensure least privilege access.
Note: As of PCF v2.0, Elastic Runtime is renamed Pivotal Application Service (PAS).
The following table provides version and version-support information about CyberArk Conjur Service Broker for PCF.
|Release date||June 26, 2018|
|Software component version||CyberArk Conjur Service Broker - v0.3.1
CyberArk Conjur Buildpack - v1.0.0
|Compatible Ops Manager version(s)||v1.11.x, v1.12.x, v2.0.x, and v2.1.x|
|Compatible Pivotal Application Service version(s)||v1.11.x, v1.12.x, v2.0.x, and v2.1.x|
|IaaS support||AWS, Azure, GCP, OpenStack, and vSphere|
CyberArk Conjur Service Broker for PCF has the following requirements:
You must have an existing Conjur appliance installed. The appliance may be external to the PCF environment. Supported versions are:
- Enterprise Conjur (v126.96.36.199 and later)
- Use v188.8.131.52 or later to search for CF hosts in the Conjur UI
- Open Source Conjur (v5.x)
- Hosted Conjur is a hosted version of Open Source Conjur. You can quickly get a hosted Conjur instance running for evaluation purposes. Visit the hosted Conjur page to sign up.
- Enterprise Conjur (v184.108.40.206 and later)
To configure the PCF tile, you must know the following information about your Conjur appliance:
- Conjur account, which is specified when the Conjur appliance is created and configured. For hosted Conjur, the account is usually an email address that you specify on the web form.
- URL to the Conjur appliance.
- Valid Conjur identity for a host that has
createprivileges on PCF-related Conjur policy. The Service Broker uses these credentials to add and remove host identities as you deploy and remove PCF applications. See Recommendations.
- Conjur API key associated with the host.
- (Optional) PCF Conjur Policy Branch ID. For production Conjur appliances, CyberArk strongly recommends a Conjur policy dedicated to PCF; otherwise, the Conjur root policy is the default. See Recommendations for more information.
- Conjur v4 for Enterprise Conjur or v5 for Open Source Conjur.
Enterprise Conjur (v4) has the following additional requirements:
* The tile installation requires a copy and paste of the x509 certificate that was created when Conjur was initiated. The certificate is stored in a .pem file that was created by the
conjur init command. The default path is
* The Service Broker requires a Conjur host factory to use when adding host identities. The examples in Recommendations include host factory definitions. If a host factory is not properly defined, a health check near the end of tile installation reports the condition, and the tile installation fails.
Create a Dedicated Conjur Policy for PCF
CyberArk strongly recommends that you create a Conjur policy dedicated to PCF before installing the PCF tile.
The syntax for defining a Conjur Policy with ID
pcf is as follows:
- !policy id: pcf
This can be loaded into the root policy or any other Conjur policy you would like. Host identities for PCF-deployed applications will be loaded into the
pcf Conjur policy when the applications are bound to a Conjur service instance.
A dedicated Conjur policy for PCF supports least privilege principles in the following ways:
* The secrets, host identities, and access control policies for your PCF-deployed applications are isolated from other resources stored in Conjur.
* Conjur access privileges required by the Service Broker, DevOps teams, and your applications can be limited in scope to the dedicated Conjur policy for PCF.
* You can give a limited set of Conjur users access to the dedicated Conjur policy for PCF, with even finer-grained permissions possible within the PCF policy itself.
* For Conjur Enterprise (v4), you can define the host factory layer in the dedicated Conjur policy for PCF, rather than in the root policy.
When creating the dedicated Conjur policy for PCF, consider the following:
* The Service Broker requires
update privileges on the policy to add and remove host identities. Members of the group that owns the policy have those privileges.
* PCF DevOps personnel need access to Conjur to declare application secrets and grant privileges to the applications to access those secrets.
* For Conjur Enterprise (v4), a host factory is required. Both the ID of the layer and the host factory must use the syntax
apps is a constant. For example,
pcf-apps is used in the policy example shown below where the dedicated policy for PCF is called
To create a dedicated Conjur policy for PCF, do the following:
Create a policy using the following example as a guide. Save the policy as a YAML file (such as
- !host id: pcf-service-broker annotations: platform: pivotalcloudfoundry - !group id: pcf-admin-group - !grant role: !group pcf-admin-group member: !host pcf-service-broker # Allow host read access to its own resource, to read annotations - !permit role: !host pcf-service-broker privilege: read resource: !host pcf-service-broker - !policy id: pcf /* Policy ID does not have to be pcf owner: !group pcf-admin-group /* Owners have complete privileges on the policy body: /* The body and following layer are - !layer pcf-apps /* required for Conjur Enterprise v4; /* optional otherwise. /* Layer name and host-factory name /* must be [policy-id]-apps - !host-factory id: pcf-apps layers: [ !layer pcf-apps ]
This policy file creates a
host/pcf-service-broker host that can be used as the
CONJUR_AUTHN_LOGIN role in the tile configuration.
pcf-service-broker host is a member of the
pcf-admin-group group, which owns the
pcf policy, so it has
update privileges on that policy as required.
The PCF policy has a
pcf-apps layer and corresponding host factory. If using Conjur v4, application hosts will be added to the
pcf-apps layer via the
pcf-apps host factory when the application is bound to a Conjur service instance.
Additional policies for individual applications can be appended to this file or loaded in separate YAML files as needed.
Load the policy into Conjur as follows (in this example, we are loading it into the root policy):
For Conjur Enterprise (v4):
$ conjur policy load --as-group security_admin your-pcf-policy-file.yml
For Conjur Open Source (v5):
$ conjur policy load root your-pcf-policy-file.yml
In the CyberArk Conjur Service Broker for PCF tile configuration:
* For PCF Conjur Policy Branch ID, use the fully-qualified ID of the dedicated Conjur policy for PCF (
pcf in the above example).
* For Conjur Login, use a Conjur host who is a member of the Conjur group that owns the PCF policy (
host/pcf-service-broker in the example above). The host also needs to be permitted to read its own annotations.
* For Conjur API Key, use that host’s API key. The admin who created the role can retrieve the value with this command:
$ conjur host rotate_api_key -h pcf-service-broker
Use the Default Root Policy
If you decide to leave the PCF Conjur Policy Branch ID blank in the tile configuration (that is, you choose to use the default root policy), consider the following:
* You are not following least privilege best practice.
* The Conjur host identity that you provide on tile installation must have
update privileges on the root policy, which means that it will be privileged to edit any policy in your Conjur installation.
* The Service Broker will add host identities for your PCF applications to the root policy.
* The PCF DevOps teams will be altering policy files in the root policy.
* For integration with Conjur v4, a Host Factory named
apps is required. Add the following layer declaration to the root policy:
- !layer apps - !host-factory id: apps layers: [ !layer apps ]
There are no known limitations.
Copyright 2018 CyberArk
Licensed under the Apache License, Version 2.0 (the “License”). You may not use this software except in compliance with the License. You may obtain a copy of the License at:
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.