Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.4.x
- Puppet >= 4.9.0 < 6.0.0
- Ubuntu
Start using this module
Documentation
hiera5_ldap
Table of Contents
Description
This is a custom Hiera 5 backend, that allows hiera to perform LDAP queries. It is intended to be used in a puppet environment with a puppet master; it (likely) won't work in a masterless puppet environment.
Setup
What hiera5_ldap affects
This backend only reads from LDAP, and does not need write access.
Setup Requirements
This backend leverages the jruby-ldap ruby gem. This gem needs to be installed on your puppet master:
$ sudo /opt/puppetlabs/bin/puppetserver gem install jruby-ldap
You'll also need read access to the LDAP instance you want to query from your puppet master.
Beginning with hiera5_ldap
To be able to query your LDAP instance from hiera, you'll have to configure how to connect to your LDAP instance, in your hiera hierarchy, i.e. in your hiera.yaml file. The minimum configuration would be:
...
hierarchy:
...
- name: "Hiera-LDAP lookup"
lookup_key: ldap_lookup_key
options:
host: '<your LDAP instance>'
...
In order to perform LDAP searches, hiera would connect to <your LDAP instance>, using simple binding without username and password, without using SSL, on the default port 389.
In your puppet code, you can now query your LDAP instance with a hiera call:
hiera('ldap:///<LDAP search>')
where LDAP search is formatted like an LDAP URL, like so: <base DN>?<attributes>?<scope>?<filter>.
The result will be an array of hashes, with the LDAP attributes as keys. The value of a hash key, or attribute, is an array of values found in LDAP. The exception is the value of attribute 'dn', which is a string instead of an array.
For example, if your groups are 'posixGroups' in the 'ou=Groups' subtree, you can query the members of the 'admins' group as follows:
hiera('ldap:///ou=Groups,dc=example,dc=com?memberUid?sub?(cn=admins)')
This results in:
- dn: 'cn=admins,ou=Groups,dc=example'
memberUid: ['admin1', 'admin2', 'admin3']
You have to include the base DN in your query. If you omit the attributes from the query, you'll get all attributes. If you omit the scope, it will default to 'sub', and if you leave out the filter, it will default to 'objectClass=*'. You can also leave out trailing question marks. I.e., if you do
hiera('ldap:///dc=example,dc=com')
you'll get your entire LDAP tree as result.
Usage
The above examples are all 'direct'; the LDAP URL is just a parameter to the hiera call. You can also use 'indirect' LDAP queries, where the actual query is looked up in a yaml file, much like regular hiera keys are looked up. This allows for automatic class parameter lookup.
For example, if you configure your hiera.yaml like this:
...
hierarchy:
...
- name: "Hiera-LDAP lookup"
path: "nodes/%{trusted.certname}.ldap"
lookup_key: ldap_lookup_key
options:
host: '<your LDAP instance>'
...
and the file nodes/<certname>.ldap looks like this:
my_class::users: 'ldap:///ou=People,dc=example,dc=com??sub?uid=*'
and you my_class module looks like this:
class my_class(Array[Hash] $users = [])
then, when the puppet master prepares the for node <certname>, for the value of users it will look up the LDAP query in nodes/<certname>.ldap, perform the query, and plug the value into the users variable.
Indirect queries also support hiera interpolation, so you should be able to write something like:
my_class::host_aliases: 'ldap:///ou=Hosts,dc=example,dc=com?cn?sub?cn=%{facts.hostname}'
Reference
Hiera hierarchy
path/paths
An array of yaml formatted files in your hiera tree that link variables to LDAP queries. I suppose you can re-use your yaml/eyaml hiera file, but I think you'll need to be sure your hiera.yaml contains the LDAP section before yaml or eyaml sections.
options
host
The hostname of your LDAP instance. Required.
port
The port that your LDAP service listens on. Default: 389 when use_ssl is false, 636 when use_ssl is true.
bind_dn
The bind DN necessary to query your LDAP instance, for example: cn=admin,dc=example,dc=com. Default empty.
bind_password
The password that goes with your bind_dn. Default empty.
bind_method
The bind method. Available options: none (which is simple, but with bind_dn and bind_password ignored), simple, sasl. Default: simple.
use_ssl
Whether to use SSL. Boolean, default false.
If you want to use SSL, you'll have to ensure JRuby can verify your LDAP server certificate. For this, you have to you add a certificate to the Java keystore that verifies your LDAP server certificate. For example, this can be the root certificate of your local CA, or the self-signed certificate of your LDAP server.
On Ubuntu, this can be achieved by putting the certificate in /usr/local/share/ca-certificates on your puppet master, and then running update-ca-certificates. On other distributions it will probably work similarly, or you can use keytool to add the certificate to the jre/lib/security/cacerts file in your java distribution. For example:
# keytool -storepass changeit -import -noprompt -alias '<certificate name>' -keystore <cacerts> -file '<certificate file>'
You cannot use SSL and opt out of verifying the certificate, because that is not supported by jruby-ldap.
LDAP URL
An LDAP URL has the following format: ldap:///<base DN>?<attributes>?<scope>?<filter>. The prefix ldap:/// is fixed.
<base DN>
The (search) base DN for your LDAP instance, like ou=People,dc=example,dc=com. Required.
<attributes>
A comma separated list of attributes to return. When empty, all attributes are returned. The special attribute 'dn' is always returned. Default: empty.
<scope>
The scope of the query. Available options: one (singleLevel), base (baseObject), sub (wholeSubtree). Default: sub.
<filter>
LDAP filter to use, follows regular LDAP filter syntax (i.e. you can write complex queries). Default: objectClass=*.
Limitations
This backend uses jruby-ldap instead of net/ldap, because net/ldap requires Ruby 2.0 support, but that is not yet the default on a puppet 4/5 master. I intend to rewrite this to net/ldap once JRuby on a puppet master becomes Ruby 2.0 compatible.
One of the limitations of using jruby-ldap is the absence of StartTLS.
Further limitations:
- no unit tests to speak of (I have currently no idea how to test a custom hiera backend)
- this backend has seen extremely limited real-world testing
- only tested on Ubuntu 16.04.
Todo
- allow for multiple LDAP servers in
hiera.yaml - allow for queries to be written as a hash, i.e. like:
query: base_dn: ou=People,dc=example,dc=com attributes: uid scope: sub filter: (uid=*)
Development
Run rake spec to run the tests (but nothing useful there right now).
Release Notes
Initial version, treat as a Minimum Viable Product.
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.