/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: 2015-12-06 04:09:43 UTC
  • Revision ID: teddy@recompile.se-20151206040943-n08v1uym0d3h23u9
* mandos.xml (FILES): Removed duplicate entry for “/dev/log”.

Show diffs side-by-side

added added

removed removed

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