Blame roles/ipaclient/library/ipaclient_setup_krb5.py

Packit Service ee01e6
#!/usr/bin/python
Packit Service 0a38ef
# -*- coding: utf-8 -*-
Packit Service 0a38ef
Packit Service 0a38ef
# Authors:
Packit Service 0a38ef
#   Thomas Woerner <twoerner@redhat.com>
Packit Service 0a38ef
#
Packit Service 0a38ef
# Based on ipa-client-install code
Packit Service 0a38ef
#
Packit Service 0a38ef
# Copyright (C) 2018  Red Hat
Packit Service 0a38ef
# see file 'COPYING' for use and warranty information
Packit Service 0a38ef
#
Packit Service 0a38ef
# This program is free software; you can redistribute it and/or modify
Packit Service 0a38ef
# it under the terms of the GNU General Public License as published by
Packit Service 0a38ef
# the Free Software Foundation, either version 3 of the License, or
Packit Service 0a38ef
# (at your option) any later version.
Packit Service 0a38ef
#
Packit Service 0a38ef
# This program is distributed in the hope that it will be useful,
Packit Service 0a38ef
# but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 0a38ef
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service 0a38ef
# GNU General Public License for more details.
Packit Service 0a38ef
#
Packit Service 0a38ef
# You should have received a copy of the GNU General Public License
Packit Service 0a38ef
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
Packit Service 0a38ef
Packit Service 0a38ef
ANSIBLE_METADATA = {
Packit Service 0a38ef
    'metadata_version': '1.0',
Packit Service 0a38ef
    'supported_by': 'community',
Packit Service 0a38ef
    'status': ['preview'],
Packit Service 0a38ef
}
Packit Service 0a38ef
Packit Service 0a38ef
DOCUMENTATION = '''
Packit Service 0a38ef
---
Packit Service 0a38ef
module: ipaclient_setup_krb5
Packit Service 0a38ef
short description: Setup krb5 for IPA client
Packit Service 0a38ef
description:
Packit Service 0a38ef
  Setup krb5 for IPA client
Packit Service 0a38ef
options:
Packit Service 0a38ef
  domain:
Packit Service 0a38ef
    description: Primary DNS domain of the IPA deployment
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  servers:
Packit Service 0a38ef
    description: Fully qualified name of IPA servers to enroll to
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  realm:
Packit Service 0a38ef
    description: Kerberos realm name of the IPA deployment
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  hostname:
Packit Service 0a38ef
    description: Fully qualified name of this host
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  kdc:
Packit Service 0a38ef
    description: The name or address of the host running the KDC
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  dnsok:
Packit Service 0a38ef
    description: The installer dnsok setting
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  client_domain:
Packit Service 0a38ef
    description: Primary DNS domain of the IPA deployment
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  sssd:
Packit Service 0a38ef
    description: The installer sssd setting
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
  force:
Packit Service 0a38ef
    description: Installer force parameter
Packit Service 0a38ef
    required: yes
Packit Service 0a38ef
author:
Packit Service 0a38ef
    - Thomas Woerner
Packit Service 0a38ef
'''
Packit Service 0a38ef
Packit Service 0a38ef
EXAMPLES = '''
Packit Service 0a38ef
# Backup and set hostname
Packit Service 0a38ef
- name: Backup and set hostname
Packit Service 0a38ef
  ipaclient_setup_krb5:
Packit Service 0a38ef
    server:
Packit Service 0a38ef
    domain:
Packit Service 0a38ef
    realm:
Packit Service 0a38ef
    hostname: client1.example.com
Packit Service 0a38ef
'''
Packit Service 0a38ef
Packit Service 0a38ef
RETURN = '''
Packit Service 0a38ef
'''
Packit Service 0a38ef
Packit Service 0a38ef
from ansible.module_utils.basic import AnsibleModule
Packit Service 0a38ef
from ansible.module_utils.ansible_ipa_client import (
Packit Service 0a38ef
    setup_logging, sysrestore, paths, configure_krb5_conf, logger
Packit Service 0a38ef
)
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
def main():
Packit Service 0a38ef
    module = AnsibleModule(
Packit Service 0a38ef
        argument_spec=dict(
Packit Service 0a38ef
            domain=dict(required=False, default=None),
Packit Service 0a38ef
            servers=dict(required=False, type='list', default=None),
Packit Service 0a38ef
            realm=dict(required=False, default=None),
Packit Service 0a38ef
            hostname=dict(required=False, default=None),
Packit Service 0a38ef
            kdc=dict(required=False, default=None),
Packit Service 0a38ef
            dnsok=dict(required=False, type='bool', default=False),
Packit Service 0a38ef
            client_domain=dict(required=False, default=None),
Packit Service 0a38ef
            sssd=dict(required=False, type='bool', default=False),
Packit Service 0a38ef
            force=dict(required=False, type='bool', default=False),
Packit Service 0a38ef
            # on_master=dict(required=False, type='bool', default=False),
Packit Service 0a38ef
        ),
Packit Service 0a38ef
        supports_check_mode=True,
Packit Service 0a38ef
    )
Packit Service 0a38ef
Packit Service 0a38ef
    module._ansible_debug = True
Packit Service 0a38ef
    setup_logging()
Packit Service 0a38ef
Packit Service 0a38ef
    servers = module.params.get('servers')
Packit Service 0a38ef
    domain = module.params.get('domain')
Packit Service 0a38ef
    realm = module.params.get('realm')
Packit Service 0a38ef
    hostname = module.params.get('hostname')
Packit Service 0a38ef
    kdc = module.params.get('kdc')
Packit Service 0a38ef
    dnsok = module.params.get('dnsok')
Packit Service 0a38ef
    client_domain = module.params.get('client_domain')
Packit Service 0a38ef
    sssd = module.params.get('sssd')
Packit Service 0a38ef
    force = module.params.get('force')
Packit Service 0a38ef
    # on_master = module.params.get('on_master')
Packit Service 0a38ef
Packit Service 0a38ef
    fstore = sysrestore.FileStore(paths.IPA_CLIENT_SYSRESTORE)
Packit Service 0a38ef
Packit Service 0a38ef
    # if options.on_master:
Packit Service 0a38ef
    #     # If on master assume kerberos is already configured properly.
Packit Service 0a38ef
    #     # Get the host TGT.
Packit Service 0a38ef
    #     try:
Packit Service 0a38ef
    #         kinit_keytab(host_principal, paths.KRB5_KEYTAB, CCACHE_FILE,
Packit Service 0a38ef
    #                      attempts=options.kinit_attempts)
Packit Service 0a38ef
    #         os.environ['KRB5CCNAME'] = CCACHE_FILE
Packit Service 0a38ef
    #     except gssapi.exceptions.GSSError as e:
Packit Service 0a38ef
    #         logger.error("Failed to obtain host TGT: %s", e)
Packit Service 0a38ef
    #         raise ScriptError(rval=CLIENT_INSTALL_ERROR)
Packit Service 0a38ef
    # else:
Packit Service 0a38ef
Packit Service 0a38ef
    # Configure krb5.conf
Packit Service 0a38ef
    fstore.backup_file(paths.KRB5_CONF)
Packit Service 0a38ef
    configure_krb5_conf(
Packit Service 0a38ef
        cli_realm=realm,
Packit Service 0a38ef
        cli_domain=domain,
Packit Service 0a38ef
        cli_server=servers,
Packit Service 0a38ef
        cli_kdc=kdc,
Packit Service 0a38ef
        dnsok=dnsok,
Packit Service 0a38ef
        filename=paths.KRB5_CONF,
Packit Service 0a38ef
        client_domain=client_domain,
Packit Service 0a38ef
        client_hostname=hostname,
Packit Service 0a38ef
        configure_sssd=sssd,
Packit Service 0a38ef
        force=force)
Packit Service 0a38ef
Packit Service 0a38ef
    logger.info(
Packit Service 0a38ef
        "Configured /etc/krb5.conf for IPA realm %s", realm)
Packit Service 0a38ef
Packit Service 0a38ef
    module.exit_json(changed=True)
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
if __name__ == '__main__':
Packit Service 0a38ef
    main()