/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-10-26 19:05:21 UTC
  • Revision ID: teddy@recompile.se-20131026190521-giagilisbyciox2h
Fall back to /var/run for pidfile if /run is not a directory.

This is for old (possibly non-Debian) systems which have not migrated
from /var/run to /run yet.

* init.d-mandos (PIDFILE): Fall back to /var/run/mandos.pid if /run is
                           not a directory.
* mandos (pidfilename): - '' -
* mandos.xml (FILES): Document fallback to /var/run/mandos.pid if /run
                      is not a directory.

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2011 Teddy Hogeborn
15
 
# Copyright © 2008-2011 Björn Påhlsson
 
14
# Copyright © 2008-2013 Teddy Hogeborn
 
15
# Copyright © 2008-2013 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
 
37
from future_builtins import *
 
38
 
37
39
import SocketServer as socketserver
38
40
import socket
39
41
import argparse
65
67
import types
66
68
import binascii
67
69
import tempfile
 
70
import itertools
 
71
import collections
68
72
 
69
73
import dbus
70
74
import dbus.service
75
79
import ctypes.util
76
80
import xml.dom.minidom
77
81
import inspect
78
 
import GnuPGInterface
79
82
 
80
83
try:
81
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
88
    except ImportError:
86
89
        SO_BINDTODEVICE = None
87
90
 
88
 
version = "1.4.1"
 
91
version = "1.6.2"
89
92
stored_state_file = "clients.pickle"
90
93
 
91
94
logger = logging.getLogger()
136
139
class PGPEngine(object):
137
140
    """A simple class for OpenPGP symmetric encryption & decryption"""
138
141
    def __init__(self):
139
 
        self.gnupg = GnuPGInterface.GnuPG()
140
142
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
141
 
        self.gnupg = GnuPGInterface.GnuPG()
142
 
        self.gnupg.options.meta_interactive = False
143
 
        self.gnupg.options.homedir = self.tempdir
144
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
145
 
                                              '--quiet',
146
 
                                              '--no-use-agent'])
 
143
        self.gnupgargs = ['--batch',
 
144
                          '--home', self.tempdir,
 
145
                          '--force-mdc',
 
146
                          '--quiet',
 
147
                          '--no-use-agent']
147
148
    
148
149
    def __enter__(self):
149
150
        return self
150
151
    
151
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
152
    def __exit__(self, exc_type, exc_value, traceback):
152
153
        self._cleanup()
153
154
        return False
154
155
    
171
172
    def password_encode(self, password):
172
173
        # Passphrase can not be empty and can not contain newlines or
173
174
        # NUL bytes.  So we prefix it and hex encode it.
174
 
        return b"mandos" + binascii.hexlify(password)
 
175
        encoded = b"mandos" + binascii.hexlify(password)
 
176
        if len(encoded) > 2048:
 
177
            # GnuPG can't handle long passwords, so encode differently
 
178
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
179
                       .replace(b"\n", b"\\n")
 
180
                       .replace(b"\0", b"\\x00"))
 
181
        return encoded
175
182
    
176
183
    def encrypt(self, data, password):
177
 
        self.gnupg.passphrase = self.password_encode(password)
178
 
        with open(os.devnull) as devnull:
179
 
            try:
180
 
                proc = self.gnupg.run(['--symmetric'],
181
 
                                      create_fhs=['stdin', 'stdout'],
182
 
                                      attach_fhs={'stderr': devnull})
183
 
                with contextlib.closing(proc.handles['stdin']) as f:
184
 
                    f.write(data)
185
 
                with contextlib.closing(proc.handles['stdout']) as f:
186
 
                    ciphertext = f.read()
187
 
                proc.wait()
188
 
            except IOError as e:
189
 
                raise PGPError(e)
190
 
        self.gnupg.passphrase = None
 
184
        passphrase = self.password_encode(password)
 
185
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
186
                                         ) as passfile:
 
187
            passfile.write(passphrase)
 
188
            passfile.flush()
 
189
            proc = subprocess.Popen(['gpg', '--symmetric',
 
190
                                     '--passphrase-file',
 
191
                                     passfile.name]
 
192
                                    + self.gnupgargs,
 
193
                                    stdin = subprocess.PIPE,
 
194
                                    stdout = subprocess.PIPE,
 
195
                                    stderr = subprocess.PIPE)
 
196
            ciphertext, err = proc.communicate(input = data)
 
197
        if proc.returncode != 0:
 
198
            raise PGPError(err)
191
199
        return ciphertext
192
200
    
193
201
    def decrypt(self, data, password):
194
 
        self.gnupg.passphrase = self.password_encode(password)
195
 
        with open(os.devnull) as devnull:
196
 
            try:
197
 
                proc = self.gnupg.run(['--decrypt'],
198
 
                                      create_fhs=['stdin', 'stdout'],
199
 
                                      attach_fhs={'stderr': devnull})
200
 
                with contextlib.closing(proc.handles['stdin'] ) as f:
201
 
                    f.write(data)
202
 
                with contextlib.closing(proc.handles['stdout']) as f:
203
 
                    decrypted_plaintext = f.read()
204
 
                proc.wait()
205
 
            except IOError as e:
206
 
                raise PGPError(e)
207
 
        self.gnupg.passphrase = None
 
202
        passphrase = self.password_encode(password)
 
203
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
204
                                         ) as passfile:
 
205
            passfile.write(passphrase)
 
206
            passfile.flush()
 
207
            proc = subprocess.Popen(['gpg', '--decrypt',
 
208
                                     '--passphrase-file',
 
209
                                     passfile.name]
 
210
                                    + self.gnupgargs,
 
211
                                    stdin = subprocess.PIPE,
 
212
                                    stdout = subprocess.PIPE,
 
213
                                    stderr = subprocess.PIPE)
 
214
            decrypted_plaintext, err = proc.communicate(input
 
215
                                                        = data)
 
216
        if proc.returncode != 0:
 
217
            raise PGPError(err)
208
218
        return decrypted_plaintext
209
219
 
210
220
 
211
 
 
212
221
class AvahiError(Exception):
213
222
    def __init__(self, value, *args, **kwargs):
214
223
        self.value = value
231
240
               Used to optionally bind to the specified interface.
232
241
    name: string; Example: 'Mandos'
233
242
    type: string; Example: '_mandos._tcp'.
234
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
243
     See <https://www.iana.org/assignments/service-names-port-numbers>
235
244
    port: integer; what port to announce
236
245
    TXT: list of strings; TXT record for the service
237
246
    domain: string; Domain to publish on, default to .local if empty.
243
252
    server: D-Bus Server
244
253
    bus: dbus.SystemBus()
245
254
    """
 
255
    
246
256
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
247
257
                 servicetype = None, port = None, TXT = None,
248
258
                 domain = "", host = "", max_renames = 32768,
261
271
        self.server = None
262
272
        self.bus = bus
263
273
        self.entry_group_state_changed_match = None
 
274
    
264
275
    def rename(self):
265
276
        """Derived from the Avahi example code"""
266
277
        if self.rename_count >= self.max_renames:
276
287
        try:
277
288
            self.add()
278
289
        except dbus.exceptions.DBusException as error:
279
 
            logger.critical("DBusException: %s", error)
 
290
            logger.critical("D-Bus Exception", exc_info=error)
280
291
            self.cleanup()
281
292
            os._exit(1)
282
293
        self.rename_count += 1
 
294
    
283
295
    def remove(self):
284
296
        """Derived from the Avahi example code"""
285
297
        if self.entry_group_state_changed_match is not None:
287
299
            self.entry_group_state_changed_match = None
288
300
        if self.group is not None:
289
301
            self.group.Reset()
 
302
    
290
303
    def add(self):
291
304
        """Derived from the Avahi example code"""
292
305
        self.remove()
309
322
            dbus.UInt16(self.port),
310
323
            avahi.string_array_to_txt_array(self.TXT))
311
324
        self.group.Commit()
 
325
    
312
326
    def entry_group_state_changed(self, state, error):
313
327
        """Derived from the Avahi example code"""
314
328
        logger.debug("Avahi entry group state change: %i", state)
321
335
        elif state == avahi.ENTRY_GROUP_FAILURE:
322
336
            logger.critical("Avahi: Error in group state changed %s",
323
337
                            unicode(error))
324
 
            raise AvahiGroupError("State changed: %s"
325
 
                                  % unicode(error))
 
338
            raise AvahiGroupError("State changed: {0!s}"
 
339
                                  .format(error))
 
340
    
326
341
    def cleanup(self):
327
342
        """Derived from the Avahi example code"""
328
343
        if self.group is not None:
333
348
                pass
334
349
            self.group = None
335
350
        self.remove()
 
351
    
336
352
    def server_state_changed(self, state, error=None):
337
353
        """Derived from the Avahi example code"""
338
354
        logger.debug("Avahi server state change: %i", state)
357
373
                logger.debug("Unknown state: %r", state)
358
374
            else:
359
375
                logger.debug("Unknown state: %r: %r", state, error)
 
376
    
360
377
    def activate(self):
361
378
        """Derived from the Avahi example code"""
362
379
        if self.server is None:
369
386
                                 self.server_state_changed)
370
387
        self.server_state_changed(self.server.GetState())
371
388
 
 
389
 
372
390
class AvahiServiceToSyslog(AvahiService):
373
391
    def rename(self):
374
392
        """Add the new name to the syslog messages"""
375
393
        ret = AvahiService.rename(self)
376
394
        syslogger.setFormatter(logging.Formatter
377
 
                               ('Mandos (%s) [%%(process)d]:'
378
 
                                ' %%(levelname)s: %%(message)s'
379
 
                                % self.name))
 
395
                               ('Mandos ({0}) [%(process)d]:'
 
396
                                ' %(levelname)s: %(message)s'
 
397
                                .format(self.name)))
380
398
        return ret
381
399
 
 
400
 
382
401
def timedelta_to_milliseconds(td):
383
402
    "Convert a datetime.timedelta() to milliseconds"
384
403
    return ((td.days * 24 * 60 * 60 * 1000)
385
404
            + (td.seconds * 1000)
386
405
            + (td.microseconds // 1000))
387
 
        
 
406
 
 
407
 
388
408
class Client(object):
389
409
    """A representation of a client host served by this server.
390
410
    
415
435
    last_checked_ok: datetime.datetime(); (UTC) or None
416
436
    last_checker_status: integer between 0 and 255 reflecting exit
417
437
                         status of last checker. -1 reflects crashed
418
 
                         checker, or None.
 
438
                         checker, -2 means no checker completed yet.
419
439
    last_enabled: datetime.datetime(); (UTC) or None
420
440
    name:       string; from the config file, used in log messages and
421
441
                        D-Bus identifiers
422
442
    secret:     bytestring; sent verbatim (over TLS) to client
423
443
    timeout:    datetime.timedelta(); How long from last_checked_ok
424
444
                                      until this client is disabled
425
 
    extended_timeout:   extra long timeout when password has been sent
 
445
    extended_timeout:   extra long timeout when secret has been sent
426
446
    runtime_expansions: Allowed attributes for runtime expansion.
427
447
    expires:    datetime.datetime(); time (UTC) when a client will be
428
448
                disabled, or None
 
449
    server_settings: The server_settings dict from main()
429
450
    """
430
451
    
431
452
    runtime_expansions = ("approval_delay", "approval_duration",
432
 
                          "created", "enabled", "fingerprint",
433
 
                          "host", "interval", "last_checked_ok",
 
453
                          "created", "enabled", "expires",
 
454
                          "fingerprint", "host", "interval",
 
455
                          "last_approval_request", "last_checked_ok",
434
456
                          "last_enabled", "name", "timeout")
435
 
    client_defaults = { "timeout": "5m",
436
 
                        "extended_timeout": "15m",
437
 
                        "interval": "2m",
 
457
    client_defaults = { "timeout": "PT5M",
 
458
                        "extended_timeout": "PT15M",
 
459
                        "interval": "PT2M",
438
460
                        "checker": "fping -q -- %%(host)s",
439
461
                        "host": "",
440
 
                        "approval_delay": "0s",
441
 
                        "approval_duration": "1s",
 
462
                        "approval_delay": "PT0S",
 
463
                        "approval_duration": "PT1S",
442
464
                        "approved_by_default": "True",
443
465
                        "enabled": "True",
444
466
                        }
457
479
    
458
480
    def approval_delay_milliseconds(self):
459
481
        return timedelta_to_milliseconds(self.approval_delay)
460
 
 
 
482
    
461
483
    @staticmethod
462
484
    def config_parser(config):
463
485
        """Construct a new dict of client settings of this form:
475
497
            # Reformat values from string types to Python types
476
498
            client["approved_by_default"] = config.getboolean(
477
499
                client_name, "approved_by_default")
478
 
            client["enabled"] = config.getboolean(client_name, "enabled")
 
500
            client["enabled"] = config.getboolean(client_name,
 
501
                                                  "enabled")
479
502
            
480
503
            client["fingerprint"] = (section["fingerprint"].upper()
481
504
                                     .replace(" ", ""))
487
510
                          "rb") as secfile:
488
511
                    client["secret"] = secfile.read()
489
512
            else:
490
 
                raise TypeError("No secret or secfile for section %s"
491
 
                                % section)
 
513
                raise TypeError("No secret or secfile for section {0}"
 
514
                                .format(section))
492
515
            client["timeout"] = string_to_delta(section["timeout"])
493
516
            client["extended_timeout"] = string_to_delta(
494
517
                section["extended_timeout"])
500
523
            client["checker_command"] = section["checker"]
501
524
            client["last_approval_request"] = None
502
525
            client["last_checked_ok"] = None
503
 
            client["last_checker_status"] = None
 
526
            client["last_checker_status"] = -2
504
527
        
505
528
        return settings
506
 
        
507
 
        
508
 
    def __init__(self, settings, name = None):
509
 
        """Note: the 'checker' key in 'config' sets the
510
 
        'checker_command' attribute and *not* the 'checker'
511
 
        attribute."""
 
529
    
 
530
    def __init__(self, settings, name = None, server_settings=None):
512
531
        self.name = name
 
532
        if server_settings is None:
 
533
            server_settings = {}
 
534
        self.server_settings = server_settings
513
535
        # adding all client settings
514
536
        for setting, value in settings.iteritems():
515
537
            setattr(self, setting, value)
523
545
        else:
524
546
            self.last_enabled = None
525
547
            self.expires = None
526
 
       
 
548
        
527
549
        logger.debug("Creating client %r", self.name)
528
550
        # Uppercase and remove spaces from fingerprint for later
529
551
        # comparison purposes with return value from the fingerprint()
530
552
        # function
531
553
        logger.debug("  Fingerprint: %s", self.fingerprint)
532
 
        self.created = settings.get("created", datetime.datetime.utcnow())
533
 
 
 
554
        self.created = settings.get("created",
 
555
                                    datetime.datetime.utcnow())
 
556
        
534
557
        # attributes specific for this server instance
535
558
        self.checker = None
536
559
        self.checker_initiator_tag = None
564
587
        if getattr(self, "enabled", False):
565
588
            # Already enabled
566
589
            return
567
 
        self.send_changedstate()
568
590
        self.expires = datetime.datetime.utcnow() + self.timeout
569
591
        self.enabled = True
570
592
        self.last_enabled = datetime.datetime.utcnow()
571
593
        self.init_checker()
 
594
        self.send_changedstate()
572
595
    
573
596
    def disable(self, quiet=True):
574
597
        """Disable this client."""
575
598
        if not getattr(self, "enabled", False):
576
599
            return False
577
600
        if not quiet:
578
 
            self.send_changedstate()
579
 
        if not quiet:
580
601
            logger.info("Disabling client %s", self.name)
581
 
        if getattr(self, "disable_initiator_tag", False):
 
602
        if getattr(self, "disable_initiator_tag", None) is not None:
582
603
            gobject.source_remove(self.disable_initiator_tag)
583
604
            self.disable_initiator_tag = None
584
605
        self.expires = None
585
 
        if getattr(self, "checker_initiator_tag", False):
 
606
        if getattr(self, "checker_initiator_tag", None) is not None:
586
607
            gobject.source_remove(self.checker_initiator_tag)
587
608
            self.checker_initiator_tag = None
588
609
        self.stop_checker()
589
610
        self.enabled = False
 
611
        if not quiet:
 
612
            self.send_changedstate()
590
613
        # Do not run this again if called by a gobject.timeout_add
591
614
        return False
592
615
    
596
619
    def init_checker(self):
597
620
        # Schedule a new checker to be started an 'interval' from now,
598
621
        # and every interval from then on.
 
622
        if self.checker_initiator_tag is not None:
 
623
            gobject.source_remove(self.checker_initiator_tag)
599
624
        self.checker_initiator_tag = (gobject.timeout_add
600
625
                                      (self.interval_milliseconds(),
601
626
                                       self.start_checker))
602
627
        # Schedule a disable() when 'timeout' has passed
 
628
        if self.disable_initiator_tag is not None:
 
629
            gobject.source_remove(self.disable_initiator_tag)
603
630
        self.disable_initiator_tag = (gobject.timeout_add
604
631
                                   (self.timeout_milliseconds(),
605
632
                                    self.disable))
624
651
            logger.warning("Checker for %(name)s crashed?",
625
652
                           vars(self))
626
653
    
627
 
    def checked_ok(self, timeout=None):
628
 
        """Bump up the timeout for this client.
629
 
        
630
 
        This should only be called when the client has been seen,
631
 
        alive and well.
632
 
        """
 
654
    def checked_ok(self):
 
655
        """Assert that the client has been seen, alive and well."""
 
656
        self.last_checked_ok = datetime.datetime.utcnow()
 
657
        self.last_checker_status = 0
 
658
        self.bump_timeout()
 
659
    
 
660
    def bump_timeout(self, timeout=None):
 
661
        """Bump up the timeout for this client."""
633
662
        if timeout is None:
634
663
            timeout = self.timeout
635
 
        self.last_checked_ok = datetime.datetime.utcnow()
636
664
        if self.disable_initiator_tag is not None:
637
665
            gobject.source_remove(self.disable_initiator_tag)
 
666
            self.disable_initiator_tag = None
638
667
        if getattr(self, "enabled", False):
639
668
            self.disable_initiator_tag = (gobject.timeout_add
640
669
                                          (timedelta_to_milliseconds
650
679
        If a checker already exists, leave it running and do
651
680
        nothing."""
652
681
        # The reason for not killing a running checker is that if we
653
 
        # did that, then if a checker (for some reason) started
654
 
        # running slowly and taking more than 'interval' time, the
655
 
        # client would inevitably timeout, since no checker would get
656
 
        # a chance to run to completion.  If we instead leave running
 
682
        # did that, and if a checker (for some reason) started running
 
683
        # slowly and taking more than 'interval' time, then the client
 
684
        # would inevitably timeout, since no checker would get a
 
685
        # chance to run to completion.  If we instead leave running
657
686
        # checkers alone, the checker would have to take more time
658
687
        # than 'timeout' for the client to be disabled, which is as it
659
688
        # should be.
673
702
                                      self.current_checker_command)
674
703
        # Start a new checker if needed
675
704
        if self.checker is None:
 
705
            # Escape attributes for the shell
 
706
            escaped_attrs = dict(
 
707
                (attr, re.escape(unicode(getattr(self, attr))))
 
708
                for attr in
 
709
                self.runtime_expansions)
676
710
            try:
677
 
                # In case checker_command has exactly one % operator
678
 
                command = self.checker_command % self.host
679
 
            except TypeError:
680
 
                # Escape attributes for the shell
681
 
                escaped_attrs = dict(
682
 
                    (attr,
683
 
                     re.escape(unicode(str(getattr(self, attr, "")),
684
 
                                       errors=
685
 
                                       'replace')))
686
 
                    for attr in
687
 
                    self.runtime_expansions)
688
 
                
689
 
                try:
690
 
                    command = self.checker_command % escaped_attrs
691
 
                except TypeError as error:
692
 
                    logger.error('Could not format string "%s":'
693
 
                                 ' %s', self.checker_command, error)
694
 
                    return True # Try again later
 
711
                command = self.checker_command % escaped_attrs
 
712
            except TypeError as error:
 
713
                logger.error('Could not format string "%s"',
 
714
                             self.checker_command, exc_info=error)
 
715
                return True # Try again later
695
716
            self.current_checker_command = command
696
717
            try:
697
718
                logger.info("Starting checker %r for %s",
700
721
                # in normal mode, that is already done by daemon(),
701
722
                # and in debug mode we don't want to.  (Stdin is
702
723
                # always replaced by /dev/null.)
 
724
                # The exception is when not debugging but nevertheless
 
725
                # running in the foreground; use the previously
 
726
                # created wnull.
 
727
                popen_args = {}
 
728
                if (not self.server_settings["debug"]
 
729
                    and self.server_settings["foreground"]):
 
730
                    popen_args.update({"stdout": wnull,
 
731
                                       "stderr": wnull })
703
732
                self.checker = subprocess.Popen(command,
704
733
                                                close_fds=True,
705
 
                                                shell=True, cwd="/")
706
 
                self.checker_callback_tag = (gobject.child_watch_add
707
 
                                             (self.checker.pid,
708
 
                                              self.checker_callback,
709
 
                                              data=command))
710
 
                # The checker may have completed before the gobject
711
 
                # watch was added.  Check for this.
 
734
                                                shell=True, cwd="/",
 
735
                                                **popen_args)
 
736
            except OSError as error:
 
737
                logger.error("Failed to start subprocess",
 
738
                             exc_info=error)
 
739
                return True
 
740
            self.checker_callback_tag = (gobject.child_watch_add
 
741
                                         (self.checker.pid,
 
742
                                          self.checker_callback,
 
743
                                          data=command))
 
744
            # The checker may have completed before the gobject
 
745
            # watch was added.  Check for this.
 
746
            try:
712
747
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
713
 
                if pid:
714
 
                    gobject.source_remove(self.checker_callback_tag)
715
 
                    self.checker_callback(pid, status, command)
716
748
            except OSError as error:
717
 
                logger.error("Failed to start subprocess: %s",
718
 
                             error)
 
749
                if error.errno == errno.ECHILD:
 
750
                    # This should never happen
 
751
                    logger.error("Child process vanished",
 
752
                                 exc_info=error)
 
753
                    return True
 
754
                raise
 
755
            if pid:
 
756
                gobject.source_remove(self.checker_callback_tag)
 
757
                self.checker_callback(pid, status, command)
719
758
        # Re-run this periodically if run by gobject.timeout_add
720
759
        return True
721
760
    
728
767
            return
729
768
        logger.debug("Stopping checker for %(name)s", vars(self))
730
769
        try:
731
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
770
            self.checker.terminate()
732
771
            #time.sleep(0.5)
733
772
            #if self.checker.poll() is None:
734
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
773
            #    self.checker.kill()
735
774
        except OSError as error:
736
775
            if error.errno != errno.ESRCH: # No such process
737
776
                raise
754
793
    # "Set" method, so we fail early here:
755
794
    if byte_arrays and signature != "ay":
756
795
        raise ValueError("Byte arrays not supported for non-'ay'"
757
 
                         " signature %r" % signature)
 
796
                         " signature {0!r}".format(signature))
758
797
    def decorator(func):
759
798
        func._dbus_is_property = True
760
799
        func._dbus_interface = dbus_interface
768
807
    return decorator
769
808
 
770
809
 
 
810
def dbus_interface_annotations(dbus_interface):
 
811
    """Decorator for marking functions returning interface annotations
 
812
    
 
813
    Usage:
 
814
    
 
815
    @dbus_interface_annotations("org.example.Interface")
 
816
    def _foo(self):  # Function name does not matter
 
817
        return {"org.freedesktop.DBus.Deprecated": "true",
 
818
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
819
                    "false"}
 
820
    """
 
821
    def decorator(func):
 
822
        func._dbus_is_interface = True
 
823
        func._dbus_interface = dbus_interface
 
824
        func._dbus_name = dbus_interface
 
825
        return func
 
826
    return decorator
 
827
 
 
828
 
 
829
def dbus_annotations(annotations):
 
830
    """Decorator to annotate D-Bus methods, signals or properties
 
831
    Usage:
 
832
    
 
833
    @dbus_service_property("org.example.Interface", signature="b",
 
834
                           access="r")
 
835
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
836
                        "org.freedesktop.DBus.Property."
 
837
                        "EmitsChangedSignal": "false"})
 
838
    def Property_dbus_property(self):
 
839
        return dbus.Boolean(False)
 
840
    """
 
841
    def decorator(func):
 
842
        func._dbus_annotations = annotations
 
843
        return func
 
844
    return decorator
 
845
 
 
846
 
771
847
class DBusPropertyException(dbus.exceptions.DBusException):
772
848
    """A base class for D-Bus property-related exceptions
773
849
    """
796
872
    """
797
873
    
798
874
    @staticmethod
799
 
    def _is_dbus_property(obj):
800
 
        return getattr(obj, "_dbus_is_property", False)
 
875
    def _is_dbus_thing(thing):
 
876
        """Returns a function testing if an attribute is a D-Bus thing
 
877
        
 
878
        If called like _is_dbus_thing("method") it returns a function
 
879
        suitable for use as predicate to inspect.getmembers().
 
880
        """
 
881
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
882
                                   False)
801
883
    
802
 
    def _get_all_dbus_properties(self):
 
884
    def _get_all_dbus_things(self, thing):
803
885
        """Returns a generator of (name, attribute) pairs
804
886
        """
805
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
887
        return ((getattr(athing.__get__(self), "_dbus_name",
 
888
                         name),
 
889
                 athing.__get__(self))
806
890
                for cls in self.__class__.__mro__
807
 
                for name, prop in
808
 
                inspect.getmembers(cls, self._is_dbus_property))
 
891
                for name, athing in
 
892
                inspect.getmembers(cls,
 
893
                                   self._is_dbus_thing(thing)))
809
894
    
810
895
    def _get_dbus_property(self, interface_name, property_name):
811
896
        """Returns a bound method if one exists which is a D-Bus
813
898
        """
814
899
        for cls in  self.__class__.__mro__:
815
900
            for name, value in (inspect.getmembers
816
 
                                (cls, self._is_dbus_property)):
 
901
                                (cls,
 
902
                                 self._is_dbus_thing("property"))):
817
903
                if (value._dbus_name == property_name
818
904
                    and value._dbus_interface == interface_name):
819
905
                    return value.__get__(self)
848
934
            # signatures other than "ay".
849
935
            if prop._dbus_signature != "ay":
850
936
                raise ValueError
851
 
            value = dbus.ByteArray(''.join(unichr(byte)
852
 
                                           for byte in value))
 
937
            value = dbus.ByteArray(b''.join(chr(byte)
 
938
                                            for byte in value))
853
939
        prop(value)
854
940
    
855
941
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
861
947
        Note: Will not include properties with access="write".
862
948
        """
863
949
        properties = {}
864
 
        for name, prop in self._get_all_dbus_properties():
 
950
        for name, prop in self._get_all_dbus_things("property"):
865
951
            if (interface_name
866
952
                and interface_name != prop._dbus_interface):
867
953
                # Interface non-empty but did not match
882
968
                         path_keyword='object_path',
883
969
                         connection_keyword='connection')
884
970
    def Introspect(self, object_path, connection):
885
 
        """Standard D-Bus method, overloaded to insert property tags.
 
971
        """Overloading of standard D-Bus method.
 
972
        
 
973
        Inserts property tags and interface annotation tags.
886
974
        """
887
975
        xmlstring = dbus.service.Object.Introspect(self, object_path,
888
976
                                                   connection)
895
983
                e.setAttribute("access", prop._dbus_access)
896
984
                return e
897
985
            for if_tag in document.getElementsByTagName("interface"):
 
986
                # Add property tags
898
987
                for tag in (make_tag(document, name, prop)
899
988
                            for name, prop
900
 
                            in self._get_all_dbus_properties()
 
989
                            in self._get_all_dbus_things("property")
901
990
                            if prop._dbus_interface
902
991
                            == if_tag.getAttribute("name")):
903
992
                    if_tag.appendChild(tag)
 
993
                # Add annotation tags
 
994
                for typ in ("method", "signal", "property"):
 
995
                    for tag in if_tag.getElementsByTagName(typ):
 
996
                        annots = dict()
 
997
                        for name, prop in (self.
 
998
                                           _get_all_dbus_things(typ)):
 
999
                            if (name == tag.getAttribute("name")
 
1000
                                and prop._dbus_interface
 
1001
                                == if_tag.getAttribute("name")):
 
1002
                                annots.update(getattr
 
1003
                                              (prop,
 
1004
                                               "_dbus_annotations",
 
1005
                                               {}))
 
1006
                        for name, value in annots.iteritems():
 
1007
                            ann_tag = document.createElement(
 
1008
                                "annotation")
 
1009
                            ann_tag.setAttribute("name", name)
 
1010
                            ann_tag.setAttribute("value", value)
 
1011
                            tag.appendChild(ann_tag)
 
1012
                # Add interface annotation tags
 
1013
                for annotation, value in dict(
 
1014
                    itertools.chain.from_iterable(
 
1015
                        annotations().iteritems()
 
1016
                        for name, annotations in
 
1017
                        self._get_all_dbus_things("interface")
 
1018
                        if name == if_tag.getAttribute("name")
 
1019
                        )).iteritems():
 
1020
                    ann_tag = document.createElement("annotation")
 
1021
                    ann_tag.setAttribute("name", annotation)
 
1022
                    ann_tag.setAttribute("value", value)
 
1023
                    if_tag.appendChild(ann_tag)
904
1024
                # Add the names to the return values for the
905
1025
                # "org.freedesktop.DBus.Properties" methods
906
1026
                if (if_tag.getAttribute("name")
921
1041
        except (AttributeError, xml.dom.DOMException,
922
1042
                xml.parsers.expat.ExpatError) as error:
923
1043
            logger.error("Failed to override Introspection method",
924
 
                         error)
 
1044
                         exc_info=error)
925
1045
        return xmlstring
926
1046
 
927
1047
 
928
 
def datetime_to_dbus (dt, variant_level=0):
 
1048
def datetime_to_dbus(dt, variant_level=0):
929
1049
    """Convert a UTC datetime.datetime() to a D-Bus type."""
930
1050
    if dt is None:
931
1051
        return dbus.String("", variant_level = variant_level)
933
1053
                       variant_level=variant_level)
934
1054
 
935
1055
 
936
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
937
 
                                  .__metaclass__):
938
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
939
 
    will add additional D-Bus attributes matching a certain pattern.
 
1056
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1057
    """A class decorator; applied to a subclass of
 
1058
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1059
    interface names according to the "alt_interface_names" mapping.
 
1060
    Usage:
 
1061
    
 
1062
    @alternate_dbus_interfaces({"org.example.Interface":
 
1063
                                    "net.example.AlternateInterface"})
 
1064
    class SampleDBusObject(dbus.service.Object):
 
1065
        @dbus.service.method("org.example.Interface")
 
1066
        def SampleDBusMethod():
 
1067
            pass
 
1068
    
 
1069
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1070
    reachable via two interfaces: "org.example.Interface" and
 
1071
    "net.example.AlternateInterface", the latter of which will have
 
1072
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1073
    "true", unless "deprecate" is passed with a False value.
 
1074
    
 
1075
    This works for methods and signals, and also for D-Bus properties
 
1076
    (from DBusObjectWithProperties) and interfaces (from the
 
1077
    dbus_interface_annotations decorator).
940
1078
    """
941
 
    def __new__(mcs, name, bases, attr):
942
 
        # Go through all the base classes which could have D-Bus
943
 
        # methods, signals, or properties in them
944
 
        for base in (b for b in bases
945
 
                     if issubclass(b, dbus.service.Object)):
946
 
            # Go though all attributes of the base class
947
 
            for attrname, attribute in inspect.getmembers(base):
 
1079
    def wrapper(cls):
 
1080
        for orig_interface_name, alt_interface_name in (
 
1081
            alt_interface_names.iteritems()):
 
1082
            attr = {}
 
1083
            interface_names = set()
 
1084
            # Go though all attributes of the class
 
1085
            for attrname, attribute in inspect.getmembers(cls):
948
1086
                # Ignore non-D-Bus attributes, and D-Bus attributes
949
1087
                # with the wrong interface name
950
1088
                if (not hasattr(attribute, "_dbus_interface")
951
1089
                    or not attribute._dbus_interface
952
 
                    .startswith("se.recompile.Mandos")):
 
1090
                    .startswith(orig_interface_name)):
953
1091
                    continue
954
1092
                # Create an alternate D-Bus interface name based on
955
1093
                # the current name
956
1094
                alt_interface = (attribute._dbus_interface
957
 
                                 .replace("se.recompile.Mandos",
958
 
                                          "se.bsnet.fukt.Mandos"))
 
1095
                                 .replace(orig_interface_name,
 
1096
                                          alt_interface_name))
 
1097
                interface_names.add(alt_interface)
959
1098
                # Is this a D-Bus signal?
960
1099
                if getattr(attribute, "_dbus_is_signal", False):
961
 
                    # Extract the original non-method function by
962
 
                    # black magic
 
1100
                    # Extract the original non-method undecorated
 
1101
                    # function by black magic
963
1102
                    nonmethod_func = (dict(
964
1103
                            zip(attribute.func_code.co_freevars,
965
1104
                                attribute.__closure__))["func"]
976
1115
                                nonmethod_func.func_name,
977
1116
                                nonmethod_func.func_defaults,
978
1117
                                nonmethod_func.func_closure)))
 
1118
                    # Copy annotations, if any
 
1119
                    try:
 
1120
                        new_function._dbus_annotations = (
 
1121
                            dict(attribute._dbus_annotations))
 
1122
                    except AttributeError:
 
1123
                        pass
979
1124
                    # Define a creator of a function to call both the
980
 
                    # old and new functions, so both the old and new
981
 
                    # signals gets sent when the function is called
 
1125
                    # original and alternate functions, so both the
 
1126
                    # original and alternate signals gets sent when
 
1127
                    # the function is called
982
1128
                    def fixscope(func1, func2):
983
1129
                        """This function is a scope container to pass
984
1130
                        func1 and func2 to the "call_both" function
991
1137
                        return call_both
992
1138
                    # Create the "call_both" function and add it to
993
1139
                    # the class
994
 
                    attr[attrname] = fixscope(attribute,
995
 
                                              new_function)
 
1140
                    attr[attrname] = fixscope(attribute, new_function)
996
1141
                # Is this a D-Bus method?
997
1142
                elif getattr(attribute, "_dbus_is_method", False):
998
1143
                    # Create a new, but exactly alike, function
1009
1154
                                        attribute.func_name,
1010
1155
                                        attribute.func_defaults,
1011
1156
                                        attribute.func_closure)))
 
1157
                    # Copy annotations, if any
 
1158
                    try:
 
1159
                        attr[attrname]._dbus_annotations = (
 
1160
                            dict(attribute._dbus_annotations))
 
1161
                    except AttributeError:
 
1162
                        pass
1012
1163
                # Is this a D-Bus property?
1013
1164
                elif getattr(attribute, "_dbus_is_property", False):
1014
1165
                    # Create a new, but exactly alike, function
1028
1179
                                        attribute.func_name,
1029
1180
                                        attribute.func_defaults,
1030
1181
                                        attribute.func_closure)))
1031
 
        return type.__new__(mcs, name, bases, attr)
1032
 
 
1033
 
 
 
1182
                    # Copy annotations, if any
 
1183
                    try:
 
1184
                        attr[attrname]._dbus_annotations = (
 
1185
                            dict(attribute._dbus_annotations))
 
1186
                    except AttributeError:
 
1187
                        pass
 
1188
                # Is this a D-Bus interface?
 
1189
                elif getattr(attribute, "_dbus_is_interface", False):
 
1190
                    # Create a new, but exactly alike, function
 
1191
                    # object.  Decorate it to be a new D-Bus interface
 
1192
                    # with the alternate D-Bus interface name.  Add it
 
1193
                    # to the class.
 
1194
                    attr[attrname] = (dbus_interface_annotations
 
1195
                                      (alt_interface)
 
1196
                                      (types.FunctionType
 
1197
                                       (attribute.func_code,
 
1198
                                        attribute.func_globals,
 
1199
                                        attribute.func_name,
 
1200
                                        attribute.func_defaults,
 
1201
                                        attribute.func_closure)))
 
1202
            if deprecate:
 
1203
                # Deprecate all alternate interfaces
 
1204
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1205
                for interface_name in interface_names:
 
1206
                    @dbus_interface_annotations(interface_name)
 
1207
                    def func(self):
 
1208
                        return { "org.freedesktop.DBus.Deprecated":
 
1209
                                     "true" }
 
1210
                    # Find an unused name
 
1211
                    for aname in (iname.format(i)
 
1212
                                  for i in itertools.count()):
 
1213
                        if aname not in attr:
 
1214
                            attr[aname] = func
 
1215
                            break
 
1216
            if interface_names:
 
1217
                # Replace the class with a new subclass of it with
 
1218
                # methods, signals, etc. as created above.
 
1219
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1220
                           (cls,), attr)
 
1221
        return cls
 
1222
    return wrapper
 
1223
 
 
1224
 
 
1225
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1226
                                "se.bsnet.fukt.Mandos"})
1034
1227
class ClientDBus(Client, DBusObjectWithProperties):
1035
1228
    """A Client class using D-Bus
1036
1229
    
1047
1240
    def __init__(self, bus = None, *args, **kwargs):
1048
1241
        self.bus = bus
1049
1242
        Client.__init__(self, *args, **kwargs)
1050
 
        self._approvals_pending = 0
1051
 
        
1052
 
        self._approvals_pending = 0
1053
1243
        # Only now, when this client is initialized, can it show up on
1054
1244
        # the D-Bus
1055
1245
        client_object_name = unicode(self.name).translate(
1059
1249
                                 ("/clients/" + client_object_name))
1060
1250
        DBusObjectWithProperties.__init__(self, self.bus,
1061
1251
                                          self.dbus_object_path)
1062
 
        
 
1252
    
1063
1253
    def notifychangeproperty(transform_func,
1064
1254
                             dbus_name, type_func=lambda x: x,
1065
1255
                             variant_level=1):
1088
1278
        
1089
1279
        return property(lambda self: getattr(self, attrname), setter)
1090
1280
    
1091
 
    
1092
1281
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1093
1282
    approvals_pending = notifychangeproperty(dbus.Boolean,
1094
1283
                                             "ApprovalPending",
1101
1290
                                       checker is not None)
1102
1291
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1103
1292
                                           "LastCheckedOK")
 
1293
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1294
                                               "LastCheckerStatus")
1104
1295
    last_approval_request = notifychangeproperty(
1105
1296
        datetime_to_dbus, "LastApprovalRequest")
1106
1297
    approved_by_default = notifychangeproperty(dbus.Boolean,
1174
1365
        return False
1175
1366
    
1176
1367
    def approve(self, value=True):
1177
 
        self.send_changedstate()
1178
1368
        self.approved = value
1179
1369
        gobject.timeout_add(timedelta_to_milliseconds
1180
1370
                            (self.approval_duration),
1181
1371
                            self._reset_approved)
1182
 
    
 
1372
        self.send_changedstate()
1183
1373
    
1184
1374
    ## D-Bus methods, signals & properties
1185
1375
    _interface = "se.recompile.Mandos.Client"
1186
1376
    
 
1377
    ## Interfaces
 
1378
    
 
1379
    @dbus_interface_annotations(_interface)
 
1380
    def _foo(self):
 
1381
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1382
                     "false"}
 
1383
    
1187
1384
    ## Signals
1188
1385
    
1189
1386
    # CheckerCompleted - signal
1225
1422
        "D-Bus signal"
1226
1423
        return self.need_approval()
1227
1424
    
1228
 
    # NeRwequest - signal
1229
 
    @dbus.service.signal(_interface, signature="s")
1230
 
    def NewRequest(self, ip):
1231
 
        """D-Bus signal
1232
 
        Is sent after a client request a password.
1233
 
        """
1234
 
        pass
1235
 
    
1236
1425
    ## Methods
1237
1426
    
1238
1427
    # Approve - method
1348
1537
            return
1349
1538
        return datetime_to_dbus(self.last_checked_ok)
1350
1539
    
 
1540
    # LastCheckerStatus - property
 
1541
    @dbus_service_property(_interface, signature="n",
 
1542
                           access="read")
 
1543
    def LastCheckerStatus_dbus_property(self):
 
1544
        return dbus.Int16(self.last_checker_status)
 
1545
    
1351
1546
    # Expires - property
1352
1547
    @dbus_service_property(_interface, signature="s", access="read")
1353
1548
    def Expires_dbus_property(self):
1364
1559
    def Timeout_dbus_property(self, value=None):
1365
1560
        if value is None:       # get
1366
1561
            return dbus.UInt64(self.timeout_milliseconds())
 
1562
        old_timeout = self.timeout
1367
1563
        self.timeout = datetime.timedelta(0, 0, 0, value)
1368
 
        if getattr(self, "disable_initiator_tag", None) is None:
1369
 
            return
1370
 
        # Reschedule timeout
1371
 
        gobject.source_remove(self.disable_initiator_tag)
1372
 
        self.disable_initiator_tag = None
1373
 
        self.expires = None
1374
 
        time_to_die = timedelta_to_milliseconds((self
1375
 
                                                 .last_checked_ok
1376
 
                                                 + self.timeout)
1377
 
                                                - datetime.datetime
1378
 
                                                .utcnow())
1379
 
        if time_to_die <= 0:
1380
 
            # The timeout has passed
1381
 
            self.disable()
1382
 
        else:
1383
 
            self.expires = (datetime.datetime.utcnow()
1384
 
                            + datetime.timedelta(milliseconds =
1385
 
                                                 time_to_die))
1386
 
            self.disable_initiator_tag = (gobject.timeout_add
1387
 
                                          (time_to_die, self.disable))
 
1564
        # Reschedule disabling
 
1565
        if self.enabled:
 
1566
            now = datetime.datetime.utcnow()
 
1567
            self.expires += self.timeout - old_timeout
 
1568
            if self.expires <= now:
 
1569
                # The timeout has passed
 
1570
                self.disable()
 
1571
            else:
 
1572
                if (getattr(self, "disable_initiator_tag", None)
 
1573
                    is None):
 
1574
                    return
 
1575
                gobject.source_remove(self.disable_initiator_tag)
 
1576
                self.disable_initiator_tag = (
 
1577
                    gobject.timeout_add(
 
1578
                        timedelta_to_milliseconds(self.expires - now),
 
1579
                        self.disable))
1388
1580
    
1389
1581
    # ExtendedTimeout - property
1390
1582
    @dbus_service_property(_interface, signature="t",
1469
1661
        self._pipe.send(('setattr', name, value))
1470
1662
 
1471
1663
 
1472
 
class ClientDBusTransitional(ClientDBus):
1473
 
    __metaclass__ = AlternateDBusNamesMetaclass
1474
 
 
1475
 
 
1476
1664
class ClientHandler(socketserver.BaseRequestHandler, object):
1477
1665
    """A class to handle client connections.
1478
1666
    
1546
1734
                except KeyError:
1547
1735
                    return
1548
1736
                
1549
 
                if self.server.use_dbus:
1550
 
                    # Emit D-Bus signal
1551
 
                    client.NewRequest(str(self.client_address))
1552
 
                
1553
1737
                if client.approval_delay:
1554
1738
                    delay = client.approval_delay
1555
1739
                    client.approvals_pending += 1
1586
1770
                    #wait until timeout or approved
1587
1771
                    time = datetime.datetime.now()
1588
1772
                    client.changedstate.acquire()
1589
 
                    (client.changedstate.wait
1590
 
                     (float(client.timedelta_to_milliseconds(delay)
1591
 
                            / 1000)))
 
1773
                    client.changedstate.wait(
 
1774
                        float(timedelta_to_milliseconds(delay)
 
1775
                              / 1000))
1592
1776
                    client.changedstate.release()
1593
1777
                    time2 = datetime.datetime.now()
1594
1778
                    if (time2 - time) >= delay:
1610
1794
                    try:
1611
1795
                        sent = session.send(client.secret[sent_size:])
1612
1796
                    except gnutls.errors.GNUTLSError as error:
1613
 
                        logger.warning("gnutls send failed")
 
1797
                        logger.warning("gnutls send failed",
 
1798
                                       exc_info=error)
1614
1799
                        return
1615
1800
                    logger.debug("Sent: %d, remaining: %d",
1616
1801
                                 sent, len(client.secret)
1619
1804
                
1620
1805
                logger.info("Sending secret to %s", client.name)
1621
1806
                # bump the timeout using extended_timeout
1622
 
                client.checked_ok(client.extended_timeout)
 
1807
                client.bump_timeout(client.extended_timeout)
1623
1808
                if self.server.use_dbus:
1624
1809
                    # Emit D-Bus signal
1625
1810
                    client.GotSecret()
1630
1815
                try:
1631
1816
                    session.bye()
1632
1817
                except gnutls.errors.GNUTLSError as error:
1633
 
                    logger.warning("GnuTLS bye failed")
 
1818
                    logger.warning("GnuTLS bye failed",
 
1819
                                   exc_info=error)
1634
1820
    
1635
1821
    @staticmethod
1636
1822
    def peer_certificate(session):
1708
1894
    def process_request(self, request, address):
1709
1895
        """Start a new process to process the request."""
1710
1896
        proc = multiprocessing.Process(target = self.sub_process_main,
1711
 
                                       args = (request,
1712
 
                                               address))
 
1897
                                       args = (request, address))
1713
1898
        proc.start()
1714
1899
        return proc
1715
1900
 
1743
1928
        use_ipv6:       Boolean; to use IPv6 or not
1744
1929
    """
1745
1930
    def __init__(self, server_address, RequestHandlerClass,
1746
 
                 interface=None, use_ipv6=True):
 
1931
                 interface=None, use_ipv6=True, socketfd=None):
 
1932
        """If socketfd is set, use that file descriptor instead of
 
1933
        creating a new one with socket.socket().
 
1934
        """
1747
1935
        self.interface = interface
1748
1936
        if use_ipv6:
1749
1937
            self.address_family = socket.AF_INET6
 
1938
        if socketfd is not None:
 
1939
            # Save the file descriptor
 
1940
            self.socketfd = socketfd
 
1941
            # Save the original socket.socket() function
 
1942
            self.socket_socket = socket.socket
 
1943
            # To implement --socket, we monkey patch socket.socket.
 
1944
            # 
 
1945
            # (When socketserver.TCPServer is a new-style class, we
 
1946
            # could make self.socket into a property instead of monkey
 
1947
            # patching socket.socket.)
 
1948
            # 
 
1949
            # Create a one-time-only replacement for socket.socket()
 
1950
            @functools.wraps(socket.socket)
 
1951
            def socket_wrapper(*args, **kwargs):
 
1952
                # Restore original function so subsequent calls are
 
1953
                # not affected.
 
1954
                socket.socket = self.socket_socket
 
1955
                del self.socket_socket
 
1956
                # This time only, return a new socket object from the
 
1957
                # saved file descriptor.
 
1958
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1959
            # Replace socket.socket() function with wrapper
 
1960
            socket.socket = socket_wrapper
 
1961
        # The socketserver.TCPServer.__init__ will call
 
1962
        # socket.socket(), which might be our replacement,
 
1963
        # socket_wrapper(), if socketfd was set.
1750
1964
        socketserver.TCPServer.__init__(self, server_address,
1751
1965
                                        RequestHandlerClass)
 
1966
    
1752
1967
    def server_bind(self):
1753
1968
        """This overrides the normal server_bind() function
1754
1969
        to bind to an interface if one was specified, and also NOT to
1762
1977
                try:
1763
1978
                    self.socket.setsockopt(socket.SOL_SOCKET,
1764
1979
                                           SO_BINDTODEVICE,
1765
 
                                           str(self.interface
1766
 
                                               + '\0'))
 
1980
                                           str(self.interface + '\0'))
1767
1981
                except socket.error as error:
1768
 
                    if error[0] == errno.EPERM:
1769
 
                        logger.error("No permission to"
1770
 
                                     " bind to interface %s",
1771
 
                                     self.interface)
1772
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1982
                    if error.errno == errno.EPERM:
 
1983
                        logger.error("No permission to bind to"
 
1984
                                     " interface %s", self.interface)
 
1985
                    elif error.errno == errno.ENOPROTOOPT:
1773
1986
                        logger.error("SO_BINDTODEVICE not available;"
1774
1987
                                     " cannot bind to interface %s",
1775
1988
                                     self.interface)
 
1989
                    elif error.errno == errno.ENODEV:
 
1990
                        logger.error("Interface %s does not exist,"
 
1991
                                     " cannot bind", self.interface)
1776
1992
                    else:
1777
1993
                        raise
1778
1994
        # Only bind(2) the socket if we really need to.
1781
1997
                if self.address_family == socket.AF_INET6:
1782
1998
                    any_address = "::" # in6addr_any
1783
1999
                else:
1784
 
                    any_address = socket.INADDR_ANY
 
2000
                    any_address = "0.0.0.0" # INADDR_ANY
1785
2001
                self.server_address = (any_address,
1786
2002
                                       self.server_address[1])
1787
2003
            elif not self.server_address[1]:
1808
2024
    """
1809
2025
    def __init__(self, server_address, RequestHandlerClass,
1810
2026
                 interface=None, use_ipv6=True, clients=None,
1811
 
                 gnutls_priority=None, use_dbus=True):
 
2027
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1812
2028
        self.enabled = False
1813
2029
        self.clients = clients
1814
2030
        if self.clients is None:
1818
2034
        IPv6_TCPServer.__init__(self, server_address,
1819
2035
                                RequestHandlerClass,
1820
2036
                                interface = interface,
1821
 
                                use_ipv6 = use_ipv6)
 
2037
                                use_ipv6 = use_ipv6,
 
2038
                                socketfd = socketfd)
1822
2039
    def server_activate(self):
1823
2040
        if self.enabled:
1824
2041
            return socketserver.TCPServer.server_activate(self)
1837
2054
    
1838
2055
    def handle_ipc(self, source, condition, parent_pipe=None,
1839
2056
                   proc = None, client_object=None):
1840
 
        condition_names = {
1841
 
            gobject.IO_IN: "IN",   # There is data to read.
1842
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1843
 
                                    # blocking).
1844
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1845
 
            gobject.IO_ERR: "ERR", # Error condition.
1846
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1847
 
                                    # broken, usually for pipes and
1848
 
                                    # sockets).
1849
 
            }
1850
 
        conditions_string = ' | '.join(name
1851
 
                                       for cond, name in
1852
 
                                       condition_names.iteritems()
1853
 
                                       if cond & condition)
1854
2057
        # error, or the other end of multiprocessing.Pipe has closed
1855
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2058
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1856
2059
            # Wait for other process to exit
1857
2060
            proc.join()
1858
2061
            return False
1916
2119
        return True
1917
2120
 
1918
2121
 
 
2122
def rfc3339_duration_to_delta(duration):
 
2123
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2124
    
 
2125
    >>> rfc3339_duration_to_delta("P7D")
 
2126
    datetime.timedelta(7)
 
2127
    >>> rfc3339_duration_to_delta("PT60S")
 
2128
    datetime.timedelta(0, 60)
 
2129
    >>> rfc3339_duration_to_delta("PT60M")
 
2130
    datetime.timedelta(0, 3600)
 
2131
    >>> rfc3339_duration_to_delta("PT24H")
 
2132
    datetime.timedelta(1)
 
2133
    >>> rfc3339_duration_to_delta("P1W")
 
2134
    datetime.timedelta(7)
 
2135
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2136
    datetime.timedelta(0, 330)
 
2137
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2138
    datetime.timedelta(1, 200)
 
2139
    """
 
2140
    
 
2141
    # Parsing an RFC 3339 duration with regular expressions is not
 
2142
    # possible - there would have to be multiple places for the same
 
2143
    # values, like seconds.  The current code, while more esoteric, is
 
2144
    # cleaner without depending on a parsing library.  If Python had a
 
2145
    # built-in library for parsing we would use it, but we'd like to
 
2146
    # avoid excessive use of external libraries.
 
2147
    
 
2148
    # New type for defining tokens, syntax, and semantics all-in-one
 
2149
    Token = collections.namedtuple("Token",
 
2150
                                   ("regexp", # To match token; if
 
2151
                                              # "value" is not None,
 
2152
                                              # must have a "group"
 
2153
                                              # containing digits
 
2154
                                    "value",  # datetime.timedelta or
 
2155
                                              # None
 
2156
                                    "followers")) # Tokens valid after
 
2157
                                                  # this token
 
2158
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2159
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2160
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2161
    token_second = Token(re.compile(r"(\d+)S"),
 
2162
                         datetime.timedelta(seconds=1),
 
2163
                         frozenset((token_end,)))
 
2164
    token_minute = Token(re.compile(r"(\d+)M"),
 
2165
                         datetime.timedelta(minutes=1),
 
2166
                         frozenset((token_second, token_end)))
 
2167
    token_hour = Token(re.compile(r"(\d+)H"),
 
2168
                       datetime.timedelta(hours=1),
 
2169
                       frozenset((token_minute, token_end)))
 
2170
    token_time = Token(re.compile(r"T"),
 
2171
                       None,
 
2172
                       frozenset((token_hour, token_minute,
 
2173
                                  token_second)))
 
2174
    token_day = Token(re.compile(r"(\d+)D"),
 
2175
                      datetime.timedelta(days=1),
 
2176
                      frozenset((token_time, token_end)))
 
2177
    token_month = Token(re.compile(r"(\d+)M"),
 
2178
                        datetime.timedelta(weeks=4),
 
2179
                        frozenset((token_day, token_end)))
 
2180
    token_year = Token(re.compile(r"(\d+)Y"),
 
2181
                       datetime.timedelta(weeks=52),
 
2182
                       frozenset((token_month, token_end)))
 
2183
    token_week = Token(re.compile(r"(\d+)W"),
 
2184
                       datetime.timedelta(weeks=1),
 
2185
                       frozenset((token_end,)))
 
2186
    token_duration = Token(re.compile(r"P"), None,
 
2187
                           frozenset((token_year, token_month,
 
2188
                                      token_day, token_time,
 
2189
                                      token_week))),
 
2190
    # Define starting values
 
2191
    value = datetime.timedelta() # Value so far
 
2192
    found_token = None
 
2193
    followers = frozenset(token_duration,) # Following valid tokens
 
2194
    s = duration                # String left to parse
 
2195
    # Loop until end token is found
 
2196
    while found_token is not token_end:
 
2197
        # Search for any currently valid tokens
 
2198
        for token in followers:
 
2199
            match = token.regexp.match(s)
 
2200
            if match is not None:
 
2201
                # Token found
 
2202
                if token.value is not None:
 
2203
                    # Value found, parse digits
 
2204
                    factor = int(match.group(1), 10)
 
2205
                    # Add to value so far
 
2206
                    value += factor * token.value
 
2207
                # Strip token from string
 
2208
                s = token.regexp.sub("", s, 1)
 
2209
                # Go to found token
 
2210
                found_token = token
 
2211
                # Set valid next tokens
 
2212
                followers = found_token.followers
 
2213
                break
 
2214
        else:
 
2215
            # No currently valid tokens were found
 
2216
            raise ValueError("Invalid RFC 3339 duration")
 
2217
    # End token found
 
2218
    return value
 
2219
 
 
2220
 
1919
2221
def string_to_delta(interval):
1920
2222
    """Parse a string and return a datetime.timedelta
1921
2223
    
1932
2234
    >>> string_to_delta('5m 30s')
1933
2235
    datetime.timedelta(0, 330)
1934
2236
    """
 
2237
    
 
2238
    try:
 
2239
        return rfc3339_duration_to_delta(interval)
 
2240
    except ValueError:
 
2241
        pass
 
2242
    
1935
2243
    timevalue = datetime.timedelta(0)
1936
2244
    for s in interval.split():
1937
2245
        try:
1948
2256
            elif suffix == "w":
1949
2257
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1950
2258
            else:
1951
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2259
                raise ValueError("Unknown suffix {0!r}"
 
2260
                                 .format(suffix))
1952
2261
        except (ValueError, IndexError) as e:
1953
2262
            raise ValueError(*(e.args))
1954
2263
        timevalue += delta
1968
2277
        sys.exit()
1969
2278
    if not noclose:
1970
2279
        # Close all standard open file descriptors
1971
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2280
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1972
2281
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1973
2282
            raise OSError(errno.ENODEV,
1974
 
                          "%s not a character device"
1975
 
                          % os.path.devnull)
 
2283
                          "{0} not a character device"
 
2284
                          .format(os.devnull))
1976
2285
        os.dup2(null, sys.stdin.fileno())
1977
2286
        os.dup2(null, sys.stdout.fileno())
1978
2287
        os.dup2(null, sys.stderr.fileno())
1987
2296
    
1988
2297
    parser = argparse.ArgumentParser()
1989
2298
    parser.add_argument("-v", "--version", action="version",
1990
 
                        version = "%%(prog)s %s" % version,
 
2299
                        version = "%(prog)s {0}".format(version),
1991
2300
                        help="show version number and exit")
1992
2301
    parser.add_argument("-i", "--interface", metavar="IF",
1993
2302
                        help="Bind to interface IF")
1999
2308
                        help="Run self-test")
2000
2309
    parser.add_argument("--debug", action="store_true",
2001
2310
                        help="Debug mode; run in foreground and log"
2002
 
                        " to terminal")
 
2311
                        " to terminal", default=None)
2003
2312
    parser.add_argument("--debuglevel", metavar="LEVEL",
2004
2313
                        help="Debug level for stdout output")
2005
2314
    parser.add_argument("--priority", help="GnuTLS"
2012
2321
                        " files")
2013
2322
    parser.add_argument("--no-dbus", action="store_false",
2014
2323
                        dest="use_dbus", help="Do not provide D-Bus"
2015
 
                        " system bus interface")
 
2324
                        " system bus interface", default=None)
2016
2325
    parser.add_argument("--no-ipv6", action="store_false",
2017
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2326
                        dest="use_ipv6", help="Do not use IPv6",
 
2327
                        default=None)
2018
2328
    parser.add_argument("--no-restore", action="store_false",
2019
2329
                        dest="restore", help="Do not restore stored"
2020
 
                        " state")
 
2330
                        " state", default=None)
 
2331
    parser.add_argument("--socket", type=int,
 
2332
                        help="Specify a file descriptor to a network"
 
2333
                        " socket to use instead of creating one")
2021
2334
    parser.add_argument("--statedir", metavar="DIR",
2022
2335
                        help="Directory to save/restore state in")
 
2336
    parser.add_argument("--foreground", action="store_true",
 
2337
                        help="Run in foreground", default=None)
2023
2338
    
2024
2339
    options = parser.parse_args()
2025
2340
    
2034
2349
                        "port": "",
2035
2350
                        "debug": "False",
2036
2351
                        "priority":
2037
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2352
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2038
2353
                        "servicename": "Mandos",
2039
2354
                        "use_dbus": "True",
2040
2355
                        "use_ipv6": "True",
2041
2356
                        "debuglevel": "",
2042
2357
                        "restore": "True",
2043
 
                        "statedir": "/var/lib/mandos"
 
2358
                        "socket": "",
 
2359
                        "statedir": "/var/lib/mandos",
 
2360
                        "foreground": "False",
2044
2361
                        }
2045
2362
    
2046
2363
    # Parse config file for server-global settings
2051
2368
    # Convert the SafeConfigParser object to a dict
2052
2369
    server_settings = server_config.defaults()
2053
2370
    # Use the appropriate methods on the non-string config options
2054
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2371
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2055
2372
        server_settings[option] = server_config.getboolean("DEFAULT",
2056
2373
                                                           option)
2057
2374
    if server_settings["port"]:
2058
2375
        server_settings["port"] = server_config.getint("DEFAULT",
2059
2376
                                                       "port")
 
2377
    if server_settings["socket"]:
 
2378
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2379
                                                         "socket")
 
2380
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2381
        # over with an opened os.devnull.  But we don't want this to
 
2382
        # happen with a supplied network socket.
 
2383
        if 0 <= server_settings["socket"] <= 2:
 
2384
            server_settings["socket"] = os.dup(server_settings
 
2385
                                               ["socket"])
2060
2386
    del server_config
2061
2387
    
2062
2388
    # Override the settings from the config file with command line
2064
2390
    for option in ("interface", "address", "port", "debug",
2065
2391
                   "priority", "servicename", "configdir",
2066
2392
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2067
 
                   "statedir"):
 
2393
                   "statedir", "socket", "foreground"):
2068
2394
        value = getattr(options, option)
2069
2395
        if value is not None:
2070
2396
            server_settings[option] = value
2073
2399
    for option in server_settings.keys():
2074
2400
        if type(server_settings[option]) is str:
2075
2401
            server_settings[option] = unicode(server_settings[option])
 
2402
    # Force all boolean options to be boolean
 
2403
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2404
                   "foreground"):
 
2405
        server_settings[option] = bool(server_settings[option])
 
2406
    # Debug implies foreground
 
2407
    if server_settings["debug"]:
 
2408
        server_settings["foreground"] = True
2076
2409
    # Now we have our good server settings in "server_settings"
2077
2410
    
2078
2411
    ##################################################################
2084
2417
    use_ipv6 = server_settings["use_ipv6"]
2085
2418
    stored_state_path = os.path.join(server_settings["statedir"],
2086
2419
                                     stored_state_file)
 
2420
    foreground = server_settings["foreground"]
2087
2421
    
2088
2422
    if debug:
2089
2423
        initlogger(debug, logging.DEBUG)
2096
2430
    
2097
2431
    if server_settings["servicename"] != "Mandos":
2098
2432
        syslogger.setFormatter(logging.Formatter
2099
 
                               ('Mandos (%s) [%%(process)d]:'
2100
 
                                ' %%(levelname)s: %%(message)s'
2101
 
                                % server_settings["servicename"]))
 
2433
                               ('Mandos ({0}) [%(process)d]:'
 
2434
                                ' %(levelname)s: %(message)s'
 
2435
                                .format(server_settings
 
2436
                                        ["servicename"])))
2102
2437
    
2103
2438
    # Parse config file with clients
2104
 
    client_config = configparser.SafeConfigParser(Client.client_defaults)
 
2439
    client_config = configparser.SafeConfigParser(Client
 
2440
                                                  .client_defaults)
2105
2441
    client_config.read(os.path.join(server_settings["configdir"],
2106
2442
                                    "clients.conf"))
2107
2443
    
2116
2452
                              use_ipv6=use_ipv6,
2117
2453
                              gnutls_priority=
2118
2454
                              server_settings["priority"],
2119
 
                              use_dbus=use_dbus)
2120
 
    if not debug:
2121
 
        pidfilename = "/var/run/mandos.pid"
 
2455
                              use_dbus=use_dbus,
 
2456
                              socketfd=(server_settings["socket"]
 
2457
                                        or None))
 
2458
    if not foreground:
 
2459
        pidfilename = "/run/mandos.pid"
 
2460
        if not os.path.isdir("/run/."):
 
2461
            pidfilename = "/var/run/mandos.pid"
 
2462
        pidfile = None
2122
2463
        try:
2123
2464
            pidfile = open(pidfilename, "w")
2124
 
        except IOError:
2125
 
            logger.error("Could not open file %r", pidfilename)
 
2465
        except IOError as e:
 
2466
            logger.error("Could not open file %r", pidfilename,
 
2467
                         exc_info=e)
2126
2468
    
2127
 
    try:
2128
 
        uid = pwd.getpwnam("_mandos").pw_uid
2129
 
        gid = pwd.getpwnam("_mandos").pw_gid
2130
 
    except KeyError:
 
2469
    for name in ("_mandos", "mandos", "nobody"):
2131
2470
        try:
2132
 
            uid = pwd.getpwnam("mandos").pw_uid
2133
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2471
            uid = pwd.getpwnam(name).pw_uid
 
2472
            gid = pwd.getpwnam(name).pw_gid
 
2473
            break
2134
2474
        except KeyError:
2135
 
            try:
2136
 
                uid = pwd.getpwnam("nobody").pw_uid
2137
 
                gid = pwd.getpwnam("nobody").pw_gid
2138
 
            except KeyError:
2139
 
                uid = 65534
2140
 
                gid = 65534
 
2475
            continue
 
2476
    else:
 
2477
        uid = 65534
 
2478
        gid = 65534
2141
2479
    try:
2142
2480
        os.setgid(gid)
2143
2481
        os.setuid(uid)
2144
2482
    except OSError as error:
2145
 
        if error[0] != errno.EPERM:
 
2483
        if error.errno != errno.EPERM:
2146
2484
            raise error
2147
2485
    
2148
2486
    if debug:
2160
2498
         .gnutls_global_set_log_function(debug_gnutls))
2161
2499
        
2162
2500
        # Redirect stdin so all checkers get /dev/null
2163
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2501
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2164
2502
        os.dup2(null, sys.stdin.fileno())
2165
2503
        if null > 2:
2166
2504
            os.close(null)
2167
2505
    
2168
2506
    # Need to fork before connecting to D-Bus
2169
 
    if not debug:
 
2507
    if not foreground:
2170
2508
        # Close all input and output, do double fork, etc.
2171
2509
        daemon()
2172
2510
    
 
2511
    # multiprocessing will use threads, so before we use gobject we
 
2512
    # need to inform gobject that threads will be used.
2173
2513
    gobject.threads_init()
2174
2514
    
2175
2515
    global main_loop
2176
2516
    # From the Avahi example code
2177
 
    DBusGMainLoop(set_as_default=True )
 
2517
    DBusGMainLoop(set_as_default=True)
2178
2518
    main_loop = gobject.MainLoop()
2179
2519
    bus = dbus.SystemBus()
2180
2520
    # End of Avahi example code
2186
2526
                            ("se.bsnet.fukt.Mandos", bus,
2187
2527
                             do_not_queue=True))
2188
2528
        except dbus.exceptions.NameExistsException as e:
2189
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2529
            logger.error("Disabling D-Bus:", exc_info=e)
2190
2530
            use_dbus = False
2191
2531
            server_settings["use_dbus"] = False
2192
2532
            tcp_server.use_dbus = False
2204
2544
    
2205
2545
    client_class = Client
2206
2546
    if use_dbus:
2207
 
        client_class = functools.partial(ClientDBusTransitional,
2208
 
                                         bus = bus)
 
2547
        client_class = functools.partial(ClientDBus, bus = bus)
2209
2548
    
2210
2549
    client_settings = Client.config_parser(client_config)
2211
2550
    old_client_settings = {}
2212
2551
    clients_data = {}
2213
2552
    
 
2553
    # This is used to redirect stdout and stderr for checker processes
 
2554
    global wnull
 
2555
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2556
    # Only used if server is running in foreground but not in debug
 
2557
    # mode
 
2558
    if debug or not foreground:
 
2559
        wnull.close()
 
2560
    
2214
2561
    # Get client data and settings from last running state.
2215
2562
    if server_settings["restore"]:
2216
2563
        try:
2219
2566
                                                     (stored_state))
2220
2567
            os.remove(stored_state_path)
2221
2568
        except IOError as e:
2222
 
            logger.warning("Could not load persistent state: {0}"
2223
 
                           .format(e))
2224
 
            if e.errno != errno.ENOENT:
 
2569
            if e.errno == errno.ENOENT:
 
2570
                logger.warning("Could not load persistent state: {0}"
 
2571
                                .format(os.strerror(e.errno)))
 
2572
            else:
 
2573
                logger.critical("Could not load persistent state:",
 
2574
                                exc_info=e)
2225
2575
                raise
2226
2576
        except EOFError as e:
2227
2577
            logger.warning("Could not load persistent state: "
2228
 
                           "EOFError: {0}".format(e))
 
2578
                           "EOFError:", exc_info=e)
2229
2579
    
2230
2580
    with PGPEngine() as pgp:
2231
2581
        for client_name, client in clients_data.iteritems():
 
2582
            # Skip removed clients
 
2583
            if client_name not in client_settings:
 
2584
                continue
 
2585
            
2232
2586
            # Decide which value to use after restoring saved state.
2233
2587
            # We have three different values: Old config file,
2234
2588
            # new config file, and saved state.
2248
2602
            
2249
2603
            # Clients who has passed its expire date can still be
2250
2604
            # enabled if its last checker was successful.  Clients
2251
 
            # whose checker failed before we stored its state is
2252
 
            # assumed to have failed all checkers during downtime.
 
2605
            # whose checker succeeded before we stored its state is
 
2606
            # assumed to have successfully run all checkers during
 
2607
            # downtime.
2253
2608
            if client["enabled"]:
2254
2609
                if datetime.datetime.utcnow() >= client["expires"]:
2255
2610
                    if not client["last_checked_ok"]:
2256
2611
                        logger.warning(
2257
2612
                            "disabling client {0} - Client never "
2258
 
                            "performed a successfull checker"
2259
 
                            .format(client["name"]))
 
2613
                            "performed a successful checker"
 
2614
                            .format(client_name))
2260
2615
                        client["enabled"] = False
2261
2616
                    elif client["last_checker_status"] != 0:
2262
2617
                        logger.warning(
2263
2618
                            "disabling client {0} - Client "
2264
2619
                            "last checker failed with error code {1}"
2265
 
                            .format(client["name"],
 
2620
                            .format(client_name,
2266
2621
                                    client["last_checker_status"]))
2267
2622
                        client["enabled"] = False
2268
2623
                    else:
2271
2626
                                             + client["timeout"])
2272
2627
                        logger.debug("Last checker succeeded,"
2273
2628
                                     " keeping {0} enabled"
2274
 
                                     .format(client["name"]))
 
2629
                                     .format(client_name))
2275
2630
            try:
2276
2631
                client["secret"] = (
2277
2632
                    pgp.decrypt(client["encrypted_secret"],
2283
2638
                             .format(client_name))
2284
2639
                client["secret"] = (
2285
2640
                    client_settings[client_name]["secret"])
2286
 
 
2287
2641
    
2288
2642
    # Add/remove clients based on new changes made to config
2289
 
    for client_name in set(old_client_settings) - set(client_settings):
 
2643
    for client_name in (set(old_client_settings)
 
2644
                        - set(client_settings)):
2290
2645
        del clients_data[client_name]
2291
 
    for client_name in set(client_settings) - set(old_client_settings):
 
2646
    for client_name in (set(client_settings)
 
2647
                        - set(old_client_settings)):
2292
2648
        clients_data[client_name] = client_settings[client_name]
2293
 
 
2294
 
    # Create clients all clients
 
2649
    
 
2650
    # Create all client objects
2295
2651
    for client_name, client in clients_data.iteritems():
2296
2652
        tcp_server.clients[client_name] = client_class(
2297
 
            name = client_name, settings = client)
 
2653
            name = client_name, settings = client,
 
2654
            server_settings = server_settings)
2298
2655
    
2299
2656
    if not tcp_server.clients:
2300
2657
        logger.warning("No clients defined")
2301
 
        
2302
 
    if not debug:
2303
 
        try:
2304
 
            with pidfile:
2305
 
                pid = os.getpid()
2306
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2307
 
            del pidfile
2308
 
        except IOError:
2309
 
            logger.error("Could not write to file %r with PID %d",
2310
 
                         pidfilename, pid)
2311
 
        except NameError:
2312
 
            # "pidfile" was never created
2313
 
            pass
 
2658
    
 
2659
    if not foreground:
 
2660
        if pidfile is not None:
 
2661
            try:
 
2662
                with pidfile:
 
2663
                    pid = os.getpid()
 
2664
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2665
            except IOError:
 
2666
                logger.error("Could not write to file %r with PID %d",
 
2667
                             pidfilename, pid)
 
2668
        del pidfile
2314
2669
        del pidfilename
2315
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2316
2670
    
2317
2671
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2318
2672
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2319
2673
    
2320
2674
    if use_dbus:
2321
 
        class MandosDBusService(dbus.service.Object):
 
2675
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2676
                                        "se.bsnet.fukt.Mandos"})
 
2677
        class MandosDBusService(DBusObjectWithProperties):
2322
2678
            """A D-Bus proxy object"""
2323
2679
            def __init__(self):
2324
2680
                dbus.service.Object.__init__(self, bus, "/")
2325
2681
            _interface = "se.recompile.Mandos"
2326
2682
            
 
2683
            @dbus_interface_annotations(_interface)
 
2684
            def _foo(self):
 
2685
                return { "org.freedesktop.DBus.Property"
 
2686
                         ".EmitsChangedSignal":
 
2687
                             "false"}
 
2688
            
2327
2689
            @dbus.service.signal(_interface, signature="o")
2328
2690
            def ClientAdded(self, objpath):
2329
2691
                "D-Bus signal"
2371
2733
            
2372
2734
            del _interface
2373
2735
        
2374
 
        class MandosDBusServiceTransitional(MandosDBusService):
2375
 
            __metaclass__ = AlternateDBusNamesMetaclass
2376
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2736
        mandos_dbus_service = MandosDBusService()
2377
2737
    
2378
2738
    def cleanup():
2379
2739
        "Cleanup function; run on exit"
2380
2740
        service.cleanup()
2381
2741
        
2382
2742
        multiprocessing.active_children()
 
2743
        wnull.close()
2383
2744
        if not (tcp_server.clients or client_settings):
2384
2745
            return
2385
2746
        
2397
2758
                # A list of attributes that can not be pickled
2398
2759
                # + secret.
2399
2760
                exclude = set(("bus", "changedstate", "secret",
2400
 
                               "checker"))
 
2761
                               "checker", "server_settings"))
2401
2762
                for name, typ in (inspect.getmembers
2402
2763
                                  (dbus.service.Object)):
2403
2764
                    exclude.add(name)
2412
2773
                del client_settings[client.name]["secret"]
2413
2774
        
2414
2775
        try:
2415
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2416
 
                                                prefix="clients-",
2417
 
                                                dir=os.path.dirname
2418
 
                                                (stored_state_path))
2419
 
            with os.fdopen(tempfd, "wb") as stored_state:
 
2776
            with (tempfile.NamedTemporaryFile
 
2777
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2778
                   dir=os.path.dirname(stored_state_path),
 
2779
                   delete=False)) as stored_state:
2420
2780
                pickle.dump((clients, client_settings), stored_state)
 
2781
                tempname=stored_state.name
2421
2782
            os.rename(tempname, stored_state_path)
2422
2783
        except (IOError, OSError) as e:
2423
 
            logger.warning("Could not save persistent state: {0}"
2424
 
                           .format(e))
2425
2784
            if not debug:
2426
2785
                try:
2427
2786
                    os.remove(tempname)
2428
2787
                except NameError:
2429
2788
                    pass
2430
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2431
 
                                   errno.EEXIST)):
 
2789
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2790
                logger.warning("Could not save persistent state: {0}"
 
2791
                               .format(os.strerror(e.errno)))
 
2792
            else:
 
2793
                logger.warning("Could not save persistent state:",
 
2794
                               exc_info=e)
2432
2795
                raise e
2433
2796
        
2434
2797
        # Delete all clients, and settings from config
2462
2825
    service.port = tcp_server.socket.getsockname()[1]
2463
2826
    if use_ipv6:
2464
2827
        logger.info("Now listening on address %r, port %d,"
2465
 
                    " flowinfo %d, scope_id %d"
2466
 
                    % tcp_server.socket.getsockname())
 
2828
                    " flowinfo %d, scope_id %d",
 
2829
                    *tcp_server.socket.getsockname())
2467
2830
    else:                       # IPv4
2468
 
        logger.info("Now listening on address %r, port %d"
2469
 
                    % tcp_server.socket.getsockname())
 
2831
        logger.info("Now listening on address %r, port %d",
 
2832
                    *tcp_server.socket.getsockname())
2470
2833
    
2471
2834
    #service.interface = tcp_server.socket.getsockname()[3]
2472
2835
    
2475
2838
        try:
2476
2839
            service.activate()
2477
2840
        except dbus.exceptions.DBusException as error:
2478
 
            logger.critical("DBusException: %s", error)
 
2841
            logger.critical("D-Bus Exception", exc_info=error)
2479
2842
            cleanup()
2480
2843
            sys.exit(1)
2481
2844
        # End of Avahi example code
2488
2851
        logger.debug("Starting main loop")
2489
2852
        main_loop.run()
2490
2853
    except AvahiError as error:
2491
 
        logger.critical("AvahiError: %s", error)
 
2854
        logger.critical("Avahi Error", exc_info=error)
2492
2855
        cleanup()
2493
2856
        sys.exit(1)
2494
2857
    except KeyboardInterrupt: