/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-07-13 21:55:28 UTC
  • mfrom: (237.4.49 release)
  • Revision ID: teddy@recompile.se-20140713215528-5lez8qv009g0i1h2
Merge from release branch.

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