Version information
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >=3.0.0 <5.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'bodgit-sssd', '1.0.2'
Learn more about managing modules with a PuppetfileDocumentation
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.conf
configuration file containing any global, per-service and per-domain settings. - The service controlling the
sssd
daemon. - 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_level
debug_timestamps
debug_microseconds
config_file_version
reconnection_retries
re_expression
full_name_format
try_inotify
krb5_rcache_dir
default_domain_suffix
override_space
user
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_level
debug_timestamps
debug_microseconds
timeout
reconnection_retries
fd_limit
client_idle_timeout
force_timeout
offline_timeout
subdomain_inherit
allowed_uids
user_attributes
wildcard_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_provider
debug_level
debug_timestamps
debug_microseconds
timeout
max_id
min_id
enumerate
subdomain_enumerate
force_timeout
entry_cache_timeout
entry_cache_user_timeout
entry_cache_group_timeout
entry_cache_netgroup_timeout
entry_cache_service_timeout
entry_cache_sudo_timeout
entry_cache_autofs_timeout
entry_cache_ssh_host_timeout
refresh_expired_interval
cache_credentials
cache_credentials_minimal_first_factor_length
account_cache_expiration
pwd_expiration_warning
use_fully_qualified_names
ignore_group_members
auth_provider
access_provider
chpass_provider
sudo_provider
selinux_provider
subdomains_provider
autofs_provider
hostid_provider
re_expression
full_name_format
lookup_family_order
dns_resolver_timeout
dns_discovery_domain
override_gid
case_sensitive
proxy_fast_alias
subdomain_homedir
realmd_tags
cached_auth_timeout
dyndns_update
dyndns_ttl
dyndns_iface
dyndns_refresh_interval
dyndns_update_ptr
dyndns_force_tcp
dyndns_server
override_homedir
homedir_substring
wildcard_limit
simple_allow_users
simple_deny_users
simple_allow_groups
simple_deny_groups
proxy_pam_target
proxy_lib_name
default_shell
base_directory
create_homedir
remove_homedir
homedir_umask
skel_dir
mail_dir
userdel_cmd
ldap_uri
ldap_backup_uri
ldap_chpass_uri
ldap_chpass_backup_uri
ldap_search_base
ldap_schema
ldap_default_bind_dn
ldap_default_authtok_type
ldap_default_authtok
ldap_user_object_class
ldap_user_name
ldap_user_uid_number
ldap_user_gid_number
ldap_user_gecos
ldap_user_home_directory
ldap_user_shell
ldap_user_uuid
ldap_user_objectsid
ldap_user_modify_timestamp
ldap_user_shadow_last_change
ldap_user_shadow_min
ldap_user_shadow_max
ldap_user_shadow_warning
ldap_user_shadow_inactive
ldap_user_shadow_expire
ldap_user_krb_last_pwd_change
ldap_user_krb_password_expiration
ldap_user_ad_account_expires
ldap_user_ad_user_account_control
ldap_ns_account_lock
ldap_user_nds_login_disabled
ldap_user_nds_login_expiration_time
ldap_user_nds_login_allowed_time_map
ldap_user_principal
ldap_user_extra_attrs
ldap_user_ssh_public_key
ldap_force_upper_case_realm
ldap_enumeration_refresh_timeout
ldap_purge_cache_timeout
ldap_user_fullname
ldap_user_member_of
ldap_user_authorized_service
ldap_user_authorized_host
ldap_user_certificate
ldap_group_object_class
ldap_group_name
ldap_group_gid_number
ldap_group_member
ldap_group_uuid
ldap_group_objectsid
ldap_group_modify_timestamp
ldap_group_type
ldap_group_external_member
ldap_group_nesting_level
ldap_groups_use_matching_rule_in_chain
ldap_initgroups_use_matching_rule_in_chain
ldap_use_tokengroups
ldap_netgroup_object_class
ldap_netgroup_name
ldap_netgroup_member
ldap_netgroup_triple
ldap_netgroup_modify_timestamp
ldap_service_object_class
ldap_service_name
ldap_service_port
ldap_service_proto
ldap_service_search_base
ldap_search_timeout
ldap_enumeration_search_timeout
ldap_network_timeout
ldap_opt_timeout
ldap_connection_expire_timeout
ldap_page_size
ldap_disable_paging
ldap_disable_range_retrieval
ldap_sasl_minssf
ldap_deref_threshold
ldap_tls_reqcert
ldap_tls_cacert
ldap_tls_cacertdir
ldap_tls_cert
ldap_tls_key
ldap_tls_cipher_suite
ldap_id_use_start_tls
ldap_id_mapping
ldap_idmap_range_min
ldap_idmap_range_max
ldap_idmap_range_size
ldap_idmap_default_domain_sid
ldap_idmap_default_domain
ldap_idmap_autorid_compat
ldap_min_id
ldap_max_id
ldap_sasl_mech
ldap_sasl_authid
ldap_sasl_realm
ldap_sasl_canonicalize
ldap_krb5_keytab
ldap_krb5_init_creds
ldap_krb5_ticket_lifetime
ldap_pwd_policy
ldap_referrals
ldap_dns_service_name
ldap_chpass_dns_service_name
ldap_chpass_update_last_change
ldap_access_filter
ldap_account_expire_policy
ldap_access_order
ldap_pwdlockout_dn
ldap_deref
ldap_rfc2307_fallback_to_local_users
ldap_sudorule_object_class
ldap_sudorule_name
ldap_sudorule_command
ldap_sudorule_host
ldap_sudorule_user
ldap_sudorule_option
ldap_sudorule_runasuser
ldap_sudorule_runasgroup
ldap_sudorule_notbefore
ldap_sudorule_notafter
ldap_sudorule_order
ldap_sudo_full_refresh_interval
ldap_sudo_smart_refresh_interval
ldap_sudo_use_host_filter
ldap_sudo_hostnames
ldap_sudo_ip
ldap_sudo_include_netgroups
ldap_sudo_include_regexp
ldap_autofs_map_master_name
ldap_autofs_map_object_class
ldap_autofs_map_name
ldap_autofs_entry_object_class
ldap_autofs_entry_key
ldap_autofs_entry_value
ldap_netgroup_search_base
ldap_user_search_base
ldap_group_search_base
ldap_sudo_search_base
ldap_autofs_search_base
krb5_server
krb5_backup_server
krb5_realm
krb5_canonicalize
krb5_use_kdcinfo
krb5_kpasswd
krb5_backup_kpasswd
krb5_ccachedir
krb5_ccname_template
krb5_auth_timeout
krb5_validate
krb5_keytab
krb5_store_password_if_offline
krb5_renewable_lifetime
krb5_lifetime
krb5_renew_interval
krb5_use_fast
krb5_fast_principal
krb5_use_enterprise_principal
krb5_map_user
krb5_confd_path
ad_domain
ad_server
ad_backup_server
ad_hostname
ad_enable_dns_sites
ad_access_filter
ad_site
ad_enable_gc
ad_gpo_access_control
ad_gpo_cache_timeout
ad_gpo_map_interactive
ad_gpo_map_remote_interactive
ad_gpo_map_network
ad_gpo_map_batch
ad_gpo_map_service
ad_gpo_map_permit
ad_gpo_map_deny
ad_gpo_default_right
ipa_domain
ipa_server
ipa_backup_server
ipa_hostname
ipa_enable_dns_sites
ipa_hbac_search_base
ipa_host_search_base
ipa_selinux_search_base
ipa_subdomains_search_base
ipa_master_domain_search_base
ipa_views_search_base
ipa_hbac_refresh
ipa_hbac_selinux
ipa_server_mode
ipa_automount_location
ipa_view_class
ipa_view_name
ipa_override_object_class
ipa_anchor_uuid
ipa_user_override_object_class
ipa_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_level
debug_timestamps
debug_microseconds
timeout
reconnection_retries
fd_limit
client_idle_timeout
force_timeout
offline_timeout
subdomain_inherit
enum_cache_timeout
entry_cache_nowait_percentage
entry_negative_timeout
filter_groups
filter_users
filter_users_in_groups
override_homedir
homedir_substring
fallback_homedir
override_shell
allowed_shells
vetoed_shells
shell_fallback
default_shell
get_domains_timeout
memcache_timeout
user_attributes
offline_credentials_expiration
offline_failed_login_attempts
offline_failed_login_delay
pam_verbosity
pam_id_timeout
pam_pwd_expiration_warning
pam_trusted_users
pam_public_domains
pam_account_expired_message
sudo_timed
autofs_negative_timeout
ssh_hash_known_hosts
ssh_known_hosts_timeout
ca_db
allowed_uids
wildcard_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 thesssd
service.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 <3.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.