/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

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

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

Show diffs side-by-side

added added

removed removed

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