/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-12-31 16:02:18 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 307.
  • Revision ID: teddy@recompile.se-20131231160218-plmmb0o0iifkd5l2
Specify BusName in systemd service file.

* mandos.service (BusName): Uncommented.

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-2013 Teddy Hogeborn
 
15
# Copyright © 2008-2013 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.2"
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
    
732
768
            return
733
769
        logger.debug("Stopping checker for %(name)s", vars(self))
734
770
        try:
735
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
771
            self.checker.terminate()
736
772
            #time.sleep(0.5)
737
773
            #if self.checker.poll() is None:
738
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
774
            #    self.checker.kill()
739
775
        except OSError as error:
740
776
            if error.errno != errno.ESRCH: # No such process
741
777
                raise
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
    
791
827
    return decorator
792
828
 
793
829
 
 
830
def dbus_annotations(annotations):
 
831
    """Decorator to annotate D-Bus methods, signals or properties
 
832
    Usage:
 
833
    
 
834
    @dbus_service_property("org.example.Interface", signature="b",
 
835
                           access="r")
 
836
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
837
                        "org.freedesktop.DBus.Property."
 
838
                        "EmitsChangedSignal": "false"})
 
839
    def Property_dbus_property(self):
 
840
        return dbus.Boolean(False)
 
841
    """
 
842
    def decorator(func):
 
843
        func._dbus_annotations = annotations
 
844
        return func
 
845
    return decorator
 
846
 
 
847
 
794
848
class DBusPropertyException(dbus.exceptions.DBusException):
795
849
    """A base class for D-Bus property-related exceptions
796
850
    """
831
885
    def _get_all_dbus_things(self, thing):
832
886
        """Returns a generator of (name, attribute) pairs
833
887
        """
834
 
        return ((athing.__get__(self)._dbus_name,
 
888
        return ((getattr(athing.__get__(self), "_dbus_name",
 
889
                         name),
835
890
                 athing.__get__(self))
836
891
                for cls in self.__class__.__mro__
837
892
                for name, athing in
936
991
                            if prop._dbus_interface
937
992
                            == if_tag.getAttribute("name")):
938
993
                    if_tag.appendChild(tag)
 
994
                # Add annotation tags
 
995
                for typ in ("method", "signal", "property"):
 
996
                    for tag in if_tag.getElementsByTagName(typ):
 
997
                        annots = dict()
 
998
                        for name, prop in (self.
 
999
                                           _get_all_dbus_things(typ)):
 
1000
                            if (name == tag.getAttribute("name")
 
1001
                                and prop._dbus_interface
 
1002
                                == if_tag.getAttribute("name")):
 
1003
                                annots.update(getattr
 
1004
                                              (prop,
 
1005
                                               "_dbus_annotations",
 
1006
                                               {}))
 
1007
                        for name, value in annots.iteritems():
 
1008
                            ann_tag = document.createElement(
 
1009
                                "annotation")
 
1010
                            ann_tag.setAttribute("name", name)
 
1011
                            ann_tag.setAttribute("value", value)
 
1012
                            tag.appendChild(ann_tag)
939
1013
                # Add interface annotation tags
940
1014
                for annotation, value in dict(
941
 
                    itertools.chain(
942
 
                        *(annotations().iteritems()
943
 
                          for name, annotations in
944
 
                          self._get_all_dbus_things("interface")
945
 
                          if name == if_tag.getAttribute("name")
946
 
                          ))).iteritems():
947
 
                    attr_tag = document.createElement("annotation")
948
 
                    attr_tag.setAttribute("name", annotation)
949
 
                    attr_tag.setAttribute("value", value)
950
 
                    if_tag.appendChild(attr_tag)
 
1015
                    itertools.chain.from_iterable(
 
1016
                        annotations().iteritems()
 
1017
                        for name, annotations in
 
1018
                        self._get_all_dbus_things("interface")
 
1019
                        if name == if_tag.getAttribute("name")
 
1020
                        )).iteritems():
 
1021
                    ann_tag = document.createElement("annotation")
 
1022
                    ann_tag.setAttribute("name", annotation)
 
1023
                    ann_tag.setAttribute("value", value)
 
1024
                    if_tag.appendChild(ann_tag)
951
1025
                # Add the names to the return values for the
952
1026
                # "org.freedesktop.DBus.Properties" methods
953
1027
                if (if_tag.getAttribute("name")
968
1042
        except (AttributeError, xml.dom.DOMException,
969
1043
                xml.parsers.expat.ExpatError) as error:
970
1044
            logger.error("Failed to override Introspection method",
971
 
                         error)
 
1045
                         exc_info=error)
972
1046
        return xmlstring
973
1047
 
974
1048
 
975
 
def datetime_to_dbus (dt, variant_level=0):
 
1049
def datetime_to_dbus(dt, variant_level=0):
976
1050
    """Convert a UTC datetime.datetime() to a D-Bus type."""
977
1051
    if dt is None:
978
1052
        return dbus.String("", variant_level = variant_level)
980
1054
                       variant_level=variant_level)
981
1055
 
982
1056
 
983
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
984
 
                                  .__metaclass__):
985
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
986
 
    will add additional D-Bus attributes matching a certain pattern.
 
1057
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1058
    """A class decorator; applied to a subclass of
 
1059
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1060
    interface names according to the "alt_interface_names" mapping.
 
1061
    Usage:
 
1062
    
 
1063
    @alternate_dbus_interfaces({"org.example.Interface":
 
1064
                                    "net.example.AlternateInterface"})
 
1065
    class SampleDBusObject(dbus.service.Object):
 
1066
        @dbus.service.method("org.example.Interface")
 
1067
        def SampleDBusMethod():
 
1068
            pass
 
1069
    
 
1070
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1071
    reachable via two interfaces: "org.example.Interface" and
 
1072
    "net.example.AlternateInterface", the latter of which will have
 
1073
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1074
    "true", unless "deprecate" is passed with a False value.
 
1075
    
 
1076
    This works for methods and signals, and also for D-Bus properties
 
1077
    (from DBusObjectWithProperties) and interfaces (from the
 
1078
    dbus_interface_annotations decorator).
987
1079
    """
988
 
    def __new__(mcs, name, bases, attr):
989
 
        # Go through all the base classes which could have D-Bus
990
 
        # methods, signals, or properties in them
991
 
        old_interface_names = []
992
 
        for base in (b for b in bases
993
 
                     if issubclass(b, dbus.service.Object)):
994
 
            # Go though all attributes of the base class
995
 
            for attrname, attribute in inspect.getmembers(base):
 
1080
    def wrapper(cls):
 
1081
        for orig_interface_name, alt_interface_name in (
 
1082
            alt_interface_names.iteritems()):
 
1083
            attr = {}
 
1084
            interface_names = set()
 
1085
            # Go though all attributes of the class
 
1086
            for attrname, attribute in inspect.getmembers(cls):
996
1087
                # Ignore non-D-Bus attributes, and D-Bus attributes
997
1088
                # with the wrong interface name
998
1089
                if (not hasattr(attribute, "_dbus_interface")
999
1090
                    or not attribute._dbus_interface
1000
 
                    .startswith("se.recompile.Mandos")):
 
1091
                    .startswith(orig_interface_name)):
1001
1092
                    continue
1002
1093
                # Create an alternate D-Bus interface name based on
1003
1094
                # the current name
1004
1095
                alt_interface = (attribute._dbus_interface
1005
 
                                 .replace("se.recompile.Mandos",
1006
 
                                          "se.bsnet.fukt.Mandos"))
1007
 
                if alt_interface != attribute._dbus_interface:
1008
 
                    old_interface_names.append(alt_interface)
 
1096
                                 .replace(orig_interface_name,
 
1097
                                          alt_interface_name))
 
1098
                interface_names.add(alt_interface)
1009
1099
                # Is this a D-Bus signal?
1010
1100
                if getattr(attribute, "_dbus_is_signal", False):
1011
 
                    # Extract the original non-method function by
1012
 
                    # black magic
 
1101
                    # Extract the original non-method undecorated
 
1102
                    # function by black magic
1013
1103
                    nonmethod_func = (dict(
1014
1104
                            zip(attribute.func_code.co_freevars,
1015
1105
                                attribute.__closure__))["func"]
1026
1116
                                nonmethod_func.func_name,
1027
1117
                                nonmethod_func.func_defaults,
1028
1118
                                nonmethod_func.func_closure)))
 
1119
                    # Copy annotations, if any
 
1120
                    try:
 
1121
                        new_function._dbus_annotations = (
 
1122
                            dict(attribute._dbus_annotations))
 
1123
                    except AttributeError:
 
1124
                        pass
1029
1125
                    # Define a creator of a function to call both the
1030
 
                    # old and new functions, so both the old and new
1031
 
                    # signals gets sent when the function is called
 
1126
                    # original and alternate functions, so both the
 
1127
                    # original and alternate signals gets sent when
 
1128
                    # the function is called
1032
1129
                    def fixscope(func1, func2):
1033
1130
                        """This function is a scope container to pass
1034
1131
                        func1 and func2 to the "call_both" function
1041
1138
                        return call_both
1042
1139
                    # Create the "call_both" function and add it to
1043
1140
                    # the class
1044
 
                    attr[attrname] = fixscope(attribute,
1045
 
                                              new_function)
 
1141
                    attr[attrname] = fixscope(attribute, new_function)
1046
1142
                # Is this a D-Bus method?
1047
1143
                elif getattr(attribute, "_dbus_is_method", False):
1048
1144
                    # Create a new, but exactly alike, function
1059
1155
                                        attribute.func_name,
1060
1156
                                        attribute.func_defaults,
1061
1157
                                        attribute.func_closure)))
 
1158
                    # Copy annotations, if any
 
1159
                    try:
 
1160
                        attr[attrname]._dbus_annotations = (
 
1161
                            dict(attribute._dbus_annotations))
 
1162
                    except AttributeError:
 
1163
                        pass
1062
1164
                # Is this a D-Bus property?
1063
1165
                elif getattr(attribute, "_dbus_is_property", False):
1064
1166
                    # Create a new, but exactly alike, function
1078
1180
                                        attribute.func_name,
1079
1181
                                        attribute.func_defaults,
1080
1182
                                        attribute.func_closure)))
 
1183
                    # Copy annotations, if any
 
1184
                    try:
 
1185
                        attr[attrname]._dbus_annotations = (
 
1186
                            dict(attribute._dbus_annotations))
 
1187
                    except AttributeError:
 
1188
                        pass
1081
1189
                # Is this a D-Bus interface?
1082
1190
                elif getattr(attribute, "_dbus_is_interface", False):
1083
1191
                    # Create a new, but exactly alike, function
1092
1200
                                        attribute.func_name,
1093
1201
                                        attribute.func_defaults,
1094
1202
                                        attribute.func_closure)))
1095
 
        # Deprecate all old interfaces
1096
 
        basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"
1097
 
        for old_interface_name in old_interface_names:
1098
 
            @dbus_interface_annotations(old_interface_name)
1099
 
            def func(self):
1100
 
                return { "org.freedesktop.DBus.Deprecated": "true" }
1101
 
            # Find an unused name
1102
 
            for aname in (basename.format(i) for i in
1103
 
                          itertools.count()):
1104
 
                if aname not in attr:
1105
 
                    attr[aname] = func
1106
 
                    break
1107
 
        return type.__new__(mcs, name, bases, attr)
1108
 
 
1109
 
 
 
1203
            if deprecate:
 
1204
                # Deprecate all alternate interfaces
 
1205
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1206
                for interface_name in interface_names:
 
1207
                    @dbus_interface_annotations(interface_name)
 
1208
                    def func(self):
 
1209
                        return { "org.freedesktop.DBus.Deprecated":
 
1210
                                     "true" }
 
1211
                    # Find an unused name
 
1212
                    for aname in (iname.format(i)
 
1213
                                  for i in itertools.count()):
 
1214
                        if aname not in attr:
 
1215
                            attr[aname] = func
 
1216
                            break
 
1217
            if interface_names:
 
1218
                # Replace the class with a new subclass of it with
 
1219
                # methods, signals, etc. as created above.
 
1220
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1221
                           (cls,), attr)
 
1222
        return cls
 
1223
    return wrapper
 
1224
 
 
1225
 
 
1226
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1227
                                "se.bsnet.fukt.Mandos"})
1110
1228
class ClientDBus(Client, DBusObjectWithProperties):
1111
1229
    """A Client class using D-Bus
1112
1230
    
1132
1250
                                 ("/clients/" + client_object_name))
1133
1251
        DBusObjectWithProperties.__init__(self, self.bus,
1134
1252
                                          self.dbus_object_path)
1135
 
        
 
1253
    
1136
1254
    def notifychangeproperty(transform_func,
1137
1255
                             dbus_name, type_func=lambda x: x,
1138
1256
                             variant_level=1):
1161
1279
        
1162
1280
        return property(lambda self: getattr(self, attrname), setter)
1163
1281
    
1164
 
    
1165
1282
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1166
1283
    approvals_pending = notifychangeproperty(dbus.Boolean,
1167
1284
                                             "ApprovalPending",
1249
1366
        return False
1250
1367
    
1251
1368
    def approve(self, value=True):
1252
 
        self.send_changedstate()
1253
1369
        self.approved = value
1254
1370
        gobject.timeout_add(timedelta_to_milliseconds
1255
1371
                            (self.approval_duration),
1256
1372
                            self._reset_approved)
1257
 
    
 
1373
        self.send_changedstate()
1258
1374
    
1259
1375
    ## D-Bus methods, signals & properties
1260
1376
    _interface = "se.recompile.Mandos.Client"
1444
1560
    def Timeout_dbus_property(self, value=None):
1445
1561
        if value is None:       # get
1446
1562
            return dbus.UInt64(self.timeout_milliseconds())
 
1563
        old_timeout = self.timeout
1447
1564
        self.timeout = datetime.timedelta(0, 0, 0, value)
1448
 
        # Reschedule timeout
 
1565
        # Reschedule disabling
1449
1566
        if self.enabled:
1450
1567
            now = datetime.datetime.utcnow()
1451
 
            time_to_die = timedelta_to_milliseconds(
1452
 
                (self.last_checked_ok + self.timeout) - now)
1453
 
            if time_to_die <= 0:
 
1568
            self.expires += self.timeout - old_timeout
 
1569
            if self.expires <= now:
1454
1570
                # The timeout has passed
1455
1571
                self.disable()
1456
1572
            else:
1457
 
                self.expires = (now +
1458
 
                                datetime.timedelta(milliseconds =
1459
 
                                                   time_to_die))
1460
1573
                if (getattr(self, "disable_initiator_tag", None)
1461
1574
                    is None):
1462
1575
                    return
1463
1576
                gobject.source_remove(self.disable_initiator_tag)
1464
 
                self.disable_initiator_tag = (gobject.timeout_add
1465
 
                                              (time_to_die,
1466
 
                                               self.disable))
 
1577
                self.disable_initiator_tag = (
 
1578
                    gobject.timeout_add(
 
1579
                        timedelta_to_milliseconds(self.expires - now),
 
1580
                        self.disable))
1467
1581
    
1468
1582
    # ExtendedTimeout - property
1469
1583
    @dbus_service_property(_interface, signature="t",
1548
1662
        self._pipe.send(('setattr', name, value))
1549
1663
 
1550
1664
 
1551
 
class ClientDBusTransitional(ClientDBus):
1552
 
    __metaclass__ = AlternateDBusNamesMetaclass
1553
 
 
1554
 
 
1555
1665
class ClientHandler(socketserver.BaseRequestHandler, object):
1556
1666
    """A class to handle client connections.
1557
1667
    
1593
1703
            logger.debug("Protocol version: %r", line)
1594
1704
            try:
1595
1705
                if int(line.strip().split()[0]) > 1:
1596
 
                    raise RuntimeError
 
1706
                    raise RuntimeError(line)
1597
1707
            except (ValueError, IndexError, RuntimeError) as error:
1598
1708
                logger.error("Unknown protocol version: %s", error)
1599
1709
                return
1661
1771
                    #wait until timeout or approved
1662
1772
                    time = datetime.datetime.now()
1663
1773
                    client.changedstate.acquire()
1664
 
                    (client.changedstate.wait
1665
 
                     (float(client.timedelta_to_milliseconds(delay)
1666
 
                            / 1000)))
 
1774
                    client.changedstate.wait(
 
1775
                        float(timedelta_to_milliseconds(delay)
 
1776
                              / 1000))
1667
1777
                    client.changedstate.release()
1668
1778
                    time2 = datetime.datetime.now()
1669
1779
                    if (time2 - time) >= delay:
1685
1795
                    try:
1686
1796
                        sent = session.send(client.secret[sent_size:])
1687
1797
                    except gnutls.errors.GNUTLSError as error:
1688
 
                        logger.warning("gnutls send failed")
 
1798
                        logger.warning("gnutls send failed",
 
1799
                                       exc_info=error)
1689
1800
                        return
1690
1801
                    logger.debug("Sent: %d, remaining: %d",
1691
1802
                                 sent, len(client.secret)
1705
1816
                try:
1706
1817
                    session.bye()
1707
1818
                except gnutls.errors.GNUTLSError as error:
1708
 
                    logger.warning("GnuTLS bye failed")
 
1819
                    logger.warning("GnuTLS bye failed",
 
1820
                                   exc_info=error)
1709
1821
    
1710
1822
    @staticmethod
1711
1823
    def peer_certificate(session):
1783
1895
    def process_request(self, request, address):
1784
1896
        """Start a new process to process the request."""
1785
1897
        proc = multiprocessing.Process(target = self.sub_process_main,
1786
 
                                       args = (request,
1787
 
                                               address))
 
1898
                                       args = (request, address))
1788
1899
        proc.start()
1789
1900
        return proc
1790
1901
 
1805
1916
    
1806
1917
    def add_pipe(self, parent_pipe, proc):
1807
1918
        """Dummy function; override as necessary"""
1808
 
        raise NotImplementedError
 
1919
        raise NotImplementedError()
1809
1920
 
1810
1921
 
1811
1922
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1818
1929
        use_ipv6:       Boolean; to use IPv6 or not
1819
1930
    """
1820
1931
    def __init__(self, server_address, RequestHandlerClass,
1821
 
                 interface=None, use_ipv6=True):
 
1932
                 interface=None, use_ipv6=True, socketfd=None):
 
1933
        """If socketfd is set, use that file descriptor instead of
 
1934
        creating a new one with socket.socket().
 
1935
        """
1822
1936
        self.interface = interface
1823
1937
        if use_ipv6:
1824
1938
            self.address_family = socket.AF_INET6
 
1939
        if socketfd is not None:
 
1940
            # Save the file descriptor
 
1941
            self.socketfd = socketfd
 
1942
            # Save the original socket.socket() function
 
1943
            self.socket_socket = socket.socket
 
1944
            # To implement --socket, we monkey patch socket.socket.
 
1945
            # 
 
1946
            # (When socketserver.TCPServer is a new-style class, we
 
1947
            # could make self.socket into a property instead of monkey
 
1948
            # patching socket.socket.)
 
1949
            # 
 
1950
            # Create a one-time-only replacement for socket.socket()
 
1951
            @functools.wraps(socket.socket)
 
1952
            def socket_wrapper(*args, **kwargs):
 
1953
                # Restore original function so subsequent calls are
 
1954
                # not affected.
 
1955
                socket.socket = self.socket_socket
 
1956
                del self.socket_socket
 
1957
                # This time only, return a new socket object from the
 
1958
                # saved file descriptor.
 
1959
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1960
            # Replace socket.socket() function with wrapper
 
1961
            socket.socket = socket_wrapper
 
1962
        # The socketserver.TCPServer.__init__ will call
 
1963
        # socket.socket(), which might be our replacement,
 
1964
        # socket_wrapper(), if socketfd was set.
1825
1965
        socketserver.TCPServer.__init__(self, server_address,
1826
1966
                                        RequestHandlerClass)
 
1967
    
1827
1968
    def server_bind(self):
1828
1969
        """This overrides the normal server_bind() function
1829
1970
        to bind to an interface if one was specified, and also NOT to
1837
1978
                try:
1838
1979
                    self.socket.setsockopt(socket.SOL_SOCKET,
1839
1980
                                           SO_BINDTODEVICE,
1840
 
                                           str(self.interface
1841
 
                                               + '\0'))
 
1981
                                           str(self.interface + '\0'))
1842
1982
                except socket.error as error:
1843
 
                    if error[0] == errno.EPERM:
1844
 
                        logger.error("No permission to"
1845
 
                                     " bind to interface %s",
1846
 
                                     self.interface)
1847
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1983
                    if error.errno == errno.EPERM:
 
1984
                        logger.error("No permission to bind to"
 
1985
                                     " interface %s", self.interface)
 
1986
                    elif error.errno == errno.ENOPROTOOPT:
1848
1987
                        logger.error("SO_BINDTODEVICE not available;"
1849
1988
                                     " cannot bind to interface %s",
1850
1989
                                     self.interface)
 
1990
                    elif error.errno == errno.ENODEV:
 
1991
                        logger.error("Interface %s does not exist,"
 
1992
                                     " cannot bind", self.interface)
1851
1993
                    else:
1852
1994
                        raise
1853
1995
        # Only bind(2) the socket if we really need to.
1856
1998
                if self.address_family == socket.AF_INET6:
1857
1999
                    any_address = "::" # in6addr_any
1858
2000
                else:
1859
 
                    any_address = socket.INADDR_ANY
 
2001
                    any_address = "0.0.0.0" # INADDR_ANY
1860
2002
                self.server_address = (any_address,
1861
2003
                                       self.server_address[1])
1862
2004
            elif not self.server_address[1]:
1883
2025
    """
1884
2026
    def __init__(self, server_address, RequestHandlerClass,
1885
2027
                 interface=None, use_ipv6=True, clients=None,
1886
 
                 gnutls_priority=None, use_dbus=True):
 
2028
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1887
2029
        self.enabled = False
1888
2030
        self.clients = clients
1889
2031
        if self.clients is None:
1893
2035
        IPv6_TCPServer.__init__(self, server_address,
1894
2036
                                RequestHandlerClass,
1895
2037
                                interface = interface,
1896
 
                                use_ipv6 = use_ipv6)
 
2038
                                use_ipv6 = use_ipv6,
 
2039
                                socketfd = socketfd)
1897
2040
    def server_activate(self):
1898
2041
        if self.enabled:
1899
2042
            return socketserver.TCPServer.server_activate(self)
1912
2055
    
1913
2056
    def handle_ipc(self, source, condition, parent_pipe=None,
1914
2057
                   proc = None, client_object=None):
1915
 
        condition_names = {
1916
 
            gobject.IO_IN: "IN",   # There is data to read.
1917
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1918
 
                                    # blocking).
1919
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1920
 
            gobject.IO_ERR: "ERR", # Error condition.
1921
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1922
 
                                    # broken, usually for pipes and
1923
 
                                    # sockets).
1924
 
            }
1925
 
        conditions_string = ' | '.join(name
1926
 
                                       for cond, name in
1927
 
                                       condition_names.iteritems()
1928
 
                                       if cond & condition)
1929
2058
        # error, or the other end of multiprocessing.Pipe has closed
1930
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2059
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1931
2060
            # Wait for other process to exit
1932
2061
            proc.join()
1933
2062
            return False
1991
2120
        return True
1992
2121
 
1993
2122
 
 
2123
def rfc3339_duration_to_delta(duration):
 
2124
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2125
    
 
2126
    >>> rfc3339_duration_to_delta("P7D")
 
2127
    datetime.timedelta(7)
 
2128
    >>> rfc3339_duration_to_delta("PT60S")
 
2129
    datetime.timedelta(0, 60)
 
2130
    >>> rfc3339_duration_to_delta("PT60M")
 
2131
    datetime.timedelta(0, 3600)
 
2132
    >>> rfc3339_duration_to_delta("PT24H")
 
2133
    datetime.timedelta(1)
 
2134
    >>> rfc3339_duration_to_delta("P1W")
 
2135
    datetime.timedelta(7)
 
2136
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2137
    datetime.timedelta(0, 330)
 
2138
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2139
    datetime.timedelta(1, 200)
 
2140
    """
 
2141
    
 
2142
    # Parsing an RFC 3339 duration with regular expressions is not
 
2143
    # possible - there would have to be multiple places for the same
 
2144
    # values, like seconds.  The current code, while more esoteric, is
 
2145
    # cleaner without depending on a parsing library.  If Python had a
 
2146
    # built-in library for parsing we would use it, but we'd like to
 
2147
    # avoid excessive use of external libraries.
 
2148
    
 
2149
    # New type for defining tokens, syntax, and semantics all-in-one
 
2150
    Token = collections.namedtuple("Token",
 
2151
                                   ("regexp", # To match token; if
 
2152
                                              # "value" is not None,
 
2153
                                              # must have a "group"
 
2154
                                              # containing digits
 
2155
                                    "value",  # datetime.timedelta or
 
2156
                                              # None
 
2157
                                    "followers")) # Tokens valid after
 
2158
                                                  # this token
 
2159
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2160
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2161
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2162
    token_second = Token(re.compile(r"(\d+)S"),
 
2163
                         datetime.timedelta(seconds=1),
 
2164
                         frozenset((token_end,)))
 
2165
    token_minute = Token(re.compile(r"(\d+)M"),
 
2166
                         datetime.timedelta(minutes=1),
 
2167
                         frozenset((token_second, token_end)))
 
2168
    token_hour = Token(re.compile(r"(\d+)H"),
 
2169
                       datetime.timedelta(hours=1),
 
2170
                       frozenset((token_minute, token_end)))
 
2171
    token_time = Token(re.compile(r"T"),
 
2172
                       None,
 
2173
                       frozenset((token_hour, token_minute,
 
2174
                                  token_second)))
 
2175
    token_day = Token(re.compile(r"(\d+)D"),
 
2176
                      datetime.timedelta(days=1),
 
2177
                      frozenset((token_time, token_end)))
 
2178
    token_month = Token(re.compile(r"(\d+)M"),
 
2179
                        datetime.timedelta(weeks=4),
 
2180
                        frozenset((token_day, token_end)))
 
2181
    token_year = Token(re.compile(r"(\d+)Y"),
 
2182
                       datetime.timedelta(weeks=52),
 
2183
                       frozenset((token_month, token_end)))
 
2184
    token_week = Token(re.compile(r"(\d+)W"),
 
2185
                       datetime.timedelta(weeks=1),
 
2186
                       frozenset((token_end,)))
 
2187
    token_duration = Token(re.compile(r"P"), None,
 
2188
                           frozenset((token_year, token_month,
 
2189
                                      token_day, token_time,
 
2190
                                      token_week))),
 
2191
    # Define starting values
 
2192
    value = datetime.timedelta() # Value so far
 
2193
    found_token = None
 
2194
    followers = frozenset(token_duration,) # Following valid tokens
 
2195
    s = duration                # String left to parse
 
2196
    # Loop until end token is found
 
2197
    while found_token is not token_end:
 
2198
        # Search for any currently valid tokens
 
2199
        for token in followers:
 
2200
            match = token.regexp.match(s)
 
2201
            if match is not None:
 
2202
                # Token found
 
2203
                if token.value is not None:
 
2204
                    # Value found, parse digits
 
2205
                    factor = int(match.group(1), 10)
 
2206
                    # Add to value so far
 
2207
                    value += factor * token.value
 
2208
                # Strip token from string
 
2209
                s = token.regexp.sub("", s, 1)
 
2210
                # Go to found token
 
2211
                found_token = token
 
2212
                # Set valid next tokens
 
2213
                followers = found_token.followers
 
2214
                break
 
2215
        else:
 
2216
            # No currently valid tokens were found
 
2217
            raise ValueError("Invalid RFC 3339 duration")
 
2218
    # End token found
 
2219
    return value
 
2220
 
 
2221
 
1994
2222
def string_to_delta(interval):
1995
2223
    """Parse a string and return a datetime.timedelta
1996
2224
    
2007
2235
    >>> string_to_delta('5m 30s')
2008
2236
    datetime.timedelta(0, 330)
2009
2237
    """
 
2238
    
 
2239
    try:
 
2240
        return rfc3339_duration_to_delta(interval)
 
2241
    except ValueError:
 
2242
        pass
 
2243
    
2010
2244
    timevalue = datetime.timedelta(0)
2011
2245
    for s in interval.split():
2012
2246
        try:
2023
2257
            elif suffix == "w":
2024
2258
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2025
2259
            else:
2026
 
                raise ValueError("Unknown suffix %r" % suffix)
2027
 
        except (ValueError, IndexError) as e:
 
2260
                raise ValueError("Unknown suffix {0!r}"
 
2261
                                 .format(suffix))
 
2262
        except IndexError as e:
2028
2263
            raise ValueError(*(e.args))
2029
2264
        timevalue += delta
2030
2265
    return timevalue
2046
2281
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2047
2282
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2048
2283
            raise OSError(errno.ENODEV,
2049
 
                          "%s not a character device"
2050
 
                          % os.devnull)
 
2284
                          "{0} not a character device"
 
2285
                          .format(os.devnull))
2051
2286
        os.dup2(null, sys.stdin.fileno())
2052
2287
        os.dup2(null, sys.stdout.fileno())
2053
2288
        os.dup2(null, sys.stderr.fileno())
2062
2297
    
2063
2298
    parser = argparse.ArgumentParser()
2064
2299
    parser.add_argument("-v", "--version", action="version",
2065
 
                        version = "%%(prog)s %s" % version,
 
2300
                        version = "%(prog)s {0}".format(version),
2066
2301
                        help="show version number and exit")
2067
2302
    parser.add_argument("-i", "--interface", metavar="IF",
2068
2303
                        help="Bind to interface IF")
2074
2309
                        help="Run self-test")
2075
2310
    parser.add_argument("--debug", action="store_true",
2076
2311
                        help="Debug mode; run in foreground and log"
2077
 
                        " to terminal")
 
2312
                        " to terminal", default=None)
2078
2313
    parser.add_argument("--debuglevel", metavar="LEVEL",
2079
2314
                        help="Debug level for stdout output")
2080
2315
    parser.add_argument("--priority", help="GnuTLS"
2087
2322
                        " files")
2088
2323
    parser.add_argument("--no-dbus", action="store_false",
2089
2324
                        dest="use_dbus", help="Do not provide D-Bus"
2090
 
                        " system bus interface")
 
2325
                        " system bus interface", default=None)
2091
2326
    parser.add_argument("--no-ipv6", action="store_false",
2092
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2327
                        dest="use_ipv6", help="Do not use IPv6",
 
2328
                        default=None)
2093
2329
    parser.add_argument("--no-restore", action="store_false",
2094
2330
                        dest="restore", help="Do not restore stored"
2095
 
                        " state")
 
2331
                        " state", default=None)
 
2332
    parser.add_argument("--socket", type=int,
 
2333
                        help="Specify a file descriptor to a network"
 
2334
                        " socket to use instead of creating one")
2096
2335
    parser.add_argument("--statedir", metavar="DIR",
2097
2336
                        help="Directory to save/restore state in")
 
2337
    parser.add_argument("--foreground", action="store_true",
 
2338
                        help="Run in foreground", default=None)
2098
2339
    
2099
2340
    options = parser.parse_args()
2100
2341
    
2109
2350
                        "port": "",
2110
2351
                        "debug": "False",
2111
2352
                        "priority":
2112
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2353
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2113
2354
                        "servicename": "Mandos",
2114
2355
                        "use_dbus": "True",
2115
2356
                        "use_ipv6": "True",
2116
2357
                        "debuglevel": "",
2117
2358
                        "restore": "True",
2118
 
                        "statedir": "/var/lib/mandos"
 
2359
                        "socket": "",
 
2360
                        "statedir": "/var/lib/mandos",
 
2361
                        "foreground": "False",
2119
2362
                        }
2120
2363
    
2121
2364
    # Parse config file for server-global settings
2126
2369
    # Convert the SafeConfigParser object to a dict
2127
2370
    server_settings = server_config.defaults()
2128
2371
    # Use the appropriate methods on the non-string config options
2129
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2372
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2130
2373
        server_settings[option] = server_config.getboolean("DEFAULT",
2131
2374
                                                           option)
2132
2375
    if server_settings["port"]:
2133
2376
        server_settings["port"] = server_config.getint("DEFAULT",
2134
2377
                                                       "port")
 
2378
    if server_settings["socket"]:
 
2379
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2380
                                                         "socket")
 
2381
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2382
        # over with an opened os.devnull.  But we don't want this to
 
2383
        # happen with a supplied network socket.
 
2384
        if 0 <= server_settings["socket"] <= 2:
 
2385
            server_settings["socket"] = os.dup(server_settings
 
2386
                                               ["socket"])
2135
2387
    del server_config
2136
2388
    
2137
2389
    # Override the settings from the config file with command line
2139
2391
    for option in ("interface", "address", "port", "debug",
2140
2392
                   "priority", "servicename", "configdir",
2141
2393
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2142
 
                   "statedir"):
 
2394
                   "statedir", "socket", "foreground"):
2143
2395
        value = getattr(options, option)
2144
2396
        if value is not None:
2145
2397
            server_settings[option] = value
2148
2400
    for option in server_settings.keys():
2149
2401
        if type(server_settings[option]) is str:
2150
2402
            server_settings[option] = unicode(server_settings[option])
 
2403
    # Force all boolean options to be boolean
 
2404
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2405
                   "foreground"):
 
2406
        server_settings[option] = bool(server_settings[option])
 
2407
    # Debug implies foreground
 
2408
    if server_settings["debug"]:
 
2409
        server_settings["foreground"] = True
2151
2410
    # Now we have our good server settings in "server_settings"
2152
2411
    
2153
2412
    ##################################################################
2159
2418
    use_ipv6 = server_settings["use_ipv6"]
2160
2419
    stored_state_path = os.path.join(server_settings["statedir"],
2161
2420
                                     stored_state_file)
 
2421
    foreground = server_settings["foreground"]
2162
2422
    
2163
2423
    if debug:
2164
2424
        initlogger(debug, logging.DEBUG)
2171
2431
    
2172
2432
    if server_settings["servicename"] != "Mandos":
2173
2433
        syslogger.setFormatter(logging.Formatter
2174
 
                               ('Mandos (%s) [%%(process)d]:'
2175
 
                                ' %%(levelname)s: %%(message)s'
2176
 
                                % server_settings["servicename"]))
 
2434
                               ('Mandos ({0}) [%(process)d]:'
 
2435
                                ' %(levelname)s: %(message)s'
 
2436
                                .format(server_settings
 
2437
                                        ["servicename"])))
2177
2438
    
2178
2439
    # Parse config file with clients
2179
2440
    client_config = configparser.SafeConfigParser(Client
2192
2453
                              use_ipv6=use_ipv6,
2193
2454
                              gnutls_priority=
2194
2455
                              server_settings["priority"],
2195
 
                              use_dbus=use_dbus)
2196
 
    if not debug:
2197
 
        pidfilename = "/var/run/mandos.pid"
 
2456
                              use_dbus=use_dbus,
 
2457
                              socketfd=(server_settings["socket"]
 
2458
                                        or None))
 
2459
    if not foreground:
 
2460
        pidfilename = "/run/mandos.pid"
 
2461
        if not os.path.isdir("/run/."):
 
2462
            pidfilename = "/var/run/mandos.pid"
 
2463
        pidfile = None
2198
2464
        try:
2199
2465
            pidfile = open(pidfilename, "w")
2200
 
        except IOError:
2201
 
            logger.error("Could not open file %r", pidfilename)
 
2466
        except IOError as e:
 
2467
            logger.error("Could not open file %r", pidfilename,
 
2468
                         exc_info=e)
2202
2469
    
2203
 
    try:
2204
 
        uid = pwd.getpwnam("_mandos").pw_uid
2205
 
        gid = pwd.getpwnam("_mandos").pw_gid
2206
 
    except KeyError:
 
2470
    for name in ("_mandos", "mandos", "nobody"):
2207
2471
        try:
2208
 
            uid = pwd.getpwnam("mandos").pw_uid
2209
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2472
            uid = pwd.getpwnam(name).pw_uid
 
2473
            gid = pwd.getpwnam(name).pw_gid
 
2474
            break
2210
2475
        except KeyError:
2211
 
            try:
2212
 
                uid = pwd.getpwnam("nobody").pw_uid
2213
 
                gid = pwd.getpwnam("nobody").pw_gid
2214
 
            except KeyError:
2215
 
                uid = 65534
2216
 
                gid = 65534
 
2476
            continue
 
2477
    else:
 
2478
        uid = 65534
 
2479
        gid = 65534
2217
2480
    try:
2218
2481
        os.setgid(gid)
2219
2482
        os.setuid(uid)
2220
2483
    except OSError as error:
2221
 
        if error[0] != errno.EPERM:
2222
 
            raise error
 
2484
        if error.errno != errno.EPERM:
 
2485
            raise
2223
2486
    
2224
2487
    if debug:
2225
2488
        # Enable all possible GnuTLS debugging
2242
2505
            os.close(null)
2243
2506
    
2244
2507
    # Need to fork before connecting to D-Bus
2245
 
    if not debug:
 
2508
    if not foreground:
2246
2509
        # Close all input and output, do double fork, etc.
2247
2510
        daemon()
2248
2511
    
 
2512
    # multiprocessing will use threads, so before we use gobject we
 
2513
    # need to inform gobject that threads will be used.
2249
2514
    gobject.threads_init()
2250
2515
    
2251
2516
    global main_loop
2262
2527
                            ("se.bsnet.fukt.Mandos", bus,
2263
2528
                             do_not_queue=True))
2264
2529
        except dbus.exceptions.NameExistsException as e:
2265
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2530
            logger.error("Disabling D-Bus:", exc_info=e)
2266
2531
            use_dbus = False
2267
2532
            server_settings["use_dbus"] = False
2268
2533
            tcp_server.use_dbus = False
2280
2545
    
2281
2546
    client_class = Client
2282
2547
    if use_dbus:
2283
 
        client_class = functools.partial(ClientDBusTransitional,
2284
 
                                         bus = bus)
 
2548
        client_class = functools.partial(ClientDBus, bus = bus)
2285
2549
    
2286
2550
    client_settings = Client.config_parser(client_config)
2287
2551
    old_client_settings = {}
2288
2552
    clients_data = {}
2289
2553
    
 
2554
    # This is used to redirect stdout and stderr for checker processes
 
2555
    global wnull
 
2556
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2557
    # Only used if server is running in foreground but not in debug
 
2558
    # mode
 
2559
    if debug or not foreground:
 
2560
        wnull.close()
 
2561
    
2290
2562
    # Get client data and settings from last running state.
2291
2563
    if server_settings["restore"]:
2292
2564
        try:
2295
2567
                                                     (stored_state))
2296
2568
            os.remove(stored_state_path)
2297
2569
        except IOError as e:
2298
 
            logger.warning("Could not load persistent state: {0}"
2299
 
                           .format(e))
2300
 
            if e.errno != errno.ENOENT:
 
2570
            if e.errno == errno.ENOENT:
 
2571
                logger.warning("Could not load persistent state: {0}"
 
2572
                                .format(os.strerror(e.errno)))
 
2573
            else:
 
2574
                logger.critical("Could not load persistent state:",
 
2575
                                exc_info=e)
2301
2576
                raise
2302
2577
        except EOFError as e:
2303
2578
            logger.warning("Could not load persistent state: "
2304
 
                           "EOFError: {0}".format(e))
 
2579
                           "EOFError:", exc_info=e)
2305
2580
    
2306
2581
    with PGPEngine() as pgp:
2307
2582
        for client_name, client in clients_data.iteritems():
 
2583
            # Skip removed clients
 
2584
            if client_name not in client_settings:
 
2585
                continue
 
2586
            
2308
2587
            # Decide which value to use after restoring saved state.
2309
2588
            # We have three different values: Old config file,
2310
2589
            # new config file, and saved state.
2360
2639
                             .format(client_name))
2361
2640
                client["secret"] = (
2362
2641
                    client_settings[client_name]["secret"])
2363
 
 
2364
2642
    
2365
2643
    # Add/remove clients based on new changes made to config
2366
2644
    for client_name in (set(old_client_settings)
2369
2647
    for client_name in (set(client_settings)
2370
2648
                        - set(old_client_settings)):
2371
2649
        clients_data[client_name] = client_settings[client_name]
2372
 
 
 
2650
    
2373
2651
    # Create all client objects
2374
2652
    for client_name, client in clients_data.iteritems():
2375
2653
        tcp_server.clients[client_name] = client_class(
2376
 
            name = client_name, settings = client)
 
2654
            name = client_name, settings = client,
 
2655
            server_settings = server_settings)
2377
2656
    
2378
2657
    if not tcp_server.clients:
2379
2658
        logger.warning("No clients defined")
2380
 
        
2381
 
    if not debug:
2382
 
        try:
2383
 
            with pidfile:
2384
 
                pid = os.getpid()
2385
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2386
 
            del pidfile
2387
 
        except IOError:
2388
 
            logger.error("Could not write to file %r with PID %d",
2389
 
                         pidfilename, pid)
2390
 
        except NameError:
2391
 
            # "pidfile" was never created
2392
 
            pass
 
2659
    
 
2660
    if not foreground:
 
2661
        if pidfile is not None:
 
2662
            try:
 
2663
                with pidfile:
 
2664
                    pid = os.getpid()
 
2665
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2666
            except IOError:
 
2667
                logger.error("Could not write to file %r with PID %d",
 
2668
                             pidfilename, pid)
 
2669
        del pidfile
2393
2670
        del pidfilename
2394
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2395
2671
    
2396
2672
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2397
2673
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2398
2674
    
2399
2675
    if use_dbus:
 
2676
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2677
                                        "se.bsnet.fukt.Mandos"})
2400
2678
        class MandosDBusService(DBusObjectWithProperties):
2401
2679
            """A D-Bus proxy object"""
2402
2680
            def __init__(self):
2456
2734
            
2457
2735
            del _interface
2458
2736
        
2459
 
        class MandosDBusServiceTransitional(MandosDBusService):
2460
 
            __metaclass__ = AlternateDBusNamesMetaclass
2461
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2737
        mandos_dbus_service = MandosDBusService()
2462
2738
    
2463
2739
    def cleanup():
2464
2740
        "Cleanup function; run on exit"
2465
2741
        service.cleanup()
2466
2742
        
2467
2743
        multiprocessing.active_children()
 
2744
        wnull.close()
2468
2745
        if not (tcp_server.clients or client_settings):
2469
2746
            return
2470
2747
        
2482
2759
                # A list of attributes that can not be pickled
2483
2760
                # + secret.
2484
2761
                exclude = set(("bus", "changedstate", "secret",
2485
 
                               "checker"))
 
2762
                               "checker", "server_settings"))
2486
2763
                for name, typ in (inspect.getmembers
2487
2764
                                  (dbus.service.Object)):
2488
2765
                    exclude.add(name)
2497
2774
                del client_settings[client.name]["secret"]
2498
2775
        
2499
2776
        try:
2500
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2501
 
                                                prefix="clients-",
2502
 
                                                dir=os.path.dirname
2503
 
                                                (stored_state_path))
2504
 
            with os.fdopen(tempfd, "wb") as stored_state:
 
2777
            with (tempfile.NamedTemporaryFile
 
2778
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2779
                   dir=os.path.dirname(stored_state_path),
 
2780
                   delete=False)) as stored_state:
2505
2781
                pickle.dump((clients, client_settings), stored_state)
 
2782
                tempname=stored_state.name
2506
2783
            os.rename(tempname, stored_state_path)
2507
2784
        except (IOError, OSError) as e:
2508
 
            logger.warning("Could not save persistent state: {0}"
2509
 
                           .format(e))
2510
2785
            if not debug:
2511
2786
                try:
2512
2787
                    os.remove(tempname)
2513
2788
                except NameError:
2514
2789
                    pass
2515
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2516
 
                                   errno.EEXIST)):
2517
 
                raise e
 
2790
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2791
                logger.warning("Could not save persistent state: {0}"
 
2792
                               .format(os.strerror(e.errno)))
 
2793
            else:
 
2794
                logger.warning("Could not save persistent state:",
 
2795
                               exc_info=e)
 
2796
                raise
2518
2797
        
2519
2798
        # Delete all clients, and settings from config
2520
2799
        while tcp_server.clients:
2547
2826
    service.port = tcp_server.socket.getsockname()[1]
2548
2827
    if use_ipv6:
2549
2828
        logger.info("Now listening on address %r, port %d,"
2550
 
                    " flowinfo %d, scope_id %d"
2551
 
                    % tcp_server.socket.getsockname())
 
2829
                    " flowinfo %d, scope_id %d",
 
2830
                    *tcp_server.socket.getsockname())
2552
2831
    else:                       # IPv4
2553
 
        logger.info("Now listening on address %r, port %d"
2554
 
                    % tcp_server.socket.getsockname())
 
2832
        logger.info("Now listening on address %r, port %d",
 
2833
                    *tcp_server.socket.getsockname())
2555
2834
    
2556
2835
    #service.interface = tcp_server.socket.getsockname()[3]
2557
2836
    
2560
2839
        try:
2561
2840
            service.activate()
2562
2841
        except dbus.exceptions.DBusException as error:
2563
 
            logger.critical("DBusException: %s", error)
 
2842
            logger.critical("D-Bus Exception", exc_info=error)
2564
2843
            cleanup()
2565
2844
            sys.exit(1)
2566
2845
        # End of Avahi example code
2573
2852
        logger.debug("Starting main loop")
2574
2853
        main_loop.run()
2575
2854
    except AvahiError as error:
2576
 
        logger.critical("AvahiError: %s", error)
 
2855
        logger.critical("Avahi Error", exc_info=error)
2577
2856
        cleanup()
2578
2857
        sys.exit(1)
2579
2858
    except KeyboardInterrupt: