/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2012 Teddy Hogeborn
15
 
# Copyright © 2008-2012 Björn Påhlsson
 
14
# Copyright © 2008-2014 Teddy Hogeborn
 
15
# Copyright © 2008-2014 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
 
37
from future_builtins import *
 
38
 
37
39
import SocketServer as socketserver
38
40
import socket
39
41
import argparse
66
68
import binascii
67
69
import tempfile
68
70
import itertools
 
71
import collections
69
72
 
70
73
import dbus
71
74
import dbus.service
76
79
import ctypes.util
77
80
import xml.dom.minidom
78
81
import inspect
79
 
import GnuPGInterface
80
82
 
81
83
try:
82
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
86
88
    except ImportError:
87
89
        SO_BINDTODEVICE = None
88
90
 
89
 
version = "1.5.3"
 
91
version = "1.6.6"
90
92
stored_state_file = "clients.pickle"
91
93
 
92
94
logger = logging.getLogger()
93
 
syslogger = (logging.handlers.SysLogHandler
94
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
 
              address = str("/dev/log")))
 
95
syslogger = None
96
96
 
97
97
try:
98
98
    if_nametoindex = (ctypes.cdll.LoadLibrary
114
114
def initlogger(debug, level=logging.WARNING):
115
115
    """init logger and add loglevel"""
116
116
    
 
117
    global syslogger
 
118
    syslogger = (logging.handlers.SysLogHandler
 
119
                 (facility =
 
120
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
121
                  address = str("/dev/log")))
117
122
    syslogger.setFormatter(logging.Formatter
118
123
                           ('Mandos [%(process)d]: %(levelname)s:'
119
124
                            ' %(message)s'))
137
142
class PGPEngine(object):
138
143
    """A simple class for OpenPGP symmetric encryption & decryption"""
139
144
    def __init__(self):
140
 
        self.gnupg = GnuPGInterface.GnuPG()
141
145
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
142
 
        self.gnupg = GnuPGInterface.GnuPG()
143
 
        self.gnupg.options.meta_interactive = False
144
 
        self.gnupg.options.homedir = self.tempdir
145
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
146
 
                                              '--quiet',
147
 
                                              '--no-use-agent'])
 
146
        self.gnupgargs = ['--batch',
 
147
                          '--home', self.tempdir,
 
148
                          '--force-mdc',
 
149
                          '--quiet',
 
150
                          '--no-use-agent']
148
151
    
149
152
    def __enter__(self):
150
153
        return self
151
154
    
152
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
155
    def __exit__(self, exc_type, exc_value, traceback):
153
156
        self._cleanup()
154
157
        return False
155
158
    
172
175
    def password_encode(self, password):
173
176
        # Passphrase can not be empty and can not contain newlines or
174
177
        # NUL bytes.  So we prefix it and hex encode it.
175
 
        return b"mandos" + binascii.hexlify(password)
 
178
        encoded = b"mandos" + binascii.hexlify(password)
 
179
        if len(encoded) > 2048:
 
180
            # GnuPG can't handle long passwords, so encode differently
 
181
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
182
                       .replace(b"\n", b"\\n")
 
183
                       .replace(b"\0", b"\\x00"))
 
184
        return encoded
176
185
    
177
186
    def encrypt(self, data, password):
178
 
        self.gnupg.passphrase = self.password_encode(password)
179
 
        with open(os.devnull, "w") as devnull:
180
 
            try:
181
 
                proc = self.gnupg.run(['--symmetric'],
182
 
                                      create_fhs=['stdin', 'stdout'],
183
 
                                      attach_fhs={'stderr': devnull})
184
 
                with contextlib.closing(proc.handles['stdin']) as f:
185
 
                    f.write(data)
186
 
                with contextlib.closing(proc.handles['stdout']) as f:
187
 
                    ciphertext = f.read()
188
 
                proc.wait()
189
 
            except IOError as e:
190
 
                raise PGPError(e)
191
 
        self.gnupg.passphrase = None
 
187
        passphrase = self.password_encode(password)
 
188
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
189
                                         ) as passfile:
 
190
            passfile.write(passphrase)
 
191
            passfile.flush()
 
192
            proc = subprocess.Popen(['gpg', '--symmetric',
 
193
                                     '--passphrase-file',
 
194
                                     passfile.name]
 
195
                                    + self.gnupgargs,
 
196
                                    stdin = subprocess.PIPE,
 
197
                                    stdout = subprocess.PIPE,
 
198
                                    stderr = subprocess.PIPE)
 
199
            ciphertext, err = proc.communicate(input = data)
 
200
        if proc.returncode != 0:
 
201
            raise PGPError(err)
192
202
        return ciphertext
193
203
    
194
204
    def decrypt(self, data, password):
195
 
        self.gnupg.passphrase = self.password_encode(password)
196
 
        with open(os.devnull, "w") as devnull:
197
 
            try:
198
 
                proc = self.gnupg.run(['--decrypt'],
199
 
                                      create_fhs=['stdin', 'stdout'],
200
 
                                      attach_fhs={'stderr': devnull})
201
 
                with contextlib.closing(proc.handles['stdin']) as f:
202
 
                    f.write(data)
203
 
                with contextlib.closing(proc.handles['stdout']) as f:
204
 
                    decrypted_plaintext = f.read()
205
 
                proc.wait()
206
 
            except IOError as e:
207
 
                raise PGPError(e)
208
 
        self.gnupg.passphrase = None
 
205
        passphrase = self.password_encode(password)
 
206
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
207
                                         ) as passfile:
 
208
            passfile.write(passphrase)
 
209
            passfile.flush()
 
210
            proc = subprocess.Popen(['gpg', '--decrypt',
 
211
                                     '--passphrase-file',
 
212
                                     passfile.name]
 
213
                                    + self.gnupgargs,
 
214
                                    stdin = subprocess.PIPE,
 
215
                                    stdout = subprocess.PIPE,
 
216
                                    stderr = subprocess.PIPE)
 
217
            decrypted_plaintext, err = proc.communicate(input
 
218
                                                        = data)
 
219
        if proc.returncode != 0:
 
220
            raise PGPError(err)
209
221
        return decrypted_plaintext
210
222
 
211
223
 
212
 
 
213
224
class AvahiError(Exception):
214
225
    def __init__(self, value, *args, **kwargs):
215
226
        self.value = value
232
243
               Used to optionally bind to the specified interface.
233
244
    name: string; Example: 'Mandos'
234
245
    type: string; Example: '_mandos._tcp'.
235
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
246
     See <https://www.iana.org/assignments/service-names-port-numbers>
236
247
    port: integer; what port to announce
237
248
    TXT: list of strings; TXT record for the service
238
249
    domain: string; Domain to publish on, default to .local if empty.
244
255
    server: D-Bus Server
245
256
    bus: dbus.SystemBus()
246
257
    """
 
258
    
247
259
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
248
260
                 servicetype = None, port = None, TXT = None,
249
261
                 domain = "", host = "", max_renames = 32768,
262
274
        self.server = None
263
275
        self.bus = bus
264
276
        self.entry_group_state_changed_match = None
 
277
    
265
278
    def rename(self):
266
279
        """Derived from the Avahi example code"""
267
280
        if self.rename_count >= self.max_renames:
281
294
            self.cleanup()
282
295
            os._exit(1)
283
296
        self.rename_count += 1
 
297
    
284
298
    def remove(self):
285
299
        """Derived from the Avahi example code"""
286
300
        if self.entry_group_state_changed_match is not None:
288
302
            self.entry_group_state_changed_match = None
289
303
        if self.group is not None:
290
304
            self.group.Reset()
 
305
    
291
306
    def add(self):
292
307
        """Derived from the Avahi example code"""
293
308
        self.remove()
310
325
            dbus.UInt16(self.port),
311
326
            avahi.string_array_to_txt_array(self.TXT))
312
327
        self.group.Commit()
 
328
    
313
329
    def entry_group_state_changed(self, state, error):
314
330
        """Derived from the Avahi example code"""
315
331
        logger.debug("Avahi entry group state change: %i", state)
322
338
        elif state == avahi.ENTRY_GROUP_FAILURE:
323
339
            logger.critical("Avahi: Error in group state changed %s",
324
340
                            unicode(error))
325
 
            raise AvahiGroupError("State changed: %s"
326
 
                                  % unicode(error))
 
341
            raise AvahiGroupError("State changed: {0!s}"
 
342
                                  .format(error))
 
343
    
327
344
    def cleanup(self):
328
345
        """Derived from the Avahi example code"""
329
346
        if self.group is not None:
334
351
                pass
335
352
            self.group = None
336
353
        self.remove()
 
354
    
337
355
    def server_state_changed(self, state, error=None):
338
356
        """Derived from the Avahi example code"""
339
357
        logger.debug("Avahi server state change: %i", state)
358
376
                logger.debug("Unknown state: %r", state)
359
377
            else:
360
378
                logger.debug("Unknown state: %r: %r", state, error)
 
379
    
361
380
    def activate(self):
362
381
        """Derived from the Avahi example code"""
363
382
        if self.server is None:
370
389
                                 self.server_state_changed)
371
390
        self.server_state_changed(self.server.GetState())
372
391
 
 
392
 
373
393
class AvahiServiceToSyslog(AvahiService):
374
394
    def rename(self):
375
395
        """Add the new name to the syslog messages"""
376
396
        ret = AvahiService.rename(self)
377
397
        syslogger.setFormatter(logging.Formatter
378
 
                               ('Mandos (%s) [%%(process)d]:'
379
 
                                ' %%(levelname)s: %%(message)s'
380
 
                                % self.name))
 
398
                               ('Mandos ({0}) [%(process)d]:'
 
399
                                ' %(levelname)s: %(message)s'
 
400
                                .format(self.name)))
381
401
        return ret
382
402
 
 
403
 
383
404
def timedelta_to_milliseconds(td):
384
405
    "Convert a datetime.timedelta() to milliseconds"
385
406
    return ((td.days * 24 * 60 * 60 * 1000)
386
407
            + (td.seconds * 1000)
387
408
            + (td.microseconds // 1000))
388
 
        
 
409
 
 
410
 
389
411
class Client(object):
390
412
    """A representation of a client host served by this server.
391
413
    
427
449
    runtime_expansions: Allowed attributes for runtime expansion.
428
450
    expires:    datetime.datetime(); time (UTC) when a client will be
429
451
                disabled, or None
 
452
    server_settings: The server_settings dict from main()
430
453
    """
431
454
    
432
455
    runtime_expansions = ("approval_delay", "approval_duration",
433
 
                          "created", "enabled", "fingerprint",
434
 
                          "host", "interval", "last_checked_ok",
 
456
                          "created", "enabled", "expires",
 
457
                          "fingerprint", "host", "interval",
 
458
                          "last_approval_request", "last_checked_ok",
435
459
                          "last_enabled", "name", "timeout")
436
 
    client_defaults = { "timeout": "5m",
437
 
                        "extended_timeout": "15m",
438
 
                        "interval": "2m",
 
460
    client_defaults = { "timeout": "PT5M",
 
461
                        "extended_timeout": "PT15M",
 
462
                        "interval": "PT2M",
439
463
                        "checker": "fping -q -- %%(host)s",
440
464
                        "host": "",
441
 
                        "approval_delay": "0s",
442
 
                        "approval_duration": "1s",
 
465
                        "approval_delay": "PT0S",
 
466
                        "approval_duration": "PT1S",
443
467
                        "approved_by_default": "True",
444
468
                        "enabled": "True",
445
469
                        }
458
482
    
459
483
    def approval_delay_milliseconds(self):
460
484
        return timedelta_to_milliseconds(self.approval_delay)
461
 
 
 
485
    
462
486
    @staticmethod
463
487
    def config_parser(config):
464
488
        """Construct a new dict of client settings of this form:
489
513
                          "rb") as secfile:
490
514
                    client["secret"] = secfile.read()
491
515
            else:
492
 
                raise TypeError("No secret or secfile for section %s"
493
 
                                % section)
 
516
                raise TypeError("No secret or secfile for section {0}"
 
517
                                .format(section))
494
518
            client["timeout"] = string_to_delta(section["timeout"])
495
519
            client["extended_timeout"] = string_to_delta(
496
520
                section["extended_timeout"])
505
529
            client["last_checker_status"] = -2
506
530
        
507
531
        return settings
508
 
        
509
 
        
510
 
    def __init__(self, settings, name = None):
511
 
        """Note: the 'checker' key in 'config' sets the
512
 
        'checker_command' attribute and *not* the 'checker'
513
 
        attribute."""
 
532
    
 
533
    def __init__(self, settings, name = None, server_settings=None):
514
534
        self.name = name
 
535
        if server_settings is None:
 
536
            server_settings = {}
 
537
        self.server_settings = server_settings
515
538
        # adding all client settings
516
539
        for setting, value in settings.iteritems():
517
540
            setattr(self, setting, value)
525
548
        else:
526
549
            self.last_enabled = None
527
550
            self.expires = None
528
 
       
 
551
        
529
552
        logger.debug("Creating client %r", self.name)
530
553
        # Uppercase and remove spaces from fingerprint for later
531
554
        # comparison purposes with return value from the fingerprint()
533
556
        logger.debug("  Fingerprint: %s", self.fingerprint)
534
557
        self.created = settings.get("created",
535
558
                                    datetime.datetime.utcnow())
536
 
 
 
559
        
537
560
        # attributes specific for this server instance
538
561
        self.checker = None
539
562
        self.checker_initiator_tag = None
567
590
        if getattr(self, "enabled", False):
568
591
            # Already enabled
569
592
            return
570
 
        self.send_changedstate()
571
593
        self.expires = datetime.datetime.utcnow() + self.timeout
572
594
        self.enabled = True
573
595
        self.last_enabled = datetime.datetime.utcnow()
574
596
        self.init_checker()
 
597
        self.send_changedstate()
575
598
    
576
599
    def disable(self, quiet=True):
577
600
        """Disable this client."""
578
601
        if not getattr(self, "enabled", False):
579
602
            return False
580
603
        if not quiet:
581
 
            self.send_changedstate()
582
 
        if not quiet:
583
604
            logger.info("Disabling client %s", self.name)
584
 
        if getattr(self, "disable_initiator_tag", False):
 
605
        if getattr(self, "disable_initiator_tag", None) is not None:
585
606
            gobject.source_remove(self.disable_initiator_tag)
586
607
            self.disable_initiator_tag = None
587
608
        self.expires = None
588
 
        if getattr(self, "checker_initiator_tag", False):
 
609
        if getattr(self, "checker_initiator_tag", None) is not None:
589
610
            gobject.source_remove(self.checker_initiator_tag)
590
611
            self.checker_initiator_tag = None
591
612
        self.stop_checker()
592
613
        self.enabled = False
 
614
        if not quiet:
 
615
            self.send_changedstate()
593
616
        # Do not run this again if called by a gobject.timeout_add
594
617
        return False
595
618
    
599
622
    def init_checker(self):
600
623
        # Schedule a new checker to be started an 'interval' from now,
601
624
        # and every interval from then on.
 
625
        if self.checker_initiator_tag is not None:
 
626
            gobject.source_remove(self.checker_initiator_tag)
602
627
        self.checker_initiator_tag = (gobject.timeout_add
603
628
                                      (self.interval_milliseconds(),
604
629
                                       self.start_checker))
605
630
        # Schedule a disable() when 'timeout' has passed
 
631
        if self.disable_initiator_tag is not None:
 
632
            gobject.source_remove(self.disable_initiator_tag)
606
633
        self.disable_initiator_tag = (gobject.timeout_add
607
634
                                   (self.timeout_milliseconds(),
608
635
                                    self.disable))
639
666
            timeout = self.timeout
640
667
        if self.disable_initiator_tag is not None:
641
668
            gobject.source_remove(self.disable_initiator_tag)
 
669
            self.disable_initiator_tag = None
642
670
        if getattr(self, "enabled", False):
643
671
            self.disable_initiator_tag = (gobject.timeout_add
644
672
                                          (timedelta_to_milliseconds
654
682
        If a checker already exists, leave it running and do
655
683
        nothing."""
656
684
        # The reason for not killing a running checker is that if we
657
 
        # did that, then if a checker (for some reason) started
658
 
        # running slowly and taking more than 'interval' time, the
659
 
        # client would inevitably timeout, since no checker would get
660
 
        # a chance to run to completion.  If we instead leave running
 
685
        # did that, and if a checker (for some reason) started running
 
686
        # slowly and taking more than 'interval' time, then the client
 
687
        # would inevitably timeout, since no checker would get a
 
688
        # chance to run to completion.  If we instead leave running
661
689
        # checkers alone, the checker would have to take more time
662
690
        # than 'timeout' for the client to be disabled, which is as it
663
691
        # should be.
665
693
        # If a checker exists, make sure it is not a zombie
666
694
        try:
667
695
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
668
 
        except (AttributeError, OSError) as error:
669
 
            if (isinstance(error, OSError)
670
 
                and error.errno != errno.ECHILD):
671
 
                raise error
 
696
        except AttributeError:
 
697
            pass
 
698
        except OSError as error:
 
699
            if error.errno != errno.ECHILD:
 
700
                raise
672
701
        else:
673
702
            if pid:
674
703
                logger.warning("Checker was a zombie")
677
706
                                      self.current_checker_command)
678
707
        # Start a new checker if needed
679
708
        if self.checker is None:
 
709
            # Escape attributes for the shell
 
710
            escaped_attrs = dict(
 
711
                (attr, re.escape(unicode(getattr(self, attr))))
 
712
                for attr in
 
713
                self.runtime_expansions)
680
714
            try:
681
 
                # In case checker_command has exactly one % operator
682
 
                command = self.checker_command % self.host
683
 
            except TypeError:
684
 
                # Escape attributes for the shell
685
 
                escaped_attrs = dict(
686
 
                    (attr,
687
 
                     re.escape(unicode(str(getattr(self, attr, "")),
688
 
                                       errors=
689
 
                                       'replace')))
690
 
                    for attr in
691
 
                    self.runtime_expansions)
692
 
                
693
 
                try:
694
 
                    command = self.checker_command % escaped_attrs
695
 
                except TypeError as error:
696
 
                    logger.error('Could not format string "%s"',
697
 
                                 self.checker_command, exc_info=error)
698
 
                    return True # Try again later
 
715
                command = self.checker_command % escaped_attrs
 
716
            except TypeError as error:
 
717
                logger.error('Could not format string "%s"',
 
718
                             self.checker_command, exc_info=error)
 
719
                return True # Try again later
699
720
            self.current_checker_command = command
700
721
            try:
701
722
                logger.info("Starting checker %r for %s",
704
725
                # in normal mode, that is already done by daemon(),
705
726
                # and in debug mode we don't want to.  (Stdin is
706
727
                # always replaced by /dev/null.)
 
728
                # The exception is when not debugging but nevertheless
 
729
                # running in the foreground; use the previously
 
730
                # created wnull.
 
731
                popen_args = {}
 
732
                if (not self.server_settings["debug"]
 
733
                    and self.server_settings["foreground"]):
 
734
                    popen_args.update({"stdout": wnull,
 
735
                                       "stderr": wnull })
707
736
                self.checker = subprocess.Popen(command,
708
737
                                                close_fds=True,
709
 
                                                shell=True, cwd="/")
710
 
                self.checker_callback_tag = (gobject.child_watch_add
711
 
                                             (self.checker.pid,
712
 
                                              self.checker_callback,
713
 
                                              data=command))
714
 
                # The checker may have completed before the gobject
715
 
                # watch was added.  Check for this.
716
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
717
 
                if pid:
718
 
                    gobject.source_remove(self.checker_callback_tag)
719
 
                    self.checker_callback(pid, status, command)
 
738
                                                shell=True, cwd="/",
 
739
                                                **popen_args)
720
740
            except OSError as error:
721
741
                logger.error("Failed to start subprocess",
722
742
                             exc_info=error)
 
743
                return True
 
744
            self.checker_callback_tag = (gobject.child_watch_add
 
745
                                         (self.checker.pid,
 
746
                                          self.checker_callback,
 
747
                                          data=command))
 
748
            # The checker may have completed before the gobject
 
749
            # watch was added.  Check for this.
 
750
            try:
 
751
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
752
            except OSError as error:
 
753
                if error.errno == errno.ECHILD:
 
754
                    # This should never happen
 
755
                    logger.error("Child process vanished",
 
756
                                 exc_info=error)
 
757
                    return True
 
758
                raise
 
759
            if pid:
 
760
                gobject.source_remove(self.checker_callback_tag)
 
761
                self.checker_callback(pid, status, command)
723
762
        # Re-run this periodically if run by gobject.timeout_add
724
763
        return True
725
764
    
758
797
    # "Set" method, so we fail early here:
759
798
    if byte_arrays and signature != "ay":
760
799
        raise ValueError("Byte arrays not supported for non-'ay'"
761
 
                         " signature %r" % signature)
 
800
                         " signature {0!r}".format(signature))
762
801
    def decorator(func):
763
802
        func._dbus_is_property = True
764
803
        func._dbus_interface = dbus_interface
773
812
 
774
813
 
775
814
def dbus_interface_annotations(dbus_interface):
776
 
    """Decorator for marking functions returning interface annotations.
 
815
    """Decorator for marking functions returning interface annotations
777
816
    
778
817
    Usage:
779
818
    
898
937
            # The byte_arrays option is not supported yet on
899
938
            # signatures other than "ay".
900
939
            if prop._dbus_signature != "ay":
901
 
                raise ValueError
 
940
                raise ValueError("Byte arrays not supported for non-"
 
941
                                 "'ay' signature {0!r}"
 
942
                                 .format(prop._dbus_signature))
902
943
            value = dbus.ByteArray(b''.join(chr(byte)
903
944
                                            for byte in value))
904
945
        prop(value)
976
1017
                            tag.appendChild(ann_tag)
977
1018
                # Add interface annotation tags
978
1019
                for annotation, value in dict(
979
 
                    itertools.chain(
980
 
                        *(annotations().iteritems()
981
 
                          for name, annotations in
982
 
                          self._get_all_dbus_things("interface")
983
 
                          if name == if_tag.getAttribute("name")
984
 
                          ))).iteritems():
 
1020
                    itertools.chain.from_iterable(
 
1021
                        annotations().iteritems()
 
1022
                        for name, annotations in
 
1023
                        self._get_all_dbus_things("interface")
 
1024
                        if name == if_tag.getAttribute("name")
 
1025
                        )).iteritems():
985
1026
                    ann_tag = document.createElement("annotation")
986
1027
                    ann_tag.setAttribute("name", annotation)
987
1028
                    ann_tag.setAttribute("value", value)
1010
1051
        return xmlstring
1011
1052
 
1012
1053
 
1013
 
def datetime_to_dbus (dt, variant_level=0):
 
1054
def datetime_to_dbus(dt, variant_level=0):
1014
1055
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1015
1056
    if dt is None:
1016
1057
        return dbus.String("", variant_level = variant_level)
1018
1059
                       variant_level=variant_level)
1019
1060
 
1020
1061
 
1021
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
1022
 
                                  .__metaclass__):
1023
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
1024
 
    will add additional D-Bus attributes matching a certain pattern.
 
1062
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1063
    """A class decorator; applied to a subclass of
 
1064
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1065
    interface names according to the "alt_interface_names" mapping.
 
1066
    Usage:
 
1067
    
 
1068
    @alternate_dbus_interfaces({"org.example.Interface":
 
1069
                                    "net.example.AlternateInterface"})
 
1070
    class SampleDBusObject(dbus.service.Object):
 
1071
        @dbus.service.method("org.example.Interface")
 
1072
        def SampleDBusMethod():
 
1073
            pass
 
1074
    
 
1075
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1076
    reachable via two interfaces: "org.example.Interface" and
 
1077
    "net.example.AlternateInterface", the latter of which will have
 
1078
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1079
    "true", unless "deprecate" is passed with a False value.
 
1080
    
 
1081
    This works for methods and signals, and also for D-Bus properties
 
1082
    (from DBusObjectWithProperties) and interfaces (from the
 
1083
    dbus_interface_annotations decorator).
1025
1084
    """
1026
 
    def __new__(mcs, name, bases, attr):
1027
 
        # Go through all the base classes which could have D-Bus
1028
 
        # methods, signals, or properties in them
1029
 
        old_interface_names = []
1030
 
        for base in (b for b in bases
1031
 
                     if issubclass(b, dbus.service.Object)):
1032
 
            # Go though all attributes of the base class
1033
 
            for attrname, attribute in inspect.getmembers(base):
 
1085
    def wrapper(cls):
 
1086
        for orig_interface_name, alt_interface_name in (
 
1087
            alt_interface_names.iteritems()):
 
1088
            attr = {}
 
1089
            interface_names = set()
 
1090
            # Go though all attributes of the class
 
1091
            for attrname, attribute in inspect.getmembers(cls):
1034
1092
                # Ignore non-D-Bus attributes, and D-Bus attributes
1035
1093
                # with the wrong interface name
1036
1094
                if (not hasattr(attribute, "_dbus_interface")
1037
1095
                    or not attribute._dbus_interface
1038
 
                    .startswith("se.recompile.Mandos")):
 
1096
                    .startswith(orig_interface_name)):
1039
1097
                    continue
1040
1098
                # Create an alternate D-Bus interface name based on
1041
1099
                # the current name
1042
1100
                alt_interface = (attribute._dbus_interface
1043
 
                                 .replace("se.recompile.Mandos",
1044
 
                                          "se.bsnet.fukt.Mandos"))
1045
 
                if alt_interface != attribute._dbus_interface:
1046
 
                    old_interface_names.append(alt_interface)
 
1101
                                 .replace(orig_interface_name,
 
1102
                                          alt_interface_name))
 
1103
                interface_names.add(alt_interface)
1047
1104
                # Is this a D-Bus signal?
1048
1105
                if getattr(attribute, "_dbus_is_signal", False):
1049
 
                    # Extract the original non-method function by
1050
 
                    # black magic
 
1106
                    # Extract the original non-method undecorated
 
1107
                    # function by black magic
1051
1108
                    nonmethod_func = (dict(
1052
1109
                            zip(attribute.func_code.co_freevars,
1053
1110
                                attribute.__closure__))["func"]
1071
1128
                    except AttributeError:
1072
1129
                        pass
1073
1130
                    # Define a creator of a function to call both the
1074
 
                    # old and new functions, so both the old and new
1075
 
                    # signals gets sent when the function is called
 
1131
                    # original and alternate functions, so both the
 
1132
                    # original and alternate signals gets sent when
 
1133
                    # the function is called
1076
1134
                    def fixscope(func1, func2):
1077
1135
                        """This function is a scope container to pass
1078
1136
                        func1 and func2 to the "call_both" function
1085
1143
                        return call_both
1086
1144
                    # Create the "call_both" function and add it to
1087
1145
                    # the class
1088
 
                    attr[attrname] = fixscope(attribute,
1089
 
                                              new_function)
 
1146
                    attr[attrname] = fixscope(attribute, new_function)
1090
1147
                # Is this a D-Bus method?
1091
1148
                elif getattr(attribute, "_dbus_is_method", False):
1092
1149
                    # Create a new, but exactly alike, function
1148
1205
                                        attribute.func_name,
1149
1206
                                        attribute.func_defaults,
1150
1207
                                        attribute.func_closure)))
1151
 
        # Deprecate all old interfaces
1152
 
        basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"
1153
 
        for old_interface_name in old_interface_names:
1154
 
            @dbus_interface_annotations(old_interface_name)
1155
 
            def func(self):
1156
 
                return { "org.freedesktop.DBus.Deprecated": "true" }
1157
 
            # Find an unused name
1158
 
            for aname in (basename.format(i) for i in
1159
 
                          itertools.count()):
1160
 
                if aname not in attr:
1161
 
                    attr[aname] = func
1162
 
                    break
1163
 
        return type.__new__(mcs, name, bases, attr)
1164
 
 
1165
 
 
 
1208
            if deprecate:
 
1209
                # Deprecate all alternate interfaces
 
1210
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1211
                for interface_name in interface_names:
 
1212
                    @dbus_interface_annotations(interface_name)
 
1213
                    def func(self):
 
1214
                        return { "org.freedesktop.DBus.Deprecated":
 
1215
                                     "true" }
 
1216
                    # Find an unused name
 
1217
                    for aname in (iname.format(i)
 
1218
                                  for i in itertools.count()):
 
1219
                        if aname not in attr:
 
1220
                            attr[aname] = func
 
1221
                            break
 
1222
            if interface_names:
 
1223
                # Replace the class with a new subclass of it with
 
1224
                # methods, signals, etc. as created above.
 
1225
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1226
                           (cls,), attr)
 
1227
        return cls
 
1228
    return wrapper
 
1229
 
 
1230
 
 
1231
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1232
                                "se.bsnet.fukt.Mandos"})
1166
1233
class ClientDBus(Client, DBusObjectWithProperties):
1167
1234
    """A Client class using D-Bus
1168
1235
    
1188
1255
                                 ("/clients/" + client_object_name))
1189
1256
        DBusObjectWithProperties.__init__(self, self.bus,
1190
1257
                                          self.dbus_object_path)
1191
 
        
 
1258
    
1192
1259
    def notifychangeproperty(transform_func,
1193
1260
                             dbus_name, type_func=lambda x: x,
1194
1261
                             variant_level=1):
1217
1284
        
1218
1285
        return property(lambda self: getattr(self, attrname), setter)
1219
1286
    
1220
 
    
1221
1287
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1222
1288
    approvals_pending = notifychangeproperty(dbus.Boolean,
1223
1289
                                             "ApprovalPending",
1287
1353
                                       *args, **kwargs)
1288
1354
    
1289
1355
    def start_checker(self, *args, **kwargs):
1290
 
        old_checker = self.checker
1291
 
        if self.checker is not None:
1292
 
            old_checker_pid = self.checker.pid
1293
 
        else:
1294
 
            old_checker_pid = None
 
1356
        old_checker_pid = getattr(self.checker, "pid", None)
1295
1357
        r = Client.start_checker(self, *args, **kwargs)
1296
1358
        # Only if new checker process was started
1297
1359
        if (self.checker is not None
1305
1367
        return False
1306
1368
    
1307
1369
    def approve(self, value=True):
1308
 
        self.send_changedstate()
1309
1370
        self.approved = value
1310
1371
        gobject.timeout_add(timedelta_to_milliseconds
1311
1372
                            (self.approval_duration),
1312
1373
                            self._reset_approved)
1313
 
    
 
1374
        self.send_changedstate()
1314
1375
    
1315
1376
    ## D-Bus methods, signals & properties
1316
1377
    _interface = "se.recompile.Mandos.Client"
1500
1561
    def Timeout_dbus_property(self, value=None):
1501
1562
        if value is None:       # get
1502
1563
            return dbus.UInt64(self.timeout_milliseconds())
 
1564
        old_timeout = self.timeout
1503
1565
        self.timeout = datetime.timedelta(0, 0, 0, value)
1504
 
        # Reschedule timeout
 
1566
        # Reschedule disabling
1505
1567
        if self.enabled:
1506
1568
            now = datetime.datetime.utcnow()
1507
 
            time_to_die = timedelta_to_milliseconds(
1508
 
                (self.last_checked_ok + self.timeout) - now)
1509
 
            if time_to_die <= 0:
 
1569
            self.expires += self.timeout - old_timeout
 
1570
            if self.expires <= now:
1510
1571
                # The timeout has passed
1511
1572
                self.disable()
1512
1573
            else:
1513
 
                self.expires = (now +
1514
 
                                datetime.timedelta(milliseconds =
1515
 
                                                   time_to_die))
1516
1574
                if (getattr(self, "disable_initiator_tag", None)
1517
1575
                    is None):
1518
1576
                    return
1519
1577
                gobject.source_remove(self.disable_initiator_tag)
1520
 
                self.disable_initiator_tag = (gobject.timeout_add
1521
 
                                              (time_to_die,
1522
 
                                               self.disable))
 
1578
                self.disable_initiator_tag = (
 
1579
                    gobject.timeout_add(
 
1580
                        timedelta_to_milliseconds(self.expires - now),
 
1581
                        self.disable))
1523
1582
    
1524
1583
    # ExtendedTimeout - property
1525
1584
    @dbus_service_property(_interface, signature="t",
1604
1663
        self._pipe.send(('setattr', name, value))
1605
1664
 
1606
1665
 
1607
 
class ClientDBusTransitional(ClientDBus):
1608
 
    __metaclass__ = AlternateDBusNamesMetaclass
1609
 
 
1610
 
 
1611
1666
class ClientHandler(socketserver.BaseRequestHandler, object):
1612
1667
    """A class to handle client connections.
1613
1668
    
1649
1704
            logger.debug("Protocol version: %r", line)
1650
1705
            try:
1651
1706
                if int(line.strip().split()[0]) > 1:
1652
 
                    raise RuntimeError
 
1707
                    raise RuntimeError(line)
1653
1708
            except (ValueError, IndexError, RuntimeError) as error:
1654
1709
                logger.error("Unknown protocol version: %s", error)
1655
1710
                return
1717
1772
                    #wait until timeout or approved
1718
1773
                    time = datetime.datetime.now()
1719
1774
                    client.changedstate.acquire()
1720
 
                    (client.changedstate.wait
1721
 
                     (float(client.timedelta_to_milliseconds(delay)
1722
 
                            / 1000)))
 
1775
                    client.changedstate.wait(
 
1776
                        float(timedelta_to_milliseconds(delay)
 
1777
                              / 1000))
1723
1778
                    client.changedstate.release()
1724
1779
                    time2 = datetime.datetime.now()
1725
1780
                    if (time2 - time) >= delay:
1741
1796
                    try:
1742
1797
                        sent = session.send(client.secret[sent_size:])
1743
1798
                    except gnutls.errors.GNUTLSError as error:
1744
 
                        logger.warning("gnutls send failed")
 
1799
                        logger.warning("gnutls send failed",
 
1800
                                       exc_info=error)
1745
1801
                        return
1746
1802
                    logger.debug("Sent: %d, remaining: %d",
1747
1803
                                 sent, len(client.secret)
1761
1817
                try:
1762
1818
                    session.bye()
1763
1819
                except gnutls.errors.GNUTLSError as error:
1764
 
                    logger.warning("GnuTLS bye failed")
 
1820
                    logger.warning("GnuTLS bye failed",
 
1821
                                   exc_info=error)
1765
1822
    
1766
1823
    @staticmethod
1767
1824
    def peer_certificate(session):
1839
1896
    def process_request(self, request, address):
1840
1897
        """Start a new process to process the request."""
1841
1898
        proc = multiprocessing.Process(target = self.sub_process_main,
1842
 
                                       args = (request,
1843
 
                                               address))
 
1899
                                       args = (request, address))
1844
1900
        proc.start()
1845
1901
        return proc
1846
1902
 
1861
1917
    
1862
1918
    def add_pipe(self, parent_pipe, proc):
1863
1919
        """Dummy function; override as necessary"""
1864
 
        raise NotImplementedError
 
1920
        raise NotImplementedError()
1865
1921
 
1866
1922
 
1867
1923
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1874
1930
        use_ipv6:       Boolean; to use IPv6 or not
1875
1931
    """
1876
1932
    def __init__(self, server_address, RequestHandlerClass,
1877
 
                 interface=None, use_ipv6=True):
 
1933
                 interface=None, use_ipv6=True, socketfd=None):
 
1934
        """If socketfd is set, use that file descriptor instead of
 
1935
        creating a new one with socket.socket().
 
1936
        """
1878
1937
        self.interface = interface
1879
1938
        if use_ipv6:
1880
1939
            self.address_family = socket.AF_INET6
 
1940
        if socketfd is not None:
 
1941
            # Save the file descriptor
 
1942
            self.socketfd = socketfd
 
1943
            # Save the original socket.socket() function
 
1944
            self.socket_socket = socket.socket
 
1945
            # To implement --socket, we monkey patch socket.socket.
 
1946
            # 
 
1947
            # (When socketserver.TCPServer is a new-style class, we
 
1948
            # could make self.socket into a property instead of monkey
 
1949
            # patching socket.socket.)
 
1950
            # 
 
1951
            # Create a one-time-only replacement for socket.socket()
 
1952
            @functools.wraps(socket.socket)
 
1953
            def socket_wrapper(*args, **kwargs):
 
1954
                # Restore original function so subsequent calls are
 
1955
                # not affected.
 
1956
                socket.socket = self.socket_socket
 
1957
                del self.socket_socket
 
1958
                # This time only, return a new socket object from the
 
1959
                # saved file descriptor.
 
1960
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1961
            # Replace socket.socket() function with wrapper
 
1962
            socket.socket = socket_wrapper
 
1963
        # The socketserver.TCPServer.__init__ will call
 
1964
        # socket.socket(), which might be our replacement,
 
1965
        # socket_wrapper(), if socketfd was set.
1881
1966
        socketserver.TCPServer.__init__(self, server_address,
1882
1967
                                        RequestHandlerClass)
 
1968
    
1883
1969
    def server_bind(self):
1884
1970
        """This overrides the normal server_bind() function
1885
1971
        to bind to an interface if one was specified, and also NOT to
1893
1979
                try:
1894
1980
                    self.socket.setsockopt(socket.SOL_SOCKET,
1895
1981
                                           SO_BINDTODEVICE,
1896
 
                                           str(self.interface
1897
 
                                               + '\0'))
 
1982
                                           str(self.interface + '\0'))
1898
1983
                except socket.error as error:
1899
 
                    if error[0] == errno.EPERM:
1900
 
                        logger.error("No permission to"
1901
 
                                     " bind to interface %s",
1902
 
                                     self.interface)
1903
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1984
                    if error.errno == errno.EPERM:
 
1985
                        logger.error("No permission to bind to"
 
1986
                                     " interface %s", self.interface)
 
1987
                    elif error.errno == errno.ENOPROTOOPT:
1904
1988
                        logger.error("SO_BINDTODEVICE not available;"
1905
1989
                                     " cannot bind to interface %s",
1906
1990
                                     self.interface)
 
1991
                    elif error.errno == errno.ENODEV:
 
1992
                        logger.error("Interface %s does not exist,"
 
1993
                                     " cannot bind", self.interface)
1907
1994
                    else:
1908
1995
                        raise
1909
1996
        # Only bind(2) the socket if we really need to.
1912
1999
                if self.address_family == socket.AF_INET6:
1913
2000
                    any_address = "::" # in6addr_any
1914
2001
                else:
1915
 
                    any_address = socket.INADDR_ANY
 
2002
                    any_address = "0.0.0.0" # INADDR_ANY
1916
2003
                self.server_address = (any_address,
1917
2004
                                       self.server_address[1])
1918
2005
            elif not self.server_address[1]:
1939
2026
    """
1940
2027
    def __init__(self, server_address, RequestHandlerClass,
1941
2028
                 interface=None, use_ipv6=True, clients=None,
1942
 
                 gnutls_priority=None, use_dbus=True):
 
2029
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1943
2030
        self.enabled = False
1944
2031
        self.clients = clients
1945
2032
        if self.clients is None:
1949
2036
        IPv6_TCPServer.__init__(self, server_address,
1950
2037
                                RequestHandlerClass,
1951
2038
                                interface = interface,
1952
 
                                use_ipv6 = use_ipv6)
 
2039
                                use_ipv6 = use_ipv6,
 
2040
                                socketfd = socketfd)
1953
2041
    def server_activate(self):
1954
2042
        if self.enabled:
1955
2043
            return socketserver.TCPServer.server_activate(self)
1968
2056
    
1969
2057
    def handle_ipc(self, source, condition, parent_pipe=None,
1970
2058
                   proc = None, client_object=None):
1971
 
        condition_names = {
1972
 
            gobject.IO_IN: "IN",   # There is data to read.
1973
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1974
 
                                    # blocking).
1975
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1976
 
            gobject.IO_ERR: "ERR", # Error condition.
1977
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1978
 
                                    # broken, usually for pipes and
1979
 
                                    # sockets).
1980
 
            }
1981
 
        conditions_string = ' | '.join(name
1982
 
                                       for cond, name in
1983
 
                                       condition_names.iteritems()
1984
 
                                       if cond & condition)
1985
2059
        # error, or the other end of multiprocessing.Pipe has closed
1986
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2060
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1987
2061
            # Wait for other process to exit
1988
2062
            proc.join()
1989
2063
            return False
2047
2121
        return True
2048
2122
 
2049
2123
 
 
2124
def rfc3339_duration_to_delta(duration):
 
2125
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2126
    
 
2127
    >>> rfc3339_duration_to_delta("P7D")
 
2128
    datetime.timedelta(7)
 
2129
    >>> rfc3339_duration_to_delta("PT60S")
 
2130
    datetime.timedelta(0, 60)
 
2131
    >>> rfc3339_duration_to_delta("PT60M")
 
2132
    datetime.timedelta(0, 3600)
 
2133
    >>> rfc3339_duration_to_delta("PT24H")
 
2134
    datetime.timedelta(1)
 
2135
    >>> rfc3339_duration_to_delta("P1W")
 
2136
    datetime.timedelta(7)
 
2137
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2138
    datetime.timedelta(0, 330)
 
2139
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2140
    datetime.timedelta(1, 200)
 
2141
    """
 
2142
    
 
2143
    # Parsing an RFC 3339 duration with regular expressions is not
 
2144
    # possible - there would have to be multiple places for the same
 
2145
    # values, like seconds.  The current code, while more esoteric, is
 
2146
    # cleaner without depending on a parsing library.  If Python had a
 
2147
    # built-in library for parsing we would use it, but we'd like to
 
2148
    # avoid excessive use of external libraries.
 
2149
    
 
2150
    # New type for defining tokens, syntax, and semantics all-in-one
 
2151
    Token = collections.namedtuple("Token",
 
2152
                                   ("regexp", # To match token; if
 
2153
                                              # "value" is not None,
 
2154
                                              # must have a "group"
 
2155
                                              # containing digits
 
2156
                                    "value",  # datetime.timedelta or
 
2157
                                              # None
 
2158
                                    "followers")) # Tokens valid after
 
2159
                                                  # this token
 
2160
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2161
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2162
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2163
    token_second = Token(re.compile(r"(\d+)S"),
 
2164
                         datetime.timedelta(seconds=1),
 
2165
                         frozenset((token_end,)))
 
2166
    token_minute = Token(re.compile(r"(\d+)M"),
 
2167
                         datetime.timedelta(minutes=1),
 
2168
                         frozenset((token_second, token_end)))
 
2169
    token_hour = Token(re.compile(r"(\d+)H"),
 
2170
                       datetime.timedelta(hours=1),
 
2171
                       frozenset((token_minute, token_end)))
 
2172
    token_time = Token(re.compile(r"T"),
 
2173
                       None,
 
2174
                       frozenset((token_hour, token_minute,
 
2175
                                  token_second)))
 
2176
    token_day = Token(re.compile(r"(\d+)D"),
 
2177
                      datetime.timedelta(days=1),
 
2178
                      frozenset((token_time, token_end)))
 
2179
    token_month = Token(re.compile(r"(\d+)M"),
 
2180
                        datetime.timedelta(weeks=4),
 
2181
                        frozenset((token_day, token_end)))
 
2182
    token_year = Token(re.compile(r"(\d+)Y"),
 
2183
                       datetime.timedelta(weeks=52),
 
2184
                       frozenset((token_month, token_end)))
 
2185
    token_week = Token(re.compile(r"(\d+)W"),
 
2186
                       datetime.timedelta(weeks=1),
 
2187
                       frozenset((token_end,)))
 
2188
    token_duration = Token(re.compile(r"P"), None,
 
2189
                           frozenset((token_year, token_month,
 
2190
                                      token_day, token_time,
 
2191
                                      token_week))),
 
2192
    # Define starting values
 
2193
    value = datetime.timedelta() # Value so far
 
2194
    found_token = None
 
2195
    followers = frozenset(token_duration,) # Following valid tokens
 
2196
    s = duration                # String left to parse
 
2197
    # Loop until end token is found
 
2198
    while found_token is not token_end:
 
2199
        # Search for any currently valid tokens
 
2200
        for token in followers:
 
2201
            match = token.regexp.match(s)
 
2202
            if match is not None:
 
2203
                # Token found
 
2204
                if token.value is not None:
 
2205
                    # Value found, parse digits
 
2206
                    factor = int(match.group(1), 10)
 
2207
                    # Add to value so far
 
2208
                    value += factor * token.value
 
2209
                # Strip token from string
 
2210
                s = token.regexp.sub("", s, 1)
 
2211
                # Go to found token
 
2212
                found_token = token
 
2213
                # Set valid next tokens
 
2214
                followers = found_token.followers
 
2215
                break
 
2216
        else:
 
2217
            # No currently valid tokens were found
 
2218
            raise ValueError("Invalid RFC 3339 duration")
 
2219
    # End token found
 
2220
    return value
 
2221
 
 
2222
 
2050
2223
def string_to_delta(interval):
2051
2224
    """Parse a string and return a datetime.timedelta
2052
2225
    
2063
2236
    >>> string_to_delta('5m 30s')
2064
2237
    datetime.timedelta(0, 330)
2065
2238
    """
 
2239
    
 
2240
    try:
 
2241
        return rfc3339_duration_to_delta(interval)
 
2242
    except ValueError:
 
2243
        pass
 
2244
    
2066
2245
    timevalue = datetime.timedelta(0)
2067
2246
    for s in interval.split():
2068
2247
        try:
2079
2258
            elif suffix == "w":
2080
2259
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2081
2260
            else:
2082
 
                raise ValueError("Unknown suffix %r" % suffix)
2083
 
        except (ValueError, IndexError) as e:
 
2261
                raise ValueError("Unknown suffix {0!r}"
 
2262
                                 .format(suffix))
 
2263
        except IndexError as e:
2084
2264
            raise ValueError(*(e.args))
2085
2265
        timevalue += delta
2086
2266
    return timevalue
2102
2282
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2103
2283
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2104
2284
            raise OSError(errno.ENODEV,
2105
 
                          "%s not a character device"
2106
 
                          % os.devnull)
 
2285
                          "{0} not a character device"
 
2286
                          .format(os.devnull))
2107
2287
        os.dup2(null, sys.stdin.fileno())
2108
2288
        os.dup2(null, sys.stdout.fileno())
2109
2289
        os.dup2(null, sys.stderr.fileno())
2118
2298
    
2119
2299
    parser = argparse.ArgumentParser()
2120
2300
    parser.add_argument("-v", "--version", action="version",
2121
 
                        version = "%%(prog)s %s" % version,
 
2301
                        version = "%(prog)s {0}".format(version),
2122
2302
                        help="show version number and exit")
2123
2303
    parser.add_argument("-i", "--interface", metavar="IF",
2124
2304
                        help="Bind to interface IF")
2130
2310
                        help="Run self-test")
2131
2311
    parser.add_argument("--debug", action="store_true",
2132
2312
                        help="Debug mode; run in foreground and log"
2133
 
                        " to terminal")
 
2313
                        " to terminal", default=None)
2134
2314
    parser.add_argument("--debuglevel", metavar="LEVEL",
2135
2315
                        help="Debug level for stdout output")
2136
2316
    parser.add_argument("--priority", help="GnuTLS"
2143
2323
                        " files")
2144
2324
    parser.add_argument("--no-dbus", action="store_false",
2145
2325
                        dest="use_dbus", help="Do not provide D-Bus"
2146
 
                        " system bus interface")
 
2326
                        " system bus interface", default=None)
2147
2327
    parser.add_argument("--no-ipv6", action="store_false",
2148
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2328
                        dest="use_ipv6", help="Do not use IPv6",
 
2329
                        default=None)
2149
2330
    parser.add_argument("--no-restore", action="store_false",
2150
2331
                        dest="restore", help="Do not restore stored"
2151
 
                        " state")
 
2332
                        " state", default=None)
 
2333
    parser.add_argument("--socket", type=int,
 
2334
                        help="Specify a file descriptor to a network"
 
2335
                        " socket to use instead of creating one")
2152
2336
    parser.add_argument("--statedir", metavar="DIR",
2153
2337
                        help="Directory to save/restore state in")
 
2338
    parser.add_argument("--foreground", action="store_true",
 
2339
                        help="Run in foreground", default=None)
 
2340
    parser.add_argument("--no-zeroconf", action="store_false",
 
2341
                        dest="zeroconf", help="Do not use Zeroconf",
 
2342
                        default=None)
2154
2343
    
2155
2344
    options = parser.parse_args()
2156
2345
    
2157
2346
    if options.check:
2158
2347
        import doctest
2159
 
        doctest.testmod()
2160
 
        sys.exit()
 
2348
        fail_count, test_count = doctest.testmod()
 
2349
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2161
2350
    
2162
2351
    # Default values for config file for server-global settings
2163
2352
    server_defaults = { "interface": "",
2165
2354
                        "port": "",
2166
2355
                        "debug": "False",
2167
2356
                        "priority":
2168
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2357
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2169
2358
                        "servicename": "Mandos",
2170
2359
                        "use_dbus": "True",
2171
2360
                        "use_ipv6": "True",
2172
2361
                        "debuglevel": "",
2173
2362
                        "restore": "True",
2174
 
                        "statedir": "/var/lib/mandos"
 
2363
                        "socket": "",
 
2364
                        "statedir": "/var/lib/mandos",
 
2365
                        "foreground": "False",
 
2366
                        "zeroconf": "True",
2175
2367
                        }
2176
2368
    
2177
2369
    # Parse config file for server-global settings
2182
2374
    # Convert the SafeConfigParser object to a dict
2183
2375
    server_settings = server_config.defaults()
2184
2376
    # Use the appropriate methods on the non-string config options
2185
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2377
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2186
2378
        server_settings[option] = server_config.getboolean("DEFAULT",
2187
2379
                                                           option)
2188
2380
    if server_settings["port"]:
2189
2381
        server_settings["port"] = server_config.getint("DEFAULT",
2190
2382
                                                       "port")
 
2383
    if server_settings["socket"]:
 
2384
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2385
                                                         "socket")
 
2386
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2387
        # over with an opened os.devnull.  But we don't want this to
 
2388
        # happen with a supplied network socket.
 
2389
        if 0 <= server_settings["socket"] <= 2:
 
2390
            server_settings["socket"] = os.dup(server_settings
 
2391
                                               ["socket"])
2191
2392
    del server_config
2192
2393
    
2193
2394
    # Override the settings from the config file with command line
2195
2396
    for option in ("interface", "address", "port", "debug",
2196
2397
                   "priority", "servicename", "configdir",
2197
2398
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2198
 
                   "statedir"):
 
2399
                   "statedir", "socket", "foreground", "zeroconf"):
2199
2400
        value = getattr(options, option)
2200
2401
        if value is not None:
2201
2402
            server_settings[option] = value
2204
2405
    for option in server_settings.keys():
2205
2406
        if type(server_settings[option]) is str:
2206
2407
            server_settings[option] = unicode(server_settings[option])
 
2408
    # Force all boolean options to be boolean
 
2409
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2410
                   "foreground", "zeroconf"):
 
2411
        server_settings[option] = bool(server_settings[option])
 
2412
    # Debug implies foreground
 
2413
    if server_settings["debug"]:
 
2414
        server_settings["foreground"] = True
2207
2415
    # Now we have our good server settings in "server_settings"
2208
2416
    
2209
2417
    ##################################################################
2210
2418
    
 
2419
    if (not server_settings["zeroconf"] and
 
2420
        not (server_settings["port"]
 
2421
             or server_settings["socket"] != "")):
 
2422
            parser.error("Needs port or socket to work without"
 
2423
                         " Zeroconf")
 
2424
    
2211
2425
    # For convenience
2212
2426
    debug = server_settings["debug"]
2213
2427
    debuglevel = server_settings["debuglevel"]
2215
2429
    use_ipv6 = server_settings["use_ipv6"]
2216
2430
    stored_state_path = os.path.join(server_settings["statedir"],
2217
2431
                                     stored_state_file)
 
2432
    foreground = server_settings["foreground"]
 
2433
    zeroconf = server_settings["zeroconf"]
2218
2434
    
2219
2435
    if debug:
2220
2436
        initlogger(debug, logging.DEBUG)
2227
2443
    
2228
2444
    if server_settings["servicename"] != "Mandos":
2229
2445
        syslogger.setFormatter(logging.Formatter
2230
 
                               ('Mandos (%s) [%%(process)d]:'
2231
 
                                ' %%(levelname)s: %%(message)s'
2232
 
                                % server_settings["servicename"]))
 
2446
                               ('Mandos ({0}) [%(process)d]:'
 
2447
                                ' %(levelname)s: %(message)s'
 
2448
                                .format(server_settings
 
2449
                                        ["servicename"])))
2233
2450
    
2234
2451
    # Parse config file with clients
2235
2452
    client_config = configparser.SafeConfigParser(Client
2240
2457
    global mandos_dbus_service
2241
2458
    mandos_dbus_service = None
2242
2459
    
 
2460
    socketfd = None
 
2461
    if server_settings["socket"] != "":
 
2462
        socketfd = server_settings["socket"]
2243
2463
    tcp_server = MandosServer((server_settings["address"],
2244
2464
                               server_settings["port"]),
2245
2465
                              ClientHandler,
2248
2468
                              use_ipv6=use_ipv6,
2249
2469
                              gnutls_priority=
2250
2470
                              server_settings["priority"],
2251
 
                              use_dbus=use_dbus)
2252
 
    if not debug:
2253
 
        pidfilename = "/var/run/mandos.pid"
 
2471
                              use_dbus=use_dbus,
 
2472
                              socketfd=socketfd)
 
2473
    if not foreground:
 
2474
        pidfilename = "/run/mandos.pid"
 
2475
        if not os.path.isdir("/run/."):
 
2476
            pidfilename = "/var/run/mandos.pid"
 
2477
        pidfile = None
2254
2478
        try:
2255
2479
            pidfile = open(pidfilename, "w")
2256
 
        except IOError:
2257
 
            logger.error("Could not open file %r", pidfilename)
 
2480
        except IOError as e:
 
2481
            logger.error("Could not open file %r", pidfilename,
 
2482
                         exc_info=e)
2258
2483
    
2259
2484
    for name in ("_mandos", "mandos", "nobody"):
2260
2485
        try:
2270
2495
        os.setgid(gid)
2271
2496
        os.setuid(uid)
2272
2497
    except OSError as error:
2273
 
        if error[0] != errno.EPERM:
2274
 
            raise error
 
2498
        if error.errno != errno.EPERM:
 
2499
            raise
2275
2500
    
2276
2501
    if debug:
2277
2502
        # Enable all possible GnuTLS debugging
2294
2519
            os.close(null)
2295
2520
    
2296
2521
    # Need to fork before connecting to D-Bus
2297
 
    if not debug:
 
2522
    if not foreground:
2298
2523
        # Close all input and output, do double fork, etc.
2299
2524
        daemon()
2300
2525
    
 
2526
    # multiprocessing will use threads, so before we use gobject we
 
2527
    # need to inform gobject that threads will be used.
2301
2528
    gobject.threads_init()
2302
2529
    
2303
2530
    global main_loop
2314
2541
                            ("se.bsnet.fukt.Mandos", bus,
2315
2542
                             do_not_queue=True))
2316
2543
        except dbus.exceptions.NameExistsException as e:
2317
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2544
            logger.error("Disabling D-Bus:", exc_info=e)
2318
2545
            use_dbus = False
2319
2546
            server_settings["use_dbus"] = False
2320
2547
            tcp_server.use_dbus = False
2321
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2322
 
    service = AvahiServiceToSyslog(name =
2323
 
                                   server_settings["servicename"],
2324
 
                                   servicetype = "_mandos._tcp",
2325
 
                                   protocol = protocol, bus = bus)
2326
 
    if server_settings["interface"]:
2327
 
        service.interface = (if_nametoindex
2328
 
                             (str(server_settings["interface"])))
 
2548
    if zeroconf:
 
2549
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2550
        service = AvahiServiceToSyslog(name =
 
2551
                                       server_settings["servicename"],
 
2552
                                       servicetype = "_mandos._tcp",
 
2553
                                       protocol = protocol, bus = bus)
 
2554
        if server_settings["interface"]:
 
2555
            service.interface = (if_nametoindex
 
2556
                                 (str(server_settings["interface"])))
2329
2557
    
2330
2558
    global multiprocessing_manager
2331
2559
    multiprocessing_manager = multiprocessing.Manager()
2332
2560
    
2333
2561
    client_class = Client
2334
2562
    if use_dbus:
2335
 
        client_class = functools.partial(ClientDBusTransitional,
2336
 
                                         bus = bus)
 
2563
        client_class = functools.partial(ClientDBus, bus = bus)
2337
2564
    
2338
2565
    client_settings = Client.config_parser(client_config)
2339
2566
    old_client_settings = {}
2340
2567
    clients_data = {}
2341
2568
    
 
2569
    # This is used to redirect stdout and stderr for checker processes
 
2570
    global wnull
 
2571
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2572
    # Only used if server is running in foreground but not in debug
 
2573
    # mode
 
2574
    if debug or not foreground:
 
2575
        wnull.close()
 
2576
    
2342
2577
    # Get client data and settings from last running state.
2343
2578
    if server_settings["restore"]:
2344
2579
        try:
2347
2582
                                                     (stored_state))
2348
2583
            os.remove(stored_state_path)
2349
2584
        except IOError as e:
2350
 
            logger.warning("Could not load persistent state: {0}"
2351
 
                           .format(e))
2352
 
            if e.errno != errno.ENOENT:
 
2585
            if e.errno == errno.ENOENT:
 
2586
                logger.warning("Could not load persistent state: {0}"
 
2587
                                .format(os.strerror(e.errno)))
 
2588
            else:
 
2589
                logger.critical("Could not load persistent state:",
 
2590
                                exc_info=e)
2353
2591
                raise
2354
2592
        except EOFError as e:
2355
2593
            logger.warning("Could not load persistent state: "
2356
 
                           "EOFError: {0}".format(e))
 
2594
                           "EOFError:", exc_info=e)
2357
2595
    
2358
2596
    with PGPEngine() as pgp:
2359
2597
        for client_name, client in clients_data.iteritems():
 
2598
            # Skip removed clients
 
2599
            if client_name not in client_settings:
 
2600
                continue
 
2601
            
2360
2602
            # Decide which value to use after restoring saved state.
2361
2603
            # We have three different values: Old config file,
2362
2604
            # new config file, and saved state.
2412
2654
                             .format(client_name))
2413
2655
                client["secret"] = (
2414
2656
                    client_settings[client_name]["secret"])
2415
 
 
2416
2657
    
2417
2658
    # Add/remove clients based on new changes made to config
2418
2659
    for client_name in (set(old_client_settings)
2421
2662
    for client_name in (set(client_settings)
2422
2663
                        - set(old_client_settings)):
2423
2664
        clients_data[client_name] = client_settings[client_name]
2424
 
 
 
2665
    
2425
2666
    # Create all client objects
2426
2667
    for client_name, client in clients_data.iteritems():
2427
2668
        tcp_server.clients[client_name] = client_class(
2428
 
            name = client_name, settings = client)
 
2669
            name = client_name, settings = client,
 
2670
            server_settings = server_settings)
2429
2671
    
2430
2672
    if not tcp_server.clients:
2431
2673
        logger.warning("No clients defined")
2432
 
        
2433
 
    if not debug:
2434
 
        try:
2435
 
            with pidfile:
2436
 
                pid = os.getpid()
2437
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2438
 
            del pidfile
2439
 
        except IOError:
2440
 
            logger.error("Could not write to file %r with PID %d",
2441
 
                         pidfilename, pid)
2442
 
        except NameError:
2443
 
            # "pidfile" was never created
2444
 
            pass
 
2674
    
 
2675
    if not foreground:
 
2676
        if pidfile is not None:
 
2677
            try:
 
2678
                with pidfile:
 
2679
                    pid = os.getpid()
 
2680
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2681
            except IOError:
 
2682
                logger.error("Could not write to file %r with PID %d",
 
2683
                             pidfilename, pid)
 
2684
        del pidfile
2445
2685
        del pidfilename
2446
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2447
2686
    
2448
2687
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2449
2688
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2450
2689
    
2451
2690
    if use_dbus:
 
2691
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2692
                                        "se.bsnet.fukt.Mandos"})
2452
2693
        class MandosDBusService(DBusObjectWithProperties):
2453
2694
            """A D-Bus proxy object"""
2454
2695
            def __init__(self):
2508
2749
            
2509
2750
            del _interface
2510
2751
        
2511
 
        class MandosDBusServiceTransitional(MandosDBusService):
2512
 
            __metaclass__ = AlternateDBusNamesMetaclass
2513
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2752
        mandos_dbus_service = MandosDBusService()
2514
2753
    
2515
2754
    def cleanup():
2516
2755
        "Cleanup function; run on exit"
2517
 
        service.cleanup()
 
2756
        if zeroconf:
 
2757
            service.cleanup()
2518
2758
        
2519
2759
        multiprocessing.active_children()
 
2760
        wnull.close()
2520
2761
        if not (tcp_server.clients or client_settings):
2521
2762
            return
2522
2763
        
2534
2775
                # A list of attributes that can not be pickled
2535
2776
                # + secret.
2536
2777
                exclude = set(("bus", "changedstate", "secret",
2537
 
                               "checker"))
 
2778
                               "checker", "server_settings"))
2538
2779
                for name, typ in (inspect.getmembers
2539
2780
                                  (dbus.service.Object)):
2540
2781
                    exclude.add(name)
2549
2790
                del client_settings[client.name]["secret"]
2550
2791
        
2551
2792
        try:
2552
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2553
 
                                                prefix="clients-",
2554
 
                                                dir=os.path.dirname
2555
 
                                                (stored_state_path))
2556
 
            with os.fdopen(tempfd, "wb") as stored_state:
 
2793
            with (tempfile.NamedTemporaryFile
 
2794
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2795
                   dir=os.path.dirname(stored_state_path),
 
2796
                   delete=False)) as stored_state:
2557
2797
                pickle.dump((clients, client_settings), stored_state)
 
2798
                tempname=stored_state.name
2558
2799
            os.rename(tempname, stored_state_path)
2559
2800
        except (IOError, OSError) as e:
2560
 
            logger.warning("Could not save persistent state: {0}"
2561
 
                           .format(e))
2562
2801
            if not debug:
2563
2802
                try:
2564
2803
                    os.remove(tempname)
2565
2804
                except NameError:
2566
2805
                    pass
2567
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2568
 
                                   errno.EEXIST)):
2569
 
                raise e
 
2806
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2807
                logger.warning("Could not save persistent state: {0}"
 
2808
                               .format(os.strerror(e.errno)))
 
2809
            else:
 
2810
                logger.warning("Could not save persistent state:",
 
2811
                               exc_info=e)
 
2812
                raise
2570
2813
        
2571
2814
        # Delete all clients, and settings from config
2572
2815
        while tcp_server.clients:
2596
2839
    tcp_server.server_activate()
2597
2840
    
2598
2841
    # Find out what port we got
2599
 
    service.port = tcp_server.socket.getsockname()[1]
 
2842
    if zeroconf:
 
2843
        service.port = tcp_server.socket.getsockname()[1]
2600
2844
    if use_ipv6:
2601
2845
        logger.info("Now listening on address %r, port %d,"
2602
 
                    " flowinfo %d, scope_id %d"
2603
 
                    % tcp_server.socket.getsockname())
 
2846
                    " flowinfo %d, scope_id %d",
 
2847
                    *tcp_server.socket.getsockname())
2604
2848
    else:                       # IPv4
2605
 
        logger.info("Now listening on address %r, port %d"
2606
 
                    % tcp_server.socket.getsockname())
 
2849
        logger.info("Now listening on address %r, port %d",
 
2850
                    *tcp_server.socket.getsockname())
2607
2851
    
2608
2852
    #service.interface = tcp_server.socket.getsockname()[3]
2609
2853
    
2610
2854
    try:
2611
 
        # From the Avahi example code
2612
 
        try:
2613
 
            service.activate()
2614
 
        except dbus.exceptions.DBusException as error:
2615
 
            logger.critical("D-Bus Exception", exc_info=error)
2616
 
            cleanup()
2617
 
            sys.exit(1)
2618
 
        # End of Avahi example code
 
2855
        if zeroconf:
 
2856
            # From the Avahi example code
 
2857
            try:
 
2858
                service.activate()
 
2859
            except dbus.exceptions.DBusException as error:
 
2860
                logger.critical("D-Bus Exception", exc_info=error)
 
2861
                cleanup()
 
2862
                sys.exit(1)
 
2863
            # End of Avahi example code
2619
2864
        
2620
2865
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2621
2866
                             lambda *args, **kwargs: