/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-02-16 03:56:48 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 309.
  • Revision ID: teddy@recompile.se-20140216035648-i6rjq2mp8jicxudo
Allow self-tests to run without needing /dev/log.

* mandos (main): Only open /dev/log on initlogger() call.

Show diffs side-by-side

added added

removed removed

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