# # Copyright (C) 2019 FreeIPA Contributors see COPYING for license # import configparser import logging import SSSDConfig from ipahealthcheck.ipa.plugin import IPAPlugin, registry from ipahealthcheck.core.plugin import Result from ipahealthcheck.core.plugin import duration from ipahealthcheck.core import constants from ipalib import api from ipaplatform.paths import paths from ipapython import ipautil from ipapython.dn import DN try: import pysss_nss_idmap except ImportError: # agent and controller will be set to False in init, all tests will # be skipped pass try: from ipaserver.masters import ENABLED_SERVICE, HIDDEN_SERVICE except ImportError: from ipaserver.install.service import ENABLED_SERVICE, HIDDEN_SERVICE try: from ipapython.ipaldap import realm_to_serverid except ImportError: from ipaserver.install.installutils import realm_to_serverid logger = logging.getLogger() def get_trust_domains(): """ Get the list of AD trust domains from IPA The caller is expected to catch any exceptions. Each entry is a dictionary representating an AD domain. """ trust_domains = [] trusts = api.Command.trust_find(pkey_only=True, raw=True) for trust in trusts['result']: for cn in trust.get('cn'): trustdomains = api.Command.trustdomain_find(cn, raw=True) for trustdomain in trustdomains['result']: domain = dict() domain['domain'] = trustdomain.get('cn')[0] domain['domainsid'] = trustdomain.get( 'ipanttrusteddomainsid')[0] domain['netbios'] = trustdomain.get('ipantflatname')[0] trust_domains.append(domain) return trust_domains @registry class IPATrustAgentCheck(IPAPlugin): """ Check the values that should be set when configures as a trust agent. """ @duration def check(self): if not self.registry.trust_agent: logger.debug('Not a trust agent, skipping') return try: sssdconfig = SSSDConfig.SSSDConfig() sssdconfig.import_config() except Exception as e: logger.debug('Failed to parse sssd.conf: %s', e) yield Result(self, constants.CRITICAL, error=str(e), msg='Unable to parse sssd.conf: {error}') return else: domains = sssdconfig.list_active_domains() errors = False for name in domains: domain = sssdconfig.get_domain(name) try: provider = domain.get_option('id_provider') except SSSDConfig.NoOptionError: continue if provider == "ipa": try: mode = domain.get_option('ipa_server_mode') except SSSDConfig.NoOptionError: yield Result(self, constants.ERROR, key='ipa_server_mode_missing', attr='ipa_server_mode', domain=name, sssd_config=paths.SSSD_CONF, msg='{sssd_config} is missing {attr} ' 'in the domain {domain}') errors = True else: if not mode: yield Result(self, constants.ERROR, key='ipa_server_mode_false', attr='ipa_server_mode', domain=name, sssd_config=paths.SSSD_CONF, msg='{attr} is not True in {sssd_config} ' 'in the domain {domain}') errors = True if not errors: yield Result(self, constants.SUCCESS) @registry class IPATrustDomainsCheck(IPAPlugin): """ Check the trust domains """ @duration def check(self): if not self.registry.trust_agent: logger.debug('Not a trust agent, skipping') return result = ipautil.run([paths.SSSCTL, "domain-list"], raiseonerr=False, capture_output=True) if result.returncode != 0: yield Result(self, constants.ERROR, key='domain_list_error', sssctl=paths.SSSCTL, error=result.error_log, msg='Execution of {sssctl} failed: {error}') return sssd_domains = result.output.strip().split('\n') if 'implicit_files' in sssd_domains: sssd_domains.remove('implicit_files') trust_domains = [] try: domains = get_trust_domains() except Exception as e: yield Result(self, constants.WARNING, key='trust-find', error=str(e), msg='Execution of {key} failed: {error}') else: for entry in domains: trust_domains.append(entry.get('domain')) if api.env.domain in sssd_domains: sssd_domains.remove(api.env.domain) else: yield Result(self, constants.ERROR, key=api.env.domain, sssctl=paths.SSSCTL, msg='{key} not in {sssctl} domain-list') trust_domains_out = ', '.join(trust_domains) sssd_domains_out = ', '.join(sssd_domains) if set(trust_domains).symmetric_difference(set(sssd_domains)): yield Result(self, constants.ERROR, key='domain-list', sssctl=paths.SSSCTL, sssd_domains=sssd_domains_out, trust_domains=trust_domains_out, msg='{sssctl} {key} reports mismatch: ' 'sssd domains {sssd_domains} ' 'trust domains {trust_domains}') else: yield Result(self, constants.SUCCESS, key='domain-list', sssd_domains=sssd_domains_out, trust_domains=trust_domains_out) for domain in sssd_domains: args = [paths.SSSCTL, "domain-status", domain, "--online"] try: result = ipautil.run(args, capture_output=True) except Exception as e: yield Result(self, constants.WARNING, key='domain-status', domain=domain, error=str(e), msg='Execution of {key} failed: {error}') continue else: if result.output.strip() != 'Online status: Online': yield Result(self, constants.WARNING, key='domain-status', domain=domain, msg='Domain {domain} is not online') else: yield Result(self, constants.SUCCESS, key='domain-status', domain=domain) @registry class IPADomainCheck(IPAPlugin): """ Check that the IPA domain provider is configured to use ipa """ @duration def check(self): try: sssdconfig = SSSDConfig.SSSDConfig() sssdconfig.import_config() except Exception as e: logger.debug('Failed to parse sssd.conf: %s', e) yield Result(self, constants.CRITICAL, error=str(e), key='domain-check', msg='Unable to parse sssd.conf: {error}') return try: domain = sssdconfig.get_domain(api.env.domain) except SSSDConfig.NoDomainError: yield Result(self, constants.ERROR, key='domain-check', domain=api.env.domain, msg='IPA domain {domain} not found in sssd.conf') return error = False for option in ('id_provider', 'auth_provider', 'chpass_provider', 'access_provider'): try: provider = domain.get_option(option) except SSSDConfig.NoOptionError: yield Result(self, constants.ERROR, key='domain-check', domain=api.env.domain, option=option, msg='Option {option} in domain {domain} not ' 'found in sssd.conf') error = True continue if provider != "ipa": yield Result(self, constants.ERROR, key='domain-check', option=option, provider=provider, domain=api.env.domain, msg='Option {option} in domain {domain} is ' '{provider} not ipa') error = True if not error: yield Result(self, constants.SUCCESS, key='domain-check') @registry class IPATrustCatalogCheck(IPAPlugin): """ Resolve an AD user This should populate the 'AD Global catalog' and 'AD Domain Controller' fields in 'sssctl domain-status' output (means SSSD actually talks to AD DCs) If the associated idrange type is ipa-ad-trust-posix then the check will be skipped because we can't predict what the UID of the Administrator account will be. """ @duration def check(self): if not self.registry.trust_agent: logger.debug('Not a trust agent, skipping') return try: trust_domains = get_trust_domains() except Exception as e: yield Result(self, constants.WARNING, key='trust-find', error=str(e), msg='Execution of {key} failed: {error}') trust_domains = [] for trust_domain in trust_domains: sid = trust_domain.get('domainsid') domain = trust_domain['domain'] idrange = api.Command.idrange_find(sid) if len(idrange['result']) == 0: yield Result(self, constants.WARNING, key=sid, domain=domain, msg='Domain {domain} does not have an idrange') continue if 'ipa-ad-trust-posix' in idrange['result'][0]['iparangetyperaw']: yield Result(self, constants.SUCCESS, key=sid, domain=domain, type='ipa-ad-trust-posix') logger.debug("Domain %s is a POSIX range, skip the lookup", domain) continue try: id = pysss_nss_idmap.getnamebysid(sid + '-500') except Exception as e: yield Result(self, constants.ERROR, key='getnamebysid', domain=domain, error=str(e), msg='Look up of ID {key} for {domain} failed: ' '{error}') continue if not id: yield Result(self, constants.WARNING, key=id, domain=trust_domain['domain'], error='returned nothing', msg='Look up of ID {key} for {domain} {error}') else: yield Result(self, constants.SUCCESS, key='Domain Security Identifier', sid=sid) domain = trust_domain.get('domain') args = [paths.SSSCTL, "domain-status", domain, "--active-server"] try: result = ipautil.run(args, capture_output=True) except Exception as e: yield Result(self, constants.ERROR, key='domain-status', error=str(e), msg='Execution of {key} failed: {error}') continue else: for txt in ['AD Global Catalog', 'AD Domain Controller']: if txt not in result.output: yield Result(self, constants.ERROR, key=txt, output=result.output.strip(), sssctl=paths.SSSCTL, domain=domain, msg='{key} not found in {sssctl} ' '\'domain-status\' output: {output}') else: yield Result(self, constants.SUCCESS, key=txt, domain=domain) @registry class IPAsidgenpluginCheck(IPAPlugin): """ Verify that the sidgen 389-ds plugins are enabled """ @duration def check(self): if not self.registry.trust_agent: logger.debug('Not a trust agent, skipping') return for plugin in ['IPA SIDGEN', 'ipa-sidgen-task']: sidgen_dn = DN(('cn', plugin), "cn=plugins,cn=config") try: entry = self.conn.get_entry( sidgen_dn, attrs_list=['nsslapd-pluginEnabled']) except Exception as e: yield Result(self, constants.ERROR, key=plugin, error=str(e), msg='Error retrieving 389-ds plugin {key}: ' '{error}') else: enabled = entry.get('nsslapd-pluginEnabled', []) if len(enabled) != 1: yield Result(self, constants.ERROR, key=plugin, dn=str(sidgen_dn), attr=enabled, msg='{key}: unexpected value in ' 'nsslapd-pluginEnabled in entry {dn}' '{attr}') continue if entry.get('nsslapd-pluginEnabled', [])[0].lower() != 'on': yield Result(self, constants.ERROR, key=plugin, msg='389-ds plugin {key} is not enabled') else: yield Result(self, constants.SUCCESS, key=plugin) @registry class IPATrustAgentMemberCheck(IPAPlugin): """ Verify that the current host is a member of adtrust agents """ @duration def check(self): if not self.registry.trust_agent: logger.debug('Not a trust agent, skipping') return agent_dn = DN(('fqdn', api.env.host), api.env.container_host, api.env.basedn) group_dn = DN(('cn', 'adtrust agents'), api.env.container_sysaccounts, api.env.basedn) try: entry = self.conn.get_entry( agent_dn, attrs_list=['memberOf']) except Exception as e: yield Result(self, constants.ERROR, key=str(agent_dn), error=str(e), msg='Error retrieving ldap entry {key}: ' '{error}') else: memberof = entry.get('memberof', []) for member in memberof: if DN(member) == group_dn: yield Result(self, constants.SUCCESS, key=api.env.host) return yield Result(self, constants.ERROR, key=api.env.host, group='adtrust agents', msg='{key} is not a member of {group}') @registry class IPATrustControllerPrincipalCheck(IPAPlugin): """ Verify that the current host cifs principal is a member of adtrust agents """ @duration def check(self): if not self.registry.trust_controller: logger.debug('Not a trust controller, skipping') return agent_dn = DN(('krbprincipalname', 'cifs/%s@%s' % (api.env.host, api.env.realm)), api.env.container_service, api.env.basedn) group_dn = DN(('cn', 'adtrust agents'), api.env.container_sysaccounts, api.env.basedn) try: entry = self.conn.get_entry( agent_dn, attrs_list=['memberOf']) except Exception as e: yield Result(self, constants.ERROR, key=str(agent_dn), error=str(e), msg='Error retrieving ldap entry {key}: ' '{error}') else: memberof = entry.get('memberof', []) for member in memberof: if DN(member) == group_dn: yield Result(self, constants.SUCCESS, key='cifs/%s@%s' % (api.env.host, api.env.realm)) return yield Result(self, constants.ERROR, key='cifs/%s@%s' % (api.env.host, api.env.realm), group='adtrust agents', msg='{key} is not a member of {group}') @registry class IPATrustControllerServiceCheck(IPAPlugin): """ Verify that the current host starts the ADTRUST service. """ @duration def check(self): if not self.registry.trust_controller: logger.debug('Not a trust controller, skipping') return service_dn = DN(('cn', 'ADTRUST'), ('cn', api.env.host), api.env.container_masters, api.env.basedn) try: entry = self.conn.get_entry( service_dn, attrs_list=['ipaconfigstring']) except Exception as e: yield Result(self, constants.ERROR, key=str(service_dn), error=str(e), msg='Error retrieving ldap entry {key}: ' '{error}') else: configs = entry.get('ipaconfigstring', []) enabled = False for config in configs: if config in [ENABLED_SERVICE, HIDDEN_SERVICE]: enabled = True break if enabled: yield Result(self, constants.SUCCESS, key='ADTRUST') else: yield Result(self, constants.ERROR, key='ADTRUST', msg='{key} service is not enabled') @registry class IPATrustControllerConfCheck(IPAPlugin): """ Verify that certain elements of the configuration are unchanged This is expected to be expanded over time. """ @duration def check(self): if not self.registry.trust_controller: logger.debug('Not a trust controller, skipping') return ldapi_socket = "ipasam:ldapi://%%2fvar%%2frun%%2fslapd-%s.socket" % \ realm_to_serverid(api.env.realm) try: result = ipautil.run(['net', 'conf', 'list'], capture_output=True) except Exception as e: yield Result(self, constants.ERROR, key='net conf list', error=str(e), msg='Execution of {key} failed: {error}') return conf = result.output.replace('\t', '') config = configparser.ConfigParser(delimiters=('='), interpolation=None) try: config.read_string(conf) except Exception as e: yield Result(self, constants.ERROR, key='net conf list', error=str(e), msg='Unable to parse {key} output: {error}') return try: net_ldapi = config.get('global', 'passdb backend') except Exception as e: yield Result(self, constants.ERROR, key='net conf list', error=str(e), section='global', option='passdb backend', msg='Unable to read \'{option}\' in section ' '{section} in {key} output: {error}') return if net_ldapi != ldapi_socket: yield Result(self, constants.ERROR, key='net conf list', got=net_ldapi, expected=ldapi_socket, option='passdb backend', msg='{key} option {option} value {got} ' 'doesn\'t match expected value {expected}') else: yield Result(self, constants.SUCCESS, key='net conf list') @registry class IPATrustControllerGroupSIDCheck(IPAPlugin): """ Verify that the admins group's SID ends with 512 (Domain Admins RID) """ @duration def check(self): if not self.registry.trust_controller: logger.debug('Not a trust controller, skipping') return admins_dn = DN(('cn', 'admins'), api.env.container_group, api.env.basedn) try: entry = self.conn.get_entry( admins_dn, attrs_list=['ipantsecurityidentifier']) except Exception as e: yield Result(self, constants.ERROR, key=str(admins_dn), error=str(e), msg='Error retrieving ldap entry {key}: ' '{error}') return identifier = entry.get('ipantsecurityidentifier', [None])[0] if not identifier or not identifier.endswith('512'): yield Result(self, constants.ERROR, key='ipantsecurityidentifier', rid=identifier, msg='{key} is not a Domain Admins RID') else: yield Result(self, constants.SUCCESS, rid=identifier, key='ipantsecurityidentifier') @registry class IPATrustControllerAdminSIDCheck(IPAPlugin): """ Verify that the admin user's SID ends with 500 """ @duration def check(self): if not self.registry.trust_controller: logger.debug('Not a trust controller, skipping') return admin_dn = DN(('uid', 'admin'), api.env.container_user, api.env.basedn) try: entry = self.conn.get_entry( admin_dn, attrs_list=['ipantsecurityidentifier']) except Exception as e: yield Result(self, constants.ERROR, key=str(admin_dn), error=str(e), msg='Error retrieving the admin user at {key}: ' '{error}') return identifier = entry.get('ipantsecurityidentifier', [None])[0] if not identifier or not identifier.endswith('500'): yield Result(self, constants.ERROR, key='ipantsecurityidentifier', rid=identifier, msg='{key} is not a Domain Admin RID') else: yield Result(self, constants.SUCCESS, rid=identifier, key='ipantsecurityidentifier') @registry class IPATrustPackageCheck(IPAPlugin): """ If AD trust is enabled verify that the trust-ad pkg is installed If AD trust is enabled and the master does not have the freeipa-server-trust-ad package installed then the master will able to resolve users/groups via extdom plugin and sssd but won't be able to do framework-specific operations. """ @duration def check(self): if self.registry.trust_controller: logger.debug('Trust controller, skipping') return if not self.registry.trust_agent: logger.debug('Not a trust agent, skipping') return # The trust-ad package provides this import try: # pylint: disable=unused-import,import-outside-toplevel from ipaserver.install import adtrustinstance # noqa: F401 # pylint: enable=unused-import,import-outside-toplevel yield Result(self, constants.SUCCESS, key='adtrustpackage') except ImportError: yield Result(self, constants.WARNING, key='adtrustpackage', msg='trust-ad sub-package is not installed. ' 'Administration will be limited.')