|
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) 2017 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 = {'metadata_version': '1.0',
|
|
Packit Service |
0a38ef |
'status': ['preview'],
|
|
Packit Service |
0a38ef |
'supported_by': 'community'}
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
DOCUMENTATION = '''
|
|
Packit Service |
0a38ef |
---
|
|
Packit Service |
0a38ef |
module: ipaclient_api
|
|
Packit Service |
0a38ef |
short description:
|
|
Packit Service |
0a38ef |
Create temporary NSS database, call IPA API for remaining enrollment parts
|
|
Packit Service |
0a38ef |
description:
|
|
Packit Service |
0a38ef |
Create temporary NSS database, call IPA API for remaining enrollment parts
|
|
Packit Service |
0a38ef |
options:
|
|
Packit Service |
0a38ef |
servers:
|
|
Packit Service |
0a38ef |
description: Fully qualified name of IPA servers to enroll to
|
|
Packit Service |
0a38ef |
required: no
|
|
Packit Service |
0a38ef |
realm:
|
|
Packit Service |
0a38ef |
description: Kerberos realm name of the IPA deployment
|
|
Packit Service |
0a38ef |
required: no
|
|
Packit Service |
0a38ef |
hostname:
|
|
Packit Service |
0a38ef |
description: Fully qualified name of this host
|
|
Packit Service |
0a38ef |
required: no
|
|
Packit Service |
0a38ef |
debug:
|
|
Packit Service |
0a38ef |
description: Turn on extra debugging
|
|
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 |
- name: IPA API calls for remaining enrollment parts
|
|
Packit Service |
0a38ef |
ipaclient_api:
|
|
Packit Service |
0a38ef |
servers: ["server1.example.com","server2.example.com"]
|
|
Packit Service |
0a38ef |
domain: example.com
|
|
Packit Service |
0a38ef |
hostname: client1.example.com
|
|
Packit Service |
0a38ef |
register: result_ipaclient_api
|
|
Packit Service |
0a38ef |
'''
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
RETURN = '''
|
|
Packit Service |
0a38ef |
ca_enabled:
|
|
Packit Service |
0a38ef |
description: Wheter the Certificate Authority is enabled or not.
|
|
Packit Service |
0a38ef |
returned: always
|
|
Packit Service |
0a38ef |
type: bool
|
|
Packit Service |
0a38ef |
subject_base:
|
|
Packit Service |
0a38ef |
description: The subject base, needed for certmonger
|
|
Packit Service |
0a38ef |
returned: always
|
|
Packit Service |
0a38ef |
type: string
|
|
Packit Service |
0a38ef |
sample: O=EXAMPLE.COM
|
|
Packit Service |
0a38ef |
'''
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
import os
|
|
Packit Service |
0a38ef |
import inspect
|
|
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,
|
|
Packit Service |
0a38ef |
paths, x509, NUM_VERSION, serialization, certdb, api,
|
|
Packit Service |
0a38ef |
delete_persistent_client_session_data, write_tmp_file,
|
|
Packit Service |
0a38ef |
ipa_generate_password, CalledProcessError, errors, disable_ra, DN,
|
|
Packit Service |
0a38ef |
CLIENT_INSTALL_ERROR, 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 |
servers=dict(required=True, type='list'),
|
|
Packit Service |
0a38ef |
realm=dict(required=True),
|
|
Packit Service |
0a38ef |
hostname=dict(required=True),
|
|
Packit Service |
0a38ef |
debug=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 |
realm = module.params.get('realm')
|
|
Packit Service |
0a38ef |
hostname = module.params.get('hostname')
|
|
Packit Service |
0a38ef |
debug = module.params.get('debug')
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
host_principal = 'host/%s@%s' % (hostname, realm)
|
|
Packit Service |
0a38ef |
os.environ['KRB5CCNAME'] = paths.IPA_DNS_CCACHE
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
ca_certs = x509.load_certificate_list_from_file(paths.IPA_CA_CRT)
|
|
Packit Service |
0a38ef |
if 40500 <= NUM_VERSION < 40590:
|
|
Packit Service |
0a38ef |
ca_certs = [cert.public_bytes(serialization.Encoding.DER)
|
|
Packit Service |
0a38ef |
for cert in ca_certs]
|
|
Packit Service |
0a38ef |
elif NUM_VERSION < 40500:
|
|
Packit Service |
0a38ef |
ca_certs = [cert.der_data for cert in ca_certs]
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
with certdb.NSSDatabase() as tmp_db:
|
|
Packit Service |
0a38ef |
api.bootstrap(context='cli_installer',
|
|
Packit Service |
0a38ef |
confdir=paths.ETC_IPA,
|
|
Packit Service |
0a38ef |
debug=debug,
|
|
Packit Service |
0a38ef |
delegate=False,
|
|
Packit Service |
0a38ef |
nss_dir=tmp_db.secdir)
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
if 'config_loaded' not in api.env:
|
|
Packit Service |
0a38ef |
module.fail_json(msg="Failed to initialize IPA API.")
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
# Clear out any current session keyring information
|
|
Packit Service |
0a38ef |
try:
|
|
Packit Service |
0a38ef |
delete_persistent_client_session_data(host_principal)
|
|
Packit Service |
0a38ef |
except ValueError:
|
|
Packit Service |
0a38ef |
pass
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
# Add CA certs to a temporary NSS database
|
|
Packit Service |
0a38ef |
try:
|
|
Packit Service |
0a38ef |
argspec = inspect.getargspec(tmp_db.create_db)
|
|
Packit Service |
0a38ef |
if "password_filename" not in argspec.args:
|
|
Packit Service |
0a38ef |
tmp_db.create_db()
|
|
Packit Service |
0a38ef |
else:
|
|
Packit Service |
0a38ef |
pwd_file = write_tmp_file(ipa_generate_password())
|
|
Packit Service |
0a38ef |
tmp_db.create_db(pwd_file.name)
|
|
Packit Service |
0a38ef |
for i, cert in enumerate(ca_certs):
|
|
Packit Service |
0a38ef |
if hasattr(certdb, "EXTERNAL_CA_TRUST_FLAGS"):
|
|
Packit Service |
0a38ef |
tmp_db.add_cert(cert,
|
|
Packit Service |
0a38ef |
'CA certificate %d' % (i + 1),
|
|
Packit Service |
0a38ef |
certdb.EXTERNAL_CA_TRUST_FLAGS)
|
|
Packit Service |
0a38ef |
else:
|
|
Packit Service |
0a38ef |
tmp_db.add_cert(cert, 'CA certificate %d' % (i + 1),
|
|
Packit Service |
0a38ef |
'C,,')
|
|
Packit Service |
0a38ef |
except CalledProcessError:
|
|
Packit Service |
0a38ef |
module.fail_json(msg="Failed to add CA to temporary NSS database.")
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
api.finalize()
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
# Now, let's try to connect to the server's RPC interface
|
|
Packit Service |
0a38ef |
connected = False
|
|
Packit Service |
0a38ef |
try:
|
|
Packit Service |
0a38ef |
api.Backend.rpcclient.connect()
|
|
Packit Service |
0a38ef |
connected = True
|
|
Packit Service |
0a38ef |
module.debug("Try RPC connection")
|
|
Packit Service |
0a38ef |
api.Backend.rpcclient.forward('ping')
|
|
Packit Service |
0a38ef |
except errors.KerberosError as e:
|
|
Packit Service |
0a38ef |
if connected:
|
|
Packit Service |
0a38ef |
api.Backend.rpcclient.disconnect()
|
|
Packit Service |
0a38ef |
module.log(
|
|
Packit Service |
0a38ef |
"Cannot connect to the server due to Kerberos error: %s. "
|
|
Packit Service |
0a38ef |
"Trying with delegate=True" % e)
|
|
Packit Service |
0a38ef |
try:
|
|
Packit Service |
0a38ef |
api.Backend.rpcclient.connect(delegate=True)
|
|
Packit Service |
0a38ef |
module.debug("Try RPC connection")
|
|
Packit Service |
0a38ef |
api.Backend.rpcclient.forward('ping')
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
module.log("Connection with delegate=True successful")
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
# The remote server is not capable of Kerberos S4U2Proxy
|
|
Packit Service |
0a38ef |
# delegation. This features is implemented in IPA server
|
|
Packit Service |
0a38ef |
# version 2.2 and higher
|
|
Packit Service |
0a38ef |
module.warn(
|
|
Packit Service |
0a38ef |
"Target IPA server has a lower version than the enrolled "
|
|
Packit Service |
0a38ef |
"client")
|
|
Packit Service |
0a38ef |
module.warn(
|
|
Packit Service |
0a38ef |
"Some capabilities including the ipa command capability "
|
|
Packit Service |
0a38ef |
"may not be available")
|
|
Packit Service |
0a38ef |
except errors.PublicError as e2:
|
|
Packit Service |
0a38ef |
module.fail_json(
|
|
Packit Service |
0a38ef |
msg="Cannot connect to the IPA server RPC interface: "
|
|
Packit Service |
0a38ef |
"%s" % e2)
|
|
Packit Service |
0a38ef |
except errors.PublicError as e:
|
|
Packit Service |
0a38ef |
module.fail_json(
|
|
Packit Service |
0a38ef |
msg="Cannot connect to the server due to generic error: "
|
|
Packit Service |
0a38ef |
"%s" % e)
|
|
Packit Service |
0a38ef |
# Use the RPC directly so older servers are supported
|
|
Packit Service |
0a38ef |
try:
|
|
Packit Service |
0a38ef |
result = api.Backend.rpcclient.forward(
|
|
Packit Service |
0a38ef |
'ca_is_enabled',
|
|
Packit Service |
0a38ef |
version=u'2.107',
|
|
Packit Service |
0a38ef |
)
|
|
Packit Service |
0a38ef |
ca_enabled = result['result']
|
|
Packit Service |
0a38ef |
except (errors.CommandError, errors.NetworkError):
|
|
Packit Service |
0a38ef |
result = api.Backend.rpcclient.forward(
|
|
Packit Service |
0a38ef |
'env',
|
|
Packit Service |
0a38ef |
server=True,
|
|
Packit Service |
0a38ef |
version=u'2.0',
|
|
Packit Service |
0a38ef |
)
|
|
Packit Service |
0a38ef |
ca_enabled = result['result']['enable_ra']
|
|
Packit Service |
0a38ef |
if not ca_enabled:
|
|
Packit Service |
0a38ef |
disable_ra()
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
# Get subject base from ipa server
|
|
Packit Service |
0a38ef |
try:
|
|
Packit Service |
0a38ef |
config = api.Command['config_show']()['result']
|
|
Packit Service |
0a38ef |
subject_base = str(DN(config['ipacertificatesubjectbase'][0]))
|
|
Packit Service |
0a38ef |
except errors.PublicError:
|
|
Packit Service |
0a38ef |
try:
|
|
Packit Service |
0a38ef |
config = api.Backend.rpcclient.forward(
|
|
Packit Service |
0a38ef |
'config_show',
|
|
Packit Service |
0a38ef |
raw=True, # so that servroles are not queried
|
|
Packit Service |
0a38ef |
version=u'2.0'
|
|
Packit Service |
0a38ef |
)['result']
|
|
Packit Service |
0a38ef |
except Exception as e:
|
|
Packit Service |
0a38ef |
logger.debug("config_show failed %s", e, exc_info=True)
|
|
Packit Service |
0a38ef |
module.fail_json(
|
|
Packit Service |
0a38ef |
"Failed to retrieve CA certificate subject base: {}".format(e),
|
|
Packit Service |
0a38ef |
rval=CLIENT_INSTALL_ERROR)
|
|
Packit Service |
0a38ef |
else:
|
|
Packit Service |
0a38ef |
subject_base = str(DN(config['ipacertificatesubjectbase'][0]))
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
module.exit_json(changed=True,
|
|
Packit Service |
0a38ef |
ca_enabled=ca_enabled,
|
|
Packit Service |
0a38ef |
subject_base=subject_base)
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
|
|
Packit Service |
0a38ef |
if __name__ == '__main__':
|
|
Packit Service |
0a38ef |
main()
|