/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: 2014-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

* mandos-monitor (MandosClientWidget.__init__): Log client creation.
  (MandosClientWidget.checker_completed): Log a successful checker.
  (MandosClientWidget.checker_started): Log starting of a checker.
  (UserInterface.__init__): New optional "log_level" argument.
  (UserInterface.log_message, UserInterface.log_message_raw): Take
                                                              optional
                                                              "level"
                                                              arg.
  (UserInterface.toggle_log_display): Log visibility change.
  (UserInterface.change_log_display): Log wrap mode change.
  (UserInterface.process_input): Show new "v" key in help message and
                                 process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.

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