mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-06-10 10:45:55 +00:00
7c378d9c4d
The naming in the ipaclient role has not been following the naming scheme and conventions used in the ipaserver and ipareplica roles. Also registered results of modules and commands have not been unsing the result_ prefix as in the other roles. All this has been fixed and the naming is consistent now. These are the renames: ipahost -> ipaclient_get_otp ipaapi -> ipaclient_api ipaextras -> ipaclient_extras ipafixca -> ipaclient_fix_ca ipafstore -> ipaclient_fstore ipa_facts -> ipaclient_get_facts ipahost -> ipaclient_get_otp ipajoin -> ipaclient_join ipanss -> ipaclient_setup_nss ipasssd -> ipaclient_setup_sssd ipadiscovery -> ipaclient_test ipatest -> ipaclient_test_keytab
315 lines
11 KiB
Python
315 lines
11 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Authors:
|
|
# Thomas Woerner <twoerner@redhat.com>
|
|
#
|
|
# Based on ipa-client-install code
|
|
#
|
|
# Copyright (C) 2017 Red Hat
|
|
# see file 'COPYING' for use and warranty information
|
|
#
|
|
# 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/>.
|
|
|
|
ANSIBLE_METADATA = {
|
|
'metadata_version': '1.0',
|
|
'supported_by': 'community',
|
|
'status': ['preview'],
|
|
}
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: ipaclient_join
|
|
short description: Join a machine to an IPA realm and get a keytab for the host service principal
|
|
description:
|
|
Join a machine to an IPA realm and get a keytab for the host service principal
|
|
options:
|
|
servers:
|
|
description: The FQDN of the IPA servers to connect to.
|
|
required: true
|
|
type: list
|
|
domain:
|
|
description: The primary DNS domain of an existing IPA deployment.
|
|
required: true
|
|
realm:
|
|
description: The Kerberos realm of an existing IPA deployment.
|
|
required: true
|
|
hostname:
|
|
description: The hostname of the machine to join (FQDN).
|
|
required: true
|
|
kdc:
|
|
description: The name or address of the host running the KDC.
|
|
required: true
|
|
basedn:
|
|
description: The basedn of the IPA server (of the form dc=example,dc=com).
|
|
required: true
|
|
principal:
|
|
description: The authorized kerberos principal used to join the IPA realm.
|
|
required: false
|
|
password:
|
|
description: The password to use if not using Kerberos to authenticate.
|
|
required: false
|
|
keytab:
|
|
description: The path to a backed-up host keytab from previous enrollment.
|
|
required: false
|
|
ca_cert_file:
|
|
description: A CA certificate to use. Do not acquire the IPA CA certificate via automated means.
|
|
required: false
|
|
force_join:
|
|
description: Force enrolling the host even if host entry exists.
|
|
required: false
|
|
type: bool
|
|
default: no
|
|
kinit_attempts:
|
|
description: Repeat the request for host Kerberos ticket X times.
|
|
required: false
|
|
type: int
|
|
default: 5
|
|
debug:
|
|
description: Enable debug mode.
|
|
required: false
|
|
type: bool
|
|
default: no
|
|
author:
|
|
- Thomas Woerner
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Join IPA to get the keytab
|
|
- name: Join IPA in force mode with maximum 5 kinit attempts
|
|
ipaclient_join:
|
|
servers: ["server1.example.com","server2.example.com"]
|
|
domain: example.com
|
|
realm: EXAMPLE.COM
|
|
kdc: server1.example.com
|
|
basedn: dc=example,dc=com
|
|
hostname: client1.example.com
|
|
principal: admin
|
|
password: MySecretPassword
|
|
force_join: yes
|
|
kinit_attempts: 5
|
|
|
|
# Join IPA to get the keytab using ipadiscovery return values
|
|
- name: Join IPA
|
|
ipaclient_join:
|
|
servers: "{{ ipadiscovery.servers }}"
|
|
domain: "{{ ipadiscovery.domain }}"
|
|
realm: "{{ ipadiscovery.realm }}"
|
|
kdc: "{{ ipadiscovery.kdc }}"
|
|
basedn: "{{ ipadiscovery.basedn }}"
|
|
hostname: "{{ ipadiscovery.hostname }}"
|
|
principal: admin
|
|
password: MySecretPassword
|
|
'''
|
|
|
|
RETURN = '''
|
|
already_joined:
|
|
description: The flag describes if the host is arelady joined.
|
|
returned: always
|
|
type: bool
|
|
'''
|
|
|
|
import os
|
|
import tempfile
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.ansible_ipa_client import *
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec = dict(
|
|
servers=dict(required=True, type='list'),
|
|
domain=dict(required=True),
|
|
realm=dict(required=True),
|
|
hostname=dict(required=True),
|
|
kdc=dict(required=True),
|
|
basedn=dict(required=True),
|
|
principal=dict(required=False),
|
|
password=dict(required=False, no_log=True),
|
|
keytab=dict(required=False),
|
|
ca_cert_file=dict(required=False),
|
|
force_join=dict(required=False, type='bool'),
|
|
kinit_attempts=dict(required=False, type='int', default=5),
|
|
debug=dict(required=False, type='bool'),
|
|
),
|
|
supports_check_mode = True,
|
|
)
|
|
|
|
module._ansible_debug = True
|
|
servers = module.params.get('servers')
|
|
domain = module.params.get('domain')
|
|
realm = module.params.get('realm')
|
|
hostname = module.params.get('hostname')
|
|
basedn = module.params.get('basedn')
|
|
kdc = module.params.get('kdc')
|
|
force_join = module.params.get('force_join')
|
|
principal = module.params.get('principal')
|
|
password = module.params.get('password')
|
|
keytab = module.params.get('keytab')
|
|
ca_cert_file = module.params.get('ca_cert_file')
|
|
kinit_attempts = module.params.get('kinit_attempts')
|
|
debug = module.params.get('debug')
|
|
|
|
if password is not None and password != "" and \
|
|
keytab is not None and keytab != "":
|
|
module.fail_json(msg="Password and keytab cannot be used together")
|
|
|
|
client_domain = hostname[hostname.find(".")+1:]
|
|
nolog = tuple()
|
|
env = {'PATH': SECURE_PATH}
|
|
fstore = sysrestore.FileStore(paths.IPA_CLIENT_SYSRESTORE)
|
|
host_principal = 'host/%s@%s' % (hostname, realm)
|
|
sssd = True
|
|
|
|
options.ca_cert_file = ca_cert_file
|
|
options.unattended = True
|
|
options.principal = principal if principal != "" else None
|
|
options.force = False
|
|
options.password = password
|
|
|
|
ccache_dir = None
|
|
changed = False
|
|
already_joined = False
|
|
try:
|
|
(krb_fd, krb_name) = tempfile.mkstemp()
|
|
os.close(krb_fd)
|
|
configure_krb5_conf(
|
|
cli_realm=realm,
|
|
cli_domain=domain,
|
|
cli_server=servers,
|
|
cli_kdc=kdc,
|
|
dnsok=False,
|
|
filename=krb_name,
|
|
client_domain=client_domain,
|
|
client_hostname=hostname,
|
|
configure_sssd=sssd,
|
|
force=False)
|
|
env['KRB5_CONFIG'] = krb_name
|
|
ccache_dir = tempfile.mkdtemp(prefix='krbcc')
|
|
ccache_name = os.path.join(ccache_dir, 'ccache')
|
|
join_args = [paths.SBIN_IPA_JOIN,
|
|
"-s", servers[0],
|
|
"-b", str(realm_to_suffix(realm)),
|
|
"-h", hostname]
|
|
if debug:
|
|
join_args.append("-d")
|
|
env['XMLRPC_TRACE_CURL'] = 'yes'
|
|
if force_join:
|
|
join_args.append("-f")
|
|
if principal:
|
|
if principal.find('@') == -1:
|
|
principal = '%s@%s' % (principal, realm)
|
|
try:
|
|
kinit_password(principal, password, ccache_name,
|
|
config=krb_name)
|
|
except RuntimeError as e:
|
|
module.fail_json(
|
|
msg="Kerberos authentication failed: {}".format(e))
|
|
elif keytab:
|
|
join_args.append("-f")
|
|
if os.path.exists(keytab):
|
|
try:
|
|
kinit_keytab(host_principal,
|
|
keytab,
|
|
ccache_name,
|
|
config=krb_name,
|
|
attempts=kinit_attempts)
|
|
except GSSError as e:
|
|
module.fail_json(
|
|
msg="Kerberos authentication failed: {}".format(e))
|
|
else:
|
|
module.fail_json(
|
|
msg="Keytab file could not be found: {}".format(keytab))
|
|
|
|
elif password:
|
|
join_args.append("-w")
|
|
join_args.append(password)
|
|
nolog = (password,)
|
|
|
|
env['KRB5CCNAME'] = os.environ['KRB5CCNAME'] = ccache_name
|
|
# Get the CA certificate
|
|
try:
|
|
os.environ['KRB5_CONFIG'] = env['KRB5_CONFIG']
|
|
if NUM_VERSION < 40100:
|
|
get_ca_cert(fstore, options, servers[0], basedn)
|
|
else:
|
|
get_ca_certs(fstore, options, servers[0], basedn, realm)
|
|
del os.environ['KRB5_CONFIG']
|
|
except errors.FileError as e:
|
|
module.fail_json(msg='%s' % e)
|
|
except Exception as e:
|
|
module.fail_json(msg="Cannot obtain CA certificate\n%s" % e)
|
|
|
|
# Now join the domain
|
|
result = run(
|
|
join_args, raiseonerr=False, env=env, nolog=nolog,
|
|
capture_error=True)
|
|
stderr = result.error_output
|
|
|
|
if result.returncode != 0:
|
|
if result.returncode == 13:
|
|
already_joined = True
|
|
module.log("Host is already joined")
|
|
else:
|
|
if principal:
|
|
run([paths.KDESTROY], raiseonerr=False, env=env)
|
|
module.fail_json(msg="Joining realm failed: %s" % stderr)
|
|
else:
|
|
changed = True
|
|
module.log("Enrolled in IPA realm %s" % realm)
|
|
|
|
# Fail for missing krb5.keytab on already joined host
|
|
if already_joined and not os.path.exists(paths.KRB5_KEYTAB):
|
|
module.fail_json(msg="krb5.keytab missing! Retry with ipaclient_force_join=yes to generate a new one.")
|
|
|
|
if principal:
|
|
run([paths.KDESTROY], raiseonerr=False, env=env)
|
|
|
|
# Obtain the TGT. We do it with the temporary krb5.conf, sot
|
|
# tha only the KDC we're installing under is contacted.
|
|
# Other KDCs might not have replicated the principal yet.
|
|
# Once we have the TGT, it's usable on any server.
|
|
try:
|
|
kinit_keytab(host_principal, paths.KRB5_KEYTAB,
|
|
paths.IPA_DNS_CCACHE,
|
|
config=krb_name,
|
|
attempts=kinit_attempts)
|
|
env['KRB5CCNAME'] = os.environ['KRB5CCNAME'] = paths.IPA_DNS_CCACHE
|
|
except GSSError as e:
|
|
# failure to get ticket makes it impossible to login and
|
|
# bind from sssd to LDAP, abort installation
|
|
module.fail_json(msg="Failed to obtain host TGT: %s" % e)
|
|
|
|
finally:
|
|
try:
|
|
os.remove(krb_name)
|
|
except OSError:
|
|
module.fail_json(msg="Could not remove %s" % krb_name)
|
|
if ccache_dir is not None:
|
|
try:
|
|
os.rmdir(ccache_dir)
|
|
except OSError:
|
|
pass
|
|
if os.path.exists(krb_name + ".ipabkp"):
|
|
try:
|
|
os.remove(krb_name + ".ipabkp")
|
|
except OSError:
|
|
module.fail_json(msg="Could not remove %s.ipabkp" % krb_name)
|
|
|
|
module.exit_json(changed=changed,
|
|
already_joined=already_joined)
|
|
|
|
if __name__ == '__main__':
|
|
main()
|