/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-10-26 19:05:21 UTC
  • Revision ID: teddy@recompile.se-20131026190521-giagilisbyciox2h
Fall back to /var/run for pidfile if /run is not a directory.

This is for old (possibly non-Debian) systems which have not migrated
from /var/run to /run yet.

* init.d-mandos (PIDFILE): Fall back to /var/run/mandos.pid if /run is
                           not a directory.
* mandos (pidfilename): - '' -
* mandos.xml (FILES): Document fallback to /var/run/mandos.pid if /run
                      is not a directory.

Reported-by: Nathanael D. Noblet <nathanael@gnat.ca>
Suggested-by: Nathanael D. Noblet <nathanael@gnat.ca>

Show diffs side-by-side

added added

removed removed

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