/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-02-16 02:42:42 UTC
  • Revision ID: teddy@recompile.se-20140216024242-9wiw1nkxgt7ohovj
Fix running of self-tests.

* debian/control (Build-Depends): Add Python dependencies to
                                  successfully run self-tests.
* debian/copyright: GPLv3 now has its own license file - use it.
* debian/watch: Set PGP signature URL.
* mandos (main): Bug fix: When running self-tests, set exit code.
* mandos-ctl (main): Cosmetic fix; use os.EX_OK instead of plain 0.

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