/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-13 01:49:18 UTC
  • Revision ID: teddy@recompile.se-20131013014918-08ybiy64qxy4ceza
* initramfs-tools-hook: Bug fix: Make sure the right version of GnuPG
                        is copied into the initramfs image.  Always
                        assume that GPGME is used to avoid searching
                        for it since the path might not be /usr/lib.
                        Thanks to Félix Sipma <felix+debian@gueux.org>
                        for the initial bug report, and also thanks to
                        Dick Middleton <dick@lingbrae.com> for some
                        more debugging.
* initramfs-unpack: New script to help with development and debugging.
                    It is only part of the source tree, it is not
                    installed.

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-2012 Teddy Hogeborn
 
15
# Copyright © 2008-2012 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.1"
 
91
version = "1.6.0"
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',
189
172
    def password_encode(self, password):
190
173
        # Passphrase can not be empty and can not contain newlines or
191
174
        # NUL bytes.  So we prefix it and hex encode it.
192
 
        encoded = b"mandos" + binascii.hexlify(password)
193
 
        if len(encoded) > 2048:
194
 
            # GnuPG can't handle long passwords, so encode differently
195
 
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
196
 
                       .replace(b"\n", b"\\n")
197
 
                       .replace(b"\0", b"\\x00"))
198
 
        return encoded
 
175
        return b"mandos" + binascii.hexlify(password)
199
176
    
200
177
    def encrypt(self, data, password):
201
178
        passphrase = self.password_encode(password)
202
 
        with tempfile.NamedTemporaryFile(
203
 
                dir=self.tempdir) as passfile:
 
179
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
180
                                         ) as passfile:
204
181
            passfile.write(passphrase)
205
182
            passfile.flush()
206
183
            proc = subprocess.Popen(['gpg', '--symmetric',
217
194
    
218
195
    def decrypt(self, data, password):
219
196
        passphrase = self.password_encode(password)
220
 
        with tempfile.NamedTemporaryFile(
221
 
                dir = self.tempdir) as passfile:
 
197
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
198
                                         ) as passfile:
222
199
            passfile.write(passphrase)
223
200
            passfile.flush()
224
201
            proc = subprocess.Popen(['gpg', '--decrypt',
228
205
                                    stdin = subprocess.PIPE,
229
206
                                    stdout = subprocess.PIPE,
230
207
                                    stderr = subprocess.PIPE)
231
 
            decrypted_plaintext, err = proc.communicate(input = data)
 
208
            decrypted_plaintext, err = proc.communicate(input
 
209
                                                        = data)
232
210
        if proc.returncode != 0:
233
211
            raise PGPError(err)
234
212
        return decrypted_plaintext
237
215
class AvahiError(Exception):
238
216
    def __init__(self, value, *args, **kwargs):
239
217
        self.value = value
240
 
        return super(AvahiError, self).__init__(value, *args,
241
 
                                                **kwargs)
242
 
 
 
218
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
219
    def __unicode__(self):
 
220
        return unicode(repr(self.value))
243
221
 
244
222
class AvahiServiceError(AvahiError):
245
223
    pass
246
224
 
247
 
 
248
225
class AvahiGroupError(AvahiError):
249
226
    pass
250
227
 
270
247
    bus: dbus.SystemBus()
271
248
    """
272
249
    
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):
 
250
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
 
251
                 servicetype = None, port = None, TXT = None,
 
252
                 domain = "", host = "", max_renames = 32768,
 
253
                 protocol = avahi.PROTO_UNSPEC, bus = None):
284
254
        self.interface = interface
285
255
        self.name = name
286
256
        self.type = servicetype
296
266
        self.bus = bus
297
267
        self.entry_group_state_changed_match = None
298
268
    
299
 
    def rename(self, remove=True):
 
269
    def rename(self):
300
270
        """Derived from the Avahi example code"""
301
271
        if self.rename_count >= self.max_renames:
302
272
            logger.critical("No suitable Zeroconf service name found"
303
273
                            " after %i retries, exiting.",
304
274
                            self.rename_count)
305
275
            raise AvahiServiceError("Too many renames")
306
 
        self.name = str(
307
 
            self.server.GetAlternativeServiceName(self.name))
308
 
        self.rename_count += 1
 
276
        self.name = unicode(self.server
 
277
                            .GetAlternativeServiceName(self.name))
309
278
        logger.info("Changing Zeroconf service name to %r ...",
310
279
                    self.name)
311
 
        if remove:
312
 
            self.remove()
 
280
        self.remove()
313
281
        try:
314
282
            self.add()
315
283
        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)
 
284
            logger.critical("D-Bus Exception", exc_info=error)
 
285
            self.cleanup()
 
286
            os._exit(1)
 
287
        self.rename_count += 1
324
288
    
325
289
    def remove(self):
326
290
        """Derived from the Avahi example code"""
364
328
            self.rename()
365
329
        elif state == avahi.ENTRY_GROUP_FAILURE:
366
330
            logger.critical("Avahi: Error in group state changed %s",
367
 
                            str(error))
368
 
            raise AvahiGroupError("State changed: {!s}".format(error))
 
331
                            unicode(error))
 
332
            raise AvahiGroupError("State changed: {0!s}"
 
333
                                  .format(error))
369
334
    
370
335
    def cleanup(self):
371
336
        """Derived from the Avahi example code"""
381
346
    def server_state_changed(self, state, error=None):
382
347
        """Derived from the Avahi example code"""
383
348
        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
 
        }
 
349
        bad_states = { avahi.SERVER_INVALID:
 
350
                           "Zeroconf server invalid",
 
351
                       avahi.SERVER_REGISTERING: None,
 
352
                       avahi.SERVER_COLLISION:
 
353
                           "Zeroconf server name collision",
 
354
                       avahi.SERVER_FAILURE:
 
355
                           "Zeroconf server failure" }
390
356
        if state in bad_states:
391
357
            if bad_states[state] is not None:
392
358
                if error is None:
395
361
                    logger.error(bad_states[state] + ": %r", error)
396
362
            self.cleanup()
397
363
        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)
 
364
            self.add()
410
365
        else:
411
366
            if error is None:
412
367
                logger.debug("Unknown state: %r", state)
422
377
                                    follow_name_owner_changes=True),
423
378
                avahi.DBUS_INTERFACE_SERVER)
424
379
        self.server.connect_to_signal("StateChanged",
425
 
                                      self.server_state_changed)
 
380
                                 self.server_state_changed)
426
381
        self.server_state_changed(self.server.GetState())
427
382
 
428
383
 
429
384
class AvahiServiceToSyslog(AvahiService):
430
 
    def rename(self, *args, **kwargs):
 
385
    def rename(self):
431
386
        """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)))
 
387
        ret = AvahiService.rename(self)
 
388
        syslogger.setFormatter(logging.Formatter
 
389
                               ('Mandos ({0}) [%(process)d]:'
 
390
                                ' %(levelname)s: %(message)s'
 
391
                                .format(self.name)))
436
392
        return ret
437
393
 
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()
 
394
 
 
395
def timedelta_to_milliseconds(td):
 
396
    "Convert a datetime.timedelta() to milliseconds"
 
397
    return ((td.days * 24 * 60 * 60 * 1000)
 
398
            + (td.seconds * 1000)
 
399
            + (td.microseconds // 1000))
 
400
 
447
401
 
448
402
class Client(object):
449
403
    """A representation of a client host served by this server.
476
430
    last_checker_status: integer between 0 and 255 reflecting exit
477
431
                         status of last checker. -1 reflects crashed
478
432
                         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
433
    last_enabled: datetime.datetime(); (UTC) or None
482
434
    name:       string; from the config file, used in log messages and
483
435
                        D-Bus identifiers
496
448
                          "fingerprint", "host", "interval",
497
449
                          "last_approval_request", "last_checked_ok",
498
450
                          "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
 
    }
 
451
    client_defaults = { "timeout": "PT5M",
 
452
                        "extended_timeout": "PT15M",
 
453
                        "interval": "PT2M",
 
454
                        "checker": "fping -q -- %%(host)s",
 
455
                        "host": "",
 
456
                        "approval_delay": "PT0S",
 
457
                        "approval_duration": "PT1S",
 
458
                        "approved_by_default": "True",
 
459
                        "enabled": "True",
 
460
                        }
 
461
    
 
462
    def timeout_milliseconds(self):
 
463
        "Return the 'timeout' attribute in milliseconds"
 
464
        return timedelta_to_milliseconds(self.timeout)
 
465
    
 
466
    def extended_timeout_milliseconds(self):
 
467
        "Return the 'extended_timeout' attribute in milliseconds"
 
468
        return timedelta_to_milliseconds(self.extended_timeout)
 
469
    
 
470
    def interval_milliseconds(self):
 
471
        "Return the 'interval' attribute in milliseconds"
 
472
        return timedelta_to_milliseconds(self.interval)
 
473
    
 
474
    def approval_delay_milliseconds(self):
 
475
        return timedelta_to_milliseconds(self.approval_delay)
510
476
    
511
477
    @staticmethod
512
478
    def config_parser(config):
528
494
            client["enabled"] = config.getboolean(client_name,
529
495
                                                  "enabled")
530
496
            
531
 
            # Uppercase and remove spaces from fingerprint for later
532
 
            # comparison purposes with return value from the
533
 
            # fingerprint() function
534
497
            client["fingerprint"] = (section["fingerprint"].upper()
535
498
                                     .replace(" ", ""))
536
499
            if "secret" in section:
541
504
                          "rb") as secfile:
542
505
                    client["secret"] = secfile.read()
543
506
            else:
544
 
                raise TypeError("No secret or secfile for section {}"
 
507
                raise TypeError("No secret or secfile for section {0}"
545
508
                                .format(section))
546
509
            client["timeout"] = string_to_delta(section["timeout"])
547
510
            client["extended_timeout"] = string_to_delta(
564
527
            server_settings = {}
565
528
        self.server_settings = server_settings
566
529
        # adding all client settings
567
 
        for setting, value in settings.items():
 
530
        for setting, value in settings.iteritems():
568
531
            setattr(self, setting, value)
569
532
        
570
533
        if self.enabled:
578
541
            self.expires = None
579
542
        
580
543
        logger.debug("Creating client %r", self.name)
 
544
        # Uppercase and remove spaces from fingerprint for later
 
545
        # comparison purposes with return value from the fingerprint()
 
546
        # function
581
547
        logger.debug("  Fingerprint: %s", self.fingerprint)
582
548
        self.created = settings.get("created",
583
549
                                    datetime.datetime.utcnow())
590
556
        self.current_checker_command = None
591
557
        self.approved = None
592
558
        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()
 
559
        self.changedstate = (multiprocessing_manager
 
560
                             .Condition(multiprocessing_manager
 
561
                                        .Lock()))
 
562
        self.client_structure = [attr for attr in
 
563
                                 self.__dict__.iterkeys()
597
564
                                 if not attr.startswith("_")]
598
565
        self.client_structure.append("client_structure")
599
566
        
600
 
        for name, t in inspect.getmembers(
601
 
                type(self), lambda obj: isinstance(obj, property)):
 
567
        for name, t in inspect.getmembers(type(self),
 
568
                                          lambda obj:
 
569
                                              isinstance(obj,
 
570
                                                         property)):
602
571
            if not name.startswith("_"):
603
572
                self.client_structure.append(name)
604
573
    
646
615
        # and every interval from then on.
647
616
        if self.checker_initiator_tag is not None:
648
617
            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)
 
618
        self.checker_initiator_tag = (gobject.timeout_add
 
619
                                      (self.interval_milliseconds(),
 
620
                                       self.start_checker))
652
621
        # Schedule a disable() when 'timeout' has passed
653
622
        if self.disable_initiator_tag is not None:
654
623
            gobject.source_remove(self.disable_initiator_tag)
655
 
        self.disable_initiator_tag = gobject.timeout_add(
656
 
            int(self.timeout.total_seconds() * 1000), self.disable)
 
624
        self.disable_initiator_tag = (gobject.timeout_add
 
625
                                   (self.timeout_milliseconds(),
 
626
                                    self.disable))
657
627
        # Also start a new checker *right now*.
658
628
        self.start_checker()
659
629
    
660
 
    def checker_callback(self, source, condition, connection,
661
 
                         command):
 
630
    def checker_callback(self, pid, condition, command):
662
631
        """The checker has completed, so take appropriate actions."""
663
632
        self.checker_callback_tag = None
664
633
        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
 
634
        if os.WIFEXITED(condition):
 
635
            self.last_checker_status = os.WEXITSTATUS(condition)
672
636
            if self.last_checker_status == 0:
673
637
                logger.info("Checker for %(name)s succeeded",
674
638
                            vars(self))
675
639
                self.checked_ok()
676
640
            else:
677
 
                logger.info("Checker for %(name)s failed", vars(self))
 
641
                logger.info("Checker for %(name)s failed",
 
642
                            vars(self))
678
643
        else:
679
644
            self.last_checker_status = -1
680
 
            self.last_checker_signal = -returncode
681
645
            logger.warning("Checker for %(name)s crashed?",
682
646
                           vars(self))
683
 
        return False
684
647
    
685
648
    def checked_ok(self):
686
649
        """Assert that the client has been seen, alive and well."""
687
650
        self.last_checked_ok = datetime.datetime.utcnow()
688
651
        self.last_checker_status = 0
689
 
        self.last_checker_signal = None
690
652
        self.bump_timeout()
691
653
    
692
654
    def bump_timeout(self, timeout=None):
697
659
            gobject.source_remove(self.disable_initiator_tag)
698
660
            self.disable_initiator_tag = None
699
661
        if getattr(self, "enabled", False):
700
 
            self.disable_initiator_tag = gobject.timeout_add(
701
 
                int(timeout.total_seconds() * 1000), self.disable)
 
662
            self.disable_initiator_tag = (gobject.timeout_add
 
663
                                          (timedelta_to_milliseconds
 
664
                                           (timeout), self.disable))
702
665
            self.expires = datetime.datetime.utcnow() + timeout
703
666
    
704
667
    def need_approval(self):
718
681
        # than 'timeout' for the client to be disabled, which is as it
719
682
        # should be.
720
683
        
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
 
684
        # If a checker exists, make sure it is not a zombie
 
685
        try:
 
686
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
687
        except (AttributeError, OSError) as error:
 
688
            if (isinstance(error, OSError)
 
689
                and error.errno != errno.ECHILD):
 
690
                raise error
 
691
        else:
 
692
            if pid:
 
693
                logger.warning("Checker was a zombie")
 
694
                gobject.source_remove(self.checker_callback_tag)
 
695
                self.checker_callback(pid, status,
 
696
                                      self.current_checker_command)
725
697
        # Start a new checker if needed
726
698
        if self.checker is None:
727
699
            # Escape attributes for the shell
728
 
            escaped_attrs = {
729
 
                attr: re.escape(str(getattr(self, attr)))
730
 
                for attr in self.runtime_expansions }
 
700
            escaped_attrs = dict(
 
701
                (attr, re.escape(unicode(getattr(self, attr))))
 
702
                for attr in
 
703
                self.runtime_expansions)
731
704
            try:
732
705
                command = self.checker_command % escaped_attrs
733
706
            except TypeError as error:
734
707
                logger.error('Could not format string "%s"',
735
 
                             self.checker_command,
 
708
                             self.checker_command, exc_info=error)
 
709
                return True # Try again later
 
710
            self.current_checker_command = command
 
711
            try:
 
712
                logger.info("Starting checker %r for %s",
 
713
                            command, self.name)
 
714
                # We don't need to redirect stdout and stderr, since
 
715
                # in normal mode, that is already done by daemon(),
 
716
                # and in debug mode we don't want to.  (Stdin is
 
717
                # always replaced by /dev/null.)
 
718
                # The exception is when not debugging but nevertheless
 
719
                # running in the foreground; use the previously
 
720
                # created wnull.
 
721
                popen_args = {}
 
722
                if (not self.server_settings["debug"]
 
723
                    and self.server_settings["foreground"]):
 
724
                    popen_args.update({"stdout": wnull,
 
725
                                       "stderr": wnull })
 
726
                self.checker = subprocess.Popen(command,
 
727
                                                close_fds=True,
 
728
                                                shell=True, cwd="/",
 
729
                                                **popen_args)
 
730
            except OSError as error:
 
731
                logger.error("Failed to start subprocess",
736
732
                             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)
 
733
                return True
 
734
            self.checker_callback_tag = (gobject.child_watch_add
 
735
                                         (self.checker.pid,
 
736
                                          self.checker_callback,
 
737
                                          data=command))
 
738
            # The checker may have completed before the gobject
 
739
            # watch was added.  Check for this.
 
740
            try:
 
741
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
742
            except OSError as error:
 
743
                if error.errno == errno.ECHILD:
 
744
                    # This should never happen
 
745
                    logger.error("Child process vanished",
 
746
                                 exc_info=error)
 
747
                    return True
 
748
                raise
 
749
            if pid:
 
750
                gobject.source_remove(self.checker_callback_tag)
 
751
                self.checker_callback(pid, status, command)
764
752
        # Re-run this periodically if run by gobject.timeout_add
765
753
        return True
766
754
    
772
760
        if getattr(self, "checker", None) is None:
773
761
            return
774
762
        logger.debug("Stopping checker for %(name)s", vars(self))
775
 
        self.checker.terminate()
 
763
        try:
 
764
            self.checker.terminate()
 
765
            #time.sleep(0.5)
 
766
            #if self.checker.poll() is None:
 
767
            #    self.checker.kill()
 
768
        except OSError as error:
 
769
            if error.errno != errno.ESRCH: # No such process
 
770
                raise
776
771
        self.checker = None
777
772
 
778
773
 
779
 
def dbus_service_property(dbus_interface,
780
 
                          signature="v",
781
 
                          access="readwrite",
782
 
                          byte_arrays=False):
 
774
def dbus_service_property(dbus_interface, signature="v",
 
775
                          access="readwrite", byte_arrays=False):
783
776
    """Decorators for marking methods of a DBusObjectWithProperties to
784
777
    become properties on the D-Bus.
785
778
    
794
787
    # "Set" method, so we fail early here:
795
788
    if byte_arrays and signature != "ay":
796
789
        raise ValueError("Byte arrays not supported for non-'ay'"
797
 
                         " signature {!r}".format(signature))
798
 
    
 
790
                         " signature {0!r}".format(signature))
799
791
    def decorator(func):
800
792
        func._dbus_is_property = True
801
793
        func._dbus_interface = dbus_interface
806
798
            func._dbus_name = func._dbus_name[:-14]
807
799
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
808
800
        return func
809
 
    
810
801
    return decorator
811
802
 
812
803
 
821
812
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
822
813
                    "false"}
823
814
    """
824
 
    
825
815
    def decorator(func):
826
816
        func._dbus_is_interface = True
827
817
        func._dbus_interface = dbus_interface
828
818
        func._dbus_name = dbus_interface
829
819
        return func
830
 
    
831
820
    return decorator
832
821
 
833
822
 
835
824
    """Decorator to annotate D-Bus methods, signals or properties
836
825
    Usage:
837
826
    
838
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
839
 
                       "org.freedesktop.DBus.Property."
840
 
                       "EmitsChangedSignal": "false"})
841
827
    @dbus_service_property("org.example.Interface", signature="b",
842
828
                           access="r")
 
829
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
830
                        "org.freedesktop.DBus.Property."
 
831
                        "EmitsChangedSignal": "false"})
843
832
    def Property_dbus_property(self):
844
833
        return dbus.Boolean(False)
845
 
    
846
 
    See also the DBusObjectWithAnnotations class.
847
834
    """
848
 
    
849
835
    def decorator(func):
850
836
        func._dbus_annotations = annotations
851
837
        return func
852
 
    
853
838
    return decorator
854
839
 
855
840
 
856
841
class DBusPropertyException(dbus.exceptions.DBusException):
857
842
    """A base class for D-Bus property-related exceptions
858
843
    """
859
 
    pass
 
844
    def __unicode__(self):
 
845
        return unicode(str(self))
860
846
 
861
847
 
862
848
class DBusPropertyAccessException(DBusPropertyException):
871
857
    pass
872
858
 
873
859
 
874
 
class DBusObjectWithAnnotations(dbus.service.Object):
875
 
    """A D-Bus object with annotations.
 
860
class DBusObjectWithProperties(dbus.service.Object):
 
861
    """A D-Bus object with properties.
876
862
    
877
 
    Classes inheriting from this can use the dbus_annotations
878
 
    decorator to add annotations to methods or signals.
 
863
    Classes inheriting from this can use the dbus_service_property
 
864
    decorator to expose methods as D-Bus properties.  It exposes the
 
865
    standard Get(), Set(), and GetAll() methods on the D-Bus.
879
866
    """
880
867
    
881
868
    @staticmethod
885
872
        If called like _is_dbus_thing("method") it returns a function
886
873
        suitable for use as predicate to inspect.getmembers().
887
874
        """
888
 
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
875
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
889
876
                                   False)
890
877
    
891
878
    def _get_all_dbus_things(self, thing):
892
879
        """Returns a generator of (name, attribute) pairs
893
880
        """
894
 
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
881
        return ((getattr(athing.__get__(self), "_dbus_name",
 
882
                         name),
895
883
                 athing.__get__(self))
896
884
                for cls in self.__class__.__mro__
897
885
                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
 
    """
 
886
                inspect.getmembers(cls,
 
887
                                   self._is_dbus_thing(thing)))
970
888
    
971
889
    def _get_dbus_property(self, interface_name, property_name):
972
890
        """Returns a bound method if one exists which is a D-Bus
973
891
        property with the specified name and interface.
974
892
        """
975
 
        for cls in self.__class__.__mro__:
976
 
            for name, value in inspect.getmembers(
977
 
                    cls, self._is_dbus_thing("property")):
 
893
        for cls in  self.__class__.__mro__:
 
894
            for name, value in (inspect.getmembers
 
895
                                (cls,
 
896
                                 self._is_dbus_thing("property"))):
978
897
                if (value._dbus_name == property_name
979
898
                    and value._dbus_interface == interface_name):
980
899
                    return value.__get__(self)
981
900
        
982
901
        # 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",
 
902
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
903
                                   + interface_name + "."
 
904
                                   + property_name)
 
905
    
 
906
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
997
907
                         out_signature="v")
998
908
    def Get(self, interface_name, property_name):
999
909
        """Standard D-Bus property Get() method, see D-Bus standard.
1017
927
            # The byte_arrays option is not supported yet on
1018
928
            # signatures other than "ay".
1019
929
            if prop._dbus_signature != "ay":
1020
 
                raise ValueError("Byte arrays not supported for non-"
1021
 
                                 "'ay' signature {!r}"
1022
 
                                 .format(prop._dbus_signature))
 
930
                raise ValueError
1023
931
            value = dbus.ByteArray(b''.join(chr(byte)
1024
932
                                            for byte in value))
1025
933
        prop(value)
1026
934
    
1027
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1028
 
                         in_signature="s",
 
935
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1029
936
                         out_signature="a{sv}")
1030
937
    def GetAll(self, interface_name):
1031
938
        """Standard D-Bus property GetAll() method, see D-Bus
1046
953
            if not hasattr(value, "variant_level"):
1047
954
                properties[name] = value
1048
955
                continue
1049
 
            properties[name] = type(value)(
1050
 
                value, variant_level = value.variant_level + 1)
 
956
            properties[name] = type(value)(value, variant_level=
 
957
                                           value.variant_level+1)
1051
958
        return dbus.Dictionary(properties, signature="sv")
1052
959
    
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
960
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1062
961
                         out_signature="s",
1063
962
                         path_keyword='object_path',
1067
966
        
1068
967
        Inserts property tags and interface annotation tags.
1069
968
        """
1070
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1071
 
                                                         object_path,
1072
 
                                                         connection)
 
969
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
970
                                                   connection)
1073
971
        try:
1074
972
            document = xml.dom.minidom.parseString(xmlstring)
1075
 
            
1076
973
            def make_tag(document, name, prop):
1077
974
                e = document.createElement("property")
1078
975
                e.setAttribute("name", name)
1079
976
                e.setAttribute("type", prop._dbus_signature)
1080
977
                e.setAttribute("access", prop._dbus_access)
1081
978
                return e
1082
 
            
1083
979
            for if_tag in document.getElementsByTagName("interface"):
1084
980
                # Add property tags
1085
981
                for tag in (make_tag(document, name, prop)
1088
984
                            if prop._dbus_interface
1089
985
                            == if_tag.getAttribute("name")):
1090
986
                    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)
 
987
                # Add annotation tags
 
988
                for typ in ("method", "signal", "property"):
 
989
                    for tag in if_tag.getElementsByTagName(typ):
 
990
                        annots = dict()
 
991
                        for name, prop in (self.
 
992
                                           _get_all_dbus_things(typ)):
 
993
                            if (name == tag.getAttribute("name")
 
994
                                and prop._dbus_interface
 
995
                                == if_tag.getAttribute("name")):
 
996
                                annots.update(getattr
 
997
                                              (prop,
 
998
                                               "_dbus_annotations",
 
999
                                               {}))
 
1000
                        for name, value in annots.iteritems():
 
1001
                            ann_tag = document.createElement(
 
1002
                                "annotation")
 
1003
                            ann_tag.setAttribute("name", name)
 
1004
                            ann_tag.setAttribute("value", value)
 
1005
                            tag.appendChild(ann_tag)
 
1006
                # Add interface annotation tags
 
1007
                for annotation, value in dict(
 
1008
                    itertools.chain.from_iterable(
 
1009
                        annotations().iteritems()
 
1010
                        for name, annotations in
 
1011
                        self._get_all_dbus_things("interface")
 
1012
                        if name == if_tag.getAttribute("name")
 
1013
                        )).iteritems():
 
1014
                    ann_tag = document.createElement("annotation")
 
1015
                    ann_tag.setAttribute("name", annotation)
 
1016
                    ann_tag.setAttribute("value", value)
 
1017
                    if_tag.appendChild(ann_tag)
1107
1018
                # Add the names to the return values for the
1108
1019
                # "org.freedesktop.DBus.Properties" methods
1109
1020
                if (if_tag.getAttribute("name")
1127
1038
                         exc_info=error)
1128
1039
        return xmlstring
1129
1040
 
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
1041
 
1199
1042
def datetime_to_dbus(dt, variant_level=0):
1200
1043
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1201
1044
    if dt is None:
1202
1045
        return dbus.String("", variant_level = variant_level)
1203
 
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
1046
    return dbus.String(dt.isoformat(),
 
1047
                       variant_level=variant_level)
1204
1048
 
1205
1049
 
1206
1050
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1226
1070
    (from DBusObjectWithProperties) and interfaces (from the
1227
1071
    dbus_interface_annotations decorator).
1228
1072
    """
1229
 
    
1230
1073
    def wrapper(cls):
1231
1074
        for orig_interface_name, alt_interface_name in (
1232
 
                alt_interface_names.items()):
 
1075
            alt_interface_names.iteritems()):
1233
1076
            attr = {}
1234
1077
            interface_names = set()
1235
1078
            # Go though all attributes of the class
1237
1080
                # Ignore non-D-Bus attributes, and D-Bus attributes
1238
1081
                # with the wrong interface name
1239
1082
                if (not hasattr(attribute, "_dbus_interface")
1240
 
                    or not attribute._dbus_interface.startswith(
1241
 
                        orig_interface_name)):
 
1083
                    or not attribute._dbus_interface
 
1084
                    .startswith(orig_interface_name)):
1242
1085
                    continue
1243
1086
                # Create an alternate D-Bus interface name based on
1244
1087
                # the current name
1245
 
                alt_interface = attribute._dbus_interface.replace(
1246
 
                    orig_interface_name, alt_interface_name)
 
1088
                alt_interface = (attribute._dbus_interface
 
1089
                                 .replace(orig_interface_name,
 
1090
                                          alt_interface_name))
1247
1091
                interface_names.add(alt_interface)
1248
1092
                # Is this a D-Bus signal?
1249
1093
                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(
 
1094
                    # Extract the original non-method undecorated
 
1095
                    # function by black magic
 
1096
                    nonmethod_func = (dict(
1254
1097
                            zip(attribute.func_code.co_freevars,
1255
 
                                attribute.__closure__))
1256
 
                                          ["func"].cell_contents)
1257
 
                    else:
1258
 
                        nonmethod_func = attribute
 
1098
                                attribute.__closure__))["func"]
 
1099
                                      .cell_contents)
1259
1100
                    # Create a new, but exactly alike, function
1260
1101
                    # object, and decorate it to be a new D-Bus signal
1261
1102
                    # 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))
 
1103
                    new_function = (dbus.service.signal
 
1104
                                    (alt_interface,
 
1105
                                     attribute._dbus_signature)
 
1106
                                    (types.FunctionType(
 
1107
                                nonmethod_func.func_code,
 
1108
                                nonmethod_func.func_globals,
 
1109
                                nonmethod_func.func_name,
 
1110
                                nonmethod_func.func_defaults,
 
1111
                                nonmethod_func.func_closure)))
1279
1112
                    # Copy annotations, if any
1280
1113
                    try:
1281
 
                        new_function._dbus_annotations = dict(
1282
 
                            attribute._dbus_annotations)
 
1114
                        new_function._dbus_annotations = (
 
1115
                            dict(attribute._dbus_annotations))
1283
1116
                    except AttributeError:
1284
1117
                        pass
1285
1118
                    # Define a creator of a function to call both the
1290
1123
                        """This function is a scope container to pass
1291
1124
                        func1 and func2 to the "call_both" function
1292
1125
                        outside of its arguments"""
1293
 
                        
1294
 
                        @functools.wraps(func2)
1295
1126
                        def call_both(*args, **kwargs):
1296
1127
                            """This function will emit two D-Bus
1297
1128
                            signals by calling func1 and func2"""
1298
1129
                            func1(*args, **kwargs)
1299
1130
                            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
1131
                        return call_both
1306
1132
                    # Create the "call_both" function and add it to
1307
1133
                    # the class
1312
1138
                    # object.  Decorate it to be a new D-Bus method
1313
1139
                    # with the alternate D-Bus interface name.  Add it
1314
1140
                    # 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)))
 
1141
                    attr[attrname] = (dbus.service.method
 
1142
                                      (alt_interface,
 
1143
                                       attribute._dbus_in_signature,
 
1144
                                       attribute._dbus_out_signature)
 
1145
                                      (types.FunctionType
 
1146
                                       (attribute.func_code,
 
1147
                                        attribute.func_globals,
 
1148
                                        attribute.func_name,
 
1149
                                        attribute.func_defaults,
 
1150
                                        attribute.func_closure)))
1325
1151
                    # Copy annotations, if any
1326
1152
                    try:
1327
 
                        attr[attrname]._dbus_annotations = dict(
1328
 
                            attribute._dbus_annotations)
 
1153
                        attr[attrname]._dbus_annotations = (
 
1154
                            dict(attribute._dbus_annotations))
1329
1155
                    except AttributeError:
1330
1156
                        pass
1331
1157
                # Is this a D-Bus property?
1334
1160
                    # object, and decorate it to be a new D-Bus
1335
1161
                    # property with the alternate D-Bus interface
1336
1162
                    # 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)))
 
1163
                    attr[attrname] = (dbus_service_property
 
1164
                                      (alt_interface,
 
1165
                                       attribute._dbus_signature,
 
1166
                                       attribute._dbus_access,
 
1167
                                       attribute
 
1168
                                       ._dbus_get_args_options
 
1169
                                       ["byte_arrays"])
 
1170
                                      (types.FunctionType
 
1171
                                       (attribute.func_code,
 
1172
                                        attribute.func_globals,
 
1173
                                        attribute.func_name,
 
1174
                                        attribute.func_defaults,
 
1175
                                        attribute.func_closure)))
1348
1176
                    # Copy annotations, if any
1349
1177
                    try:
1350
 
                        attr[attrname]._dbus_annotations = dict(
1351
 
                            attribute._dbus_annotations)
 
1178
                        attr[attrname]._dbus_annotations = (
 
1179
                            dict(attribute._dbus_annotations))
1352
1180
                    except AttributeError:
1353
1181
                        pass
1354
1182
                # Is this a D-Bus interface?
1357
1185
                    # object.  Decorate it to be a new D-Bus interface
1358
1186
                    # with the alternate D-Bus interface name.  Add it
1359
1187
                    # 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)))
 
1188
                    attr[attrname] = (dbus_interface_annotations
 
1189
                                      (alt_interface)
 
1190
                                      (types.FunctionType
 
1191
                                       (attribute.func_code,
 
1192
                                        attribute.func_globals,
 
1193
                                        attribute.func_name,
 
1194
                                        attribute.func_defaults,
 
1195
                                        attribute.func_closure)))
1367
1196
            if deprecate:
1368
1197
                # Deprecate all alternate interfaces
1369
 
                iname="_AlternateDBusNames_interface_annotation{}"
 
1198
                iname="_AlternateDBusNames_interface_annotation{0}"
1370
1199
                for interface_name in interface_names:
1371
 
                    
1372
1200
                    @dbus_interface_annotations(interface_name)
1373
1201
                    def func(self):
1374
1202
                        return { "org.freedesktop.DBus.Deprecated":
1375
 
                                 "true" }
 
1203
                                     "true" }
1376
1204
                    # Find an unused name
1377
1205
                    for aname in (iname.format(i)
1378
1206
                                  for i in itertools.count()):
1382
1210
            if interface_names:
1383
1211
                # Replace the class with a new subclass of it with
1384
1212
                # methods, signals, etc. as created above.
1385
 
                cls = type(b"{}Alternate".format(cls.__name__),
1386
 
                           (cls, ), attr)
 
1213
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1214
                           (cls,), attr)
1387
1215
        return cls
1388
 
    
1389
1216
    return wrapper
1390
1217
 
1391
1218
 
1392
1219
@alternate_dbus_interfaces({"se.recompile.Mandos":
1393
 
                            "se.bsnet.fukt.Mandos"})
 
1220
                                "se.bsnet.fukt.Mandos"})
1394
1221
class ClientDBus(Client, DBusObjectWithProperties):
1395
1222
    """A Client class using D-Bus
1396
1223
    
1400
1227
    """
1401
1228
    
1402
1229
    runtime_expansions = (Client.runtime_expansions
1403
 
                          + ("dbus_object_path", ))
1404
 
    
1405
 
    _interface = "se.recompile.Mandos.Client"
 
1230
                          + ("dbus_object_path",))
1406
1231
    
1407
1232
    # dbus.service.Object doesn't use super(), so we can't either.
1408
1233
    
1411
1236
        Client.__init__(self, *args, **kwargs)
1412
1237
        # Only now, when this client is initialized, can it show up on
1413
1238
        # the D-Bus
1414
 
        client_object_name = str(self.name).translate(
 
1239
        client_object_name = unicode(self.name).translate(
1415
1240
            {ord("."): ord("_"),
1416
1241
             ord("-"): ord("_")})
1417
 
        self.dbus_object_path = dbus.ObjectPath(
1418
 
            "/clients/" + client_object_name)
 
1242
        self.dbus_object_path = (dbus.ObjectPath
 
1243
                                 ("/clients/" + client_object_name))
1419
1244
        DBusObjectWithProperties.__init__(self, self.bus,
1420
1245
                                          self.dbus_object_path)
1421
1246
    
1422
 
    def notifychangeproperty(transform_func, dbus_name,
1423
 
                             type_func=lambda x: x,
1424
 
                             variant_level=1,
1425
 
                             invalidate_only=False,
1426
 
                             _interface=_interface):
 
1247
    def notifychangeproperty(transform_func,
 
1248
                             dbus_name, type_func=lambda x: x,
 
1249
                             variant_level=1):
1427
1250
        """ Modify a variable so that it's a property which announces
1428
1251
        its changes to DBus.
1429
1252
        
1434
1257
                   to the D-Bus.  Default: no transform
1435
1258
        variant_level: D-Bus variant level.  Default: 1
1436
1259
        """
1437
 
        attrname = "_{}".format(dbus_name)
1438
 
        
 
1260
        attrname = "_{0}".format(dbus_name)
1439
1261
        def setter(self, value):
1440
1262
            if hasattr(self, "dbus_object_path"):
1441
1263
                if (not hasattr(self, attrname) or
1442
1264
                    type_func(getattr(self, attrname, None))
1443
1265
                    != 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())
 
1266
                    dbus_value = transform_func(type_func(value),
 
1267
                                                variant_level
 
1268
                                                =variant_level)
 
1269
                    self.PropertyChanged(dbus.String(dbus_name),
 
1270
                                         dbus_value)
1459
1271
            setattr(self, attrname, value)
1460
1272
        
1461
1273
        return property(lambda self: getattr(self, attrname), setter)
1467
1279
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1468
1280
    last_enabled = notifychangeproperty(datetime_to_dbus,
1469
1281
                                        "LastEnabled")
1470
 
    checker = notifychangeproperty(
1471
 
        dbus.Boolean, "CheckerRunning",
1472
 
        type_func = lambda checker: checker is not None)
 
1282
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1283
                                   type_func = lambda checker:
 
1284
                                       checker is not None)
1473
1285
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1474
1286
                                           "LastCheckedOK")
1475
1287
    last_checker_status = notifychangeproperty(dbus.Int16,
1478
1290
        datetime_to_dbus, "LastApprovalRequest")
1479
1291
    approved_by_default = notifychangeproperty(dbus.Boolean,
1480
1292
                                               "ApprovedByDefault")
1481
 
    approval_delay = notifychangeproperty(
1482
 
        dbus.UInt64, "ApprovalDelay",
1483
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1293
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1294
                                          "ApprovalDelay",
 
1295
                                          type_func =
 
1296
                                          timedelta_to_milliseconds)
1484
1297
    approval_duration = notifychangeproperty(
1485
1298
        dbus.UInt64, "ApprovalDuration",
1486
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1299
        type_func = timedelta_to_milliseconds)
1487
1300
    host = notifychangeproperty(dbus.String, "Host")
1488
 
    timeout = notifychangeproperty(
1489
 
        dbus.UInt64, "Timeout",
1490
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1301
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1302
                                   type_func =
 
1303
                                   timedelta_to_milliseconds)
1491
1304
    extended_timeout = notifychangeproperty(
1492
1305
        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)
 
1306
        type_func = timedelta_to_milliseconds)
 
1307
    interval = notifychangeproperty(dbus.UInt64,
 
1308
                                    "Interval",
 
1309
                                    type_func =
 
1310
                                    timedelta_to_milliseconds)
1497
1311
    checker_command = notifychangeproperty(dbus.String, "Checker")
1498
 
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1499
 
                                  invalidate_only=True)
1500
1312
    
1501
1313
    del notifychangeproperty
1502
1314
    
1509
1321
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1510
1322
        Client.__del__(self, *args, **kwargs)
1511
1323
    
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:
 
1324
    def checker_callback(self, pid, condition, command,
 
1325
                         *args, **kwargs):
 
1326
        self.checker_callback_tag = None
 
1327
        self.checker = None
 
1328
        if os.WIFEXITED(condition):
 
1329
            exitstatus = os.WEXITSTATUS(condition)
1519
1330
            # Emit D-Bus signal
1520
1331
            self.CheckerCompleted(dbus.Int16(exitstatus),
1521
 
                                  # This is specific to GNU libC
1522
 
                                  dbus.Int64(exitstatus << 8),
 
1332
                                  dbus.Int64(condition),
1523
1333
                                  dbus.String(command))
1524
1334
        else:
1525
1335
            # Emit D-Bus signal
1526
1336
            self.CheckerCompleted(dbus.Int16(-1),
1527
 
                                  dbus.Int64(
1528
 
                                      # This is specific to GNU libC
1529
 
                                      (exitstatus << 8)
1530
 
                                      | self.last_checker_signal),
 
1337
                                  dbus.Int64(condition),
1531
1338
                                  dbus.String(command))
1532
 
        return ret
 
1339
        
 
1340
        return Client.checker_callback(self, pid, condition, command,
 
1341
                                       *args, **kwargs)
1533
1342
    
1534
1343
    def start_checker(self, *args, **kwargs):
1535
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
1344
        old_checker = self.checker
 
1345
        if self.checker is not None:
 
1346
            old_checker_pid = self.checker.pid
 
1347
        else:
 
1348
            old_checker_pid = None
1536
1349
        r = Client.start_checker(self, *args, **kwargs)
1537
1350
        # Only if new checker process was started
1538
1351
        if (self.checker is not None
1547
1360
    
1548
1361
    def approve(self, value=True):
1549
1362
        self.approved = value
1550
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1551
 
                                * 1000), self._reset_approved)
 
1363
        gobject.timeout_add(timedelta_to_milliseconds
 
1364
                            (self.approval_duration),
 
1365
                            self._reset_approved)
1552
1366
        self.send_changedstate()
1553
1367
    
1554
1368
    ## D-Bus methods, signals & properties
 
1369
    _interface = "se.recompile.Mandos.Client"
1555
1370
    
1556
1371
    ## Interfaces
1557
1372
    
 
1373
    @dbus_interface_annotations(_interface)
 
1374
    def _foo(self):
 
1375
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1376
                     "false"}
 
1377
    
1558
1378
    ## Signals
1559
1379
    
1560
1380
    # CheckerCompleted - signal
1570
1390
        pass
1571
1391
    
1572
1392
    # PropertyChanged - signal
1573
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1574
1393
    @dbus.service.signal(_interface, signature="sv")
1575
1394
    def PropertyChanged(self, property, value):
1576
1395
        "D-Bus signal"
1610
1429
        self.checked_ok()
1611
1430
    
1612
1431
    # Enable - method
1613
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1614
1432
    @dbus.service.method(_interface)
1615
1433
    def Enable(self):
1616
1434
        "D-Bus method"
1617
1435
        self.enable()
1618
1436
    
1619
1437
    # StartChecker - method
1620
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1621
1438
    @dbus.service.method(_interface)
1622
1439
    def StartChecker(self):
1623
1440
        "D-Bus method"
1624
1441
        self.start_checker()
1625
1442
    
1626
1443
    # Disable - method
1627
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1628
1444
    @dbus.service.method(_interface)
1629
1445
    def Disable(self):
1630
1446
        "D-Bus method"
1631
1447
        self.disable()
1632
1448
    
1633
1449
    # StopChecker - method
1634
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1635
1450
    @dbus.service.method(_interface)
1636
1451
    def StopChecker(self):
1637
1452
        self.stop_checker()
1644
1459
        return dbus.Boolean(bool(self.approvals_pending))
1645
1460
    
1646
1461
    # ApprovedByDefault - property
1647
 
    @dbus_service_property(_interface,
1648
 
                           signature="b",
 
1462
    @dbus_service_property(_interface, signature="b",
1649
1463
                           access="readwrite")
1650
1464
    def ApprovedByDefault_dbus_property(self, value=None):
1651
1465
        if value is None:       # get
1653
1467
        self.approved_by_default = bool(value)
1654
1468
    
1655
1469
    # ApprovalDelay - property
1656
 
    @dbus_service_property(_interface,
1657
 
                           signature="t",
 
1470
    @dbus_service_property(_interface, signature="t",
1658
1471
                           access="readwrite")
1659
1472
    def ApprovalDelay_dbus_property(self, value=None):
1660
1473
        if value is None:       # get
1661
 
            return dbus.UInt64(self.approval_delay.total_seconds()
1662
 
                               * 1000)
 
1474
            return dbus.UInt64(self.approval_delay_milliseconds())
1663
1475
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1664
1476
    
1665
1477
    # ApprovalDuration - property
1666
 
    @dbus_service_property(_interface,
1667
 
                           signature="t",
 
1478
    @dbus_service_property(_interface, signature="t",
1668
1479
                           access="readwrite")
1669
1480
    def ApprovalDuration_dbus_property(self, value=None):
1670
1481
        if value is None:       # get
1671
 
            return dbus.UInt64(self.approval_duration.total_seconds()
1672
 
                               * 1000)
 
1482
            return dbus.UInt64(timedelta_to_milliseconds(
 
1483
                    self.approval_duration))
1673
1484
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1674
1485
    
1675
1486
    # Name - property
1676
 
    @dbus_annotations(
1677
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1678
1487
    @dbus_service_property(_interface, signature="s", access="read")
1679
1488
    def Name_dbus_property(self):
1680
1489
        return dbus.String(self.name)
1681
1490
    
1682
1491
    # Fingerprint - property
1683
 
    @dbus_annotations(
1684
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1685
1492
    @dbus_service_property(_interface, signature="s", access="read")
1686
1493
    def Fingerprint_dbus_property(self):
1687
1494
        return dbus.String(self.fingerprint)
1688
1495
    
1689
1496
    # Host - property
1690
 
    @dbus_service_property(_interface,
1691
 
                           signature="s",
 
1497
    @dbus_service_property(_interface, signature="s",
1692
1498
                           access="readwrite")
1693
1499
    def Host_dbus_property(self, value=None):
1694
1500
        if value is None:       # get
1695
1501
            return dbus.String(self.host)
1696
 
        self.host = str(value)
 
1502
        self.host = unicode(value)
1697
1503
    
1698
1504
    # Created - property
1699
 
    @dbus_annotations(
1700
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1701
1505
    @dbus_service_property(_interface, signature="s", access="read")
1702
1506
    def Created_dbus_property(self):
1703
1507
        return datetime_to_dbus(self.created)
1708
1512
        return datetime_to_dbus(self.last_enabled)
1709
1513
    
1710
1514
    # Enabled - property
1711
 
    @dbus_service_property(_interface,
1712
 
                           signature="b",
 
1515
    @dbus_service_property(_interface, signature="b",
1713
1516
                           access="readwrite")
1714
1517
    def Enabled_dbus_property(self, value=None):
1715
1518
        if value is None:       # get
1720
1523
            self.disable()
1721
1524
    
1722
1525
    # LastCheckedOK - property
1723
 
    @dbus_service_property(_interface,
1724
 
                           signature="s",
 
1526
    @dbus_service_property(_interface, signature="s",
1725
1527
                           access="readwrite")
1726
1528
    def LastCheckedOK_dbus_property(self, value=None):
1727
1529
        if value is not None:
1730
1532
        return datetime_to_dbus(self.last_checked_ok)
1731
1533
    
1732
1534
    # LastCheckerStatus - property
1733
 
    @dbus_service_property(_interface, signature="n", access="read")
 
1535
    @dbus_service_property(_interface, signature="n",
 
1536
                           access="read")
1734
1537
    def LastCheckerStatus_dbus_property(self):
1735
1538
        return dbus.Int16(self.last_checker_status)
1736
1539
    
1745
1548
        return datetime_to_dbus(self.last_approval_request)
1746
1549
    
1747
1550
    # Timeout - property
1748
 
    @dbus_service_property(_interface,
1749
 
                           signature="t",
 
1551
    @dbus_service_property(_interface, signature="t",
1750
1552
                           access="readwrite")
1751
1553
    def Timeout_dbus_property(self, value=None):
1752
1554
        if value is None:       # get
1753
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1555
            return dbus.UInt64(self.timeout_milliseconds())
1754
1556
        old_timeout = self.timeout
1755
1557
        self.timeout = datetime.timedelta(0, 0, 0, value)
1756
1558
        # Reschedule disabling
1765
1567
                    is None):
1766
1568
                    return
1767
1569
                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)
 
1570
                self.disable_initiator_tag = (
 
1571
                    gobject.timeout_add(
 
1572
                        timedelta_to_milliseconds(self.expires - now),
 
1573
                        self.disable))
1771
1574
    
1772
1575
    # ExtendedTimeout - property
1773
 
    @dbus_service_property(_interface,
1774
 
                           signature="t",
 
1576
    @dbus_service_property(_interface, signature="t",
1775
1577
                           access="readwrite")
1776
1578
    def ExtendedTimeout_dbus_property(self, value=None):
1777
1579
        if value is None:       # get
1778
 
            return dbus.UInt64(self.extended_timeout.total_seconds()
1779
 
                               * 1000)
 
1580
            return dbus.UInt64(self.extended_timeout_milliseconds())
1780
1581
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1781
1582
    
1782
1583
    # Interval - property
1783
 
    @dbus_service_property(_interface,
1784
 
                           signature="t",
 
1584
    @dbus_service_property(_interface, signature="t",
1785
1585
                           access="readwrite")
1786
1586
    def Interval_dbus_property(self, value=None):
1787
1587
        if value is None:       # get
1788
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1588
            return dbus.UInt64(self.interval_milliseconds())
1789
1589
        self.interval = datetime.timedelta(0, 0, 0, value)
1790
1590
        if getattr(self, "checker_initiator_tag", None) is None:
1791
1591
            return
1792
1592
        if self.enabled:
1793
1593
            # Reschedule checker run
1794
1594
            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
 
1595
            self.checker_initiator_tag = (gobject.timeout_add
 
1596
                                          (value, self.start_checker))
 
1597
            self.start_checker()    # Start one now, too
1798
1598
    
1799
1599
    # Checker - property
1800
 
    @dbus_service_property(_interface,
1801
 
                           signature="s",
 
1600
    @dbus_service_property(_interface, signature="s",
1802
1601
                           access="readwrite")
1803
1602
    def Checker_dbus_property(self, value=None):
1804
1603
        if value is None:       # get
1805
1604
            return dbus.String(self.checker_command)
1806
 
        self.checker_command = str(value)
 
1605
        self.checker_command = unicode(value)
1807
1606
    
1808
1607
    # CheckerRunning - property
1809
 
    @dbus_service_property(_interface,
1810
 
                           signature="b",
 
1608
    @dbus_service_property(_interface, signature="b",
1811
1609
                           access="readwrite")
1812
1610
    def CheckerRunning_dbus_property(self, value=None):
1813
1611
        if value is None:       # get
1818
1616
            self.stop_checker()
1819
1617
    
1820
1618
    # ObjectPath - property
1821
 
    @dbus_annotations(
1822
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
1823
 
         "org.freedesktop.DBus.Deprecated": "true"})
1824
1619
    @dbus_service_property(_interface, signature="o", access="read")
1825
1620
    def ObjectPath_dbus_property(self):
1826
1621
        return self.dbus_object_path # is already a dbus.ObjectPath
1827
1622
    
1828
1623
    # 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)
 
1624
    @dbus_service_property(_interface, signature="ay",
 
1625
                           access="write", byte_arrays=True)
1836
1626
    def Secret_dbus_property(self, value):
1837
 
        self.secret = bytes(value)
 
1627
        self.secret = str(value)
1838
1628
    
1839
1629
    del _interface
1840
1630
 
1844
1634
        self._pipe = child_pipe
1845
1635
        self._pipe.send(('init', fpr, address))
1846
1636
        if not self._pipe.recv():
1847
 
            raise KeyError(fpr)
 
1637
            raise KeyError()
1848
1638
    
1849
1639
    def __getattribute__(self, name):
1850
1640
        if name == '_pipe':
1854
1644
        if data[0] == 'data':
1855
1645
            return data[1]
1856
1646
        if data[0] == 'function':
1857
 
            
1858
1647
            def func(*args, **kwargs):
1859
1648
                self._pipe.send(('funcall', name, args, kwargs))
1860
1649
                return self._pipe.recv()[1]
1861
 
            
1862
1650
            return func
1863
1651
    
1864
1652
    def __setattr__(self, name, value):
1876
1664
    def handle(self):
1877
1665
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1878
1666
            logger.info("TCP connection from: %s",
1879
 
                        str(self.client_address))
 
1667
                        unicode(self.client_address))
1880
1668
            logger.debug("Pipe FD: %d",
1881
1669
                         self.server.child_pipe.fileno())
1882
1670
            
1883
 
            session = gnutls.connection.ClientSession(
1884
 
                self.request, gnutls.connection .X509Credentials())
 
1671
            session = (gnutls.connection
 
1672
                       .ClientSession(self.request,
 
1673
                                      gnutls.connection
 
1674
                                      .X509Credentials()))
1885
1675
            
1886
1676
            # Note: gnutls.connection.X509Credentials is really a
1887
1677
            # generic GnuTLS certificate credentials object so long as
1896
1686
            priority = self.server.gnutls_priority
1897
1687
            if priority is None:
1898
1688
                priority = "NORMAL"
1899
 
            gnutls.library.functions.gnutls_priority_set_direct(
1900
 
                session._c_object, priority, None)
 
1689
            (gnutls.library.functions
 
1690
             .gnutls_priority_set_direct(session._c_object,
 
1691
                                         priority, None))
1901
1692
            
1902
1693
            # Start communication using the Mandos protocol
1903
1694
            # Get protocol number
1905
1696
            logger.debug("Protocol version: %r", line)
1906
1697
            try:
1907
1698
                if int(line.strip().split()[0]) > 1:
1908
 
                    raise RuntimeError(line)
 
1699
                    raise RuntimeError
1909
1700
            except (ValueError, IndexError, RuntimeError) as error:
1910
1701
                logger.error("Unknown protocol version: %s", error)
1911
1702
                return
1923
1714
            approval_required = False
1924
1715
            try:
1925
1716
                try:
1926
 
                    fpr = self.fingerprint(
1927
 
                        self.peer_certificate(session))
 
1717
                    fpr = self.fingerprint(self.peer_certificate
 
1718
                                           (session))
1928
1719
                except (TypeError,
1929
1720
                        gnutls.errors.GNUTLSError) as error:
1930
1721
                    logger.warning("Bad certificate: %s", error)
1945
1736
                while True:
1946
1737
                    if not client.enabled:
1947
1738
                        logger.info("Client %s is disabled",
1948
 
                                    client.name)
 
1739
                                       client.name)
1949
1740
                        if self.server.use_dbus:
1950
1741
                            # Emit D-Bus signal
1951
1742
                            client.Rejected("Disabled")
1960
1751
                        if self.server.use_dbus:
1961
1752
                            # Emit D-Bus signal
1962
1753
                            client.NeedApproval(
1963
 
                                client.approval_delay.total_seconds()
1964
 
                                * 1000, client.approved_by_default)
 
1754
                                client.approval_delay_milliseconds(),
 
1755
                                client.approved_by_default)
1965
1756
                    else:
1966
1757
                        logger.warning("Client %s was not approved",
1967
1758
                                       client.name)
1973
1764
                    #wait until timeout or approved
1974
1765
                    time = datetime.datetime.now()
1975
1766
                    client.changedstate.acquire()
1976
 
                    client.changedstate.wait(delay.total_seconds())
 
1767
                    client.changedstate.wait(
 
1768
                        float(timedelta_to_milliseconds(delay)
 
1769
                              / 1000))
1977
1770
                    client.changedstate.release()
1978
1771
                    time2 = datetime.datetime.now()
1979
1772
                    if (time2 - time) >= delay:
1998
1791
                        logger.warning("gnutls send failed",
1999
1792
                                       exc_info=error)
2000
1793
                        return
2001
 
                    logger.debug("Sent: %d, remaining: %d", sent,
2002
 
                                 len(client.secret) - (sent_size
2003
 
                                                       + sent))
 
1794
                    logger.debug("Sent: %d, remaining: %d",
 
1795
                                 sent, len(client.secret)
 
1796
                                 - (sent_size + sent))
2004
1797
                    sent_size += sent
2005
1798
                
2006
1799
                logger.info("Sending secret to %s", client.name)
2023
1816
    def peer_certificate(session):
2024
1817
        "Return the peer's OpenPGP certificate as a bytestring"
2025
1818
        # If not an OpenPGP certificate...
2026
 
        if (gnutls.library.functions.gnutls_certificate_type_get(
2027
 
                session._c_object)
 
1819
        if (gnutls.library.functions
 
1820
            .gnutls_certificate_type_get(session._c_object)
2028
1821
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
2029
1822
            # ...do the normal thing
2030
1823
            return session.peer_certificate
2044
1837
    def fingerprint(openpgp):
2045
1838
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2046
1839
        # 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)))
 
1840
        datum = (gnutls.library.types
 
1841
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1842
                                             ctypes.POINTER
 
1843
                                             (ctypes.c_ubyte)),
 
1844
                                 ctypes.c_uint(len(openpgp))))
2051
1845
        # New empty GnuTLS certificate
2052
1846
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
2053
 
        gnutls.library.functions.gnutls_openpgp_crt_init(
2054
 
            ctypes.byref(crt))
 
1847
        (gnutls.library.functions
 
1848
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
2055
1849
        # 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)
 
1850
        (gnutls.library.functions
 
1851
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1852
                                    gnutls.library.constants
 
1853
                                    .GNUTLS_OPENPGP_FMT_RAW))
2059
1854
        # Verify the self signature in the key
2060
1855
        crtverify = ctypes.c_uint()
2061
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
2062
 
            crt, 0, ctypes.byref(crtverify))
 
1856
        (gnutls.library.functions
 
1857
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1858
                                         ctypes.byref(crtverify)))
2063
1859
        if crtverify.value != 0:
2064
1860
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2065
 
            raise gnutls.errors.CertificateSecurityError(
2066
 
                "Verify failed")
 
1861
            raise (gnutls.errors.CertificateSecurityError
 
1862
                   ("Verify failed"))
2067
1863
        # New buffer for the fingerprint
2068
1864
        buf = ctypes.create_string_buffer(20)
2069
1865
        buf_len = ctypes.c_size_t()
2070
1866
        # 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))
 
1867
        (gnutls.library.functions
 
1868
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1869
                                             ctypes.byref(buf_len)))
2073
1870
        # Deinit the certificate
2074
1871
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2075
1872
        # Convert the buffer to a Python bytestring
2081
1878
 
2082
1879
class MultiprocessingMixIn(object):
2083
1880
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2084
 
    
2085
1881
    def sub_process_main(self, request, address):
2086
1882
        try:
2087
1883
            self.finish_request(request, address)
2099
1895
 
2100
1896
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2101
1897
    """ adds a pipe to the MixIn """
2102
 
    
2103
1898
    def process_request(self, request, client_address):
2104
1899
        """Overrides and wraps the original process_request().
2105
1900
        
2114
1909
    
2115
1910
    def add_pipe(self, parent_pipe, proc):
2116
1911
        """Dummy function; override as necessary"""
2117
 
        raise NotImplementedError()
 
1912
        raise NotImplementedError
2118
1913
 
2119
1914
 
2120
1915
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2126
1921
        interface:      None or a network interface name (string)
2127
1922
        use_ipv6:       Boolean; to use IPv6 or not
2128
1923
    """
2129
 
    
2130
1924
    def __init__(self, server_address, RequestHandlerClass,
2131
 
                 interface=None,
2132
 
                 use_ipv6=True,
2133
 
                 socketfd=None):
 
1925
                 interface=None, use_ipv6=True, socketfd=None):
2134
1926
        """If socketfd is set, use that file descriptor instead of
2135
1927
        creating a new one with socket.socket().
2136
1928
        """
2177
1969
                             self.interface)
2178
1970
            else:
2179
1971
                try:
2180
 
                    self.socket.setsockopt(
2181
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
2182
 
                        (self.interface + "\0").encode("utf-8"))
 
1972
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1973
                                           SO_BINDTODEVICE,
 
1974
                                           str(self.interface + '\0'))
2183
1975
                except socket.error as error:
2184
1976
                    if error.errno == errno.EPERM:
2185
1977
                        logger.error("No permission to bind to"
2203
1995
                self.server_address = (any_address,
2204
1996
                                       self.server_address[1])
2205
1997
            elif not self.server_address[1]:
2206
 
                self.server_address = (self.server_address[0], 0)
 
1998
                self.server_address = (self.server_address[0],
 
1999
                                       0)
2207
2000
#                 if self.interface:
2208
2001
#                     self.server_address = (self.server_address[0],
2209
2002
#                                            0, # port
2223
2016
    
2224
2017
    Assumes a gobject.MainLoop event loop.
2225
2018
    """
2226
 
    
2227
2019
    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):
 
2020
                 interface=None, use_ipv6=True, clients=None,
 
2021
                 gnutls_priority=None, use_dbus=True, socketfd=None):
2234
2022
        self.enabled = False
2235
2023
        self.clients = clients
2236
2024
        if self.clients is None:
2242
2030
                                interface = interface,
2243
2031
                                use_ipv6 = use_ipv6,
2244
2032
                                socketfd = socketfd)
2245
 
    
2246
2033
    def server_activate(self):
2247
2034
        if self.enabled:
2248
2035
            return socketserver.TCPServer.server_activate(self)
2252
2039
    
2253
2040
    def add_pipe(self, parent_pipe, proc):
2254
2041
        # 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))
 
2042
        gobject.io_add_watch(parent_pipe.fileno(),
 
2043
                             gobject.IO_IN | gobject.IO_HUP,
 
2044
                             functools.partial(self.handle_ipc,
 
2045
                                               parent_pipe =
 
2046
                                               parent_pipe,
 
2047
                                               proc = proc))
2261
2048
    
2262
 
    def handle_ipc(self, source, condition,
2263
 
                   parent_pipe=None,
2264
 
                   proc = None,
2265
 
                   client_object=None):
 
2049
    def handle_ipc(self, source, condition, parent_pipe=None,
 
2050
                   proc = None, client_object=None):
2266
2051
        # error, or the other end of multiprocessing.Pipe has closed
2267
2052
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2268
2053
            # Wait for other process to exit
2291
2076
                parent_pipe.send(False)
2292
2077
                return False
2293
2078
            
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))
 
2079
            gobject.io_add_watch(parent_pipe.fileno(),
 
2080
                                 gobject.IO_IN | gobject.IO_HUP,
 
2081
                                 functools.partial(self.handle_ipc,
 
2082
                                                   parent_pipe =
 
2083
                                                   parent_pipe,
 
2084
                                                   proc = proc,
 
2085
                                                   client_object =
 
2086
                                                   client))
2301
2087
            parent_pipe.send(True)
2302
2088
            # remove the old hook in favor of the new above hook on
2303
2089
            # same fileno
2309
2095
            
2310
2096
            parent_pipe.send(('data', getattr(client_object,
2311
2097
                                              funcname)(*args,
2312
 
                                                        **kwargs)))
 
2098
                                                         **kwargs)))
2313
2099
        
2314
2100
        if command == 'getattr':
2315
2101
            attrname = request[1]
2316
 
            if isinstance(client_object.__getattribute__(attrname),
2317
 
                          collections.Callable):
2318
 
                parent_pipe.send(('function', ))
 
2102
            if callable(client_object.__getattribute__(attrname)):
 
2103
                parent_pipe.send(('function',))
2319
2104
            else:
2320
 
                parent_pipe.send((
2321
 
                    'data', client_object.__getattribute__(attrname)))
 
2105
                parent_pipe.send(('data', client_object
 
2106
                                  .__getattribute__(attrname)))
2322
2107
        
2323
2108
        if command == 'setattr':
2324
2109
            attrname = request[1]
2355
2140
    # avoid excessive use of external libraries.
2356
2141
    
2357
2142
    # 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
 
2143
    Token = collections.namedtuple("Token",
 
2144
                                   ("regexp", # To match token; if
 
2145
                                              # "value" is not None,
 
2146
                                              # must have a "group"
 
2147
                                              # containing digits
 
2148
                                    "value",  # datetime.timedelta or
 
2149
                                              # None
 
2150
                                    "followers")) # Tokens valid after
 
2151
                                                  # this token
2363
2152
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2364
2153
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2365
2154
    token_end = Token(re.compile(r"$"), None, frozenset())
2366
2155
    token_second = Token(re.compile(r"(\d+)S"),
2367
2156
                         datetime.timedelta(seconds=1),
2368
 
                         frozenset((token_end, )))
 
2157
                         frozenset((token_end,)))
2369
2158
    token_minute = Token(re.compile(r"(\d+)M"),
2370
2159
                         datetime.timedelta(minutes=1),
2371
2160
                         frozenset((token_second, token_end)))
2387
2176
                       frozenset((token_month, token_end)))
2388
2177
    token_week = Token(re.compile(r"(\d+)W"),
2389
2178
                       datetime.timedelta(weeks=1),
2390
 
                       frozenset((token_end, )))
 
2179
                       frozenset((token_end,)))
2391
2180
    token_duration = Token(re.compile(r"P"), None,
2392
2181
                           frozenset((token_year, token_month,
2393
2182
                                      token_day, token_time,
2394
 
                                      token_week)))
 
2183
                                      token_week))),
2395
2184
    # Define starting values
2396
2185
    value = datetime.timedelta() # Value so far
2397
2186
    found_token = None
2398
 
    followers = frozenset((token_duration, )) # Following valid tokens
 
2187
    followers = frozenset(token_duration,) # Following valid tokens
2399
2188
    s = duration                # String left to parse
2400
2189
    # Loop until end token is found
2401
2190
    while found_token is not token_end:
2418
2207
                break
2419
2208
        else:
2420
2209
            # No currently valid tokens were found
2421
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
2422
 
                             .format(duration))
 
2210
            raise ValueError("Invalid RFC 3339 duration")
2423
2211
    # End token found
2424
2212
    return value
2425
2213
 
2449
2237
    timevalue = datetime.timedelta(0)
2450
2238
    for s in interval.split():
2451
2239
        try:
2452
 
            suffix = s[-1]
 
2240
            suffix = unicode(s[-1])
2453
2241
            value = int(s[:-1])
2454
2242
            if suffix == "d":
2455
2243
                delta = datetime.timedelta(value)
2462
2250
            elif suffix == "w":
2463
2251
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2464
2252
            else:
2465
 
                raise ValueError("Unknown suffix {!r}".format(suffix))
2466
 
        except IndexError as e:
 
2253
                raise ValueError("Unknown suffix {0!r}"
 
2254
                                 .format(suffix))
 
2255
        except (ValueError, IndexError) as e:
2467
2256
            raise ValueError(*(e.args))
2468
2257
        timevalue += delta
2469
2258
    return timevalue
2485
2274
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2486
2275
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2487
2276
            raise OSError(errno.ENODEV,
2488
 
                          "{} not a character device"
 
2277
                          "{0} not a character device"
2489
2278
                          .format(os.devnull))
2490
2279
        os.dup2(null, sys.stdin.fileno())
2491
2280
        os.dup2(null, sys.stdout.fileno())
2501
2290
    
2502
2291
    parser = argparse.ArgumentParser()
2503
2292
    parser.add_argument("-v", "--version", action="version",
2504
 
                        version = "%(prog)s {}".format(version),
 
2293
                        version = "%(prog)s {0}".format(version),
2505
2294
                        help="show version number and exit")
2506
2295
    parser.add_argument("-i", "--interface", metavar="IF",
2507
2296
                        help="Bind to interface IF")
2540
2329
                        help="Directory to save/restore state in")
2541
2330
    parser.add_argument("--foreground", action="store_true",
2542
2331
                        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
2332
    
2547
2333
    options = parser.parse_args()
2548
2334
    
2549
2335
    if options.check:
2550
2336
        import doctest
2551
 
        fail_count, test_count = doctest.testmod()
2552
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2337
        doctest.testmod()
 
2338
        sys.exit()
2553
2339
    
2554
2340
    # Default values for config file for server-global settings
2555
2341
    server_defaults = { "interface": "",
2557
2343
                        "port": "",
2558
2344
                        "debug": "False",
2559
2345
                        "priority":
2560
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2561
 
                        ":+SIGN-DSA-SHA256",
 
2346
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224",
2562
2347
                        "servicename": "Mandos",
2563
2348
                        "use_dbus": "True",
2564
2349
                        "use_ipv6": "True",
2567
2352
                        "socket": "",
2568
2353
                        "statedir": "/var/lib/mandos",
2569
2354
                        "foreground": "False",
2570
 
                        "zeroconf": "True",
2571
 
                    }
 
2355
                        }
2572
2356
    
2573
2357
    # Parse config file for server-global settings
2574
2358
    server_config = configparser.SafeConfigParser(server_defaults)
2575
2359
    del server_defaults
2576
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
2360
    server_config.read(os.path.join(options.configdir,
 
2361
                                    "mandos.conf"))
2577
2362
    # Convert the SafeConfigParser object to a dict
2578
2363
    server_settings = server_config.defaults()
2579
2364
    # Use the appropriate methods on the non-string config options
2597
2382
    # Override the settings from the config file with command line
2598
2383
    # options, if set.
2599
2384
    for option in ("interface", "address", "port", "debug",
2600
 
                   "priority", "servicename", "configdir", "use_dbus",
2601
 
                   "use_ipv6", "debuglevel", "restore", "statedir",
2602
 
                   "socket", "foreground", "zeroconf"):
 
2385
                   "priority", "servicename", "configdir",
 
2386
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2387
                   "statedir", "socket", "foreground"):
2603
2388
        value = getattr(options, option)
2604
2389
        if value is not None:
2605
2390
            server_settings[option] = value
2606
2391
    del options
2607
2392
    # Force all strings to be unicode
2608
2393
    for option in server_settings.keys():
2609
 
        if isinstance(server_settings[option], bytes):
2610
 
            server_settings[option] = (server_settings[option]
2611
 
                                       .decode("utf-8"))
 
2394
        if type(server_settings[option]) is str:
 
2395
            server_settings[option] = unicode(server_settings[option])
2612
2396
    # Force all boolean options to be boolean
2613
2397
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2614
 
                   "foreground", "zeroconf"):
 
2398
                   "foreground"):
2615
2399
        server_settings[option] = bool(server_settings[option])
2616
2400
    # Debug implies foreground
2617
2401
    if server_settings["debug"]:
2620
2404
    
2621
2405
    ##################################################################
2622
2406
    
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
2407
    # For convenience
2629
2408
    debug = server_settings["debug"]
2630
2409
    debuglevel = server_settings["debuglevel"]
2633
2412
    stored_state_path = os.path.join(server_settings["statedir"],
2634
2413
                                     stored_state_file)
2635
2414
    foreground = server_settings["foreground"]
2636
 
    zeroconf = server_settings["zeroconf"]
2637
2415
    
2638
2416
    if debug:
2639
2417
        initlogger(debug, logging.DEBUG)
2645
2423
            initlogger(debug, level)
2646
2424
    
2647
2425
    if server_settings["servicename"] != "Mandos":
2648
 
        syslogger.setFormatter(
2649
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
2650
 
                              ' %(levelname)s: %(message)s'.format(
2651
 
                                  server_settings["servicename"])))
 
2426
        syslogger.setFormatter(logging.Formatter
 
2427
                               ('Mandos ({0}) [%(process)d]:'
 
2428
                                ' %(levelname)s: %(message)s'
 
2429
                                .format(server_settings
 
2430
                                        ["servicename"])))
2652
2431
    
2653
2432
    # Parse config file with clients
2654
2433
    client_config = configparser.SafeConfigParser(Client
2659
2438
    global mandos_dbus_service
2660
2439
    mandos_dbus_service = None
2661
2440
    
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)
 
2441
    tcp_server = MandosServer((server_settings["address"],
 
2442
                               server_settings["port"]),
 
2443
                              ClientHandler,
 
2444
                              interface=(server_settings["interface"]
 
2445
                                         or None),
 
2446
                              use_ipv6=use_ipv6,
 
2447
                              gnutls_priority=
 
2448
                              server_settings["priority"],
 
2449
                              use_dbus=use_dbus,
 
2450
                              socketfd=(server_settings["socket"]
 
2451
                                        or None))
2673
2452
    if not foreground:
2674
 
        pidfilename = "/run/mandos.pid"
2675
 
        if not os.path.isdir("/run/."):
2676
 
            pidfilename = "/var/run/mandos.pid"
 
2453
        pidfilename = "/var/run/mandos.pid"
2677
2454
        pidfile = None
2678
2455
        try:
2679
 
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2456
            pidfile = open(pidfilename, "w")
2680
2457
        except IOError as e:
2681
2458
            logger.error("Could not open file %r", pidfilename,
2682
2459
                         exc_info=e)
2696
2473
        os.setuid(uid)
2697
2474
    except OSError as error:
2698
2475
        if error.errno != errno.EPERM:
2699
 
            raise
 
2476
            raise error
2700
2477
    
2701
2478
    if debug:
2702
2479
        # Enable all possible GnuTLS debugging
2709
2486
        def debug_gnutls(level, string):
2710
2487
            logger.debug("GnuTLS: %s", string[:-1])
2711
2488
        
2712
 
        gnutls.library.functions.gnutls_global_set_log_function(
2713
 
            debug_gnutls)
 
2489
        (gnutls.library.functions
 
2490
         .gnutls_global_set_log_function(debug_gnutls))
2714
2491
        
2715
2492
        # Redirect stdin so all checkers get /dev/null
2716
2493
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2736
2513
    if use_dbus:
2737
2514
        try:
2738
2515
            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:
 
2516
                                            bus, do_not_queue=True)
 
2517
            old_bus_name = (dbus.service.BusName
 
2518
                            ("se.bsnet.fukt.Mandos", bus,
 
2519
                             do_not_queue=True))
 
2520
        except dbus.exceptions.NameExistsException as e:
2745
2521
            logger.error("Disabling D-Bus:", exc_info=e)
2746
2522
            use_dbus = False
2747
2523
            server_settings["use_dbus"] = False
2748
2524
            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"))
 
2525
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2526
    service = AvahiServiceToSyslog(name =
 
2527
                                   server_settings["servicename"],
 
2528
                                   servicetype = "_mandos._tcp",
 
2529
                                   protocol = protocol, bus = bus)
 
2530
    if server_settings["interface"]:
 
2531
        service.interface = (if_nametoindex
 
2532
                             (str(server_settings["interface"])))
2759
2533
    
2760
2534
    global multiprocessing_manager
2761
2535
    multiprocessing_manager = multiprocessing.Manager()
2780
2554
    if server_settings["restore"]:
2781
2555
        try:
2782
2556
            with open(stored_state_path, "rb") as stored_state:
2783
 
                clients_data, old_client_settings = pickle.load(
2784
 
                    stored_state)
 
2557
                clients_data, old_client_settings = (pickle.load
 
2558
                                                     (stored_state))
2785
2559
            os.remove(stored_state_path)
2786
2560
        except IOError as e:
2787
2561
            if e.errno == errno.ENOENT:
2788
 
                logger.warning("Could not load persistent state:"
2789
 
                               " {}".format(os.strerror(e.errno)))
 
2562
                logger.warning("Could not load persistent state: {0}"
 
2563
                                .format(os.strerror(e.errno)))
2790
2564
            else:
2791
2565
                logger.critical("Could not load persistent state:",
2792
2566
                                exc_info=e)
2793
2567
                raise
2794
2568
        except EOFError as e:
2795
2569
            logger.warning("Could not load persistent state: "
2796
 
                           "EOFError:",
2797
 
                           exc_info=e)
 
2570
                           "EOFError:", exc_info=e)
2798
2571
    
2799
2572
    with PGPEngine() as pgp:
2800
 
        for client_name, client in clients_data.items():
 
2573
        for client_name, client in clients_data.iteritems():
2801
2574
            # Skip removed clients
2802
2575
            if client_name not in client_settings:
2803
2576
                continue
2812
2585
                    # For each value in new config, check if it
2813
2586
                    # differs from the old config value (Except for
2814
2587
                    # the "secret" attribute)
2815
 
                    if (name != "secret"
2816
 
                        and (value !=
2817
 
                             old_client_settings[client_name][name])):
 
2588
                    if (name != "secret" and
 
2589
                        value != old_client_settings[client_name]
 
2590
                        [name]):
2818
2591
                        client[name] = value
2819
2592
                except KeyError:
2820
2593
                    pass
2821
2594
            
2822
2595
            # Clients who has passed its expire date can still be
2823
 
            # enabled if its last checker was successful.  A Client
 
2596
            # enabled if its last checker was successful.  Clients
2824
2597
            # whose checker succeeded before we stored its state is
2825
2598
            # assumed to have successfully run all checkers during
2826
2599
            # downtime.
2828
2601
                if datetime.datetime.utcnow() >= client["expires"]:
2829
2602
                    if not client["last_checked_ok"]:
2830
2603
                        logger.warning(
2831
 
                            "disabling client {} - Client never "
2832
 
                            "performed a successful checker".format(
2833
 
                                client_name))
 
2604
                            "disabling client {0} - Client never "
 
2605
                            "performed a successful checker"
 
2606
                            .format(client_name))
2834
2607
                        client["enabled"] = False
2835
2608
                    elif client["last_checker_status"] != 0:
2836
2609
                        logger.warning(
2837
 
                            "disabling client {} - Client last"
2838
 
                            " checker failed with error code"
2839
 
                            " {}".format(
2840
 
                                client_name,
2841
 
                                client["last_checker_status"]))
 
2610
                            "disabling client {0} - Client "
 
2611
                            "last checker failed with error code {1}"
 
2612
                            .format(client_name,
 
2613
                                    client["last_checker_status"]))
2842
2614
                        client["enabled"] = False
2843
2615
                    else:
2844
 
                        client["expires"] = (
2845
 
                            datetime.datetime.utcnow()
2846
 
                            + client["timeout"])
 
2616
                        client["expires"] = (datetime.datetime
 
2617
                                             .utcnow()
 
2618
                                             + client["timeout"])
2847
2619
                        logger.debug("Last checker succeeded,"
2848
 
                                     " keeping {} enabled".format(
2849
 
                                         client_name))
 
2620
                                     " keeping {0} enabled"
 
2621
                                     .format(client_name))
2850
2622
            try:
2851
 
                client["secret"] = pgp.decrypt(
2852
 
                    client["encrypted_secret"],
2853
 
                    client_settings[client_name]["secret"])
 
2623
                client["secret"] = (
 
2624
                    pgp.decrypt(client["encrypted_secret"],
 
2625
                                client_settings[client_name]
 
2626
                                ["secret"]))
2854
2627
            except PGPError:
2855
2628
                # 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"])
 
2629
                logger.debug("Failed to decrypt {0} old secret"
 
2630
                             .format(client_name))
 
2631
                client["secret"] = (
 
2632
                    client_settings[client_name]["secret"])
2860
2633
    
2861
2634
    # Add/remove clients based on new changes made to config
2862
2635
    for client_name in (set(old_client_settings)
2867
2640
        clients_data[client_name] = client_settings[client_name]
2868
2641
    
2869
2642
    # Create all client objects
2870
 
    for client_name, client in clients_data.items():
 
2643
    for client_name, client in clients_data.iteritems():
2871
2644
        tcp_server.clients[client_name] = client_class(
2872
 
            name = client_name,
2873
 
            settings = client,
 
2645
            name = client_name, settings = client,
2874
2646
            server_settings = server_settings)
2875
2647
    
2876
2648
    if not tcp_server.clients:
2878
2650
    
2879
2651
    if not foreground:
2880
2652
        if pidfile is not None:
2881
 
            pid = os.getpid()
2882
2653
            try:
2883
2654
                with pidfile:
2884
 
                    print(pid, file=pidfile)
 
2655
                    pid = os.getpid()
 
2656
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
2885
2657
            except IOError:
2886
2658
                logger.error("Could not write to file %r with PID %d",
2887
2659
                             pidfilename, pid)
2892
2664
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2893
2665
    
2894
2666
    if use_dbus:
2895
 
        
2896
 
        @alternate_dbus_interfaces(
2897
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2898
 
        class MandosDBusService(DBusObjectWithObjectManager):
 
2667
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2668
                                        "se.bsnet.fukt.Mandos"})
 
2669
        class MandosDBusService(DBusObjectWithProperties):
2899
2670
            """A D-Bus proxy object"""
2900
 
            
2901
2671
            def __init__(self):
2902
2672
                dbus.service.Object.__init__(self, bus, "/")
2903
 
            
2904
2673
            _interface = "se.recompile.Mandos"
2905
2674
            
 
2675
            @dbus_interface_annotations(_interface)
 
2676
            def _foo(self):
 
2677
                return { "org.freedesktop.DBus.Property"
 
2678
                         ".EmitsChangedSignal":
 
2679
                             "false"}
 
2680
            
2906
2681
            @dbus.service.signal(_interface, signature="o")
2907
2682
            def ClientAdded(self, objpath):
2908
2683
                "D-Bus signal"
2913
2688
                "D-Bus signal"
2914
2689
                pass
2915
2690
            
2916
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
2917
 
                               "true"})
2918
2691
            @dbus.service.signal(_interface, signature="os")
2919
2692
            def ClientRemoved(self, objpath, name):
2920
2693
                "D-Bus signal"
2921
2694
                pass
2922
2695
            
2923
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
2924
 
                               "true"})
2925
2696
            @dbus.service.method(_interface, out_signature="ao")
2926
2697
            def GetAllClients(self):
2927
2698
                "D-Bus method"
2928
 
                return dbus.Array(c.dbus_object_path for c in
 
2699
                return dbus.Array(c.dbus_object_path
 
2700
                                  for c in
2929
2701
                                  tcp_server.clients.itervalues())
2930
2702
            
2931
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
2932
 
                               "true"})
2933
2703
            @dbus.service.method(_interface,
2934
2704
                                 out_signature="a{oa{sv}}")
2935
2705
            def GetAllClientsWithProperties(self):
2936
2706
                "D-Bus method"
2937
2707
                return dbus.Dictionary(
2938
 
                    { c.dbus_object_path: c.GetAll(
2939
 
                        "se.recompile.Mandos.Client")
2940
 
                      for c in tcp_server.clients.itervalues() },
 
2708
                    ((c.dbus_object_path, c.GetAll(""))
 
2709
                     for c in tcp_server.clients.itervalues()),
2941
2710
                    signature="oa{sv}")
2942
2711
            
2943
2712
            @dbus.service.method(_interface, in_signature="o")
2947
2716
                    if c.dbus_object_path == object_path:
2948
2717
                        del tcp_server.clients[c.name]
2949
2718
                        c.remove_from_connection()
2950
 
                        # Don't signal the disabling
 
2719
                        # Don't signal anything except ClientRemoved
2951
2720
                        c.disable(quiet=True)
2952
 
                        # Emit D-Bus signal for removal
2953
 
                        self.client_removed_signal(c)
 
2721
                        # Emit D-Bus signal
 
2722
                        self.ClientRemoved(object_path, c.name)
2954
2723
                        return
2955
2724
                raise KeyError(object_path)
2956
2725
            
2957
2726
            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
2727
        
2995
2728
        mandos_dbus_service = MandosDBusService()
2996
2729
    
2997
2730
    def cleanup():
2998
2731
        "Cleanup function; run on exit"
2999
 
        if zeroconf:
3000
 
            service.cleanup()
 
2732
        service.cleanup()
3001
2733
        
3002
2734
        multiprocessing.active_children()
3003
2735
        wnull.close()
3017
2749
                
3018
2750
                # A list of attributes that can not be pickled
3019
2751
                # + secret.
3020
 
                exclude = { "bus", "changedstate", "secret",
3021
 
                            "checker", "server_settings" }
3022
 
                for name, typ in inspect.getmembers(dbus.service
3023
 
                                                    .Object):
 
2752
                exclude = set(("bus", "changedstate", "secret",
 
2753
                               "checker", "server_settings"))
 
2754
                for name, typ in (inspect.getmembers
 
2755
                                  (dbus.service.Object)):
3024
2756
                    exclude.add(name)
3025
2757
                
3026
2758
                client_dict["encrypted_secret"] = (client
3033
2765
                del client_settings[client.name]["secret"]
3034
2766
        
3035
2767
        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:
 
2768
            with (tempfile.NamedTemporaryFile
 
2769
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2770
                   dir=os.path.dirname(stored_state_path),
 
2771
                   delete=False)) as stored_state:
3042
2772
                pickle.dump((clients, client_settings), stored_state)
3043
 
                tempname = stored_state.name
 
2773
                tempname=stored_state.name
3044
2774
            os.rename(tempname, stored_state_path)
3045
2775
        except (IOError, OSError) as e:
3046
2776
            if not debug:
3049
2779
                except NameError:
3050
2780
                    pass
3051
2781
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3052
 
                logger.warning("Could not save persistent state: {}"
 
2782
                logger.warning("Could not save persistent state: {0}"
3053
2783
                               .format(os.strerror(e.errno)))
3054
2784
            else:
3055
2785
                logger.warning("Could not save persistent state:",
3056
2786
                               exc_info=e)
3057
 
                raise
 
2787
                raise e
3058
2788
        
3059
2789
        # Delete all clients, and settings from config
3060
2790
        while tcp_server.clients:
3061
2791
            name, client = tcp_server.clients.popitem()
3062
2792
            if use_dbus:
3063
2793
                client.remove_from_connection()
3064
 
            # Don't signal the disabling
 
2794
            # Don't signal anything except ClientRemoved
3065
2795
            client.disable(quiet=True)
3066
 
            # Emit D-Bus signal for removal
3067
 
            mandos_dbus_service.client_removed_signal(client)
 
2796
            if use_dbus:
 
2797
                # Emit D-Bus signal
 
2798
                mandos_dbus_service.ClientRemoved(client
 
2799
                                                  .dbus_object_path,
 
2800
                                                  client.name)
3068
2801
        client_settings.clear()
3069
2802
    
3070
2803
    atexit.register(cleanup)
3071
2804
    
3072
2805
    for client in tcp_server.clients.itervalues():
3073
2806
        if use_dbus:
3074
 
            # Emit D-Bus signal for adding
3075
 
            mandos_dbus_service.client_added_signal(client)
 
2807
            # Emit D-Bus signal
 
2808
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
3076
2809
        # Need to initiate checking of clients
3077
2810
        if client.enabled:
3078
2811
            client.init_checker()
3081
2814
    tcp_server.server_activate()
3082
2815
    
3083
2816
    # Find out what port we got
3084
 
    if zeroconf:
3085
 
        service.port = tcp_server.socket.getsockname()[1]
 
2817
    service.port = tcp_server.socket.getsockname()[1]
3086
2818
    if use_ipv6:
3087
2819
        logger.info("Now listening on address %r, port %d,"
3088
2820
                    " flowinfo %d, scope_id %d",
3094
2826
    #service.interface = tcp_server.socket.getsockname()[3]
3095
2827
    
3096
2828
    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
 
2829
        # From the Avahi example code
 
2830
        try:
 
2831
            service.activate()
 
2832
        except dbus.exceptions.DBusException as error:
 
2833
            logger.critical("D-Bus Exception", exc_info=error)
 
2834
            cleanup()
 
2835
            sys.exit(1)
 
2836
        # End of Avahi example code
3106
2837
        
3107
2838
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3108
2839
                             lambda *args, **kwargs:
3123
2854
    # Must run before the D-Bus bus name gets deregistered
3124
2855
    cleanup()
3125
2856
 
3126
 
 
3127
2857
if __name__ == '__main__':
3128
2858
    main()