realmd

Puppet module to join a system to AD and Kerberos with realmd

Project URL RSS Feed Report issues

Module Stats

57 downloads

57 latest version

4.7 quality score

Version information

released Apr 10th 2024

This version is compatible with:

Puppet Enterprise 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
Puppet >= 7.0.0 < 9.0.0
, , , ,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'h0tw1r3-realmd', '3.0.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add h0tw1r3-realmd

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install h0tw1r3-realmd --version 3.0.0

Documentation

h0tw1r3/realmd — version 3.0.0 Apr 10th 2024

Puppet Realmd

Overview
Module Description - What the module does and why it is useful
Setup - The basics of getting started with realmd
Usage - Configuration options and additional functionality
Reference - An under-the-hood peek at what the module is doing and how
Limitations - OS compatibility, etc.

Overview

This module installs and configures Realmd and joins a domain. It will also optionally control the Kerberos client and SSSD configuration files and the SSSD service.

Module Description

Realmd is a high-level tool for discovering and joining domains. It provides automatic base configuration of SSSD, nsswitch settings, and PAM configuration changes necessary for a Linux client to participate in an Active Directory domain.

This module will install the necessary Realmd packages and dependencies, configure Realmd, and join an Active Directory domain via one of two methods:

Username and password
Kerberos keytab file

It also optionally manages the contents of the Kerberos client configuration and SSSD configuration files.

Setup

What realmd affects

Packages
- Redhat Family
  - realmd
  - adcli
  - sssd
  - krb5-workstation
  - oddjob
  - oddjob-mkhomedir
- Debian Family
  - adcli
  - krb5-user
  - sssd
  - sssd-tools
  - samba-common-bin
  - samba
  - libpam-modules
  - libpam-sss
  - libnss-sss
Files
- /etc/realmd.conf
- /etc/sssd/sssd.conf
- /etc/krb5.conf
- /usr/share/pam-configs/realmd_mkhomedir (Debian Family)
Services
- sssd
Execs
- for username and password joins
  - the realm join command is run with supplied credentials
- for keytab joins
  - the kerberos config file (/etc/krb5.conf) will be placed on disk
  - the kinit command is run to obtain an initial TGT
  - the realm join command is run to join via keytab
- For Debian Family
  - triggers a pam-auth-update to activate the mkhomedir
- the SSSD config cache is forcibly removed on each config change to ensure cache is rebuilt

Setup Requirements

Keytabs
- this module does not manage keytabs -- the krb_keytab parameter is an absolute path to a keytab deployed in some way outside of this module

Beginning with realmd

Setup realmd and join an Active Directory domain via username and password:

class { 'realmd':
  domain               => 'example.com',
  domain_join_user     => 'user',
  domain_join_password => 'password',
}

Joining with a prepared computer account

Create the computer account by running adcli on any domain joined machine
- new computer account: adcli preset-computer --domain example.com
- or use an existing account: adcli reset-computer --domain example.com

Configure the realmd class

class { 'realmd':
  domain             => $facts['networking']['domain'],
  one_time_password  => 's3cure_pw', # optional, skip if you didn't specify it when running preset-computer
  #do not set domain_join_user
  #do not set krb_ticket_join
}

Errors when running

Error: adcli join ... returned 3 instead of one of [0] The account hasn't been prepared properly or the password is wrong

Usage

Setup Realmd, join an Active Directory domain via a keytab and fully configure SSSD:

class { 'realmd':
  domain             => $facts['networking']['domain'],
  domain_join_user   => 'user',
  krb_ticket_join    => true,
  krb_keytab         => '/tmp/keytab',
  manage_sssd_config => true,
  sssd_config        => {
    'sssd' => {
      'domains'             => $facts['networking']['domain'],
      'config_file_version' => '2',
      'services'            => 'nss,pam',
    },
    "domain/${facts['networking']['domain']}" => {
      'ad_domain'                      => $facts['networking']['domain'],
      'krb5_realm'                     => upcase($facts['networking']['domain']),
      'realmd_tags'                    => 'manages-system joined-with-adcli',
      'cache_credentials'              => 'True',
      'id_provider'                    => 'ad',
      'access_provider'                => 'ad',
      'krb5_store_password_if_offline' => 'True',
      'default_shell'                  => '/bin/bash',
      'ldap_id_mapping'                => 'True',
      'fallback_homedir'               => '/home/%u',
    },
  },
}

Acknowledgements

This module was forked from walkamongus-realmd and may not be compatible.

Reference

Classes

realmd: realmd
realmd::config: == Class realmd::config This class is called from realmd for service config.
realmd::install: == Class realmd::install This class is called from realmd for install.
realmd::join: == Class realmd::join This class is called from realmd for joining AD.
realmd::join::keytab: == Class realmd::join::keytab This class is called from realmd for performing a passwordless AD join with a Kerberos keytab
realmd::join::one_time_password: == Class realmd::join::password This class is called from realmd for joining AD using a username and password. The default password for Wind
realmd::join::password: == Class realmd::join::password This class is called from realmd for joining AD using a username and password.
realmd::sssd::config: == Class realmd::sssd::config This class is called from realmd for SSSD service configuration.
realmd::sssd::service: == Class realmd::sssd::service This class is meant to be called from realmd. It ensure the service is running.

Classes

`realmd`

Installs, configures, and joins a domain using realmd. Optionally control the Kerberos client and SSSD configuration files and the SSSD service.

Default values for all parameters are in hiera.

Parameters

The following parameters are available in the realmd class:

realmd_package_name
realmd_package_ensure
realmd_config_file
realmd_config
homedir_umask
adcli_package_name
adcli_package_ensure
krb_client_package_name
krb_client_package_ensure
sssd_package_name
sssd_package_ensure
sssd_service_name
sssd_service_ensure
sssd_config_file
sssd_config_cache_file
sssd_config
manage_sssd_config
manage_sssd_service
manage_sssd_package
domain
netbiosname
domain_join_user
domain_join_password
one_time_password
krb_ticket_join
krb_keytab
krb_config_file
krb_config
manage_krb_config
ou
required_packages
extra_join_options
computer_name

`realmd_package_name`

Data type: String

The name of the main Realmd package

`realmd_package_ensure`

Data type: String

`realmd_config_file`

Data type: Stdlib::Absolutepath

The absolute path of the Realmd configuration file

`realmd_config`

Data type: Hash

A hash of configuration options structured in an ini-style format

`homedir_umask`

Data type: String

A string of the umask for the default directory permissions created by mkhomedir with Debian

`adcli_package_name`

Data type: String

The name of the adcli package

`adcli_package_ensure`

Data type: String

`krb_client_package_name`

Data type: String

The name of the Kerberos client package

`krb_client_package_ensure`

Data type: String

`sssd_package_name`

Data type: String

The name of the main SSSD package

`sssd_package_ensure`

Data type: String

`sssd_service_name`

Data type: String

The name of the SSSD service

`sssd_service_ensure`

Data type: String

`sssd_config_file`

Data type: Stdlib::Absolutepath

The absolute path of the SSSD configuration file

`sssd_config_cache_file`

Data type: Stdlib::Absolutepath

`sssd_config`

Data type: Hash

A hash of configuration options structured in an ini-style format

`manage_sssd_config`

Data type: Boolean

Enable or disable management of the SSSD configuration file

`manage_sssd_service`

Data type: Boolean

Enable or disable management of the SSSD service

`manage_sssd_package`

Data type: Boolean

`domain`

Data type: String

The name of the domain to join

`netbiosname`

Data type: String

The computer name used with one-time-password (computer account) join

`domain_join_user`

Data type: Variant[String, Undef]

The account to be used in joining the domain

`domain_join_password`

Data type: Variant[String, Undef]

The password of the account to be used in joining the domain

`one_time_password`

Data type: Variant[String, Undef]

The password of the prepared computer account

`krb_ticket_join`

Data type: Boolean

Enable of disable joining the domain via a Kerberos keytab

`krb_keytab`

Data type: Variant[Stdlib::Absolutepath, Undef]

The absolute path to the Kerberos keytab file to be used in joining the domain

`krb_config_file`

Data type: Stdlib::Absolutepath

The absolute path to the Kerberos client configuration file

`krb_config`

Data type: Hash

A hash of configuration options structured in an ini-style format

`manage_krb_config`

Data type: Boolean

Enable or disable management of the Kerberos client configuration file

`ou`

Data type: Variant[String, Undef]

The computer organizational unit

`required_packages`

Data type: Hash

A hash of package resources to manage for any auxilliary functionality

`extra_join_options`

Data type: Variant[Array, Undef]

Extra arguments passed to realm join command

`computer_name`

Data type: Variant[String[1, 15], Undef, Boolean[false]]

The computer name used with password join

`realmd::config`

== Class realmd::config

This class is called from realmd for service config.

`realmd::install`

== Class realmd::install

This class is called from realmd for install.

`realmd::join`

== Class realmd::join

This class is called from realmd for joining AD.

`realmd::join::keytab`

== Class realmd::join::keytab

This class is called from realmd for performing a passwordless AD join with a Kerberos keytab

`realmd::join::one_time_password`

== Class realmd::join::password

This class is called from realmd for joining AD using a username and password. The default password for Windows ADS is "the first 15 chars of the hostname in lowercase"

`realmd::join::password`

== Class realmd::join::password

This class is called from realmd for joining AD using a username and password.

`realmd::sssd::config`

== Class realmd::sssd::config

This class is called from realmd for SSSD service configuration.

`realmd::sssd::service`

== Class realmd::sssd::service

This class is meant to be called from realmd. It ensure the service is running.

                              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.

Modules

Discover

Contribute

Resources

About Forge

Getting Started

realmd

Version information

This version is compatible with:

Start using this module

Documentation

Puppet Realmd

Table of Contents

Overview

Module Description

Setup

What realmd affects

Setup Requirements

Beginning with realmd

Joining with a prepared computer account

Errors when running

Usage

Setup Realmd, join an Active Directory domain via a keytab and fully configure SSSD:

Acknowledgements

Reference

Table of Contents

Classes

Classes

realmd

Parameters

realmd_package_name

realmd_package_ensure

realmd_config_file

realmd_config

homedir_umask

adcli_package_name

adcli_package_ensure

krb_client_package_name

krb_client_package_ensure

sssd_package_name

sssd_package_ensure

sssd_service_name

sssd_service_ensure

sssd_config_file

sssd_config_cache_file

sssd_config

manage_sssd_config

manage_sssd_service

manage_sssd_package

domain

netbiosname

domain_join_user

domain_join_password

one_time_password

krb_ticket_join

krb_keytab

krb_config_file

krb_config

manage_krb_config

ou

required_packages

extra_join_options

computer_name

realmd::config

realmd::install

realmd::join

realmd::join::keytab

realmd::join::one_time_password

realmd::join::password

realmd::sssd::config

realmd::sssd::service

Dependencies

`realmd`

`realmd_package_name`

`realmd_package_ensure`

`realmd_config_file`

`realmd_config`

`homedir_umask`

`adcli_package_name`

`adcli_package_ensure`

`krb_client_package_name`

`krb_client_package_ensure`

`sssd_package_name`

`sssd_package_ensure`

`sssd_service_name`

`sssd_service_ensure`

`sssd_config_file`

`sssd_config_cache_file`

`sssd_config`

`manage_sssd_config`

`manage_sssd_service`

`manage_sssd_package`

`domain`

`netbiosname`

`domain_join_user`

`domain_join_password`

`one_time_password`

`krb_ticket_join`

`krb_keytab`

`krb_config_file`

`krb_config`

`manage_krb_config`

`ou`

`required_packages`

`extra_join_options`

`computer_name`

`realmd::config`

`realmd::install`

`realmd::join`

`realmd::join::keytab`

`realmd::join::one_time_password`

`realmd::join::password`

`realmd::sssd::config`

`realmd::sssd::service`