Source code for privacyidea.lib.machines.hosts

# -*- coding: utf-8 -*-
#  2016-04-08 Cornelius Kölbel <>
#             Avoid consecutive if-statements
#  2015-02-25 Cornelius Kölbel <>
#             Initial writup
# This code is free software; you can redistribute it and/or
# modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
# License as published by the Free Software Foundation; either
# version 3 of the License, or any later version.
# This code is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# You should have received a copy of the GNU Affero General Public
# License along with this program.  If not, see <>.
__doc__ = """This contains the HostsMachineResolver which simply resolves
the machines in a file like /etc/hosts.
The machine id is the IP address in this case.

This file is tested in tests/ in the class

from .base import Machine
from .base import BaseMachineResolver
from .base import MachineResolverError

import netaddr

[docs]class HostsMachineResolver(BaseMachineResolver): type = "hosts"
[docs] def get_machines(self, machine_id=None, hostname=None, ip=None, any=None, substring=False): """ Return matching machines. :param machine_id: can be matched as substring :param hostname: can be matched as substring :param ip: can not be matched as substring :param substring: Whether the filtering should be a substring matching :type substring: bool :param any: a substring that matches EITHER hostname, machineid or ip :type any: basestring :return: list of Machine Objects """ machines = [] f = open(self.filename, "r") try: for line in f: split_line = line.split() if len(split_line) < 2: # skip lines with less than 2 columns continue if split_line[0][0] == "#": # skip comments continue line_id = split_line[0] line_ip = netaddr.IPAddress(split_line[0]) line_hostname = split_line[1:] # check if machine_id, ip or hostname matches a substring if (any and any not in line_id and len([x for x in line_hostname if any in x]) <= 0 and any not in "{0!s}".format(line_ip)): # "any" was provided but did not match either # hostname, ip or machine_id continue else: if machine_id: if not substring and machine_id == line_id: return [Machine(, line_id, hostname=line_hostname, ip=line_ip)] if substring and machine_id not in line_id: # do not append this machine! continue if hostname: if substring: h_match = len([x for x in line_hostname if hostname in x]) else: h_match = hostname in line_hostname if not h_match: # do not append this machine! continue if ip and ip != line_ip: # Do not append this machine! continue machines.append(Machine(, line_id, hostname=line_hostname, ip=line_ip)) finally: f.close() return machines
[docs] def get_machine_id(self, hostname=None, ip=None): """ Returns the machine id for a given hostname or IP address. If hostname and ip is given, the resolver should also check that the hostname matches the IP. If it can check this and hostname and IP do not match, then an Exception must be raised. :param hostname: The hostname of the machine :type hostname: basestring :param ip: IP address of the machine :type ip: netaddr :return: The machine ID, which depends on the resolver :rtype: basestring """ machines = self.get_machines() for machine in machines: h_match = not hostname or machine.has_hostname(hostname) i_match = not ip or machine.has_ip(ip) if h_match and i_match: return return
[docs] def load_config(self, config): """ This loads the configuration dictionary, which contains the necessary information for the machine resolver to find and connect to the machine store. :param config: The configuration dictionary to run the machine resolver :type config: dict :return: None """ self.filename = config.get("filename") if self.filename is None: raise MachineResolverError("filename is missing!")
[docs] @classmethod def get_config_description(cls): description = {cls.type: {"config": {"filename": "string"}}} return description
[docs] @staticmethod def testconnection(params): """ Test if the given filename exists. :param params: :return: """ return False, "Not Implemented"