/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-04-24 06:55:34 UTC
  • Revision ID: teddy@recompile.se-20120424065534-n1jqfth9odw3l1jr
* network-hooks.d/bridge: Move "start" and "stop" commands to separate
                          functions.
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -

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