/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-22 19:46:35 UTC
  • Revision ID: teddy@recompile.se-20131022194635-ll6jyg1snrxwe94o
* TODO

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.1"
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'])
 
143
        self.gnupgargs = ['--batch',
 
144
                          '--home', self.tempdir,
 
145
                          '--force-mdc',
 
146
                          '--quiet',
 
147
                          '--no-use-agent']
146
148
    
147
149
    def __enter__(self):
148
150
        return self
149
151
    
150
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
152
    def __exit__(self, exc_type, exc_value, traceback):
151
153
        self._cleanup()
152
154
        return False
153
155
    
170
172
    def password_encode(self, password):
171
173
        # Passphrase can not be empty and can not contain newlines or
172
174
        # NUL bytes.  So we prefix it and hex encode it.
173
 
        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
174
182
    
175
183
    def encrypt(self, data, password):
176
 
        self.gnupg.passphrase = self.password_encode(password)
177
 
        with open(os.devnull) as devnull:
178
 
            try:
179
 
                proc = self.gnupg.run(['--symmetric'],
180
 
                                      create_fhs=['stdin', 'stdout'],
181
 
                                      attach_fhs={'stderr': devnull})
182
 
                with contextlib.closing(proc.handles['stdin']) as f:
183
 
                    f.write(data)
184
 
                with contextlib.closing(proc.handles['stdout']) as f:
185
 
                    ciphertext = f.read()
186
 
                proc.wait()
187
 
            except IOError as e:
188
 
                raise PGPError(e)
189
 
        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)
190
199
        return ciphertext
191
200
    
192
201
    def decrypt(self, data, password):
193
 
        self.gnupg.passphrase = self.password_encode(password)
194
 
        with open(os.devnull) as devnull:
195
 
            try:
196
 
                proc = self.gnupg.run(['--decrypt'],
197
 
                                      create_fhs=['stdin', 'stdout'],
198
 
                                      attach_fhs={'stderr': devnull})
199
 
                with contextlib.closing(proc.handles['stdin'] ) as f:
200
 
                    f.write(data)
201
 
                with contextlib.closing(proc.handles['stdout']) as f:
202
 
                    decrypted_plaintext = f.read()
203
 
                proc.wait()
204
 
            except IOError as e:
205
 
                raise PGPError(e)
206
 
        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)
207
218
        return decrypted_plaintext
208
219
 
209
220
 
210
 
 
211
221
class AvahiError(Exception):
212
222
    def __init__(self, value, *args, **kwargs):
213
223
        self.value = value
230
240
               Used to optionally bind to the specified interface.
231
241
    name: string; Example: 'Mandos'
232
242
    type: string; Example: '_mandos._tcp'.
233
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
243
     See <https://www.iana.org/assignments/service-names-port-numbers>
234
244
    port: integer; what port to announce
235
245
    TXT: list of strings; TXT record for the service
236
246
    domain: string; Domain to publish on, default to .local if empty.
242
252
    server: D-Bus Server
243
253
    bus: dbus.SystemBus()
244
254
    """
 
255
    
245
256
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
246
257
                 servicetype = None, port = None, TXT = None,
247
258
                 domain = "", host = "", max_renames = 32768,
260
271
        self.server = None
261
272
        self.bus = bus
262
273
        self.entry_group_state_changed_match = None
 
274
    
263
275
    def rename(self):
264
276
        """Derived from the Avahi example code"""
265
277
        if self.rename_count >= self.max_renames:
275
287
        try:
276
288
            self.add()
277
289
        except dbus.exceptions.DBusException as error:
278
 
            logger.critical("DBusException: %s", error)
 
290
            logger.critical("D-Bus Exception", exc_info=error)
279
291
            self.cleanup()
280
292
            os._exit(1)
281
293
        self.rename_count += 1
 
294
    
282
295
    def remove(self):
283
296
        """Derived from the Avahi example code"""
284
297
        if self.entry_group_state_changed_match is not None:
286
299
            self.entry_group_state_changed_match = None
287
300
        if self.group is not None:
288
301
            self.group.Reset()
 
302
    
289
303
    def add(self):
290
304
        """Derived from the Avahi example code"""
291
305
        self.remove()
308
322
            dbus.UInt16(self.port),
309
323
            avahi.string_array_to_txt_array(self.TXT))
310
324
        self.group.Commit()
 
325
    
311
326
    def entry_group_state_changed(self, state, error):
312
327
        """Derived from the Avahi example code"""
313
328
        logger.debug("Avahi entry group state change: %i", state)
320
335
        elif state == avahi.ENTRY_GROUP_FAILURE:
321
336
            logger.critical("Avahi: Error in group state changed %s",
322
337
                            unicode(error))
323
 
            raise AvahiGroupError("State changed: %s"
324
 
                                  % unicode(error))
 
338
            raise AvahiGroupError("State changed: {0!s}"
 
339
                                  .format(error))
 
340
    
325
341
    def cleanup(self):
326
342
        """Derived from the Avahi example code"""
327
343
        if self.group is not None:
332
348
                pass
333
349
            self.group = None
334
350
        self.remove()
 
351
    
335
352
    def server_state_changed(self, state, error=None):
336
353
        """Derived from the Avahi example code"""
337
354
        logger.debug("Avahi server state change: %i", state)
356
373
                logger.debug("Unknown state: %r", state)
357
374
            else:
358
375
                logger.debug("Unknown state: %r: %r", state, error)
 
376
    
359
377
    def activate(self):
360
378
        """Derived from the Avahi example code"""
361
379
        if self.server is None:
368
386
                                 self.server_state_changed)
369
387
        self.server_state_changed(self.server.GetState())
370
388
 
 
389
 
371
390
class AvahiServiceToSyslog(AvahiService):
372
391
    def rename(self):
373
392
        """Add the new name to the syslog messages"""
374
393
        ret = AvahiService.rename(self)
375
394
        syslogger.setFormatter(logging.Formatter
376
 
                               ('Mandos (%s) [%%(process)d]:'
377
 
                                ' %%(levelname)s: %%(message)s'
378
 
                                % self.name))
 
395
                               ('Mandos ({0}) [%(process)d]:'
 
396
                                ' %(levelname)s: %(message)s'
 
397
                                .format(self.name)))
379
398
        return ret
380
399
 
 
400
 
381
401
def timedelta_to_milliseconds(td):
382
402
    "Convert a datetime.timedelta() to milliseconds"
383
403
    return ((td.days * 24 * 60 * 60 * 1000)
384
404
            + (td.seconds * 1000)
385
405
            + (td.microseconds // 1000))
386
 
        
 
406
 
 
407
 
387
408
class Client(object):
388
409
    """A representation of a client host served by this server.
389
410
    
414
435
    last_checked_ok: datetime.datetime(); (UTC) or None
415
436
    last_checker_status: integer between 0 and 255 reflecting exit
416
437
                         status of last checker. -1 reflects crashed
417
 
                         checker, or None.
 
438
                         checker, -2 means no checker completed yet.
418
439
    last_enabled: datetime.datetime(); (UTC) or None
419
440
    name:       string; from the config file, used in log messages and
420
441
                        D-Bus identifiers
421
442
    secret:     bytestring; sent verbatim (over TLS) to client
422
443
    timeout:    datetime.timedelta(); How long from last_checked_ok
423
444
                                      until this client is disabled
424
 
    extended_timeout:   extra long timeout when password has been sent
 
445
    extended_timeout:   extra long timeout when secret has been sent
425
446
    runtime_expansions: Allowed attributes for runtime expansion.
426
447
    expires:    datetime.datetime(); time (UTC) when a client will be
427
448
                disabled, or None
 
449
    server_settings: The server_settings dict from main()
428
450
    """
429
451
    
430
452
    runtime_expansions = ("approval_delay", "approval_duration",
431
 
                          "created", "enabled", "fingerprint",
432
 
                          "host", "interval", "last_checked_ok",
 
453
                          "created", "enabled", "expires",
 
454
                          "fingerprint", "host", "interval",
 
455
                          "last_approval_request", "last_checked_ok",
433
456
                          "last_enabled", "name", "timeout")
434
 
    client_defaults = { "timeout": "5m",
435
 
                        "extended_timeout": "15m",
436
 
                        "interval": "2m",
 
457
    client_defaults = { "timeout": "PT5M",
 
458
                        "extended_timeout": "PT15M",
 
459
                        "interval": "PT2M",
437
460
                        "checker": "fping -q -- %%(host)s",
438
461
                        "host": "",
439
 
                        "approval_delay": "0s",
440
 
                        "approval_duration": "1s",
 
462
                        "approval_delay": "PT0S",
 
463
                        "approval_duration": "PT1S",
441
464
                        "approved_by_default": "True",
442
465
                        "enabled": "True",
443
466
                        }
456
479
    
457
480
    def approval_delay_milliseconds(self):
458
481
        return timedelta_to_milliseconds(self.approval_delay)
459
 
 
 
482
    
460
483
    @staticmethod
461
484
    def config_parser(config):
462
 
        """ Construct a new dict of client settings of this form:
 
485
        """Construct a new dict of client settings of this form:
463
486
        { client_name: {setting_name: value, ...}, ...}
464
 
        with exceptions for any special settings as defined above"""
 
487
        with exceptions for any special settings as defined above.
 
488
        NOTE: Must be a pure function. Must return the same result
 
489
        value given the same arguments.
 
490
        """
465
491
        settings = {}
466
492
        for client_name in config.sections():
467
493
            section = dict(config.items(client_name))
471
497
            # Reformat values from string types to Python types
472
498
            client["approved_by_default"] = config.getboolean(
473
499
                client_name, "approved_by_default")
474
 
            client["enabled"] = config.getboolean(client_name, "enabled")
 
500
            client["enabled"] = config.getboolean(client_name,
 
501
                                                  "enabled")
475
502
            
476
503
            client["fingerprint"] = (section["fingerprint"].upper()
477
504
                                     .replace(" ", ""))
483
510
                          "rb") as secfile:
484
511
                    client["secret"] = secfile.read()
485
512
            else:
486
 
                raise TypeError("No secret or secfile for section %s"
487
 
                                % section)
 
513
                raise TypeError("No secret or secfile for section {0}"
 
514
                                .format(section))
488
515
            client["timeout"] = string_to_delta(section["timeout"])
489
516
            client["extended_timeout"] = string_to_delta(
490
517
                section["extended_timeout"])
496
523
            client["checker_command"] = section["checker"]
497
524
            client["last_approval_request"] = None
498
525
            client["last_checked_ok"] = None
499
 
            client["last_checker_status"] = None
500
 
            if client["enabled"]:
501
 
                client["last_enabled"] = datetime.datetime.utcnow()
502
 
                client["expires"] = (datetime.datetime.utcnow()
503
 
                                     + client["timeout"])
504
 
            else:
505
 
                client["last_enabled"] = None
506
 
                client["expires"] = None
507
 
 
 
526
            client["last_checker_status"] = -2
 
527
        
508
528
        return settings
509
 
        
510
 
        
511
 
    def __init__(self, settings, name = None):
512
 
        """Note: the 'checker' key in 'config' sets the
513
 
        'checker_command' attribute and *not* the 'checker'
514
 
        attribute."""
 
529
    
 
530
    def __init__(self, settings, name = None, server_settings=None):
515
531
        self.name = name
 
532
        if server_settings is None:
 
533
            server_settings = {}
 
534
        self.server_settings = server_settings
516
535
        # adding all client settings
517
536
        for setting, value in settings.iteritems():
518
537
            setattr(self, setting, value)
519
538
        
 
539
        if self.enabled:
 
540
            if not hasattr(self, "last_enabled"):
 
541
                self.last_enabled = datetime.datetime.utcnow()
 
542
            if not hasattr(self, "expires"):
 
543
                self.expires = (datetime.datetime.utcnow()
 
544
                                + self.timeout)
 
545
        else:
 
546
            self.last_enabled = None
 
547
            self.expires = None
 
548
        
520
549
        logger.debug("Creating client %r", self.name)
521
550
        # Uppercase and remove spaces from fingerprint for later
522
551
        # comparison purposes with return value from the fingerprint()
523
552
        # function
524
553
        logger.debug("  Fingerprint: %s", self.fingerprint)
525
 
        self.created = settings.get("created", datetime.datetime.utcnow())
526
 
 
 
554
        self.created = settings.get("created",
 
555
                                    datetime.datetime.utcnow())
 
556
        
527
557
        # attributes specific for this server instance
528
558
        self.checker = None
529
559
        self.checker_initiator_tag = None
557
587
        if getattr(self, "enabled", False):
558
588
            # Already enabled
559
589
            return
560
 
        self.send_changedstate()
561
590
        self.expires = datetime.datetime.utcnow() + self.timeout
562
591
        self.enabled = True
563
592
        self.last_enabled = datetime.datetime.utcnow()
564
593
        self.init_checker()
 
594
        self.send_changedstate()
565
595
    
566
596
    def disable(self, quiet=True):
567
597
        """Disable this client."""
568
598
        if not getattr(self, "enabled", False):
569
599
            return False
570
600
        if not quiet:
571
 
            self.send_changedstate()
572
 
        if not quiet:
573
601
            logger.info("Disabling client %s", self.name)
574
 
        if getattr(self, "disable_initiator_tag", False):
 
602
        if getattr(self, "disable_initiator_tag", None) is not None:
575
603
            gobject.source_remove(self.disable_initiator_tag)
576
604
            self.disable_initiator_tag = None
577
605
        self.expires = None
578
 
        if getattr(self, "checker_initiator_tag", False):
 
606
        if getattr(self, "checker_initiator_tag", None) is not None:
579
607
            gobject.source_remove(self.checker_initiator_tag)
580
608
            self.checker_initiator_tag = None
581
609
        self.stop_checker()
582
610
        self.enabled = False
 
611
        if not quiet:
 
612
            self.send_changedstate()
583
613
        # Do not run this again if called by a gobject.timeout_add
584
614
        return False
585
615
    
589
619
    def init_checker(self):
590
620
        # Schedule a new checker to be started an 'interval' from now,
591
621
        # and every interval from then on.
 
622
        if self.checker_initiator_tag is not None:
 
623
            gobject.source_remove(self.checker_initiator_tag)
592
624
        self.checker_initiator_tag = (gobject.timeout_add
593
625
                                      (self.interval_milliseconds(),
594
626
                                       self.start_checker))
595
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)
596
630
        self.disable_initiator_tag = (gobject.timeout_add
597
631
                                   (self.timeout_milliseconds(),
598
632
                                    self.disable))
617
651
            logger.warning("Checker for %(name)s crashed?",
618
652
                           vars(self))
619
653
    
620
 
    def checked_ok(self, timeout=None):
621
 
        """Bump up the timeout for this client.
622
 
        
623
 
        This should only be called when the client has been seen,
624
 
        alive and well.
625
 
        """
 
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."""
626
662
        if timeout is None:
627
663
            timeout = self.timeout
628
 
        self.last_checked_ok = datetime.datetime.utcnow()
629
664
        if self.disable_initiator_tag is not None:
630
665
            gobject.source_remove(self.disable_initiator_tag)
 
666
            self.disable_initiator_tag = None
631
667
        if getattr(self, "enabled", False):
632
668
            self.disable_initiator_tag = (gobject.timeout_add
633
669
                                          (timedelta_to_milliseconds
643
679
        If a checker already exists, leave it running and do
644
680
        nothing."""
645
681
        # The reason for not killing a running checker is that if we
646
 
        # did that, then if a checker (for some reason) started
647
 
        # running slowly and taking more than 'interval' time, the
648
 
        # client would inevitably timeout, since no checker would get
649
 
        # 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
650
686
        # checkers alone, the checker would have to take more time
651
687
        # than 'timeout' for the client to be disabled, which is as it
652
688
        # should be.
666
702
                                      self.current_checker_command)
667
703
        # Start a new checker if needed
668
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)
669
710
            try:
670
 
                # In case checker_command has exactly one % operator
671
 
                command = self.checker_command % self.host
672
 
            except TypeError:
673
 
                # Escape attributes for the shell
674
 
                escaped_attrs = dict(
675
 
                    (attr,
676
 
                     re.escape(unicode(str(getattr(self, attr, "")),
677
 
                                       errors=
678
 
                                       'replace')))
679
 
                    for attr in
680
 
                    self.runtime_expansions)
681
 
                
682
 
                try:
683
 
                    command = self.checker_command % escaped_attrs
684
 
                except TypeError as error:
685
 
                    logger.error('Could not format string "%s":'
686
 
                                 ' %s', self.checker_command, error)
687
 
                    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
688
716
            self.current_checker_command = command
689
717
            try:
690
718
                logger.info("Starting checker %r for %s",
693
721
                # in normal mode, that is already done by daemon(),
694
722
                # and in debug mode we don't want to.  (Stdin is
695
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 })
696
732
                self.checker = subprocess.Popen(command,
697
733
                                                close_fds=True,
698
 
                                                shell=True, cwd="/")
699
 
                self.checker_callback_tag = (gobject.child_watch_add
700
 
                                             (self.checker.pid,
701
 
                                              self.checker_callback,
702
 
                                              data=command))
703
 
                # The checker may have completed before the gobject
704
 
                # 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:
705
747
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
706
 
                if pid:
707
 
                    gobject.source_remove(self.checker_callback_tag)
708
 
                    self.checker_callback(pid, status, command)
709
748
            except OSError as error:
710
 
                logger.error("Failed to start subprocess: %s",
711
 
                             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)
712
758
        # Re-run this periodically if run by gobject.timeout_add
713
759
        return True
714
760
    
721
767
            return
722
768
        logger.debug("Stopping checker for %(name)s", vars(self))
723
769
        try:
724
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
770
            self.checker.terminate()
725
771
            #time.sleep(0.5)
726
772
            #if self.checker.poll() is None:
727
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
773
            #    self.checker.kill()
728
774
        except OSError as error:
729
775
            if error.errno != errno.ESRCH: # No such process
730
776
                raise
747
793
    # "Set" method, so we fail early here:
748
794
    if byte_arrays and signature != "ay":
749
795
        raise ValueError("Byte arrays not supported for non-'ay'"
750
 
                         " signature %r" % signature)
 
796
                         " signature {0!r}".format(signature))
751
797
    def decorator(func):
752
798
        func._dbus_is_property = True
753
799
        func._dbus_interface = dbus_interface
761
807
    return decorator
762
808
 
763
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
 
764
847
class DBusPropertyException(dbus.exceptions.DBusException):
765
848
    """A base class for D-Bus property-related exceptions
766
849
    """
789
872
    """
790
873
    
791
874
    @staticmethod
792
 
    def _is_dbus_property(obj):
793
 
        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)
794
883
    
795
 
    def _get_all_dbus_properties(self):
 
884
    def _get_all_dbus_things(self, thing):
796
885
        """Returns a generator of (name, attribute) pairs
797
886
        """
798
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
887
        return ((getattr(athing.__get__(self), "_dbus_name",
 
888
                         name),
 
889
                 athing.__get__(self))
799
890
                for cls in self.__class__.__mro__
800
 
                for name, prop in
801
 
                inspect.getmembers(cls, self._is_dbus_property))
 
891
                for name, athing in
 
892
                inspect.getmembers(cls,
 
893
                                   self._is_dbus_thing(thing)))
802
894
    
803
895
    def _get_dbus_property(self, interface_name, property_name):
804
896
        """Returns a bound method if one exists which is a D-Bus
806
898
        """
807
899
        for cls in  self.__class__.__mro__:
808
900
            for name, value in (inspect.getmembers
809
 
                                (cls, self._is_dbus_property)):
 
901
                                (cls,
 
902
                                 self._is_dbus_thing("property"))):
810
903
                if (value._dbus_name == property_name
811
904
                    and value._dbus_interface == interface_name):
812
905
                    return value.__get__(self)
841
934
            # signatures other than "ay".
842
935
            if prop._dbus_signature != "ay":
843
936
                raise ValueError
844
 
            value = dbus.ByteArray(''.join(unichr(byte)
845
 
                                           for byte in value))
 
937
            value = dbus.ByteArray(b''.join(chr(byte)
 
938
                                            for byte in value))
846
939
        prop(value)
847
940
    
848
941
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
854
947
        Note: Will not include properties with access="write".
855
948
        """
856
949
        properties = {}
857
 
        for name, prop in self._get_all_dbus_properties():
 
950
        for name, prop in self._get_all_dbus_things("property"):
858
951
            if (interface_name
859
952
                and interface_name != prop._dbus_interface):
860
953
                # Interface non-empty but did not match
875
968
                         path_keyword='object_path',
876
969
                         connection_keyword='connection')
877
970
    def Introspect(self, object_path, connection):
878
 
        """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.
879
974
        """
880
975
        xmlstring = dbus.service.Object.Introspect(self, object_path,
881
976
                                                   connection)
888
983
                e.setAttribute("access", prop._dbus_access)
889
984
                return e
890
985
            for if_tag in document.getElementsByTagName("interface"):
 
986
                # Add property tags
891
987
                for tag in (make_tag(document, name, prop)
892
988
                            for name, prop
893
 
                            in self._get_all_dbus_properties()
 
989
                            in self._get_all_dbus_things("property")
894
990
                            if prop._dbus_interface
895
991
                            == if_tag.getAttribute("name")):
896
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)
897
1024
                # Add the names to the return values for the
898
1025
                # "org.freedesktop.DBus.Properties" methods
899
1026
                if (if_tag.getAttribute("name")
914
1041
        except (AttributeError, xml.dom.DOMException,
915
1042
                xml.parsers.expat.ExpatError) as error:
916
1043
            logger.error("Failed to override Introspection method",
917
 
                         error)
 
1044
                         exc_info=error)
918
1045
        return xmlstring
919
1046
 
920
1047
 
921
 
def datetime_to_dbus (dt, variant_level=0):
 
1048
def datetime_to_dbus(dt, variant_level=0):
922
1049
    """Convert a UTC datetime.datetime() to a D-Bus type."""
923
1050
    if dt is None:
924
1051
        return dbus.String("", variant_level = variant_level)
926
1053
                       variant_level=variant_level)
927
1054
 
928
1055
 
929
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
930
 
                                  .__metaclass__):
931
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
932
 
    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).
933
1078
    """
934
 
    def __new__(mcs, name, bases, attr):
935
 
        # Go through all the base classes which could have D-Bus
936
 
        # methods, signals, or properties in them
937
 
        for base in (b for b in bases
938
 
                     if issubclass(b, dbus.service.Object)):
939
 
            # Go though all attributes of the base class
940
 
            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):
941
1086
                # Ignore non-D-Bus attributes, and D-Bus attributes
942
1087
                # with the wrong interface name
943
1088
                if (not hasattr(attribute, "_dbus_interface")
944
1089
                    or not attribute._dbus_interface
945
 
                    .startswith("se.recompile.Mandos")):
 
1090
                    .startswith(orig_interface_name)):
946
1091
                    continue
947
1092
                # Create an alternate D-Bus interface name based on
948
1093
                # the current name
949
1094
                alt_interface = (attribute._dbus_interface
950
 
                                 .replace("se.recompile.Mandos",
951
 
                                          "se.bsnet.fukt.Mandos"))
 
1095
                                 .replace(orig_interface_name,
 
1096
                                          alt_interface_name))
 
1097
                interface_names.add(alt_interface)
952
1098
                # Is this a D-Bus signal?
953
1099
                if getattr(attribute, "_dbus_is_signal", False):
954
 
                    # Extract the original non-method function by
955
 
                    # black magic
 
1100
                    # Extract the original non-method undecorated
 
1101
                    # function by black magic
956
1102
                    nonmethod_func = (dict(
957
1103
                            zip(attribute.func_code.co_freevars,
958
1104
                                attribute.__closure__))["func"]
969
1115
                                nonmethod_func.func_name,
970
1116
                                nonmethod_func.func_defaults,
971
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
972
1124
                    # Define a creator of a function to call both the
973
 
                    # old and new functions, so both the old and new
974
 
                    # 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
975
1128
                    def fixscope(func1, func2):
976
1129
                        """This function is a scope container to pass
977
1130
                        func1 and func2 to the "call_both" function
984
1137
                        return call_both
985
1138
                    # Create the "call_both" function and add it to
986
1139
                    # the class
987
 
                    attr[attrname] = fixscope(attribute,
988
 
                                              new_function)
 
1140
                    attr[attrname] = fixscope(attribute, new_function)
989
1141
                # Is this a D-Bus method?
990
1142
                elif getattr(attribute, "_dbus_is_method", False):
991
1143
                    # Create a new, but exactly alike, function
1002
1154
                                        attribute.func_name,
1003
1155
                                        attribute.func_defaults,
1004
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
1005
1163
                # Is this a D-Bus property?
1006
1164
                elif getattr(attribute, "_dbus_is_property", False):
1007
1165
                    # Create a new, but exactly alike, function
1021
1179
                                        attribute.func_name,
1022
1180
                                        attribute.func_defaults,
1023
1181
                                        attribute.func_closure)))
1024
 
        return type.__new__(mcs, name, bases, attr)
1025
 
 
1026
 
 
 
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"})
1027
1227
class ClientDBus(Client, DBusObjectWithProperties):
1028
1228
    """A Client class using D-Bus
1029
1229
    
1040
1240
    def __init__(self, bus = None, *args, **kwargs):
1041
1241
        self.bus = bus
1042
1242
        Client.__init__(self, *args, **kwargs)
1043
 
        self._approvals_pending = 0
1044
 
        
1045
 
        self._approvals_pending = 0
1046
1243
        # Only now, when this client is initialized, can it show up on
1047
1244
        # the D-Bus
1048
1245
        client_object_name = unicode(self.name).translate(
1052
1249
                                 ("/clients/" + client_object_name))
1053
1250
        DBusObjectWithProperties.__init__(self, self.bus,
1054
1251
                                          self.dbus_object_path)
1055
 
        
 
1252
    
1056
1253
    def notifychangeproperty(transform_func,
1057
1254
                             dbus_name, type_func=lambda x: x,
1058
1255
                             variant_level=1):
1081
1278
        
1082
1279
        return property(lambda self: getattr(self, attrname), setter)
1083
1280
    
1084
 
    
1085
1281
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1086
1282
    approvals_pending = notifychangeproperty(dbus.Boolean,
1087
1283
                                             "ApprovalPending",
1094
1290
                                       checker is not None)
1095
1291
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1096
1292
                                           "LastCheckedOK")
 
1293
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1294
                                               "LastCheckerStatus")
1097
1295
    last_approval_request = notifychangeproperty(
1098
1296
        datetime_to_dbus, "LastApprovalRequest")
1099
1297
    approved_by_default = notifychangeproperty(dbus.Boolean,
1167
1365
        return False
1168
1366
    
1169
1367
    def approve(self, value=True):
1170
 
        self.send_changedstate()
1171
1368
        self.approved = value
1172
1369
        gobject.timeout_add(timedelta_to_milliseconds
1173
1370
                            (self.approval_duration),
1174
1371
                            self._reset_approved)
1175
 
    
 
1372
        self.send_changedstate()
1176
1373
    
1177
1374
    ## D-Bus methods, signals & properties
1178
1375
    _interface = "se.recompile.Mandos.Client"
1179
1376
    
 
1377
    ## Interfaces
 
1378
    
 
1379
    @dbus_interface_annotations(_interface)
 
1380
    def _foo(self):
 
1381
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1382
                     "false"}
 
1383
    
1180
1384
    ## Signals
1181
1385
    
1182
1386
    # CheckerCompleted - signal
1218
1422
        "D-Bus signal"
1219
1423
        return self.need_approval()
1220
1424
    
1221
 
    # NeRwequest - signal
1222
 
    @dbus.service.signal(_interface, signature="s")
1223
 
    def NewRequest(self, ip):
1224
 
        """D-Bus signal
1225
 
        Is sent after a client request a password.
1226
 
        """
1227
 
        pass
1228
 
    
1229
1425
    ## Methods
1230
1426
    
1231
1427
    # Approve - method
1341
1537
            return
1342
1538
        return datetime_to_dbus(self.last_checked_ok)
1343
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
    
1344
1546
    # Expires - property
1345
1547
    @dbus_service_property(_interface, signature="s", access="read")
1346
1548
    def Expires_dbus_property(self):
1357
1559
    def Timeout_dbus_property(self, value=None):
1358
1560
        if value is None:       # get
1359
1561
            return dbus.UInt64(self.timeout_milliseconds())
 
1562
        old_timeout = self.timeout
1360
1563
        self.timeout = datetime.timedelta(0, 0, 0, value)
1361
 
        if getattr(self, "disable_initiator_tag", None) is None:
1362
 
            return
1363
 
        # Reschedule timeout
1364
 
        gobject.source_remove(self.disable_initiator_tag)
1365
 
        self.disable_initiator_tag = None
1366
 
        self.expires = None
1367
 
        time_to_die = timedelta_to_milliseconds((self
1368
 
                                                 .last_checked_ok
1369
 
                                                 + self.timeout)
1370
 
                                                - datetime.datetime
1371
 
                                                .utcnow())
1372
 
        if time_to_die <= 0:
1373
 
            # The timeout has passed
1374
 
            self.disable()
1375
 
        else:
1376
 
            self.expires = (datetime.datetime.utcnow()
1377
 
                            + datetime.timedelta(milliseconds =
1378
 
                                                 time_to_die))
1379
 
            self.disable_initiator_tag = (gobject.timeout_add
1380
 
                                          (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))
1381
1580
    
1382
1581
    # ExtendedTimeout - property
1383
1582
    @dbus_service_property(_interface, signature="t",
1462
1661
        self._pipe.send(('setattr', name, value))
1463
1662
 
1464
1663
 
1465
 
class ClientDBusTransitional(ClientDBus):
1466
 
    __metaclass__ = AlternateDBusNamesMetaclass
1467
 
 
1468
 
 
1469
1664
class ClientHandler(socketserver.BaseRequestHandler, object):
1470
1665
    """A class to handle client connections.
1471
1666
    
1539
1734
                except KeyError:
1540
1735
                    return
1541
1736
                
1542
 
                if self.server.use_dbus:
1543
 
                    # Emit D-Bus signal
1544
 
                    client.NewRequest(str(self.client_address))
1545
 
                
1546
1737
                if client.approval_delay:
1547
1738
                    delay = client.approval_delay
1548
1739
                    client.approvals_pending += 1
1579
1770
                    #wait until timeout or approved
1580
1771
                    time = datetime.datetime.now()
1581
1772
                    client.changedstate.acquire()
1582
 
                    (client.changedstate.wait
1583
 
                     (float(client.timedelta_to_milliseconds(delay)
1584
 
                            / 1000)))
 
1773
                    client.changedstate.wait(
 
1774
                        float(timedelta_to_milliseconds(delay)
 
1775
                              / 1000))
1585
1776
                    client.changedstate.release()
1586
1777
                    time2 = datetime.datetime.now()
1587
1778
                    if (time2 - time) >= delay:
1603
1794
                    try:
1604
1795
                        sent = session.send(client.secret[sent_size:])
1605
1796
                    except gnutls.errors.GNUTLSError as error:
1606
 
                        logger.warning("gnutls send failed")
 
1797
                        logger.warning("gnutls send failed",
 
1798
                                       exc_info=error)
1607
1799
                        return
1608
1800
                    logger.debug("Sent: %d, remaining: %d",
1609
1801
                                 sent, len(client.secret)
1612
1804
                
1613
1805
                logger.info("Sending secret to %s", client.name)
1614
1806
                # bump the timeout using extended_timeout
1615
 
                client.checked_ok(client.extended_timeout)
 
1807
                client.bump_timeout(client.extended_timeout)
1616
1808
                if self.server.use_dbus:
1617
1809
                    # Emit D-Bus signal
1618
1810
                    client.GotSecret()
1623
1815
                try:
1624
1816
                    session.bye()
1625
1817
                except gnutls.errors.GNUTLSError as error:
1626
 
                    logger.warning("GnuTLS bye failed")
 
1818
                    logger.warning("GnuTLS bye failed",
 
1819
                                   exc_info=error)
1627
1820
    
1628
1821
    @staticmethod
1629
1822
    def peer_certificate(session):
1701
1894
    def process_request(self, request, address):
1702
1895
        """Start a new process to process the request."""
1703
1896
        proc = multiprocessing.Process(target = self.sub_process_main,
1704
 
                                       args = (request,
1705
 
                                               address))
 
1897
                                       args = (request, address))
1706
1898
        proc.start()
1707
1899
        return proc
1708
1900
 
1736
1928
        use_ipv6:       Boolean; to use IPv6 or not
1737
1929
    """
1738
1930
    def __init__(self, server_address, RequestHandlerClass,
1739
 
                 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
        """
1740
1935
        self.interface = interface
1741
1936
        if use_ipv6:
1742
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.
1743
1964
        socketserver.TCPServer.__init__(self, server_address,
1744
1965
                                        RequestHandlerClass)
 
1966
    
1745
1967
    def server_bind(self):
1746
1968
        """This overrides the normal server_bind() function
1747
1969
        to bind to an interface if one was specified, and also NOT to
1755
1977
                try:
1756
1978
                    self.socket.setsockopt(socket.SOL_SOCKET,
1757
1979
                                           SO_BINDTODEVICE,
1758
 
                                           str(self.interface
1759
 
                                               + '\0'))
 
1980
                                           str(self.interface + '\0'))
1760
1981
                except socket.error as error:
1761
 
                    if error[0] == errno.EPERM:
1762
 
                        logger.error("No permission to"
1763
 
                                     " bind to interface %s",
1764
 
                                     self.interface)
1765
 
                    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:
1766
1986
                        logger.error("SO_BINDTODEVICE not available;"
1767
1987
                                     " cannot bind to interface %s",
1768
1988
                                     self.interface)
 
1989
                    elif error.errno == errno.ENODEV:
 
1990
                        logger.error("Interface %s does not exist,"
 
1991
                                     " cannot bind", self.interface)
1769
1992
                    else:
1770
1993
                        raise
1771
1994
        # Only bind(2) the socket if we really need to.
1774
1997
                if self.address_family == socket.AF_INET6:
1775
1998
                    any_address = "::" # in6addr_any
1776
1999
                else:
1777
 
                    any_address = socket.INADDR_ANY
 
2000
                    any_address = "0.0.0.0" # INADDR_ANY
1778
2001
                self.server_address = (any_address,
1779
2002
                                       self.server_address[1])
1780
2003
            elif not self.server_address[1]:
1801
2024
    """
1802
2025
    def __init__(self, server_address, RequestHandlerClass,
1803
2026
                 interface=None, use_ipv6=True, clients=None,
1804
 
                 gnutls_priority=None, use_dbus=True):
 
2027
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1805
2028
        self.enabled = False
1806
2029
        self.clients = clients
1807
2030
        if self.clients is None:
1811
2034
        IPv6_TCPServer.__init__(self, server_address,
1812
2035
                                RequestHandlerClass,
1813
2036
                                interface = interface,
1814
 
                                use_ipv6 = use_ipv6)
 
2037
                                use_ipv6 = use_ipv6,
 
2038
                                socketfd = socketfd)
1815
2039
    def server_activate(self):
1816
2040
        if self.enabled:
1817
2041
            return socketserver.TCPServer.server_activate(self)
1830
2054
    
1831
2055
    def handle_ipc(self, source, condition, parent_pipe=None,
1832
2056
                   proc = None, client_object=None):
1833
 
        condition_names = {
1834
 
            gobject.IO_IN: "IN",   # There is data to read.
1835
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1836
 
                                    # blocking).
1837
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1838
 
            gobject.IO_ERR: "ERR", # Error condition.
1839
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1840
 
                                    # broken, usually for pipes and
1841
 
                                    # sockets).
1842
 
            }
1843
 
        conditions_string = ' | '.join(name
1844
 
                                       for cond, name in
1845
 
                                       condition_names.iteritems()
1846
 
                                       if cond & condition)
1847
2057
        # error, or the other end of multiprocessing.Pipe has closed
1848
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2058
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1849
2059
            # Wait for other process to exit
1850
2060
            proc.join()
1851
2061
            return False
1909
2119
        return True
1910
2120
 
1911
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
 
1912
2221
def string_to_delta(interval):
1913
2222
    """Parse a string and return a datetime.timedelta
1914
2223
    
1925
2234
    >>> string_to_delta('5m 30s')
1926
2235
    datetime.timedelta(0, 330)
1927
2236
    """
 
2237
    
 
2238
    try:
 
2239
        return rfc3339_duration_to_delta(interval)
 
2240
    except ValueError:
 
2241
        pass
 
2242
    
1928
2243
    timevalue = datetime.timedelta(0)
1929
2244
    for s in interval.split():
1930
2245
        try:
1941
2256
            elif suffix == "w":
1942
2257
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1943
2258
            else:
1944
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2259
                raise ValueError("Unknown suffix {0!r}"
 
2260
                                 .format(suffix))
1945
2261
        except (ValueError, IndexError) as e:
1946
2262
            raise ValueError(*(e.args))
1947
2263
        timevalue += delta
1961
2277
        sys.exit()
1962
2278
    if not noclose:
1963
2279
        # Close all standard open file descriptors
1964
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2280
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1965
2281
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1966
2282
            raise OSError(errno.ENODEV,
1967
 
                          "%s not a character device"
1968
 
                          % os.path.devnull)
 
2283
                          "{0} not a character device"
 
2284
                          .format(os.devnull))
1969
2285
        os.dup2(null, sys.stdin.fileno())
1970
2286
        os.dup2(null, sys.stdout.fileno())
1971
2287
        os.dup2(null, sys.stderr.fileno())
1980
2296
    
1981
2297
    parser = argparse.ArgumentParser()
1982
2298
    parser.add_argument("-v", "--version", action="version",
1983
 
                        version = "%%(prog)s %s" % version,
 
2299
                        version = "%(prog)s {0}".format(version),
1984
2300
                        help="show version number and exit")
1985
2301
    parser.add_argument("-i", "--interface", metavar="IF",
1986
2302
                        help="Bind to interface IF")
1992
2308
                        help="Run self-test")
1993
2309
    parser.add_argument("--debug", action="store_true",
1994
2310
                        help="Debug mode; run in foreground and log"
1995
 
                        " to terminal")
 
2311
                        " to terminal", default=None)
1996
2312
    parser.add_argument("--debuglevel", metavar="LEVEL",
1997
2313
                        help="Debug level for stdout output")
1998
2314
    parser.add_argument("--priority", help="GnuTLS"
2005
2321
                        " files")
2006
2322
    parser.add_argument("--no-dbus", action="store_false",
2007
2323
                        dest="use_dbus", help="Do not provide D-Bus"
2008
 
                        " system bus interface")
 
2324
                        " system bus interface", default=None)
2009
2325
    parser.add_argument("--no-ipv6", action="store_false",
2010
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2326
                        dest="use_ipv6", help="Do not use IPv6",
 
2327
                        default=None)
2011
2328
    parser.add_argument("--no-restore", action="store_false",
2012
2329
                        dest="restore", help="Do not restore stored"
2013
 
                        " 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")
2014
2334
    parser.add_argument("--statedir", metavar="DIR",
2015
2335
                        help="Directory to save/restore state in")
 
2336
    parser.add_argument("--foreground", action="store_true",
 
2337
                        help="Run in foreground", default=None)
2016
2338
    
2017
2339
    options = parser.parse_args()
2018
2340
    
2027
2349
                        "port": "",
2028
2350
                        "debug": "False",
2029
2351
                        "priority":
2030
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2352
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2031
2353
                        "servicename": "Mandos",
2032
2354
                        "use_dbus": "True",
2033
2355
                        "use_ipv6": "True",
2034
2356
                        "debuglevel": "",
2035
2357
                        "restore": "True",
2036
 
                        "statedir": "/var/lib/mandos"
 
2358
                        "socket": "",
 
2359
                        "statedir": "/var/lib/mandos",
 
2360
                        "foreground": "False",
2037
2361
                        }
2038
2362
    
2039
2363
    # Parse config file for server-global settings
2044
2368
    # Convert the SafeConfigParser object to a dict
2045
2369
    server_settings = server_config.defaults()
2046
2370
    # Use the appropriate methods on the non-string config options
2047
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2371
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2048
2372
        server_settings[option] = server_config.getboolean("DEFAULT",
2049
2373
                                                           option)
2050
2374
    if server_settings["port"]:
2051
2375
        server_settings["port"] = server_config.getint("DEFAULT",
2052
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"])
2053
2386
    del server_config
2054
2387
    
2055
2388
    # Override the settings from the config file with command line
2057
2390
    for option in ("interface", "address", "port", "debug",
2058
2391
                   "priority", "servicename", "configdir",
2059
2392
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2060
 
                   "statedir"):
 
2393
                   "statedir", "socket", "foreground"):
2061
2394
        value = getattr(options, option)
2062
2395
        if value is not None:
2063
2396
            server_settings[option] = value
2066
2399
    for option in server_settings.keys():
2067
2400
        if type(server_settings[option]) is str:
2068
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
2069
2409
    # Now we have our good server settings in "server_settings"
2070
2410
    
2071
2411
    ##################################################################
2077
2417
    use_ipv6 = server_settings["use_ipv6"]
2078
2418
    stored_state_path = os.path.join(server_settings["statedir"],
2079
2419
                                     stored_state_file)
 
2420
    foreground = server_settings["foreground"]
2080
2421
    
2081
2422
    if debug:
2082
2423
        initlogger(debug, logging.DEBUG)
2089
2430
    
2090
2431
    if server_settings["servicename"] != "Mandos":
2091
2432
        syslogger.setFormatter(logging.Formatter
2092
 
                               ('Mandos (%s) [%%(process)d]:'
2093
 
                                ' %%(levelname)s: %%(message)s'
2094
 
                                % server_settings["servicename"]))
 
2433
                               ('Mandos ({0}) [%(process)d]:'
 
2434
                                ' %(levelname)s: %(message)s'
 
2435
                                .format(server_settings
 
2436
                                        ["servicename"])))
2095
2437
    
2096
2438
    # Parse config file with clients
2097
 
    client_config = configparser.SafeConfigParser(Client.client_defaults)
 
2439
    client_config = configparser.SafeConfigParser(Client
 
2440
                                                  .client_defaults)
2098
2441
    client_config.read(os.path.join(server_settings["configdir"],
2099
2442
                                    "clients.conf"))
2100
2443
    
2109
2452
                              use_ipv6=use_ipv6,
2110
2453
                              gnutls_priority=
2111
2454
                              server_settings["priority"],
2112
 
                              use_dbus=use_dbus)
2113
 
    if not debug:
2114
 
        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
        pidfile = None
2115
2461
        try:
2116
2462
            pidfile = open(pidfilename, "w")
2117
 
        except IOError:
2118
 
            logger.error("Could not open file %r", pidfilename)
 
2463
        except IOError as e:
 
2464
            logger.error("Could not open file %r", pidfilename,
 
2465
                         exc_info=e)
2119
2466
    
2120
 
    try:
2121
 
        uid = pwd.getpwnam("_mandos").pw_uid
2122
 
        gid = pwd.getpwnam("_mandos").pw_gid
2123
 
    except KeyError:
 
2467
    for name in ("_mandos", "mandos", "nobody"):
2124
2468
        try:
2125
 
            uid = pwd.getpwnam("mandos").pw_uid
2126
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2469
            uid = pwd.getpwnam(name).pw_uid
 
2470
            gid = pwd.getpwnam(name).pw_gid
 
2471
            break
2127
2472
        except KeyError:
2128
 
            try:
2129
 
                uid = pwd.getpwnam("nobody").pw_uid
2130
 
                gid = pwd.getpwnam("nobody").pw_gid
2131
 
            except KeyError:
2132
 
                uid = 65534
2133
 
                gid = 65534
 
2473
            continue
 
2474
    else:
 
2475
        uid = 65534
 
2476
        gid = 65534
2134
2477
    try:
2135
2478
        os.setgid(gid)
2136
2479
        os.setuid(uid)
2137
2480
    except OSError as error:
2138
 
        if error[0] != errno.EPERM:
 
2481
        if error.errno != errno.EPERM:
2139
2482
            raise error
2140
2483
    
2141
2484
    if debug:
2153
2496
         .gnutls_global_set_log_function(debug_gnutls))
2154
2497
        
2155
2498
        # Redirect stdin so all checkers get /dev/null
2156
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2499
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2157
2500
        os.dup2(null, sys.stdin.fileno())
2158
2501
        if null > 2:
2159
2502
            os.close(null)
2160
2503
    
2161
2504
    # Need to fork before connecting to D-Bus
2162
 
    if not debug:
 
2505
    if not foreground:
2163
2506
        # Close all input and output, do double fork, etc.
2164
2507
        daemon()
2165
2508
    
 
2509
    # multiprocessing will use threads, so before we use gobject we
 
2510
    # need to inform gobject that threads will be used.
2166
2511
    gobject.threads_init()
2167
2512
    
2168
2513
    global main_loop
2169
2514
    # From the Avahi example code
2170
 
    DBusGMainLoop(set_as_default=True )
 
2515
    DBusGMainLoop(set_as_default=True)
2171
2516
    main_loop = gobject.MainLoop()
2172
2517
    bus = dbus.SystemBus()
2173
2518
    # End of Avahi example code
2179
2524
                            ("se.bsnet.fukt.Mandos", bus,
2180
2525
                             do_not_queue=True))
2181
2526
        except dbus.exceptions.NameExistsException as e:
2182
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2527
            logger.error("Disabling D-Bus:", exc_info=e)
2183
2528
            use_dbus = False
2184
2529
            server_settings["use_dbus"] = False
2185
2530
            tcp_server.use_dbus = False
2197
2542
    
2198
2543
    client_class = Client
2199
2544
    if use_dbus:
2200
 
        client_class = functools.partial(ClientDBusTransitional,
2201
 
                                         bus = bus)
 
2545
        client_class = functools.partial(ClientDBus, bus = bus)
2202
2546
    
2203
2547
    client_settings = Client.config_parser(client_config)
2204
2548
    old_client_settings = {}
2205
2549
    clients_data = {}
2206
2550
    
 
2551
    # This is used to redirect stdout and stderr for checker processes
 
2552
    global wnull
 
2553
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2554
    # Only used if server is running in foreground but not in debug
 
2555
    # mode
 
2556
    if debug or not foreground:
 
2557
        wnull.close()
 
2558
    
2207
2559
    # Get client data and settings from last running state.
2208
2560
    if server_settings["restore"]:
2209
2561
        try:
2212
2564
                                                     (stored_state))
2213
2565
            os.remove(stored_state_path)
2214
2566
        except IOError as e:
2215
 
            logger.warning("Could not load persistent state: {0}"
2216
 
                           .format(e))
2217
 
            if e.errno != errno.ENOENT:
 
2567
            if e.errno == errno.ENOENT:
 
2568
                logger.warning("Could not load persistent state: {0}"
 
2569
                                .format(os.strerror(e.errno)))
 
2570
            else:
 
2571
                logger.critical("Could not load persistent state:",
 
2572
                                exc_info=e)
2218
2573
                raise
2219
2574
        except EOFError as e:
2220
2575
            logger.warning("Could not load persistent state: "
2221
 
                           "EOFError: {0}".format(e))
 
2576
                           "EOFError:", exc_info=e)
2222
2577
    
2223
2578
    with PGPEngine() as pgp:
2224
2579
        for client_name, client in clients_data.iteritems():
 
2580
            # Skip removed clients
 
2581
            if client_name not in client_settings:
 
2582
                continue
 
2583
            
2225
2584
            # Decide which value to use after restoring saved state.
2226
2585
            # We have three different values: Old config file,
2227
2586
            # new config file, and saved state.
2241
2600
            
2242
2601
            # Clients who has passed its expire date can still be
2243
2602
            # enabled if its last checker was successful.  Clients
2244
 
            # whose checker failed before we stored its state is
2245
 
            # assumed to have failed all checkers during downtime.
 
2603
            # whose checker succeeded before we stored its state is
 
2604
            # assumed to have successfully run all checkers during
 
2605
            # downtime.
2246
2606
            if client["enabled"]:
2247
2607
                if datetime.datetime.utcnow() >= client["expires"]:
2248
2608
                    if not client["last_checked_ok"]:
2249
2609
                        logger.warning(
2250
2610
                            "disabling client {0} - Client never "
2251
 
                            "performed a successfull checker"
2252
 
                            .format(client["name"]))
 
2611
                            "performed a successful checker"
 
2612
                            .format(client_name))
2253
2613
                        client["enabled"] = False
2254
2614
                    elif client["last_checker_status"] != 0:
2255
2615
                        logger.warning(
2256
2616
                            "disabling client {0} - Client "
2257
2617
                            "last checker failed with error code {1}"
2258
 
                            .format(client["name"],
 
2618
                            .format(client_name,
2259
2619
                                    client["last_checker_status"]))
2260
2620
                        client["enabled"] = False
2261
2621
                    else:
2262
2622
                        client["expires"] = (datetime.datetime
2263
2623
                                             .utcnow()
2264
2624
                                             + client["timeout"])
2265
 
                    
 
2625
                        logger.debug("Last checker succeeded,"
 
2626
                                     " keeping {0} enabled"
 
2627
                                     .format(client_name))
2266
2628
            try:
2267
2629
                client["secret"] = (
2268
2630
                    pgp.decrypt(client["encrypted_secret"],
2274
2636
                             .format(client_name))
2275
2637
                client["secret"] = (
2276
2638
                    client_settings[client_name]["secret"])
2277
 
 
2278
2639
    
2279
2640
    # Add/remove clients based on new changes made to config
2280
 
    for client_name in set(old_client_settings) - set(client_settings):
 
2641
    for client_name in (set(old_client_settings)
 
2642
                        - set(client_settings)):
2281
2643
        del clients_data[client_name]
2282
 
    for client_name in set(client_settings) - set(old_client_settings):
 
2644
    for client_name in (set(client_settings)
 
2645
                        - set(old_client_settings)):
2283
2646
        clients_data[client_name] = client_settings[client_name]
2284
 
 
2285
 
    # Create clients all clients
 
2647
    
 
2648
    # Create all client objects
2286
2649
    for client_name, client in clients_data.iteritems():
2287
2650
        tcp_server.clients[client_name] = client_class(
2288
 
            name = client_name, settings = client)
 
2651
            name = client_name, settings = client,
 
2652
            server_settings = server_settings)
2289
2653
    
2290
2654
    if not tcp_server.clients:
2291
2655
        logger.warning("No clients defined")
2292
 
        
2293
 
    if not debug:
2294
 
        try:
2295
 
            with pidfile:
2296
 
                pid = os.getpid()
2297
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2298
 
            del pidfile
2299
 
        except IOError:
2300
 
            logger.error("Could not write to file %r with PID %d",
2301
 
                         pidfilename, pid)
2302
 
        except NameError:
2303
 
            # "pidfile" was never created
2304
 
            pass
 
2656
    
 
2657
    if not foreground:
 
2658
        if pidfile is not None:
 
2659
            try:
 
2660
                with pidfile:
 
2661
                    pid = os.getpid()
 
2662
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2663
            except IOError:
 
2664
                logger.error("Could not write to file %r with PID %d",
 
2665
                             pidfilename, pid)
 
2666
        del pidfile
2305
2667
        del pidfilename
2306
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2307
2668
    
2308
2669
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2309
2670
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2310
2671
    
2311
2672
    if use_dbus:
2312
 
        class MandosDBusService(dbus.service.Object):
 
2673
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2674
                                        "se.bsnet.fukt.Mandos"})
 
2675
        class MandosDBusService(DBusObjectWithProperties):
2313
2676
            """A D-Bus proxy object"""
2314
2677
            def __init__(self):
2315
2678
                dbus.service.Object.__init__(self, bus, "/")
2316
2679
            _interface = "se.recompile.Mandos"
2317
2680
            
 
2681
            @dbus_interface_annotations(_interface)
 
2682
            def _foo(self):
 
2683
                return { "org.freedesktop.DBus.Property"
 
2684
                         ".EmitsChangedSignal":
 
2685
                             "false"}
 
2686
            
2318
2687
            @dbus.service.signal(_interface, signature="o")
2319
2688
            def ClientAdded(self, objpath):
2320
2689
                "D-Bus signal"
2362
2731
            
2363
2732
            del _interface
2364
2733
        
2365
 
        class MandosDBusServiceTransitional(MandosDBusService):
2366
 
            __metaclass__ = AlternateDBusNamesMetaclass
2367
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2734
        mandos_dbus_service = MandosDBusService()
2368
2735
    
2369
2736
    def cleanup():
2370
2737
        "Cleanup function; run on exit"
2371
2738
        service.cleanup()
2372
2739
        
2373
2740
        multiprocessing.active_children()
 
2741
        wnull.close()
2374
2742
        if not (tcp_server.clients or client_settings):
2375
2743
            return
2376
2744
        
2388
2756
                # A list of attributes that can not be pickled
2389
2757
                # + secret.
2390
2758
                exclude = set(("bus", "changedstate", "secret",
2391
 
                               "checker"))
 
2759
                               "checker", "server_settings"))
2392
2760
                for name, typ in (inspect.getmembers
2393
2761
                                  (dbus.service.Object)):
2394
2762
                    exclude.add(name)
2403
2771
                del client_settings[client.name]["secret"]
2404
2772
        
2405
2773
        try:
2406
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2407
 
                                                prefix="clients-",
2408
 
                                                dir=os.path.dirname
2409
 
                                                (stored_state_path))
2410
 
            with os.fdopen(tempfd, "wb") as stored_state:
 
2774
            with (tempfile.NamedTemporaryFile
 
2775
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2776
                   dir=os.path.dirname(stored_state_path),
 
2777
                   delete=False)) as stored_state:
2411
2778
                pickle.dump((clients, client_settings), stored_state)
 
2779
                tempname=stored_state.name
2412
2780
            os.rename(tempname, stored_state_path)
2413
2781
        except (IOError, OSError) as e:
2414
 
            logger.warning("Could not save persistent state: {0}"
2415
 
                           .format(e))
2416
2782
            if not debug:
2417
2783
                try:
2418
2784
                    os.remove(tempname)
2419
2785
                except NameError:
2420
2786
                    pass
2421
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2422
 
                                   errno.EEXIST)):
 
2787
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2788
                logger.warning("Could not save persistent state: {0}"
 
2789
                               .format(os.strerror(e.errno)))
 
2790
            else:
 
2791
                logger.warning("Could not save persistent state:",
 
2792
                               exc_info=e)
2423
2793
                raise e
2424
2794
        
2425
2795
        # Delete all clients, and settings from config
2453
2823
    service.port = tcp_server.socket.getsockname()[1]
2454
2824
    if use_ipv6:
2455
2825
        logger.info("Now listening on address %r, port %d,"
2456
 
                    " flowinfo %d, scope_id %d"
2457
 
                    % tcp_server.socket.getsockname())
 
2826
                    " flowinfo %d, scope_id %d",
 
2827
                    *tcp_server.socket.getsockname())
2458
2828
    else:                       # IPv4
2459
 
        logger.info("Now listening on address %r, port %d"
2460
 
                    % tcp_server.socket.getsockname())
 
2829
        logger.info("Now listening on address %r, port %d",
 
2830
                    *tcp_server.socket.getsockname())
2461
2831
    
2462
2832
    #service.interface = tcp_server.socket.getsockname()[3]
2463
2833
    
2466
2836
        try:
2467
2837
            service.activate()
2468
2838
        except dbus.exceptions.DBusException as error:
2469
 
            logger.critical("DBusException: %s", error)
 
2839
            logger.critical("D-Bus Exception", exc_info=error)
2470
2840
            cleanup()
2471
2841
            sys.exit(1)
2472
2842
        # End of Avahi example code
2479
2849
        logger.debug("Starting main loop")
2480
2850
        main_loop.run()
2481
2851
    except AvahiError as error:
2482
 
        logger.critical("AvahiError: %s", error)
 
2852
        logger.critical("Avahi Error", exc_info=error)
2483
2853
        cleanup()
2484
2854
        sys.exit(1)
2485
2855
    except KeyboardInterrupt: