/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: 2013-10-28 08:38:47 UTC
  • Revision ID: teddy@recompile.se-20131028083847-cper3srg5o29r2ge
Use architecture libdir.

Instead of always using /usr/lib/mandos, use whatever the architecture
specifies, like /usr/lib/x86_64-linux-gnu/mandos or /usr/lib64/mandos.
Still use /usr/lib/mandos as a fallback.

* Makefile (LIBDIR): New.
 (install-client-nokey, uninstall-client): Use LIBDIR instead of
                                           $(PREFIX)/lib.
* initramfs-tools-hook: Detect correct libdir and copy from there.

Reported-by: Nathanael D. Noblet <nathanael@gnat.ca>
Suggested-by: Nathanael D. Noblet <nathanael@gnat.ca>

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