/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-07-09 20:32:52 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150709203252-u10p7trfsxc1a9yp
Install client Diffie-Hellman parameters into initramfs.

* debian/control (Package: mandos-client/Recommends): Added
  "gnutls-bin | openssl" (to generate DH parameters).
* debian/mandos-client.postinst (create_dh_params): New function
                                                    called on package
                                                    configure.
* plugins.d/mandos-client.c (main): Bug fix: Work around Debian bug
                                    #633582 also for the
                                    "client-dhparams.pem" file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
91
104
if sys.version_info.major == 2:
92
105
    str = unicode
93
106
 
94
 
version = "1.6.8"
 
107
version = "1.6.9"
95
108
stored_state_file = "clients.pickle"
96
109
 
97
110
logger = logging.getLogger()
98
111
syslogger = None
99
112
 
100
113
try:
101
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
102
 
                      (ctypes.util.find_library("c"))
103
 
                      .if_nametoindex)
 
114
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
115
        ctypes.util.find_library("c")).if_nametoindex
104
116
except (OSError, AttributeError):
 
117
    
105
118
    def if_nametoindex(interface):
106
119
        "Get an interface index the hard way, i.e. using fcntl()"
107
120
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
116
129
    """init logger and add loglevel"""
117
130
    
118
131
    global syslogger
119
 
    syslogger = (logging.handlers.SysLogHandler
120
 
                 (facility =
121
 
                  logging.handlers.SysLogHandler.LOG_DAEMON,
122
 
                  address = "/dev/log"))
 
132
    syslogger = (logging.handlers.SysLogHandler(
 
133
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
134
        address = "/dev/log"))
123
135
    syslogger.setFormatter(logging.Formatter
124
136
                           ('Mandos [%(process)d]: %(levelname)s:'
125
137
                            ' %(message)s'))
142
154
 
143
155
class PGPEngine(object):
144
156
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
157
    
145
158
    def __init__(self):
146
159
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
147
160
        self.gnupgargs = ['--batch',
186
199
    
187
200
    def encrypt(self, data, password):
188
201
        passphrase = self.password_encode(password)
189
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
190
 
                                         ) as passfile:
 
202
        with tempfile.NamedTemporaryFile(
 
203
                dir=self.tempdir) as passfile:
191
204
            passfile.write(passphrase)
192
205
            passfile.flush()
193
206
            proc = subprocess.Popen(['gpg', '--symmetric',
204
217
    
205
218
    def decrypt(self, data, password):
206
219
        passphrase = self.password_encode(password)
207
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
208
 
                                         ) as passfile:
 
220
        with tempfile.NamedTemporaryFile(
 
221
                dir = self.tempdir) as passfile:
209
222
            passfile.write(passphrase)
210
223
            passfile.flush()
211
224
            proc = subprocess.Popen(['gpg', '--decrypt',
215
228
                                    stdin = subprocess.PIPE,
216
229
                                    stdout = subprocess.PIPE,
217
230
                                    stderr = subprocess.PIPE)
218
 
            decrypted_plaintext, err = proc.communicate(input
219
 
                                                        = data)
 
231
            decrypted_plaintext, err = proc.communicate(input = data)
220
232
        if proc.returncode != 0:
221
233
            raise PGPError(err)
222
234
        return decrypted_plaintext
228
240
        return super(AvahiError, self).__init__(value, *args,
229
241
                                                **kwargs)
230
242
 
 
243
 
231
244
class AvahiServiceError(AvahiError):
232
245
    pass
233
246
 
 
247
 
234
248
class AvahiGroupError(AvahiError):
235
249
    pass
236
250
 
256
270
    bus: dbus.SystemBus()
257
271
    """
258
272
    
259
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
 
                 servicetype = None, port = None, TXT = None,
261
 
                 domain = "", host = "", max_renames = 32768,
262
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
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):
263
284
        self.interface = interface
264
285
        self.name = name
265
286
        self.type = servicetype
275
296
        self.bus = bus
276
297
        self.entry_group_state_changed_match = None
277
298
    
278
 
    def rename(self):
 
299
    def rename(self, remove=True):
279
300
        """Derived from the Avahi example code"""
280
301
        if self.rename_count >= self.max_renames:
281
302
            logger.critical("No suitable Zeroconf service name found"
282
303
                            " after %i retries, exiting.",
283
304
                            self.rename_count)
284
305
            raise AvahiServiceError("Too many renames")
285
 
        self.name = str(self.server
286
 
                        .GetAlternativeServiceName(self.name))
 
306
        self.name = str(
 
307
            self.server.GetAlternativeServiceName(self.name))
 
308
        self.rename_count += 1
287
309
        logger.info("Changing Zeroconf service name to %r ...",
288
310
                    self.name)
289
 
        self.remove()
 
311
        if remove:
 
312
            self.remove()
290
313
        try:
291
314
            self.add()
292
315
        except dbus.exceptions.DBusException as error:
293
 
            logger.critical("D-Bus Exception", exc_info=error)
294
 
            self.cleanup()
295
 
            os._exit(1)
296
 
        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)
297
324
    
298
325
    def remove(self):
299
326
        """Derived from the Avahi example code"""
338
365
        elif state == avahi.ENTRY_GROUP_FAILURE:
339
366
            logger.critical("Avahi: Error in group state changed %s",
340
367
                            str(error))
341
 
            raise AvahiGroupError("State changed: {!s}"
342
 
                                  .format(error))
 
368
            raise AvahiGroupError("State changed: {!s}".format(error))
343
369
    
344
370
    def cleanup(self):
345
371
        """Derived from the Avahi example code"""
355
381
    def server_state_changed(self, state, error=None):
356
382
        """Derived from the Avahi example code"""
357
383
        logger.debug("Avahi server state change: %i", state)
358
 
        bad_states = { avahi.SERVER_INVALID:
359
 
                           "Zeroconf server invalid",
360
 
                       avahi.SERVER_REGISTERING: None,
361
 
                       avahi.SERVER_COLLISION:
362
 
                           "Zeroconf server name collision",
363
 
                       avahi.SERVER_FAILURE:
364
 
                           "Zeroconf server failure" }
 
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
        }
365
390
        if state in bad_states:
366
391
            if bad_states[state] is not None:
367
392
                if error is None:
386
411
                                    follow_name_owner_changes=True),
387
412
                avahi.DBUS_INTERFACE_SERVER)
388
413
        self.server.connect_to_signal("StateChanged",
389
 
                                 self.server_state_changed)
 
414
                                      self.server_state_changed)
390
415
        self.server_state_changed(self.server.GetState())
391
416
 
392
417
 
393
418
class AvahiServiceToSyslog(AvahiService):
394
 
    def rename(self):
 
419
    def rename(self, *args, **kwargs):
395
420
        """Add the new name to the syslog messages"""
396
 
        ret = AvahiService.rename(self)
397
 
        syslogger.setFormatter(logging.Formatter
398
 
                               ('Mandos ({}) [%(process)d]:'
399
 
                                ' %(levelname)s: %(message)s'
400
 
                                .format(self.name)))
 
421
        ret = AvahiService.rename(self, *args, **kwargs)
 
422
        syslogger.setFormatter(logging.Formatter(
 
423
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
424
            .format(self.name)))
401
425
        return ret
402
426
 
 
427
def call_pipe(connection,       # : multiprocessing.Connection
 
428
              func, *args, **kwargs):
 
429
    """This function is meant to be called by multiprocessing.Process
 
430
    
 
431
    This function runs func(*args, **kwargs), and writes the resulting
 
432
    return value on the provided multiprocessing.Connection.
 
433
    """
 
434
    connection.send(func(*args, **kwargs))
 
435
    connection.close()
403
436
 
404
437
class Client(object):
405
438
    """A representation of a client host served by this server.
432
465
    last_checker_status: integer between 0 and 255 reflecting exit
433
466
                         status of last checker. -1 reflects crashed
434
467
                         checker, -2 means no checker completed yet.
 
468
    last_checker_signal: The signal which killed the last checker, if
 
469
                         last_checker_status is -1
435
470
    last_enabled: datetime.datetime(); (UTC) or None
436
471
    name:       string; from the config file, used in log messages and
437
472
                        D-Bus identifiers
450
485
                          "fingerprint", "host", "interval",
451
486
                          "last_approval_request", "last_checked_ok",
452
487
                          "last_enabled", "name", "timeout")
453
 
    client_defaults = { "timeout": "PT5M",
454
 
                        "extended_timeout": "PT15M",
455
 
                        "interval": "PT2M",
456
 
                        "checker": "fping -q -- %%(host)s",
457
 
                        "host": "",
458
 
                        "approval_delay": "PT0S",
459
 
                        "approval_duration": "PT1S",
460
 
                        "approved_by_default": "True",
461
 
                        "enabled": "True",
462
 
                        }
 
488
    client_defaults = {
 
489
        "timeout": "PT5M",
 
490
        "extended_timeout": "PT15M",
 
491
        "interval": "PT2M",
 
492
        "checker": "fping -q -- %%(host)s",
 
493
        "host": "",
 
494
        "approval_delay": "PT0S",
 
495
        "approval_duration": "PT1S",
 
496
        "approved_by_default": "True",
 
497
        "enabled": "True",
 
498
    }
463
499
    
464
500
    @staticmethod
465
501
    def config_parser(config):
481
517
            client["enabled"] = config.getboolean(client_name,
482
518
                                                  "enabled")
483
519
            
 
520
            # Uppercase and remove spaces from fingerprint for later
 
521
            # comparison purposes with return value from the
 
522
            # fingerprint() function
484
523
            client["fingerprint"] = (section["fingerprint"].upper()
485
524
                                     .replace(" ", ""))
486
525
            if "secret" in section:
528
567
            self.expires = None
529
568
        
530
569
        logger.debug("Creating client %r", self.name)
531
 
        # Uppercase and remove spaces from fingerprint for later
532
 
        # comparison purposes with return value from the fingerprint()
533
 
        # function
534
570
        logger.debug("  Fingerprint: %s", self.fingerprint)
535
571
        self.created = settings.get("created",
536
572
                                    datetime.datetime.utcnow())
543
579
        self.current_checker_command = None
544
580
        self.approved = None
545
581
        self.approvals_pending = 0
546
 
        self.changedstate = (multiprocessing_manager
547
 
                             .Condition(multiprocessing_manager
548
 
                                        .Lock()))
549
 
        self.client_structure = [attr for attr in
550
 
                                 self.__dict__.iterkeys()
 
582
        self.changedstate = multiprocessing_manager.Condition(
 
583
            multiprocessing_manager.Lock())
 
584
        self.client_structure = [attr
 
585
                                 for attr in self.__dict__.iterkeys()
551
586
                                 if not attr.startswith("_")]
552
587
        self.client_structure.append("client_structure")
553
588
        
554
 
        for name, t in inspect.getmembers(type(self),
555
 
                                          lambda obj:
556
 
                                              isinstance(obj,
557
 
                                                         property)):
 
589
        for name, t in inspect.getmembers(
 
590
                type(self), lambda obj: isinstance(obj, property)):
558
591
            if not name.startswith("_"):
559
592
                self.client_structure.append(name)
560
593
    
602
635
        # and every interval from then on.
603
636
        if self.checker_initiator_tag is not None:
604
637
            gobject.source_remove(self.checker_initiator_tag)
605
 
        self.checker_initiator_tag = (gobject.timeout_add
606
 
                                      (int(self.interval
607
 
                                           .total_seconds() * 1000),
608
 
                                       self.start_checker))
 
638
        self.checker_initiator_tag = gobject.timeout_add(
 
639
            int(self.interval.total_seconds() * 1000),
 
640
            self.start_checker)
609
641
        # Schedule a disable() when 'timeout' has passed
610
642
        if self.disable_initiator_tag is not None:
611
643
            gobject.source_remove(self.disable_initiator_tag)
612
 
        self.disable_initiator_tag = (gobject.timeout_add
613
 
                                      (int(self.timeout
614
 
                                           .total_seconds() * 1000),
615
 
                                       self.disable))
 
644
        self.disable_initiator_tag = gobject.timeout_add(
 
645
            int(self.timeout.total_seconds() * 1000), self.disable)
616
646
        # Also start a new checker *right now*.
617
647
        self.start_checker()
618
648
    
619
 
    def checker_callback(self, pid, condition, command):
 
649
    def checker_callback(self, source, condition, connection,
 
650
                         command):
620
651
        """The checker has completed, so take appropriate actions."""
621
652
        self.checker_callback_tag = None
622
653
        self.checker = None
623
 
        if os.WIFEXITED(condition):
624
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
654
        # Read return code from connection (see call_pipe)
 
655
        returncode = connection.recv()
 
656
        connection.close()
 
657
        
 
658
        if returncode >= 0:
 
659
            self.last_checker_status = returncode
 
660
            self.last_checker_signal = None
625
661
            if self.last_checker_status == 0:
626
662
                logger.info("Checker for %(name)s succeeded",
627
663
                            vars(self))
628
664
                self.checked_ok()
629
665
            else:
630
 
                logger.info("Checker for %(name)s failed",
631
 
                            vars(self))
 
666
                logger.info("Checker for %(name)s failed", vars(self))
632
667
        else:
633
668
            self.last_checker_status = -1
 
669
            self.last_checker_signal = -returncode
634
670
            logger.warning("Checker for %(name)s crashed?",
635
671
                           vars(self))
 
672
        return False
636
673
    
637
674
    def checked_ok(self):
638
675
        """Assert that the client has been seen, alive and well."""
639
676
        self.last_checked_ok = datetime.datetime.utcnow()
640
677
        self.last_checker_status = 0
 
678
        self.last_checker_signal = None
641
679
        self.bump_timeout()
642
680
    
643
681
    def bump_timeout(self, timeout=None):
648
686
            gobject.source_remove(self.disable_initiator_tag)
649
687
            self.disable_initiator_tag = None
650
688
        if getattr(self, "enabled", False):
651
 
            self.disable_initiator_tag = (gobject.timeout_add
652
 
                                          (int(timeout.total_seconds()
653
 
                                               * 1000), self.disable))
 
689
            self.disable_initiator_tag = gobject.timeout_add(
 
690
                int(timeout.total_seconds() * 1000), self.disable)
654
691
            self.expires = datetime.datetime.utcnow() + timeout
655
692
    
656
693
    def need_approval(self):
670
707
        # than 'timeout' for the client to be disabled, which is as it
671
708
        # should be.
672
709
        
673
 
        # If a checker exists, make sure it is not a zombie
674
 
        try:
675
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
676
 
        except AttributeError:
677
 
            pass
678
 
        except OSError as error:
679
 
            if error.errno != errno.ECHILD:
680
 
                raise
681
 
        else:
682
 
            if pid:
683
 
                logger.warning("Checker was a zombie")
684
 
                gobject.source_remove(self.checker_callback_tag)
685
 
                self.checker_callback(pid, status,
686
 
                                      self.current_checker_command)
 
710
        if self.checker is not None and not self.checker.is_alive():
 
711
            logger.warning("Checker was not alive; joining")
 
712
            self.checker.join()
 
713
            self.checker = None
687
714
        # Start a new checker if needed
688
715
        if self.checker is None:
689
716
            # Escape attributes for the shell
690
 
            escaped_attrs = { attr:
691
 
                                  re.escape(str(getattr(self, attr)))
692
 
                              for attr in self.runtime_expansions }
 
717
            escaped_attrs = {
 
718
                attr: re.escape(str(getattr(self, attr)))
 
719
                for attr in self.runtime_expansions }
693
720
            try:
694
721
                command = self.checker_command % escaped_attrs
695
722
            except TypeError as error:
696
723
                logger.error('Could not format string "%s"',
697
 
                             self.checker_command, exc_info=error)
698
 
                return True # Try again later
 
724
                             self.checker_command,
 
725
                             exc_info=error)
 
726
                return True     # Try again later
699
727
            self.current_checker_command = command
700
 
            try:
701
 
                logger.info("Starting checker %r for %s",
702
 
                            command, self.name)
703
 
                # We don't need to redirect stdout and stderr, since
704
 
                # in normal mode, that is already done by daemon(),
705
 
                # and in debug mode we don't want to.  (Stdin is
706
 
                # always replaced by /dev/null.)
707
 
                # The exception is when not debugging but nevertheless
708
 
                # running in the foreground; use the previously
709
 
                # created wnull.
710
 
                popen_args = {}
711
 
                if (not self.server_settings["debug"]
712
 
                    and self.server_settings["foreground"]):
713
 
                    popen_args.update({"stdout": wnull,
714
 
                                       "stderr": wnull })
715
 
                self.checker = subprocess.Popen(command,
716
 
                                                close_fds=True,
717
 
                                                shell=True, cwd="/",
718
 
                                                **popen_args)
719
 
            except OSError as error:
720
 
                logger.error("Failed to start subprocess",
721
 
                             exc_info=error)
722
 
                return True
723
 
            self.checker_callback_tag = (gobject.child_watch_add
724
 
                                         (self.checker.pid,
725
 
                                          self.checker_callback,
726
 
                                          data=command))
727
 
            # The checker may have completed before the gobject
728
 
            # watch was added.  Check for this.
729
 
            try:
730
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
731
 
            except OSError as error:
732
 
                if error.errno == errno.ECHILD:
733
 
                    # This should never happen
734
 
                    logger.error("Child process vanished",
735
 
                                 exc_info=error)
736
 
                    return True
737
 
                raise
738
 
            if pid:
739
 
                gobject.source_remove(self.checker_callback_tag)
740
 
                self.checker_callback(pid, status, command)
 
728
            logger.info("Starting checker %r for %s", command,
 
729
                        self.name)
 
730
            # We don't need to redirect stdout and stderr, since
 
731
            # in normal mode, that is already done by daemon(),
 
732
            # and in debug mode we don't want to.  (Stdin is
 
733
            # always replaced by /dev/null.)
 
734
            # The exception is when not debugging but nevertheless
 
735
            # running in the foreground; use the previously
 
736
            # created wnull.
 
737
            popen_args = { "close_fds": True,
 
738
                           "shell": True,
 
739
                           "cwd": "/" }
 
740
            if (not self.server_settings["debug"]
 
741
                and self.server_settings["foreground"]):
 
742
                popen_args.update({"stdout": wnull,
 
743
                                   "stderr": wnull })
 
744
            pipe = multiprocessing.Pipe(duplex = False)
 
745
            self.checker = multiprocessing.Process(
 
746
                target = call_pipe,
 
747
                args = (pipe[1], subprocess.call, command),
 
748
                kwargs = popen_args)
 
749
            self.checker.start()
 
750
            self.checker_callback_tag = gobject.io_add_watch(
 
751
                pipe[0].fileno(), gobject.IO_IN,
 
752
                self.checker_callback, pipe[0], command)
741
753
        # Re-run this periodically if run by gobject.timeout_add
742
754
        return True
743
755
    
749
761
        if getattr(self, "checker", None) is None:
750
762
            return
751
763
        logger.debug("Stopping checker for %(name)s", vars(self))
752
 
        try:
753
 
            self.checker.terminate()
754
 
            #time.sleep(0.5)
755
 
            #if self.checker.poll() is None:
756
 
            #    self.checker.kill()
757
 
        except OSError as error:
758
 
            if error.errno != errno.ESRCH: # No such process
759
 
                raise
 
764
        self.checker.terminate()
760
765
        self.checker = None
761
766
 
762
767
 
763
 
def dbus_service_property(dbus_interface, signature="v",
764
 
                          access="readwrite", byte_arrays=False):
 
768
def dbus_service_property(dbus_interface,
 
769
                          signature="v",
 
770
                          access="readwrite",
 
771
                          byte_arrays=False):
765
772
    """Decorators for marking methods of a DBusObjectWithProperties to
766
773
    become properties on the D-Bus.
767
774
    
777
784
    if byte_arrays and signature != "ay":
778
785
        raise ValueError("Byte arrays not supported for non-'ay'"
779
786
                         " signature {!r}".format(signature))
 
787
    
780
788
    def decorator(func):
781
789
        func._dbus_is_property = True
782
790
        func._dbus_interface = dbus_interface
787
795
            func._dbus_name = func._dbus_name[:-14]
788
796
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
789
797
        return func
 
798
    
790
799
    return decorator
791
800
 
792
801
 
801
810
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
802
811
                    "false"}
803
812
    """
 
813
    
804
814
    def decorator(func):
805
815
        func._dbus_is_interface = True
806
816
        func._dbus_interface = dbus_interface
807
817
        func._dbus_name = dbus_interface
808
818
        return func
 
819
    
809
820
    return decorator
810
821
 
811
822
 
813
824
    """Decorator to annotate D-Bus methods, signals or properties
814
825
    Usage:
815
826
    
 
827
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
828
                       "org.freedesktop.DBus.Property."
 
829
                       "EmitsChangedSignal": "false"})
816
830
    @dbus_service_property("org.example.Interface", signature="b",
817
831
                           access="r")
818
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
819
 
                        "org.freedesktop.DBus.Property."
820
 
                        "EmitsChangedSignal": "false"})
821
832
    def Property_dbus_property(self):
822
833
        return dbus.Boolean(False)
823
834
    """
 
835
    
824
836
    def decorator(func):
825
837
        func._dbus_annotations = annotations
826
838
        return func
 
839
    
827
840
    return decorator
828
841
 
829
842
 
832
845
    """
833
846
    pass
834
847
 
 
848
 
835
849
class DBusPropertyAccessException(DBusPropertyException):
836
850
    """A property's access permissions disallows an operation.
837
851
    """
865
879
    def _get_all_dbus_things(self, thing):
866
880
        """Returns a generator of (name, attribute) pairs
867
881
        """
868
 
        return ((getattr(athing.__get__(self), "_dbus_name",
869
 
                         name),
 
882
        return ((getattr(athing.__get__(self), "_dbus_name", name),
870
883
                 athing.__get__(self))
871
884
                for cls in self.__class__.__mro__
872
885
                for name, athing in
873
 
                inspect.getmembers(cls,
874
 
                                   self._is_dbus_thing(thing)))
 
886
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
875
887
    
876
888
    def _get_dbus_property(self, interface_name, property_name):
877
889
        """Returns a bound method if one exists which is a D-Bus
878
890
        property with the specified name and interface.
879
891
        """
880
 
        for cls in  self.__class__.__mro__:
881
 
            for name, value in (inspect.getmembers
882
 
                                (cls,
883
 
                                 self._is_dbus_thing("property"))):
 
892
        for cls in self.__class__.__mro__:
 
893
            for name, value in inspect.getmembers(
 
894
                    cls, self._is_dbus_thing("property")):
884
895
                if (value._dbus_name == property_name
885
896
                    and value._dbus_interface == interface_name):
886
897
                    return value.__get__(self)
887
898
        
888
899
        # No such property
889
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
890
 
                                   + interface_name + "."
891
 
                                   + property_name)
 
900
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
901
            self.dbus_object_path, interface_name, property_name))
892
902
    
893
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
903
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
904
                         in_signature="ss",
894
905
                         out_signature="v")
895
906
    def Get(self, interface_name, property_name):
896
907
        """Standard D-Bus property Get() method, see D-Bus standard.
921
932
                                            for byte in value))
922
933
        prop(value)
923
934
    
924
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
935
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
936
                         in_signature="s",
925
937
                         out_signature="a{sv}")
926
938
    def GetAll(self, interface_name):
927
939
        """Standard D-Bus property GetAll() method, see D-Bus
942
954
            if not hasattr(value, "variant_level"):
943
955
                properties[name] = value
944
956
                continue
945
 
            properties[name] = type(value)(value, variant_level=
946
 
                                           value.variant_level+1)
 
957
            properties[name] = type(value)(
 
958
                value, variant_level = value.variant_level + 1)
947
959
        return dbus.Dictionary(properties, signature="sv")
948
960
    
 
961
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
962
    def PropertiesChanged(self, interface_name, changed_properties,
 
963
                          invalidated_properties):
 
964
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
965
        standard.
 
966
        """
 
967
        pass
 
968
    
949
969
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
950
970
                         out_signature="s",
951
971
                         path_keyword='object_path',
959
979
                                                   connection)
960
980
        try:
961
981
            document = xml.dom.minidom.parseString(xmlstring)
 
982
            
962
983
            def make_tag(document, name, prop):
963
984
                e = document.createElement("property")
964
985
                e.setAttribute("name", name)
965
986
                e.setAttribute("type", prop._dbus_signature)
966
987
                e.setAttribute("access", prop._dbus_access)
967
988
                return e
 
989
            
968
990
            for if_tag in document.getElementsByTagName("interface"):
969
991
                # Add property tags
970
992
                for tag in (make_tag(document, name, prop)
982
1004
                            if (name == tag.getAttribute("name")
983
1005
                                and prop._dbus_interface
984
1006
                                == if_tag.getAttribute("name")):
985
 
                                annots.update(getattr
986
 
                                              (prop,
987
 
                                               "_dbus_annotations",
988
 
                                               {}))
 
1007
                                annots.update(getattr(
 
1008
                                    prop, "_dbus_annotations", {}))
989
1009
                        for name, value in annots.items():
990
1010
                            ann_tag = document.createElement(
991
1011
                                "annotation")
996
1016
                for annotation, value in dict(
997
1017
                    itertools.chain.from_iterable(
998
1018
                        annotations().items()
999
 
                        for name, annotations in
1000
 
                        self._get_all_dbus_things("interface")
 
1019
                        for name, annotations
 
1020
                        in self._get_all_dbus_things("interface")
1001
1021
                        if name == if_tag.getAttribute("name")
1002
1022
                        )).items():
1003
1023
                    ann_tag = document.createElement("annotation")
1032
1052
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1033
1053
    if dt is None:
1034
1054
        return dbus.String("", variant_level = variant_level)
1035
 
    return dbus.String(dt.isoformat(),
1036
 
                       variant_level=variant_level)
 
1055
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1037
1056
 
1038
1057
 
1039
1058
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1059
1078
    (from DBusObjectWithProperties) and interfaces (from the
1060
1079
    dbus_interface_annotations decorator).
1061
1080
    """
 
1081
    
1062
1082
    def wrapper(cls):
1063
1083
        for orig_interface_name, alt_interface_name in (
1064
 
            alt_interface_names.items()):
 
1084
                alt_interface_names.items()):
1065
1085
            attr = {}
1066
1086
            interface_names = set()
1067
1087
            # Go though all attributes of the class
1069
1089
                # Ignore non-D-Bus attributes, and D-Bus attributes
1070
1090
                # with the wrong interface name
1071
1091
                if (not hasattr(attribute, "_dbus_interface")
1072
 
                    or not attribute._dbus_interface
1073
 
                    .startswith(orig_interface_name)):
 
1092
                    or not attribute._dbus_interface.startswith(
 
1093
                        orig_interface_name)):
1074
1094
                    continue
1075
1095
                # Create an alternate D-Bus interface name based on
1076
1096
                # the current name
1077
 
                alt_interface = (attribute._dbus_interface
1078
 
                                 .replace(orig_interface_name,
1079
 
                                          alt_interface_name))
 
1097
                alt_interface = attribute._dbus_interface.replace(
 
1098
                    orig_interface_name, alt_interface_name)
1080
1099
                interface_names.add(alt_interface)
1081
1100
                # Is this a D-Bus signal?
1082
1101
                if getattr(attribute, "_dbus_is_signal", False):
1083
 
                    # Extract the original non-method undecorated
1084
 
                    # function by black magic
1085
 
                    nonmethod_func = (dict(
 
1102
                    if sys.version_info.major == 2:
 
1103
                        # Extract the original non-method undecorated
 
1104
                        # function by black magic
 
1105
                        nonmethod_func = (dict(
1086
1106
                            zip(attribute.func_code.co_freevars,
1087
 
                                attribute.__closure__))["func"]
1088
 
                                      .cell_contents)
 
1107
                                attribute.__closure__))
 
1108
                                          ["func"].cell_contents)
 
1109
                    else:
 
1110
                        nonmethod_func = attribute
1089
1111
                    # Create a new, but exactly alike, function
1090
1112
                    # object, and decorate it to be a new D-Bus signal
1091
1113
                    # with the alternate D-Bus interface name
1092
 
                    new_function = (dbus.service.signal
1093
 
                                    (alt_interface,
1094
 
                                     attribute._dbus_signature)
1095
 
                                    (types.FunctionType(
1096
 
                                nonmethod_func.func_code,
1097
 
                                nonmethod_func.func_globals,
1098
 
                                nonmethod_func.func_name,
1099
 
                                nonmethod_func.func_defaults,
1100
 
                                nonmethod_func.func_closure)))
 
1114
                    if sys.version_info.major == 2:
 
1115
                        new_function = 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)
 
1121
                    else:
 
1122
                        new_function = types.FunctionType(
 
1123
                            nonmethod_func.__code__,
 
1124
                            nonmethod_func.__globals__,
 
1125
                            nonmethod_func.__name__,
 
1126
                            nonmethod_func.__defaults__,
 
1127
                            nonmethod_func.__closure__)
 
1128
                    new_function = (dbus.service.signal(
 
1129
                        alt_interface,
 
1130
                        attribute._dbus_signature)(new_function))
1101
1131
                    # Copy annotations, if any
1102
1132
                    try:
1103
 
                        new_function._dbus_annotations = (
1104
 
                            dict(attribute._dbus_annotations))
 
1133
                        new_function._dbus_annotations = dict(
 
1134
                            attribute._dbus_annotations)
1105
1135
                    except AttributeError:
1106
1136
                        pass
1107
1137
                    # Define a creator of a function to call both the
1112
1142
                        """This function is a scope container to pass
1113
1143
                        func1 and func2 to the "call_both" function
1114
1144
                        outside of its arguments"""
 
1145
                        
1115
1146
                        def call_both(*args, **kwargs):
1116
1147
                            """This function will emit two D-Bus
1117
1148
                            signals by calling func1 and func2"""
1118
1149
                            func1(*args, **kwargs)
1119
1150
                            func2(*args, **kwargs)
 
1151
                        
1120
1152
                        return call_both
1121
1153
                    # Create the "call_both" function and add it to
1122
1154
                    # the class
1127
1159
                    # object.  Decorate it to be a new D-Bus method
1128
1160
                    # with the alternate D-Bus interface name.  Add it
1129
1161
                    # to the class.
1130
 
                    attr[attrname] = (dbus.service.method
1131
 
                                      (alt_interface,
1132
 
                                       attribute._dbus_in_signature,
1133
 
                                       attribute._dbus_out_signature)
1134
 
                                      (types.FunctionType
1135
 
                                       (attribute.func_code,
1136
 
                                        attribute.func_globals,
1137
 
                                        attribute.func_name,
1138
 
                                        attribute.func_defaults,
1139
 
                                        attribute.func_closure)))
 
1162
                    attr[attrname] = (
 
1163
                        dbus.service.method(
 
1164
                            alt_interface,
 
1165
                            attribute._dbus_in_signature,
 
1166
                            attribute._dbus_out_signature)
 
1167
                        (types.FunctionType(attribute.func_code,
 
1168
                                            attribute.func_globals,
 
1169
                                            attribute.func_name,
 
1170
                                            attribute.func_defaults,
 
1171
                                            attribute.func_closure)))
1140
1172
                    # Copy annotations, if any
1141
1173
                    try:
1142
 
                        attr[attrname]._dbus_annotations = (
1143
 
                            dict(attribute._dbus_annotations))
 
1174
                        attr[attrname]._dbus_annotations = dict(
 
1175
                            attribute._dbus_annotations)
1144
1176
                    except AttributeError:
1145
1177
                        pass
1146
1178
                # Is this a D-Bus property?
1149
1181
                    # object, and decorate it to be a new D-Bus
1150
1182
                    # property with the alternate D-Bus interface
1151
1183
                    # name.  Add it to the class.
1152
 
                    attr[attrname] = (dbus_service_property
1153
 
                                      (alt_interface,
1154
 
                                       attribute._dbus_signature,
1155
 
                                       attribute._dbus_access,
1156
 
                                       attribute
1157
 
                                       ._dbus_get_args_options
1158
 
                                       ["byte_arrays"])
1159
 
                                      (types.FunctionType
1160
 
                                       (attribute.func_code,
1161
 
                                        attribute.func_globals,
1162
 
                                        attribute.func_name,
1163
 
                                        attribute.func_defaults,
1164
 
                                        attribute.func_closure)))
 
1184
                    attr[attrname] = (dbus_service_property(
 
1185
                        alt_interface, attribute._dbus_signature,
 
1186
                        attribute._dbus_access,
 
1187
                        attribute._dbus_get_args_options
 
1188
                        ["byte_arrays"])
 
1189
                                      (types.FunctionType(
 
1190
                                          attribute.func_code,
 
1191
                                          attribute.func_globals,
 
1192
                                          attribute.func_name,
 
1193
                                          attribute.func_defaults,
 
1194
                                          attribute.func_closure)))
1165
1195
                    # Copy annotations, if any
1166
1196
                    try:
1167
 
                        attr[attrname]._dbus_annotations = (
1168
 
                            dict(attribute._dbus_annotations))
 
1197
                        attr[attrname]._dbus_annotations = dict(
 
1198
                            attribute._dbus_annotations)
1169
1199
                    except AttributeError:
1170
1200
                        pass
1171
1201
                # Is this a D-Bus interface?
1174
1204
                    # object.  Decorate it to be a new D-Bus interface
1175
1205
                    # with the alternate D-Bus interface name.  Add it
1176
1206
                    # to the class.
1177
 
                    attr[attrname] = (dbus_interface_annotations
1178
 
                                      (alt_interface)
1179
 
                                      (types.FunctionType
1180
 
                                       (attribute.func_code,
1181
 
                                        attribute.func_globals,
1182
 
                                        attribute.func_name,
1183
 
                                        attribute.func_defaults,
1184
 
                                        attribute.func_closure)))
 
1207
                    attr[attrname] = (
 
1208
                        dbus_interface_annotations(alt_interface)
 
1209
                        (types.FunctionType(attribute.func_code,
 
1210
                                            attribute.func_globals,
 
1211
                                            attribute.func_name,
 
1212
                                            attribute.func_defaults,
 
1213
                                            attribute.func_closure)))
1185
1214
            if deprecate:
1186
1215
                # Deprecate all alternate interfaces
1187
1216
                iname="_AlternateDBusNames_interface_annotation{}"
1188
1217
                for interface_name in interface_names:
 
1218
                    
1189
1219
                    @dbus_interface_annotations(interface_name)
1190
1220
                    def func(self):
1191
1221
                        return { "org.freedesktop.DBus.Deprecated":
1192
 
                                     "true" }
 
1222
                                 "true" }
1193
1223
                    # Find an unused name
1194
1224
                    for aname in (iname.format(i)
1195
1225
                                  for i in itertools.count()):
1200
1230
                # Replace the class with a new subclass of it with
1201
1231
                # methods, signals, etc. as created above.
1202
1232
                cls = type(b"{}Alternate".format(cls.__name__),
1203
 
                           (cls,), attr)
 
1233
                           (cls, ), attr)
1204
1234
        return cls
 
1235
    
1205
1236
    return wrapper
1206
1237
 
1207
1238
 
1208
1239
@alternate_dbus_interfaces({"se.recompile.Mandos":
1209
 
                                "se.bsnet.fukt.Mandos"})
 
1240
                            "se.bsnet.fukt.Mandos"})
1210
1241
class ClientDBus(Client, DBusObjectWithProperties):
1211
1242
    """A Client class using D-Bus
1212
1243
    
1216
1247
    """
1217
1248
    
1218
1249
    runtime_expansions = (Client.runtime_expansions
1219
 
                          + ("dbus_object_path",))
 
1250
                          + ("dbus_object_path", ))
 
1251
    
 
1252
    _interface = "se.recompile.Mandos.Client"
1220
1253
    
1221
1254
    # dbus.service.Object doesn't use super(), so we can't either.
1222
1255
    
1228
1261
        client_object_name = str(self.name).translate(
1229
1262
            {ord("."): ord("_"),
1230
1263
             ord("-"): ord("_")})
1231
 
        self.dbus_object_path = (dbus.ObjectPath
1232
 
                                 ("/clients/" + client_object_name))
 
1264
        self.dbus_object_path = dbus.ObjectPath(
 
1265
            "/clients/" + client_object_name)
1233
1266
        DBusObjectWithProperties.__init__(self, self.bus,
1234
1267
                                          self.dbus_object_path)
1235
1268
    
1236
 
    def notifychangeproperty(transform_func,
1237
 
                             dbus_name, type_func=lambda x: x,
1238
 
                             variant_level=1):
 
1269
    def notifychangeproperty(transform_func, dbus_name,
 
1270
                             type_func=lambda x: x,
 
1271
                             variant_level=1,
 
1272
                             invalidate_only=False,
 
1273
                             _interface=_interface):
1239
1274
        """ Modify a variable so that it's a property which announces
1240
1275
        its changes to DBus.
1241
1276
        
1247
1282
        variant_level: D-Bus variant level.  Default: 1
1248
1283
        """
1249
1284
        attrname = "_{}".format(dbus_name)
 
1285
        
1250
1286
        def setter(self, value):
1251
1287
            if hasattr(self, "dbus_object_path"):
1252
1288
                if (not hasattr(self, attrname) or
1253
1289
                    type_func(getattr(self, attrname, None))
1254
1290
                    != type_func(value)):
1255
 
                    dbus_value = transform_func(type_func(value),
1256
 
                                                variant_level
1257
 
                                                =variant_level)
1258
 
                    self.PropertyChanged(dbus.String(dbus_name),
1259
 
                                         dbus_value)
 
1291
                    if invalidate_only:
 
1292
                        self.PropertiesChanged(
 
1293
                            _interface, dbus.Dictionary(),
 
1294
                            dbus.Array((dbus_name, )))
 
1295
                    else:
 
1296
                        dbus_value = transform_func(
 
1297
                            type_func(value),
 
1298
                            variant_level = variant_level)
 
1299
                        self.PropertyChanged(dbus.String(dbus_name),
 
1300
                                             dbus_value)
 
1301
                        self.PropertiesChanged(
 
1302
                            _interface,
 
1303
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1304
                                              dbus_value }),
 
1305
                            dbus.Array())
1260
1306
            setattr(self, attrname, value)
1261
1307
        
1262
1308
        return property(lambda self: getattr(self, attrname), setter)
1268
1314
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1269
1315
    last_enabled = notifychangeproperty(datetime_to_dbus,
1270
1316
                                        "LastEnabled")
1271
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1272
 
                                   type_func = lambda checker:
1273
 
                                       checker is not None)
 
1317
    checker = notifychangeproperty(
 
1318
        dbus.Boolean, "CheckerRunning",
 
1319
        type_func = lambda checker: checker is not None)
1274
1320
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1275
1321
                                           "LastCheckedOK")
1276
1322
    last_checker_status = notifychangeproperty(dbus.Int16,
1279
1325
        datetime_to_dbus, "LastApprovalRequest")
1280
1326
    approved_by_default = notifychangeproperty(dbus.Boolean,
1281
1327
                                               "ApprovedByDefault")
1282
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1283
 
                                          "ApprovalDelay",
1284
 
                                          type_func =
1285
 
                                          lambda td: td.total_seconds()
1286
 
                                          * 1000)
 
1328
    approval_delay = notifychangeproperty(
 
1329
        dbus.UInt64, "ApprovalDelay",
 
1330
        type_func = lambda td: td.total_seconds() * 1000)
1287
1331
    approval_duration = notifychangeproperty(
1288
1332
        dbus.UInt64, "ApprovalDuration",
1289
1333
        type_func = lambda td: td.total_seconds() * 1000)
1290
1334
    host = notifychangeproperty(dbus.String, "Host")
1291
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1292
 
                                   type_func = lambda td:
1293
 
                                       td.total_seconds() * 1000)
 
1335
    timeout = notifychangeproperty(
 
1336
        dbus.UInt64, "Timeout",
 
1337
        type_func = lambda td: td.total_seconds() * 1000)
1294
1338
    extended_timeout = notifychangeproperty(
1295
1339
        dbus.UInt64, "ExtendedTimeout",
1296
1340
        type_func = lambda td: td.total_seconds() * 1000)
1297
 
    interval = notifychangeproperty(dbus.UInt64,
1298
 
                                    "Interval",
1299
 
                                    type_func =
1300
 
                                    lambda td: td.total_seconds()
1301
 
                                    * 1000)
 
1341
    interval = notifychangeproperty(
 
1342
        dbus.UInt64, "Interval",
 
1343
        type_func = lambda td: td.total_seconds() * 1000)
1302
1344
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1345
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1346
                                  invalidate_only=True)
1303
1347
    
1304
1348
    del notifychangeproperty
1305
1349
    
1312
1356
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1313
1357
        Client.__del__(self, *args, **kwargs)
1314
1358
    
1315
 
    def checker_callback(self, pid, condition, command,
1316
 
                         *args, **kwargs):
1317
 
        self.checker_callback_tag = None
1318
 
        self.checker = None
1319
 
        if os.WIFEXITED(condition):
1320
 
            exitstatus = os.WEXITSTATUS(condition)
 
1359
    def checker_callback(self, source, condition,
 
1360
                         connection, command, *args, **kwargs):
 
1361
        ret = Client.checker_callback(self, source, condition,
 
1362
                                      connection, command, *args,
 
1363
                                      **kwargs)
 
1364
        exitstatus = self.last_checker_status
 
1365
        if exitstatus >= 0:
1321
1366
            # Emit D-Bus signal
1322
1367
            self.CheckerCompleted(dbus.Int16(exitstatus),
1323
 
                                  dbus.Int64(condition),
 
1368
                                  dbus.Int64(0),
1324
1369
                                  dbus.String(command))
1325
1370
        else:
1326
1371
            # Emit D-Bus signal
1327
1372
            self.CheckerCompleted(dbus.Int16(-1),
1328
 
                                  dbus.Int64(condition),
 
1373
                                  dbus.Int64(
 
1374
                                      self.last_checker_signal),
1329
1375
                                  dbus.String(command))
1330
 
        
1331
 
        return Client.checker_callback(self, pid, condition, command,
1332
 
                                       *args, **kwargs)
 
1376
        return ret
1333
1377
    
1334
1378
    def start_checker(self, *args, **kwargs):
1335
1379
        old_checker_pid = getattr(self.checker, "pid", None)
1352
1396
        self.send_changedstate()
1353
1397
    
1354
1398
    ## D-Bus methods, signals & properties
1355
 
    _interface = "se.recompile.Mandos.Client"
1356
1399
    
1357
1400
    ## Interfaces
1358
1401
    
1359
 
    @dbus_interface_annotations(_interface)
1360
 
    def _foo(self):
1361
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1362
 
                     "false"}
1363
 
    
1364
1402
    ## Signals
1365
1403
    
1366
1404
    # CheckerCompleted - signal
1376
1414
        pass
1377
1415
    
1378
1416
    # PropertyChanged - signal
 
1417
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1379
1418
    @dbus.service.signal(_interface, signature="sv")
1380
1419
    def PropertyChanged(self, property, value):
1381
1420
        "D-Bus signal"
1445
1484
        return dbus.Boolean(bool(self.approvals_pending))
1446
1485
    
1447
1486
    # ApprovedByDefault - property
1448
 
    @dbus_service_property(_interface, signature="b",
 
1487
    @dbus_service_property(_interface,
 
1488
                           signature="b",
1449
1489
                           access="readwrite")
1450
1490
    def ApprovedByDefault_dbus_property(self, value=None):
1451
1491
        if value is None:       # get
1453
1493
        self.approved_by_default = bool(value)
1454
1494
    
1455
1495
    # ApprovalDelay - property
1456
 
    @dbus_service_property(_interface, signature="t",
 
1496
    @dbus_service_property(_interface,
 
1497
                           signature="t",
1457
1498
                           access="readwrite")
1458
1499
    def ApprovalDelay_dbus_property(self, value=None):
1459
1500
        if value is None:       # get
1462
1503
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1463
1504
    
1464
1505
    # ApprovalDuration - property
1465
 
    @dbus_service_property(_interface, signature="t",
 
1506
    @dbus_service_property(_interface,
 
1507
                           signature="t",
1466
1508
                           access="readwrite")
1467
1509
    def ApprovalDuration_dbus_property(self, value=None):
1468
1510
        if value is None:       # get
1481
1523
        return dbus.String(self.fingerprint)
1482
1524
    
1483
1525
    # Host - property
1484
 
    @dbus_service_property(_interface, signature="s",
 
1526
    @dbus_service_property(_interface,
 
1527
                           signature="s",
1485
1528
                           access="readwrite")
1486
1529
    def Host_dbus_property(self, value=None):
1487
1530
        if value is None:       # get
1499
1542
        return datetime_to_dbus(self.last_enabled)
1500
1543
    
1501
1544
    # Enabled - property
1502
 
    @dbus_service_property(_interface, signature="b",
 
1545
    @dbus_service_property(_interface,
 
1546
                           signature="b",
1503
1547
                           access="readwrite")
1504
1548
    def Enabled_dbus_property(self, value=None):
1505
1549
        if value is None:       # get
1510
1554
            self.disable()
1511
1555
    
1512
1556
    # LastCheckedOK - property
1513
 
    @dbus_service_property(_interface, signature="s",
 
1557
    @dbus_service_property(_interface,
 
1558
                           signature="s",
1514
1559
                           access="readwrite")
1515
1560
    def LastCheckedOK_dbus_property(self, value=None):
1516
1561
        if value is not None:
1519
1564
        return datetime_to_dbus(self.last_checked_ok)
1520
1565
    
1521
1566
    # LastCheckerStatus - property
1522
 
    @dbus_service_property(_interface, signature="n",
1523
 
                           access="read")
 
1567
    @dbus_service_property(_interface, signature="n", access="read")
1524
1568
    def LastCheckerStatus_dbus_property(self):
1525
1569
        return dbus.Int16(self.last_checker_status)
1526
1570
    
1535
1579
        return datetime_to_dbus(self.last_approval_request)
1536
1580
    
1537
1581
    # Timeout - property
1538
 
    @dbus_service_property(_interface, signature="t",
 
1582
    @dbus_service_property(_interface,
 
1583
                           signature="t",
1539
1584
                           access="readwrite")
1540
1585
    def Timeout_dbus_property(self, value=None):
1541
1586
        if value is None:       # get
1554
1599
                    is None):
1555
1600
                    return
1556
1601
                gobject.source_remove(self.disable_initiator_tag)
1557
 
                self.disable_initiator_tag = (
1558
 
                    gobject.timeout_add(
1559
 
                        int((self.expires - now).total_seconds()
1560
 
                            * 1000), self.disable))
 
1602
                self.disable_initiator_tag = gobject.timeout_add(
 
1603
                    int((self.expires - now).total_seconds() * 1000),
 
1604
                    self.disable)
1561
1605
    
1562
1606
    # ExtendedTimeout - property
1563
 
    @dbus_service_property(_interface, signature="t",
 
1607
    @dbus_service_property(_interface,
 
1608
                           signature="t",
1564
1609
                           access="readwrite")
1565
1610
    def ExtendedTimeout_dbus_property(self, value=None):
1566
1611
        if value is None:       # get
1569
1614
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1570
1615
    
1571
1616
    # Interval - property
1572
 
    @dbus_service_property(_interface, signature="t",
 
1617
    @dbus_service_property(_interface,
 
1618
                           signature="t",
1573
1619
                           access="readwrite")
1574
1620
    def Interval_dbus_property(self, value=None):
1575
1621
        if value is None:       # get
1580
1626
        if self.enabled:
1581
1627
            # Reschedule checker run
1582
1628
            gobject.source_remove(self.checker_initiator_tag)
1583
 
            self.checker_initiator_tag = (gobject.timeout_add
1584
 
                                          (value, self.start_checker))
1585
 
            self.start_checker()    # Start one now, too
 
1629
            self.checker_initiator_tag = gobject.timeout_add(
 
1630
                value, self.start_checker)
 
1631
            self.start_checker() # Start one now, too
1586
1632
    
1587
1633
    # Checker - property
1588
 
    @dbus_service_property(_interface, signature="s",
 
1634
    @dbus_service_property(_interface,
 
1635
                           signature="s",
1589
1636
                           access="readwrite")
1590
1637
    def Checker_dbus_property(self, value=None):
1591
1638
        if value is None:       # get
1593
1640
        self.checker_command = str(value)
1594
1641
    
1595
1642
    # CheckerRunning - property
1596
 
    @dbus_service_property(_interface, signature="b",
 
1643
    @dbus_service_property(_interface,
 
1644
                           signature="b",
1597
1645
                           access="readwrite")
1598
1646
    def CheckerRunning_dbus_property(self, value=None):
1599
1647
        if value is None:       # get
1609
1657
        return self.dbus_object_path # is already a dbus.ObjectPath
1610
1658
    
1611
1659
    # Secret = property
1612
 
    @dbus_service_property(_interface, signature="ay",
1613
 
                           access="write", byte_arrays=True)
 
1660
    @dbus_service_property(_interface,
 
1661
                           signature="ay",
 
1662
                           access="write",
 
1663
                           byte_arrays=True)
1614
1664
    def Secret_dbus_property(self, value):
1615
1665
        self.secret = bytes(value)
1616
1666
    
1622
1672
        self._pipe = child_pipe
1623
1673
        self._pipe.send(('init', fpr, address))
1624
1674
        if not self._pipe.recv():
1625
 
            raise KeyError()
 
1675
            raise KeyError(fpr)
1626
1676
    
1627
1677
    def __getattribute__(self, name):
1628
1678
        if name == '_pipe':
1632
1682
        if data[0] == 'data':
1633
1683
            return data[1]
1634
1684
        if data[0] == 'function':
 
1685
            
1635
1686
            def func(*args, **kwargs):
1636
1687
                self._pipe.send(('funcall', name, args, kwargs))
1637
1688
                return self._pipe.recv()[1]
 
1689
            
1638
1690
            return func
1639
1691
    
1640
1692
    def __setattr__(self, name, value):
1656
1708
            logger.debug("Pipe FD: %d",
1657
1709
                         self.server.child_pipe.fileno())
1658
1710
            
1659
 
            session = (gnutls.connection
1660
 
                       .ClientSession(self.request,
1661
 
                                      gnutls.connection
1662
 
                                      .X509Credentials()))
 
1711
            session = gnutls.connection.ClientSession(
 
1712
                self.request, gnutls.connection .X509Credentials())
1663
1713
            
1664
1714
            # Note: gnutls.connection.X509Credentials is really a
1665
1715
            # generic GnuTLS certificate credentials object so long as
1674
1724
            priority = self.server.gnutls_priority
1675
1725
            if priority is None:
1676
1726
                priority = "NORMAL"
1677
 
            (gnutls.library.functions
1678
 
             .gnutls_priority_set_direct(session._c_object,
1679
 
                                         priority, None))
 
1727
            gnutls.library.functions.gnutls_priority_set_direct(
 
1728
                session._c_object, priority, None)
1680
1729
            
1681
1730
            # Start communication using the Mandos protocol
1682
1731
            # Get protocol number
1702
1751
            approval_required = False
1703
1752
            try:
1704
1753
                try:
1705
 
                    fpr = self.fingerprint(self.peer_certificate
1706
 
                                           (session))
 
1754
                    fpr = self.fingerprint(
 
1755
                        self.peer_certificate(session))
1707
1756
                except (TypeError,
1708
1757
                        gnutls.errors.GNUTLSError) as error:
1709
1758
                    logger.warning("Bad certificate: %s", error)
1724
1773
                while True:
1725
1774
                    if not client.enabled:
1726
1775
                        logger.info("Client %s is disabled",
1727
 
                                       client.name)
 
1776
                                    client.name)
1728
1777
                        if self.server.use_dbus:
1729
1778
                            # Emit D-Bus signal
1730
1779
                            client.Rejected("Disabled")
1777
1826
                        logger.warning("gnutls send failed",
1778
1827
                                       exc_info=error)
1779
1828
                        return
1780
 
                    logger.debug("Sent: %d, remaining: %d",
1781
 
                                 sent, len(client.secret)
1782
 
                                 - (sent_size + sent))
 
1829
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1830
                                 len(client.secret) - (sent_size
 
1831
                                                       + sent))
1783
1832
                    sent_size += sent
1784
1833
                
1785
1834
                logger.info("Sending secret to %s", client.name)
1802
1851
    def peer_certificate(session):
1803
1852
        "Return the peer's OpenPGP certificate as a bytestring"
1804
1853
        # If not an OpenPGP certificate...
1805
 
        if (gnutls.library.functions
1806
 
            .gnutls_certificate_type_get(session._c_object)
 
1854
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
1855
                session._c_object)
1807
1856
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1808
1857
            # ...do the normal thing
1809
1858
            return session.peer_certificate
1823
1872
    def fingerprint(openpgp):
1824
1873
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1825
1874
        # New GnuTLS "datum" with the OpenPGP public key
1826
 
        datum = (gnutls.library.types
1827
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1828
 
                                             ctypes.POINTER
1829
 
                                             (ctypes.c_ubyte)),
1830
 
                                 ctypes.c_uint(len(openpgp))))
 
1875
        datum = gnutls.library.types.gnutls_datum_t(
 
1876
            ctypes.cast(ctypes.c_char_p(openpgp),
 
1877
                        ctypes.POINTER(ctypes.c_ubyte)),
 
1878
            ctypes.c_uint(len(openpgp)))
1831
1879
        # New empty GnuTLS certificate
1832
1880
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1833
 
        (gnutls.library.functions
1834
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
1881
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
1882
            ctypes.byref(crt))
1835
1883
        # Import the OpenPGP public key into the certificate
1836
 
        (gnutls.library.functions
1837
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1838
 
                                    gnutls.library.constants
1839
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
1884
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
1885
            crt, ctypes.byref(datum),
 
1886
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1840
1887
        # Verify the self signature in the key
1841
1888
        crtverify = ctypes.c_uint()
1842
 
        (gnutls.library.functions
1843
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1844
 
                                         ctypes.byref(crtverify)))
 
1889
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
1890
            crt, 0, ctypes.byref(crtverify))
1845
1891
        if crtverify.value != 0:
1846
1892
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1847
 
            raise (gnutls.errors.CertificateSecurityError
1848
 
                   ("Verify failed"))
 
1893
            raise gnutls.errors.CertificateSecurityError(
 
1894
                "Verify failed")
1849
1895
        # New buffer for the fingerprint
1850
1896
        buf = ctypes.create_string_buffer(20)
1851
1897
        buf_len = ctypes.c_size_t()
1852
1898
        # Get the fingerprint from the certificate into the buffer
1853
 
        (gnutls.library.functions
1854
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1855
 
                                             ctypes.byref(buf_len)))
 
1899
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
1900
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1856
1901
        # Deinit the certificate
1857
1902
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1858
1903
        # Convert the buffer to a Python bytestring
1864
1909
 
1865
1910
class MultiprocessingMixIn(object):
1866
1911
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1912
    
1867
1913
    def sub_process_main(self, request, address):
1868
1914
        try:
1869
1915
            self.finish_request(request, address)
1881
1927
 
1882
1928
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1883
1929
    """ adds a pipe to the MixIn """
 
1930
    
1884
1931
    def process_request(self, request, client_address):
1885
1932
        """Overrides and wraps the original process_request().
1886
1933
        
1907
1954
        interface:      None or a network interface name (string)
1908
1955
        use_ipv6:       Boolean; to use IPv6 or not
1909
1956
    """
 
1957
    
1910
1958
    def __init__(self, server_address, RequestHandlerClass,
1911
 
                 interface=None, use_ipv6=True, socketfd=None):
 
1959
                 interface=None,
 
1960
                 use_ipv6=True,
 
1961
                 socketfd=None):
1912
1962
        """If socketfd is set, use that file descriptor instead of
1913
1963
        creating a new one with socket.socket().
1914
1964
        """
1955
2005
                             self.interface)
1956
2006
            else:
1957
2007
                try:
1958
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1959
 
                                           SO_BINDTODEVICE,
1960
 
                                           (self.interface + "\0")
1961
 
                                           .encode("utf-8"))
 
2008
                    self.socket.setsockopt(
 
2009
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2010
                        (self.interface + "\0").encode("utf-8"))
1962
2011
                except socket.error as error:
1963
2012
                    if error.errno == errno.EPERM:
1964
2013
                        logger.error("No permission to bind to"
1982
2031
                self.server_address = (any_address,
1983
2032
                                       self.server_address[1])
1984
2033
            elif not self.server_address[1]:
1985
 
                self.server_address = (self.server_address[0],
1986
 
                                       0)
 
2034
                self.server_address = (self.server_address[0], 0)
1987
2035
#                 if self.interface:
1988
2036
#                     self.server_address = (self.server_address[0],
1989
2037
#                                            0, # port
2003
2051
    
2004
2052
    Assumes a gobject.MainLoop event loop.
2005
2053
    """
 
2054
    
2006
2055
    def __init__(self, server_address, RequestHandlerClass,
2007
 
                 interface=None, use_ipv6=True, clients=None,
2008
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
2056
                 interface=None,
 
2057
                 use_ipv6=True,
 
2058
                 clients=None,
 
2059
                 gnutls_priority=None,
 
2060
                 use_dbus=True,
 
2061
                 socketfd=None):
2009
2062
        self.enabled = False
2010
2063
        self.clients = clients
2011
2064
        if self.clients is None:
2017
2070
                                interface = interface,
2018
2071
                                use_ipv6 = use_ipv6,
2019
2072
                                socketfd = socketfd)
 
2073
    
2020
2074
    def server_activate(self):
2021
2075
        if self.enabled:
2022
2076
            return socketserver.TCPServer.server_activate(self)
2026
2080
    
2027
2081
    def add_pipe(self, parent_pipe, proc):
2028
2082
        # Call "handle_ipc" for both data and EOF events
2029
 
        gobject.io_add_watch(parent_pipe.fileno(),
2030
 
                             gobject.IO_IN | gobject.IO_HUP,
2031
 
                             functools.partial(self.handle_ipc,
2032
 
                                               parent_pipe =
2033
 
                                               parent_pipe,
2034
 
                                               proc = proc))
 
2083
        gobject.io_add_watch(
 
2084
            parent_pipe.fileno(),
 
2085
            gobject.IO_IN | gobject.IO_HUP,
 
2086
            functools.partial(self.handle_ipc,
 
2087
                              parent_pipe = parent_pipe,
 
2088
                              proc = proc))
2035
2089
    
2036
 
    def handle_ipc(self, source, condition, parent_pipe=None,
2037
 
                   proc = None, client_object=None):
 
2090
    def handle_ipc(self, source, condition,
 
2091
                   parent_pipe=None,
 
2092
                   proc = None,
 
2093
                   client_object=None):
2038
2094
        # error, or the other end of multiprocessing.Pipe has closed
2039
2095
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2040
2096
            # Wait for other process to exit
2063
2119
                parent_pipe.send(False)
2064
2120
                return False
2065
2121
            
2066
 
            gobject.io_add_watch(parent_pipe.fileno(),
2067
 
                                 gobject.IO_IN | gobject.IO_HUP,
2068
 
                                 functools.partial(self.handle_ipc,
2069
 
                                                   parent_pipe =
2070
 
                                                   parent_pipe,
2071
 
                                                   proc = proc,
2072
 
                                                   client_object =
2073
 
                                                   client))
 
2122
            gobject.io_add_watch(
 
2123
                parent_pipe.fileno(),
 
2124
                gobject.IO_IN | gobject.IO_HUP,
 
2125
                functools.partial(self.handle_ipc,
 
2126
                                  parent_pipe = parent_pipe,
 
2127
                                  proc = proc,
 
2128
                                  client_object = client))
2074
2129
            parent_pipe.send(True)
2075
2130
            # remove the old hook in favor of the new above hook on
2076
2131
            # same fileno
2082
2137
            
2083
2138
            parent_pipe.send(('data', getattr(client_object,
2084
2139
                                              funcname)(*args,
2085
 
                                                         **kwargs)))
 
2140
                                                        **kwargs)))
2086
2141
        
2087
2142
        if command == 'getattr':
2088
2143
            attrname = request[1]
2089
 
            if callable(client_object.__getattribute__(attrname)):
2090
 
                parent_pipe.send(('function',))
 
2144
            if isinstance(client_object.__getattribute__(attrname),
 
2145
                          collections.Callable):
 
2146
                parent_pipe.send(('function', ))
2091
2147
            else:
2092
 
                parent_pipe.send(('data', client_object
2093
 
                                  .__getattribute__(attrname)))
 
2148
                parent_pipe.send((
 
2149
                    'data', client_object.__getattribute__(attrname)))
2094
2150
        
2095
2151
        if command == 'setattr':
2096
2152
            attrname = request[1]
2127
2183
    # avoid excessive use of external libraries.
2128
2184
    
2129
2185
    # New type for defining tokens, syntax, and semantics all-in-one
2130
 
    Token = collections.namedtuple("Token",
2131
 
                                   ("regexp", # To match token; if
2132
 
                                              # "value" is not None,
2133
 
                                              # must have a "group"
2134
 
                                              # containing digits
2135
 
                                    "value",  # datetime.timedelta or
2136
 
                                              # None
2137
 
                                    "followers")) # Tokens valid after
2138
 
                                                  # this token
 
2186
    Token = collections.namedtuple("Token", (
 
2187
        "regexp",  # To match token; if "value" is not None, must have
 
2188
                   # a "group" containing digits
 
2189
        "value",   # datetime.timedelta or None
 
2190
        "followers"))           # Tokens valid after this token
2139
2191
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2140
2192
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2141
2193
    token_end = Token(re.compile(r"$"), None, frozenset())
2142
2194
    token_second = Token(re.compile(r"(\d+)S"),
2143
2195
                         datetime.timedelta(seconds=1),
2144
 
                         frozenset((token_end,)))
 
2196
                         frozenset((token_end, )))
2145
2197
    token_minute = Token(re.compile(r"(\d+)M"),
2146
2198
                         datetime.timedelta(minutes=1),
2147
2199
                         frozenset((token_second, token_end)))
2163
2215
                       frozenset((token_month, token_end)))
2164
2216
    token_week = Token(re.compile(r"(\d+)W"),
2165
2217
                       datetime.timedelta(weeks=1),
2166
 
                       frozenset((token_end,)))
 
2218
                       frozenset((token_end, )))
2167
2219
    token_duration = Token(re.compile(r"P"), None,
2168
2220
                           frozenset((token_year, token_month,
2169
2221
                                      token_day, token_time,
2171
2223
    # Define starting values
2172
2224
    value = datetime.timedelta() # Value so far
2173
2225
    found_token = None
2174
 
    followers = frozenset((token_duration,)) # Following valid tokens
 
2226
    followers = frozenset((token_duration, )) # Following valid tokens
2175
2227
    s = duration                # String left to parse
2176
2228
    # Loop until end token is found
2177
2229
    while found_token is not token_end:
2194
2246
                break
2195
2247
        else:
2196
2248
            # No currently valid tokens were found
2197
 
            raise ValueError("Invalid RFC 3339 duration")
 
2249
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2250
                             .format(duration))
2198
2251
    # End token found
2199
2252
    return value
2200
2253
 
2237
2290
            elif suffix == "w":
2238
2291
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2239
2292
            else:
2240
 
                raise ValueError("Unknown suffix {!r}"
2241
 
                                 .format(suffix))
 
2293
                raise ValueError("Unknown suffix {!r}".format(suffix))
2242
2294
        except IndexError as e:
2243
2295
            raise ValueError(*(e.args))
2244
2296
        timevalue += delta
2260
2312
        # Close all standard open file descriptors
2261
2313
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2262
2314
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2263
 
            raise OSError(errno.ENODEV, "{} not a character device"
 
2315
            raise OSError(errno.ENODEV,
 
2316
                          "{} not a character device"
2264
2317
                          .format(os.devnull))
2265
2318
        os.dup2(null, sys.stdin.fileno())
2266
2319
        os.dup2(null, sys.stdout.fileno())
2332
2385
                        "port": "",
2333
2386
                        "debug": "False",
2334
2387
                        "priority":
2335
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2388
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2389
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2336
2390
                        "servicename": "Mandos",
2337
2391
                        "use_dbus": "True",
2338
2392
                        "use_ipv6": "True",
2342
2396
                        "statedir": "/var/lib/mandos",
2343
2397
                        "foreground": "False",
2344
2398
                        "zeroconf": "True",
2345
 
                        }
 
2399
                    }
2346
2400
    
2347
2401
    # Parse config file for server-global settings
2348
2402
    server_config = configparser.SafeConfigParser(server_defaults)
2349
2403
    del server_defaults
2350
 
    server_config.read(os.path.join(options.configdir,
2351
 
                                    "mandos.conf"))
 
2404
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2352
2405
    # Convert the SafeConfigParser object to a dict
2353
2406
    server_settings = server_config.defaults()
2354
2407
    # Use the appropriate methods on the non-string config options
2372
2425
    # Override the settings from the config file with command line
2373
2426
    # options, if set.
2374
2427
    for option in ("interface", "address", "port", "debug",
2375
 
                   "priority", "servicename", "configdir",
2376
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2377
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
2428
                   "priority", "servicename", "configdir", "use_dbus",
 
2429
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2430
                   "socket", "foreground", "zeroconf"):
2378
2431
        value = getattr(options, option)
2379
2432
        if value is not None:
2380
2433
            server_settings[option] = value
2395
2448
    
2396
2449
    ##################################################################
2397
2450
    
2398
 
    if (not server_settings["zeroconf"] and
2399
 
        not (server_settings["port"]
2400
 
             or server_settings["socket"] != "")):
2401
 
            parser.error("Needs port or socket to work without"
2402
 
                         " Zeroconf")
 
2451
    if (not server_settings["zeroconf"]
 
2452
        and not (server_settings["port"]
 
2453
                 or server_settings["socket"] != "")):
 
2454
        parser.error("Needs port or socket to work without Zeroconf")
2403
2455
    
2404
2456
    # For convenience
2405
2457
    debug = server_settings["debug"]
2421
2473
            initlogger(debug, level)
2422
2474
    
2423
2475
    if server_settings["servicename"] != "Mandos":
2424
 
        syslogger.setFormatter(logging.Formatter
2425
 
                               ('Mandos ({}) [%(process)d]:'
2426
 
                                ' %(levelname)s: %(message)s'
2427
 
                                .format(server_settings
2428
 
                                        ["servicename"])))
 
2476
        syslogger.setFormatter(
 
2477
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2478
                              ' %(levelname)s: %(message)s'.format(
 
2479
                                  server_settings["servicename"])))
2429
2480
    
2430
2481
    # Parse config file with clients
2431
2482
    client_config = configparser.SafeConfigParser(Client
2439
2490
    socketfd = None
2440
2491
    if server_settings["socket"] != "":
2441
2492
        socketfd = server_settings["socket"]
2442
 
    tcp_server = MandosServer((server_settings["address"],
2443
 
                               server_settings["port"]),
2444
 
                              ClientHandler,
2445
 
                              interface=(server_settings["interface"]
2446
 
                                         or None),
2447
 
                              use_ipv6=use_ipv6,
2448
 
                              gnutls_priority=
2449
 
                              server_settings["priority"],
2450
 
                              use_dbus=use_dbus,
2451
 
                              socketfd=socketfd)
 
2493
    tcp_server = MandosServer(
 
2494
        (server_settings["address"], server_settings["port"]),
 
2495
        ClientHandler,
 
2496
        interface=(server_settings["interface"] or None),
 
2497
        use_ipv6=use_ipv6,
 
2498
        gnutls_priority=server_settings["priority"],
 
2499
        use_dbus=use_dbus,
 
2500
        socketfd=socketfd)
2452
2501
    if not foreground:
2453
2502
        pidfilename = "/run/mandos.pid"
2454
2503
        if not os.path.isdir("/run/."):
2455
2504
            pidfilename = "/var/run/mandos.pid"
2456
2505
        pidfile = None
2457
2506
        try:
2458
 
            pidfile = open(pidfilename, "w")
 
2507
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2459
2508
        except IOError as e:
2460
2509
            logger.error("Could not open file %r", pidfilename,
2461
2510
                         exc_info=e)
2488
2537
        def debug_gnutls(level, string):
2489
2538
            logger.debug("GnuTLS: %s", string[:-1])
2490
2539
        
2491
 
        (gnutls.library.functions
2492
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2540
        gnutls.library.functions.gnutls_global_set_log_function(
 
2541
            debug_gnutls)
2493
2542
        
2494
2543
        # Redirect stdin so all checkers get /dev/null
2495
2544
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2515
2564
    if use_dbus:
2516
2565
        try:
2517
2566
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2518
 
                                            bus, do_not_queue=True)
2519
 
            old_bus_name = (dbus.service.BusName
2520
 
                            ("se.bsnet.fukt.Mandos", bus,
2521
 
                             do_not_queue=True))
2522
 
        except dbus.exceptions.NameExistsException as e:
 
2567
                                            bus,
 
2568
                                            do_not_queue=True)
 
2569
            old_bus_name = dbus.service.BusName(
 
2570
                "se.bsnet.fukt.Mandos", bus,
 
2571
                do_not_queue=True)
 
2572
        except dbus.exceptions.DBusException as e:
2523
2573
            logger.error("Disabling D-Bus:", exc_info=e)
2524
2574
            use_dbus = False
2525
2575
            server_settings["use_dbus"] = False
2526
2576
            tcp_server.use_dbus = False
2527
2577
    if zeroconf:
2528
2578
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2529
 
        service = AvahiServiceToSyslog(name =
2530
 
                                       server_settings["servicename"],
2531
 
                                       servicetype = "_mandos._tcp",
2532
 
                                       protocol = protocol, bus = bus)
 
2579
        service = AvahiServiceToSyslog(
 
2580
            name = server_settings["servicename"],
 
2581
            servicetype = "_mandos._tcp",
 
2582
            protocol = protocol,
 
2583
            bus = bus)
2533
2584
        if server_settings["interface"]:
2534
 
            service.interface = (if_nametoindex
2535
 
                                 (server_settings["interface"]
2536
 
                                  .encode("utf-8")))
 
2585
            service.interface = if_nametoindex(
 
2586
                server_settings["interface"].encode("utf-8"))
2537
2587
    
2538
2588
    global multiprocessing_manager
2539
2589
    multiprocessing_manager = multiprocessing.Manager()
2558
2608
    if server_settings["restore"]:
2559
2609
        try:
2560
2610
            with open(stored_state_path, "rb") as stored_state:
2561
 
                clients_data, old_client_settings = (pickle.load
2562
 
                                                     (stored_state))
 
2611
                clients_data, old_client_settings = pickle.load(
 
2612
                    stored_state)
2563
2613
            os.remove(stored_state_path)
2564
2614
        except IOError as e:
2565
2615
            if e.errno == errno.ENOENT:
2566
 
                logger.warning("Could not load persistent state: {}"
2567
 
                                .format(os.strerror(e.errno)))
 
2616
                logger.warning("Could not load persistent state:"
 
2617
                               " {}".format(os.strerror(e.errno)))
2568
2618
            else:
2569
2619
                logger.critical("Could not load persistent state:",
2570
2620
                                exc_info=e)
2571
2621
                raise
2572
2622
        except EOFError as e:
2573
2623
            logger.warning("Could not load persistent state: "
2574
 
                           "EOFError:", exc_info=e)
 
2624
                           "EOFError:",
 
2625
                           exc_info=e)
2575
2626
    
2576
2627
    with PGPEngine() as pgp:
2577
2628
        for client_name, client in clients_data.items():
2589
2640
                    # For each value in new config, check if it
2590
2641
                    # differs from the old config value (Except for
2591
2642
                    # the "secret" attribute)
2592
 
                    if (name != "secret" and
2593
 
                        value != old_client_settings[client_name]
2594
 
                        [name]):
 
2643
                    if (name != "secret"
 
2644
                        and (value !=
 
2645
                             old_client_settings[client_name][name])):
2595
2646
                        client[name] = value
2596
2647
                except KeyError:
2597
2648
                    pass
2598
2649
            
2599
2650
            # Clients who has passed its expire date can still be
2600
 
            # enabled if its last checker was successful.  Clients
 
2651
            # enabled if its last checker was successful.  A Client
2601
2652
            # whose checker succeeded before we stored its state is
2602
2653
            # assumed to have successfully run all checkers during
2603
2654
            # downtime.
2606
2657
                    if not client["last_checked_ok"]:
2607
2658
                        logger.warning(
2608
2659
                            "disabling client {} - Client never "
2609
 
                            "performed a successful checker"
2610
 
                            .format(client_name))
 
2660
                            "performed a successful checker".format(
 
2661
                                client_name))
2611
2662
                        client["enabled"] = False
2612
2663
                    elif client["last_checker_status"] != 0:
2613
2664
                        logger.warning(
2614
2665
                            "disabling client {} - Client last"
2615
 
                            " checker failed with error code {}"
2616
 
                            .format(client_name,
2617
 
                                    client["last_checker_status"]))
 
2666
                            " checker failed with error code"
 
2667
                            " {}".format(
 
2668
                                client_name,
 
2669
                                client["last_checker_status"]))
2618
2670
                        client["enabled"] = False
2619
2671
                    else:
2620
 
                        client["expires"] = (datetime.datetime
2621
 
                                             .utcnow()
2622
 
                                             + client["timeout"])
 
2672
                        client["expires"] = (
 
2673
                            datetime.datetime.utcnow()
 
2674
                            + client["timeout"])
2623
2675
                        logger.debug("Last checker succeeded,"
2624
 
                                     " keeping {} enabled"
2625
 
                                     .format(client_name))
 
2676
                                     " keeping {} enabled".format(
 
2677
                                         client_name))
2626
2678
            try:
2627
 
                client["secret"] = (
2628
 
                    pgp.decrypt(client["encrypted_secret"],
2629
 
                                client_settings[client_name]
2630
 
                                ["secret"]))
 
2679
                client["secret"] = pgp.decrypt(
 
2680
                    client["encrypted_secret"],
 
2681
                    client_settings[client_name]["secret"])
2631
2682
            except PGPError:
2632
2683
                # If decryption fails, we use secret from new settings
2633
 
                logger.debug("Failed to decrypt {} old secret"
2634
 
                             .format(client_name))
2635
 
                client["secret"] = (
2636
 
                    client_settings[client_name]["secret"])
 
2684
                logger.debug("Failed to decrypt {} old secret".format(
 
2685
                    client_name))
 
2686
                client["secret"] = (client_settings[client_name]
 
2687
                                    ["secret"])
2637
2688
    
2638
2689
    # Add/remove clients based on new changes made to config
2639
2690
    for client_name in (set(old_client_settings)
2646
2697
    # Create all client objects
2647
2698
    for client_name, client in clients_data.items():
2648
2699
        tcp_server.clients[client_name] = client_class(
2649
 
            name = client_name, settings = client,
 
2700
            name = client_name,
 
2701
            settings = client,
2650
2702
            server_settings = server_settings)
2651
2703
    
2652
2704
    if not tcp_server.clients:
2654
2706
    
2655
2707
    if not foreground:
2656
2708
        if pidfile is not None:
 
2709
            pid = os.getpid()
2657
2710
            try:
2658
2711
                with pidfile:
2659
 
                    pid = os.getpid()
2660
 
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
 
2712
                    print(pid, file=pidfile)
2661
2713
            except IOError:
2662
2714
                logger.error("Could not write to file %r with PID %d",
2663
2715
                             pidfilename, pid)
2668
2720
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2669
2721
    
2670
2722
    if use_dbus:
2671
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2672
 
                                        "se.bsnet.fukt.Mandos"})
 
2723
        
 
2724
        @alternate_dbus_interfaces(
 
2725
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2673
2726
        class MandosDBusService(DBusObjectWithProperties):
2674
2727
            """A D-Bus proxy object"""
 
2728
            
2675
2729
            def __init__(self):
2676
2730
                dbus.service.Object.__init__(self, bus, "/")
 
2731
            
2677
2732
            _interface = "se.recompile.Mandos"
2678
2733
            
2679
2734
            @dbus_interface_annotations(_interface)
2680
2735
            def _foo(self):
2681
 
                return { "org.freedesktop.DBus.Property"
2682
 
                         ".EmitsChangedSignal":
2683
 
                             "false"}
 
2736
                return {
 
2737
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2738
                    "false" }
2684
2739
            
2685
2740
            @dbus.service.signal(_interface, signature="o")
2686
2741
            def ClientAdded(self, objpath):
2700
2755
            @dbus.service.method(_interface, out_signature="ao")
2701
2756
            def GetAllClients(self):
2702
2757
                "D-Bus method"
2703
 
                return dbus.Array(c.dbus_object_path
2704
 
                                  for c in
 
2758
                return dbus.Array(c.dbus_object_path for c in
2705
2759
                                  tcp_server.clients.itervalues())
2706
2760
            
2707
2761
            @dbus.service.method(_interface,
2709
2763
            def GetAllClientsWithProperties(self):
2710
2764
                "D-Bus method"
2711
2765
                return dbus.Dictionary(
2712
 
                    ((c.dbus_object_path, c.GetAll(""))
2713
 
                     for c in tcp_server.clients.itervalues()),
 
2766
                    { c.dbus_object_path: c.GetAll("")
 
2767
                      for c in tcp_server.clients.itervalues() },
2714
2768
                    signature="oa{sv}")
2715
2769
            
2716
2770
            @dbus.service.method(_interface, in_signature="o")
2756
2810
                # + secret.
2757
2811
                exclude = { "bus", "changedstate", "secret",
2758
2812
                            "checker", "server_settings" }
2759
 
                for name, typ in (inspect.getmembers
2760
 
                                  (dbus.service.Object)):
 
2813
                for name, typ in inspect.getmembers(dbus.service
 
2814
                                                    .Object):
2761
2815
                    exclude.add(name)
2762
2816
                
2763
2817
                client_dict["encrypted_secret"] = (client
2770
2824
                del client_settings[client.name]["secret"]
2771
2825
        
2772
2826
        try:
2773
 
            with (tempfile.NamedTemporaryFile
2774
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2775
 
                   dir=os.path.dirname(stored_state_path),
2776
 
                   delete=False)) as stored_state:
 
2827
            with tempfile.NamedTemporaryFile(
 
2828
                    mode='wb',
 
2829
                    suffix=".pickle",
 
2830
                    prefix='clients-',
 
2831
                    dir=os.path.dirname(stored_state_path),
 
2832
                    delete=False) as stored_state:
2777
2833
                pickle.dump((clients, client_settings), stored_state)
2778
 
                tempname=stored_state.name
 
2834
                tempname = stored_state.name
2779
2835
            os.rename(tempname, stored_state_path)
2780
2836
        except (IOError, OSError) as e:
2781
2837
            if not debug:
2800
2856
            client.disable(quiet=True)
2801
2857
            if use_dbus:
2802
2858
                # Emit D-Bus signal
2803
 
                mandos_dbus_service.ClientRemoved(client
2804
 
                                                  .dbus_object_path,
2805
 
                                                  client.name)
 
2859
                mandos_dbus_service.ClientRemoved(
 
2860
                    client.dbus_object_path, client.name)
2806
2861
        client_settings.clear()
2807
2862
    
2808
2863
    atexit.register(cleanup)
2861
2916
    # Must run before the D-Bus bus name gets deregistered
2862
2917
    cleanup()
2863
2918
 
 
2919
 
2864
2920
if __name__ == '__main__':
2865
2921
    main()