/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-08-10 09:00:23 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150810090023-fz6vjqr7zf33e2tf
Support the standard org.freedesktop.DBus.ObjectManager interface.

Now that the D-Bus standard has an interface to keep track of new and
removed objects, use that instead of our own methods.  This deprecates
our D-Bus methods "GetAllClients" and "GetAllClientsWithProperties"
and the signals "ClientAdded" and "ClientRemoved", all on the server
interface "se.recompile.Mandos".

* DBUS-API: Removed references to deprecated methods and signals;
  insert reference to the org.freedesktop.DBus.ObjectManager
  interface.
* mandos (DBusObjectWithProperties._get_all_interface_names): New.
  (dbus.OBJECT_MANAGER_IFACE): If not present, monkey patch.
  (DBusObjectWithObjectManager): New.
  (main/MandosDBusService): Inherit from DBusObjectWithObjectManager.
  (main/MandosDBusService.ClientRemoved): Annotate as deprecated.
  (main/MandosDBusService.GetAllClients): - '' -
  (main/MandosDBusService.GetAllClientsWithProperties): Annotate as
                                                        deprecated.
                                                        Also only
                                                        return
                                                        properties on
                                                        client
                                                        interface.
  (main/MandosDBusService.RemoveClient): Call client_removed_signal
                                         instead of ClientRemoved.
  (main/MandosDBusService.GetManagedObjects): New.
  (main/MandosDBusService.client_added_signal): New.
  (main/MandosDBusService.client_removed_signal): - '' -
  (main/cleanup): Call "client_removed_signal" instead of sending
                  "ClientRemoved" signal directly.
  (main): Call "client_added_signal" instead of sending "ClientAdded"
          signal directly.
* mandos-ctl: Use GetManagedObjects instead of
              GetAllClientsWithProperties.  Also, show better error
              message in case of failure to connect to the D-Bus

* mandos-monitor (MandosClientPropertyCache.properties_changed):
  Bug fix; only update properties on client interface.
  (UserInterface.find_and_remove_client): Change to accept arguments
                                          from InterfacesRemoved
                                          signal.  Also, bug fix:
                                          working error message when
                                          removing unknown client.
  (UserInterface.add_new_client): Change to accept arguments from
                                  InterfacesRemoved signal.  Pass
                                  properties to MandosClientWidget
                                  constructor.
  (UserInterface.run): Connect find_and_remove_client method to
                       InterfacesRemoved signal and the add_new_client
                       method to the InterfacesAdded signal.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
 
1
#!/usr/bin/python2.7
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2013 Teddy Hogeborn
15
 
# Copyright © 2008-2013 Björn Påhlsson
 
14
# Copyright © 2008-2015 Teddy Hogeborn
 
15
# Copyright © 2008-2015 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
36
36
 
37
37
from future_builtins import *
38
38
 
39
 
import SocketServer as socketserver
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
40
43
import socket
41
44
import argparse
42
45
import datetime
47
50
import gnutls.library.functions
48
51
import gnutls.library.constants
49
52
import gnutls.library.types
50
 
import ConfigParser as configparser
 
53
try:
 
54
    import ConfigParser as configparser
 
55
except ImportError:
 
56
    import configparser
51
57
import sys
52
58
import re
53
59
import os
62
68
import struct
63
69
import fcntl
64
70
import functools
65
 
import cPickle as pickle
 
71
try:
 
72
    import cPickle as pickle
 
73
except ImportError:
 
74
    import pickle
66
75
import multiprocessing
67
76
import types
68
77
import binascii
69
78
import tempfile
70
79
import itertools
71
80
import collections
 
81
import codecs
72
82
 
73
83
import dbus
74
84
import dbus.service
75
 
import gobject
 
85
try:
 
86
    import gobject
 
87
except ImportError:
 
88
    from gi.repository import GObject as gobject
76
89
import avahi
77
90
from dbus.mainloop.glib import DBusGMainLoop
78
91
import ctypes
88
101
    except ImportError:
89
102
        SO_BINDTODEVICE = None
90
103
 
91
 
version = "1.6.1"
 
104
if sys.version_info.major == 2:
 
105
    str = unicode
 
106
 
 
107
version = "1.6.9"
92
108
stored_state_file = "clients.pickle"
93
109
 
94
110
logger = logging.getLogger()
95
 
syslogger = (logging.handlers.SysLogHandler
96
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
 
              address = str("/dev/log")))
 
111
syslogger = None
98
112
 
99
113
try:
100
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
101
 
                      (ctypes.util.find_library("c"))
102
 
                      .if_nametoindex)
 
114
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
115
        ctypes.util.find_library("c")).if_nametoindex
103
116
except (OSError, AttributeError):
 
117
    
104
118
    def if_nametoindex(interface):
105
119
        "Get an interface index the hard way, i.e. using fcntl()"
106
120
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
107
121
        with contextlib.closing(socket.socket()) as s:
108
122
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
109
 
                                struct.pack(str("16s16x"),
110
 
                                            interface))
111
 
        interface_index = struct.unpack(str("I"),
112
 
                                        ifreq[16:20])[0]
 
123
                                struct.pack(b"16s16x", interface))
 
124
        interface_index = struct.unpack("I", ifreq[16:20])[0]
113
125
        return interface_index
114
126
 
115
127
 
116
128
def initlogger(debug, level=logging.WARNING):
117
129
    """init logger and add loglevel"""
118
130
    
 
131
    global syslogger
 
132
    syslogger = (logging.handlers.SysLogHandler(
 
133
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
134
        address = "/dev/log"))
119
135
    syslogger.setFormatter(logging.Formatter
120
136
                           ('Mandos [%(process)d]: %(levelname)s:'
121
137
                            ' %(message)s'))
138
154
 
139
155
class PGPEngine(object):
140
156
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
157
    
141
158
    def __init__(self):
142
159
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
143
160
        self.gnupgargs = ['--batch',
182
199
    
183
200
    def encrypt(self, data, password):
184
201
        passphrase = self.password_encode(password)
185
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
186
 
                                         ) as passfile:
 
202
        with tempfile.NamedTemporaryFile(
 
203
                dir=self.tempdir) as passfile:
187
204
            passfile.write(passphrase)
188
205
            passfile.flush()
189
206
            proc = subprocess.Popen(['gpg', '--symmetric',
200
217
    
201
218
    def decrypt(self, data, password):
202
219
        passphrase = self.password_encode(password)
203
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
204
 
                                         ) as passfile:
 
220
        with tempfile.NamedTemporaryFile(
 
221
                dir = self.tempdir) as passfile:
205
222
            passfile.write(passphrase)
206
223
            passfile.flush()
207
224
            proc = subprocess.Popen(['gpg', '--decrypt',
211
228
                                    stdin = subprocess.PIPE,
212
229
                                    stdout = subprocess.PIPE,
213
230
                                    stderr = subprocess.PIPE)
214
 
            decrypted_plaintext, err = proc.communicate(input
215
 
                                                        = data)
 
231
            decrypted_plaintext, err = proc.communicate(input = data)
216
232
        if proc.returncode != 0:
217
233
            raise PGPError(err)
218
234
        return decrypted_plaintext
221
237
class AvahiError(Exception):
222
238
    def __init__(self, value, *args, **kwargs):
223
239
        self.value = value
224
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
225
 
    def __unicode__(self):
226
 
        return unicode(repr(self.value))
 
240
        return super(AvahiError, self).__init__(value, *args,
 
241
                                                **kwargs)
 
242
 
227
243
 
228
244
class AvahiServiceError(AvahiError):
229
245
    pass
230
246
 
 
247
 
231
248
class AvahiGroupError(AvahiError):
232
249
    pass
233
250
 
253
270
    bus: dbus.SystemBus()
254
271
    """
255
272
    
256
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
257
 
                 servicetype = None, port = None, TXT = None,
258
 
                 domain = "", host = "", max_renames = 32768,
259
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
273
    def __init__(self,
 
274
                 interface = avahi.IF_UNSPEC,
 
275
                 name = None,
 
276
                 servicetype = None,
 
277
                 port = None,
 
278
                 TXT = None,
 
279
                 domain = "",
 
280
                 host = "",
 
281
                 max_renames = 32768,
 
282
                 protocol = avahi.PROTO_UNSPEC,
 
283
                 bus = None):
260
284
        self.interface = interface
261
285
        self.name = name
262
286
        self.type = servicetype
272
296
        self.bus = bus
273
297
        self.entry_group_state_changed_match = None
274
298
    
275
 
    def rename(self):
 
299
    def rename(self, remove=True):
276
300
        """Derived from the Avahi example code"""
277
301
        if self.rename_count >= self.max_renames:
278
302
            logger.critical("No suitable Zeroconf service name found"
279
303
                            " after %i retries, exiting.",
280
304
                            self.rename_count)
281
305
            raise AvahiServiceError("Too many renames")
282
 
        self.name = unicode(self.server
283
 
                            .GetAlternativeServiceName(self.name))
 
306
        self.name = str(
 
307
            self.server.GetAlternativeServiceName(self.name))
 
308
        self.rename_count += 1
284
309
        logger.info("Changing Zeroconf service name to %r ...",
285
310
                    self.name)
286
 
        self.remove()
 
311
        if remove:
 
312
            self.remove()
287
313
        try:
288
314
            self.add()
289
315
        except dbus.exceptions.DBusException as error:
290
 
            logger.critical("D-Bus Exception", exc_info=error)
291
 
            self.cleanup()
292
 
            os._exit(1)
293
 
        self.rename_count += 1
 
316
            if (error.get_dbus_name()
 
317
                == "org.freedesktop.Avahi.CollisionError"):
 
318
                logger.info("Local Zeroconf service name collision.")
 
319
                return self.rename(remove=False)
 
320
            else:
 
321
                logger.critical("D-Bus Exception", exc_info=error)
 
322
                self.cleanup()
 
323
                os._exit(1)
294
324
    
295
325
    def remove(self):
296
326
        """Derived from the Avahi example code"""
334
364
            self.rename()
335
365
        elif state == avahi.ENTRY_GROUP_FAILURE:
336
366
            logger.critical("Avahi: Error in group state changed %s",
337
 
                            unicode(error))
338
 
            raise AvahiGroupError("State changed: {0!s}"
339
 
                                  .format(error))
 
367
                            str(error))
 
368
            raise AvahiGroupError("State changed: {!s}".format(error))
340
369
    
341
370
    def cleanup(self):
342
371
        """Derived from the Avahi example code"""
352
381
    def server_state_changed(self, state, error=None):
353
382
        """Derived from the Avahi example code"""
354
383
        logger.debug("Avahi server state change: %i", state)
355
 
        bad_states = { avahi.SERVER_INVALID:
356
 
                           "Zeroconf server invalid",
357
 
                       avahi.SERVER_REGISTERING: None,
358
 
                       avahi.SERVER_COLLISION:
359
 
                           "Zeroconf server name collision",
360
 
                       avahi.SERVER_FAILURE:
361
 
                           "Zeroconf server failure" }
 
384
        bad_states = {
 
385
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
386
            avahi.SERVER_REGISTERING: None,
 
387
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
388
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
389
        }
362
390
        if state in bad_states:
363
391
            if bad_states[state] is not None:
364
392
                if error is None:
367
395
                    logger.error(bad_states[state] + ": %r", error)
368
396
            self.cleanup()
369
397
        elif state == avahi.SERVER_RUNNING:
370
 
            self.add()
 
398
            try:
 
399
                self.add()
 
400
            except dbus.exceptions.DBusException as error:
 
401
                if (error.get_dbus_name()
 
402
                    == "org.freedesktop.Avahi.CollisionError"):
 
403
                    logger.info("Local Zeroconf service name"
 
404
                                " collision.")
 
405
                    return self.rename(remove=False)
 
406
                else:
 
407
                    logger.critical("D-Bus Exception", exc_info=error)
 
408
                    self.cleanup()
 
409
                    os._exit(1)
371
410
        else:
372
411
            if error is None:
373
412
                logger.debug("Unknown state: %r", state)
383
422
                                    follow_name_owner_changes=True),
384
423
                avahi.DBUS_INTERFACE_SERVER)
385
424
        self.server.connect_to_signal("StateChanged",
386
 
                                 self.server_state_changed)
 
425
                                      self.server_state_changed)
387
426
        self.server_state_changed(self.server.GetState())
388
427
 
389
428
 
390
429
class AvahiServiceToSyslog(AvahiService):
391
 
    def rename(self):
 
430
    def rename(self, *args, **kwargs):
392
431
        """Add the new name to the syslog messages"""
393
 
        ret = AvahiService.rename(self)
394
 
        syslogger.setFormatter(logging.Formatter
395
 
                               ('Mandos ({0}) [%(process)d]:'
396
 
                                ' %(levelname)s: %(message)s'
397
 
                                .format(self.name)))
 
432
        ret = AvahiService.rename(self, *args, **kwargs)
 
433
        syslogger.setFormatter(logging.Formatter(
 
434
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
435
            .format(self.name)))
398
436
        return ret
399
437
 
400
 
 
401
 
def timedelta_to_milliseconds(td):
402
 
    "Convert a datetime.timedelta() to milliseconds"
403
 
    return ((td.days * 24 * 60 * 60 * 1000)
404
 
            + (td.seconds * 1000)
405
 
            + (td.microseconds // 1000))
406
 
 
 
438
def call_pipe(connection,       # : multiprocessing.Connection
 
439
              func, *args, **kwargs):
 
440
    """This function is meant to be called by multiprocessing.Process
 
441
    
 
442
    This function runs func(*args, **kwargs), and writes the resulting
 
443
    return value on the provided multiprocessing.Connection.
 
444
    """
 
445
    connection.send(func(*args, **kwargs))
 
446
    connection.close()
407
447
 
408
448
class Client(object):
409
449
    """A representation of a client host served by this server.
436
476
    last_checker_status: integer between 0 and 255 reflecting exit
437
477
                         status of last checker. -1 reflects crashed
438
478
                         checker, -2 means no checker completed yet.
 
479
    last_checker_signal: The signal which killed the last checker, if
 
480
                         last_checker_status is -1
439
481
    last_enabled: datetime.datetime(); (UTC) or None
440
482
    name:       string; from the config file, used in log messages and
441
483
                        D-Bus identifiers
454
496
                          "fingerprint", "host", "interval",
455
497
                          "last_approval_request", "last_checked_ok",
456
498
                          "last_enabled", "name", "timeout")
457
 
    client_defaults = { "timeout": "PT5M",
458
 
                        "extended_timeout": "PT15M",
459
 
                        "interval": "PT2M",
460
 
                        "checker": "fping -q -- %%(host)s",
461
 
                        "host": "",
462
 
                        "approval_delay": "PT0S",
463
 
                        "approval_duration": "PT1S",
464
 
                        "approved_by_default": "True",
465
 
                        "enabled": "True",
466
 
                        }
467
 
    
468
 
    def timeout_milliseconds(self):
469
 
        "Return the 'timeout' attribute in milliseconds"
470
 
        return timedelta_to_milliseconds(self.timeout)
471
 
    
472
 
    def extended_timeout_milliseconds(self):
473
 
        "Return the 'extended_timeout' attribute in milliseconds"
474
 
        return timedelta_to_milliseconds(self.extended_timeout)
475
 
    
476
 
    def interval_milliseconds(self):
477
 
        "Return the 'interval' attribute in milliseconds"
478
 
        return timedelta_to_milliseconds(self.interval)
479
 
    
480
 
    def approval_delay_milliseconds(self):
481
 
        return timedelta_to_milliseconds(self.approval_delay)
 
499
    client_defaults = {
 
500
        "timeout": "PT5M",
 
501
        "extended_timeout": "PT15M",
 
502
        "interval": "PT2M",
 
503
        "checker": "fping -q -- %%(host)s",
 
504
        "host": "",
 
505
        "approval_delay": "PT0S",
 
506
        "approval_duration": "PT1S",
 
507
        "approved_by_default": "True",
 
508
        "enabled": "True",
 
509
    }
482
510
    
483
511
    @staticmethod
484
512
    def config_parser(config):
500
528
            client["enabled"] = config.getboolean(client_name,
501
529
                                                  "enabled")
502
530
            
 
531
            # Uppercase and remove spaces from fingerprint for later
 
532
            # comparison purposes with return value from the
 
533
            # fingerprint() function
503
534
            client["fingerprint"] = (section["fingerprint"].upper()
504
535
                                     .replace(" ", ""))
505
536
            if "secret" in section:
510
541
                          "rb") as secfile:
511
542
                    client["secret"] = secfile.read()
512
543
            else:
513
 
                raise TypeError("No secret or secfile for section {0}"
 
544
                raise TypeError("No secret or secfile for section {}"
514
545
                                .format(section))
515
546
            client["timeout"] = string_to_delta(section["timeout"])
516
547
            client["extended_timeout"] = string_to_delta(
533
564
            server_settings = {}
534
565
        self.server_settings = server_settings
535
566
        # adding all client settings
536
 
        for setting, value in settings.iteritems():
 
567
        for setting, value in settings.items():
537
568
            setattr(self, setting, value)
538
569
        
539
570
        if self.enabled:
547
578
            self.expires = None
548
579
        
549
580
        logger.debug("Creating client %r", self.name)
550
 
        # Uppercase and remove spaces from fingerprint for later
551
 
        # comparison purposes with return value from the fingerprint()
552
 
        # function
553
581
        logger.debug("  Fingerprint: %s", self.fingerprint)
554
582
        self.created = settings.get("created",
555
583
                                    datetime.datetime.utcnow())
562
590
        self.current_checker_command = None
563
591
        self.approved = None
564
592
        self.approvals_pending = 0
565
 
        self.changedstate = (multiprocessing_manager
566
 
                             .Condition(multiprocessing_manager
567
 
                                        .Lock()))
568
 
        self.client_structure = [attr for attr in
569
 
                                 self.__dict__.iterkeys()
 
593
        self.changedstate = multiprocessing_manager.Condition(
 
594
            multiprocessing_manager.Lock())
 
595
        self.client_structure = [attr
 
596
                                 for attr in self.__dict__.iterkeys()
570
597
                                 if not attr.startswith("_")]
571
598
        self.client_structure.append("client_structure")
572
599
        
573
 
        for name, t in inspect.getmembers(type(self),
574
 
                                          lambda obj:
575
 
                                              isinstance(obj,
576
 
                                                         property)):
 
600
        for name, t in inspect.getmembers(
 
601
                type(self), lambda obj: isinstance(obj, property)):
577
602
            if not name.startswith("_"):
578
603
                self.client_structure.append(name)
579
604
    
621
646
        # and every interval from then on.
622
647
        if self.checker_initiator_tag is not None:
623
648
            gobject.source_remove(self.checker_initiator_tag)
624
 
        self.checker_initiator_tag = (gobject.timeout_add
625
 
                                      (self.interval_milliseconds(),
626
 
                                       self.start_checker))
 
649
        self.checker_initiator_tag = gobject.timeout_add(
 
650
            int(self.interval.total_seconds() * 1000),
 
651
            self.start_checker)
627
652
        # Schedule a disable() when 'timeout' has passed
628
653
        if self.disable_initiator_tag is not None:
629
654
            gobject.source_remove(self.disable_initiator_tag)
630
 
        self.disable_initiator_tag = (gobject.timeout_add
631
 
                                   (self.timeout_milliseconds(),
632
 
                                    self.disable))
 
655
        self.disable_initiator_tag = gobject.timeout_add(
 
656
            int(self.timeout.total_seconds() * 1000), self.disable)
633
657
        # Also start a new checker *right now*.
634
658
        self.start_checker()
635
659
    
636
 
    def checker_callback(self, pid, condition, command):
 
660
    def checker_callback(self, source, condition, connection,
 
661
                         command):
637
662
        """The checker has completed, so take appropriate actions."""
638
663
        self.checker_callback_tag = None
639
664
        self.checker = None
640
 
        if os.WIFEXITED(condition):
641
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
665
        # Read return code from connection (see call_pipe)
 
666
        returncode = connection.recv()
 
667
        connection.close()
 
668
        
 
669
        if returncode >= 0:
 
670
            self.last_checker_status = returncode
 
671
            self.last_checker_signal = None
642
672
            if self.last_checker_status == 0:
643
673
                logger.info("Checker for %(name)s succeeded",
644
674
                            vars(self))
645
675
                self.checked_ok()
646
676
            else:
647
 
                logger.info("Checker for %(name)s failed",
648
 
                            vars(self))
 
677
                logger.info("Checker for %(name)s failed", vars(self))
649
678
        else:
650
679
            self.last_checker_status = -1
 
680
            self.last_checker_signal = -returncode
651
681
            logger.warning("Checker for %(name)s crashed?",
652
682
                           vars(self))
 
683
        return False
653
684
    
654
685
    def checked_ok(self):
655
686
        """Assert that the client has been seen, alive and well."""
656
687
        self.last_checked_ok = datetime.datetime.utcnow()
657
688
        self.last_checker_status = 0
 
689
        self.last_checker_signal = None
658
690
        self.bump_timeout()
659
691
    
660
692
    def bump_timeout(self, timeout=None):
665
697
            gobject.source_remove(self.disable_initiator_tag)
666
698
            self.disable_initiator_tag = None
667
699
        if getattr(self, "enabled", False):
668
 
            self.disable_initiator_tag = (gobject.timeout_add
669
 
                                          (timedelta_to_milliseconds
670
 
                                           (timeout), self.disable))
 
700
            self.disable_initiator_tag = gobject.timeout_add(
 
701
                int(timeout.total_seconds() * 1000), self.disable)
671
702
            self.expires = datetime.datetime.utcnow() + timeout
672
703
    
673
704
    def need_approval(self):
687
718
        # than 'timeout' for the client to be disabled, which is as it
688
719
        # should be.
689
720
        
690
 
        # If a checker exists, make sure it is not a zombie
691
 
        try:
692
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
693
 
        except (AttributeError, OSError) as error:
694
 
            if (isinstance(error, OSError)
695
 
                and error.errno != errno.ECHILD):
696
 
                raise error
697
 
        else:
698
 
            if pid:
699
 
                logger.warning("Checker was a zombie")
700
 
                gobject.source_remove(self.checker_callback_tag)
701
 
                self.checker_callback(pid, status,
702
 
                                      self.current_checker_command)
 
721
        if self.checker is not None and not self.checker.is_alive():
 
722
            logger.warning("Checker was not alive; joining")
 
723
            self.checker.join()
 
724
            self.checker = None
703
725
        # Start a new checker if needed
704
726
        if self.checker is None:
705
727
            # Escape attributes for the shell
706
 
            escaped_attrs = dict(
707
 
                (attr, re.escape(unicode(getattr(self, attr))))
708
 
                for attr in
709
 
                self.runtime_expansions)
 
728
            escaped_attrs = {
 
729
                attr: re.escape(str(getattr(self, attr)))
 
730
                for attr in self.runtime_expansions }
710
731
            try:
711
732
                command = self.checker_command % escaped_attrs
712
733
            except TypeError as error:
713
734
                logger.error('Could not format string "%s"',
714
 
                             self.checker_command, exc_info=error)
715
 
                return True # Try again later
 
735
                             self.checker_command,
 
736
                             exc_info=error)
 
737
                return True     # Try again later
716
738
            self.current_checker_command = command
717
 
            try:
718
 
                logger.info("Starting checker %r for %s",
719
 
                            command, self.name)
720
 
                # We don't need to redirect stdout and stderr, since
721
 
                # in normal mode, that is already done by daemon(),
722
 
                # and in debug mode we don't want to.  (Stdin is
723
 
                # always replaced by /dev/null.)
724
 
                # The exception is when not debugging but nevertheless
725
 
                # running in the foreground; use the previously
726
 
                # created wnull.
727
 
                popen_args = {}
728
 
                if (not self.server_settings["debug"]
729
 
                    and self.server_settings["foreground"]):
730
 
                    popen_args.update({"stdout": wnull,
731
 
                                       "stderr": wnull })
732
 
                self.checker = subprocess.Popen(command,
733
 
                                                close_fds=True,
734
 
                                                shell=True, cwd="/",
735
 
                                                **popen_args)
736
 
            except OSError as error:
737
 
                logger.error("Failed to start subprocess",
738
 
                             exc_info=error)
739
 
                return True
740
 
            self.checker_callback_tag = (gobject.child_watch_add
741
 
                                         (self.checker.pid,
742
 
                                          self.checker_callback,
743
 
                                          data=command))
744
 
            # The checker may have completed before the gobject
745
 
            # watch was added.  Check for this.
746
 
            try:
747
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
748
 
            except OSError as error:
749
 
                if error.errno == errno.ECHILD:
750
 
                    # This should never happen
751
 
                    logger.error("Child process vanished",
752
 
                                 exc_info=error)
753
 
                    return True
754
 
                raise
755
 
            if pid:
756
 
                gobject.source_remove(self.checker_callback_tag)
757
 
                self.checker_callback(pid, status, command)
 
739
            logger.info("Starting checker %r for %s", command,
 
740
                        self.name)
 
741
            # We don't need to redirect stdout and stderr, since
 
742
            # in normal mode, that is already done by daemon(),
 
743
            # and in debug mode we don't want to.  (Stdin is
 
744
            # always replaced by /dev/null.)
 
745
            # The exception is when not debugging but nevertheless
 
746
            # running in the foreground; use the previously
 
747
            # created wnull.
 
748
            popen_args = { "close_fds": True,
 
749
                           "shell": True,
 
750
                           "cwd": "/" }
 
751
            if (not self.server_settings["debug"]
 
752
                and self.server_settings["foreground"]):
 
753
                popen_args.update({"stdout": wnull,
 
754
                                   "stderr": wnull })
 
755
            pipe = multiprocessing.Pipe(duplex = False)
 
756
            self.checker = multiprocessing.Process(
 
757
                target = call_pipe,
 
758
                args = (pipe[1], subprocess.call, command),
 
759
                kwargs = popen_args)
 
760
            self.checker.start()
 
761
            self.checker_callback_tag = gobject.io_add_watch(
 
762
                pipe[0].fileno(), gobject.IO_IN,
 
763
                self.checker_callback, pipe[0], command)
758
764
        # Re-run this periodically if run by gobject.timeout_add
759
765
        return True
760
766
    
766
772
        if getattr(self, "checker", None) is None:
767
773
            return
768
774
        logger.debug("Stopping checker for %(name)s", vars(self))
769
 
        try:
770
 
            self.checker.terminate()
771
 
            #time.sleep(0.5)
772
 
            #if self.checker.poll() is None:
773
 
            #    self.checker.kill()
774
 
        except OSError as error:
775
 
            if error.errno != errno.ESRCH: # No such process
776
 
                raise
 
775
        self.checker.terminate()
777
776
        self.checker = None
778
777
 
779
778
 
780
 
def dbus_service_property(dbus_interface, signature="v",
781
 
                          access="readwrite", byte_arrays=False):
 
779
def dbus_service_property(dbus_interface,
 
780
                          signature="v",
 
781
                          access="readwrite",
 
782
                          byte_arrays=False):
782
783
    """Decorators for marking methods of a DBusObjectWithProperties to
783
784
    become properties on the D-Bus.
784
785
    
793
794
    # "Set" method, so we fail early here:
794
795
    if byte_arrays and signature != "ay":
795
796
        raise ValueError("Byte arrays not supported for non-'ay'"
796
 
                         " signature {0!r}".format(signature))
 
797
                         " signature {!r}".format(signature))
 
798
    
797
799
    def decorator(func):
798
800
        func._dbus_is_property = True
799
801
        func._dbus_interface = dbus_interface
804
806
            func._dbus_name = func._dbus_name[:-14]
805
807
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
806
808
        return func
 
809
    
807
810
    return decorator
808
811
 
809
812
 
818
821
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
819
822
                    "false"}
820
823
    """
 
824
    
821
825
    def decorator(func):
822
826
        func._dbus_is_interface = True
823
827
        func._dbus_interface = dbus_interface
824
828
        func._dbus_name = dbus_interface
825
829
        return func
 
830
    
826
831
    return decorator
827
832
 
828
833
 
830
835
    """Decorator to annotate D-Bus methods, signals or properties
831
836
    Usage:
832
837
    
 
838
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
839
                       "org.freedesktop.DBus.Property."
 
840
                       "EmitsChangedSignal": "false"})
833
841
    @dbus_service_property("org.example.Interface", signature="b",
834
842
                           access="r")
835
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
836
 
                        "org.freedesktop.DBus.Property."
837
 
                        "EmitsChangedSignal": "false"})
838
843
    def Property_dbus_property(self):
839
844
        return dbus.Boolean(False)
 
845
    
 
846
    See also the DBusObjectWithAnnotations class.
840
847
    """
 
848
    
841
849
    def decorator(func):
842
850
        func._dbus_annotations = annotations
843
851
        return func
 
852
    
844
853
    return decorator
845
854
 
846
855
 
847
856
class DBusPropertyException(dbus.exceptions.DBusException):
848
857
    """A base class for D-Bus property-related exceptions
849
858
    """
850
 
    def __unicode__(self):
851
 
        return unicode(str(self))
 
859
    pass
852
860
 
853
861
 
854
862
class DBusPropertyAccessException(DBusPropertyException):
863
871
    pass
864
872
 
865
873
 
866
 
class DBusObjectWithProperties(dbus.service.Object):
867
 
    """A D-Bus object with properties.
 
874
class DBusObjectWithAnnotations(dbus.service.Object):
 
875
    """A D-Bus object with annotations.
868
876
    
869
 
    Classes inheriting from this can use the dbus_service_property
870
 
    decorator to expose methods as D-Bus properties.  It exposes the
871
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
877
    Classes inheriting from this can use the dbus_annotations
 
878
    decorator to add annotations to methods or signals.
872
879
    """
873
880
    
874
881
    @staticmethod
878
885
        If called like _is_dbus_thing("method") it returns a function
879
886
        suitable for use as predicate to inspect.getmembers().
880
887
        """
881
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
888
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
882
889
                                   False)
883
890
    
884
891
    def _get_all_dbus_things(self, thing):
885
892
        """Returns a generator of (name, attribute) pairs
886
893
        """
887
 
        return ((getattr(athing.__get__(self), "_dbus_name",
888
 
                         name),
 
894
        return ((getattr(athing.__get__(self), "_dbus_name", name),
889
895
                 athing.__get__(self))
890
896
                for cls in self.__class__.__mro__
891
897
                for name, athing in
892
 
                inspect.getmembers(cls,
893
 
                                   self._is_dbus_thing(thing)))
 
898
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
899
    
 
900
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
901
                         out_signature = "s",
 
902
                         path_keyword = 'object_path',
 
903
                         connection_keyword = 'connection')
 
904
    def Introspect(self, object_path, connection):
 
905
        """Overloading of standard D-Bus method.
 
906
        
 
907
        Inserts annotation tags on methods and signals.
 
908
        """
 
909
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
910
                                                   connection)
 
911
        try:
 
912
            document = xml.dom.minidom.parseString(xmlstring)
 
913
            
 
914
            for if_tag in document.getElementsByTagName("interface"):
 
915
                # Add annotation tags
 
916
                for typ in ("method", "signal"):
 
917
                    for tag in if_tag.getElementsByTagName(typ):
 
918
                        annots = dict()
 
919
                        for name, prop in (self.
 
920
                                           _get_all_dbus_things(typ)):
 
921
                            if (name == tag.getAttribute("name")
 
922
                                and prop._dbus_interface
 
923
                                == if_tag.getAttribute("name")):
 
924
                                annots.update(getattr(
 
925
                                    prop, "_dbus_annotations", {}))
 
926
                        for name, value in annots.items():
 
927
                            ann_tag = document.createElement(
 
928
                                "annotation")
 
929
                            ann_tag.setAttribute("name", name)
 
930
                            ann_tag.setAttribute("value", value)
 
931
                            tag.appendChild(ann_tag)
 
932
                # Add interface annotation tags
 
933
                for annotation, value in dict(
 
934
                    itertools.chain.from_iterable(
 
935
                        annotations().items()
 
936
                        for name, annotations
 
937
                        in self._get_all_dbus_things("interface")
 
938
                        if name == if_tag.getAttribute("name")
 
939
                        )).items():
 
940
                    ann_tag = document.createElement("annotation")
 
941
                    ann_tag.setAttribute("name", annotation)
 
942
                    ann_tag.setAttribute("value", value)
 
943
                    if_tag.appendChild(ann_tag)
 
944
                # Fix argument name for the Introspect method itself
 
945
                if (if_tag.getAttribute("name")
 
946
                                == dbus.INTROSPECTABLE_IFACE):
 
947
                    for cn in if_tag.getElementsByTagName("method"):
 
948
                        if cn.getAttribute("name") == "Introspect":
 
949
                            for arg in cn.getElementsByTagName("arg"):
 
950
                                if (arg.getAttribute("direction")
 
951
                                    == "out"):
 
952
                                    arg.setAttribute("name",
 
953
                                                     "xml_data")
 
954
            xmlstring = document.toxml("utf-8")
 
955
            document.unlink()
 
956
        except (AttributeError, xml.dom.DOMException,
 
957
                xml.parsers.expat.ExpatError) as error:
 
958
            logger.error("Failed to override Introspection method",
 
959
                         exc_info=error)
 
960
        return xmlstring
 
961
 
 
962
 
 
963
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
964
    """A D-Bus object with properties.
 
965
    
 
966
    Classes inheriting from this can use the dbus_service_property
 
967
    decorator to expose methods as D-Bus properties.  It exposes the
 
968
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
969
    """
894
970
    
895
971
    def _get_dbus_property(self, interface_name, property_name):
896
972
        """Returns a bound method if one exists which is a D-Bus
897
973
        property with the specified name and interface.
898
974
        """
899
 
        for cls in  self.__class__.__mro__:
900
 
            for name, value in (inspect.getmembers
901
 
                                (cls,
902
 
                                 self._is_dbus_thing("property"))):
 
975
        for cls in self.__class__.__mro__:
 
976
            for name, value in inspect.getmembers(
 
977
                    cls, self._is_dbus_thing("property")):
903
978
                if (value._dbus_name == property_name
904
979
                    and value._dbus_interface == interface_name):
905
980
                    return value.__get__(self)
906
981
        
907
982
        # No such property
908
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
909
 
                                   + interface_name + "."
910
 
                                   + property_name)
911
 
    
912
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
983
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
984
            self.dbus_object_path, interface_name, property_name))
 
985
    
 
986
    @classmethod
 
987
    def _get_all_interface_names(cls):
 
988
        """Get a sequence of all interfaces supported by an object"""
 
989
        return (name for name in set(getattr(getattr(x, attr),
 
990
                                             "_dbus_interface", None)
 
991
                                     for x in (inspect.getmro(cls))
 
992
                                     for attr in dir(x))
 
993
                if name is not None)
 
994
    
 
995
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
996
                         in_signature="ss",
913
997
                         out_signature="v")
914
998
    def Get(self, interface_name, property_name):
915
999
        """Standard D-Bus property Get() method, see D-Bus standard.
933
1017
            # The byte_arrays option is not supported yet on
934
1018
            # signatures other than "ay".
935
1019
            if prop._dbus_signature != "ay":
936
 
                raise ValueError
 
1020
                raise ValueError("Byte arrays not supported for non-"
 
1021
                                 "'ay' signature {!r}"
 
1022
                                 .format(prop._dbus_signature))
937
1023
            value = dbus.ByteArray(b''.join(chr(byte)
938
1024
                                            for byte in value))
939
1025
        prop(value)
940
1026
    
941
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1027
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1028
                         in_signature="s",
942
1029
                         out_signature="a{sv}")
943
1030
    def GetAll(self, interface_name):
944
1031
        """Standard D-Bus property GetAll() method, see D-Bus
959
1046
            if not hasattr(value, "variant_level"):
960
1047
                properties[name] = value
961
1048
                continue
962
 
            properties[name] = type(value)(value, variant_level=
963
 
                                           value.variant_level+1)
 
1049
            properties[name] = type(value)(
 
1050
                value, variant_level = value.variant_level + 1)
964
1051
        return dbus.Dictionary(properties, signature="sv")
965
1052
    
 
1053
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
1054
    def PropertiesChanged(self, interface_name, changed_properties,
 
1055
                          invalidated_properties):
 
1056
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
1057
        standard.
 
1058
        """
 
1059
        pass
 
1060
    
966
1061
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
967
1062
                         out_signature="s",
968
1063
                         path_keyword='object_path',
972
1067
        
973
1068
        Inserts property tags and interface annotation tags.
974
1069
        """
975
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
976
 
                                                   connection)
 
1070
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1071
                                                         object_path,
 
1072
                                                         connection)
977
1073
        try:
978
1074
            document = xml.dom.minidom.parseString(xmlstring)
 
1075
            
979
1076
            def make_tag(document, name, prop):
980
1077
                e = document.createElement("property")
981
1078
                e.setAttribute("name", name)
982
1079
                e.setAttribute("type", prop._dbus_signature)
983
1080
                e.setAttribute("access", prop._dbus_access)
984
1081
                return e
 
1082
            
985
1083
            for if_tag in document.getElementsByTagName("interface"):
986
1084
                # Add property tags
987
1085
                for tag in (make_tag(document, name, prop)
990
1088
                            if prop._dbus_interface
991
1089
                            == if_tag.getAttribute("name")):
992
1090
                    if_tag.appendChild(tag)
993
 
                # Add annotation tags
994
 
                for typ in ("method", "signal", "property"):
995
 
                    for tag in if_tag.getElementsByTagName(typ):
996
 
                        annots = dict()
997
 
                        for name, prop in (self.
998
 
                                           _get_all_dbus_things(typ)):
999
 
                            if (name == tag.getAttribute("name")
1000
 
                                and prop._dbus_interface
1001
 
                                == if_tag.getAttribute("name")):
1002
 
                                annots.update(getattr
1003
 
                                              (prop,
1004
 
                                               "_dbus_annotations",
1005
 
                                               {}))
1006
 
                        for name, value in annots.iteritems():
1007
 
                            ann_tag = document.createElement(
1008
 
                                "annotation")
1009
 
                            ann_tag.setAttribute("name", name)
1010
 
                            ann_tag.setAttribute("value", value)
1011
 
                            tag.appendChild(ann_tag)
1012
 
                # Add interface annotation tags
1013
 
                for annotation, value in dict(
1014
 
                    itertools.chain.from_iterable(
1015
 
                        annotations().iteritems()
1016
 
                        for name, annotations in
1017
 
                        self._get_all_dbus_things("interface")
1018
 
                        if name == if_tag.getAttribute("name")
1019
 
                        )).iteritems():
1020
 
                    ann_tag = document.createElement("annotation")
1021
 
                    ann_tag.setAttribute("name", annotation)
1022
 
                    ann_tag.setAttribute("value", value)
1023
 
                    if_tag.appendChild(ann_tag)
 
1091
                # Add annotation tags for properties
 
1092
                for tag in if_tag.getElementsByTagName("property"):
 
1093
                    annots = dict()
 
1094
                    for name, prop in self._get_all_dbus_things(
 
1095
                            "property"):
 
1096
                        if (name == tag.getAttribute("name")
 
1097
                            and prop._dbus_interface
 
1098
                            == if_tag.getAttribute("name")):
 
1099
                            annots.update(getattr(
 
1100
                                prop, "_dbus_annotations", {}))
 
1101
                    for name, value in annots.items():
 
1102
                        ann_tag = document.createElement(
 
1103
                            "annotation")
 
1104
                        ann_tag.setAttribute("name", name)
 
1105
                        ann_tag.setAttribute("value", value)
 
1106
                        tag.appendChild(ann_tag)
1024
1107
                # Add the names to the return values for the
1025
1108
                # "org.freedesktop.DBus.Properties" methods
1026
1109
                if (if_tag.getAttribute("name")
1044
1127
                         exc_info=error)
1045
1128
        return xmlstring
1046
1129
 
 
1130
try:
 
1131
    dbus.OBJECT_MANAGER_IFACE
 
1132
except AttributeError:
 
1133
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1134
 
 
1135
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1136
    """A D-Bus object with an ObjectManager.
 
1137
    
 
1138
    Classes inheriting from this exposes the standard
 
1139
    GetManagedObjects call and the InterfacesAdded and
 
1140
    InterfacesRemoved signals on the standard
 
1141
    "org.freedesktop.DBus.ObjectManager" interface.
 
1142
    
 
1143
    Note: No signals are sent automatically; they must be sent
 
1144
    manually.
 
1145
    """
 
1146
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1147
                         out_signature = "a{oa{sa{sv}}}")
 
1148
    def GetManagedObjects(self):
 
1149
        """This function must be overridden"""
 
1150
        raise NotImplementedError()
 
1151
    
 
1152
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1153
                         signature = "oa{sa{sv}}")
 
1154
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1155
        pass
 
1156
    
 
1157
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1158
                         signature = "oas")
 
1159
    def InterfacesRemoved(self, object_path, interfaces):
 
1160
        pass
 
1161
    
 
1162
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1163
                         out_signature = "s",
 
1164
                         path_keyword = 'object_path',
 
1165
                         connection_keyword = 'connection')
 
1166
    def Introspect(self, object_path, connection):
 
1167
        """Overloading of standard D-Bus method.
 
1168
        
 
1169
        Override return argument name of GetManagedObjects to be
 
1170
        "objpath_interfaces_and_properties"
 
1171
        """
 
1172
        xmlstring = DBusObjectWithAnnotations(self, object_path,
 
1173
                                              connection)
 
1174
        try:
 
1175
            document = xml.dom.minidom.parseString(xmlstring)
 
1176
            
 
1177
            for if_tag in document.getElementsByTagName("interface"):
 
1178
                # Fix argument name for the GetManagedObjects method
 
1179
                if (if_tag.getAttribute("name")
 
1180
                                == dbus.OBJECT_MANAGER_IFACE):
 
1181
                    for cn in if_tag.getElementsByTagName("method"):
 
1182
                        if (cn.getAttribute("name")
 
1183
                            == "GetManagedObjects"):
 
1184
                            for arg in cn.getElementsByTagName("arg"):
 
1185
                                if (arg.getAttribute("direction")
 
1186
                                    == "out"):
 
1187
                                    arg.setAttribute(
 
1188
                                        "name",
 
1189
                                        "objpath_interfaces"
 
1190
                                        "_and_properties")
 
1191
            xmlstring = document.toxml("utf-8")
 
1192
            document.unlink()
 
1193
        except (AttributeError, xml.dom.DOMException,
 
1194
                xml.parsers.expat.ExpatError) as error:
 
1195
            logger.error("Failed to override Introspection method",
 
1196
                         exc_info = error)
 
1197
        return xmlstring
1047
1198
 
1048
1199
def datetime_to_dbus(dt, variant_level=0):
1049
1200
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1050
1201
    if dt is None:
1051
1202
        return dbus.String("", variant_level = variant_level)
1052
 
    return dbus.String(dt.isoformat(),
1053
 
                       variant_level=variant_level)
 
1203
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1054
1204
 
1055
1205
 
1056
1206
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1076
1226
    (from DBusObjectWithProperties) and interfaces (from the
1077
1227
    dbus_interface_annotations decorator).
1078
1228
    """
 
1229
    
1079
1230
    def wrapper(cls):
1080
1231
        for orig_interface_name, alt_interface_name in (
1081
 
            alt_interface_names.iteritems()):
 
1232
                alt_interface_names.items()):
1082
1233
            attr = {}
1083
1234
            interface_names = set()
1084
1235
            # Go though all attributes of the class
1086
1237
                # Ignore non-D-Bus attributes, and D-Bus attributes
1087
1238
                # with the wrong interface name
1088
1239
                if (not hasattr(attribute, "_dbus_interface")
1089
 
                    or not attribute._dbus_interface
1090
 
                    .startswith(orig_interface_name)):
 
1240
                    or not attribute._dbus_interface.startswith(
 
1241
                        orig_interface_name)):
1091
1242
                    continue
1092
1243
                # Create an alternate D-Bus interface name based on
1093
1244
                # the current name
1094
 
                alt_interface = (attribute._dbus_interface
1095
 
                                 .replace(orig_interface_name,
1096
 
                                          alt_interface_name))
 
1245
                alt_interface = attribute._dbus_interface.replace(
 
1246
                    orig_interface_name, alt_interface_name)
1097
1247
                interface_names.add(alt_interface)
1098
1248
                # Is this a D-Bus signal?
1099
1249
                if getattr(attribute, "_dbus_is_signal", False):
1100
 
                    # Extract the original non-method undecorated
1101
 
                    # function by black magic
1102
 
                    nonmethod_func = (dict(
 
1250
                    if sys.version_info.major == 2:
 
1251
                        # Extract the original non-method undecorated
 
1252
                        # function by black magic
 
1253
                        nonmethod_func = (dict(
1103
1254
                            zip(attribute.func_code.co_freevars,
1104
 
                                attribute.__closure__))["func"]
1105
 
                                      .cell_contents)
 
1255
                                attribute.__closure__))
 
1256
                                          ["func"].cell_contents)
 
1257
                    else:
 
1258
                        nonmethod_func = attribute
1106
1259
                    # Create a new, but exactly alike, function
1107
1260
                    # object, and decorate it to be a new D-Bus signal
1108
1261
                    # with the alternate D-Bus interface name
1109
 
                    new_function = (dbus.service.signal
1110
 
                                    (alt_interface,
1111
 
                                     attribute._dbus_signature)
1112
 
                                    (types.FunctionType(
1113
 
                                nonmethod_func.func_code,
1114
 
                                nonmethod_func.func_globals,
1115
 
                                nonmethod_func.func_name,
1116
 
                                nonmethod_func.func_defaults,
1117
 
                                nonmethod_func.func_closure)))
 
1262
                    if sys.version_info.major == 2:
 
1263
                        new_function = types.FunctionType(
 
1264
                            nonmethod_func.func_code,
 
1265
                            nonmethod_func.func_globals,
 
1266
                            nonmethod_func.func_name,
 
1267
                            nonmethod_func.func_defaults,
 
1268
                            nonmethod_func.func_closure)
 
1269
                    else:
 
1270
                        new_function = types.FunctionType(
 
1271
                            nonmethod_func.__code__,
 
1272
                            nonmethod_func.__globals__,
 
1273
                            nonmethod_func.__name__,
 
1274
                            nonmethod_func.__defaults__,
 
1275
                            nonmethod_func.__closure__)
 
1276
                    new_function = (dbus.service.signal(
 
1277
                        alt_interface,
 
1278
                        attribute._dbus_signature)(new_function))
1118
1279
                    # Copy annotations, if any
1119
1280
                    try:
1120
 
                        new_function._dbus_annotations = (
1121
 
                            dict(attribute._dbus_annotations))
 
1281
                        new_function._dbus_annotations = dict(
 
1282
                            attribute._dbus_annotations)
1122
1283
                    except AttributeError:
1123
1284
                        pass
1124
1285
                    # Define a creator of a function to call both the
1129
1290
                        """This function is a scope container to pass
1130
1291
                        func1 and func2 to the "call_both" function
1131
1292
                        outside of its arguments"""
 
1293
                        
1132
1294
                        def call_both(*args, **kwargs):
1133
1295
                            """This function will emit two D-Bus
1134
1296
                            signals by calling func1 and func2"""
1135
1297
                            func1(*args, **kwargs)
1136
1298
                            func2(*args, **kwargs)
 
1299
                        
1137
1300
                        return call_both
1138
1301
                    # Create the "call_both" function and add it to
1139
1302
                    # the class
1144
1307
                    # object.  Decorate it to be a new D-Bus method
1145
1308
                    # with the alternate D-Bus interface name.  Add it
1146
1309
                    # to the class.
1147
 
                    attr[attrname] = (dbus.service.method
1148
 
                                      (alt_interface,
1149
 
                                       attribute._dbus_in_signature,
1150
 
                                       attribute._dbus_out_signature)
1151
 
                                      (types.FunctionType
1152
 
                                       (attribute.func_code,
1153
 
                                        attribute.func_globals,
1154
 
                                        attribute.func_name,
1155
 
                                        attribute.func_defaults,
1156
 
                                        attribute.func_closure)))
 
1310
                    attr[attrname] = (
 
1311
                        dbus.service.method(
 
1312
                            alt_interface,
 
1313
                            attribute._dbus_in_signature,
 
1314
                            attribute._dbus_out_signature)
 
1315
                        (types.FunctionType(attribute.func_code,
 
1316
                                            attribute.func_globals,
 
1317
                                            attribute.func_name,
 
1318
                                            attribute.func_defaults,
 
1319
                                            attribute.func_closure)))
1157
1320
                    # Copy annotations, if any
1158
1321
                    try:
1159
 
                        attr[attrname]._dbus_annotations = (
1160
 
                            dict(attribute._dbus_annotations))
 
1322
                        attr[attrname]._dbus_annotations = dict(
 
1323
                            attribute._dbus_annotations)
1161
1324
                    except AttributeError:
1162
1325
                        pass
1163
1326
                # Is this a D-Bus property?
1166
1329
                    # object, and decorate it to be a new D-Bus
1167
1330
                    # property with the alternate D-Bus interface
1168
1331
                    # name.  Add it to the class.
1169
 
                    attr[attrname] = (dbus_service_property
1170
 
                                      (alt_interface,
1171
 
                                       attribute._dbus_signature,
1172
 
                                       attribute._dbus_access,
1173
 
                                       attribute
1174
 
                                       ._dbus_get_args_options
1175
 
                                       ["byte_arrays"])
1176
 
                                      (types.FunctionType
1177
 
                                       (attribute.func_code,
1178
 
                                        attribute.func_globals,
1179
 
                                        attribute.func_name,
1180
 
                                        attribute.func_defaults,
1181
 
                                        attribute.func_closure)))
 
1332
                    attr[attrname] = (dbus_service_property(
 
1333
                        alt_interface, attribute._dbus_signature,
 
1334
                        attribute._dbus_access,
 
1335
                        attribute._dbus_get_args_options
 
1336
                        ["byte_arrays"])
 
1337
                                      (types.FunctionType(
 
1338
                                          attribute.func_code,
 
1339
                                          attribute.func_globals,
 
1340
                                          attribute.func_name,
 
1341
                                          attribute.func_defaults,
 
1342
                                          attribute.func_closure)))
1182
1343
                    # Copy annotations, if any
1183
1344
                    try:
1184
 
                        attr[attrname]._dbus_annotations = (
1185
 
                            dict(attribute._dbus_annotations))
 
1345
                        attr[attrname]._dbus_annotations = dict(
 
1346
                            attribute._dbus_annotations)
1186
1347
                    except AttributeError:
1187
1348
                        pass
1188
1349
                # Is this a D-Bus interface?
1191
1352
                    # object.  Decorate it to be a new D-Bus interface
1192
1353
                    # with the alternate D-Bus interface name.  Add it
1193
1354
                    # to the class.
1194
 
                    attr[attrname] = (dbus_interface_annotations
1195
 
                                      (alt_interface)
1196
 
                                      (types.FunctionType
1197
 
                                       (attribute.func_code,
1198
 
                                        attribute.func_globals,
1199
 
                                        attribute.func_name,
1200
 
                                        attribute.func_defaults,
1201
 
                                        attribute.func_closure)))
 
1355
                    attr[attrname] = (
 
1356
                        dbus_interface_annotations(alt_interface)
 
1357
                        (types.FunctionType(attribute.func_code,
 
1358
                                            attribute.func_globals,
 
1359
                                            attribute.func_name,
 
1360
                                            attribute.func_defaults,
 
1361
                                            attribute.func_closure)))
1202
1362
            if deprecate:
1203
1363
                # Deprecate all alternate interfaces
1204
 
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1364
                iname="_AlternateDBusNames_interface_annotation{}"
1205
1365
                for interface_name in interface_names:
 
1366
                    
1206
1367
                    @dbus_interface_annotations(interface_name)
1207
1368
                    def func(self):
1208
1369
                        return { "org.freedesktop.DBus.Deprecated":
1209
 
                                     "true" }
 
1370
                                 "true" }
1210
1371
                    # Find an unused name
1211
1372
                    for aname in (iname.format(i)
1212
1373
                                  for i in itertools.count()):
1216
1377
            if interface_names:
1217
1378
                # Replace the class with a new subclass of it with
1218
1379
                # methods, signals, etc. as created above.
1219
 
                cls = type(b"{0}Alternate".format(cls.__name__),
1220
 
                           (cls,), attr)
 
1380
                cls = type(b"{}Alternate".format(cls.__name__),
 
1381
                           (cls, ), attr)
1221
1382
        return cls
 
1383
    
1222
1384
    return wrapper
1223
1385
 
1224
1386
 
1225
1387
@alternate_dbus_interfaces({"se.recompile.Mandos":
1226
 
                                "se.bsnet.fukt.Mandos"})
 
1388
                            "se.bsnet.fukt.Mandos"})
1227
1389
class ClientDBus(Client, DBusObjectWithProperties):
1228
1390
    """A Client class using D-Bus
1229
1391
    
1233
1395
    """
1234
1396
    
1235
1397
    runtime_expansions = (Client.runtime_expansions
1236
 
                          + ("dbus_object_path",))
 
1398
                          + ("dbus_object_path", ))
 
1399
    
 
1400
    _interface = "se.recompile.Mandos.Client"
1237
1401
    
1238
1402
    # dbus.service.Object doesn't use super(), so we can't either.
1239
1403
    
1242
1406
        Client.__init__(self, *args, **kwargs)
1243
1407
        # Only now, when this client is initialized, can it show up on
1244
1408
        # the D-Bus
1245
 
        client_object_name = unicode(self.name).translate(
 
1409
        client_object_name = str(self.name).translate(
1246
1410
            {ord("."): ord("_"),
1247
1411
             ord("-"): ord("_")})
1248
 
        self.dbus_object_path = (dbus.ObjectPath
1249
 
                                 ("/clients/" + client_object_name))
 
1412
        self.dbus_object_path = dbus.ObjectPath(
 
1413
            "/clients/" + client_object_name)
1250
1414
        DBusObjectWithProperties.__init__(self, self.bus,
1251
1415
                                          self.dbus_object_path)
1252
1416
    
1253
 
    def notifychangeproperty(transform_func,
1254
 
                             dbus_name, type_func=lambda x: x,
1255
 
                             variant_level=1):
 
1417
    def notifychangeproperty(transform_func, dbus_name,
 
1418
                             type_func=lambda x: x,
 
1419
                             variant_level=1,
 
1420
                             invalidate_only=False,
 
1421
                             _interface=_interface):
1256
1422
        """ Modify a variable so that it's a property which announces
1257
1423
        its changes to DBus.
1258
1424
        
1263
1429
                   to the D-Bus.  Default: no transform
1264
1430
        variant_level: D-Bus variant level.  Default: 1
1265
1431
        """
1266
 
        attrname = "_{0}".format(dbus_name)
 
1432
        attrname = "_{}".format(dbus_name)
 
1433
        
1267
1434
        def setter(self, value):
1268
1435
            if hasattr(self, "dbus_object_path"):
1269
1436
                if (not hasattr(self, attrname) or
1270
1437
                    type_func(getattr(self, attrname, None))
1271
1438
                    != type_func(value)):
1272
 
                    dbus_value = transform_func(type_func(value),
1273
 
                                                variant_level
1274
 
                                                =variant_level)
1275
 
                    self.PropertyChanged(dbus.String(dbus_name),
1276
 
                                         dbus_value)
 
1439
                    if invalidate_only:
 
1440
                        self.PropertiesChanged(
 
1441
                            _interface, dbus.Dictionary(),
 
1442
                            dbus.Array((dbus_name, )))
 
1443
                    else:
 
1444
                        dbus_value = transform_func(
 
1445
                            type_func(value),
 
1446
                            variant_level = variant_level)
 
1447
                        self.PropertyChanged(dbus.String(dbus_name),
 
1448
                                             dbus_value)
 
1449
                        self.PropertiesChanged(
 
1450
                            _interface,
 
1451
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1452
                                              dbus_value }),
 
1453
                            dbus.Array())
1277
1454
            setattr(self, attrname, value)
1278
1455
        
1279
1456
        return property(lambda self: getattr(self, attrname), setter)
1285
1462
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1286
1463
    last_enabled = notifychangeproperty(datetime_to_dbus,
1287
1464
                                        "LastEnabled")
1288
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1289
 
                                   type_func = lambda checker:
1290
 
                                       checker is not None)
 
1465
    checker = notifychangeproperty(
 
1466
        dbus.Boolean, "CheckerRunning",
 
1467
        type_func = lambda checker: checker is not None)
1291
1468
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1292
1469
                                           "LastCheckedOK")
1293
1470
    last_checker_status = notifychangeproperty(dbus.Int16,
1296
1473
        datetime_to_dbus, "LastApprovalRequest")
1297
1474
    approved_by_default = notifychangeproperty(dbus.Boolean,
1298
1475
                                               "ApprovedByDefault")
1299
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1300
 
                                          "ApprovalDelay",
1301
 
                                          type_func =
1302
 
                                          timedelta_to_milliseconds)
 
1476
    approval_delay = notifychangeproperty(
 
1477
        dbus.UInt64, "ApprovalDelay",
 
1478
        type_func = lambda td: td.total_seconds() * 1000)
1303
1479
    approval_duration = notifychangeproperty(
1304
1480
        dbus.UInt64, "ApprovalDuration",
1305
 
        type_func = timedelta_to_milliseconds)
 
1481
        type_func = lambda td: td.total_seconds() * 1000)
1306
1482
    host = notifychangeproperty(dbus.String, "Host")
1307
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1308
 
                                   type_func =
1309
 
                                   timedelta_to_milliseconds)
 
1483
    timeout = notifychangeproperty(
 
1484
        dbus.UInt64, "Timeout",
 
1485
        type_func = lambda td: td.total_seconds() * 1000)
1310
1486
    extended_timeout = notifychangeproperty(
1311
1487
        dbus.UInt64, "ExtendedTimeout",
1312
 
        type_func = timedelta_to_milliseconds)
1313
 
    interval = notifychangeproperty(dbus.UInt64,
1314
 
                                    "Interval",
1315
 
                                    type_func =
1316
 
                                    timedelta_to_milliseconds)
 
1488
        type_func = lambda td: td.total_seconds() * 1000)
 
1489
    interval = notifychangeproperty(
 
1490
        dbus.UInt64, "Interval",
 
1491
        type_func = lambda td: td.total_seconds() * 1000)
1317
1492
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1493
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1494
                                  invalidate_only=True)
1318
1495
    
1319
1496
    del notifychangeproperty
1320
1497
    
1327
1504
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1328
1505
        Client.__del__(self, *args, **kwargs)
1329
1506
    
1330
 
    def checker_callback(self, pid, condition, command,
1331
 
                         *args, **kwargs):
1332
 
        self.checker_callback_tag = None
1333
 
        self.checker = None
1334
 
        if os.WIFEXITED(condition):
1335
 
            exitstatus = os.WEXITSTATUS(condition)
 
1507
    def checker_callback(self, source, condition,
 
1508
                         connection, command, *args, **kwargs):
 
1509
        ret = Client.checker_callback(self, source, condition,
 
1510
                                      connection, command, *args,
 
1511
                                      **kwargs)
 
1512
        exitstatus = self.last_checker_status
 
1513
        if exitstatus >= 0:
1336
1514
            # Emit D-Bus signal
1337
1515
            self.CheckerCompleted(dbus.Int16(exitstatus),
1338
 
                                  dbus.Int64(condition),
 
1516
                                  # This is specific to GNU libC
 
1517
                                  dbus.Int64(exitstatus << 8),
1339
1518
                                  dbus.String(command))
1340
1519
        else:
1341
1520
            # Emit D-Bus signal
1342
1521
            self.CheckerCompleted(dbus.Int16(-1),
1343
 
                                  dbus.Int64(condition),
 
1522
                                  dbus.Int64(
 
1523
                                      # This is specific to GNU libC
 
1524
                                      (exitstatus << 8)
 
1525
                                      | self.last_checker_signal),
1344
1526
                                  dbus.String(command))
1345
 
        
1346
 
        return Client.checker_callback(self, pid, condition, command,
1347
 
                                       *args, **kwargs)
 
1527
        return ret
1348
1528
    
1349
1529
    def start_checker(self, *args, **kwargs):
1350
 
        old_checker = self.checker
1351
 
        if self.checker is not None:
1352
 
            old_checker_pid = self.checker.pid
1353
 
        else:
1354
 
            old_checker_pid = None
 
1530
        old_checker_pid = getattr(self.checker, "pid", None)
1355
1531
        r = Client.start_checker(self, *args, **kwargs)
1356
1532
        # Only if new checker process was started
1357
1533
        if (self.checker is not None
1366
1542
    
1367
1543
    def approve(self, value=True):
1368
1544
        self.approved = value
1369
 
        gobject.timeout_add(timedelta_to_milliseconds
1370
 
                            (self.approval_duration),
1371
 
                            self._reset_approved)
 
1545
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1546
                                * 1000), self._reset_approved)
1372
1547
        self.send_changedstate()
1373
1548
    
1374
1549
    ## D-Bus methods, signals & properties
1375
 
    _interface = "se.recompile.Mandos.Client"
1376
1550
    
1377
1551
    ## Interfaces
1378
1552
    
1379
 
    @dbus_interface_annotations(_interface)
1380
 
    def _foo(self):
1381
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1382
 
                     "false"}
1383
 
    
1384
1553
    ## Signals
1385
1554
    
1386
1555
    # CheckerCompleted - signal
1396
1565
        pass
1397
1566
    
1398
1567
    # PropertyChanged - signal
 
1568
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1399
1569
    @dbus.service.signal(_interface, signature="sv")
1400
1570
    def PropertyChanged(self, property, value):
1401
1571
        "D-Bus signal"
1435
1605
        self.checked_ok()
1436
1606
    
1437
1607
    # Enable - method
 
1608
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1438
1609
    @dbus.service.method(_interface)
1439
1610
    def Enable(self):
1440
1611
        "D-Bus method"
1441
1612
        self.enable()
1442
1613
    
1443
1614
    # StartChecker - method
 
1615
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1444
1616
    @dbus.service.method(_interface)
1445
1617
    def StartChecker(self):
1446
1618
        "D-Bus method"
1447
1619
        self.start_checker()
1448
1620
    
1449
1621
    # Disable - method
 
1622
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1450
1623
    @dbus.service.method(_interface)
1451
1624
    def Disable(self):
1452
1625
        "D-Bus method"
1453
1626
        self.disable()
1454
1627
    
1455
1628
    # StopChecker - method
 
1629
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1456
1630
    @dbus.service.method(_interface)
1457
1631
    def StopChecker(self):
1458
1632
        self.stop_checker()
1465
1639
        return dbus.Boolean(bool(self.approvals_pending))
1466
1640
    
1467
1641
    # ApprovedByDefault - property
1468
 
    @dbus_service_property(_interface, signature="b",
 
1642
    @dbus_service_property(_interface,
 
1643
                           signature="b",
1469
1644
                           access="readwrite")
1470
1645
    def ApprovedByDefault_dbus_property(self, value=None):
1471
1646
        if value is None:       # get
1473
1648
        self.approved_by_default = bool(value)
1474
1649
    
1475
1650
    # ApprovalDelay - property
1476
 
    @dbus_service_property(_interface, signature="t",
 
1651
    @dbus_service_property(_interface,
 
1652
                           signature="t",
1477
1653
                           access="readwrite")
1478
1654
    def ApprovalDelay_dbus_property(self, value=None):
1479
1655
        if value is None:       # get
1480
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1656
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1657
                               * 1000)
1481
1658
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1482
1659
    
1483
1660
    # ApprovalDuration - property
1484
 
    @dbus_service_property(_interface, signature="t",
 
1661
    @dbus_service_property(_interface,
 
1662
                           signature="t",
1485
1663
                           access="readwrite")
1486
1664
    def ApprovalDuration_dbus_property(self, value=None):
1487
1665
        if value is None:       # get
1488
 
            return dbus.UInt64(timedelta_to_milliseconds(
1489
 
                    self.approval_duration))
 
1666
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1667
                               * 1000)
1490
1668
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1491
1669
    
1492
1670
    # Name - property
 
1671
    @dbus_annotations(
 
1672
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1493
1673
    @dbus_service_property(_interface, signature="s", access="read")
1494
1674
    def Name_dbus_property(self):
1495
1675
        return dbus.String(self.name)
1496
1676
    
1497
1677
    # Fingerprint - property
 
1678
    @dbus_annotations(
 
1679
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1498
1680
    @dbus_service_property(_interface, signature="s", access="read")
1499
1681
    def Fingerprint_dbus_property(self):
1500
1682
        return dbus.String(self.fingerprint)
1501
1683
    
1502
1684
    # Host - property
1503
 
    @dbus_service_property(_interface, signature="s",
 
1685
    @dbus_service_property(_interface,
 
1686
                           signature="s",
1504
1687
                           access="readwrite")
1505
1688
    def Host_dbus_property(self, value=None):
1506
1689
        if value is None:       # get
1507
1690
            return dbus.String(self.host)
1508
 
        self.host = unicode(value)
 
1691
        self.host = str(value)
1509
1692
    
1510
1693
    # Created - property
 
1694
    @dbus_annotations(
 
1695
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1511
1696
    @dbus_service_property(_interface, signature="s", access="read")
1512
1697
    def Created_dbus_property(self):
1513
1698
        return datetime_to_dbus(self.created)
1518
1703
        return datetime_to_dbus(self.last_enabled)
1519
1704
    
1520
1705
    # Enabled - property
1521
 
    @dbus_service_property(_interface, signature="b",
 
1706
    @dbus_service_property(_interface,
 
1707
                           signature="b",
1522
1708
                           access="readwrite")
1523
1709
    def Enabled_dbus_property(self, value=None):
1524
1710
        if value is None:       # get
1529
1715
            self.disable()
1530
1716
    
1531
1717
    # LastCheckedOK - property
1532
 
    @dbus_service_property(_interface, signature="s",
 
1718
    @dbus_service_property(_interface,
 
1719
                           signature="s",
1533
1720
                           access="readwrite")
1534
1721
    def LastCheckedOK_dbus_property(self, value=None):
1535
1722
        if value is not None:
1538
1725
        return datetime_to_dbus(self.last_checked_ok)
1539
1726
    
1540
1727
    # LastCheckerStatus - property
1541
 
    @dbus_service_property(_interface, signature="n",
1542
 
                           access="read")
 
1728
    @dbus_service_property(_interface, signature="n", access="read")
1543
1729
    def LastCheckerStatus_dbus_property(self):
1544
1730
        return dbus.Int16(self.last_checker_status)
1545
1731
    
1554
1740
        return datetime_to_dbus(self.last_approval_request)
1555
1741
    
1556
1742
    # Timeout - property
1557
 
    @dbus_service_property(_interface, signature="t",
 
1743
    @dbus_service_property(_interface,
 
1744
                           signature="t",
1558
1745
                           access="readwrite")
1559
1746
    def Timeout_dbus_property(self, value=None):
1560
1747
        if value is None:       # get
1561
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1748
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1562
1749
        old_timeout = self.timeout
1563
1750
        self.timeout = datetime.timedelta(0, 0, 0, value)
1564
1751
        # Reschedule disabling
1573
1760
                    is None):
1574
1761
                    return
1575
1762
                gobject.source_remove(self.disable_initiator_tag)
1576
 
                self.disable_initiator_tag = (
1577
 
                    gobject.timeout_add(
1578
 
                        timedelta_to_milliseconds(self.expires - now),
1579
 
                        self.disable))
 
1763
                self.disable_initiator_tag = gobject.timeout_add(
 
1764
                    int((self.expires - now).total_seconds() * 1000),
 
1765
                    self.disable)
1580
1766
    
1581
1767
    # ExtendedTimeout - property
1582
 
    @dbus_service_property(_interface, signature="t",
 
1768
    @dbus_service_property(_interface,
 
1769
                           signature="t",
1583
1770
                           access="readwrite")
1584
1771
    def ExtendedTimeout_dbus_property(self, value=None):
1585
1772
        if value is None:       # get
1586
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1773
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1774
                               * 1000)
1587
1775
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1588
1776
    
1589
1777
    # Interval - property
1590
 
    @dbus_service_property(_interface, signature="t",
 
1778
    @dbus_service_property(_interface,
 
1779
                           signature="t",
1591
1780
                           access="readwrite")
1592
1781
    def Interval_dbus_property(self, value=None):
1593
1782
        if value is None:       # get
1594
 
            return dbus.UInt64(self.interval_milliseconds())
 
1783
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1595
1784
        self.interval = datetime.timedelta(0, 0, 0, value)
1596
1785
        if getattr(self, "checker_initiator_tag", None) is None:
1597
1786
            return
1598
1787
        if self.enabled:
1599
1788
            # Reschedule checker run
1600
1789
            gobject.source_remove(self.checker_initiator_tag)
1601
 
            self.checker_initiator_tag = (gobject.timeout_add
1602
 
                                          (value, self.start_checker))
1603
 
            self.start_checker()    # Start one now, too
 
1790
            self.checker_initiator_tag = gobject.timeout_add(
 
1791
                value, self.start_checker)
 
1792
            self.start_checker() # Start one now, too
1604
1793
    
1605
1794
    # Checker - property
1606
 
    @dbus_service_property(_interface, signature="s",
 
1795
    @dbus_service_property(_interface,
 
1796
                           signature="s",
1607
1797
                           access="readwrite")
1608
1798
    def Checker_dbus_property(self, value=None):
1609
1799
        if value is None:       # get
1610
1800
            return dbus.String(self.checker_command)
1611
 
        self.checker_command = unicode(value)
 
1801
        self.checker_command = str(value)
1612
1802
    
1613
1803
    # CheckerRunning - property
1614
 
    @dbus_service_property(_interface, signature="b",
 
1804
    @dbus_service_property(_interface,
 
1805
                           signature="b",
1615
1806
                           access="readwrite")
1616
1807
    def CheckerRunning_dbus_property(self, value=None):
1617
1808
        if value is None:       # get
1622
1813
            self.stop_checker()
1623
1814
    
1624
1815
    # ObjectPath - property
 
1816
    @dbus_annotations(
 
1817
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
1818
         "org.freedesktop.DBus.Deprecated": "true"})
1625
1819
    @dbus_service_property(_interface, signature="o", access="read")
1626
1820
    def ObjectPath_dbus_property(self):
1627
1821
        return self.dbus_object_path # is already a dbus.ObjectPath
1628
1822
    
1629
1823
    # Secret = property
1630
 
    @dbus_service_property(_interface, signature="ay",
1631
 
                           access="write", byte_arrays=True)
 
1824
    @dbus_annotations(
 
1825
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1826
         "invalidates"})
 
1827
    @dbus_service_property(_interface,
 
1828
                           signature="ay",
 
1829
                           access="write",
 
1830
                           byte_arrays=True)
1632
1831
    def Secret_dbus_property(self, value):
1633
 
        self.secret = str(value)
 
1832
        self.secret = bytes(value)
1634
1833
    
1635
1834
    del _interface
1636
1835
 
1640
1839
        self._pipe = child_pipe
1641
1840
        self._pipe.send(('init', fpr, address))
1642
1841
        if not self._pipe.recv():
1643
 
            raise KeyError()
 
1842
            raise KeyError(fpr)
1644
1843
    
1645
1844
    def __getattribute__(self, name):
1646
1845
        if name == '_pipe':
1650
1849
        if data[0] == 'data':
1651
1850
            return data[1]
1652
1851
        if data[0] == 'function':
 
1852
            
1653
1853
            def func(*args, **kwargs):
1654
1854
                self._pipe.send(('funcall', name, args, kwargs))
1655
1855
                return self._pipe.recv()[1]
 
1856
            
1656
1857
            return func
1657
1858
    
1658
1859
    def __setattr__(self, name, value):
1670
1871
    def handle(self):
1671
1872
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1672
1873
            logger.info("TCP connection from: %s",
1673
 
                        unicode(self.client_address))
 
1874
                        str(self.client_address))
1674
1875
            logger.debug("Pipe FD: %d",
1675
1876
                         self.server.child_pipe.fileno())
1676
1877
            
1677
 
            session = (gnutls.connection
1678
 
                       .ClientSession(self.request,
1679
 
                                      gnutls.connection
1680
 
                                      .X509Credentials()))
 
1878
            session = gnutls.connection.ClientSession(
 
1879
                self.request, gnutls.connection .X509Credentials())
1681
1880
            
1682
1881
            # Note: gnutls.connection.X509Credentials is really a
1683
1882
            # generic GnuTLS certificate credentials object so long as
1692
1891
            priority = self.server.gnutls_priority
1693
1892
            if priority is None:
1694
1893
                priority = "NORMAL"
1695
 
            (gnutls.library.functions
1696
 
             .gnutls_priority_set_direct(session._c_object,
1697
 
                                         priority, None))
 
1894
            gnutls.library.functions.gnutls_priority_set_direct(
 
1895
                session._c_object, priority, None)
1698
1896
            
1699
1897
            # Start communication using the Mandos protocol
1700
1898
            # Get protocol number
1702
1900
            logger.debug("Protocol version: %r", line)
1703
1901
            try:
1704
1902
                if int(line.strip().split()[0]) > 1:
1705
 
                    raise RuntimeError
 
1903
                    raise RuntimeError(line)
1706
1904
            except (ValueError, IndexError, RuntimeError) as error:
1707
1905
                logger.error("Unknown protocol version: %s", error)
1708
1906
                return
1720
1918
            approval_required = False
1721
1919
            try:
1722
1920
                try:
1723
 
                    fpr = self.fingerprint(self.peer_certificate
1724
 
                                           (session))
 
1921
                    fpr = self.fingerprint(
 
1922
                        self.peer_certificate(session))
1725
1923
                except (TypeError,
1726
1924
                        gnutls.errors.GNUTLSError) as error:
1727
1925
                    logger.warning("Bad certificate: %s", error)
1742
1940
                while True:
1743
1941
                    if not client.enabled:
1744
1942
                        logger.info("Client %s is disabled",
1745
 
                                       client.name)
 
1943
                                    client.name)
1746
1944
                        if self.server.use_dbus:
1747
1945
                            # Emit D-Bus signal
1748
1946
                            client.Rejected("Disabled")
1757
1955
                        if self.server.use_dbus:
1758
1956
                            # Emit D-Bus signal
1759
1957
                            client.NeedApproval(
1760
 
                                client.approval_delay_milliseconds(),
1761
 
                                client.approved_by_default)
 
1958
                                client.approval_delay.total_seconds()
 
1959
                                * 1000, client.approved_by_default)
1762
1960
                    else:
1763
1961
                        logger.warning("Client %s was not approved",
1764
1962
                                       client.name)
1770
1968
                    #wait until timeout or approved
1771
1969
                    time = datetime.datetime.now()
1772
1970
                    client.changedstate.acquire()
1773
 
                    client.changedstate.wait(
1774
 
                        float(timedelta_to_milliseconds(delay)
1775
 
                              / 1000))
 
1971
                    client.changedstate.wait(delay.total_seconds())
1776
1972
                    client.changedstate.release()
1777
1973
                    time2 = datetime.datetime.now()
1778
1974
                    if (time2 - time) >= delay:
1797
1993
                        logger.warning("gnutls send failed",
1798
1994
                                       exc_info=error)
1799
1995
                        return
1800
 
                    logger.debug("Sent: %d, remaining: %d",
1801
 
                                 sent, len(client.secret)
1802
 
                                 - (sent_size + sent))
 
1996
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1997
                                 len(client.secret) - (sent_size
 
1998
                                                       + sent))
1803
1999
                    sent_size += sent
1804
2000
                
1805
2001
                logger.info("Sending secret to %s", client.name)
1822
2018
    def peer_certificate(session):
1823
2019
        "Return the peer's OpenPGP certificate as a bytestring"
1824
2020
        # If not an OpenPGP certificate...
1825
 
        if (gnutls.library.functions
1826
 
            .gnutls_certificate_type_get(session._c_object)
 
2021
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
2022
                session._c_object)
1827
2023
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1828
2024
            # ...do the normal thing
1829
2025
            return session.peer_certificate
1843
2039
    def fingerprint(openpgp):
1844
2040
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1845
2041
        # New GnuTLS "datum" with the OpenPGP public key
1846
 
        datum = (gnutls.library.types
1847
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1848
 
                                             ctypes.POINTER
1849
 
                                             (ctypes.c_ubyte)),
1850
 
                                 ctypes.c_uint(len(openpgp))))
 
2042
        datum = gnutls.library.types.gnutls_datum_t(
 
2043
            ctypes.cast(ctypes.c_char_p(openpgp),
 
2044
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2045
            ctypes.c_uint(len(openpgp)))
1851
2046
        # New empty GnuTLS certificate
1852
2047
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1853
 
        (gnutls.library.functions
1854
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2048
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
2049
            ctypes.byref(crt))
1855
2050
        # Import the OpenPGP public key into the certificate
1856
 
        (gnutls.library.functions
1857
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1858
 
                                    gnutls.library.constants
1859
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2051
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
2052
            crt, ctypes.byref(datum),
 
2053
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1860
2054
        # Verify the self signature in the key
1861
2055
        crtverify = ctypes.c_uint()
1862
 
        (gnutls.library.functions
1863
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1864
 
                                         ctypes.byref(crtverify)))
 
2056
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
2057
            crt, 0, ctypes.byref(crtverify))
1865
2058
        if crtverify.value != 0:
1866
2059
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1867
 
            raise (gnutls.errors.CertificateSecurityError
1868
 
                   ("Verify failed"))
 
2060
            raise gnutls.errors.CertificateSecurityError(
 
2061
                "Verify failed")
1869
2062
        # New buffer for the fingerprint
1870
2063
        buf = ctypes.create_string_buffer(20)
1871
2064
        buf_len = ctypes.c_size_t()
1872
2065
        # Get the fingerprint from the certificate into the buffer
1873
 
        (gnutls.library.functions
1874
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1875
 
                                             ctypes.byref(buf_len)))
 
2066
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
2067
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1876
2068
        # Deinit the certificate
1877
2069
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1878
2070
        # Convert the buffer to a Python bytestring
1884
2076
 
1885
2077
class MultiprocessingMixIn(object):
1886
2078
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2079
    
1887
2080
    def sub_process_main(self, request, address):
1888
2081
        try:
1889
2082
            self.finish_request(request, address)
1901
2094
 
1902
2095
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1903
2096
    """ adds a pipe to the MixIn """
 
2097
    
1904
2098
    def process_request(self, request, client_address):
1905
2099
        """Overrides and wraps the original process_request().
1906
2100
        
1915
2109
    
1916
2110
    def add_pipe(self, parent_pipe, proc):
1917
2111
        """Dummy function; override as necessary"""
1918
 
        raise NotImplementedError
 
2112
        raise NotImplementedError()
1919
2113
 
1920
2114
 
1921
2115
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1927
2121
        interface:      None or a network interface name (string)
1928
2122
        use_ipv6:       Boolean; to use IPv6 or not
1929
2123
    """
 
2124
    
1930
2125
    def __init__(self, server_address, RequestHandlerClass,
1931
 
                 interface=None, use_ipv6=True, socketfd=None):
 
2126
                 interface=None,
 
2127
                 use_ipv6=True,
 
2128
                 socketfd=None):
1932
2129
        """If socketfd is set, use that file descriptor instead of
1933
2130
        creating a new one with socket.socket().
1934
2131
        """
1975
2172
                             self.interface)
1976
2173
            else:
1977
2174
                try:
1978
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1979
 
                                           SO_BINDTODEVICE,
1980
 
                                           str(self.interface + '\0'))
 
2175
                    self.socket.setsockopt(
 
2176
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2177
                        (self.interface + "\0").encode("utf-8"))
1981
2178
                except socket.error as error:
1982
2179
                    if error.errno == errno.EPERM:
1983
2180
                        logger.error("No permission to bind to"
2001
2198
                self.server_address = (any_address,
2002
2199
                                       self.server_address[1])
2003
2200
            elif not self.server_address[1]:
2004
 
                self.server_address = (self.server_address[0],
2005
 
                                       0)
 
2201
                self.server_address = (self.server_address[0], 0)
2006
2202
#                 if self.interface:
2007
2203
#                     self.server_address = (self.server_address[0],
2008
2204
#                                            0, # port
2022
2218
    
2023
2219
    Assumes a gobject.MainLoop event loop.
2024
2220
    """
 
2221
    
2025
2222
    def __init__(self, server_address, RequestHandlerClass,
2026
 
                 interface=None, use_ipv6=True, clients=None,
2027
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
2223
                 interface=None,
 
2224
                 use_ipv6=True,
 
2225
                 clients=None,
 
2226
                 gnutls_priority=None,
 
2227
                 use_dbus=True,
 
2228
                 socketfd=None):
2028
2229
        self.enabled = False
2029
2230
        self.clients = clients
2030
2231
        if self.clients is None:
2036
2237
                                interface = interface,
2037
2238
                                use_ipv6 = use_ipv6,
2038
2239
                                socketfd = socketfd)
 
2240
    
2039
2241
    def server_activate(self):
2040
2242
        if self.enabled:
2041
2243
            return socketserver.TCPServer.server_activate(self)
2045
2247
    
2046
2248
    def add_pipe(self, parent_pipe, proc):
2047
2249
        # Call "handle_ipc" for both data and EOF events
2048
 
        gobject.io_add_watch(parent_pipe.fileno(),
2049
 
                             gobject.IO_IN | gobject.IO_HUP,
2050
 
                             functools.partial(self.handle_ipc,
2051
 
                                               parent_pipe =
2052
 
                                               parent_pipe,
2053
 
                                               proc = proc))
 
2250
        gobject.io_add_watch(
 
2251
            parent_pipe.fileno(),
 
2252
            gobject.IO_IN | gobject.IO_HUP,
 
2253
            functools.partial(self.handle_ipc,
 
2254
                              parent_pipe = parent_pipe,
 
2255
                              proc = proc))
2054
2256
    
2055
 
    def handle_ipc(self, source, condition, parent_pipe=None,
2056
 
                   proc = None, client_object=None):
 
2257
    def handle_ipc(self, source, condition,
 
2258
                   parent_pipe=None,
 
2259
                   proc = None,
 
2260
                   client_object=None):
2057
2261
        # error, or the other end of multiprocessing.Pipe has closed
2058
2262
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2059
2263
            # Wait for other process to exit
2082
2286
                parent_pipe.send(False)
2083
2287
                return False
2084
2288
            
2085
 
            gobject.io_add_watch(parent_pipe.fileno(),
2086
 
                                 gobject.IO_IN | gobject.IO_HUP,
2087
 
                                 functools.partial(self.handle_ipc,
2088
 
                                                   parent_pipe =
2089
 
                                                   parent_pipe,
2090
 
                                                   proc = proc,
2091
 
                                                   client_object =
2092
 
                                                   client))
 
2289
            gobject.io_add_watch(
 
2290
                parent_pipe.fileno(),
 
2291
                gobject.IO_IN | gobject.IO_HUP,
 
2292
                functools.partial(self.handle_ipc,
 
2293
                                  parent_pipe = parent_pipe,
 
2294
                                  proc = proc,
 
2295
                                  client_object = client))
2093
2296
            parent_pipe.send(True)
2094
2297
            # remove the old hook in favor of the new above hook on
2095
2298
            # same fileno
2101
2304
            
2102
2305
            parent_pipe.send(('data', getattr(client_object,
2103
2306
                                              funcname)(*args,
2104
 
                                                         **kwargs)))
 
2307
                                                        **kwargs)))
2105
2308
        
2106
2309
        if command == 'getattr':
2107
2310
            attrname = request[1]
2108
 
            if callable(client_object.__getattribute__(attrname)):
2109
 
                parent_pipe.send(('function',))
 
2311
            if isinstance(client_object.__getattribute__(attrname),
 
2312
                          collections.Callable):
 
2313
                parent_pipe.send(('function', ))
2110
2314
            else:
2111
 
                parent_pipe.send(('data', client_object
2112
 
                                  .__getattribute__(attrname)))
 
2315
                parent_pipe.send((
 
2316
                    'data', client_object.__getattribute__(attrname)))
2113
2317
        
2114
2318
        if command == 'setattr':
2115
2319
            attrname = request[1]
2146
2350
    # avoid excessive use of external libraries.
2147
2351
    
2148
2352
    # New type for defining tokens, syntax, and semantics all-in-one
2149
 
    Token = collections.namedtuple("Token",
2150
 
                                   ("regexp", # To match token; if
2151
 
                                              # "value" is not None,
2152
 
                                              # must have a "group"
2153
 
                                              # containing digits
2154
 
                                    "value",  # datetime.timedelta or
2155
 
                                              # None
2156
 
                                    "followers")) # Tokens valid after
2157
 
                                                  # this token
 
2353
    Token = collections.namedtuple("Token", (
 
2354
        "regexp",  # To match token; if "value" is not None, must have
 
2355
                   # a "group" containing digits
 
2356
        "value",   # datetime.timedelta or None
 
2357
        "followers"))           # Tokens valid after this token
2158
2358
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2159
2359
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2160
2360
    token_end = Token(re.compile(r"$"), None, frozenset())
2161
2361
    token_second = Token(re.compile(r"(\d+)S"),
2162
2362
                         datetime.timedelta(seconds=1),
2163
 
                         frozenset((token_end,)))
 
2363
                         frozenset((token_end, )))
2164
2364
    token_minute = Token(re.compile(r"(\d+)M"),
2165
2365
                         datetime.timedelta(minutes=1),
2166
2366
                         frozenset((token_second, token_end)))
2182
2382
                       frozenset((token_month, token_end)))
2183
2383
    token_week = Token(re.compile(r"(\d+)W"),
2184
2384
                       datetime.timedelta(weeks=1),
2185
 
                       frozenset((token_end,)))
 
2385
                       frozenset((token_end, )))
2186
2386
    token_duration = Token(re.compile(r"P"), None,
2187
2387
                           frozenset((token_year, token_month,
2188
2388
                                      token_day, token_time,
2189
 
                                      token_week))),
 
2389
                                      token_week)))
2190
2390
    # Define starting values
2191
2391
    value = datetime.timedelta() # Value so far
2192
2392
    found_token = None
2193
 
    followers = frozenset(token_duration,) # Following valid tokens
 
2393
    followers = frozenset((token_duration, )) # Following valid tokens
2194
2394
    s = duration                # String left to parse
2195
2395
    # Loop until end token is found
2196
2396
    while found_token is not token_end:
2213
2413
                break
2214
2414
        else:
2215
2415
            # No currently valid tokens were found
2216
 
            raise ValueError("Invalid RFC 3339 duration")
 
2416
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2417
                             .format(duration))
2217
2418
    # End token found
2218
2419
    return value
2219
2420
 
2243
2444
    timevalue = datetime.timedelta(0)
2244
2445
    for s in interval.split():
2245
2446
        try:
2246
 
            suffix = unicode(s[-1])
 
2447
            suffix = s[-1]
2247
2448
            value = int(s[:-1])
2248
2449
            if suffix == "d":
2249
2450
                delta = datetime.timedelta(value)
2256
2457
            elif suffix == "w":
2257
2458
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2258
2459
            else:
2259
 
                raise ValueError("Unknown suffix {0!r}"
2260
 
                                 .format(suffix))
2261
 
        except (ValueError, IndexError) as e:
 
2460
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2461
        except IndexError as e:
2262
2462
            raise ValueError(*(e.args))
2263
2463
        timevalue += delta
2264
2464
    return timevalue
2280
2480
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2281
2481
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2282
2482
            raise OSError(errno.ENODEV,
2283
 
                          "{0} not a character device"
 
2483
                          "{} not a character device"
2284
2484
                          .format(os.devnull))
2285
2485
        os.dup2(null, sys.stdin.fileno())
2286
2486
        os.dup2(null, sys.stdout.fileno())
2296
2496
    
2297
2497
    parser = argparse.ArgumentParser()
2298
2498
    parser.add_argument("-v", "--version", action="version",
2299
 
                        version = "%(prog)s {0}".format(version),
 
2499
                        version = "%(prog)s {}".format(version),
2300
2500
                        help="show version number and exit")
2301
2501
    parser.add_argument("-i", "--interface", metavar="IF",
2302
2502
                        help="Bind to interface IF")
2335
2535
                        help="Directory to save/restore state in")
2336
2536
    parser.add_argument("--foreground", action="store_true",
2337
2537
                        help="Run in foreground", default=None)
 
2538
    parser.add_argument("--no-zeroconf", action="store_false",
 
2539
                        dest="zeroconf", help="Do not use Zeroconf",
 
2540
                        default=None)
2338
2541
    
2339
2542
    options = parser.parse_args()
2340
2543
    
2341
2544
    if options.check:
2342
2545
        import doctest
2343
 
        doctest.testmod()
2344
 
        sys.exit()
 
2546
        fail_count, test_count = doctest.testmod()
 
2547
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2345
2548
    
2346
2549
    # Default values for config file for server-global settings
2347
2550
    server_defaults = { "interface": "",
2349
2552
                        "port": "",
2350
2553
                        "debug": "False",
2351
2554
                        "priority":
2352
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2555
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2556
                        ":+SIGN-DSA-SHA256",
2353
2557
                        "servicename": "Mandos",
2354
2558
                        "use_dbus": "True",
2355
2559
                        "use_ipv6": "True",
2358
2562
                        "socket": "",
2359
2563
                        "statedir": "/var/lib/mandos",
2360
2564
                        "foreground": "False",
2361
 
                        }
 
2565
                        "zeroconf": "True",
 
2566
                    }
2362
2567
    
2363
2568
    # Parse config file for server-global settings
2364
2569
    server_config = configparser.SafeConfigParser(server_defaults)
2365
2570
    del server_defaults
2366
 
    server_config.read(os.path.join(options.configdir,
2367
 
                                    "mandos.conf"))
 
2571
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2368
2572
    # Convert the SafeConfigParser object to a dict
2369
2573
    server_settings = server_config.defaults()
2370
2574
    # Use the appropriate methods on the non-string config options
2388
2592
    # Override the settings from the config file with command line
2389
2593
    # options, if set.
2390
2594
    for option in ("interface", "address", "port", "debug",
2391
 
                   "priority", "servicename", "configdir",
2392
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2393
 
                   "statedir", "socket", "foreground"):
 
2595
                   "priority", "servicename", "configdir", "use_dbus",
 
2596
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2597
                   "socket", "foreground", "zeroconf"):
2394
2598
        value = getattr(options, option)
2395
2599
        if value is not None:
2396
2600
            server_settings[option] = value
2397
2601
    del options
2398
2602
    # Force all strings to be unicode
2399
2603
    for option in server_settings.keys():
2400
 
        if type(server_settings[option]) is str:
2401
 
            server_settings[option] = unicode(server_settings[option])
 
2604
        if isinstance(server_settings[option], bytes):
 
2605
            server_settings[option] = (server_settings[option]
 
2606
                                       .decode("utf-8"))
2402
2607
    # Force all boolean options to be boolean
2403
2608
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2404
 
                   "foreground"):
 
2609
                   "foreground", "zeroconf"):
2405
2610
        server_settings[option] = bool(server_settings[option])
2406
2611
    # Debug implies foreground
2407
2612
    if server_settings["debug"]:
2410
2615
    
2411
2616
    ##################################################################
2412
2617
    
 
2618
    if (not server_settings["zeroconf"]
 
2619
        and not (server_settings["port"]
 
2620
                 or server_settings["socket"] != "")):
 
2621
        parser.error("Needs port or socket to work without Zeroconf")
 
2622
    
2413
2623
    # For convenience
2414
2624
    debug = server_settings["debug"]
2415
2625
    debuglevel = server_settings["debuglevel"]
2418
2628
    stored_state_path = os.path.join(server_settings["statedir"],
2419
2629
                                     stored_state_file)
2420
2630
    foreground = server_settings["foreground"]
 
2631
    zeroconf = server_settings["zeroconf"]
2421
2632
    
2422
2633
    if debug:
2423
2634
        initlogger(debug, logging.DEBUG)
2429
2640
            initlogger(debug, level)
2430
2641
    
2431
2642
    if server_settings["servicename"] != "Mandos":
2432
 
        syslogger.setFormatter(logging.Formatter
2433
 
                               ('Mandos ({0}) [%(process)d]:'
2434
 
                                ' %(levelname)s: %(message)s'
2435
 
                                .format(server_settings
2436
 
                                        ["servicename"])))
 
2643
        syslogger.setFormatter(
 
2644
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2645
                              ' %(levelname)s: %(message)s'.format(
 
2646
                                  server_settings["servicename"])))
2437
2647
    
2438
2648
    # Parse config file with clients
2439
2649
    client_config = configparser.SafeConfigParser(Client
2444
2654
    global mandos_dbus_service
2445
2655
    mandos_dbus_service = None
2446
2656
    
2447
 
    tcp_server = MandosServer((server_settings["address"],
2448
 
                               server_settings["port"]),
2449
 
                              ClientHandler,
2450
 
                              interface=(server_settings["interface"]
2451
 
                                         or None),
2452
 
                              use_ipv6=use_ipv6,
2453
 
                              gnutls_priority=
2454
 
                              server_settings["priority"],
2455
 
                              use_dbus=use_dbus,
2456
 
                              socketfd=(server_settings["socket"]
2457
 
                                        or None))
 
2657
    socketfd = None
 
2658
    if server_settings["socket"] != "":
 
2659
        socketfd = server_settings["socket"]
 
2660
    tcp_server = MandosServer(
 
2661
        (server_settings["address"], server_settings["port"]),
 
2662
        ClientHandler,
 
2663
        interface=(server_settings["interface"] or None),
 
2664
        use_ipv6=use_ipv6,
 
2665
        gnutls_priority=server_settings["priority"],
 
2666
        use_dbus=use_dbus,
 
2667
        socketfd=socketfd)
2458
2668
    if not foreground:
2459
2669
        pidfilename = "/run/mandos.pid"
 
2670
        if not os.path.isdir("/run/."):
 
2671
            pidfilename = "/var/run/mandos.pid"
2460
2672
        pidfile = None
2461
2673
        try:
2462
 
            pidfile = open(pidfilename, "w")
 
2674
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2463
2675
        except IOError as e:
2464
2676
            logger.error("Could not open file %r", pidfilename,
2465
2677
                         exc_info=e)
2479
2691
        os.setuid(uid)
2480
2692
    except OSError as error:
2481
2693
        if error.errno != errno.EPERM:
2482
 
            raise error
 
2694
            raise
2483
2695
    
2484
2696
    if debug:
2485
2697
        # Enable all possible GnuTLS debugging
2492
2704
        def debug_gnutls(level, string):
2493
2705
            logger.debug("GnuTLS: %s", string[:-1])
2494
2706
        
2495
 
        (gnutls.library.functions
2496
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2707
        gnutls.library.functions.gnutls_global_set_log_function(
 
2708
            debug_gnutls)
2497
2709
        
2498
2710
        # Redirect stdin so all checkers get /dev/null
2499
2711
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2519
2731
    if use_dbus:
2520
2732
        try:
2521
2733
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2522
 
                                            bus, do_not_queue=True)
2523
 
            old_bus_name = (dbus.service.BusName
2524
 
                            ("se.bsnet.fukt.Mandos", bus,
2525
 
                             do_not_queue=True))
2526
 
        except dbus.exceptions.NameExistsException as e:
 
2734
                                            bus,
 
2735
                                            do_not_queue=True)
 
2736
            old_bus_name = dbus.service.BusName(
 
2737
                "se.bsnet.fukt.Mandos", bus,
 
2738
                do_not_queue=True)
 
2739
        except dbus.exceptions.DBusException as e:
2527
2740
            logger.error("Disabling D-Bus:", exc_info=e)
2528
2741
            use_dbus = False
2529
2742
            server_settings["use_dbus"] = False
2530
2743
            tcp_server.use_dbus = False
2531
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2532
 
    service = AvahiServiceToSyslog(name =
2533
 
                                   server_settings["servicename"],
2534
 
                                   servicetype = "_mandos._tcp",
2535
 
                                   protocol = protocol, bus = bus)
2536
 
    if server_settings["interface"]:
2537
 
        service.interface = (if_nametoindex
2538
 
                             (str(server_settings["interface"])))
 
2744
    if zeroconf:
 
2745
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2746
        service = AvahiServiceToSyslog(
 
2747
            name = server_settings["servicename"],
 
2748
            servicetype = "_mandos._tcp",
 
2749
            protocol = protocol,
 
2750
            bus = bus)
 
2751
        if server_settings["interface"]:
 
2752
            service.interface = if_nametoindex(
 
2753
                server_settings["interface"].encode("utf-8"))
2539
2754
    
2540
2755
    global multiprocessing_manager
2541
2756
    multiprocessing_manager = multiprocessing.Manager()
2560
2775
    if server_settings["restore"]:
2561
2776
        try:
2562
2777
            with open(stored_state_path, "rb") as stored_state:
2563
 
                clients_data, old_client_settings = (pickle.load
2564
 
                                                     (stored_state))
 
2778
                clients_data, old_client_settings = pickle.load(
 
2779
                    stored_state)
2565
2780
            os.remove(stored_state_path)
2566
2781
        except IOError as e:
2567
2782
            if e.errno == errno.ENOENT:
2568
 
                logger.warning("Could not load persistent state: {0}"
2569
 
                                .format(os.strerror(e.errno)))
 
2783
                logger.warning("Could not load persistent state:"
 
2784
                               " {}".format(os.strerror(e.errno)))
2570
2785
            else:
2571
2786
                logger.critical("Could not load persistent state:",
2572
2787
                                exc_info=e)
2573
2788
                raise
2574
2789
        except EOFError as e:
2575
2790
            logger.warning("Could not load persistent state: "
2576
 
                           "EOFError:", exc_info=e)
 
2791
                           "EOFError:",
 
2792
                           exc_info=e)
2577
2793
    
2578
2794
    with PGPEngine() as pgp:
2579
 
        for client_name, client in clients_data.iteritems():
 
2795
        for client_name, client in clients_data.items():
2580
2796
            # Skip removed clients
2581
2797
            if client_name not in client_settings:
2582
2798
                continue
2591
2807
                    # For each value in new config, check if it
2592
2808
                    # differs from the old config value (Except for
2593
2809
                    # the "secret" attribute)
2594
 
                    if (name != "secret" and
2595
 
                        value != old_client_settings[client_name]
2596
 
                        [name]):
 
2810
                    if (name != "secret"
 
2811
                        and (value !=
 
2812
                             old_client_settings[client_name][name])):
2597
2813
                        client[name] = value
2598
2814
                except KeyError:
2599
2815
                    pass
2600
2816
            
2601
2817
            # Clients who has passed its expire date can still be
2602
 
            # enabled if its last checker was successful.  Clients
 
2818
            # enabled if its last checker was successful.  A Client
2603
2819
            # whose checker succeeded before we stored its state is
2604
2820
            # assumed to have successfully run all checkers during
2605
2821
            # downtime.
2607
2823
                if datetime.datetime.utcnow() >= client["expires"]:
2608
2824
                    if not client["last_checked_ok"]:
2609
2825
                        logger.warning(
2610
 
                            "disabling client {0} - Client never "
2611
 
                            "performed a successful checker"
2612
 
                            .format(client_name))
 
2826
                            "disabling client {} - Client never "
 
2827
                            "performed a successful checker".format(
 
2828
                                client_name))
2613
2829
                        client["enabled"] = False
2614
2830
                    elif client["last_checker_status"] != 0:
2615
2831
                        logger.warning(
2616
 
                            "disabling client {0} - Client "
2617
 
                            "last checker failed with error code {1}"
2618
 
                            .format(client_name,
2619
 
                                    client["last_checker_status"]))
 
2832
                            "disabling client {} - Client last"
 
2833
                            " checker failed with error code"
 
2834
                            " {}".format(
 
2835
                                client_name,
 
2836
                                client["last_checker_status"]))
2620
2837
                        client["enabled"] = False
2621
2838
                    else:
2622
 
                        client["expires"] = (datetime.datetime
2623
 
                                             .utcnow()
2624
 
                                             + client["timeout"])
 
2839
                        client["expires"] = (
 
2840
                            datetime.datetime.utcnow()
 
2841
                            + client["timeout"])
2625
2842
                        logger.debug("Last checker succeeded,"
2626
 
                                     " keeping {0} enabled"
2627
 
                                     .format(client_name))
 
2843
                                     " keeping {} enabled".format(
 
2844
                                         client_name))
2628
2845
            try:
2629
 
                client["secret"] = (
2630
 
                    pgp.decrypt(client["encrypted_secret"],
2631
 
                                client_settings[client_name]
2632
 
                                ["secret"]))
 
2846
                client["secret"] = pgp.decrypt(
 
2847
                    client["encrypted_secret"],
 
2848
                    client_settings[client_name]["secret"])
2633
2849
            except PGPError:
2634
2850
                # If decryption fails, we use secret from new settings
2635
 
                logger.debug("Failed to decrypt {0} old secret"
2636
 
                             .format(client_name))
2637
 
                client["secret"] = (
2638
 
                    client_settings[client_name]["secret"])
 
2851
                logger.debug("Failed to decrypt {} old secret".format(
 
2852
                    client_name))
 
2853
                client["secret"] = (client_settings[client_name]
 
2854
                                    ["secret"])
2639
2855
    
2640
2856
    # Add/remove clients based on new changes made to config
2641
2857
    for client_name in (set(old_client_settings)
2646
2862
        clients_data[client_name] = client_settings[client_name]
2647
2863
    
2648
2864
    # Create all client objects
2649
 
    for client_name, client in clients_data.iteritems():
 
2865
    for client_name, client in clients_data.items():
2650
2866
        tcp_server.clients[client_name] = client_class(
2651
 
            name = client_name, settings = client,
 
2867
            name = client_name,
 
2868
            settings = client,
2652
2869
            server_settings = server_settings)
2653
2870
    
2654
2871
    if not tcp_server.clients:
2656
2873
    
2657
2874
    if not foreground:
2658
2875
        if pidfile is not None:
 
2876
            pid = os.getpid()
2659
2877
            try:
2660
2878
                with pidfile:
2661
 
                    pid = os.getpid()
2662
 
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2879
                    print(pid, file=pidfile)
2663
2880
            except IOError:
2664
2881
                logger.error("Could not write to file %r with PID %d",
2665
2882
                             pidfilename, pid)
2670
2887
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2671
2888
    
2672
2889
    if use_dbus:
2673
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2674
 
                                        "se.bsnet.fukt.Mandos"})
2675
 
        class MandosDBusService(DBusObjectWithProperties):
 
2890
        
 
2891
        @alternate_dbus_interfaces(
 
2892
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2893
        class MandosDBusService(DBusObjectWithObjectManager):
2676
2894
            """A D-Bus proxy object"""
 
2895
            
2677
2896
            def __init__(self):
2678
2897
                dbus.service.Object.__init__(self, bus, "/")
 
2898
            
2679
2899
            _interface = "se.recompile.Mandos"
2680
2900
            
2681
 
            @dbus_interface_annotations(_interface)
2682
 
            def _foo(self):
2683
 
                return { "org.freedesktop.DBus.Property"
2684
 
                         ".EmitsChangedSignal":
2685
 
                             "false"}
2686
 
            
2687
2901
            @dbus.service.signal(_interface, signature="o")
2688
2902
            def ClientAdded(self, objpath):
2689
2903
                "D-Bus signal"
2694
2908
                "D-Bus signal"
2695
2909
                pass
2696
2910
            
 
2911
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2912
                               "true"})
2697
2913
            @dbus.service.signal(_interface, signature="os")
2698
2914
            def ClientRemoved(self, objpath, name):
2699
2915
                "D-Bus signal"
2700
2916
                pass
2701
2917
            
 
2918
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2919
                               "true"})
2702
2920
            @dbus.service.method(_interface, out_signature="ao")
2703
2921
            def GetAllClients(self):
2704
2922
                "D-Bus method"
2705
 
                return dbus.Array(c.dbus_object_path
2706
 
                                  for c in
 
2923
                return dbus.Array(c.dbus_object_path for c in
2707
2924
                                  tcp_server.clients.itervalues())
2708
2925
            
 
2926
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2927
                               "true"})
2709
2928
            @dbus.service.method(_interface,
2710
2929
                                 out_signature="a{oa{sv}}")
2711
2930
            def GetAllClientsWithProperties(self):
2712
2931
                "D-Bus method"
2713
2932
                return dbus.Dictionary(
2714
 
                    ((c.dbus_object_path, c.GetAll(""))
2715
 
                     for c in tcp_server.clients.itervalues()),
 
2933
                    { c.dbus_object_path: c.GetAll(
 
2934
                        "se.recompile.Mandos.Client")
 
2935
                      for c in tcp_server.clients.itervalues() },
2716
2936
                    signature="oa{sv}")
2717
2937
            
2718
2938
            @dbus.service.method(_interface, in_signature="o")
2722
2942
                    if c.dbus_object_path == object_path:
2723
2943
                        del tcp_server.clients[c.name]
2724
2944
                        c.remove_from_connection()
2725
 
                        # Don't signal anything except ClientRemoved
 
2945
                        # Don't signal the disabling
2726
2946
                        c.disable(quiet=True)
2727
 
                        # Emit D-Bus signal
2728
 
                        self.ClientRemoved(object_path, c.name)
 
2947
                        # Emit D-Bus signal for removal
 
2948
                        self.client_removed_signal(c)
2729
2949
                        return
2730
2950
                raise KeyError(object_path)
2731
2951
            
2732
2952
            del _interface
 
2953
            
 
2954
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
2955
                                 out_signature = "a{oa{sa{sv}}}")
 
2956
            def GetManagedObjects(self):
 
2957
                """D-Bus method"""
 
2958
                return dbus.Dictionary(
 
2959
                    { client.dbus_object_path:
 
2960
                      dbus.Dictionary(
 
2961
                          { interface: client.GetAll(interface)
 
2962
                            for interface in
 
2963
                                 client._get_all_interface_names()})
 
2964
                      for client in tcp_server.clients.values()})
 
2965
            
 
2966
            def client_added_signal(self, client):
 
2967
                """Send the new standard signal and the old signal"""
 
2968
                if use_dbus:
 
2969
                    # New standard signal
 
2970
                    self.InterfacesAdded(
 
2971
                        client.dbus_object_path,
 
2972
                        dbus.Dictionary(
 
2973
                            { interface: client.GetAll(interface)
 
2974
                              for interface in
 
2975
                              client._get_all_interface_names()}))
 
2976
                    # Old signal
 
2977
                    self.ClientAdded(client.dbus_object_path)
 
2978
            
 
2979
            def client_removed_signal(self, client):
 
2980
                """Send the new standard signal and the old signal"""
 
2981
                if use_dbus:
 
2982
                    # New standard signal
 
2983
                    self.InterfacesRemoved(
 
2984
                        client.dbus_object_path,
 
2985
                        client._get_all_interface_names())
 
2986
                    # Old signal
 
2987
                    self.ClientRemoved(client.dbus_object_path,
 
2988
                                       client.name)
2733
2989
        
2734
2990
        mandos_dbus_service = MandosDBusService()
2735
2991
    
2736
2992
    def cleanup():
2737
2993
        "Cleanup function; run on exit"
2738
 
        service.cleanup()
 
2994
        if zeroconf:
 
2995
            service.cleanup()
2739
2996
        
2740
2997
        multiprocessing.active_children()
2741
2998
        wnull.close()
2755
3012
                
2756
3013
                # A list of attributes that can not be pickled
2757
3014
                # + secret.
2758
 
                exclude = set(("bus", "changedstate", "secret",
2759
 
                               "checker", "server_settings"))
2760
 
                for name, typ in (inspect.getmembers
2761
 
                                  (dbus.service.Object)):
 
3015
                exclude = { "bus", "changedstate", "secret",
 
3016
                            "checker", "server_settings" }
 
3017
                for name, typ in inspect.getmembers(dbus.service
 
3018
                                                    .Object):
2762
3019
                    exclude.add(name)
2763
3020
                
2764
3021
                client_dict["encrypted_secret"] = (client
2771
3028
                del client_settings[client.name]["secret"]
2772
3029
        
2773
3030
        try:
2774
 
            with (tempfile.NamedTemporaryFile
2775
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2776
 
                   dir=os.path.dirname(stored_state_path),
2777
 
                   delete=False)) as stored_state:
 
3031
            with tempfile.NamedTemporaryFile(
 
3032
                    mode='wb',
 
3033
                    suffix=".pickle",
 
3034
                    prefix='clients-',
 
3035
                    dir=os.path.dirname(stored_state_path),
 
3036
                    delete=False) as stored_state:
2778
3037
                pickle.dump((clients, client_settings), stored_state)
2779
 
                tempname=stored_state.name
 
3038
                tempname = stored_state.name
2780
3039
            os.rename(tempname, stored_state_path)
2781
3040
        except (IOError, OSError) as e:
2782
3041
            if not debug:
2785
3044
                except NameError:
2786
3045
                    pass
2787
3046
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2788
 
                logger.warning("Could not save persistent state: {0}"
 
3047
                logger.warning("Could not save persistent state: {}"
2789
3048
                               .format(os.strerror(e.errno)))
2790
3049
            else:
2791
3050
                logger.warning("Could not save persistent state:",
2792
3051
                               exc_info=e)
2793
 
                raise e
 
3052
                raise
2794
3053
        
2795
3054
        # Delete all clients, and settings from config
2796
3055
        while tcp_server.clients:
2797
3056
            name, client = tcp_server.clients.popitem()
2798
3057
            if use_dbus:
2799
3058
                client.remove_from_connection()
2800
 
            # Don't signal anything except ClientRemoved
 
3059
            # Don't signal the disabling
2801
3060
            client.disable(quiet=True)
2802
 
            if use_dbus:
2803
 
                # Emit D-Bus signal
2804
 
                mandos_dbus_service.ClientRemoved(client
2805
 
                                                  .dbus_object_path,
2806
 
                                                  client.name)
 
3061
            # Emit D-Bus signal for removal
 
3062
            mandos_dbus_service.client_removed_signal(client)
2807
3063
        client_settings.clear()
2808
3064
    
2809
3065
    atexit.register(cleanup)
2810
3066
    
2811
3067
    for client in tcp_server.clients.itervalues():
2812
3068
        if use_dbus:
2813
 
            # Emit D-Bus signal
2814
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3069
            # Emit D-Bus signal for adding
 
3070
            mandos_dbus_service.client_added_signal(client)
2815
3071
        # Need to initiate checking of clients
2816
3072
        if client.enabled:
2817
3073
            client.init_checker()
2820
3076
    tcp_server.server_activate()
2821
3077
    
2822
3078
    # Find out what port we got
2823
 
    service.port = tcp_server.socket.getsockname()[1]
 
3079
    if zeroconf:
 
3080
        service.port = tcp_server.socket.getsockname()[1]
2824
3081
    if use_ipv6:
2825
3082
        logger.info("Now listening on address %r, port %d,"
2826
3083
                    " flowinfo %d, scope_id %d",
2832
3089
    #service.interface = tcp_server.socket.getsockname()[3]
2833
3090
    
2834
3091
    try:
2835
 
        # From the Avahi example code
2836
 
        try:
2837
 
            service.activate()
2838
 
        except dbus.exceptions.DBusException as error:
2839
 
            logger.critical("D-Bus Exception", exc_info=error)
2840
 
            cleanup()
2841
 
            sys.exit(1)
2842
 
        # End of Avahi example code
 
3092
        if zeroconf:
 
3093
            # From the Avahi example code
 
3094
            try:
 
3095
                service.activate()
 
3096
            except dbus.exceptions.DBusException as error:
 
3097
                logger.critical("D-Bus Exception", exc_info=error)
 
3098
                cleanup()
 
3099
                sys.exit(1)
 
3100
            # End of Avahi example code
2843
3101
        
2844
3102
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2845
3103
                             lambda *args, **kwargs:
2860
3118
    # Must run before the D-Bus bus name gets deregistered
2861
3119
    cleanup()
2862
3120
 
 
3121
 
2863
3122
if __name__ == '__main__':
2864
3123
    main()