126
106
    max_renames: integer; maximum number of renames
 
127
107
    rename_count: integer; counter so we only rename after collisions
 
128
108
                  a sensible number of times
 
129
 
    group: D-Bus Entry Group
 
131
 
    bus: dbus.SystemBus()
 
133
110
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
 
134
 
                 servicetype = None, port = None, TXT = None,
 
135
 
                 domain = u"", host = u"", max_renames = 32768,
 
136
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
 
111
                 type = None, port = None, TXT = None, domain = "",
 
 
112
                 host = "", max_renames = 32768):
 
137
113
        self.interface = interface
 
139
 
        self.type = servicetype
 
141
 
        self.TXT = TXT if TXT is not None else []
 
142
121
        self.domain = domain
 
144
123
        self.rename_count = 0
 
145
124
        self.max_renames = max_renames
 
146
 
        self.protocol = protocol
 
147
 
        self.group = None       # our entry group
 
150
125
    def rename(self):
 
151
126
        """Derived from the Avahi example code"""
 
152
127
        if self.rename_count >= self.max_renames:
 
153
128
            logger.critical(u"No suitable Zeroconf service name found"
 
154
129
                            u" after %i retries, exiting.",
 
156
 
            raise AvahiServiceError(u"Too many renames")
 
157
 
        self.name = self.server.GetAlternativeServiceName(self.name)
 
 
131
            raise AvahiServiceError("Too many renames")
 
 
132
        self.name = server.GetAlternativeServiceName(self.name)
 
158
133
        logger.info(u"Changing Zeroconf service name to %r ...",
 
160
 
        syslogger.setFormatter(logging.Formatter
 
161
 
                               (u'Mandos (%s) [%%(process)d]:'
 
162
 
                                u' %%(levelname)s: %%(message)s'
 
 
135
        syslogger.setFormatter(logging.Formatter\
 
 
136
                               ('Mandos (%s): %%(levelname)s:'
 
 
137
                               ' %%(message)s' % self.name))
 
166
140
        self.rename_count += 1
 
167
141
    def remove(self):
 
168
142
        """Derived from the Avahi example code"""
 
169
 
        if self.group is not None:
 
 
143
        if group is not None:
 
172
146
        """Derived from the Avahi example code"""
 
173
 
        if self.group is None:
 
174
 
            self.group = dbus.Interface(
 
175
 
                self.bus.get_object(avahi.DBUS_NAME,
 
176
 
                                    self.server.EntryGroupNew()),
 
177
 
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
178
 
            self.group.connect_to_signal('StateChanged',
 
180
 
                                         .entry_group_state_changed)
 
 
149
            group = dbus.Interface\
 
 
150
                    (bus.get_object(avahi.DBUS_NAME,
 
 
151
                                    server.EntryGroupNew()),
 
 
152
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
 
153
            group.connect_to_signal('StateChanged',
 
 
154
                                    entry_group_state_changed)
 
181
155
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
 
182
 
                     self.name, self.type)
 
183
 
        self.group.AddService(
 
186
 
            dbus.UInt32(0),     # flags
 
187
 
            self.name, self.type,
 
188
 
            self.domain, self.host,
 
189
 
            dbus.UInt16(self.port),
 
190
 
            avahi.string_array_to_txt_array(self.TXT))
 
192
 
    def entry_group_state_changed(self, state, error):
 
193
 
        """Derived from the Avahi example code"""
 
194
 
        logger.debug(u"Avahi state change: %i", state)
 
196
 
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
197
 
            logger.debug(u"Zeroconf service established.")
 
198
 
        elif state == avahi.ENTRY_GROUP_COLLISION:
 
199
 
            logger.warning(u"Zeroconf service name collision.")
 
201
 
        elif state == avahi.ENTRY_GROUP_FAILURE:
 
202
 
            logger.critical(u"Avahi: Error in group state changed %s",
 
204
 
            raise AvahiGroupError(u"State changed: %s"
 
207
 
        """Derived from the Avahi example code"""
 
208
 
        if self.group is not None:
 
211
 
    def server_state_changed(self, state):
 
212
 
        """Derived from the Avahi example code"""
 
213
 
        if state == avahi.SERVER_COLLISION:
 
214
 
            logger.error(u"Zeroconf server name collision")
 
216
 
        elif state == avahi.SERVER_RUNNING:
 
219
 
        """Derived from the Avahi example code"""
 
220
 
        if self.server is None:
 
221
 
            self.server = dbus.Interface(
 
222
 
                self.bus.get_object(avahi.DBUS_NAME,
 
223
 
                                    avahi.DBUS_PATH_SERVER),
 
224
 
                avahi.DBUS_INTERFACE_SERVER)
 
225
 
        self.server.connect_to_signal(u"StateChanged",
 
226
 
                                 self.server_state_changed)
 
227
 
        self.server_state_changed(self.server.GetState())
 
 
156
                     service.name, service.type)
 
 
158
                self.interface,         # interface
 
 
159
                avahi.PROTO_INET6,      # protocol
 
 
160
                dbus.UInt32(0),         # flags
 
 
161
                self.name, self.type,
 
 
162
                self.domain, self.host,
 
 
163
                dbus.UInt16(self.port),
 
 
164
                avahi.string_array_to_txt_array(self.TXT))
 
 
167
# From the Avahi example code:
 
 
168
group = None                            # our entry group
 
 
169
# End of Avahi example code
 
230
172
class Client(object):
 
231
173
    """A representation of a client host served by this server.
 
234
 
    name:       string; from the config file, used in log messages and
 
 
175
    name:      string; from the config file, used in log messages
 
236
176
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
237
177
                 uniquely identify the client
 
238
 
    secret:     bytestring; sent verbatim (over TLS) to client
 
239
 
    host:       string; available for use by the checker command
 
240
 
    created:    datetime.datetime(); (UTC) object creation
 
241
 
    last_enabled: datetime.datetime(); (UTC)
 
243
 
    last_checked_ok: datetime.datetime(); (UTC) or None
 
244
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
245
 
                                      until this client is invalid
 
246
 
    interval:   datetime.timedelta(); How often to start a new checker
 
247
 
    disable_hook:  If set, called by disable() as disable_hook(self)
 
248
 
    checker:    subprocess.Popen(); a running checker process used
 
249
 
                                    to see if the client lives.
 
250
 
                                    'None' if no process is running.
 
 
178
    secret:    bytestring; sent verbatim (over TLS) to client
 
 
179
    host:      string; available for use by the checker command
 
 
180
    created:   datetime.datetime(); object creation, not client host
 
 
181
    last_checked_ok: datetime.datetime() or None if not yet checked OK
 
 
182
    timeout:   datetime.timedelta(); How long from last_checked_ok
 
 
183
                                     until this client is invalid
 
 
184
    interval:  datetime.timedelta(); How often to start a new checker
 
 
185
    stop_hook: If set, called by stop() as stop_hook(self)
 
 
186
    checker:   subprocess.Popen(); a running checker process used
 
 
187
                                   to see if the client lives.
 
 
188
                                   'None' if no process is running.
 
251
189
    checker_initiator_tag: a gobject event source tag, or None
 
252
 
    disable_initiator_tag: - '' -
 
 
190
    stop_initiator_tag:    - '' -
 
253
191
    checker_callback_tag:  - '' -
 
254
192
    checker_command: string; External command which is run to check if
 
255
193
                     client lives.  %() expansions are done at
 
256
194
                     runtime with vars(self) as dict, so that for
 
257
195
                     instance %(name)s can be used in the command.
 
258
 
    current_checker_command: string; current running checker_command
 
 
197
    _timeout: Real variable for 'timeout'
 
 
198
    _interval: Real variable for 'interval'
 
 
199
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
 
200
    _interval_milliseconds: - '' -
 
262
 
    def _timedelta_to_milliseconds(td):
 
263
 
        "Convert a datetime.timedelta() to milliseconds"
 
264
 
        return ((td.days * 24 * 60 * 60 * 1000)
 
265
 
                + (td.seconds * 1000)
 
266
 
                + (td.microseconds // 1000))
 
268
 
    def timeout_milliseconds(self):
 
269
 
        "Return the 'timeout' attribute in milliseconds"
 
270
 
        return self._timedelta_to_milliseconds(self.timeout)
 
272
 
    def interval_milliseconds(self):
 
273
 
        "Return the 'interval' attribute in milliseconds"
 
274
 
        return self._timedelta_to_milliseconds(self.interval)
 
276
 
    def __init__(self, name = None, disable_hook=None, config=None):
 
 
202
    def _set_timeout(self, timeout):
 
 
203
        "Setter function for 'timeout' attribute"
 
 
204
        self._timeout = timeout
 
 
205
        self._timeout_milliseconds = ((self.timeout.days
 
 
206
                                       * 24 * 60 * 60 * 1000)
 
 
207
                                      + (self.timeout.seconds * 1000)
 
 
208
                                      + (self.timeout.microseconds
 
 
210
    timeout = property(lambda self: self._timeout,
 
 
213
    def _set_interval(self, interval):
 
 
214
        "Setter function for 'interval' attribute"
 
 
215
        self._interval = interval
 
 
216
        self._interval_milliseconds = ((self.interval.days
 
 
217
                                        * 24 * 60 * 60 * 1000)
 
 
218
                                       + (self.interval.seconds
 
 
220
                                       + (self.interval.microseconds
 
 
222
    interval = property(lambda self: self._interval,
 
 
225
    def __init__(self, name = None, stop_hook=None, config={}):
 
277
226
        """Note: the 'checker' key in 'config' sets the
 
278
227
        'checker_command' attribute and *not* the 'checker'
 
283
230
        logger.debug(u"Creating client %r", self.name)
 
284
231
        # Uppercase and remove spaces from fingerprint for later
 
285
232
        # comparison purposes with return value from the fingerprint()
 
287
 
        self.fingerprint = (config[u"fingerprint"].upper()
 
 
234
        self.fingerprint = config["fingerprint"].upper()\
 
289
236
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
 
290
 
        if u"secret" in config:
 
291
 
            self.secret = config[u"secret"].decode(u"base64")
 
292
 
        elif u"secfile" in config:
 
293
 
            with closing(open(os.path.expanduser
 
295
 
                               (config[u"secfile"])),
 
297
 
                self.secret = secfile.read()
 
 
237
        if "secret" in config:
 
 
238
            self.secret = config["secret"].decode(u"base64")
 
 
239
        elif "secfile" in config:
 
 
240
            sf = open(config["secfile"])
 
 
241
            self.secret = sf.read()
 
299
244
            raise TypeError(u"No secret or secfile for client %s"
 
301
 
        self.host = config.get(u"host", u"")
 
302
 
        self.created = datetime.datetime.utcnow()
 
304
 
        self.last_enabled = None
 
 
246
        self.host = config.get("host", "")
 
 
247
        self.created = datetime.datetime.now()
 
305
248
        self.last_checked_ok = None
 
306
 
        self.timeout = string_to_delta(config[u"timeout"])
 
307
 
        self.interval = string_to_delta(config[u"interval"])
 
308
 
        self.disable_hook = disable_hook
 
 
249
        self.timeout = string_to_delta(config["timeout"])
 
 
250
        self.interval = string_to_delta(config["interval"])
 
 
251
        self.stop_hook = stop_hook
 
309
252
        self.checker = None
 
310
253
        self.checker_initiator_tag = None
 
311
 
        self.disable_initiator_tag = None
 
 
254
        self.stop_initiator_tag = None
 
312
255
        self.checker_callback_tag = None
 
313
 
        self.checker_command = config[u"checker"]
 
314
 
        self.current_checker_command = None
 
315
 
        self.last_connect = None
 
 
256
        self.check_command = config["checker"]
 
318
258
        """Start this client's checker and timeout hooks"""
 
319
 
        if getattr(self, u"enabled", False):
 
322
 
        self.last_enabled = datetime.datetime.utcnow()
 
323
259
        # Schedule a new checker to be started an 'interval' from now,
 
324
260
        # and every interval from then on.
 
325
 
        self.checker_initiator_tag = (gobject.timeout_add
 
326
 
                                      (self.interval_milliseconds(),
 
 
261
        self.checker_initiator_tag = gobject.timeout_add\
 
 
262
                                     (self._interval_milliseconds,
 
328
264
        # Also start a new checker *right now*.
 
329
265
        self.start_checker()
 
330
 
        # Schedule a disable() when 'timeout' has passed
 
331
 
        self.disable_initiator_tag = (gobject.timeout_add
 
332
 
                                   (self.timeout_milliseconds(),
 
337
 
        """Disable this client."""
 
338
 
        if not getattr(self, "enabled", False):
 
 
266
        # Schedule a stop() when 'timeout' has passed
 
 
267
        self.stop_initiator_tag = gobject.timeout_add\
 
 
268
                                  (self._timeout_milliseconds,
 
 
272
        The possibility that a client might be restarted is left open,
 
 
273
        but not currently used."""
 
 
274
        # If this client doesn't have a secret, it is already stopped.
 
 
275
        if hasattr(self, "secret") and self.secret:
 
 
276
            logger.info(u"Stopping client %s", self.name)
 
340
 
        logger.info(u"Disabling client %s", self.name)
 
341
 
        if getattr(self, u"disable_initiator_tag", False):
 
342
 
            gobject.source_remove(self.disable_initiator_tag)
 
343
 
            self.disable_initiator_tag = None
 
344
 
        if getattr(self, u"checker_initiator_tag", False):
 
 
280
        if getattr(self, "stop_initiator_tag", False):
 
 
281
            gobject.source_remove(self.stop_initiator_tag)
 
 
282
            self.stop_initiator_tag = None
 
 
283
        if getattr(self, "checker_initiator_tag", False):
 
345
284
            gobject.source_remove(self.checker_initiator_tag)
 
346
285
            self.checker_initiator_tag = None
 
347
286
        self.stop_checker()
 
348
 
        if self.disable_hook:
 
349
 
            self.disable_hook(self)
 
351
289
        # Do not run this again if called by a gobject.timeout_add
 
354
291
    def __del__(self):
 
355
 
        self.disable_hook = None
 
358
 
    def checker_callback(self, pid, condition, command):
 
 
292
        self.stop_hook = None
 
 
294
    def checker_callback(self, pid, condition):
 
359
295
        """The checker has completed, so take appropriate actions."""
 
 
296
        now = datetime.datetime.now()
 
360
297
        self.checker_callback_tag = None
 
361
298
        self.checker = None
 
362
 
        if os.WIFEXITED(condition):
 
363
 
            exitstatus = os.WEXITSTATUS(condition)
 
365
 
                logger.info(u"Checker for %(name)s succeeded",
 
369
 
                logger.info(u"Checker for %(name)s failed",
 
 
299
        if os.WIFEXITED(condition) \
 
 
300
               and (os.WEXITSTATUS(condition) == 0):
 
 
301
            logger.info(u"Checker for %(name)s succeeded",
 
 
303
            self.last_checked_ok = now
 
 
304
            gobject.source_remove(self.stop_initiator_tag)
 
 
305
            self.stop_initiator_tag = gobject.timeout_add\
 
 
306
                                      (self._timeout_milliseconds,
 
 
308
        elif not os.WIFEXITED(condition):
 
372
309
            logger.warning(u"Checker for %(name)s crashed?",
 
375
 
    def checked_ok(self):
 
376
 
        """Bump up the timeout for this client.
 
378
 
        This should only be called when the client has been seen,
 
381
 
        self.last_checked_ok = datetime.datetime.utcnow()
 
382
 
        gobject.source_remove(self.disable_initiator_tag)
 
383
 
        self.disable_initiator_tag = (gobject.timeout_add
 
384
 
                                      (self.timeout_milliseconds(),
 
 
312
            logger.info(u"Checker for %(name)s failed",
 
387
314
    def start_checker(self):
 
388
315
        """Start a new checker subprocess if one is not running.
 
390
316
        If a checker already exists, leave it running and do
 
392
318
        # The reason for not killing a running checker is that if we
 
 
474
373
            if error.errno != errno.ESRCH: # No such process
 
476
375
        self.checker = None
 
478
376
    def still_valid(self):
 
479
377
        """Has the timeout not yet passed for this client?"""
 
480
 
        if not getattr(self, u"enabled", False):
 
482
 
        now = datetime.datetime.utcnow()
 
 
378
        now = datetime.datetime.now()
 
483
379
        if self.last_checked_ok is None:
 
484
380
            return now < (self.created + self.timeout)
 
486
382
            return now < (self.last_checked_ok + self.timeout)
 
489
 
def dbus_service_property(dbus_interface, signature=u"v",
 
490
 
                          access=u"readwrite", byte_arrays=False):
 
491
 
    """Decorators for marking methods of a DBusObjectWithProperties to
 
492
 
    become properties on the D-Bus.
 
494
 
    The decorated method will be called with no arguments by "Get"
 
495
 
    and with one argument by "Set".
 
497
 
    The parameters, where they are supported, are the same as
 
498
 
    dbus.service.method, except there is only "signature", since the
 
499
 
    type from Get() and the type sent to Set() is the same.
 
502
 
        func._dbus_is_property = True
 
503
 
        func._dbus_interface = dbus_interface
 
504
 
        func._dbus_signature = signature
 
505
 
        func._dbus_access = access
 
506
 
        func._dbus_name = func.__name__
 
507
 
        if func._dbus_name.endswith(u"_dbus_property"):
 
508
 
            func._dbus_name = func._dbus_name[:-14]
 
509
 
        func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
 
514
 
class DBusPropertyException(dbus.exceptions.DBusException):
 
515
 
    """A base class for D-Bus property-related exceptions
 
517
 
    def __unicode__(self):
 
518
 
        return unicode(str(self))
 
521
 
class DBusPropertyAccessException(DBusPropertyException):
 
522
 
    """A property's access permissions disallows an operation.
 
527
 
class DBusPropertyNotFound(DBusPropertyException):
 
528
 
    """An attempt was made to access a non-existing property.
 
533
 
class DBusObjectWithProperties(dbus.service.Object):
 
534
 
    """A D-Bus object with properties.
 
536
 
    Classes inheriting from this can use the dbus_service_property
 
537
 
    decorator to expose methods as D-Bus properties.  It exposes the
 
538
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
542
 
    def _is_dbus_property(obj):
 
543
 
        return getattr(obj, u"_dbus_is_property", False)
 
545
 
    def _get_all_dbus_properties(self):
 
546
 
        """Returns a generator of (name, attribute) pairs
 
548
 
        return ((prop._dbus_name, prop)
 
550
 
                inspect.getmembers(self, self._is_dbus_property))
 
552
 
    def _get_dbus_property(self, interface_name, property_name):
 
553
 
        """Returns a bound method if one exists which is a D-Bus
 
554
 
        property with the specified name and interface.
 
556
 
        for name in (property_name,
 
557
 
                     property_name + u"_dbus_property"):
 
558
 
            prop = getattr(self, name, None)
 
560
 
                or not self._is_dbus_property(prop)
 
561
 
                or prop._dbus_name != property_name
 
562
 
                or (interface_name and prop._dbus_interface
 
563
 
                    and interface_name != prop._dbus_interface)):
 
567
 
        raise DBusPropertyNotFound(self.dbus_object_path + u":"
 
568
 
                                   + interface_name + u"."
 
571
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
 
573
 
    def Get(self, interface_name, property_name):
 
574
 
        """Standard D-Bus property Get() method, see D-Bus standard.
 
576
 
        prop = self._get_dbus_property(interface_name, property_name)
 
577
 
        if prop._dbus_access == u"write":
 
578
 
            raise DBusPropertyAccessException(property_name)
 
580
 
        if not hasattr(value, u"variant_level"):
 
582
 
        return type(value)(value, variant_level=value.variant_level+1)
 
584
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
 
585
 
    def Set(self, interface_name, property_name, value):
 
586
 
        """Standard D-Bus property Set() method, see D-Bus standard.
 
588
 
        prop = self._get_dbus_property(interface_name, property_name)
 
589
 
        if prop._dbus_access == u"read":
 
590
 
            raise DBusPropertyAccessException(property_name)
 
591
 
        if prop._dbus_get_args_options[u"byte_arrays"]:
 
592
 
            value = dbus.ByteArray(''.join(unichr(byte)
 
596
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
 
597
 
                         out_signature=u"a{sv}")
 
598
 
    def GetAll(self, interface_name):
 
599
 
        """Standard D-Bus property GetAll() method, see D-Bus
 
602
 
        Note: Will not include properties with access="write".
 
605
 
        for name, prop in self._get_all_dbus_properties():
 
607
 
                and interface_name != prop._dbus_interface):
 
608
 
                # Interface non-empty but did not match
 
610
 
            # Ignore write-only properties
 
611
 
            if prop._dbus_access == u"write":
 
614
 
            if not hasattr(value, u"variant_level"):
 
617
 
            all[name] = type(value)(value, variant_level=
 
618
 
                                    value.variant_level+1)
 
619
 
        return dbus.Dictionary(all, signature=u"sv")
 
621
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
623
 
                         path_keyword='object_path',
 
624
 
                         connection_keyword='connection')
 
625
 
    def Introspect(self, object_path, connection):
 
626
 
        """Standard D-Bus method, overloaded to insert property tags.
 
628
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
631
 
            document = xml.dom.minidom.parseString(xmlstring)
 
632
 
            def make_tag(document, name, prop):
 
633
 
                e = document.createElement(u"property")
 
634
 
                e.setAttribute(u"name", name)
 
635
 
                e.setAttribute(u"type", prop._dbus_signature)
 
636
 
                e.setAttribute(u"access", prop._dbus_access)
 
638
 
            for if_tag in document.getElementsByTagName(u"interface"):
 
639
 
                for tag in (make_tag(document, name, prop)
 
641
 
                            in self._get_all_dbus_properties()
 
642
 
                            if prop._dbus_interface
 
643
 
                            == if_tag.getAttribute(u"name")):
 
644
 
                    if_tag.appendChild(tag)
 
645
 
                # Add the names to the return values for the
 
646
 
                # "org.freedesktop.DBus.Properties" methods
 
647
 
                if (if_tag.getAttribute(u"name")
 
648
 
                    == u"org.freedesktop.DBus.Properties"):
 
649
 
                    for cn in if_tag.getElementsByTagName(u"method"):
 
650
 
                        if cn.getAttribute(u"name") == u"Get":
 
651
 
                            for arg in cn.getElementsByTagName(u"arg"):
 
652
 
                                if (arg.getAttribute(u"direction")
 
654
 
                                    arg.setAttribute(u"name", u"value")
 
655
 
                        elif cn.getAttribute(u"name") == u"GetAll":
 
656
 
                            for arg in cn.getElementsByTagName(u"arg"):
 
657
 
                                if (arg.getAttribute(u"direction")
 
659
 
                                    arg.setAttribute(u"name", u"props")
 
660
 
            xmlstring = document.toxml(u"utf-8")
 
662
 
        except (AttributeError, xml.dom.DOMException,
 
663
 
                xml.parsers.expat.ExpatError), error:
 
664
 
            logger.error(u"Failed to override Introspection method",
 
669
 
class ClientDBus(Client, DBusObjectWithProperties):
 
670
 
    """A Client class using D-Bus
 
673
 
    dbus_object_path: dbus.ObjectPath
 
674
 
    bus: dbus.SystemBus()
 
676
 
    # dbus.service.Object doesn't use super(), so we can't either.
 
678
 
    def __init__(self, bus = None, *args, **kwargs):
 
680
 
        Client.__init__(self, *args, **kwargs)
 
681
 
        # Only now, when this client is initialized, can it show up on
 
683
 
        self.dbus_object_path = (dbus.ObjectPath
 
685
 
                                  + self.name.replace(u".", u"_")))
 
686
 
        DBusObjectWithProperties.__init__(self, self.bus,
 
687
 
                                          self.dbus_object_path)
 
690
 
    def _datetime_to_dbus(dt, variant_level=0):
 
691
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
 
692
 
        return dbus.String(dt.isoformat(),
 
693
 
                           variant_level=variant_level)
 
696
 
        oldstate = getattr(self, u"enabled", False)
 
697
 
        r = Client.enable(self)
 
698
 
        if oldstate != self.enabled:
 
700
 
            self.PropertyChanged(dbus.String(u"enabled"),
 
701
 
                                 dbus.Boolean(True, variant_level=1))
 
702
 
            self.PropertyChanged(
 
703
 
                dbus.String(u"last_enabled"),
 
704
 
                self._datetime_to_dbus(self.last_enabled,
 
708
 
    def disable(self, signal = True):
 
709
 
        oldstate = getattr(self, u"enabled", False)
 
710
 
        r = Client.disable(self)
 
711
 
        if signal and oldstate != self.enabled:
 
713
 
            self.PropertyChanged(dbus.String(u"enabled"),
 
714
 
                                 dbus.Boolean(False, variant_level=1))
 
717
 
    def __del__(self, *args, **kwargs):
 
719
 
            self.remove_from_connection()
 
722
 
        if hasattr(DBusObjectWithProperties, u"__del__"):
 
723
 
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
 
724
 
        Client.__del__(self, *args, **kwargs)
 
726
 
    def checker_callback(self, pid, condition, command,
 
728
 
        self.checker_callback_tag = None
 
731
 
        self.PropertyChanged(dbus.String(u"checker_running"),
 
732
 
                             dbus.Boolean(False, variant_level=1))
 
733
 
        if os.WIFEXITED(condition):
 
734
 
            exitstatus = os.WEXITSTATUS(condition)
 
736
 
            self.CheckerCompleted(dbus.Int16(exitstatus),
 
737
 
                                  dbus.Int64(condition),
 
738
 
                                  dbus.String(command))
 
741
 
            self.CheckerCompleted(dbus.Int16(-1),
 
742
 
                                  dbus.Int64(condition),
 
743
 
                                  dbus.String(command))
 
745
 
        return Client.checker_callback(self, pid, condition, command,
 
748
 
    def checked_ok(self, *args, **kwargs):
 
749
 
        r = Client.checked_ok(self, *args, **kwargs)
 
751
 
        self.PropertyChanged(
 
752
 
            dbus.String(u"last_checked_ok"),
 
753
 
            (self._datetime_to_dbus(self.last_checked_ok,
 
757
 
    def start_checker(self, *args, **kwargs):
 
758
 
        old_checker = self.checker
 
759
 
        if self.checker is not None:
 
760
 
            old_checker_pid = self.checker.pid
 
762
 
            old_checker_pid = None
 
763
 
        r = Client.start_checker(self, *args, **kwargs)
 
764
 
        # Only if new checker process was started
 
765
 
        if (self.checker is not None
 
766
 
            and old_checker_pid != self.checker.pid):
 
768
 
            self.CheckerStarted(self.current_checker_command)
 
769
 
            self.PropertyChanged(
 
770
 
                dbus.String(u"checker_running"),
 
771
 
                dbus.Boolean(True, variant_level=1))
 
774
 
    def stop_checker(self, *args, **kwargs):
 
775
 
        old_checker = getattr(self, u"checker", None)
 
776
 
        r = Client.stop_checker(self, *args, **kwargs)
 
777
 
        if (old_checker is not None
 
778
 
            and getattr(self, u"checker", None) is None):
 
779
 
            self.PropertyChanged(dbus.String(u"checker_running"),
 
780
 
                                 dbus.Boolean(False, variant_level=1))
 
783
 
    ## D-Bus methods & signals
 
784
 
    _interface = u"se.bsnet.fukt.Mandos.Client"
 
787
 
    @dbus.service.method(_interface)
 
789
 
        return self.checked_ok()
 
791
 
    # CheckerCompleted - signal
 
792
 
    @dbus.service.signal(_interface, signature=u"nxs")
 
793
 
    def CheckerCompleted(self, exitcode, waitstatus, command):
 
797
 
    # CheckerStarted - signal
 
798
 
    @dbus.service.signal(_interface, signature=u"s")
 
799
 
    def CheckerStarted(self, command):
 
803
 
    # PropertyChanged - signal
 
804
 
    @dbus.service.signal(_interface, signature=u"sv")
 
805
 
    def PropertyChanged(self, property, value):
 
810
 
    @dbus.service.signal(_interface)
 
816
 
    @dbus.service.signal(_interface)
 
822
 
    @dbus.service.method(_interface)
 
827
 
    # StartChecker - method
 
828
 
    @dbus.service.method(_interface)
 
829
 
    def StartChecker(self):
 
834
 
    @dbus.service.method(_interface)
 
839
 
    # StopChecker - method
 
840
 
    @dbus.service.method(_interface)
 
841
 
    def StopChecker(self):
 
845
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
846
 
    def name_dbus_property(self):
 
847
 
        return dbus.String(self.name)
 
849
 
    # fingerprint - property
 
850
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
851
 
    def fingerprint_dbus_property(self):
 
852
 
        return dbus.String(self.fingerprint)
 
855
 
    @dbus_service_property(_interface, signature=u"s",
 
857
 
    def host_dbus_property(self, value=None):
 
858
 
        if value is None:       # get
 
859
 
            return dbus.String(self.host)
 
862
 
        self.PropertyChanged(dbus.String(u"host"),
 
863
 
                             dbus.String(value, variant_level=1))
 
866
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
867
 
    def created_dbus_property(self):
 
868
 
        return dbus.String(self._datetime_to_dbus(self.created))
 
870
 
    # last_enabled - property
 
871
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
872
 
    def last_enabled_dbus_property(self):
 
873
 
        if self.last_enabled is None:
 
874
 
            return dbus.String(u"")
 
875
 
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
 
878
 
    @dbus_service_property(_interface, signature=u"b",
 
880
 
    def enabled_dbus_property(self, value=None):
 
881
 
        if value is None:       # get
 
882
 
            return dbus.Boolean(self.enabled)
 
888
 
    # last_checked_ok - property
 
889
 
    @dbus_service_property(_interface, signature=u"s",
 
891
 
    def last_checked_ok_dbus_property(self, value=None):
 
892
 
        if value is not None:
 
895
 
        if self.last_checked_ok is None:
 
896
 
            return dbus.String(u"")
 
897
 
        return dbus.String(self._datetime_to_dbus(self
 
901
 
    @dbus_service_property(_interface, signature=u"t",
 
903
 
    def timeout_dbus_property(self, value=None):
 
904
 
        if value is None:       # get
 
905
 
            return dbus.UInt64(self.timeout_milliseconds())
 
906
 
        self.timeout = datetime.timedelta(0, 0, 0, value)
 
908
 
        self.PropertyChanged(dbus.String(u"timeout"),
 
909
 
                             dbus.UInt64(value, variant_level=1))
 
910
 
        if getattr(self, u"disable_initiator_tag", None) is None:
 
913
 
        gobject.source_remove(self.disable_initiator_tag)
 
914
 
        self.disable_initiator_tag = None
 
916
 
                       _timedelta_to_milliseconds((self
 
922
 
            # The timeout has passed
 
925
 
            self.disable_initiator_tag = (gobject.timeout_add
 
926
 
                                          (time_to_die, self.disable))
 
928
 
    # interval - property
 
929
 
    @dbus_service_property(_interface, signature=u"t",
 
931
 
    def interval_dbus_property(self, value=None):
 
932
 
        if value is None:       # get
 
933
 
            return dbus.UInt64(self.interval_milliseconds())
 
934
 
        self.interval = datetime.timedelta(0, 0, 0, value)
 
936
 
        self.PropertyChanged(dbus.String(u"interval"),
 
937
 
                             dbus.UInt64(value, variant_level=1))
 
938
 
        if getattr(self, u"checker_initiator_tag", None) is None:
 
940
 
        # Reschedule checker run
 
941
 
        gobject.source_remove(self.checker_initiator_tag)
 
942
 
        self.checker_initiator_tag = (gobject.timeout_add
 
943
 
                                      (value, self.start_checker))
 
944
 
        self.start_checker()    # Start one now, too
 
947
 
    @dbus_service_property(_interface, signature=u"s",
 
949
 
    def checker_dbus_property(self, value=None):
 
950
 
        if value is None:       # get
 
951
 
            return dbus.String(self.checker_command)
 
952
 
        self.checker_command = value
 
954
 
        self.PropertyChanged(dbus.String(u"checker"),
 
955
 
                             dbus.String(self.checker_command,
 
958
 
    # checker_running - property
 
959
 
    @dbus_service_property(_interface, signature=u"b",
 
961
 
    def checker_running_dbus_property(self, value=None):
 
962
 
        if value is None:       # get
 
963
 
            return dbus.Boolean(self.checker is not None)
 
969
 
    # object_path - property
 
970
 
    @dbus_service_property(_interface, signature=u"o", access=u"read")
 
971
 
    def object_path_dbus_property(self):
 
972
 
        return self.dbus_object_path # is already a dbus.ObjectPath
 
975
 
    @dbus_service_property(_interface, signature=u"ay",
 
976
 
                           access=u"write", byte_arrays=True)
 
977
 
    def secret_dbus_property(self, value):
 
978
 
        self.secret = str(value)
 
983
 
class ClientHandler(socketserver.BaseRequestHandler, object):
 
984
 
    """A class to handle client connections.
 
986
 
    Instantiated once for each connection to handle it.
 
 
385
def peer_certificate(session):
 
 
386
    "Return the peer's OpenPGP certificate as a bytestring"
 
 
387
    # If not an OpenPGP certificate...
 
 
388
    if gnutls.library.functions.gnutls_certificate_type_get\
 
 
389
            (session._c_object) \
 
 
390
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
 
 
391
        # ...do the normal thing
 
 
392
        return session.peer_certificate
 
 
393
    list_size = ctypes.c_uint()
 
 
394
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
 
395
        (session._c_object, ctypes.byref(list_size))
 
 
396
    if list_size.value == 0:
 
 
399
    return ctypes.string_at(cert.data, cert.size)
 
 
402
def fingerprint(openpgp):
 
 
403
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
 
404
    # New GnuTLS "datum" with the OpenPGP public key
 
 
405
    datum = gnutls.library.types.gnutls_datum_t\
 
 
406
        (ctypes.cast(ctypes.c_char_p(openpgp),
 
 
407
                     ctypes.POINTER(ctypes.c_ubyte)),
 
 
408
         ctypes.c_uint(len(openpgp)))
 
 
409
    # New empty GnuTLS certificate
 
 
410
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
 
411
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
 
413
    # Import the OpenPGP public key into the certificate
 
 
414
    gnutls.library.functions.gnutls_openpgp_crt_import\
 
 
415
                    (crt, ctypes.byref(datum),
 
 
416
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
 
417
    # Verify the self signature in the key
 
 
418
    crtverify = ctypes.c_uint();
 
 
419
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
 
 
420
        (crt, 0, ctypes.byref(crtverify))
 
 
421
    if crtverify.value != 0:
 
 
422
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
 
423
        raise gnutls.errors.CertificateSecurityError("Verify failed")
 
 
424
    # New buffer for the fingerprint
 
 
425
    buffer = ctypes.create_string_buffer(20)
 
 
426
    buffer_length = ctypes.c_size_t()
 
 
427
    # Get the fingerprint from the certificate into the buffer
 
 
428
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
 
429
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
 
430
    # Deinit the certificate
 
 
431
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
 
432
    # Convert the buffer to a Python bytestring
 
 
433
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
 
434
    # Convert the bytestring to hexadecimal notation
 
 
435
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
 
439
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
 
440
    """A TCP request handler class.
 
 
441
    Instantiated by IPv6_TCPServer for each request to handle it.
 
987
442
    Note: This will run in its own forked process."""
 
989
444
    def handle(self):
 
990
445
        logger.info(u"TCP connection from: %s",
 
991
 
                    unicode(self.client_address))
 
992
 
        logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
 
993
 
        # Open IPC pipe to parent process
 
994
 
        with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
 
995
 
            session = (gnutls.connection
 
996
 
                       .ClientSession(self.request,
 
1000
 
            line = self.request.makefile().readline()
 
1001
 
            logger.debug(u"Protocol version: %r", line)
 
1003
 
                if int(line.strip().split()[0]) > 1:
 
1005
 
            except (ValueError, IndexError, RuntimeError), error:
 
1006
 
                logger.error(u"Unknown protocol version: %s", error)
 
1009
 
            # Note: gnutls.connection.X509Credentials is really a
 
1010
 
            # generic GnuTLS certificate credentials object so long as
 
1011
 
            # no X.509 keys are added to it.  Therefore, we can use it
 
1012
 
            # here despite using OpenPGP certificates.
 
1014
 
            #priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
 
1015
 
            #                      u"+AES-256-CBC", u"+SHA1",
 
1016
 
            #                      u"+COMP-NULL", u"+CTYPE-OPENPGP",
 
1018
 
            # Use a fallback default, since this MUST be set.
 
1019
 
            priority = self.server.gnutls_priority
 
1020
 
            if priority is None:
 
1021
 
                priority = u"NORMAL"
 
1022
 
            (gnutls.library.functions
 
1023
 
             .gnutls_priority_set_direct(session._c_object,
 
1028
 
            except gnutls.errors.GNUTLSError, error:
 
1029
 
                logger.warning(u"Handshake failed: %s", error)
 
1030
 
                # Do not run session.bye() here: the session is not
 
1031
 
                # established.  Just abandon the request.
 
1033
 
            logger.debug(u"Handshake succeeded")
 
1035
 
                fpr = self.fingerprint(self.peer_certificate(session))
 
1036
 
            except (TypeError, gnutls.errors.GNUTLSError), error:
 
1037
 
                logger.warning(u"Bad certificate: %s", error)
 
1040
 
            logger.debug(u"Fingerprint: %s", fpr)
 
1042
 
            for c in self.server.clients:
 
1043
 
                if c.fingerprint == fpr:
 
1047
 
                ipc.write(u"NOTFOUND %s %s\n"
 
1048
 
                          % (fpr, unicode(self.client_address)))
 
1051
 
            # Have to check if client.still_valid(), since it is
 
1052
 
            # possible that the client timed out while establishing
 
1053
 
            # the GnuTLS session.
 
1054
 
            if not client.still_valid():
 
1055
 
                ipc.write(u"INVALID %s\n" % client.name)
 
1058
 
            ipc.write(u"SENDING %s\n" % client.name)
 
1060
 
            while sent_size < len(client.secret):
 
1061
 
                sent = session.send(client.secret[sent_size:])
 
1062
 
                logger.debug(u"Sent: %d, remaining: %d",
 
1063
 
                             sent, len(client.secret)
 
1064
 
                             - (sent_size + sent))
 
1069
 
    def peer_certificate(session):
 
1070
 
        "Return the peer's OpenPGP certificate as a bytestring"
 
1071
 
        # If not an OpenPGP certificate...
 
1072
 
        if (gnutls.library.functions
 
1073
 
            .gnutls_certificate_type_get(session._c_object)
 
1074
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
1075
 
            # ...do the normal thing
 
1076
 
            return session.peer_certificate
 
1077
 
        list_size = ctypes.c_uint(1)
 
1078
 
        cert_list = (gnutls.library.functions
 
1079
 
                     .gnutls_certificate_get_peers
 
1080
 
                     (session._c_object, ctypes.byref(list_size)))
 
1081
 
        if not bool(cert_list) and list_size.value != 0:
 
1082
 
            raise gnutls.errors.GNUTLSError(u"error getting peer"
 
1084
 
        if list_size.value == 0:
 
1087
 
        return ctypes.string_at(cert.data, cert.size)
 
1090
 
    def fingerprint(openpgp):
 
1091
 
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
 
1092
 
        # New GnuTLS "datum" with the OpenPGP public key
 
1093
 
        datum = (gnutls.library.types
 
1094
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1097
 
                                 ctypes.c_uint(len(openpgp))))
 
1098
 
        # New empty GnuTLS certificate
 
1099
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
1100
 
        (gnutls.library.functions
 
1101
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
1102
 
        # Import the OpenPGP public key into the certificate
 
1103
 
        (gnutls.library.functions
 
1104
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1105
 
                                    gnutls.library.constants
 
1106
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
1107
 
        # Verify the self signature in the key
 
1108
 
        crtverify = ctypes.c_uint()
 
1109
 
        (gnutls.library.functions
 
1110
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1111
 
                                         ctypes.byref(crtverify)))
 
1112
 
        if crtverify.value != 0:
 
1113
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1114
 
            raise (gnutls.errors.CertificateSecurityError
 
1116
 
        # New buffer for the fingerprint
 
1117
 
        buf = ctypes.create_string_buffer(20)
 
1118
 
        buf_len = ctypes.c_size_t()
 
1119
 
        # Get the fingerprint from the certificate into the buffer
 
1120
 
        (gnutls.library.functions
 
1121
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1122
 
                                             ctypes.byref(buf_len)))
 
1123
 
        # Deinit the certificate
 
1124
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1125
 
        # Convert the buffer to a Python bytestring
 
1126
 
        fpr = ctypes.string_at(buf, buf_len.value)
 
1127
 
        # Convert the bytestring to hexadecimal notation
 
1128
 
        hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
1132
 
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
 
1133
 
    """Like socketserver.ForkingMixIn, but also pass a pipe."""
 
1134
 
    def process_request(self, request, client_address):
 
1135
 
        """Overrides and wraps the original process_request().
 
1137
 
        This function creates a new pipe in self.pipe
 
1139
 
        self.pipe = os.pipe()
 
1140
 
        super(ForkingMixInWithPipe,
 
1141
 
              self).process_request(request, client_address)
 
1142
 
        os.close(self.pipe[1])  # close write end
 
1143
 
        self.add_pipe(self.pipe[0])
 
1144
 
    def add_pipe(self, pipe):
 
1145
 
        """Dummy function; override as necessary"""
 
1149
 
class IPv6_TCPServer(ForkingMixInWithPipe,
 
1150
 
                     socketserver.TCPServer, object):
 
1151
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
 
446
                     unicode(self.client_address))
 
 
447
        session = gnutls.connection.ClientSession\
 
 
448
                  (self.request, gnutls.connection.X509Credentials())
 
 
450
        line = self.request.makefile().readline()
 
 
451
        logger.debug(u"Protocol version: %r", line)
 
 
453
            if int(line.strip().split()[0]) > 1:
 
 
455
        except (ValueError, IndexError, RuntimeError), error:
 
 
456
            logger.error(u"Unknown protocol version: %s", error)
 
 
459
        # Note: gnutls.connection.X509Credentials is really a generic
 
 
460
        # GnuTLS certificate credentials object so long as no X.509
 
 
461
        # keys are added to it.  Therefore, we can use it here despite
 
 
462
        # using OpenPGP certificates.
 
 
464
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
 
 
465
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
 
467
        priority = "NORMAL"             # Fallback default, since this
 
 
469
        if self.server.settings["priority"]:
 
 
470
            priority = self.server.settings["priority"]
 
 
471
        gnutls.library.functions.gnutls_priority_set_direct\
 
 
472
            (session._c_object, priority, None);
 
 
476
        except gnutls.errors.GNUTLSError, error:
 
 
477
            logger.warning(u"Handshake failed: %s", error)
 
 
478
            # Do not run session.bye() here: the session is not
 
 
479
            # established.  Just abandon the request.
 
 
482
            fpr = fingerprint(peer_certificate(session))
 
 
483
        except (TypeError, gnutls.errors.GNUTLSError), error:
 
 
484
            logger.warning(u"Bad certificate: %s", error)
 
 
487
        logger.debug(u"Fingerprint: %s", fpr)
 
 
489
        for c in self.server.clients:
 
 
490
            if c.fingerprint == fpr:
 
 
494
            logger.warning(u"Client not found for fingerprint: %s",
 
 
498
        # Have to check if client.still_valid(), since it is possible
 
 
499
        # that the client timed out while establishing the GnuTLS
 
 
501
        if not client.still_valid():
 
 
502
            logger.warning(u"Client %(name)s is invalid",
 
 
507
        while sent_size < len(client.secret):
 
 
508
            sent = session.send(client.secret[sent_size:])
 
 
509
            logger.debug(u"Sent: %d, remaining: %d",
 
 
510
                         sent, len(client.secret)
 
 
511
                         - (sent_size + sent))
 
 
516
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
 
517
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
 
 
519
        settings:       Server settings
 
 
520
        clients:        Set() of Client objects
 
1154
521
        enabled:        Boolean; whether this server is activated yet
 
1155
 
        interface:      None or a network interface name (string)
 
1156
 
        use_ipv6:       Boolean; to use IPv6 or not
 
1158
 
    def __init__(self, server_address, RequestHandlerClass,
 
1159
 
                 interface=None, use_ipv6=True):
 
1160
 
        self.interface = interface
 
1162
 
            self.address_family = socket.AF_INET6
 
1163
 
        socketserver.TCPServer.__init__(self, server_address,
 
1164
 
                                        RequestHandlerClass)
 
 
523
    address_family = socket.AF_INET6
 
 
524
    def __init__(self, *args, **kwargs):
 
 
525
        if "settings" in kwargs:
 
 
526
            self.settings = kwargs["settings"]
 
 
527
            del kwargs["settings"]
 
 
528
        if "clients" in kwargs:
 
 
529
            self.clients = kwargs["clients"]
 
 
530
            del kwargs["clients"]
 
 
532
        return super(type(self), self).__init__(*args, **kwargs)
 
1165
533
    def server_bind(self):
 
1166
534
        """This overrides the normal server_bind() function
 
1167
535
        to bind to an interface if one was specified, and also NOT to
 
1168
536
        bind to an address or port if they were not specified."""
 
1169
 
        if self.interface is not None:
 
1170
 
            if SO_BINDTODEVICE is None:
 
1171
 
                logger.error(u"SO_BINDTODEVICE does not exist;"
 
1172
 
                             u" cannot bind to interface %s",
 
1176
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1180
 
                except socket.error, error:
 
1181
 
                    if error[0] == errno.EPERM:
 
1182
 
                        logger.error(u"No permission to"
 
1183
 
                                     u" bind to interface %s",
 
1185
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1186
 
                        logger.error(u"SO_BINDTODEVICE not available;"
 
1187
 
                                     u" cannot bind to interface %s",
 
 
537
        if self.settings["interface"]:
 
 
538
            # 25 is from /usr/include/asm-i486/socket.h
 
 
539
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
 
541
                self.socket.setsockopt(socket.SOL_SOCKET,
 
 
543
                                       self.settings["interface"])
 
 
544
            except socket.error, error:
 
 
545
                if error[0] == errno.EPERM:
 
 
546
                    logger.error(u"No permission to"
 
 
547
                                 u" bind to interface %s",
 
 
548
                                 self.settings["interface"])
 
1191
551
        # Only bind(2) the socket if we really need to.
 
1192
552
        if self.server_address[0] or self.server_address[1]:
 
1193
553
            if not self.server_address[0]:
 
1194
 
                if self.address_family == socket.AF_INET6:
 
1195
 
                    any_address = u"::" # in6addr_any
 
1197
 
                    any_address = socket.INADDR_ANY
 
1198
 
                self.server_address = (any_address,
 
 
555
                self.server_address = (in6addr_any,
 
1199
556
                                       self.server_address[1])
 
1200
557
            elif not self.server_address[1]:
 
1201
558
                self.server_address = (self.server_address[0],
 
1203
 
#                 if self.interface:
 
 
560
#                 if self.settings["interface"]:
 
1204
561
#                     self.server_address = (self.server_address[0],
 
1207
564
#                                            if_nametoindex
 
1209
 
            return socketserver.TCPServer.server_bind(self)
 
1212
 
class MandosServer(IPv6_TCPServer):
 
1216
 
        clients:        set of Client objects
 
1217
 
        gnutls_priority GnuTLS priority string
 
1218
 
        use_dbus:       Boolean; to emit D-Bus signals or not
 
1220
 
    Assumes a gobject.MainLoop event loop.
 
1222
 
    def __init__(self, server_address, RequestHandlerClass,
 
1223
 
                 interface=None, use_ipv6=True, clients=None,
 
1224
 
                 gnutls_priority=None, use_dbus=True):
 
1225
 
        self.enabled = False
 
1226
 
        self.clients = clients
 
1227
 
        if self.clients is None:
 
1228
 
            self.clients = set()
 
1229
 
        self.use_dbus = use_dbus
 
1230
 
        self.gnutls_priority = gnutls_priority
 
1231
 
        IPv6_TCPServer.__init__(self, server_address,
 
1232
 
                                RequestHandlerClass,
 
1233
 
                                interface = interface,
 
1234
 
                                use_ipv6 = use_ipv6)
 
 
567
            return super(type(self), self).server_bind()
 
1235
568
    def server_activate(self):
 
1236
569
        if self.enabled:
 
1237
 
            return socketserver.TCPServer.server_activate(self)
 
 
570
            return super(type(self), self).server_activate()
 
1238
571
    def enable(self):
 
1239
572
        self.enabled = True
 
1240
 
    def add_pipe(self, pipe):
 
1241
 
        # Call "handle_ipc" for both data and EOF events
 
1242
 
        gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
 
1244
 
    def handle_ipc(self, source, condition, file_objects={}):
 
1246
 
            gobject.IO_IN: u"IN",   # There is data to read.
 
1247
 
            gobject.IO_OUT: u"OUT", # Data can be written (without
 
1249
 
            gobject.IO_PRI: u"PRI", # There is urgent data to read.
 
1250
 
            gobject.IO_ERR: u"ERR", # Error condition.
 
1251
 
            gobject.IO_HUP: u"HUP"  # Hung up (the connection has been
 
1252
 
                                    # broken, usually for pipes and
 
1255
 
        conditions_string = ' | '.join(name
 
1257
 
                                       condition_names.iteritems()
 
1258
 
                                       if cond & condition)
 
1259
 
        logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
 
1262
 
        # Turn the pipe file descriptor into a Python file object
 
1263
 
        if source not in file_objects:
 
1264
 
            file_objects[source] = os.fdopen(source, u"r", 1)
 
1266
 
        # Read a line from the file object
 
1267
 
        cmdline = file_objects[source].readline()
 
1268
 
        if not cmdline:             # Empty line means end of file
 
1269
 
            # close the IPC pipe
 
1270
 
            file_objects[source].close()
 
1271
 
            del file_objects[source]
 
1273
 
            # Stop calling this function
 
1276
 
        logger.debug(u"IPC command: %r", cmdline)
 
1278
 
        # Parse and act on command
 
1279
 
        cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
 
1281
 
        if cmd == u"NOTFOUND":
 
1282
 
            logger.warning(u"Client not found for fingerprint: %s",
 
1286
 
                mandos_dbus_service.ClientNotFound(args)
 
1287
 
        elif cmd == u"INVALID":
 
1288
 
            for client in self.clients:
 
1289
 
                if client.name == args:
 
1290
 
                    logger.warning(u"Client %s is invalid", args)
 
1296
 
                logger.error(u"Unknown client %s is invalid", args)
 
1297
 
        elif cmd == u"SENDING":
 
1298
 
            for client in self.clients:
 
1299
 
                if client.name == args:
 
1300
 
                    logger.info(u"Sending secret to %s", client.name)
 
1307
 
                logger.error(u"Sending secret to unknown client %s",
 
1310
 
            logger.error(u"Unknown IPC command: %r", cmdline)
 
1312
 
        # Keep calling this function
 
1316
575
def string_to_delta(interval):
 
1317
576
    """Parse a string and return a datetime.timedelta
 
1319
 
    >>> string_to_delta(u'7d')
 
 
578
    >>> string_to_delta('7d')
 
1320
579
    datetime.timedelta(7)
 
1321
 
    >>> string_to_delta(u'60s')
 
 
580
    >>> string_to_delta('60s')
 
1322
581
    datetime.timedelta(0, 60)
 
1323
 
    >>> string_to_delta(u'60m')
 
 
582
    >>> string_to_delta('60m')
 
1324
583
    datetime.timedelta(0, 3600)
 
1325
 
    >>> string_to_delta(u'24h')
 
 
584
    >>> string_to_delta('24h')
 
1326
585
    datetime.timedelta(1)
 
1327
586
    >>> string_to_delta(u'1w')
 
1328
587
    datetime.timedelta(7)
 
1329
 
    >>> string_to_delta(u'5m 30s')
 
 
588
    >>> string_to_delta('5m 30s')
 
1330
589
    datetime.timedelta(0, 330)
 
1332
591
    timevalue = datetime.timedelta(0)
 
1333
592
    for s in interval.split():
 
1335
 
            suffix = unicode(s[-1])
 
 
594
            suffix=unicode(s[-1])
 
1337
596
            if suffix == u"d":
 
1338
597
                delta = datetime.timedelta(value)
 
1339
598
            elif suffix == u"s":
 
 
1441
716
    # Default values for config file for server-global settings
 
1442
 
    server_defaults = { u"interface": u"",
 
1447
 
                        u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
1448
 
                        u"servicename": u"Mandos",
 
1449
 
                        u"use_dbus": u"True",
 
1450
 
                        u"use_ipv6": u"True",
 
 
717
    server_defaults = { "interface": "",
 
 
722
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
 
723
                        "servicename": "Mandos",
 
1453
726
    # Parse config file for server-global settings
 
1454
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
 
727
    server_config = ConfigParser.SafeConfigParser(server_defaults)
 
1455
728
    del server_defaults
 
1456
 
    server_config.read(os.path.join(options.configdir,
 
 
729
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
1458
730
    # Convert the SafeConfigParser object to a dict
 
1459
731
    server_settings = server_config.defaults()
 
1460
 
    # Use the appropriate methods on the non-string config options
 
1461
 
    for option in (u"debug", u"use_dbus", u"use_ipv6"):
 
1462
 
        server_settings[option] = server_config.getboolean(u"DEFAULT",
 
1464
 
    if server_settings["port"]:
 
1465
 
        server_settings["port"] = server_config.getint(u"DEFAULT",
 
 
732
    # Use getboolean on the boolean config option
 
 
733
    server_settings["debug"] = server_config.getboolean\
 
1467
735
    del server_config
 
1469
737
    # Override the settings from the config file with command line
 
1470
738
    # options, if set.
 
1471
 
    for option in (u"interface", u"address", u"port", u"debug",
 
1472
 
                   u"priority", u"servicename", u"configdir",
 
1473
 
                   u"use_dbus", u"use_ipv6"):
 
 
739
    for option in ("interface", "address", "port", "debug",
 
 
740
                   "priority", "servicename", "configdir"):
 
1474
741
        value = getattr(options, option)
 
1475
742
        if value is not None:
 
1476
743
            server_settings[option] = value
 
1478
 
    # Force all strings to be unicode
 
1479
 
    for option in server_settings.keys():
 
1480
 
        if type(server_settings[option]) is str:
 
1481
 
            server_settings[option] = unicode(server_settings[option])
 
1482
745
    # Now we have our good server settings in "server_settings"
 
1484
 
    ##################################################################
 
1487
 
    debug = server_settings[u"debug"]
 
1488
 
    use_dbus = server_settings[u"use_dbus"]
 
1489
 
    use_ipv6 = server_settings[u"use_ipv6"]
 
 
747
    debug = server_settings["debug"]
 
1492
750
        syslogger.setLevel(logging.WARNING)
 
1493
751
        console.setLevel(logging.WARNING)
 
1495
 
    if server_settings[u"servicename"] != u"Mandos":
 
1496
 
        syslogger.setFormatter(logging.Formatter
 
1497
 
                               (u'Mandos (%s) [%%(process)d]:'
 
1498
 
                                u' %%(levelname)s: %%(message)s'
 
1499
 
                                % server_settings[u"servicename"]))
 
 
753
    if server_settings["servicename"] != "Mandos":
 
 
754
        syslogger.setFormatter(logging.Formatter\
 
 
755
                               ('Mandos (%s): %%(levelname)s:'
 
 
757
                                % server_settings["servicename"]))
 
1501
759
    # Parse config file with clients
 
1502
 
    client_defaults = { u"timeout": u"1h",
 
1504
 
                        u"checker": u"fping -q -- %%(host)s",
 
 
760
    client_defaults = { "timeout": "1h",
 
 
762
                        "checker": "fping -q -- %(host)s",
 
1507
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
1508
 
    client_config.read(os.path.join(server_settings[u"configdir"],
 
1511
 
    global mandos_dbus_service
 
1512
 
    mandos_dbus_service = None
 
1514
 
    tcp_server = MandosServer((server_settings[u"address"],
 
1515
 
                               server_settings[u"port"]),
 
1517
 
                              interface=server_settings[u"interface"],
 
1520
 
                              server_settings[u"priority"],
 
1522
 
    pidfilename = u"/var/run/mandos.pid"
 
1524
 
        pidfile = open(pidfilename, u"w")
 
1526
 
        logger.error(u"Could not open file %r", pidfilename)
 
1529
 
        uid = pwd.getpwnam(u"_mandos").pw_uid
 
1530
 
        gid = pwd.getpwnam(u"_mandos").pw_gid
 
1533
 
            uid = pwd.getpwnam(u"mandos").pw_uid
 
1534
 
            gid = pwd.getpwnam(u"mandos").pw_gid
 
1537
 
                uid = pwd.getpwnam(u"nobody").pw_uid
 
1538
 
                gid = pwd.getpwnam(u"nobody").pw_gid
 
 
765
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
 
766
    client_config.read(os.path.join(server_settings["configdir"],
 
 
770
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
 
771
                                 server_settings["port"]),
 
 
773
                                settings=server_settings,
 
 
775
    pidfilename = "/var/run/mandos.pid"
 
 
777
        pidfile = open(pidfilename, "w")
 
 
778
    except IOError, error:
 
 
779
        logger.error("Could not open file %r", pidfilename)
 
 
784
        uid = pwd.getpwnam("mandos").pw_uid
 
 
787
            uid = pwd.getpwnam("nobody").pw_uid
 
 
791
        gid = pwd.getpwnam("mandos").pw_gid
 
 
794
            gid = pwd.getpwnam("nogroup").pw_gid
 
1545
800
    except OSError, error:
 
1546
801
        if error[0] != errno.EPERM:
 
1549
 
    # Enable all possible GnuTLS debugging
 
1551
 
        # "Use a log level over 10 to enable all debugging options."
 
1553
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
1555
 
        @gnutls.library.types.gnutls_log_func
 
1556
 
        def debug_gnutls(level, string):
 
1557
 
            logger.debug(u"GnuTLS: %s", string[:-1])
 
1559
 
        (gnutls.library.functions
 
1560
 
         .gnutls_global_set_log_function(debug_gnutls))
 
 
805
    service = AvahiService(name = server_settings["servicename"],
 
 
806
                           type = "_mandos._tcp", );
 
 
807
    if server_settings["interface"]:
 
 
808
        service.interface = if_nametoindex\
 
 
809
                            (server_settings["interface"])
 
1562
811
    global main_loop
 
1563
814
    # From the Avahi example code
 
1564
815
    DBusGMainLoop(set_as_default=True )
 
1565
816
    main_loop = gobject.MainLoop()
 
1566
817
    bus = dbus.SystemBus()
 
 
818
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
 
 
819
                                           avahi.DBUS_PATH_SERVER),
 
 
820
                            avahi.DBUS_INTERFACE_SERVER)
 
1567
821
    # End of Avahi example code
 
1569
 
        bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
 
1570
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
1571
 
    service = AvahiService(name = server_settings[u"servicename"],
 
1572
 
                           servicetype = u"_mandos._tcp",
 
1573
 
                           protocol = protocol, bus = bus)
 
1574
 
    if server_settings["interface"]:
 
1575
 
        service.interface = (if_nametoindex
 
1576
 
                             (str(server_settings[u"interface"])))
 
1578
 
    client_class = Client
 
1580
 
        client_class = functools.partial(ClientDBus, bus = bus)
 
1581
 
    tcp_server.clients.update(set(
 
1582
 
            client_class(name = section,
 
1583
 
                         config= dict(client_config.items(section)))
 
1584
 
            for section in client_config.sections()))
 
1585
 
    if not tcp_server.clients:
 
1586
 
        logger.warning(u"No clients defined")
 
 
823
    def remove_from_clients(client):
 
 
824
        clients.remove(client)
 
 
826
            logger.critical(u"No clients left, exiting")
 
 
829
    clients.update(Set(Client(name = section,
 
 
830
                              stop_hook = remove_from_clients,
 
 
832
                              = dict(client_config.items(section)))
 
 
833
                       for section in client_config.sections()))
 
 
835
        logger.critical(u"No clients defined")
 
1589
839
        # Redirect stdin so all checkers get /dev/null