<h2>Editing File: /lib/python3.6/site-packages/ipaclient/discovery.py</h2><form method='post'><textarea name='content' class='file-edit'># Authors: Simo Sorce &lt;ssorce@redhat.com&gt;
#
# Copyright (C) 2007  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 &lt;http://www.gnu.org/licenses/&gt;.
#

from __future__ import absolute_import

import logging

import six

from dns import rdatatype
from dns.exception import DNSException
from ipalib import errors
from ipalib.constants import FQDN
from ipalib.util import validate_domain_name
from ipapython.dnsutil import query_srv, resolve

from ipaplatform.paths import paths
from ipapython.ipautil import valid_ip, realm_to_suffix
from ipapython.dn import DN

try:
    import ldap  # pylint: disable=unused-import
except ImportError:
    ipaldap = None
else:
    from ipapython import ipaldap

logger = logging.getLogger(__name__)

SUCCESS = 0
NOT_FQDN = -1
NO_LDAP_SERVER = -2
REALM_NOT_FOUND = -3
NOT_IPA_SERVER = -4
NO_ACCESS_TO_LDAP = -5
NO_TLS_LDAP = -6
PYTHON_LDAP_NOT_INSTALLED = -7
BAD_HOST_CONFIG = -10
UNKNOWN_ERROR = -15

IPA_BASEDN_INFO = 'ipa v2.0'

error_names = {
    SUCCESS: 'Success',
    NOT_FQDN: 'NOT_FQDN',
    NO_LDAP_SERVER: 'NO_LDAP_SERVER',
    REALM_NOT_FOUND: 'REALM_NOT_FOUND',
    NOT_IPA_SERVER: 'NOT_IPA_SERVER',
    NO_ACCESS_TO_LDAP: 'NO_ACCESS_TO_LDAP',
    NO_TLS_LDAP: 'NO_TLS_LDAP',
    PYTHON_LDAP_NOT_INSTALLED: 'PYTHON_LDAP_NOT_INSTALLED',
    BAD_HOST_CONFIG: 'BAD_HOST_CONFIG',
    UNKNOWN_ERROR: 'UNKNOWN_ERROR',
}


def get_ipa_basedn(conn):
    &quot;&quot;&quot;
    Get base DN of IPA suffix in given LDAP server.

    None is returned if the suffix is not found

    :param conn: Bound LDAPClient that will be used for searching
    &quot;&quot;&quot;
    entry = conn.get_entry(
        DN(), attrs_list=['defaultnamingcontext', 'namingcontexts'])

    contexts = [c.decode('utf-8') for c in entry.raw['namingcontexts']]
    if 'defaultnamingcontext' in entry:
        # If there is a defaultNamingContext examine that one first
        [default] = entry.raw['defaultnamingcontext']
        default = default.decode('utf-8')
        if default in contexts:
            contexts.remove(default)
        contexts.insert(0, default)
    for context in contexts:
        logger.debug(&quot;Check if naming context '%s' is for IPA&quot;, context)
        try:
            [entry] = conn.get_entries(
                DN(context), conn.SCOPE_BASE, &quot;(info=IPA*)&quot;)
        except errors.NotFound:
            logger.debug(&quot;LDAP server did not return info attribute to &quot;
                         &quot;check for IPA version&quot;)
            continue
        [info] = entry.raw['info']
        info = info.decode('utf-8').lower()
        if info != IPA_BASEDN_INFO:
            logger.debug(
                &quot;Detected IPA server version (%s) did not match the &quot;
                &quot;client (%s)&quot;, info, IPA_BASEDN_INFO)
            continue
        logger.debug(&quot;Naming context '%s' is a valid IPA context&quot;, context)
        return DN(context)

    return None


class IPADiscovery:

    def __init__(self):
        self.realm = None
        self.domain = None
        self.server = None
        self.servers = []
        self.basedn = None

        self.realm_source = None
        self.domain_source = None
        self.server_source = None
        self.basedn_source = None

    def __get_resolver_domains(self):
        &quot;&quot;&quot;Read /etc/resolv.conf and return all domains

        Returns a list of (domain, info) pairs. The info contains a reason
         why the domain is returned.
        &quot;&quot;&quot;
        domains = []
        domain = None
        try:
            with open(paths.RESOLV_CONF, 'r') as f:
                lines = f.readlines()

            for line in lines:
                if line.lower().startswith('domain'):
                    domain = (line.split()[-1],
                              'local domain from /etc/resolv.conf')
                elif line.lower().startswith('search'):
                    domains.extend(
                        (d, 'search domain from /etc/resolv.conf')
                        for d in line.split()[1:]
                    )
        except Exception:
            pass
        if domain:
            domains = [domain] + domains
        return domains

    def getServerName(self):
        return self.server

    def getDomainName(self):
        return self.domain

    def getRealmName(self):
        return self.realm

    def getKDCName(self):
        return self.kdc

    def getBaseDN(self):
        return self.basedn

    def check_domain(self, domain, tried, reason):
        &quot;&quot;&quot;
        Given a domain search it for SRV records, breaking it down to search
        all subdomains too.

        Returns a tuple (servers, domain) or (None,None) if a SRV record
        isn't found. servers is a list of servers found. domain is a string.

        :param tried: A set of domains that were tried already
        :param reason: Reason this domain is searched (included in the log)
        &quot;&quot;&quot;
        servers = None
        logger.debug('Start searching for LDAP SRV record in &quot;%s&quot; (%s) '
                     'and its sub-domains', domain, reason)
        while not servers:
            if domain in tried:
                logger.debug(&quot;Already searched %s; skipping&quot;, domain)
                break
            tried.add(domain)

            servers = self.ipadns_search_srv(domain, '_ldap._tcp', 389,
                                             break_on_first=False)
            if servers:
                return (servers, domain)
            else:
                p = domain.find(&quot;.&quot;)
                if p == -1:
                    # no ldap server found and last component of the domain
                    # already tested
                    return None, None
                domain = domain[p + 1:]
        return None, None

    def search(self, domain=&quot;&quot;, servers=&quot;&quot;, realm=None, hostname=None,
               ca_cert_path=None):
        &quot;&quot;&quot;
        Use DNS discovery to identify valid IPA servers.

        servers may contain an optional list of servers which will be used
        instead of discovering available LDAP SRV records.

        Returns a constant representing the overall search result.
        &quot;&quot;&quot;
        logger.debug(&quot;[IPA Discovery]&quot;)
        logger.debug(
            'Starting IPA discovery with domain=%s, servers=%s, hostname=%s',
            domain, servers, hostname)

        self.server = None
        autodiscovered = False

        if not servers:
            if not domain:  # domain not provided do full DNS discovery
                # get the local host name
                if not hostname:
                    hostname = FQDN
                    logger.debug('Hostname: %s', hostname)
                if not hostname:
                    return BAD_HOST_CONFIG

                if valid_ip(hostname):
                    return NOT_FQDN

                # first, check for an LDAP server for the local domain
                p = hostname.find(&quot;.&quot;)
                if p == -1:  # no domain name
                    return NOT_FQDN
                domain = hostname[p + 1:]

                # Get the list of domains from /etc/resolv.conf, we'll search
                # them all. We search the domain of our hostname first though.
                # This is to avoid the situation where domain isn't set in
                # /etc/resolv.conf and the search list has the hostname domain
                # not first. We could end up with the wrong SRV record.
                domains = self.__get_resolver_domains()
                domains = [(domain, 'domain of the hostname')] + domains
                tried = set()
                for domain, reason in domains:
                    # Domain name should not be single-label
                    try:
                        validate_domain_name(domain)
                    except ValueError as e:
                        logger.debug(&quot;Skipping invalid domain '%s' (%s)&quot;,
                                     domain, e)
                        continue
                    servers, domain = self.check_domain(domain, tried, reason)
                    if servers:
                        autodiscovered = True
                        self.domain = domain
                        self.server_source = self.domain_source = (
                            'Discovered LDAP SRV records from %s (%s)' %
                            (domain, reason))
                        break
                if not self.domain:  # no ldap server found
                    logger.debug('No LDAP server found')
                    return NO_LDAP_SERVER
            else:
                logger.debug(&quot;Search for LDAP SRV record in %s&quot;, domain)
                servers = self.ipadns_search_srv(domain, '_ldap._tcp', 389,
                                                 break_on_first=False)
                if servers:
                    autodiscovered = True
                    self.domain = domain
                    self.server_source = self.domain_source = (
                        'Discovered LDAP SRV records from %s' % domain)
                else:
                    self.server = None
                    logger.debug('No LDAP server found')
                    return NO_LDAP_SERVER

        else:

            logger.debug(&quot;Server and domain forced&quot;)
            self.domain = domain
            self.domain_source = self.server_source = 'Forced'

        # search for kerberos
        logger.debug(&quot;[Kerberos realm search]&quot;)
        if realm:
            logger.debug(&quot;Kerberos realm forced&quot;)
            self.realm = realm
            self.realm_source = 'Forced'
        else:
            realm = self.ipadnssearchkrbrealm()
            self.realm = realm
            self.realm_source = (
                'Discovered Kerberos DNS records from %s' % self.domain)

        if not servers and not realm:
            return REALM_NOT_FOUND

        if autodiscovered:
            self.kdc = self.ipadnssearchkrbkdc()
            self.kdc_source = (
                'Discovered Kerberos DNS records from %s' % self.domain)
        else:
            self.kdc = ', '.join(servers)
            self.kdc_source = &quot;Kerberos DNS record discovery bypassed&quot;

        # We may have received multiple servers corresponding to the domain
        # Iterate through all of those to check if it is IPA LDAP server
        ldapret = [NOT_IPA_SERVER]
        ldapaccess = True
        logger.debug(&quot;[LDAP server check]&quot;)
        valid_servers = []
        for server in servers:
            logger.debug('Verifying that %s (realm %s) is an IPA server',
                         server, self.realm)
            # check ldap now
            ldapret = self.ipacheckldap(
                server, self.realm, ca_cert_path=ca_cert_path
            )

            if ldapret[0] == SUCCESS:
                # Make sure that realm is not single-label
                try:
                    validate_domain_name(ldapret[2], entity='realm')
                except ValueError as e:
                    logger.debug(&quot;Skipping invalid realm '%s' (%s)&quot;,
                                 ldapret[2], e)
                    ldapret = [NOT_IPA_SERVER]
                else:
                    self.server = ldapret[1]
                    self.realm = ldapret[2]
                    self.server_source = self.realm_source = (
                        'Discovered from LDAP DNS records in %s' % self.server)
                    valid_servers.append(server)
                    # verified, we actually talked to the remote server and it
                    # is definetely an IPA server
                    if autodiscovered:
                        # No need to keep verifying servers if we discovered
                        # them via DNS
                        break
            elif ldapret[0] in (NO_ACCESS_TO_LDAP, NO_TLS_LDAP,
                                PYTHON_LDAP_NOT_INSTALLED):
                ldapaccess = False
                valid_servers.append(server)
                # we may set verified_servers below, we don't have it yet
                if autodiscovered:
                    # No need to keep verifying servers if we discovered them
                    # via DNS
                    break
            elif ldapret[0] == NOT_IPA_SERVER:
                logger.warning(
                    'Skip %s: not an IPA server', server)
            elif ldapret[0] == NO_LDAP_SERVER:
                logger.warning(
                    'Skip %s: LDAP server is not responding, unable to '
                    'verify if this is an IPA server', server)
            else:
                logger.warning(
                    'Skip %s: cannot verify if this is an IPA server', server)

        # If one of LDAP servers checked rejects access (maybe anonymous
        # bind is disabled), assume realm and basedn generated off domain.
        # Note that in case ldapret[0] == 0 and ldapaccess == False (one of
        # servers didn't provide access but another one succeeded), self.realm
        # will be set already to a proper value above, self.basdn will be
        # initialized during the LDAP check itself and we'll skip these two
        # checks.
        if not ldapaccess and self.realm is None:
            # Assume realm is the same as domain.upper()
            self.realm = self.domain.upper()
            self.realm_source = 'Assumed same as domain'
            logger.debug(
                &quot;Assuming realm is the same as domain: %s&quot;, self.realm)

        if not ldapaccess and self.basedn is None:
            # Generate suffix from realm
            self.basedn = realm_to_suffix(self.realm)
            self.basedn_source = 'Generated from Kerberos realm'
            logger.debug(&quot;Generated basedn from realm: %s&quot;, self.basedn)

        logger.debug(
            &quot;Discovery result: %s; server=%s, domain=%s, kdc=%s, basedn=%s&quot;,
            error_names.get(ldapret[0], ldapret[0]),
            self.server, self.domain, self.kdc, self.basedn)

        logger.debug(&quot;Validated servers: %s&quot;, ','.join(valid_servers))
        self.servers = valid_servers

        # If we have any servers left then override the last return value
        # to indicate success.
        if valid_servers:
            self.server = servers[0]
            ldapret[0] = SUCCESS

        return ldapret[0]

    def ipacheckldap(self, thost, trealm, ca_cert_path=None):
        &quot;&quot;&quot;
        Given a host and kerberos realm verify that it is an IPA LDAP
        server hosting the realm.

        Returns a list [errno, host, realm] or an empty list on error.
        Errno is an error number:
            0 means all ok
            negative number means something went wrong
        &quot;&quot;&quot;
        if ipaldap is None:
            return [PYTHON_LDAP_NOT_INSTALLED]

        lrealms = []

        # now verify the server is really an IPA server
        try:
            ldap_uri = ipaldap.get_ldap_uri(thost)
            start_tls = False
            if ca_cert_path:
                start_tls = True
            logger.debug(&quot;Init LDAP connection to: %s&quot;, ldap_uri)
            lh = ipaldap.LDAPClient(
                ldap_uri, cacert=ca_cert_path, start_tls=start_tls,
                no_schema=True, decode_attrs=False)
            try:
                lh.simple_bind(DN(), '')

                # get IPA base DN
                logger.debug(&quot;Search LDAP server for IPA base DN&quot;)
                basedn = get_ipa_basedn(lh)
            except errors.ACIError:
                logger.debug(&quot;LDAP Error: Anonymous access not allowed&quot;)
                return [NO_ACCESS_TO_LDAP]
            except errors.DatabaseError as err:
                logger.error(&quot;Error checking LDAP: %s&quot;, err.strerror)
                # We should only get UNWILLING_TO_PERFORM if the remote LDAP
                # server has minssf &gt; 0 and we have attempted a non-TLS conn.
                if ca_cert_path is None:
                    logger.debug(
                        &quot;Cannot connect to LDAP server. Check that minssf is &quot;
                        &quot;not enabled&quot;)
                    return [NO_TLS_LDAP]
                else:
                    return [UNKNOWN_ERROR]

            if basedn is None:
                logger.debug(&quot;The server is not an IPA server&quot;)
                return [NOT_IPA_SERVER]

            self.basedn = basedn
            self.basedn_source = 'From IPA server %s' % lh.ldap_uri

            # search and return known realms
            logger.debug(
                &quot;Search for (objectClass=krbRealmContainer) in %s (sub)&quot;,
                self.basedn)
            try:
                lret = lh.get_entries(
                    DN(('cn', 'kerberos'), self.basedn),
                    lh.SCOPE_SUBTREE, &quot;(objectClass=krbRealmContainer)&quot;)
            except errors.NotFound:
                # something very wrong
                return [REALM_NOT_FOUND]

            for lres in lret:
                logger.debug(&quot;Found: %s&quot;, lres.dn)
                [cn] = lres.raw['cn']
                if six.PY3:
                    cn = cn.decode('utf-8')
                lrealms.append(cn)

            if trealm:
                for r in lrealms:
                    if trealm == r:
                        return [SUCCESS, thost, trealm]
                # must match or something is very wrong
                logger.debug(&quot;Realm %s does not match any realm in LDAP &quot;
                             &quot;database&quot;, trealm)
                return [REALM_NOT_FOUND]
            else:
                if len(lrealms) != 1:
                    # which one? we can't attach to a multi-realm server
                    # without DNS working
                    logger.debug(
                        &quot;Multiple realms found, cannot decide which realm &quot;
                        &quot;is the correct realm without working DNS&quot;)
                    return [REALM_NOT_FOUND]
                else:
                    return [SUCCESS, thost, lrealms[0]]

            # we shouldn't get here
            assert False, &quot;Unknown error in ipadiscovery&quot;

        except errors.DatabaseTimeout:
            logger.debug(&quot;LDAP Error: timeout&quot;)
            return [NO_LDAP_SERVER]
        except errors.NetworkError as err:
            logger.debug(&quot;LDAP Error: %s&quot;, err.strerror)
            return [NO_LDAP_SERVER]
        except errors.ACIError:
            logger.debug(&quot;LDAP Error: Anonymous access not allowed&quot;)
            return [NO_ACCESS_TO_LDAP]
        except errors.DatabaseError as err:
            logger.debug(&quot;Error checking LDAP: %s&quot;, err.strerror)
            return [UNKNOWN_ERROR]
        except Exception as err:
            logger.debug(&quot;Error checking LDAP: %s&quot;, err)

            return [UNKNOWN_ERROR]

    def ipadns_search_srv(self, domain, srv_record_name, default_port,
                          break_on_first=True):
        &quot;&quot;&quot;
        Search for SRV records in given domain. When no record is found,
        en empty list is returned

        :param domain: Search domain name
        :param srv_record_name: SRV record name, e.g. &quot;_ldap._tcp&quot;
        :param default_port: When default_port is not None, it is being
                    checked with the port in SRV record and if they don't
                    match, the port from SRV record is appended to
                    found hostname in this format: &quot;hostname:port&quot;
        :param break_on_first: break on the first find and return just one
                    entry
        &quot;&quot;&quot;
        servers = []
        qname = '%s.%s' % (srv_record_name, domain)

        logger.debug(&quot;Search DNS for SRV record of %s&quot;, qname)

        try:
            answers = query_srv(qname)
        except DNSException as e:
            logger.debug(&quot;DNS record not found: %s&quot;, e.__class__.__name__)
            answers = []

        for answer in answers:
            logger.debug(&quot;DNS record found: %s&quot;, answer)
            server = str(answer.target).rstrip(&quot;.&quot;)
            if not server:
                logger.debug(&quot;Cannot parse the hostname from SRV record: %s&quot;,
                             answer)
                continue
            if default_port is not None and answer.port != default_port:
                server = &quot;%s:%s&quot; % (server, str(answer.port))
            servers.append(server)
            if break_on_first:
                break

        return servers

    def ipadnssearchkrbrealm(self, domain=None):
        &quot;&quot;&quot;
        :param domain: Domain to be searched in
        :returns: string of a realm found in a TXT record
                  None if no realm was found
        &quot;&quot;&quot;
        if not domain:
            domain = self.domain
        # now, check for a Kerberos realm the local host or domain is in
        qname = &quot;_kerberos.&quot; + domain

        logger.debug(&quot;Search DNS for TXT record of %s&quot;, qname)

        try:
            answers = resolve(qname, rdatatype.TXT)
        except DNSException as e:
            logger.debug(&quot;DNS record not found: %s&quot;, e.__class__.__name__)
            answers = []

        realm = None
        for answer in answers:
            logger.debug(&quot;DNS record found: %s&quot;, answer)
            if answer.strings:
                try:
                    realm = answer.strings[0].decode('utf-8')
                except UnicodeDecodeError as e:
                    logger.debug(
                        'A TXT record cannot be decoded as UTF-8: %s', e)
                    continue
                if realm:
                    # Make sure that the realm is not single-label
                    try:
                        validate_domain_name(realm, entity='realm')
                    except ValueError as e:
                        logger.debug(&quot;Skipping invalid realm '%s' (%s)&quot;,
                                     realm, e)
                        continue
                    return realm
        return None

    def ipadnssearchkrbkdc(self, domain=None):
        if not domain:
            domain = self.domain

        kdc = self.ipadns_search_srv(domain, '_kerberos._udp', 88,
                                     break_on_first=False)

        if kdc:
            kdc = ','.join(kdc)
        else:
            logger.debug(&quot;SRV record for KDC not found! Domain: %s&quot;, domain)
            kdc = None

        return kdc


def main():
    import argparse
    import os
    from ipapython.ipa_log_manager import standard_logging_setup

    parser = argparse.ArgumentParser(__name__)

    if os.path.isfile(paths.IPA_CA_CRT):
        default_ca = paths.IPA_CA_CRT
    else:
        default_ca = None
    parser.add_argument('--ca-cert', default=default_ca)
    parser.add_argument('--debug', action='store_true')
    parser.add_argument('domain')

    args = parser.parse_args()

    standard_logging_setup(debug=args.debug)

    discover = IPADiscovery()
    result = discover.search(args.domain, ca_cert_path=args.ca_cert)

    for key in ['realm', 'domain', 'basedn', 'server', 'servers']:
        value = str(getattr(discover, key))
        source_key = &quot;{}_source&quot;.format(key)
        source = getattr(discover, source_key, None)
        if source is not None:
            print(&quot;{:&lt;8} {:&lt;32}\t({})&quot;.format(key, value, source))
        else:
            print(&quot;{:&lt;8} {:&lt;32}&quot;.format(key, value))

    parser.exit(
        abs(result),
        &quot;{}\n&quot;.format(error_names.get(result, result))
    )


if __name__ == '__main__':
    main()
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Flib%2Fpython3.6%2Fsite-packages%2Fipaclient'>Back to Directory</a>