/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2012-01-01 20:45:53 UTC
  • Revision ID: teddy@recompile.se-20120101204553-f1zlty873gswtf5n
* README: Hint that the intro(8mandos) manual page is in the server
          package.

Show diffs side-by-side

added added

removed removed

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