conjur
Version information
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.0.0 < 5.0.0
- , ,
This module has been deprecated by its author since Oct 6th 2017.
The author has suggested cyberark-conjur as its replacement.
Start using this module
Documentation
conjur
Table of Contents
- Description
- Setup - The basics of getting started with conjur
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Support - "Puppet Supported" details and contact info
Description
This is the official Puppet module for Conjur, a robust identity and access management platform. This module simplifies the operations of establishing Conjur host identity and allows authorized Puppet nodes to fetch secrets from Conjur.
Setup
Setup Requirements
This module requires that you have a Conjur endpoint available to the Puppet nodes using this module.
Beginning with conjur
This module provides a conjur::secret
function that can be used to retrieve secrets from Conjur. Given a Conjur variable identifier, conjur::secret
uses the node’s Conjur identity to resolve and return the variable’s value.
$dbpass = conjur::secret('production/postgres/password')
Hiera attributes can also be used to inform which secret should be fetched, depending on the node running the Conjur module. For example, if hiera('domain')
returns app1.example.com
and a Conjur variable named domains/app1.example.com/ssl-cert
exists, the SSL certificate can be retrieved and written to a file like so:
file { '/etc/ssl/cert.pem':
content => conjur::secret("domains/%{hiera('domain')}/ssl-cert"),
ensure => file
show_diff => false # only required for Puppet < 4.6
# diff will automatically get redacted in 4.6 if content is Sensitive
}
Sensitive data type (Puppet >= 4.6)
Note in Puppet >= 4.6 conjur::secret
returns values wrapped
in a Sensitive
data type. In some contexts, such as string interpolation,
it might cause surprising results (interpolating to Sensitive [value redacted]
).
This is intentional, as it makes it harder to accidentally mishandle secrets.
To use a secret as a string, you need to explicitly request it using the
unwrap
function; the result of the processing should be again wrapped in
a Sensitive
value.
In particular, you should not pass unwrapped secrets as resource parameters
if you can avoid it. Many resource types support Sensitive
data type and
handle it correctly. If a resource you're using does not, file a bug.
$dbpass = conjur::secret('production/postgres/password')
# In Puppet 4.6, use Sensitive data type to handle anything sensitive
$db_yaml = Sensitive("password: ${dbpass.unwrap}")
file { '/etc/someservice/db.yaml':
content => $db_yaml, # this correctly handles both Sensitive and String
ensure => file,
mode => '0600', # remember to limit reading
}
Usage
This module provides the conjur::secret
function, described above, and the conjur
class, which can be configured to establish Conjur host identity on the node running Puppet.
Pre-established host identity
For best security properties, use conjurize or a similar method to establish host identity before running Puppet to configure. This way Puppet master only ever handles a temporary access token instead of real, permanent Conjur credentials of the hosts it manages.
If a host is so pre-configured, the settings and credentials are automatically obtained and used. In this case, all that is needed to use conjur::secret
is a simple
include conjur
Conjur host identity with Host Factory
If pre-establishing host identity is unfeasible, we instead recommend bootstrapping Conjur host identity using a Host Factory token. Nodes inherit the permissions of the layer for which the Host Factory token was generated.
To use a Host Factory token with this module, set variables authn_login
and host_factory_token
. Do not set the variable authn_api_key
when using host_factory_token
; it is not required. authn_login
should have a host/
prefix; the part after the slash will be used as the node’s name in Conjur.
class { conjur:
account => 'mycompany',
appliance_url => 'https://conjur.mycompany.com/',
authn_login => 'host/redis001',
host_factory_token => Sensitive('3zt94bb200p69nanj64v9sdn1e15rjqqt12kf68x1d6gb7z33vfskx'),
ssl_certificate => file('/etc/conjur.pem')
version => 5,
}
By default, all nodes using this Puppet module to bootstrap identity with host_factory_token will have the following annotation set:
puppet: true
Conjur host identity with API key
For one-off hosts or test environments it may be preferable to create a host in Conjur and then directly assign its Conjur identity in this module.
class { conjur:
appliance_url => 'https://conjur.mycompany.com/',
authn_login => 'host/redis001',
authn_api_key => Sensitive('f9yykd2r0dajz398rh32xz2fxp1tws1qq2baw4112n4am9x3ncqbk3'),
ssl_certificate => file('/conjur-ca.pem')
version => 5,
}
Conjur Enterprise Edition
If you're using this module to establish host identity with Conjur Enterprise
Edition version 4.x, you should use version => 4
. (This is also the default
for backwards compatibility reasons.) Also note that the appliance_url
will
need to include the /api/
suffix.
For example:
class { conjur:
appliance_url => 'https://conjur.mycompany.com/api/',
authn_login => 'host/redis001',
host_factory_token => Sensitive('3zt94bb200p69nanj64v9sdn1e15rjqqt12kf68x1d6gb7z33vfskx'),
ssl_certificate => file('/etc/conjur.pem')
version => 4,
}
Reference
Classes
Public Classes
::conjur
Functions
Public Functions
conjur::secret
::conjur
This class establishes Conjur host identity on the node so that secrets can be fetched from Conjur. The identity and Conjur endpoint configuration can be pre-configured on a host using /etc/conjur.conf
and /etc/conjur.identity
or provided as parameters. The identity can also be bootstrapped using a host factory token.
Note
Several parameters (ie. API keys) are of Sensitive
data type on Puppet >= 4.6.
To pass a normal string, you need to wrap it using Sensitive("example")
.
Parameters
account
Conjur account authority name. Optional for v4, required for v5.
appliance_url
A Conjur endpoint (with trailing /api
for v4).
authn_login
User username or host name (prefixed with host/
).
authn_api_key
API key for a user or host. Must be Sensitive
if supported.
ssl_certificate
Content of the X509 certificate of the root CA of Conjur, PEM formatted.
When using Puppet's file
function, the path to the cert must be absolute.
host_factory_token
You can use a host factory token to obtain a host identity. Must be Sensitive
if supported.
Simply use this parameter to set it. The host record will be created in Conjur.
authn_token
Raw (unencoded) Conjur token. This is usually only useful for testing.
Must be Sensitive
if supported.
version
Conjur API version. Should be set to 5 unless you're using Conjur Enterprise 4.x.
Defaults to 4 for backward compatibility reasons. (This will change in a future version.)
Examples
# use a pre-existing Conjur configuration host identity
include conjur
# using an host factory token
class { conjur:
appliance_url => 'https://conjur.mycompany.com/',
authn_login => 'host/redis001',
host_factory_token => Sensitive('f9yykd2r0dajz398rh32xz2fxp1tws1qq2baw4112n4am9x3ncqbk3'),
ssl_certificate => file('conjur-ca.pem')
version => 5,
}
# same, but /etc/conjur.conf and certificate are already on a host
# (eg. baked into a base image)
class { conjur:
authn_login => 'host/redis001',
host_factory_token => Sensitive('f9yykd2r0dajz398rh32xz2fxp1tws1qq2baw4112n4am9x3ncqbk3'),
}
# using an API key
class { conjur:
account => 'mycompany',
appliance_url => 'https://conjur.mycompany.com/',
authn_login => 'host/redis001',
authn_api_key => Sensitive('f9yykd2r0dajz398rh32xz2fxp1tws1qq2baw4112n4am9x3ncqbk3'),
ssl_certificate => file('conjur-ca.pem')
version => 5,
}
conjur::secret
This function uses the node’s Conjur host identity to authenticate with Conjur and retrieve a secret that the node is authorized to fetch. The output of this function is a string that contains the value of the variable parameter. If the secret cannot be fetched an error is thrown.
The returned value is Sensitive
data type if supported (see notes above).
Parameters
variable
The identifier of a Conjur variable to retrieve.
Example
dbpass = conjur::secret('production/postgres/password')
Limitations
See metadata.json for supported platforms
Development
Open an issue or fork this project and open a Pull Request.
Support
Please note, that this is a "Partner Supported" module, which means that technical customer support for this module is solely provided by Conjur.
Puppet does not provide support for any Partner Supported modules. Technical support for the Conjur module can be reached via these channels:
Formal requests: https://conjur.zendesk.com
Informal requests: support@conjur.com
Change Log
All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.
[1.2.0] - 2017-09-27
- Support Conjur v5 API.
[1.1.0] - 2017-05-24
- Cleanup and refactor of project files. No behavior change.
[1.0.1] - 2017-03-10
- Store Conjur configuration and identity on the node, if not present.
[1.0.0] - 2017-03-02
v1.0.0 is a complete revamp of the module. This release includes several breaking changes.
See README.md for complete details.
[0.0.4] - 2015-05-11
- fixed another instance of the same bug
[0.0.2] - 2014-09-24
- fixed a bug in host identity manifest preventing usage of host factory
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 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.