Forge Home

ipa

Manages IPA servers and clients.

1,658 downloads

972 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.2.1 (latest)
  • 0.2.0
  • 0.1.1
  • 0.1.0
released Jan 21st 2021
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 <= 7.0.0
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'encore-ipa', '0.2.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add encore-ipa
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install encore-ipa --version 0.2.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

encore/ipa — version 0.2.1 Jan 21st 2021

ipa Puppet module

Build Status

Overview

This module will install and configure IPA servers, replicas, and clients. This module was forked from huit-ipa, and refactored with a focus on simplicity and ease of use. It has been further refactored to support Red Hat installations only.

The following features work great:

  • Creating a domain.
  • Adding IPA server replicas.
  • Autofs configuration.
  • Trust-ad join.
  • Joining clients.
  • Firewalld management.

The following features were stripped out and are currently unavailable:

  • Sudo rule management.
  • Host management (beyond simple clinet domain joins).
  • Host joins via one time passwords.
  • Dns zone management (beyond creating an initial zone).
  • Admin configuration
  • Web configuration

Dependencies

This module requires:

Usage

Example usage:

Creating an IPA master, with ad-trust to corp.domain.com.

  class { '::ipa':
    ad_domain            => 'corp.domain.com',
    ad_groups            => ['linux_admins','linux_users'],
    ad_trust_admin       => 'ad_admin@domain.com',
    ad_trust_password    => 'ad_admin_password',
    ad_trust_realm       => 'corp.domain.com',
    admin_password       => 'ChangeM3!',
    automount_home_dir   => "/home/ipa/${ad_domain}",
    automount_home_share => 'nfs01.corp.domain.com:/srv/nfs/homes/&',
    domain               => 'ipa.corp.domain.com',
    ds_password          => 'ChangeM3!',
    install_ipa_client   => false,
    ipa_master_fqdn      => $facts['fqdn'],
    ipa_role             => 'master',
    sssd_debug_level     => '3',
  }

Adding a replica:

  class { '::ipa':
    admin_password       => 'ChangeM3!',
    automount_home_dir   => '/home/ipa/corp.domain.com',
    configure_replica_ca => true,
    domain               => 'ipa.corp.domain.com',
    domain_join_password => 'ChangeM3!',
    ipa_master_fqdn      => 'ipa01.corp.domain.com',
    ipa_role             => 'replica',
    sssd_debug_level     => '3',
  }

Adding a client:

  class { '::ipa':
    automount_home_dir   => '/home/ipa/corp.domain.com',
    domain               => 'ipa.corp.domain.com',
    domain_join_password => 'ChangeM3!',
    ipa_master_fqdn      => 'ipa01.corp.domain.com',
    ipa_role             => 'client',
  }

Mandatory Parameters

domain

Mandatory. The name of the IPA domain to create or join.

ipa_role

Mandatory. What role the node will be. Options are 'master', 'replica', and 'client'.

admin_password

Mandatory if ipa_role is set as 'Master' or 'Replica'. Password which will be assigned to the IPA account named 'admin'.

ds_password

Mandatory if ipa_role is set as 'Master'. Password which will be passed into the ipa setup's parameter named "--ds-password".

Optional Parameters

configure_dns_server

If true, then the parameter '--setup-dns' is passed to the IPA server installer. Also, triggers the install of the required dns server packages.

configure_replica_ca

If true, then the parameter '--setup-ca' is passed to the IPA replica installer.

configure_ntp

If false, then the parameter '--no-ntp' is passed to the IPA server installer.

custom_dns_forwarders

Each element in this array is prefixed with '--forwarder ' and passed to the IPA server installer.

domain_join_principal

The principal (usually username) used to join a client or replica to the IPA domain.

domain_join_password

The password for the domain_join_principal.

enable_hostname

If true, then the parameter '--hostname' is populated with the parameter 'ipa_server_fqdn' and passed to the IPA installer.

enable_ip_address

If true, then the parameter '--ip-address' is populated with the parameter 'ip_address' and passed to the IPA installer.

fixed_primary

If true, then the parameter '--fixed-primary' is passed to the IPA installer.

idstart

From the IPA man pages: "The starting user and group id number".

install_autofs

If true, then the autofs packages are installed.

install_epel

If true, then the epel repo is installed. The epel repo is usually required for sssd packages.

install_kstart

If true, then the kstart packages are installed.

install_sssdtools

If true, then the sssdtools packages are installed.

install_ipa_client

If true, then the IPA client packages are installed if the parameter 'ipa_role' is set to 'client'.

install_ipa_server

If true, then the IPA server packages are installed if the parameter 'ipa_role' is not set to 'client'.

install_sssd

If true, then the sssd packages are installed.

ipa_master_fqdn

FQDN of the server to use for a client or replica domain join.

manage_host_entry

If true, then a host entry is created using the parameters 'ipa_server_fqdn' and 'ip_address'.

mkhomedir

If true, then the parameter '--mkhomedir' is passed to the IPA client installer.

no_ui_redirect

If true, then the parameter '--no-ui-redirect' is passed to the IPA server installer.

realm

The name of the IPA realm to create or join (UPPERCASE).

Cipher hardening on CentOS/RHEL 8

NOTE: These settings are automatically applied inside of ipa::params, they are documented here as a reference.

    # IPA on RHEL/CentOS 8 switched to mod_ssl, away from mod_nss
    # mod_ssl in RHEL/CentOS 8 uses the "system" cryto policy for its ciphers and protocols
    # see:
    # https://www.redhat.com/en/blog/how-customize-crypto-policies-rhel-82
    # https://access.redhat.com/articles/3642912
    # https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/security_hardening/using-the-system-wide-cryptographic-policies_security-hardening
    $nss_ssl_ciphers = []
    $nss_ssl_protocols = []
    
    $ds_ssl_ciphers = [
      # TLS 1.2
      '+TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256',
      '+TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384',
      '+TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256',
      '+TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384',
      # TLS 1.3
      '+TLS_AES_128_GCM_SHA256',
      '+TLS_AES_256_GCM_SHA384',
      '+TLS_CHACHA20_POLY1305_SHA256',
    ]
    $ds_ssl_min_version = 'TLS1.2'
    
    # Dogtag PKI Tomcat
    # you _must_ set both the TLS 1.2 and 1.3 ciphers here though, otherwise you'll get an error
    # when registering your clients:
    # Joining realm failed: HTTP POST to URL 'https://freeipa.maludy.home:443/ipa/xml' failed.  libcurl failed even to execute the HTTP transaction, explaining:  SSL certificate problem: EE certificate key too weak
    $pki_ssl_ciphers = [
      # TLS 1.2
      '+TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256',
      '+TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384',
      '+TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256',
      '+TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384',
      # TLS 1.3
      '+TLS_AES_128_GCM_SHA256',
      '+TLS_AES_256_GCM_SHA384',
      '+TLS_CHACHA20_POLY1305_SHA256',
    ]
    # PKI Tomcat doesn't, yet, support tls1_3 protocol, so leave it to 1.2
    # if you try to set it to tls1_2:tls1_3 pki-tomcatd@pki-tomcat.service service will fail to start
    $pki_ssl_protocol_range = 'tls1_2:tls1_2'
    
    class { 'ipa':
     ipa_role => 'master',
     # nss ciphers and protocols not used in CentOS 8
     nss_ssl_ciphers        => $nss_ssl_ciphers,
     nss_ssl_protocols      => $nss_ssl_protocols,
     ds_ssl_ciphers         => $ds_ssl_ciphers,
     ds_ssl_min_version     => $ds_ssl_min_version,
     pki_ssl_ciphers        => $pki_ssl_ciphers,
     pki_ssl_protocol_range => $pki_ssl_protocol_range,
   }

Limitations

This module has only been tested on RHEL 7.

Testing

A vagrantfile is provided for easy testing.

Steps to get started:

  1. Install vagrant.
  2. Install virtualbox.
  3. Clone this repo.
  4. Run vagrant up in a terminal window from the root of the repo.
  5. Open a browser and navigate to https://localhost:8440. Log in with username admin and password vagrant123.

License

jpuskar/puppet-easy_ipa forked from: huit/puppet-ipa - Puppet module that can manage an IPA master, replicas and clients.

Copyright (C) 2013 Harvard University Information Technology

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.