# # Copyright (C) 2015 FreeIPA Contributors see COPYING for license # from __future__ import print_function import logging import re import os import shutil import pwd import fileinput import sys from augeas import Augeas import dns.exception import six # pylint: disable=import-error if six.PY3: # The SafeConfigParser class has been renamed to ConfigParser in Py3 from configparser import ConfigParser as SafeConfigParser else: from ConfigParser import SafeConfigParser # pylint: enable=import-error from ipalib import api from ipalib.install import certmonger, sysrestore import SSSDConfig import ipalib.util import ipalib.errors from ipaclient.install.client import sssd_enable_service from ipaplatform import services from ipaplatform.tasks import tasks from ipapython import ipautil, version, certdb from ipapython import dnsutil from ipapython.dn import DN from ipaplatform.constants import constants from ipaplatform.paths import paths from ipaserver.install import installutils from ipaserver.install import dsinstance from ipaserver.install import httpinstance from ipaserver.install import ntpinstance from ipaserver.install import bindinstance from ipaserver.install import service from ipaserver.install import cainstance from ipaserver.install import certs from ipaserver.install import otpdinstance from ipaserver.install import schemaupdate from ipaserver.install import custodiainstance from ipaserver.install import sysupgrade from ipaserver.install import dnskeysyncinstance from ipaserver.install import dogtaginstance from ipaserver.install import krbinstance from ipaserver.install import adtrustinstance from ipaserver.install.upgradeinstance import IPAUpgrade from ipaserver.install.ldapupdate import BadSyntax if six.PY3: unicode = str logger = logging.getLogger(__name__) class KpasswdInstance(service.SimpleServiceInstance): def __init__(self): service.SimpleServiceInstance.__init__(self, "ipa_kpasswd") def uninstall_ipa_kpasswd(): """ We can't use the full service uninstaller because that will attempt to stop and disable the service which by now doesn't exist. We just want to clean up sysrestore.state to remove all references to ipa_kpasswd. """ ipa_kpasswd = KpasswdInstance() enabled = not ipa_kpasswd.restore_state("enabled") if enabled is not None and not enabled: ipa_kpasswd.remove() def uninstall_ipa_memcached(): """ We can't use the full service uninstaller because that will attempt to stop and disable the service which by now doesn't exist. We just want to clean up sysrestore.state to remove all references to ipa_memcached. """ ipa_memcached = service.SimpleServiceInstance('ipa_memcached') if ipa_memcached.is_configured(): ipa_memcached.uninstall() def backup_file(filename, ext): """Make a backup of filename using ext as the extension. Do not overwrite previous backups.""" if not os.path.isabs(filename): raise ValueError("Absolute path required") backupfile = filename + ".bak" while os.path.exists(backupfile): backupfile = backupfile + "." + str(ext) try: shutil.copy2(filename, backupfile) except IOError as e: if e.errno == 2: # No such file or directory pass else: raise e def update_conf(sub_dict, filename, template_filename): template = ipautil.template_file(template_filename, sub_dict) fd = open(filename, "w") fd.write(template) fd.close() def find_autoredirect(fqdn): """ When upgrading ipa-rewrite.conf we need to see if the automatic redirect was disabled during install time (or afterward). So sift through the configuration file and see if we can determine the status. Returns True if autoredirect is enabled, False otherwise """ filename = paths.HTTPD_IPA_REWRITE_CONF if os.path.exists(filename): pattern = "^RewriteRule \^/\$ https://%s/ipa/ui \[L,NC,R=301\]" % fqdn p = re.compile(pattern) for line in fileinput.input(filename): if p.search(line): fileinput.close() return True fileinput.close() return False return True def find_version(filename): """Find the version of a configuration file If no VERSION entry exists in the file, returns 0. If the file does not exist, returns -1. """ if os.path.exists(filename): pattern = "^[\s#]*VERSION\s+([0-9]+)\s+.*" p = re.compile(pattern) for line in fileinput.input(filename): if p.search(line): fileinput.close() return p.search(line).group(1) fileinput.close() # no VERSION found return 0 else: return -1 def upgrade_file(sub_dict, filename, template, add=False): """ Get the version from the current and template files and update the installed configuration file if there is a new template. If add is True then create a new configuration file. """ old = int(find_version(filename)) new = int(find_version(template)) if old < 0 and not add: logger.error("%s not found.", filename) raise RuntimeError("%s not found." % filename) if new < 0: logger.error("%s not found.", template) if new == 0: logger.error("Template %s is not versioned.", template) if old == 0: # The original file does not have a VERSION entry. This means it's now # managed by IPA, but previously was not. logger.warning("%s is now managed by IPA. It will be " "overwritten. A backup of the original will be made.", filename) if old < new or (add and old == 0): backup_file(filename, new) update_conf(sub_dict, filename, template) logger.info("Upgraded %s to version %d", filename, new) def check_certs(): """Check ca.crt is in the right place, and try to fix if not""" logger.info('[Verifying that root certificate is published]') if not os.path.exists(paths.CA_CRT): ca_file = paths.IPA_CA_CRT if os.path.exists(ca_file): old_umask = os.umask(0o22) # make sure its readable by httpd try: shutil.copyfile(ca_file, paths.CA_CRT) finally: os.umask(old_umask) else: logger.error("Missing Certification Authority file.") logger.error("You should place a copy of the CA certificate in " "/usr/share/ipa/html/ca.crt") else: logger.debug('Certificate file exists') def upgrade_pki(ca, fstore): """ Update/add the dogtag proxy configuration. The IPA side of this is handled in ipa-pki-proxy.conf. This requires enabling SSL renegotiation. """ logger.info('[Verifying that CA proxy configuration is correct]') if not ca.is_configured(): logger.info('CA is not configured') return http = httpinstance.HTTPInstance(fstore) http.enable_mod_nss_renegotiate() logger.debug('Proxy configuration up-to-date') def update_dbmodules(realm, filename=paths.KRB5_CONF): newfile = [] found_dbrealm = False found_realm = False prefix = '' logger.info('[Verifying that KDC configuration is using ipa-kdb backend]') fd = open(filename) lines = fd.readlines() fd.close() if ' db_library = ipadb.so\n' in lines: logger.debug('dbmodules already updated in %s', filename) return for line in lines: if line.startswith('[dbmodules]'): found_dbrealm = True if found_dbrealm and line.find(realm) > -1: found_realm = True prefix = '#' if found_dbrealm and line.find('}') > -1 and found_realm: found_realm = False newfile.append('#%s' % line) prefix = '' continue newfile.append('%s%s' % (prefix, line)) # Append updated dbmodules information newfile.append(' %s = {\n' % realm) newfile.append(' db_library = ipadb.so\n') newfile.append(' }\n') # Write out new file fd = open(filename, 'w') fd.write("".join(newfile)) fd.close() logger.debug('%s updated', filename) def cleanup_kdc(fstore): """ Clean up old KDC files if they exist. We need to remove the actual file and any references in the uninstall configuration. """ logger.info('[Checking for deprecated KDC configuration files]') for file in ['kpasswd.keytab', 'ldappwd']: filename = os.path.join(paths.VAR_KERBEROS_KRB5KDC_DIR, file) installutils.remove_file(filename) if fstore.has_file(filename): fstore.untrack_file(filename) logger.debug('Uninstalling %s', filename) def cleanup_adtrust(fstore): """ Clean up any old Samba backup files that were deprecated. """ logger.info('[Checking for deprecated backups of Samba ' 'configuration files]') for backed_up_file in [paths.SMB_CONF]: if fstore.has_file(backed_up_file): fstore.untrack_file(backed_up_file) logger.debug('Removing %s from backup', backed_up_file) def cleanup_dogtag(): """ pkispawn leaves some mess we were not cleaning up until recently. Try to clean up what we can. """ subsystems = [] if api.Command.ca_is_enabled()['result']: subsystems.append('CA') if api.Command.kra_is_enabled()['result']: subsystems.append('KRA') for system in subsystems: logger.debug( "Cleaning up after pkispawn for the %s subsystem", system) instance = dogtaginstance.DogtagInstance( api.env.realm, system, service_desc=None, ) instance.clean_pkispawn_files() def upgrade_adtrust_config(): """ Upgrade 'dedicated keytab file' in smb.conf to omit FILE: prefix """ if not adtrustinstance.ipa_smb_conf_exists(): return logger.info("[Remove FILE: prefix from 'dedicated keytab file' " "in Samba configuration]") args = [paths.NET, "conf", "setparm", "global", "dedicated keytab file", paths.SAMBA_KEYTAB] try: ipautil.run(args) except ipautil.CalledProcessError as e: logger.warning("Error updating Samba registry: %s", e) def ca_configure_profiles_acl(ca): logger.info('[Authorizing RA Agent to modify profiles]') if not ca.is_configured(): logger.info('CA is not configured') return False return cainstance.configure_profiles_acl() def ca_configure_lightweight_ca_acls(ca): logger.info('[Authorizing RA Agent to manage lightweight CAs]') if not ca.is_configured(): logger.info('CA is not configured') return False return cainstance.configure_lightweight_ca_acls() def ca_enable_ldap_profile_subsystem(ca): logger.info('[Ensuring CA is using LDAPProfileSubsystem]') if not ca.is_configured(): logger.info('CA is not configured') return False needs_update = False directive = None try: for i in range(15): directive = "subsystem.{}.class".format(i) value = installutils.get_directive( paths.CA_CS_CFG_PATH, directive, separator='=') if value == 'com.netscape.cmscore.profile.ProfileSubsystem': needs_update = True break except OSError as e: logger.error('Cannot read CA configuration file "%s": %s', paths.CA_CS_CFG_PATH, e) return False if needs_update: installutils.set_directive( paths.CA_CS_CFG_PATH, directive, 'com.netscape.cmscore.profile.LDAPProfileSubsystem', quotes=False, separator='=') ca.restart('pki-tomcat') logger.info('[Migrating certificate profiles to LDAP]') cainstance.migrate_profiles_to_ldap() return needs_update def ca_import_included_profiles(ca): logger.info('[Ensuring presence of included profiles]') if not ca.is_configured(): logger.info('CA is not configured') return False return cainstance.import_included_profiles() def ca_ensure_lightweight_cas_container(ca): logger.info('[Ensuring Lightweight CAs container exists in Dogtag ' 'database]') if not ca.is_configured(): logger.info('CA is not configured') return False return cainstance.ensure_lightweight_cas_container() def ca_add_default_ocsp_uri(ca): logger.info('[Adding default OCSP URI configuration]') if not ca.is_configured(): logger.info('CA is not configured') return False value = installutils.get_directive( paths.CA_CS_CFG_PATH, 'ca.defaultOcspUri', separator='=') if value: return False # already set; restart not needed installutils.set_directive( paths.CA_CS_CFG_PATH, 'ca.defaultOcspUri', 'http://ipa-ca.%s/ca/ocsp' % ipautil.format_netloc(api.env.domain), quotes=False, separator='=') return True # restart needed def upgrade_ca_audit_cert_validity(ca): """ Update the Dogtag audit signing certificate. Returns True if restart is needed, False otherwise. """ logger.info('[Verifying that CA audit signing cert has 2 year validity]') if ca.is_configured(): return ca.set_audit_renewal() else: logger.info('CA is not configured') return False def named_remove_deprecated_options(): """ From IPA 3.3, persistent search is a default mechanism for new DNS zone detection. Remove psearch, zone_refresh cache_ttl and serial_autoincrement options, as they have been deprecated in bind-dyndb-ldap configuration file. When some change in named.conf is done, this functions returns True. """ logger.info('[Removing deprecated DNS configuration options]') if not bindinstance.named_conf_exists(): # DNS service may not be configured logger.info('DNS is not configured') return False deprecated_options = ['zone_refresh', 'psearch', 'cache_ttl', 'serial_autoincrement'] removed_options = [] try: # Remove all the deprecated options for option in deprecated_options: value = bindinstance.named_conf_get_directive(option) if value is not None: bindinstance.named_conf_set_directive(option, None) removed_options.append(option) except IOError as e: logger.error('Cannot modify DNS configuration in %s: %s', bindinstance.NAMED_CONF, e) # Log only the changed options if not removed_options: logger.debug('No changes made') return False logger.debug('The following configuration options have been removed: %s', ', '.join(removed_options)) return True def named_set_minimum_connections(): """ Sets the minimal number of connections. When some change in named.conf is done, this functions returns True. """ changed = False logger.info('[Ensuring minimal number of connections]') if not bindinstance.named_conf_exists(): # DNS service may not be configured logger.info('DNS is not configured') return changed # make sure number of connections is right minimum_connections = 4 try: connections = bindinstance.named_conf_get_directive('connections') except IOError as e: logger.debug('Cannot retrieve connections option from %s: %s', bindinstance.NAMED_CONF, e) return changed try: if connections is not None: connections = int(connections) except ValueError: # this should not happend, but there is some bad value in # "connections" option, bail out pass else: if connections is not None and connections < minimum_connections: try: bindinstance.named_conf_set_directive('connections', minimum_connections) logger.debug('Connections set to %d', minimum_connections) except IOError as e: logger.error('Cannot update connections in %s: %s', bindinstance.NAMED_CONF, e) else: changed = True if not changed: logger.debug('No changes made') return changed def named_update_gssapi_configuration(): """ Update GSSAPI configuration in named.conf to a recent API. tkey-gssapi-credential and tkey-domain is replaced with tkey-gssapi-keytab. Details can be found in https://fedorahosted.org/freeipa/ticket/3429. When some change in named.conf is done, this functions returns True """ logger.info('[Updating GSSAPI configuration in DNS]') if not bindinstance.named_conf_exists(): # DNS service may not be configured logger.info('DNS is not configured') return False if sysupgrade.get_upgrade_state('named.conf', 'gssapi_updated'): logger.debug('Skip GSSAPI configuration check') return False try: gssapi_keytab = bindinstance.named_conf_get_directive('tkey-gssapi-keytab', bindinstance.NAMED_SECTION_OPTIONS) except IOError as e: logger.error('Cannot retrieve tkey-gssapi-keytab option from %s: %s', bindinstance.NAMED_CONF, e) return False else: if gssapi_keytab: logger.debug('GSSAPI configuration already updated') sysupgrade.set_upgrade_state('named.conf', 'gssapi_updated', True) return False try: tkey_credential = bindinstance.named_conf_get_directive('tkey-gssapi-credential', bindinstance.NAMED_SECTION_OPTIONS) tkey_domain = bindinstance.named_conf_get_directive('tkey-domain', bindinstance.NAMED_SECTION_OPTIONS) except IOError as e: logger.error('Cannot retrieve tkey-gssapi-credential option from %s: ' '%s', bindinstance.NAMED_CONF, e) return False if not tkey_credential or not tkey_domain: logger.error('Either tkey-gssapi-credential or tkey-domain is missing ' 'in %s. Skip update.', bindinstance.NAMED_CONF) return False try: bindinstance.named_conf_set_directive( 'tkey-gssapi-credential', None, bindinstance.NAMED_SECTION_OPTIONS) bindinstance.named_conf_set_directive( 'tkey-domain', None, bindinstance.NAMED_SECTION_OPTIONS) bindinstance.named_conf_set_directive( 'tkey-gssapi-keytab', paths.NAMED_KEYTAB, bindinstance.NAMED_SECTION_OPTIONS) except IOError as e: logger.error('Cannot update GSSAPI configuration in %s: %s', bindinstance.NAMED_CONF, e) return False else: logger.debug('GSSAPI configuration updated') sysupgrade.set_upgrade_state('named.conf', 'gssapi_updated', True) return True def named_update_pid_file(): """ Make sure that named reads the pid file from the right file """ logger.info('[Updating pid-file configuration in DNS]') if not bindinstance.named_conf_exists(): # DNS service may not be configured logger.info('DNS is not configured') return False if sysupgrade.get_upgrade_state('named.conf', 'pid-file_updated'): logger.debug('Skip pid-file configuration check') return False try: pid_file = bindinstance.named_conf_get_directive('pid-file', bindinstance.NAMED_SECTION_OPTIONS) except IOError as e: logger.error('Cannot retrieve pid-file option from %s: %s', bindinstance.NAMED_CONF, e) return False else: if pid_file: logger.debug('pid-file configuration already updated') sysupgrade.set_upgrade_state('named.conf', 'pid-file_updated', True) return False try: bindinstance.named_conf_set_directive('pid-file', paths.NAMED_PID, bindinstance.NAMED_SECTION_OPTIONS) except IOError as e: logger.error('Cannot update pid-file configuration in %s: %s', bindinstance.NAMED_CONF, e) return False else: logger.debug('pid-file configuration updated') sysupgrade.set_upgrade_state('named.conf', 'pid-file_updated', True) return True def named_enable_dnssec(): """ Enable dnssec in named.conf """ if not bindinstance.named_conf_exists(): # DNS service may not be configured logger.info('DNS is not configured') return False if not sysupgrade.get_upgrade_state('named.conf', 'dnssec_enabled'): logger.info('[Enabling "dnssec-enable" configuration in DNS]') try: bindinstance.named_conf_set_directive('dnssec-enable', 'yes', bindinstance.NAMED_SECTION_OPTIONS, str_val=False) except IOError as e: logger.error('Cannot update dnssec-enable configuration in %s: %s', bindinstance.NAMED_CONF, e) return False else: logger.debug('dnssec-enabled in %s', bindinstance.NAMED_CONF) sysupgrade.set_upgrade_state('named.conf', 'dnssec_enabled', True) return True def named_validate_dnssec(): """ Disable dnssec validation in named.conf We can't let enable it by default, there can be non-valid dns forwarders which breaks DNSSEC validation """ if not bindinstance.named_conf_exists(): # DNS service may not be configured logger.info('DNS is not configured') return False if (not sysupgrade.get_upgrade_state('named.conf', 'dnssec_validation_upgraded') and bindinstance.named_conf_get_directive( 'dnssec-validation', bindinstance.NAMED_SECTION_OPTIONS, str_val=False) is None): # dnssec-validation is not configured, disable it logger.info('[Disabling "dnssec-validate" configuration in DNS]') try: bindinstance.named_conf_set_directive('dnssec-validation', 'no', bindinstance.NAMED_SECTION_OPTIONS, str_val=False) except IOError as e: logger.error('Cannot update dnssec-validate configuration in %s: ' '%s', bindinstance.NAMED_CONF, e) return False else: logger.debug('dnssec-validate already configured in %s', bindinstance.NAMED_CONF) sysupgrade.set_upgrade_state('named.conf', 'dnssec_validation_upgraded', True) return True def named_bindkey_file_option(): """ Add options bindkey_file to named.conf """ if not bindinstance.named_conf_exists(): # DNS service may not be configured logger.info('DNS is not configured') return False if sysupgrade.get_upgrade_state('named.conf', 'bindkey-file_updated'): logger.debug('Skip bindkey-file configuration check') return False try: bindkey_file = bindinstance.named_conf_get_directive('bindkey-file', bindinstance.NAMED_SECTION_OPTIONS) except IOError as e: logger.error('Cannot retrieve bindkey-file option from %s: %s', bindinstance.NAMED_CONF, e) return False else: if bindkey_file: logger.debug('bindkey-file configuration already updated') sysupgrade.set_upgrade_state('named.conf', 'bindkey-file_updated', True) return False logger.info('[Setting "bindkeys-file" option in named.conf]') try: bindinstance.named_conf_set_directive('bindkeys-file', paths.NAMED_BINDKEYS_FILE, bindinstance.NAMED_SECTION_OPTIONS) except IOError as e: logger.error('Cannot update bindkeys-file configuration in %s: %s', bindinstance.NAMED_CONF, e) return False sysupgrade.set_upgrade_state('named.conf', 'bindkey-file_updated', True) return True def named_managed_keys_dir_option(): """ Add options managed_keys_directory to named.conf """ if not bindinstance.named_conf_exists(): # DNS service may not be configured logger.info('DNS is not configured') return False if sysupgrade.get_upgrade_state('named.conf', 'managed-keys-directory_updated'): logger.debug('Skip managed-keys-directory configuration check') return False try: managed_keys = bindinstance.named_conf_get_directive('managed-keys-directory', bindinstance.NAMED_SECTION_OPTIONS) except IOError as e: logger.error('Cannot retrieve managed-keys-directory option from %s: ' '%s', bindinstance.NAMED_CONF, e) return False else: if managed_keys: logger.debug('managed_keys_directory configuration already ' 'updated') sysupgrade.set_upgrade_state('named.conf', 'managed-keys-directory_updated', True) return False logger.info('[Setting "managed-keys-directory" option in named.conf]') try: bindinstance.named_conf_set_directive('managed-keys-directory', paths.NAMED_MANAGED_KEYS_DIR, bindinstance.NAMED_SECTION_OPTIONS) except IOError as e: logger.error('Cannot update managed-keys-directory configuration in ' '%s: %s', bindinstance.NAMED_CONF, e) return False sysupgrade.set_upgrade_state('named.conf', 'managed-keys-directory_updated', True) return True def named_root_key_include(): """ Add options managed_keys_directory to named.conf """ if not bindinstance.named_conf_exists(): # DNS service may not be configured logger.info('DNS is not configured') return False if sysupgrade.get_upgrade_state('named.conf', 'root_key_updated'): logger.debug('Skip root key configuration check') return False try: root_key = bindinstance.named_conf_include_exists(paths.NAMED_ROOT_KEY) except IOError as e: logger.error('Cannot check root key include in %s: %s', bindinstance.NAMED_CONF, e) return False else: if root_key: logger.debug('root keys configuration already updated') sysupgrade.set_upgrade_state('named.conf', 'root_key_updated', True) return False logger.info('[Including named root key in named.conf]') try: bindinstance.named_conf_add_include(paths.NAMED_ROOT_KEY) except IOError as e: logger.error('Cannot update named root key include in %s: %s', bindinstance.NAMED_CONF, e) return False sysupgrade.set_upgrade_state('named.conf', 'root_key_updated', True) return True def named_update_global_forwarder_policy(): bind = bindinstance.BindInstance() if not bindinstance.named_conf_exists() or not bind.is_configured(): # DNS service may not be configured logger.info('DNS is not configured') return False logger.info('[Checking global forwarding policy in named.conf ' 'to avoid conflicts with automatic empty zones]') if sysupgrade.get_upgrade_state( 'named.conf', 'forward_policy_conflict_with_empty_zones_handled' ): # upgrade was done already return False sysupgrade.set_upgrade_state( 'named.conf', 'forward_policy_conflict_with_empty_zones_handled', True ) try: if not dnsutil.has_empty_zone_addresses(api.env.host): # guess: local server does not have IP addresses from private # ranges so hopefully automatic empty zones are not a problem return False except dns.exception.DNSException as ex: logger.error( 'Skipping update of global DNS forwarder in named.conf: ' 'Unable to determine if local server is using an ' 'IP address belonging to an automatic empty zone. ' 'Consider changing forwarding policy to "only". ' 'DNS exception: %s', ex) return False if bindinstance.named_conf_get_directive( 'forward', section=bindinstance.NAMED_SECTION_OPTIONS, str_val=False ) == 'only': return False logger.info('Global forward policy in named.conf will ' 'be changed to "only" to avoid conflicts with ' 'automatic empty zones') bindinstance.named_conf_set_directive( 'forward', 'only', section=bindinstance.NAMED_SECTION_OPTIONS, str_val=False ) return True def named_add_server_id(): """ DNS Locations feature requires to have configured server_id in IPA section of named.conf :return: if named.conf has been changed """ bind = bindinstance.BindInstance() if not bindinstance.named_conf_exists() or not bind.is_configured(): # DNS service may not be configured logger.info('DNS is not configured') return False if sysupgrade.get_upgrade_state('named.conf', 'add_server_id'): # upgrade was done already return False logger.info('[Adding server_id to named.conf]') bindinstance.named_conf_set_directive('server_id', api.env.host) sysupgrade.set_upgrade_state('named.conf', 'add_server_id', True) return True def certificate_renewal_update(ca, ds, http): """ Update certmonger certificate renewal configuration. """ template = paths.CERTMONGER_COMMAND_TEMPLATE serverid = installutils.realm_to_serverid(api.env.realm) requests = [ { 'cert-database': paths.PKI_TOMCAT_ALIAS_DIR, 'cert-nickname': 'auditSigningCert cert-pki-ca', 'ca': 'dogtag-ipa-ca-renew-agent', 'cert-presave-command': template % 'stop_pkicad', 'cert-postsave-command': (template % 'renew_ca_cert "auditSigningCert cert-pki-ca"'), }, { 'cert-database': paths.PKI_TOMCAT_ALIAS_DIR, 'cert-nickname': 'ocspSigningCert cert-pki-ca', 'ca': 'dogtag-ipa-ca-renew-agent', 'cert-presave-command': template % 'stop_pkicad', 'cert-postsave-command': (template % 'renew_ca_cert "ocspSigningCert cert-pki-ca"'), }, { 'cert-database': paths.PKI_TOMCAT_ALIAS_DIR, 'cert-nickname': 'subsystemCert cert-pki-ca', 'ca': 'dogtag-ipa-ca-renew-agent', 'cert-presave-command': template % 'stop_pkicad', 'cert-postsave-command': (template % 'renew_ca_cert "subsystemCert cert-pki-ca"'), }, { 'cert-database': paths.PKI_TOMCAT_ALIAS_DIR, 'cert-nickname': 'caSigningCert cert-pki-ca', 'ca': 'dogtag-ipa-ca-renew-agent', 'cert-presave-command': template % 'stop_pkicad', 'cert-postsave-command': (template % 'renew_ca_cert "caSigningCert cert-pki-ca"'), 'template-profile': '', }, { 'cert-database': paths.PKI_TOMCAT_ALIAS_DIR, 'cert-nickname': 'Server-Cert cert-pki-ca', 'ca': 'dogtag-ipa-ca-renew-agent', 'cert-presave-command': template % 'stop_pkicad', 'cert-postsave-command': (template % 'renew_ca_cert "Server-Cert cert-pki-ca"'), }, { 'cert-file': paths.RA_AGENT_PEM, 'key-file': paths.RA_AGENT_KEY, 'ca': 'dogtag-ipa-ca-renew-agent', 'cert-presave-command': template % 'renew_ra_cert_pre', 'cert-postsave-command': template % 'renew_ra_cert', }, { 'cert-database': paths.HTTPD_ALIAS_DIR, 'cert-nickname': http.get_mod_nss_nickname(), 'ca': 'IPA', 'cert-postsave-command': template % 'restart_httpd', }, { 'cert-database': dsinstance.config_dirname(serverid), 'cert-nickname': ds.get_server_cert_nickname(serverid), 'ca': 'IPA', 'cert-postsave-command': '%s %s' % (template % 'restart_dirsrv', serverid), } ] logger.info("[Update certmonger certificate renewal configuration]") if not ca.is_configured(): logger.info('CA is not configured') return False db = certs.CertDB(api.env.realm, paths.PKI_TOMCAT_ALIAS_DIR) for nickname, _trust_flags in db.list_certs(): if nickname.startswith('caSigningCert cert-pki-ca '): requests.append( { 'cert-database': paths.PKI_TOMCAT_ALIAS_DIR, 'cert-nickname': nickname, 'ca': 'dogtag-ipa-ca-renew-agent', 'cert-presave-command': template % 'stop_pkicad', 'cert-postsave-command': (template % ('renew_ca_cert "%s"' % nickname)), 'template-profile': 'caCACert', } ) # State not set, lets see if we are already configured for request in requests: request_id = certmonger.get_request_id(request) if request_id is None: break else: return False # Ok, now we need to stop tracking, then we can start tracking them # again with new configuration: ca.stop_tracking_certificates() ds.stop_tracking_certificates(serverid) http.stop_tracking_certificates() filename = paths.CERTMONGER_CAS_CA_RENEWAL if os.path.exists(filename): with installutils.stopped_service('certmonger'): logger.info("Removing %s", filename) installutils.remove_file(filename) ca.configure_certmonger_renewal() ca.configure_renewal() ca.configure_agent_renewal() ca.track_servercert() ca.add_lightweight_ca_tracking_requests() ds.start_tracking_certificates(serverid) http.start_tracking_certificates() logger.info("Certmonger certificate renewal configuration updated") return True def copy_crl_file(old_path, new_path=None): """ Copy CRL to new location, update permissions and SELinux context """ if new_path is None: filename = os.path.basename(old_path) new_path = os.path.join(paths.PKI_CA_PUBLISH_DIR, filename) logger.debug('copy_crl_file: %s -> %s', old_path, new_path) if os.path.islink(old_path): # update symlink to the most most recent CRL file filename = os.path.basename(os.readlink(old_path)) realpath = os.path.join(paths.PKI_CA_PUBLISH_DIR, filename) logger.debug('copy_crl_file: Create symlink %s -> %s', new_path, realpath) os.symlink(realpath, new_path) else: shutil.copy2(old_path, new_path) pent = pwd.getpwnam(constants.PKI_USER) os.chown(new_path, pent.pw_uid, pent.pw_gid) tasks.restore_context(new_path) def migrate_crl_publish_dir(ca): """ Move CRL publish dir from /var/lib/pki-ca/publish to IPA controlled tree: /var/lib/ipa/pki-ca/publish """ logger.info('[Migrate CRL publish directory]') if sysupgrade.get_upgrade_state('dogtag', 'moved_crl_publish_dir'): logger.info('CRL tree already moved') return False if not ca.is_configured(): logger.info('CA is not configured') return False try: old_publish_dir = installutils.get_directive( paths.CA_CS_CFG_PATH, 'ca.publish.publisher.instance.FileBaseCRLPublisher.directory', separator='=') except OSError as e: logger.error('Cannot read CA configuration file "%s": %s', paths.CA_CS_CFG_PATH, e) return False # Prepare target publish dir (creation, permissions, SELinux context) # Run this every update to ensure proper values publishdir = ca.prepare_crl_publish_dir() if old_publish_dir == paths.PKI_CA_PUBLISH_DIR: # publish dir is already updated logger.info('Publish directory already set to new location') sysupgrade.set_upgrade_state('dogtag', 'moved_crl_publish_dir', True) return False # Copy all CRLs to new directory logger.info('Copy all CRLs to new publish directory') try: crl_files_unsorted = cainstance.get_crl_files(old_publish_dir) except OSError as e: logger.error('Cannot move CRL files to new directory: %s', e) else: # Move CRL files at the end of the list to make sure that the actual # CRL files are copied first crl_files = sorted(crl_files_unsorted, key=lambda f: os.path.islink(f)) for f in crl_files: try: copy_crl_file(f) except Exception as e: logger.error('Cannot move CRL file to new directory: %s', e) try: installutils.set_directive( paths.CA_CS_CFG_PATH, 'ca.publish.publisher.instance.FileBaseCRLPublisher.directory', publishdir, quotes=False, separator='=') except OSError as e: logger.error('Cannot update CA configuration file "%s": %s', paths.CA_CS_CFG_PATH, e) return False sysupgrade.set_upgrade_state('dogtag', 'moved_crl_publish_dir', True) logger.info('CRL publish directory has been migrated, ' 'request pki-tomcat restart') return True def ca_enable_pkix(ca): logger.info('[Enable PKIX certificate path discovery and validation]') if sysupgrade.get_upgrade_state('dogtag', 'pkix_enabled'): logger.info('PKIX already enabled') return False if not ca.is_configured(): logger.info('CA is not configured') return False ca.enable_pkix() sysupgrade.set_upgrade_state('dogtag', 'pkix_enabled', True) return True def add_ca_dns_records(): logger.info('[Add missing CA DNS records]') if sysupgrade.get_upgrade_state('dns', 'ipa_ca_records'): logger.info('IPA CA DNS records already processed') return ret = api.Command['dns_is_enabled']() if not ret['result']: logger.info('DNS is not configured') sysupgrade.set_upgrade_state('dns', 'ipa_ca_records', True) return bind = bindinstance.BindInstance() bind.remove_ipa_ca_cnames(api.env.domain) bind.update_system_records() sysupgrade.set_upgrade_state('dns', 'ipa_ca_records', True) def find_subject_base(): """ Try to find the current value of certificate subject base. See the docstring in dsinstance.DsInstance for details. """ subject_base = dsinstance.DsInstance().find_subject_base() if subject_base: sysupgrade.set_upgrade_state( 'certmap.conf', 'subject_base', subject_base ) return subject_base logger.error('Unable to determine certificate subject base. ' 'certmap.conf will not be updated.') def uninstall_selfsign(ds, http): logger.info('[Removing self-signed CA]') """Replace self-signed CA by a CA-less install""" if api.env.ra_plugin != 'selfsign': logger.debug('Self-signed CA is not installed') return logger.warning( 'Removing self-signed CA. Certificates will need to managed manually.') p = SafeConfigParser() p.read(paths.IPA_DEFAULT_CONF) p.set('global', 'enable_ra', 'False') p.set('global', 'ra_plugin', 'none') with open(paths.IPA_DEFAULT_CONF, 'w') as f: p.write(f) ds.stop_tracking_certificates() http.stop_tracking_certificates() def uninstall_dogtag_9(ds, http): logger.info('[Removing Dogtag 9 CA]') if api.env.ra_plugin != 'dogtag': logger.debug('Dogtag CA is not installed') return if api.env.dogtag_version >= 10: logger.debug('Dogtag is version 10 or above') return dn = DN(('cn', 'CA'), ('cn', api.env.host), ('cn', 'masters'), ('cn', 'ipa'), ('cn', 'etc'), api.env.basedn) try: api.Backend.ldap2.delete_entry(dn) except ipalib.errors.PublicError as e: logger.error("Cannot delete %s: %s", dn, e) p = SafeConfigParser() p.read(paths.IPA_DEFAULT_CONF) p.set('global', 'dogtag_version', '10') with open(paths.IPA_DEFAULT_CONF, 'w') as f: p.write(f) sstore = sysrestore.StateFile(paths.SYSRESTORE) sstore.restore_state('pkids', 'enabled') sstore.restore_state('pkids', 'running') sstore.restore_state('pkids', 'user_exists') serverid = sstore.restore_state('pkids', 'serverid') sstore.save() ca = dogtaginstance.DogtagInstance( api.env.realm, "CA", "certificate server", nss_db=paths.VAR_LIB_PKI_CA_ALIAS_DIR) ca.stop_tracking_certificates(False) if serverid is not None: # drop the trailing / off the config_dirname so the directory # will match what is in certmonger dirname = dsinstance.config_dirname(serverid)[:-1] dsdb = certs.CertDB(api.env.realm, nssdir=dirname) dsdb.untrack_server_cert("Server-Cert") try: services.service('pki-cad', api).disable('pki-ca') except Exception as e: logger.warning("Failed to disable pki-cad: %s", e) try: services.service('pki-cad', api).stop('pki-ca') except Exception as e: logger.warning("Failed to stop pki-cad: %s", e) if serverid is not None: try: services.service('dirsrv', api).disable(serverid) except Exception as e: logger.warning("Failed to disable dirsrv: %s", e) try: services.service('dirsrv', api).stop(serverid) except Exception as e: logger.warning("Failed to stop dirsrv: %s", e) http.restart() def mask_named_regular(): """Disable named, we need to run only named-pkcs11, running both named and named-pkcs can cause unexpected errors""" if sysupgrade.get_upgrade_state('dns', 'regular_named_masked'): return False sysupgrade.set_upgrade_state('dns', 'regular_named_masked', True) if bindinstance.named_conf_exists(): logger.info('[Masking named]') named = services.service('named-regular', api) try: named.stop() except Exception as e: logger.warning('Unable to stop named service (%s)', e) try: named.mask() except Exception as e: logger.warning('Unable to mask named service (%s)', e) return True return False def fix_dyndb_ldap_workdir_permissions(): """Fix dyndb-ldap working dir permissions. DNSSEC daemons requires it""" if sysupgrade.get_upgrade_state('dns', 'dyndb_ipa_workdir_perm'): return if bindinstance.named_conf_exists(): logger.info('[Fix bind-dyndb-ldap IPA working directory]') dnskeysync = dnskeysyncinstance.DNSKeySyncInstance() dnskeysync.set_dyndb_ldap_workdir_permissions() sysupgrade.set_upgrade_state('dns', 'dyndb_ipa_workdir_perm', True) def fix_schema_file_syntax(): """Fix syntax errors in schema files https://fedorahosted.org/freeipa/ticket/3578 """ logger.info('[Fix DS schema file syntax]') # This is not handled by normal schema updates, because pre-1.3.2 DS will # ignore (auto-fix) these syntax errors, and 1.3.2 and above will choke on # them before checking dynamic schema updates. if sysupgrade.get_upgrade_state('ds', 'fix_schema_syntax'): logger.info('Syntax already fixed') return serverid = installutils.realm_to_serverid(api.env.realm) ds_dir = dsinstance.config_dirname(serverid) # 1. 60ipadns.ldif: Add parenthesis to idnsRecord filename = os.path.join(ds_dir, 'schema', '60ipadns.ldif') result_lines = [] with open(filename) as file: for line in file: line = line.strip('\n') if (line.startswith('objectClasses:') and "NAME 'idnsRecord'" in line and line.count('(') == 2 and line.count(')') == 1): logger.debug('Add closing parenthesis in idnsRecord') line += ' )' result_lines.append(line) with open(filename, 'w') as file: file.write('\n'.join(result_lines)) # 2. 65ipasudo.ldif: Remove extra dollar from ipaSudoRule filename = os.path.join(ds_dir, 'schema', '65ipasudo.ldif') result_lines = [] with open(filename) as file: for line in file: line = line.strip('\n') if (line.startswith('objectClasses:') and "NAME 'ipaSudoRule'" in line): logger.debug('Remove extra dollar sign in ipaSudoRule') line = line.replace('$$', '$') result_lines.append(line) with open(filename, 'w') as file: file.write('\n'.join(result_lines)) # Done sysupgrade.set_upgrade_state('ds', 'fix_schema_syntax', True) def set_sssd_domain_option(option, value): sssdconfig = SSSDConfig.SSSDConfig() sssdconfig.import_config() domain = sssdconfig.get_domain(str(api.env.domain)) domain.set_option(option, value) sssdconfig.save_domain(domain) sssdconfig.write(paths.SSSD_CONF) def remove_ds_ra_cert(subject_base): logger.info('[Removing RA cert from DS NSS database]') if sysupgrade.get_upgrade_state('ds', 'remove_ra_cert'): logger.info('RA cert already removed') return dbdir = dsinstance.config_dirname( installutils.realm_to_serverid(api.env.realm)) dsdb = certs.CertDB(api.env.realm, nssdir=dbdir, subject_base=subject_base) nickname = 'CN=IPA RA,%s' % subject_base cert = dsdb.get_cert_from_db(nickname) if cert: dsdb.delete_cert(nickname) sysupgrade.set_upgrade_state('ds', 'remove_ra_cert', True) def fix_trust_flags(): logger.info('[Fixing trust flags in %s]', paths.HTTPD_ALIAS_DIR) if sysupgrade.get_upgrade_state('http', 'fix_trust_flags'): logger.info("Trust flags already processed") return if not api.Command.ca_is_enabled()['result']: logger.info("CA is not enabled") return db = certs.CertDB(api.env.realm, nssdir=paths.HTTPD_ALIAS_DIR) nickname = certdb.get_ca_nickname(api.env.realm) cert = db.get_cert_from_db(nickname) if cert: db.trust_root_cert(nickname, certdb.IPA_CA_TRUST_FLAGS) sysupgrade.set_upgrade_state('http', 'fix_trust_flags', True) def update_mod_nss_protocol(http): logger.info('[Updating mod_nss protocol versions]') if sysupgrade.get_upgrade_state('nss.conf', 'protocol_updated_tls12'): logger.info("Protocol versions already updated") return http.set_mod_nss_protocol() sysupgrade.set_upgrade_state('nss.conf', 'protocol_updated_tls12', True) def disable_mod_nss_ocsp(http): logger.info('[Updating mod_nss enabling OCSP]') http.disable_mod_nss_ocsp() def update_mod_nss_cipher_suite(http): logger.info('[Updating mod_nss cipher suite]') revision = sysupgrade.get_upgrade_state('nss.conf', 'cipher_suite_updated') if revision and revision >= httpinstance.NSS_CIPHER_REVISION: logger.debug("Cipher suite already updated") return http.set_mod_nss_cipher_suite() sysupgrade.set_upgrade_state( 'nss.conf', 'cipher_suite_updated', httpinstance.NSS_CIPHER_REVISION) def update_ipa_httpd_service_conf(http): logger.info('[Updating HTTPD service IPA configuration]') http.update_httpd_service_ipa_conf() def update_http_keytab(http): logger.info('[Moving HTTPD service keytab to gssproxy]') if os.path.exists(paths.OLD_IPA_KEYTAB): # ensure proper SELinux context by using copy operation shutil.copy(paths.OLD_IPA_KEYTAB, http.keytab) try: os.remove(paths.OLD_IPA_KEYTAB) except OSError as e: logger.error( 'Cannot remove file %s (%s). Please remove the file manually.', paths.OLD_IPA_KEYTAB, e ) pent = pwd.getpwnam(http.keytab_user) os.chown(http.keytab, pent.pw_uid, pent.pw_gid) def ds_enable_sidgen_extdom_plugins(ds): """For AD trust agents, make sure we enable sidgen and extdom plugins """ logger.info('[Enable sidgen and extdom plugins by default]') if sysupgrade.get_upgrade_state('ds', 'enable_ds_sidgen_extdom_plugins'): logger.debug('sidgen and extdom plugins are enabled already') return ds.add_sidgen_plugin(api.env.basedn) ds.add_extdom_plugin(api.env.basedn) sysupgrade.set_upgrade_state('ds', 'enable_ds_sidgen_extdom_plugins', True) def ca_upgrade_schema(ca): logger.info('[Upgrading CA schema]') if not ca.is_configured(): logger.info('CA is not configured') return False schema_files=[ '/usr/share/pki/server/conf/schema-certProfile.ldif', '/usr/share/pki/server/conf/schema-authority.ldif', ] try: modified = schemaupdate.update_schema(schema_files, ldapi=True) except Exception as e: logger.error("%s", e) raise RuntimeError('CA schema upgrade failed.', 1) else: if modified: logger.info('CA schema update complete') return True else: logger.info('CA schema update complete (no changes)') return False def add_default_caacl(ca): logger.info('[Add default CA ACL]') if sysupgrade.get_upgrade_state('caacl', 'add_default_caacl'): logger.info('Default CA ACL already added') return if ca.is_configured(): cainstance.ensure_default_caacl() sysupgrade.set_upgrade_state('caacl', 'add_default_caacl', True) def setup_pkinit(krb): logger.info("[Setup PKINIT]") if not krbinstance.is_pkinit_enabled(): krb.issue_selfsigned_pkinit_certs() aug = Augeas(flags=Augeas.NO_LOAD | Augeas.NO_MODL_AUTOLOAD, loadpath=paths.USR_SHARE_IPA_DIR) try: aug.transform('IPAKrb5', paths.KRB5KDC_KDC_CONF) aug.load() path = '/files{}/realms/{}'.format(paths.KRB5KDC_KDC_CONF, krb.realm) modified = False value = 'FILE:{},{}'.format(paths.KDC_CERT, paths.KDC_KEY) expr = '{}[count(pkinit_identity)=1][pkinit_identity="{}"]'.format( path, value) if not aug.match(expr): aug.remove('{}/pkinit_identity'.format(path)) aug.set('{}/pkinit_identity'.format(path), value) modified = True for value in ['FILE:{}'.format(paths.KDC_CERT), 'FILE:{}'.format(paths.CACERT_PEM)]: expr = '{}/pkinit_anchors[.="{}"]'.format(path, value) if not aug.match(expr): aug.set('{}/pkinit_anchors[last()+1]'.format(path), value) modified = True value = 'FILE:{}'.format(paths.CA_BUNDLE_PEM) expr = '{}/pkinit_pool[.="{}"]'.format(path, value) if not aug.match(expr): aug.set('{}/pkinit_pool[last()+1]'.format(path), value) modified = True if modified: try: aug.save() except IOError: for error_path in aug.match('/augeas//error'): logger.error('augeas: %s', aug.get(error_path)) raise if krb.is_running(): krb.stop() krb.start() finally: aug.close() def enable_certauth(krb): logger.info("[Enable certauth]") aug = Augeas(flags=Augeas.NO_LOAD | Augeas.NO_MODL_AUTOLOAD, loadpath=paths.USR_SHARE_IPA_DIR) try: aug.transform('IPAKrb5', paths.KRB5_CONF) aug.load() path = '/files{}/plugins/certauth'.format(paths.KRB5_CONF) modified = False if not aug.match(path): aug.set('{}/module'.format(path), 'ipakdb:kdb/ipadb.so') aug.set('{}/enable_only'.format(path), 'ipakdb') modified = True if modified: try: aug.save() except IOError: for error_path in aug.match('/augeas//error'): logger.error('augeas: %s', aug.get(error_path)) raise if krb.is_running(): krb.stop() krb.start() finally: aug.close() def disable_httpd_system_trust(http): ca_certs = [] db = certs.CertDB(api.env.realm, nssdir=paths.HTTPD_ALIAS_DIR) for nickname, trust_flags in db.list_certs(): if not trust_flags.has_key: cert = db.get_cert_from_db(nickname) if cert: ca_certs.append((cert, nickname, trust_flags)) if http.disable_system_trust(): for cert, nickname, trust_flags in ca_certs: db.add_cert(cert, nickname, trust_flags) def upgrade_configuration(): """ Execute configuration upgrade of the IPA services """ logger.debug('IPA version %s', version.VENDOR_VERSION) fstore = sysrestore.FileStore(paths.SYSRESTORE) fqdn = api.env.host # Ok, we are an IPA server, do the additional tests ds_serverid = installutils.realm_to_serverid(api.env.realm) ds = dsinstance.DsInstance() # start DS, CA will not start without running DS, and cause error ds_running = ds.is_running() if not ds_running: ds.start(ds_serverid) check_certs() auto_redirect = find_autoredirect(fqdn) sub_dict = dict( REALM=api.env.realm, FQDN=fqdn, AUTOREDIR='' if auto_redirect else '#', CRL_PUBLISH_PATH=paths.PKI_CA_PUBLISH_DIR, DOGTAG_PORT=8009, CLONE='#' ) subject_base = find_subject_base() if subject_base: sub_dict['ISSUER_DN'] = 'CN=Certificate Authority,' + subject_base ca = cainstance.CAInstance( api.env.realm, host_name=api.env.host) ca_running = ca.is_running() # create passswd.txt file in PKI_TOMCAT_ALIAS_DIR if it does not exist # this file will be required on most actions over this NSS DB in FIPS if ca.is_configured() and not os.path.exists(os.path.join( paths.PKI_TOMCAT_ALIAS_DIR, 'pwdfile.txt')): ca.create_certstore_passwdfile() with installutils.stopped_service('pki-tomcatd', 'pki-tomcat'): # Dogtag must be stopped to be able to backup CS.cfg config ca.backup_config() # migrate CRL publish dir before the location in ipa.conf is updated ca_restart = migrate_crl_publish_dir(ca) if ca.is_configured(): crl = installutils.get_directive( paths.CA_CS_CFG_PATH, 'ca.crl.MasterCRL.enableCRLUpdates', '=') sub_dict['CLONE']='#' if crl.lower() == 'true' else '' ds_dirname = dsinstance.config_dirname(ds_serverid) upgrade_file(sub_dict, paths.HTTPD_IPA_CONF, os.path.join(paths.USR_SHARE_IPA_DIR, "ipa.conf")) upgrade_file(sub_dict, paths.HTTPD_IPA_REWRITE_CONF, os.path.join(paths.USR_SHARE_IPA_DIR, "ipa-rewrite.conf")) if ca.is_configured(): upgrade_file( sub_dict, paths.HTTPD_IPA_PKI_PROXY_CONF, os.path.join(paths.USR_SHARE_IPA_DIR, "ipa-pki-proxy.conf"), add=True) else: if ipautil.file_exists(paths.HTTPD_IPA_PKI_PROXY_CONF): os.remove(paths.HTTPD_IPA_PKI_PROXY_CONF) if subject_base: upgrade_file( sub_dict, os.path.join(ds_dirname, "certmap.conf"), os.path.join(paths.USR_SHARE_IPA_DIR, "certmap.conf.template") ) upgrade_pki(ca, fstore) # several upgrade steps require running CA. If CA is configured, # always run ca.start() because we need to wait until CA is really ready # by checking status using http if ca.is_configured(): ca.start('pki-tomcat') certmonger_service = services.knownservices.certmonger if ca.is_configured() and not certmonger_service.is_running(): certmonger_service.start() ca.unconfigure_certmonger_renewal_guard() update_dbmodules(api.env.realm) uninstall_ipa_kpasswd() uninstall_ipa_memcached() removed_sysconfig_file = paths.SYSCONFIG_HTTPD if fstore.has_file(removed_sysconfig_file): logger.info('Restoring %s as it is no longer required', removed_sysconfig_file) fstore.restore_file(removed_sysconfig_file) http = httpinstance.HTTPInstance(fstore) http.fqdn = fqdn http.realm = api.env.realm http.suffix = ipautil.realm_to_suffix(api.env.realm) http.configure_selinux_for_httpd() http.change_mod_nss_port_from_http() http.configure_certmonger_renewal_guard() http.enable_and_start_oddjobd() ds.configure_dirsrv_ccache() ntpinstance.ntp_ldap_enable(api.env.host, api.env.basedn, api.env.realm) ds.stop(ds_serverid) fix_schema_file_syntax() remove_ds_ra_cert(subject_base) ds.start(ds_serverid) ds.fqdn = fqdn ds.realm = api.env.realm ds.suffix = ipautil.realm_to_suffix(api.env.realm) ds_enable_sidgen_extdom_plugins(ds) if not http.is_kdcproxy_configured(): logger.info('[Enabling KDC Proxy]') http.create_kdcproxy_conf() http.enable_kdcproxy() http.stop() disable_httpd_system_trust(http) update_ipa_httpd_service_conf(http) update_mod_nss_protocol(http) update_mod_nss_cipher_suite(http) disable_mod_nss_ocsp(http) fix_trust_flags() update_http_keytab(http) http.configure_gssproxy() http.start() uninstall_selfsign(ds, http) uninstall_dogtag_9(ds, http) simple_service_list = ( (otpdinstance.OtpdInstance(), 'OTPD'), ) for service, ldap_name in simple_service_list: try: if not service.is_configured(): service.create_instance(ldap_name, fqdn, ipautil.realm_to_suffix(api.env.realm), realm=api.env.realm) except ipalib.errors.DuplicateEntry: pass # install DNSKeySync service only if DNS is configured on server if bindinstance.named_conf_exists(): dnskeysyncd = dnskeysyncinstance.DNSKeySyncInstance(fstore) if not dnskeysyncd.is_configured(): dnskeysyncd.create_instance(fqdn, api.env.realm) dnskeysyncd.start_dnskeysyncd() cleanup_kdc(fstore) cleanup_adtrust(fstore) cleanup_dogtag() upgrade_adtrust_config() bind = bindinstance.BindInstance(fstore) if bind.is_configured() and not bind.is_running(): # some upgrade steps may require bind running bind_started = True bind.start() else: bind_started = False add_ca_dns_records() # Any of the following functions returns True iff the named.conf file # has been altered named_conf_changes = ( named_remove_deprecated_options(), named_set_minimum_connections(), named_update_gssapi_configuration(), named_update_pid_file(), named_enable_dnssec(), named_validate_dnssec(), named_bindkey_file_option(), named_managed_keys_dir_option(), named_root_key_include(), named_update_global_forwarder_policy(), mask_named_regular(), fix_dyndb_ldap_workdir_permissions(), named_add_server_id(), ) if any(named_conf_changes): # configuration has changed, restart the name server logger.info('Changes to named.conf have been made, restart named') bind = bindinstance.BindInstance(fstore) try: if bind.is_running(): bind.restart() except ipautil.CalledProcessError as e: logger.error("Failed to restart %s: %s", bind.service_name, e) if bind_started: bind.stop() custodia = custodiainstance.CustodiaInstance(api.env.host, api.env.realm) custodia.upgrade_instance() ca_restart = any([ ca_restart, ca_upgrade_schema(ca), upgrade_ca_audit_cert_validity(ca), certificate_renewal_update(ca, ds, http), ca_enable_pkix(ca), ca_configure_profiles_acl(ca), ca_configure_lightweight_ca_acls(ca), ca_ensure_lightweight_cas_container(ca), ca_add_default_ocsp_uri(ca), ]) if ca_restart: logger.info( 'pki-tomcat configuration changed, restart pki-tomcat') try: ca.restart('pki-tomcat') except ipautil.CalledProcessError as e: logger.error("Failed to restart %s: %s", ca.service_name, e) ca_enable_ldap_profile_subsystem(ca) # This step MUST be done after ca_enable_ldap_profile_subsystem and # ca_configure_profiles_acl, and the consequent restart, but does not # itself require a restart. # ca_import_included_profiles(ca) add_default_caacl(ca) if ca.is_configured(): cainstance.repair_profile_caIPAserviceCert() ca.setup_lightweight_ca_key_retrieval() cainstance.ensure_ipa_authority_entry() set_sssd_domain_option('ipa_server_mode', 'True') set_sssd_domain_option('ipa_server', api.env.host) sssdconfig = SSSDConfig.SSSDConfig() sssdconfig.import_config() sssd_enable_service(sssdconfig, 'ifp') sssd = services.service('sssd', api) sssd.restart() krb = krbinstance.KrbInstance(fstore) krb.fqdn = fqdn krb.realm = api.env.realm krb.suffix = ipautil.realm_to_suffix(krb.realm) krb.subject_base = subject_base krb.sub_dict = dict(FQDN=krb.fqdn, SUFFIX=krb.suffix, DOMAIN=api.env.domain, HOST=api.env.host, SERVER_ID=installutils.realm_to_serverid(krb.realm), REALM=krb.realm, KRB5KDC_KADM5_ACL=paths.KRB5KDC_KADM5_ACL, DICT_WORDS=paths.DICT_WORDS, KRB5KDC_KADM5_KEYTAB=paths.KRB5KDC_KADM5_KEYTAB, KDC_CERT=paths.KDC_CERT, KDC_KEY=paths.KDC_KEY, CACERT_PEM=paths.CACERT_PEM, KDC_CA_BUNDLE_PEM=paths.KDC_CA_BUNDLE_PEM, CA_BUNDLE_PEM=paths.CA_BUNDLE_PEM) krb.add_anonymous_principal() setup_pkinit(krb) enable_certauth(krb) if not ds_running: ds.stop(ds_serverid) if ca.is_configured(): if ca_running and not ca.is_running(): ca.start('pki-tomcat') elif not ca_running and ca.is_running(): ca.stop('pki-tomcat') def upgrade_check(options): try: installutils.check_server_configuration() tasks.check_ipv6_stack_enabled() except RuntimeError as e: logger.error("%s", e) sys.exit(1) if not options.skip_version_check: # check IPA version and data version try: installutils.check_version() except (installutils.UpgradePlatformError, installutils.UpgradeDataNewerVersionError) as e: raise RuntimeError( 'Unable to execute IPA upgrade: %s' % e, 1) except installutils.UpgradeMissingVersionError as e: logger.info("Missing version: %s", e) except installutils.UpgradeVersionError: # Ignore other errors pass else: logger.info("Skipping version check") logger.warning("Upgrade without version check may break your system") def upgrade(): realm = api.env.realm schema_files = [os.path.join(paths.USR_SHARE_IPA_DIR, f) for f in dsinstance.ALL_SCHEMA_FILES] schema_files.extend(dsinstance.get_all_external_schema_files( paths.EXTERNAL_SCHEMA_DIR)) data_upgrade = IPAUpgrade(realm, schema_files=schema_files) try: data_upgrade.create_instance() except BadSyntax: raise RuntimeError( 'Bad syntax detected in upgrade file(s).', 1) except RuntimeError: raise RuntimeError('IPA upgrade failed.', 1) else: if data_upgrade.modified: logger.info('Update complete') else: logger.info('Update complete, no data were modified') # store new data version after upgrade installutils.store_version() print('Upgrading IPA services') logger.info('Upgrading the configuration of the IPA services') upgrade_configuration() logger.info('The IPA services were upgraded')