Version information
released May 15th 2016
This version is compatible with:
- Puppet Enterprise >=3.7.0 <2015.4.0
- Puppet >=3.0.0 <5.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'bodgit-sssd', '1.0.1'Learn more about managing modules with a PuppetfileDocumentation
bodgit/sssd — version 1.0.1 May 15th 2016
sssd
Tested with Travis CI
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with sssd
- 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
Overview
This module manages SSSD.
Module Description
This module can install the SSSD packages, configure any services and domains, and optionally configure the D-Bus system service.
Setup
What sssd affects
- The package(s) providing the SSSD software.
- The
sssd.confconfiguration file containing any global, per-service and per-domain settings. - The service controlling the
sssddaemon. - D-Bus system bus configuration to make SSSD data available over D-Bus.
Beginning with sssd
include ::sssd
::sssd::service { 'nss': }
::sssd::domain { 'example.com':
id_provider => 'ldap',
...
}
Usage
Classes and Defined Types
Class: sssd
Parameters within sssd:
conf_dir
The base configuration directory, defaults to /etc/sssd.
conf_file
The configuration file, normally ${conf_dir}/sssd.conf.
package_name
The name of the package to install that provides the SSSD software. Currently it's assumed a single package or metapackage installs everything.
service_name
The name of the service managing sssd.
All other parameters
The following parameters map 1:1 to their equivalent in sssd.conf(5) for the
[sssd] section:
debug_leveldebug_timestampsdebug_microsecondsconfig_file_versionreconnection_retriesre_expressionfull_name_formattry_inotifykrb5_rcache_dirdefault_domain_suffixoverride_spaceuser
The domains and services parameters are managed automatically.
Class: sssd::dbus
Parameters within sssd::dbus:
package_name
The name of the package to install that provides the SSSD/D-Bus integration.
All other parameters
The following parameters map 1:1 to their equivalent in sssd.conf(5) for the
[ifp] section:
debug_leveldebug_timestampsdebug_microsecondstimeoutreconnection_retriesfd_limitclient_idle_timeoutforce_timeoutoffline_timeoutsubdomain_inheritallowed_uidsuser_attributeswildcard_limit
Defined Type: sssd::domain
Parameters within sssd::domain:
name
The label to associate with this domain.
All other parameters
The following parameters map 1:1 to their equivalent in sssd.conf(5) for the
[domain/${name}] section:
id_providerdebug_leveldebug_timestampsdebug_microsecondstimeoutmax_idmin_idenumeratesubdomain_enumerateforce_timeoutentry_cache_timeoutentry_cache_user_timeoutentry_cache_group_timeoutentry_cache_netgroup_timeoutentry_cache_service_timeoutentry_cache_sudo_timeoutentry_cache_autofs_timeoutentry_cache_ssh_host_timeoutrefresh_expired_intervalcache_credentialscache_credentials_minimal_first_factor_lengthaccount_cache_expirationpwd_expiration_warninguse_fully_qualified_namesignore_group_membersauth_provideraccess_providerchpass_providersudo_providerselinux_providersubdomains_providerautofs_providerhostid_providerre_expressionfull_name_formatlookup_family_orderdns_resolver_timeoutdns_discovery_domainoverride_gidcase_sensitiveproxy_fast_aliassubdomain_homedirrealmd_tagscached_auth_timeoutdyndns_updatedyndns_ttldyndns_ifacedyndns_refresh_intervaldyndns_update_ptrdyndns_force_tcpdyndns_serveroverride_homedirhomedir_substringwildcard_limitsimple_allow_userssimple_deny_userssimple_allow_groupssimple_deny_groupsproxy_pam_targetproxy_lib_namedefault_shellbase_directorycreate_homedirremove_homedirhomedir_umaskskel_dirmail_diruserdel_cmdldap_urildap_backup_urildap_chpass_urildap_chpass_backup_urildap_search_baseldap_schemaldap_default_bind_dnldap_default_authtok_typeldap_default_authtokldap_user_object_classldap_user_nameldap_user_uid_numberldap_user_gid_numberldap_user_gecosldap_user_home_directoryldap_user_shellldap_user_uuidldap_user_objectsidldap_user_modify_timestampldap_user_shadow_last_changeldap_user_shadow_minldap_user_shadow_maxldap_user_shadow_warningldap_user_shadow_inactiveldap_user_shadow_expireldap_user_krb_last_pwd_changeldap_user_krb_password_expirationldap_user_ad_account_expiresldap_user_ad_user_account_controlldap_ns_account_lockldap_user_nds_login_disabledldap_user_nds_login_expiration_timeldap_user_nds_login_allowed_time_mapldap_user_principalldap_user_extra_attrsldap_user_ssh_public_keyldap_force_upper_case_realmldap_enumeration_refresh_timeoutldap_purge_cache_timeoutldap_user_fullnameldap_user_member_ofldap_user_authorized_serviceldap_user_authorized_hostldap_user_certificateldap_group_object_classldap_group_nameldap_group_gid_numberldap_group_memberldap_group_uuidldap_group_objectsidldap_group_modify_timestampldap_group_typeldap_group_external_memberldap_group_nesting_levelldap_groups_use_matching_rule_in_chainldap_initgroups_use_matching_rule_in_chainldap_use_tokengroupsldap_netgroup_object_classldap_netgroup_nameldap_netgroup_memberldap_netgroup_tripleldap_netgroup_modify_timestampldap_service_object_classldap_service_nameldap_service_portldap_service_protoldap_service_search_baseldap_search_timeoutldap_enumeration_search_timeoutldap_network_timeoutldap_opt_timeoutldap_connection_expire_timeoutldap_page_sizeldap_disable_pagingldap_disable_range_retrievalldap_sasl_minssfldap_deref_thresholdldap_tls_reqcertldap_tls_cacertldap_tls_cacertdirldap_tls_certldap_tls_keyldap_tls_cipher_suiteldap_id_use_start_tlsldap_id_mappingldap_idmap_range_minldap_idmap_range_maxldap_idmap_range_sizeldap_idmap_default_domain_sidldap_idmap_default_domainldap_idmap_autorid_compatldap_min_idldap_max_idldap_sasl_mechldap_sasl_authidldap_sasl_realmldap_sasl_canonicalizeldap_krb5_keytabldap_krb5_init_credsldap_krb5_ticket_lifetimeldap_pwd_policyldap_referralsldap_dns_service_nameldap_chpass_dns_service_nameldap_chpass_update_last_changeldap_access_filterldap_account_expire_policyldap_access_orderldap_pwdlockout_dnldap_derefldap_rfc2307_fallback_to_local_usersldap_sudorule_object_classldap_sudorule_nameldap_sudorule_commandldap_sudorule_hostldap_sudorule_userldap_sudorule_optionldap_sudorule_runasuserldap_sudorule_runasgroupldap_sudorule_notbeforeldap_sudorule_notafterldap_sudorule_orderldap_sudo_full_refresh_intervalldap_sudo_smart_refresh_intervalldap_sudo_use_host_filterldap_sudo_hostnamesldap_sudo_ipldap_sudo_include_netgroupsldap_sudo_include_regexpldap_autofs_map_master_nameldap_autofs_map_object_classldap_autofs_map_nameldap_autofs_entry_object_classldap_autofs_entry_keyldap_autofs_entry_valueldap_netgroup_search_baseldap_user_search_baseldap_group_search_baseldap_sudo_search_baseldap_autofs_search_basekrb5_serverkrb5_backup_serverkrb5_realmkrb5_canonicalizekrb5_use_kdcinfokrb5_kpasswdkrb5_backup_kpasswdkrb5_ccachedirkrb5_ccname_templatekrb5_auth_timeoutkrb5_validatekrb5_keytabkrb5_store_password_if_offlinekrb5_renewable_lifetimekrb5_lifetimekrb5_renew_intervalkrb5_use_fastkrb5_fast_principalkrb5_use_enterprise_principalkrb5_map_userkrb5_confd_pathad_domainad_serverad_backup_serverad_hostnamead_enable_dns_sitesad_access_filterad_sitead_enable_gcad_gpo_access_controlad_gpo_cache_timeoutad_gpo_map_interactivead_gpo_map_remote_interactivead_gpo_map_networkad_gpo_map_batchad_gpo_map_servicead_gpo_map_permitad_gpo_map_denyad_gpo_default_rightipa_domainipa_serveripa_backup_serveripa_hostnameipa_enable_dns_sitesipa_hbac_search_baseipa_host_search_baseipa_selinux_search_baseipa_subdomains_search_baseipa_master_domain_search_baseipa_views_search_baseipa_hbac_refreshipa_hbac_selinuxipa_server_modeipa_automount_locationipa_view_classipa_view_nameipa_override_object_classipa_anchor_uuidipa_user_override_object_classipa_group_override_object_class
Defined Type: sssd::service
Parameters within sssd::service:
name
The name of the service. Valid services are nss, pam, sudo, autofs,
ssh, pac or ifp. Note that the ifp service is managed by the
sssd::dbus class.
All other parameters
The following parameters map 1:1 to their equivalent in sssd.conf(5) for the
[${name}] section:
debug_leveldebug_timestampsdebug_microsecondstimeoutreconnection_retriesfd_limitclient_idle_timeoutforce_timeoutoffline_timeoutsubdomain_inheritenum_cache_timeoutentry_cache_nowait_percentageentry_negative_timeoutfilter_groupsfilter_usersfilter_users_in_groupsoverride_homedirhomedir_substringfallback_homediroverride_shellallowed_shellsvetoed_shellsshell_fallbackdefault_shellget_domains_timeoutmemcache_timeoutuser_attributesoffline_credentials_expirationoffline_failed_login_attemptsoffline_failed_login_delaypam_verbositypam_id_timeoutpam_pwd_expiration_warningpam_trusted_userspam_public_domainspam_account_expired_messagesudo_timedautofs_negative_timeoutssh_hash_known_hostsssh_known_hosts_timeoutca_dballowed_uidswildcard_limit
Functions
Function: validate_sssd_search_base
Validate a string or array of strings are valid SSSD search bases.
validate_sssd_search_base('dc=example,dc=com')
validate_sssd_search_base('dc=example,dc=com?subtree?')
validate_sssd_search_base('cn=host_specific,dc=example,dc=com?subtree?(host=thishost)?dc=example.com?subtree?')
validate_sssd_search_base(['dc=example,dc=com'])
Native Types
Native Type: sssd_conf
Sssd_conf {
target => '/etc/sssd/sssd.conf',
}
sssd_conf { 'Configuration file version':
ensure => present,
section => 'sssd',
setting => 'config_file_version',
value => '2',
}
sssd_conf { 'sssd/debug_level':
ensure => absent,
}
Parameters within sssd_conf:
name
The name of the section and setting separated by /, or a unique string.
ensure
Standard ensurable parameter.
section
The section in the sssd.conf file where the setting resides. Defaults to the
global [sssd] section.
setting
The name of the setting to manage.
value
The value of the setting.
target
The file in which to manage the setting. Defaults to /etc/sssd/sssd.conf.
If a file resource exists in the catalogue for this value it will be autorequired.
Examples
Configure SSSD to use LDAP for NSS:
include ::sssd
::sssd::service { 'nss': }
::sssd::domain { 'example.com':
id_provider => 'ldap',
ldap_schema => 'rfc2307',
ldap_uri => ['ldap://192.0.2.1'],
ldap_search_base => 'dc=example,dc=com',
ldap_tls_reqcert => 'never',
ldap_id_use_start_tls => false,
ldap_default_bind_dn => 'cn=Manager,dc=example,dc=com',
ldap_default_authtok => 'secret',
}
class { '::nsswitch':
passwd => ['files', 'sss'],
shadow => ['files', 'sss'],
group => ['files', 'sss'],
}
Class['::sssd'] -> Class['::nsswitch']
Extend the above example to also make the SSSD data available over D-Bus:
include ::dbus
include ::sssd
::sssd::service { 'nss': }
::sssd::domain { 'example.com':
id_provider => 'ldap',
ldap_schema => 'rfc2307',
ldap_uri => ['ldap://192.0.2.1'],
ldap_search_base => 'dc=example,dc=com',
ldap_tls_reqcert => 'never',
ldap_id_use_start_tls => false,
ldap_default_bind_dn => 'cn=Manager,dc=example,dc=com',
ldap_default_authtok => 'secret',
}
include ::sssd::dbus
class { '::nsswitch':
passwd => ['files', 'sss'],
shadow => ['files', 'sss'],
group => ['files', 'sss'],
}
Class['::sssd'] -> Class['::nsswitch']
Reference
Classes
Public Classes
sssd: Main class for managing SSSD.sssd::dbus: Main class for managing SSSD/D-Bus integration.
Private Classes
sssd::install: Handles SSSD installation.sssd::config: Handles global SSSD configuration.sssd::params: Different configuration data for different systems.sssd::daemon: Manages thesssdservice.sssd::dbus::install: Handles SSSD/D-Bus installation.sssd::dbus::config: Handles configuring the SSSD/D-Bus integration.
Defined Types
Public Defined Types
sssd::domain: Handles per-domain configuration.sssd::service: Handles per-service configuration.
Functions
validate_sssd_search_base: Parameter validation.
Native Types
sssd_conf: Manages a setting in the SSSD configuration file.
Limitations
This module takes the (somewhat laborious) approach of creating parameters for
each sssd.conf setting rather than just pass in a large hash of settings
which should result in more control.
Any setting that accepts the boolean TRUE/FALSE values is mapped to a
native Puppet boolean type. Any multi-valued setting accepts an array of
values.
Currently almost all parameters are optional, the only mandatory parameter is
that of the identity provider (id_provider) for the
sssd::domain defined type. This may change in
the future if the logic becomes more obvious.
This module has been built on and tested against Puppet 3.0 and higher.
The module has been tested on:
- RedHat/CentOS Enterprise Linux 6/7
Testing on other platforms has been light and cannot be guaranteed.
Development
Please log issues or pull requests at github.
Types in this module release
Dependencies
- puppetlabs/stdlib (>=4.6.0 <5.0.0)
- bodgit/bodgitlib (>=1.0.0 <2.0.0)
- richardc/datacat (>=0.6.1 <1.0.0)
- herculesteam/augeasproviders_core (>=2.1.0 <3.0.0)
- bodgit/dbus (>=1.1.2 <2.0.0)
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 2013 Puppet Labs
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.