/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: 2012-05-01 20:48:00 UTC
  • Revision ID: teddy@recompile.se-20120501204800-0wkzdkcd3epzci45
* mandos (main): Simplify and shorten code selecting user and group ID
                 to switch to.

Show diffs side-by-side

added added

removed removed

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