/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-08-10 16:19:28 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150810161928-bnukog7l47j3pjix
Depend on Avahi and the network in the server's systemd service file.

* mandos.service ([Unit]/After): New; set to "network.target" and
  "avahi-daemon.service".
  ([Unit]/RequisiteOverridable): New; set to "avahi-daemon.service".

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