/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-10-13 15:43:42 UTC
  • Revision ID: teddy@recompile.se-20131013154342-2ztabynqog6xuk0t
* initramfs-unpack: Bug fix: Made executable.

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-2012 Teddy Hogeborn
 
15
# Copyright © 2008-2012 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
 
37
from future_builtins import *
 
38
 
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
 
 
89
 
version = "1.4.1"
90
 
stored_state_path = "/var/lib/mandos/clients.pickle"
 
91
version = "1.6.0"
 
92
stored_state_file = "clients.pickle"
91
93
 
92
94
logger = logging.getLogger()
93
95
syslogger = (logging.handlers.SysLogHandler
111
113
        return interface_index
112
114
 
113
115
 
114
 
def initlogger(level=logging.WARNING):
 
116
def initlogger(debug, level=logging.WARNING):
115
117
    """init logger and add loglevel"""
116
118
    
117
119
    syslogger.setFormatter(logging.Formatter
119
121
                            ' %(message)s'))
120
122
    logger.addHandler(syslogger)
121
123
    
122
 
    console = logging.StreamHandler()
123
 
    console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
124
 
                                           ' [%(process)d]:'
125
 
                                           ' %(levelname)s:'
126
 
                                           ' %(message)s'))
127
 
    logger.addHandler(console)
 
124
    if debug:
 
125
        console = logging.StreamHandler()
 
126
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
127
                                               ' [%(process)d]:'
 
128
                                               ' %(levelname)s:'
 
129
                                               ' %(message)s'))
 
130
        logger.addHandler(console)
128
131
    logger.setLevel(level)
129
132
 
130
133
 
131
 
class CryptoError(Exception):
 
134
class PGPError(Exception):
 
135
    """Exception if encryption/decryption fails"""
132
136
    pass
133
137
 
134
138
 
135
 
class Crypto(object):
 
139
class PGPEngine(object):
136
140
    """A simple class for OpenPGP symmetric encryption & decryption"""
137
141
    def __init__(self):
138
 
        self.gnupg = GnuPGInterface.GnuPG()
139
142
        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'])
 
143
        self.gnupgargs = ['--batch',
 
144
                          '--home', self.tempdir,
 
145
                          '--force-mdc',
 
146
                          '--quiet',
 
147
                          '--no-use-agent']
145
148
    
146
149
    def __enter__(self):
147
150
        return self
148
151
    
149
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
152
    def __exit__(self, exc_type, exc_value, traceback):
150
153
        self._cleanup()
151
154
        return False
152
155
    
172
175
        return b"mandos" + binascii.hexlify(password)
173
176
    
174
177
    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 CryptoError(e)
188
 
        self.gnupg.passphrase = None
 
178
        passphrase = self.password_encode(password)
 
179
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
180
                                         ) as passfile:
 
181
            passfile.write(passphrase)
 
182
            passfile.flush()
 
183
            proc = subprocess.Popen(['gpg', '--symmetric',
 
184
                                     '--passphrase-file',
 
185
                                     passfile.name]
 
186
                                    + self.gnupgargs,
 
187
                                    stdin = subprocess.PIPE,
 
188
                                    stdout = subprocess.PIPE,
 
189
                                    stderr = subprocess.PIPE)
 
190
            ciphertext, err = proc.communicate(input = data)
 
191
        if proc.returncode != 0:
 
192
            raise PGPError(err)
189
193
        return ciphertext
190
194
    
191
195
    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 CryptoError(e)
205
 
        self.gnupg.passphrase = None
 
196
        passphrase = self.password_encode(password)
 
197
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
198
                                         ) as passfile:
 
199
            passfile.write(passphrase)
 
200
            passfile.flush()
 
201
            proc = subprocess.Popen(['gpg', '--decrypt',
 
202
                                     '--passphrase-file',
 
203
                                     passfile.name]
 
204
                                    + self.gnupgargs,
 
205
                                    stdin = subprocess.PIPE,
 
206
                                    stdout = subprocess.PIPE,
 
207
                                    stderr = subprocess.PIPE)
 
208
            decrypted_plaintext, err = proc.communicate(input
 
209
                                                        = data)
 
210
        if proc.returncode != 0:
 
211
            raise PGPError(err)
206
212
        return decrypted_plaintext
207
213
 
208
214
 
209
 
 
210
215
class AvahiError(Exception):
211
216
    def __init__(self, value, *args, **kwargs):
212
217
        self.value = value
229
234
               Used to optionally bind to the specified interface.
230
235
    name: string; Example: 'Mandos'
231
236
    type: string; Example: '_mandos._tcp'.
232
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
237
     See <https://www.iana.org/assignments/service-names-port-numbers>
233
238
    port: integer; what port to announce
234
239
    TXT: list of strings; TXT record for the service
235
240
    domain: string; Domain to publish on, default to .local if empty.
241
246
    server: D-Bus Server
242
247
    bus: dbus.SystemBus()
243
248
    """
 
249
    
244
250
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
245
251
                 servicetype = None, port = None, TXT = None,
246
252
                 domain = "", host = "", max_renames = 32768,
259
265
        self.server = None
260
266
        self.bus = bus
261
267
        self.entry_group_state_changed_match = None
 
268
    
262
269
    def rename(self):
263
270
        """Derived from the Avahi example code"""
264
271
        if self.rename_count >= self.max_renames:
274
281
        try:
275
282
            self.add()
276
283
        except dbus.exceptions.DBusException as error:
277
 
            logger.critical("DBusException: %s", error)
 
284
            logger.critical("D-Bus Exception", exc_info=error)
278
285
            self.cleanup()
279
286
            os._exit(1)
280
287
        self.rename_count += 1
 
288
    
281
289
    def remove(self):
282
290
        """Derived from the Avahi example code"""
283
291
        if self.entry_group_state_changed_match is not None:
285
293
            self.entry_group_state_changed_match = None
286
294
        if self.group is not None:
287
295
            self.group.Reset()
 
296
    
288
297
    def add(self):
289
298
        """Derived from the Avahi example code"""
290
299
        self.remove()
307
316
            dbus.UInt16(self.port),
308
317
            avahi.string_array_to_txt_array(self.TXT))
309
318
        self.group.Commit()
 
319
    
310
320
    def entry_group_state_changed(self, state, error):
311
321
        """Derived from the Avahi example code"""
312
322
        logger.debug("Avahi entry group state change: %i", state)
319
329
        elif state == avahi.ENTRY_GROUP_FAILURE:
320
330
            logger.critical("Avahi: Error in group state changed %s",
321
331
                            unicode(error))
322
 
            raise AvahiGroupError("State changed: %s"
323
 
                                  % unicode(error))
 
332
            raise AvahiGroupError("State changed: {0!s}"
 
333
                                  .format(error))
 
334
    
324
335
    def cleanup(self):
325
336
        """Derived from the Avahi example code"""
326
337
        if self.group is not None:
331
342
                pass
332
343
            self.group = None
333
344
        self.remove()
 
345
    
334
346
    def server_state_changed(self, state, error=None):
335
347
        """Derived from the Avahi example code"""
336
348
        logger.debug("Avahi server state change: %i", state)
355
367
                logger.debug("Unknown state: %r", state)
356
368
            else:
357
369
                logger.debug("Unknown state: %r: %r", state, error)
 
370
    
358
371
    def activate(self):
359
372
        """Derived from the Avahi example code"""
360
373
        if self.server is None:
367
380
                                 self.server_state_changed)
368
381
        self.server_state_changed(self.server.GetState())
369
382
 
 
383
 
370
384
class AvahiServiceToSyslog(AvahiService):
371
385
    def rename(self):
372
386
        """Add the new name to the syslog messages"""
373
387
        ret = AvahiService.rename(self)
374
388
        syslogger.setFormatter(logging.Formatter
375
 
                               ('Mandos (%s) [%%(process)d]:'
376
 
                                ' %%(levelname)s: %%(message)s'
377
 
                                % self.name))
 
389
                               ('Mandos ({0}) [%(process)d]:'
 
390
                                ' %(levelname)s: %(message)s'
 
391
                                .format(self.name)))
378
392
        return ret
379
393
 
380
 
def _timedelta_to_milliseconds(td):
 
394
 
 
395
def timedelta_to_milliseconds(td):
381
396
    "Convert a datetime.timedelta() to milliseconds"
382
397
    return ((td.days * 24 * 60 * 60 * 1000)
383
398
            + (td.seconds * 1000)
384
399
            + (td.microseconds // 1000))
385
 
        
 
400
 
 
401
 
386
402
class Client(object):
387
403
    """A representation of a client host served by this server.
388
404
    
389
405
    Attributes:
390
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
406
    approved:   bool(); 'None' if not yet approved/disapproved
391
407
    approval_delay: datetime.timedelta(); Time to wait for approval
392
408
    approval_duration: datetime.timedelta(); Duration of one approval
393
409
    checker:    subprocess.Popen(); a running checker process used
411
427
    interval:   datetime.timedelta(); How often to start a new checker
412
428
    last_approval_request: datetime.datetime(); (UTC) or None
413
429
    last_checked_ok: datetime.datetime(); (UTC) or None
414
 
 
415
430
    last_checker_status: integer between 0 and 255 reflecting exit
416
431
                         status of last checker. -1 reflects crashed
417
 
                         checker, or None.
418
 
    last_enabled: datetime.datetime(); (UTC)
 
432
                         checker, -2 means no checker completed yet.
 
433
    last_enabled: datetime.datetime(); (UTC) or None
419
434
    name:       string; from the config file, used in log messages and
420
435
                        D-Bus identifiers
421
436
    secret:     bytestring; sent verbatim (over TLS) to client
422
437
    timeout:    datetime.timedelta(); How long from last_checked_ok
423
438
                                      until this client is disabled
424
 
    extended_timeout:   extra long timeout when password has been sent
 
439
    extended_timeout:   extra long timeout when secret has been sent
425
440
    runtime_expansions: Allowed attributes for runtime expansion.
426
441
    expires:    datetime.datetime(); time (UTC) when a client will be
427
442
                disabled, or None
 
443
    server_settings: The server_settings dict from main()
428
444
    """
429
445
    
430
446
    runtime_expansions = ("approval_delay", "approval_duration",
431
 
                          "created", "enabled", "fingerprint",
432
 
                          "host", "interval", "last_checked_ok",
 
447
                          "created", "enabled", "expires",
 
448
                          "fingerprint", "host", "interval",
 
449
                          "last_approval_request", "last_checked_ok",
433
450
                          "last_enabled", "name", "timeout")
 
451
    client_defaults = { "timeout": "PT5M",
 
452
                        "extended_timeout": "PT15M",
 
453
                        "interval": "PT2M",
 
454
                        "checker": "fping -q -- %%(host)s",
 
455
                        "host": "",
 
456
                        "approval_delay": "PT0S",
 
457
                        "approval_duration": "PT1S",
 
458
                        "approved_by_default": "True",
 
459
                        "enabled": "True",
 
460
                        }
434
461
    
435
462
    def timeout_milliseconds(self):
436
463
        "Return the 'timeout' attribute in milliseconds"
437
 
        return _timedelta_to_milliseconds(self.timeout)
 
464
        return timedelta_to_milliseconds(self.timeout)
438
465
    
439
466
    def extended_timeout_milliseconds(self):
440
467
        "Return the 'extended_timeout' attribute in milliseconds"
441
 
        return _timedelta_to_milliseconds(self.extended_timeout)
 
468
        return timedelta_to_milliseconds(self.extended_timeout)
442
469
    
443
470
    def interval_milliseconds(self):
444
471
        "Return the 'interval' attribute in milliseconds"
445
 
        return _timedelta_to_milliseconds(self.interval)
 
472
        return timedelta_to_milliseconds(self.interval)
446
473
    
447
474
    def approval_delay_milliseconds(self):
448
 
        return _timedelta_to_milliseconds(self.approval_delay)
449
 
    
450
 
    def __init__(self, name = None, config=None):
451
 
        """Note: the 'checker' key in 'config' sets the
452
 
        'checker_command' attribute and *not* the 'checker'
453
 
        attribute."""
 
475
        return timedelta_to_milliseconds(self.approval_delay)
 
476
    
 
477
    @staticmethod
 
478
    def config_parser(config):
 
479
        """Construct a new dict of client settings of this form:
 
480
        { client_name: {setting_name: value, ...}, ...}
 
481
        with exceptions for any special settings as defined above.
 
482
        NOTE: Must be a pure function. Must return the same result
 
483
        value given the same arguments.
 
484
        """
 
485
        settings = {}
 
486
        for client_name in config.sections():
 
487
            section = dict(config.items(client_name))
 
488
            client = settings[client_name] = {}
 
489
            
 
490
            client["host"] = section["host"]
 
491
            # Reformat values from string types to Python types
 
492
            client["approved_by_default"] = config.getboolean(
 
493
                client_name, "approved_by_default")
 
494
            client["enabled"] = config.getboolean(client_name,
 
495
                                                  "enabled")
 
496
            
 
497
            client["fingerprint"] = (section["fingerprint"].upper()
 
498
                                     .replace(" ", ""))
 
499
            if "secret" in section:
 
500
                client["secret"] = section["secret"].decode("base64")
 
501
            elif "secfile" in section:
 
502
                with open(os.path.expanduser(os.path.expandvars
 
503
                                             (section["secfile"])),
 
504
                          "rb") as secfile:
 
505
                    client["secret"] = secfile.read()
 
506
            else:
 
507
                raise TypeError("No secret or secfile for section {0}"
 
508
                                .format(section))
 
509
            client["timeout"] = string_to_delta(section["timeout"])
 
510
            client["extended_timeout"] = string_to_delta(
 
511
                section["extended_timeout"])
 
512
            client["interval"] = string_to_delta(section["interval"])
 
513
            client["approval_delay"] = string_to_delta(
 
514
                section["approval_delay"])
 
515
            client["approval_duration"] = string_to_delta(
 
516
                section["approval_duration"])
 
517
            client["checker_command"] = section["checker"]
 
518
            client["last_approval_request"] = None
 
519
            client["last_checked_ok"] = None
 
520
            client["last_checker_status"] = -2
 
521
        
 
522
        return settings
 
523
    
 
524
    def __init__(self, settings, name = None, server_settings=None):
454
525
        self.name = name
455
 
        if config is None:
456
 
            config = {}
 
526
        if server_settings is None:
 
527
            server_settings = {}
 
528
        self.server_settings = server_settings
 
529
        # adding all client settings
 
530
        for setting, value in settings.iteritems():
 
531
            setattr(self, setting, value)
 
532
        
 
533
        if self.enabled:
 
534
            if not hasattr(self, "last_enabled"):
 
535
                self.last_enabled = datetime.datetime.utcnow()
 
536
            if not hasattr(self, "expires"):
 
537
                self.expires = (datetime.datetime.utcnow()
 
538
                                + self.timeout)
 
539
        else:
 
540
            self.last_enabled = None
 
541
            self.expires = None
 
542
        
457
543
        logger.debug("Creating client %r", self.name)
458
544
        # Uppercase and remove spaces from fingerprint for later
459
545
        # comparison purposes with return value from the fingerprint()
460
546
        # function
461
 
        self.fingerprint = (config["fingerprint"].upper()
462
 
                            .replace(" ", ""))
463
547
        logger.debug("  Fingerprint: %s", self.fingerprint)
464
 
        if "secret" in config:
465
 
            self.secret = config["secret"].decode("base64")
466
 
        elif "secfile" in config:
467
 
            with open(os.path.expanduser(os.path.expandvars
468
 
                                         (config["secfile"])),
469
 
                      "rb") as secfile:
470
 
                self.secret = secfile.read()
471
 
        else:
472
 
            raise TypeError("No secret or secfile for client %s"
473
 
                            % self.name)
474
 
        self.host = config.get("host", "")
475
 
        self.created = datetime.datetime.utcnow()
476
 
        self.enabled = True
477
 
        self.last_approval_request = None
478
 
        self.last_enabled = datetime.datetime.utcnow()
479
 
        self.last_checked_ok = None
480
 
        self.last_checker_status = None
481
 
        self.timeout = string_to_delta(config["timeout"])
482
 
        self.extended_timeout = string_to_delta(config
483
 
                                                ["extended_timeout"])
484
 
        self.interval = string_to_delta(config["interval"])
 
548
        self.created = settings.get("created",
 
549
                                    datetime.datetime.utcnow())
 
550
        
 
551
        # attributes specific for this server instance
485
552
        self.checker = None
486
553
        self.checker_initiator_tag = None
487
554
        self.disable_initiator_tag = None
488
 
        self.expires = datetime.datetime.utcnow() + self.timeout
489
555
        self.checker_callback_tag = None
490
 
        self.checker_command = config["checker"]
491
556
        self.current_checker_command = None
492
 
        self._approved = None
493
 
        self.approved_by_default = config.get("approved_by_default",
494
 
                                              True)
 
557
        self.approved = None
495
558
        self.approvals_pending = 0
496
 
        self.approval_delay = string_to_delta(
497
 
            config["approval_delay"])
498
 
        self.approval_duration = string_to_delta(
499
 
            config["approval_duration"])
500
559
        self.changedstate = (multiprocessing_manager
501
560
                             .Condition(multiprocessing_manager
502
561
                                        .Lock()))
522
581
        if getattr(self, "enabled", False):
523
582
            # Already enabled
524
583
            return
525
 
        self.send_changedstate()
526
584
        self.expires = datetime.datetime.utcnow() + self.timeout
527
585
        self.enabled = True
528
586
        self.last_enabled = datetime.datetime.utcnow()
529
587
        self.init_checker()
 
588
        self.send_changedstate()
530
589
    
531
590
    def disable(self, quiet=True):
532
591
        """Disable this client."""
533
592
        if not getattr(self, "enabled", False):
534
593
            return False
535
594
        if not quiet:
536
 
            self.send_changedstate()
537
 
        if not quiet:
538
595
            logger.info("Disabling client %s", self.name)
539
 
        if getattr(self, "disable_initiator_tag", False):
 
596
        if getattr(self, "disable_initiator_tag", None) is not None:
540
597
            gobject.source_remove(self.disable_initiator_tag)
541
598
            self.disable_initiator_tag = None
542
599
        self.expires = None
543
 
        if getattr(self, "checker_initiator_tag", False):
 
600
        if getattr(self, "checker_initiator_tag", None) is not None:
544
601
            gobject.source_remove(self.checker_initiator_tag)
545
602
            self.checker_initiator_tag = None
546
603
        self.stop_checker()
547
604
        self.enabled = False
 
605
        if not quiet:
 
606
            self.send_changedstate()
548
607
        # Do not run this again if called by a gobject.timeout_add
549
608
        return False
550
609
    
554
613
    def init_checker(self):
555
614
        # Schedule a new checker to be started an 'interval' from now,
556
615
        # and every interval from then on.
 
616
        if self.checker_initiator_tag is not None:
 
617
            gobject.source_remove(self.checker_initiator_tag)
557
618
        self.checker_initiator_tag = (gobject.timeout_add
558
619
                                      (self.interval_milliseconds(),
559
620
                                       self.start_checker))
560
621
        # Schedule a disable() when 'timeout' has passed
 
622
        if self.disable_initiator_tag is not None:
 
623
            gobject.source_remove(self.disable_initiator_tag)
561
624
        self.disable_initiator_tag = (gobject.timeout_add
562
625
                                   (self.timeout_milliseconds(),
563
626
                                    self.disable))
569
632
        self.checker_callback_tag = None
570
633
        self.checker = None
571
634
        if os.WIFEXITED(condition):
572
 
            self.last_checker_status =  os.WEXITSTATUS(condition)
 
635
            self.last_checker_status = os.WEXITSTATUS(condition)
573
636
            if self.last_checker_status == 0:
574
637
                logger.info("Checker for %(name)s succeeded",
575
638
                            vars(self))
582
645
            logger.warning("Checker for %(name)s crashed?",
583
646
                           vars(self))
584
647
    
585
 
    def checked_ok(self, timeout=None):
586
 
        """Bump up the timeout for this client.
587
 
        
588
 
        This should only be called when the client has been seen,
589
 
        alive and well.
590
 
        """
 
648
    def checked_ok(self):
 
649
        """Assert that the client has been seen, alive and well."""
 
650
        self.last_checked_ok = datetime.datetime.utcnow()
 
651
        self.last_checker_status = 0
 
652
        self.bump_timeout()
 
653
    
 
654
    def bump_timeout(self, timeout=None):
 
655
        """Bump up the timeout for this client."""
591
656
        if timeout is None:
592
657
            timeout = self.timeout
593
 
        self.last_checked_ok = datetime.datetime.utcnow()
594
658
        if self.disable_initiator_tag is not None:
595
659
            gobject.source_remove(self.disable_initiator_tag)
 
660
            self.disable_initiator_tag = None
596
661
        if getattr(self, "enabled", False):
597
662
            self.disable_initiator_tag = (gobject.timeout_add
598
 
                                          (_timedelta_to_milliseconds
 
663
                                          (timedelta_to_milliseconds
599
664
                                           (timeout), self.disable))
600
665
            self.expires = datetime.datetime.utcnow() + timeout
601
666
    
608
673
        If a checker already exists, leave it running and do
609
674
        nothing."""
610
675
        # The reason for not killing a running checker is that if we
611
 
        # did that, then if a checker (for some reason) started
612
 
        # running slowly and taking more than 'interval' time, the
613
 
        # client would inevitably timeout, since no checker would get
614
 
        # a chance to run to completion.  If we instead leave running
 
676
        # did that, and if a checker (for some reason) started running
 
677
        # slowly and taking more than 'interval' time, then the client
 
678
        # would inevitably timeout, since no checker would get a
 
679
        # chance to run to completion.  If we instead leave running
615
680
        # checkers alone, the checker would have to take more time
616
681
        # than 'timeout' for the client to be disabled, which is as it
617
682
        # should be.
631
696
                                      self.current_checker_command)
632
697
        # Start a new checker if needed
633
698
        if self.checker is None:
 
699
            # Escape attributes for the shell
 
700
            escaped_attrs = dict(
 
701
                (attr, re.escape(unicode(getattr(self, attr))))
 
702
                for attr in
 
703
                self.runtime_expansions)
634
704
            try:
635
 
                # In case checker_command has exactly one % operator
636
 
                command = self.checker_command % self.host
637
 
            except TypeError:
638
 
                # Escape attributes for the shell
639
 
                escaped_attrs = dict(
640
 
                    (attr,
641
 
                     re.escape(unicode(str(getattr(self, attr, "")),
642
 
                                       errors=
643
 
                                       'replace')))
644
 
                    for attr in
645
 
                    self.runtime_expansions)
646
 
                
647
 
                try:
648
 
                    command = self.checker_command % escaped_attrs
649
 
                except TypeError as error:
650
 
                    logger.error('Could not format string "%s":'
651
 
                                 ' %s', self.checker_command, error)
652
 
                    return True # Try again later
 
705
                command = self.checker_command % escaped_attrs
 
706
            except TypeError as error:
 
707
                logger.error('Could not format string "%s"',
 
708
                             self.checker_command, exc_info=error)
 
709
                return True # Try again later
653
710
            self.current_checker_command = command
654
711
            try:
655
712
                logger.info("Starting checker %r for %s",
658
715
                # in normal mode, that is already done by daemon(),
659
716
                # and in debug mode we don't want to.  (Stdin is
660
717
                # always replaced by /dev/null.)
 
718
                # The exception is when not debugging but nevertheless
 
719
                # running in the foreground; use the previously
 
720
                # created wnull.
 
721
                popen_args = {}
 
722
                if (not self.server_settings["debug"]
 
723
                    and self.server_settings["foreground"]):
 
724
                    popen_args.update({"stdout": wnull,
 
725
                                       "stderr": wnull })
661
726
                self.checker = subprocess.Popen(command,
662
727
                                                close_fds=True,
663
 
                                                shell=True, cwd="/")
664
 
                self.checker_callback_tag = (gobject.child_watch_add
665
 
                                             (self.checker.pid,
666
 
                                              self.checker_callback,
667
 
                                              data=command))
668
 
                # The checker may have completed before the gobject
669
 
                # watch was added.  Check for this.
 
728
                                                shell=True, cwd="/",
 
729
                                                **popen_args)
 
730
            except OSError as error:
 
731
                logger.error("Failed to start subprocess",
 
732
                             exc_info=error)
 
733
                return True
 
734
            self.checker_callback_tag = (gobject.child_watch_add
 
735
                                         (self.checker.pid,
 
736
                                          self.checker_callback,
 
737
                                          data=command))
 
738
            # The checker may have completed before the gobject
 
739
            # watch was added.  Check for this.
 
740
            try:
670
741
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
671
 
                if pid:
672
 
                    gobject.source_remove(self.checker_callback_tag)
673
 
                    self.checker_callback(pid, status, command)
674
742
            except OSError as error:
675
 
                logger.error("Failed to start subprocess: %s",
676
 
                             error)
 
743
                if error.errno == errno.ECHILD:
 
744
                    # This should never happen
 
745
                    logger.error("Child process vanished",
 
746
                                 exc_info=error)
 
747
                    return True
 
748
                raise
 
749
            if pid:
 
750
                gobject.source_remove(self.checker_callback_tag)
 
751
                self.checker_callback(pid, status, command)
677
752
        # Re-run this periodically if run by gobject.timeout_add
678
753
        return True
679
754
    
686
761
            return
687
762
        logger.debug("Stopping checker for %(name)s", vars(self))
688
763
        try:
689
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
764
            self.checker.terminate()
690
765
            #time.sleep(0.5)
691
766
            #if self.checker.poll() is None:
692
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
767
            #    self.checker.kill()
693
768
        except OSError as error:
694
769
            if error.errno != errno.ESRCH: # No such process
695
770
                raise
712
787
    # "Set" method, so we fail early here:
713
788
    if byte_arrays and signature != "ay":
714
789
        raise ValueError("Byte arrays not supported for non-'ay'"
715
 
                         " signature %r" % signature)
 
790
                         " signature {0!r}".format(signature))
716
791
    def decorator(func):
717
792
        func._dbus_is_property = True
718
793
        func._dbus_interface = dbus_interface
726
801
    return decorator
727
802
 
728
803
 
 
804
def dbus_interface_annotations(dbus_interface):
 
805
    """Decorator for marking functions returning interface annotations
 
806
    
 
807
    Usage:
 
808
    
 
809
    @dbus_interface_annotations("org.example.Interface")
 
810
    def _foo(self):  # Function name does not matter
 
811
        return {"org.freedesktop.DBus.Deprecated": "true",
 
812
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
813
                    "false"}
 
814
    """
 
815
    def decorator(func):
 
816
        func._dbus_is_interface = True
 
817
        func._dbus_interface = dbus_interface
 
818
        func._dbus_name = dbus_interface
 
819
        return func
 
820
    return decorator
 
821
 
 
822
 
 
823
def dbus_annotations(annotations):
 
824
    """Decorator to annotate D-Bus methods, signals or properties
 
825
    Usage:
 
826
    
 
827
    @dbus_service_property("org.example.Interface", signature="b",
 
828
                           access="r")
 
829
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
830
                        "org.freedesktop.DBus.Property."
 
831
                        "EmitsChangedSignal": "false"})
 
832
    def Property_dbus_property(self):
 
833
        return dbus.Boolean(False)
 
834
    """
 
835
    def decorator(func):
 
836
        func._dbus_annotations = annotations
 
837
        return func
 
838
    return decorator
 
839
 
 
840
 
729
841
class DBusPropertyException(dbus.exceptions.DBusException):
730
842
    """A base class for D-Bus property-related exceptions
731
843
    """
754
866
    """
755
867
    
756
868
    @staticmethod
757
 
    def _is_dbus_property(obj):
758
 
        return getattr(obj, "_dbus_is_property", False)
 
869
    def _is_dbus_thing(thing):
 
870
        """Returns a function testing if an attribute is a D-Bus thing
 
871
        
 
872
        If called like _is_dbus_thing("method") it returns a function
 
873
        suitable for use as predicate to inspect.getmembers().
 
874
        """
 
875
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
876
                                   False)
759
877
    
760
 
    def _get_all_dbus_properties(self):
 
878
    def _get_all_dbus_things(self, thing):
761
879
        """Returns a generator of (name, attribute) pairs
762
880
        """
763
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
881
        return ((getattr(athing.__get__(self), "_dbus_name",
 
882
                         name),
 
883
                 athing.__get__(self))
764
884
                for cls in self.__class__.__mro__
765
 
                for name, prop in
766
 
                inspect.getmembers(cls, self._is_dbus_property))
 
885
                for name, athing in
 
886
                inspect.getmembers(cls,
 
887
                                   self._is_dbus_thing(thing)))
767
888
    
768
889
    def _get_dbus_property(self, interface_name, property_name):
769
890
        """Returns a bound method if one exists which is a D-Bus
771
892
        """
772
893
        for cls in  self.__class__.__mro__:
773
894
            for name, value in (inspect.getmembers
774
 
                                (cls, self._is_dbus_property)):
 
895
                                (cls,
 
896
                                 self._is_dbus_thing("property"))):
775
897
                if (value._dbus_name == property_name
776
898
                    and value._dbus_interface == interface_name):
777
899
                    return value.__get__(self)
806
928
            # signatures other than "ay".
807
929
            if prop._dbus_signature != "ay":
808
930
                raise ValueError
809
 
            value = dbus.ByteArray(''.join(unichr(byte)
810
 
                                           for byte in value))
 
931
            value = dbus.ByteArray(b''.join(chr(byte)
 
932
                                            for byte in value))
811
933
        prop(value)
812
934
    
813
935
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
819
941
        Note: Will not include properties with access="write".
820
942
        """
821
943
        properties = {}
822
 
        for name, prop in self._get_all_dbus_properties():
 
944
        for name, prop in self._get_all_dbus_things("property"):
823
945
            if (interface_name
824
946
                and interface_name != prop._dbus_interface):
825
947
                # Interface non-empty but did not match
840
962
                         path_keyword='object_path',
841
963
                         connection_keyword='connection')
842
964
    def Introspect(self, object_path, connection):
843
 
        """Standard D-Bus method, overloaded to insert property tags.
 
965
        """Overloading of standard D-Bus method.
 
966
        
 
967
        Inserts property tags and interface annotation tags.
844
968
        """
845
969
        xmlstring = dbus.service.Object.Introspect(self, object_path,
846
970
                                                   connection)
853
977
                e.setAttribute("access", prop._dbus_access)
854
978
                return e
855
979
            for if_tag in document.getElementsByTagName("interface"):
 
980
                # Add property tags
856
981
                for tag in (make_tag(document, name, prop)
857
982
                            for name, prop
858
 
                            in self._get_all_dbus_properties()
 
983
                            in self._get_all_dbus_things("property")
859
984
                            if prop._dbus_interface
860
985
                            == if_tag.getAttribute("name")):
861
986
                    if_tag.appendChild(tag)
 
987
                # Add annotation tags
 
988
                for typ in ("method", "signal", "property"):
 
989
                    for tag in if_tag.getElementsByTagName(typ):
 
990
                        annots = dict()
 
991
                        for name, prop in (self.
 
992
                                           _get_all_dbus_things(typ)):
 
993
                            if (name == tag.getAttribute("name")
 
994
                                and prop._dbus_interface
 
995
                                == if_tag.getAttribute("name")):
 
996
                                annots.update(getattr
 
997
                                              (prop,
 
998
                                               "_dbus_annotations",
 
999
                                               {}))
 
1000
                        for name, value in annots.iteritems():
 
1001
                            ann_tag = document.createElement(
 
1002
                                "annotation")
 
1003
                            ann_tag.setAttribute("name", name)
 
1004
                            ann_tag.setAttribute("value", value)
 
1005
                            tag.appendChild(ann_tag)
 
1006
                # Add interface annotation tags
 
1007
                for annotation, value in dict(
 
1008
                    itertools.chain.from_iterable(
 
1009
                        annotations().iteritems()
 
1010
                        for name, annotations in
 
1011
                        self._get_all_dbus_things("interface")
 
1012
                        if name == if_tag.getAttribute("name")
 
1013
                        )).iteritems():
 
1014
                    ann_tag = document.createElement("annotation")
 
1015
                    ann_tag.setAttribute("name", annotation)
 
1016
                    ann_tag.setAttribute("value", value)
 
1017
                    if_tag.appendChild(ann_tag)
862
1018
                # Add the names to the return values for the
863
1019
                # "org.freedesktop.DBus.Properties" methods
864
1020
                if (if_tag.getAttribute("name")
879
1035
        except (AttributeError, xml.dom.DOMException,
880
1036
                xml.parsers.expat.ExpatError) as error:
881
1037
            logger.error("Failed to override Introspection method",
882
 
                         error)
 
1038
                         exc_info=error)
883
1039
        return xmlstring
884
1040
 
885
1041
 
886
 
def datetime_to_dbus (dt, variant_level=0):
 
1042
def datetime_to_dbus(dt, variant_level=0):
887
1043
    """Convert a UTC datetime.datetime() to a D-Bus type."""
888
1044
    if dt is None:
889
1045
        return dbus.String("", variant_level = variant_level)
891
1047
                       variant_level=variant_level)
892
1048
 
893
1049
 
894
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
895
 
                                  .__metaclass__):
896
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
897
 
    will add additional D-Bus attributes matching a certain pattern.
 
1050
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1051
    """A class decorator; applied to a subclass of
 
1052
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1053
    interface names according to the "alt_interface_names" mapping.
 
1054
    Usage:
 
1055
    
 
1056
    @alternate_dbus_interfaces({"org.example.Interface":
 
1057
                                    "net.example.AlternateInterface"})
 
1058
    class SampleDBusObject(dbus.service.Object):
 
1059
        @dbus.service.method("org.example.Interface")
 
1060
        def SampleDBusMethod():
 
1061
            pass
 
1062
    
 
1063
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1064
    reachable via two interfaces: "org.example.Interface" and
 
1065
    "net.example.AlternateInterface", the latter of which will have
 
1066
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1067
    "true", unless "deprecate" is passed with a False value.
 
1068
    
 
1069
    This works for methods and signals, and also for D-Bus properties
 
1070
    (from DBusObjectWithProperties) and interfaces (from the
 
1071
    dbus_interface_annotations decorator).
898
1072
    """
899
 
    def __new__(mcs, name, bases, attr):
900
 
        # Go through all the base classes which could have D-Bus
901
 
        # methods, signals, or properties in them
902
 
        for base in (b for b in bases
903
 
                     if issubclass(b, dbus.service.Object)):
904
 
            # Go though all attributes of the base class
905
 
            for attrname, attribute in inspect.getmembers(base):
 
1073
    def wrapper(cls):
 
1074
        for orig_interface_name, alt_interface_name in (
 
1075
            alt_interface_names.iteritems()):
 
1076
            attr = {}
 
1077
            interface_names = set()
 
1078
            # Go though all attributes of the class
 
1079
            for attrname, attribute in inspect.getmembers(cls):
906
1080
                # Ignore non-D-Bus attributes, and D-Bus attributes
907
1081
                # with the wrong interface name
908
1082
                if (not hasattr(attribute, "_dbus_interface")
909
1083
                    or not attribute._dbus_interface
910
 
                    .startswith("se.recompile.Mandos")):
 
1084
                    .startswith(orig_interface_name)):
911
1085
                    continue
912
1086
                # Create an alternate D-Bus interface name based on
913
1087
                # the current name
914
1088
                alt_interface = (attribute._dbus_interface
915
 
                                 .replace("se.recompile.Mandos",
916
 
                                          "se.bsnet.fukt.Mandos"))
 
1089
                                 .replace(orig_interface_name,
 
1090
                                          alt_interface_name))
 
1091
                interface_names.add(alt_interface)
917
1092
                # Is this a D-Bus signal?
918
1093
                if getattr(attribute, "_dbus_is_signal", False):
919
 
                    # Extract the original non-method function by
920
 
                    # black magic
 
1094
                    # Extract the original non-method undecorated
 
1095
                    # function by black magic
921
1096
                    nonmethod_func = (dict(
922
1097
                            zip(attribute.func_code.co_freevars,
923
1098
                                attribute.__closure__))["func"]
934
1109
                                nonmethod_func.func_name,
935
1110
                                nonmethod_func.func_defaults,
936
1111
                                nonmethod_func.func_closure)))
 
1112
                    # Copy annotations, if any
 
1113
                    try:
 
1114
                        new_function._dbus_annotations = (
 
1115
                            dict(attribute._dbus_annotations))
 
1116
                    except AttributeError:
 
1117
                        pass
937
1118
                    # Define a creator of a function to call both the
938
 
                    # old and new functions, so both the old and new
939
 
                    # signals gets sent when the function is called
 
1119
                    # original and alternate functions, so both the
 
1120
                    # original and alternate signals gets sent when
 
1121
                    # the function is called
940
1122
                    def fixscope(func1, func2):
941
1123
                        """This function is a scope container to pass
942
1124
                        func1 and func2 to the "call_both" function
949
1131
                        return call_both
950
1132
                    # Create the "call_both" function and add it to
951
1133
                    # the class
952
 
                    attr[attrname] = fixscope(attribute,
953
 
                                              new_function)
 
1134
                    attr[attrname] = fixscope(attribute, new_function)
954
1135
                # Is this a D-Bus method?
955
1136
                elif getattr(attribute, "_dbus_is_method", False):
956
1137
                    # Create a new, but exactly alike, function
967
1148
                                        attribute.func_name,
968
1149
                                        attribute.func_defaults,
969
1150
                                        attribute.func_closure)))
 
1151
                    # Copy annotations, if any
 
1152
                    try:
 
1153
                        attr[attrname]._dbus_annotations = (
 
1154
                            dict(attribute._dbus_annotations))
 
1155
                    except AttributeError:
 
1156
                        pass
970
1157
                # Is this a D-Bus property?
971
1158
                elif getattr(attribute, "_dbus_is_property", False):
972
1159
                    # Create a new, but exactly alike, function
986
1173
                                        attribute.func_name,
987
1174
                                        attribute.func_defaults,
988
1175
                                        attribute.func_closure)))
989
 
        return type.__new__(mcs, name, bases, attr)
990
 
 
991
 
 
 
1176
                    # Copy annotations, if any
 
1177
                    try:
 
1178
                        attr[attrname]._dbus_annotations = (
 
1179
                            dict(attribute._dbus_annotations))
 
1180
                    except AttributeError:
 
1181
                        pass
 
1182
                # Is this a D-Bus interface?
 
1183
                elif getattr(attribute, "_dbus_is_interface", False):
 
1184
                    # Create a new, but exactly alike, function
 
1185
                    # object.  Decorate it to be a new D-Bus interface
 
1186
                    # with the alternate D-Bus interface name.  Add it
 
1187
                    # to the class.
 
1188
                    attr[attrname] = (dbus_interface_annotations
 
1189
                                      (alt_interface)
 
1190
                                      (types.FunctionType
 
1191
                                       (attribute.func_code,
 
1192
                                        attribute.func_globals,
 
1193
                                        attribute.func_name,
 
1194
                                        attribute.func_defaults,
 
1195
                                        attribute.func_closure)))
 
1196
            if deprecate:
 
1197
                # Deprecate all alternate interfaces
 
1198
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1199
                for interface_name in interface_names:
 
1200
                    @dbus_interface_annotations(interface_name)
 
1201
                    def func(self):
 
1202
                        return { "org.freedesktop.DBus.Deprecated":
 
1203
                                     "true" }
 
1204
                    # Find an unused name
 
1205
                    for aname in (iname.format(i)
 
1206
                                  for i in itertools.count()):
 
1207
                        if aname not in attr:
 
1208
                            attr[aname] = func
 
1209
                            break
 
1210
            if interface_names:
 
1211
                # Replace the class with a new subclass of it with
 
1212
                # methods, signals, etc. as created above.
 
1213
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1214
                           (cls,), attr)
 
1215
        return cls
 
1216
    return wrapper
 
1217
 
 
1218
 
 
1219
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1220
                                "se.bsnet.fukt.Mandos"})
992
1221
class ClientDBus(Client, DBusObjectWithProperties):
993
1222
    """A Client class using D-Bus
994
1223
    
1005
1234
    def __init__(self, bus = None, *args, **kwargs):
1006
1235
        self.bus = bus
1007
1236
        Client.__init__(self, *args, **kwargs)
1008
 
        
1009
 
        self._approvals_pending = 0
1010
1237
        # Only now, when this client is initialized, can it show up on
1011
1238
        # the D-Bus
1012
1239
        client_object_name = unicode(self.name).translate(
1016
1243
                                 ("/clients/" + client_object_name))
1017
1244
        DBusObjectWithProperties.__init__(self, self.bus,
1018
1245
                                          self.dbus_object_path)
1019
 
        
 
1246
    
1020
1247
    def notifychangeproperty(transform_func,
1021
1248
                             dbus_name, type_func=lambda x: x,
1022
1249
                             variant_level=1):
1045
1272
        
1046
1273
        return property(lambda self: getattr(self, attrname), setter)
1047
1274
    
1048
 
    
1049
1275
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1050
1276
    approvals_pending = notifychangeproperty(dbus.Boolean,
1051
1277
                                             "ApprovalPending",
1058
1284
                                       checker is not None)
1059
1285
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1060
1286
                                           "LastCheckedOK")
 
1287
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1288
                                               "LastCheckerStatus")
1061
1289
    last_approval_request = notifychangeproperty(
1062
1290
        datetime_to_dbus, "LastApprovalRequest")
1063
1291
    approved_by_default = notifychangeproperty(dbus.Boolean,
1064
1292
                                               "ApprovedByDefault")
1065
 
    approval_delay = notifychangeproperty(dbus.UInt16,
 
1293
    approval_delay = notifychangeproperty(dbus.UInt64,
1066
1294
                                          "ApprovalDelay",
1067
1295
                                          type_func =
1068
 
                                          _timedelta_to_milliseconds)
 
1296
                                          timedelta_to_milliseconds)
1069
1297
    approval_duration = notifychangeproperty(
1070
 
        dbus.UInt16, "ApprovalDuration",
1071
 
        type_func = _timedelta_to_milliseconds)
 
1298
        dbus.UInt64, "ApprovalDuration",
 
1299
        type_func = timedelta_to_milliseconds)
1072
1300
    host = notifychangeproperty(dbus.String, "Host")
1073
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
 
1301
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1074
1302
                                   type_func =
1075
 
                                   _timedelta_to_milliseconds)
 
1303
                                   timedelta_to_milliseconds)
1076
1304
    extended_timeout = notifychangeproperty(
1077
 
        dbus.UInt16, "ExtendedTimeout",
1078
 
        type_func = _timedelta_to_milliseconds)
1079
 
    interval = notifychangeproperty(dbus.UInt16,
 
1305
        dbus.UInt64, "ExtendedTimeout",
 
1306
        type_func = timedelta_to_milliseconds)
 
1307
    interval = notifychangeproperty(dbus.UInt64,
1080
1308
                                    "Interval",
1081
1309
                                    type_func =
1082
 
                                    _timedelta_to_milliseconds)
 
1310
                                    timedelta_to_milliseconds)
1083
1311
    checker_command = notifychangeproperty(dbus.String, "Checker")
1084
1312
    
1085
1313
    del notifychangeproperty
1127
1355
        return r
1128
1356
    
1129
1357
    def _reset_approved(self):
1130
 
        self._approved = None
 
1358
        self.approved = None
1131
1359
        return False
1132
1360
    
1133
1361
    def approve(self, value=True):
1134
 
        self.send_changedstate()
1135
 
        self._approved = value
1136
 
        gobject.timeout_add(_timedelta_to_milliseconds
 
1362
        self.approved = value
 
1363
        gobject.timeout_add(timedelta_to_milliseconds
1137
1364
                            (self.approval_duration),
1138
1365
                            self._reset_approved)
1139
 
    
 
1366
        self.send_changedstate()
1140
1367
    
1141
1368
    ## D-Bus methods, signals & properties
1142
1369
    _interface = "se.recompile.Mandos.Client"
1143
1370
    
 
1371
    ## Interfaces
 
1372
    
 
1373
    @dbus_interface_annotations(_interface)
 
1374
    def _foo(self):
 
1375
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1376
                     "false"}
 
1377
    
1144
1378
    ## Signals
1145
1379
    
1146
1380
    # CheckerCompleted - signal
1182
1416
        "D-Bus signal"
1183
1417
        return self.need_approval()
1184
1418
    
1185
 
    # NeRwequest - signal
1186
 
    @dbus.service.signal(_interface, signature="s")
1187
 
    def NewRequest(self, ip):
1188
 
        """D-Bus signal
1189
 
        Is sent after a client request a password.
1190
 
        """
1191
 
        pass
1192
 
    
1193
1419
    ## Methods
1194
1420
    
1195
1421
    # Approve - method
1253
1479
                           access="readwrite")
1254
1480
    def ApprovalDuration_dbus_property(self, value=None):
1255
1481
        if value is None:       # get
1256
 
            return dbus.UInt64(_timedelta_to_milliseconds(
 
1482
            return dbus.UInt64(timedelta_to_milliseconds(
1257
1483
                    self.approval_duration))
1258
1484
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1259
1485
    
1273
1499
    def Host_dbus_property(self, value=None):
1274
1500
        if value is None:       # get
1275
1501
            return dbus.String(self.host)
1276
 
        self.host = value
 
1502
        self.host = unicode(value)
1277
1503
    
1278
1504
    # Created - property
1279
1505
    @dbus_service_property(_interface, signature="s", access="read")
1280
1506
    def Created_dbus_property(self):
1281
 
        return dbus.String(datetime_to_dbus(self.created))
 
1507
        return datetime_to_dbus(self.created)
1282
1508
    
1283
1509
    # LastEnabled - property
1284
1510
    @dbus_service_property(_interface, signature="s", access="read")
1305
1531
            return
1306
1532
        return datetime_to_dbus(self.last_checked_ok)
1307
1533
    
 
1534
    # LastCheckerStatus - property
 
1535
    @dbus_service_property(_interface, signature="n",
 
1536
                           access="read")
 
1537
    def LastCheckerStatus_dbus_property(self):
 
1538
        return dbus.Int16(self.last_checker_status)
 
1539
    
1308
1540
    # Expires - property
1309
1541
    @dbus_service_property(_interface, signature="s", access="read")
1310
1542
    def Expires_dbus_property(self):
1321
1553
    def Timeout_dbus_property(self, value=None):
1322
1554
        if value is None:       # get
1323
1555
            return dbus.UInt64(self.timeout_milliseconds())
 
1556
        old_timeout = self.timeout
1324
1557
        self.timeout = datetime.timedelta(0, 0, 0, value)
1325
 
        if getattr(self, "disable_initiator_tag", None) is None:
1326
 
            return
1327
 
        # Reschedule timeout
1328
 
        gobject.source_remove(self.disable_initiator_tag)
1329
 
        self.disable_initiator_tag = None
1330
 
        self.expires = None
1331
 
        time_to_die = _timedelta_to_milliseconds((self
1332
 
                                                  .last_checked_ok
1333
 
                                                  + self.timeout)
1334
 
                                                 - datetime.datetime
1335
 
                                                 .utcnow())
1336
 
        if time_to_die <= 0:
1337
 
            # The timeout has passed
1338
 
            self.disable()
1339
 
        else:
1340
 
            self.expires = (datetime.datetime.utcnow()
1341
 
                            + datetime.timedelta(milliseconds =
1342
 
                                                 time_to_die))
1343
 
            self.disable_initiator_tag = (gobject.timeout_add
1344
 
                                          (time_to_die, self.disable))
 
1558
        # Reschedule disabling
 
1559
        if self.enabled:
 
1560
            now = datetime.datetime.utcnow()
 
1561
            self.expires += self.timeout - old_timeout
 
1562
            if self.expires <= now:
 
1563
                # The timeout has passed
 
1564
                self.disable()
 
1565
            else:
 
1566
                if (getattr(self, "disable_initiator_tag", None)
 
1567
                    is None):
 
1568
                    return
 
1569
                gobject.source_remove(self.disable_initiator_tag)
 
1570
                self.disable_initiator_tag = (
 
1571
                    gobject.timeout_add(
 
1572
                        timedelta_to_milliseconds(self.expires - now),
 
1573
                        self.disable))
1345
1574
    
1346
1575
    # ExtendedTimeout - property
1347
1576
    @dbus_service_property(_interface, signature="t",
1360
1589
        self.interval = datetime.timedelta(0, 0, 0, value)
1361
1590
        if getattr(self, "checker_initiator_tag", None) is None:
1362
1591
            return
1363
 
        # Reschedule checker run
1364
 
        gobject.source_remove(self.checker_initiator_tag)
1365
 
        self.checker_initiator_tag = (gobject.timeout_add
1366
 
                                      (value, self.start_checker))
1367
 
        self.start_checker()    # Start one now, too
 
1592
        if self.enabled:
 
1593
            # Reschedule checker run
 
1594
            gobject.source_remove(self.checker_initiator_tag)
 
1595
            self.checker_initiator_tag = (gobject.timeout_add
 
1596
                                          (value, self.start_checker))
 
1597
            self.start_checker()    # Start one now, too
1368
1598
    
1369
1599
    # Checker - property
1370
1600
    @dbus_service_property(_interface, signature="s",
1372
1602
    def Checker_dbus_property(self, value=None):
1373
1603
        if value is None:       # get
1374
1604
            return dbus.String(self.checker_command)
1375
 
        self.checker_command = value
 
1605
        self.checker_command = unicode(value)
1376
1606
    
1377
1607
    # CheckerRunning - property
1378
1608
    @dbus_service_property(_interface, signature="b",
1407
1637
            raise KeyError()
1408
1638
    
1409
1639
    def __getattribute__(self, name):
1410
 
        if(name == '_pipe'):
 
1640
        if name == '_pipe':
1411
1641
            return super(ProxyClient, self).__getattribute__(name)
1412
1642
        self._pipe.send(('getattr', name))
1413
1643
        data = self._pipe.recv()
1420
1650
            return func
1421
1651
    
1422
1652
    def __setattr__(self, name, value):
1423
 
        if(name == '_pipe'):
 
1653
        if name == '_pipe':
1424
1654
            return super(ProxyClient, self).__setattr__(name, value)
1425
1655
        self._pipe.send(('setattr', name, value))
1426
1656
 
1427
1657
 
1428
 
class ClientDBusTransitional(ClientDBus):
1429
 
    __metaclass__ = AlternateDBusNamesMetaclass
1430
 
 
1431
 
 
1432
1658
class ClientHandler(socketserver.BaseRequestHandler, object):
1433
1659
    """A class to handle client connections.
1434
1660
    
1495
1721
                    logger.warning("Bad certificate: %s", error)
1496
1722
                    return
1497
1723
                logger.debug("Fingerprint: %s", fpr)
1498
 
                if self.server.use_dbus:
1499
 
                    # Emit D-Bus signal
1500
 
                    client.NewRequest(str(self.client_address))
1501
1724
                
1502
1725
                try:
1503
1726
                    client = ProxyClient(child_pipe, fpr,
1519
1742
                            client.Rejected("Disabled")
1520
1743
                        return
1521
1744
                    
1522
 
                    if client._approved or not client.approval_delay:
 
1745
                    if client.approved or not client.approval_delay:
1523
1746
                        #We are approved or approval is disabled
1524
1747
                        break
1525
 
                    elif client._approved is None:
 
1748
                    elif client.approved is None:
1526
1749
                        logger.info("Client %s needs approval",
1527
1750
                                    client.name)
1528
1751
                        if self.server.use_dbus:
1541
1764
                    #wait until timeout or approved
1542
1765
                    time = datetime.datetime.now()
1543
1766
                    client.changedstate.acquire()
1544
 
                    (client.changedstate.wait
1545
 
                     (float(client._timedelta_to_milliseconds(delay)
1546
 
                            / 1000)))
 
1767
                    client.changedstate.wait(
 
1768
                        float(timedelta_to_milliseconds(delay)
 
1769
                              / 1000))
1547
1770
                    client.changedstate.release()
1548
1771
                    time2 = datetime.datetime.now()
1549
1772
                    if (time2 - time) >= delay:
1565
1788
                    try:
1566
1789
                        sent = session.send(client.secret[sent_size:])
1567
1790
                    except gnutls.errors.GNUTLSError as error:
1568
 
                        logger.warning("gnutls send failed")
 
1791
                        logger.warning("gnutls send failed",
 
1792
                                       exc_info=error)
1569
1793
                        return
1570
1794
                    logger.debug("Sent: %d, remaining: %d",
1571
1795
                                 sent, len(client.secret)
1574
1798
                
1575
1799
                logger.info("Sending secret to %s", client.name)
1576
1800
                # bump the timeout using extended_timeout
1577
 
                client.checked_ok(client.extended_timeout)
 
1801
                client.bump_timeout(client.extended_timeout)
1578
1802
                if self.server.use_dbus:
1579
1803
                    # Emit D-Bus signal
1580
1804
                    client.GotSecret()
1585
1809
                try:
1586
1810
                    session.bye()
1587
1811
                except gnutls.errors.GNUTLSError as error:
1588
 
                    logger.warning("GnuTLS bye failed")
 
1812
                    logger.warning("GnuTLS bye failed",
 
1813
                                   exc_info=error)
1589
1814
    
1590
1815
    @staticmethod
1591
1816
    def peer_certificate(session):
1656
1881
    def sub_process_main(self, request, address):
1657
1882
        try:
1658
1883
            self.finish_request(request, address)
1659
 
        except:
 
1884
        except Exception:
1660
1885
            self.handle_error(request, address)
1661
1886
        self.close_request(request)
1662
1887
    
1663
1888
    def process_request(self, request, address):
1664
1889
        """Start a new process to process the request."""
1665
1890
        proc = multiprocessing.Process(target = self.sub_process_main,
1666
 
                                       args = (request,
1667
 
                                               address))
 
1891
                                       args = (request, address))
1668
1892
        proc.start()
1669
1893
        return proc
1670
1894
 
1698
1922
        use_ipv6:       Boolean; to use IPv6 or not
1699
1923
    """
1700
1924
    def __init__(self, server_address, RequestHandlerClass,
1701
 
                 interface=None, use_ipv6=True):
 
1925
                 interface=None, use_ipv6=True, socketfd=None):
 
1926
        """If socketfd is set, use that file descriptor instead of
 
1927
        creating a new one with socket.socket().
 
1928
        """
1702
1929
        self.interface = interface
1703
1930
        if use_ipv6:
1704
1931
            self.address_family = socket.AF_INET6
 
1932
        if socketfd is not None:
 
1933
            # Save the file descriptor
 
1934
            self.socketfd = socketfd
 
1935
            # Save the original socket.socket() function
 
1936
            self.socket_socket = socket.socket
 
1937
            # To implement --socket, we monkey patch socket.socket.
 
1938
            # 
 
1939
            # (When socketserver.TCPServer is a new-style class, we
 
1940
            # could make self.socket into a property instead of monkey
 
1941
            # patching socket.socket.)
 
1942
            # 
 
1943
            # Create a one-time-only replacement for socket.socket()
 
1944
            @functools.wraps(socket.socket)
 
1945
            def socket_wrapper(*args, **kwargs):
 
1946
                # Restore original function so subsequent calls are
 
1947
                # not affected.
 
1948
                socket.socket = self.socket_socket
 
1949
                del self.socket_socket
 
1950
                # This time only, return a new socket object from the
 
1951
                # saved file descriptor.
 
1952
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1953
            # Replace socket.socket() function with wrapper
 
1954
            socket.socket = socket_wrapper
 
1955
        # The socketserver.TCPServer.__init__ will call
 
1956
        # socket.socket(), which might be our replacement,
 
1957
        # socket_wrapper(), if socketfd was set.
1705
1958
        socketserver.TCPServer.__init__(self, server_address,
1706
1959
                                        RequestHandlerClass)
 
1960
    
1707
1961
    def server_bind(self):
1708
1962
        """This overrides the normal server_bind() function
1709
1963
        to bind to an interface if one was specified, and also NOT to
1717
1971
                try:
1718
1972
                    self.socket.setsockopt(socket.SOL_SOCKET,
1719
1973
                                           SO_BINDTODEVICE,
1720
 
                                           str(self.interface
1721
 
                                               + '\0'))
 
1974
                                           str(self.interface + '\0'))
1722
1975
                except socket.error as error:
1723
 
                    if error[0] == errno.EPERM:
1724
 
                        logger.error("No permission to"
1725
 
                                     " bind to interface %s",
1726
 
                                     self.interface)
1727
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1976
                    if error.errno == errno.EPERM:
 
1977
                        logger.error("No permission to bind to"
 
1978
                                     " interface %s", self.interface)
 
1979
                    elif error.errno == errno.ENOPROTOOPT:
1728
1980
                        logger.error("SO_BINDTODEVICE not available;"
1729
1981
                                     " cannot bind to interface %s",
1730
1982
                                     self.interface)
 
1983
                    elif error.errno == errno.ENODEV:
 
1984
                        logger.error("Interface %s does not exist,"
 
1985
                                     " cannot bind", self.interface)
1731
1986
                    else:
1732
1987
                        raise
1733
1988
        # Only bind(2) the socket if we really need to.
1736
1991
                if self.address_family == socket.AF_INET6:
1737
1992
                    any_address = "::" # in6addr_any
1738
1993
                else:
1739
 
                    any_address = socket.INADDR_ANY
 
1994
                    any_address = "0.0.0.0" # INADDR_ANY
1740
1995
                self.server_address = (any_address,
1741
1996
                                       self.server_address[1])
1742
1997
            elif not self.server_address[1]:
1763
2018
    """
1764
2019
    def __init__(self, server_address, RequestHandlerClass,
1765
2020
                 interface=None, use_ipv6=True, clients=None,
1766
 
                 gnutls_priority=None, use_dbus=True):
 
2021
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1767
2022
        self.enabled = False
1768
2023
        self.clients = clients
1769
2024
        if self.clients is None:
1773
2028
        IPv6_TCPServer.__init__(self, server_address,
1774
2029
                                RequestHandlerClass,
1775
2030
                                interface = interface,
1776
 
                                use_ipv6 = use_ipv6)
 
2031
                                use_ipv6 = use_ipv6,
 
2032
                                socketfd = socketfd)
1777
2033
    def server_activate(self):
1778
2034
        if self.enabled:
1779
2035
            return socketserver.TCPServer.server_activate(self)
1792
2048
    
1793
2049
    def handle_ipc(self, source, condition, parent_pipe=None,
1794
2050
                   proc = None, client_object=None):
1795
 
        condition_names = {
1796
 
            gobject.IO_IN: "IN",   # There is data to read.
1797
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1798
 
                                    # blocking).
1799
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1800
 
            gobject.IO_ERR: "ERR", # Error condition.
1801
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1802
 
                                    # broken, usually for pipes and
1803
 
                                    # sockets).
1804
 
            }
1805
 
        conditions_string = ' | '.join(name
1806
 
                                       for cond, name in
1807
 
                                       condition_names.iteritems()
1808
 
                                       if cond & condition)
1809
2051
        # error, or the other end of multiprocessing.Pipe has closed
1810
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2052
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1811
2053
            # Wait for other process to exit
1812
2054
            proc.join()
1813
2055
            return False
1871
2113
        return True
1872
2114
 
1873
2115
 
 
2116
def rfc3339_duration_to_delta(duration):
 
2117
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2118
    
 
2119
    >>> rfc3339_duration_to_delta("P7D")
 
2120
    datetime.timedelta(7)
 
2121
    >>> rfc3339_duration_to_delta("PT60S")
 
2122
    datetime.timedelta(0, 60)
 
2123
    >>> rfc3339_duration_to_delta("PT60M")
 
2124
    datetime.timedelta(0, 3600)
 
2125
    >>> rfc3339_duration_to_delta("PT24H")
 
2126
    datetime.timedelta(1)
 
2127
    >>> rfc3339_duration_to_delta("P1W")
 
2128
    datetime.timedelta(7)
 
2129
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2130
    datetime.timedelta(0, 330)
 
2131
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2132
    datetime.timedelta(1, 200)
 
2133
    """
 
2134
    
 
2135
    # Parsing an RFC 3339 duration with regular expressions is not
 
2136
    # possible - there would have to be multiple places for the same
 
2137
    # values, like seconds.  The current code, while more esoteric, is
 
2138
    # cleaner without depending on a parsing library.  If Python had a
 
2139
    # built-in library for parsing we would use it, but we'd like to
 
2140
    # avoid excessive use of external libraries.
 
2141
    
 
2142
    # New type for defining tokens, syntax, and semantics all-in-one
 
2143
    Token = collections.namedtuple("Token",
 
2144
                                   ("regexp", # To match token; if
 
2145
                                              # "value" is not None,
 
2146
                                              # must have a "group"
 
2147
                                              # containing digits
 
2148
                                    "value",  # datetime.timedelta or
 
2149
                                              # None
 
2150
                                    "followers")) # Tokens valid after
 
2151
                                                  # this token
 
2152
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2153
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2154
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2155
    token_second = Token(re.compile(r"(\d+)S"),
 
2156
                         datetime.timedelta(seconds=1),
 
2157
                         frozenset((token_end,)))
 
2158
    token_minute = Token(re.compile(r"(\d+)M"),
 
2159
                         datetime.timedelta(minutes=1),
 
2160
                         frozenset((token_second, token_end)))
 
2161
    token_hour = Token(re.compile(r"(\d+)H"),
 
2162
                       datetime.timedelta(hours=1),
 
2163
                       frozenset((token_minute, token_end)))
 
2164
    token_time = Token(re.compile(r"T"),
 
2165
                       None,
 
2166
                       frozenset((token_hour, token_minute,
 
2167
                                  token_second)))
 
2168
    token_day = Token(re.compile(r"(\d+)D"),
 
2169
                      datetime.timedelta(days=1),
 
2170
                      frozenset((token_time, token_end)))
 
2171
    token_month = Token(re.compile(r"(\d+)M"),
 
2172
                        datetime.timedelta(weeks=4),
 
2173
                        frozenset((token_day, token_end)))
 
2174
    token_year = Token(re.compile(r"(\d+)Y"),
 
2175
                       datetime.timedelta(weeks=52),
 
2176
                       frozenset((token_month, token_end)))
 
2177
    token_week = Token(re.compile(r"(\d+)W"),
 
2178
                       datetime.timedelta(weeks=1),
 
2179
                       frozenset((token_end,)))
 
2180
    token_duration = Token(re.compile(r"P"), None,
 
2181
                           frozenset((token_year, token_month,
 
2182
                                      token_day, token_time,
 
2183
                                      token_week))),
 
2184
    # Define starting values
 
2185
    value = datetime.timedelta() # Value so far
 
2186
    found_token = None
 
2187
    followers = frozenset(token_duration,) # Following valid tokens
 
2188
    s = duration                # String left to parse
 
2189
    # Loop until end token is found
 
2190
    while found_token is not token_end:
 
2191
        # Search for any currently valid tokens
 
2192
        for token in followers:
 
2193
            match = token.regexp.match(s)
 
2194
            if match is not None:
 
2195
                # Token found
 
2196
                if token.value is not None:
 
2197
                    # Value found, parse digits
 
2198
                    factor = int(match.group(1), 10)
 
2199
                    # Add to value so far
 
2200
                    value += factor * token.value
 
2201
                # Strip token from string
 
2202
                s = token.regexp.sub("", s, 1)
 
2203
                # Go to found token
 
2204
                found_token = token
 
2205
                # Set valid next tokens
 
2206
                followers = found_token.followers
 
2207
                break
 
2208
        else:
 
2209
            # No currently valid tokens were found
 
2210
            raise ValueError("Invalid RFC 3339 duration")
 
2211
    # End token found
 
2212
    return value
 
2213
 
 
2214
 
1874
2215
def string_to_delta(interval):
1875
2216
    """Parse a string and return a datetime.timedelta
1876
2217
    
1887
2228
    >>> string_to_delta('5m 30s')
1888
2229
    datetime.timedelta(0, 330)
1889
2230
    """
 
2231
    
 
2232
    try:
 
2233
        return rfc3339_duration_to_delta(interval)
 
2234
    except ValueError:
 
2235
        pass
 
2236
    
1890
2237
    timevalue = datetime.timedelta(0)
1891
2238
    for s in interval.split():
1892
2239
        try:
1903
2250
            elif suffix == "w":
1904
2251
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1905
2252
            else:
1906
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2253
                raise ValueError("Unknown suffix {0!r}"
 
2254
                                 .format(suffix))
1907
2255
        except (ValueError, IndexError) as e:
1908
2256
            raise ValueError(*(e.args))
1909
2257
        timevalue += delta
1923
2271
        sys.exit()
1924
2272
    if not noclose:
1925
2273
        # Close all standard open file descriptors
1926
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2274
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1927
2275
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1928
2276
            raise OSError(errno.ENODEV,
1929
 
                          "%s not a character device"
1930
 
                          % os.path.devnull)
 
2277
                          "{0} not a character device"
 
2278
                          .format(os.devnull))
1931
2279
        os.dup2(null, sys.stdin.fileno())
1932
2280
        os.dup2(null, sys.stdout.fileno())
1933
2281
        os.dup2(null, sys.stderr.fileno())
1942
2290
    
1943
2291
    parser = argparse.ArgumentParser()
1944
2292
    parser.add_argument("-v", "--version", action="version",
1945
 
                        version = "%%(prog)s %s" % version,
 
2293
                        version = "%(prog)s {0}".format(version),
1946
2294
                        help="show version number and exit")
1947
2295
    parser.add_argument("-i", "--interface", metavar="IF",
1948
2296
                        help="Bind to interface IF")
1954
2302
                        help="Run self-test")
1955
2303
    parser.add_argument("--debug", action="store_true",
1956
2304
                        help="Debug mode; run in foreground and log"
1957
 
                        " to terminal")
 
2305
                        " to terminal", default=None)
1958
2306
    parser.add_argument("--debuglevel", metavar="LEVEL",
1959
2307
                        help="Debug level for stdout output")
1960
2308
    parser.add_argument("--priority", help="GnuTLS"
1967
2315
                        " files")
1968
2316
    parser.add_argument("--no-dbus", action="store_false",
1969
2317
                        dest="use_dbus", help="Do not provide D-Bus"
1970
 
                        " system bus interface")
 
2318
                        " system bus interface", default=None)
1971
2319
    parser.add_argument("--no-ipv6", action="store_false",
1972
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2320
                        dest="use_ipv6", help="Do not use IPv6",
 
2321
                        default=None)
1973
2322
    parser.add_argument("--no-restore", action="store_false",
1974
2323
                        dest="restore", help="Do not restore stored"
1975
 
                        " state", default=True)
 
2324
                        " state", default=None)
 
2325
    parser.add_argument("--socket", type=int,
 
2326
                        help="Specify a file descriptor to a network"
 
2327
                        " socket to use instead of creating one")
 
2328
    parser.add_argument("--statedir", metavar="DIR",
 
2329
                        help="Directory to save/restore state in")
 
2330
    parser.add_argument("--foreground", action="store_true",
 
2331
                        help="Run in foreground", default=None)
1976
2332
    
1977
2333
    options = parser.parse_args()
1978
2334
    
1987
2343
                        "port": "",
1988
2344
                        "debug": "False",
1989
2345
                        "priority":
1990
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2346
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224",
1991
2347
                        "servicename": "Mandos",
1992
2348
                        "use_dbus": "True",
1993
2349
                        "use_ipv6": "True",
1994
2350
                        "debuglevel": "",
 
2351
                        "restore": "True",
 
2352
                        "socket": "",
 
2353
                        "statedir": "/var/lib/mandos",
 
2354
                        "foreground": "False",
1995
2355
                        }
1996
2356
    
1997
2357
    # Parse config file for server-global settings
2002
2362
    # Convert the SafeConfigParser object to a dict
2003
2363
    server_settings = server_config.defaults()
2004
2364
    # Use the appropriate methods on the non-string config options
2005
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2365
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2006
2366
        server_settings[option] = server_config.getboolean("DEFAULT",
2007
2367
                                                           option)
2008
2368
    if server_settings["port"]:
2009
2369
        server_settings["port"] = server_config.getint("DEFAULT",
2010
2370
                                                       "port")
 
2371
    if server_settings["socket"]:
 
2372
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2373
                                                         "socket")
 
2374
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2375
        # over with an opened os.devnull.  But we don't want this to
 
2376
        # happen with a supplied network socket.
 
2377
        if 0 <= server_settings["socket"] <= 2:
 
2378
            server_settings["socket"] = os.dup(server_settings
 
2379
                                               ["socket"])
2011
2380
    del server_config
2012
2381
    
2013
2382
    # Override the settings from the config file with command line
2014
2383
    # options, if set.
2015
2384
    for option in ("interface", "address", "port", "debug",
2016
2385
                   "priority", "servicename", "configdir",
2017
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore"):
 
2386
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2387
                   "statedir", "socket", "foreground"):
2018
2388
        value = getattr(options, option)
2019
2389
        if value is not None:
2020
2390
            server_settings[option] = value
2023
2393
    for option in server_settings.keys():
2024
2394
        if type(server_settings[option]) is str:
2025
2395
            server_settings[option] = unicode(server_settings[option])
 
2396
    # Force all boolean options to be boolean
 
2397
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2398
                   "foreground"):
 
2399
        server_settings[option] = bool(server_settings[option])
 
2400
    # Debug implies foreground
 
2401
    if server_settings["debug"]:
 
2402
        server_settings["foreground"] = True
2026
2403
    # Now we have our good server settings in "server_settings"
2027
2404
    
2028
2405
    ##################################################################
2032
2409
    debuglevel = server_settings["debuglevel"]
2033
2410
    use_dbus = server_settings["use_dbus"]
2034
2411
    use_ipv6 = server_settings["use_ipv6"]
 
2412
    stored_state_path = os.path.join(server_settings["statedir"],
 
2413
                                     stored_state_file)
 
2414
    foreground = server_settings["foreground"]
2035
2415
    
2036
2416
    if debug:
2037
 
        initlogger(logging.DEBUG)
 
2417
        initlogger(debug, logging.DEBUG)
2038
2418
    else:
2039
2419
        if not debuglevel:
2040
 
            initlogger()
 
2420
            initlogger(debug)
2041
2421
        else:
2042
2422
            level = getattr(logging, debuglevel.upper())
2043
 
            initlogger(level)
 
2423
            initlogger(debug, level)
2044
2424
    
2045
2425
    if server_settings["servicename"] != "Mandos":
2046
2426
        syslogger.setFormatter(logging.Formatter
2047
 
                               ('Mandos (%s) [%%(process)d]:'
2048
 
                                ' %%(levelname)s: %%(message)s'
2049
 
                                % server_settings["servicename"]))
 
2427
                               ('Mandos ({0}) [%(process)d]:'
 
2428
                                ' %(levelname)s: %(message)s'
 
2429
                                .format(server_settings
 
2430
                                        ["servicename"])))
2050
2431
    
2051
2432
    # Parse config file with clients
2052
 
    client_defaults = { "timeout": "5m",
2053
 
                        "extended_timeout": "15m",
2054
 
                        "interval": "2m",
2055
 
                        "checker": "fping -q -- %%(host)s",
2056
 
                        "host": "",
2057
 
                        "approval_delay": "0s",
2058
 
                        "approval_duration": "1s",
2059
 
                        }
2060
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2433
    client_config = configparser.SafeConfigParser(Client
 
2434
                                                  .client_defaults)
2061
2435
    client_config.read(os.path.join(server_settings["configdir"],
2062
2436
                                    "clients.conf"))
2063
2437
    
2072
2446
                              use_ipv6=use_ipv6,
2073
2447
                              gnutls_priority=
2074
2448
                              server_settings["priority"],
2075
 
                              use_dbus=use_dbus)
2076
 
    if not debug:
 
2449
                              use_dbus=use_dbus,
 
2450
                              socketfd=(server_settings["socket"]
 
2451
                                        or None))
 
2452
    if not foreground:
2077
2453
        pidfilename = "/var/run/mandos.pid"
 
2454
        pidfile = None
2078
2455
        try:
2079
2456
            pidfile = open(pidfilename, "w")
2080
 
        except IOError:
2081
 
            logger.error("Could not open file %r", pidfilename)
 
2457
        except IOError as e:
 
2458
            logger.error("Could not open file %r", pidfilename,
 
2459
                         exc_info=e)
2082
2460
    
2083
 
    try:
2084
 
        uid = pwd.getpwnam("_mandos").pw_uid
2085
 
        gid = pwd.getpwnam("_mandos").pw_gid
2086
 
    except KeyError:
 
2461
    for name in ("_mandos", "mandos", "nobody"):
2087
2462
        try:
2088
 
            uid = pwd.getpwnam("mandos").pw_uid
2089
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2463
            uid = pwd.getpwnam(name).pw_uid
 
2464
            gid = pwd.getpwnam(name).pw_gid
 
2465
            break
2090
2466
        except KeyError:
2091
 
            try:
2092
 
                uid = pwd.getpwnam("nobody").pw_uid
2093
 
                gid = pwd.getpwnam("nobody").pw_gid
2094
 
            except KeyError:
2095
 
                uid = 65534
2096
 
                gid = 65534
 
2467
            continue
 
2468
    else:
 
2469
        uid = 65534
 
2470
        gid = 65534
2097
2471
    try:
2098
2472
        os.setgid(gid)
2099
2473
        os.setuid(uid)
2100
2474
    except OSError as error:
2101
 
        if error[0] != errno.EPERM:
 
2475
        if error.errno != errno.EPERM:
2102
2476
            raise error
2103
2477
    
2104
2478
    if debug:
2116
2490
         .gnutls_global_set_log_function(debug_gnutls))
2117
2491
        
2118
2492
        # Redirect stdin so all checkers get /dev/null
2119
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2493
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2120
2494
        os.dup2(null, sys.stdin.fileno())
2121
2495
        if null > 2:
2122
2496
            os.close(null)
2123
 
    else:
2124
 
        # No console logging
2125
 
        logger.removeHandler(console)
2126
2497
    
2127
2498
    # Need to fork before connecting to D-Bus
2128
 
    if not debug:
 
2499
    if not foreground:
2129
2500
        # Close all input and output, do double fork, etc.
2130
2501
        daemon()
2131
2502
    
 
2503
    # multiprocessing will use threads, so before we use gobject we
 
2504
    # need to inform gobject that threads will be used.
 
2505
    gobject.threads_init()
 
2506
    
2132
2507
    global main_loop
2133
2508
    # From the Avahi example code
2134
 
    DBusGMainLoop(set_as_default=True )
 
2509
    DBusGMainLoop(set_as_default=True)
2135
2510
    main_loop = gobject.MainLoop()
2136
2511
    bus = dbus.SystemBus()
2137
2512
    # End of Avahi example code
2143
2518
                            ("se.bsnet.fukt.Mandos", bus,
2144
2519
                             do_not_queue=True))
2145
2520
        except dbus.exceptions.NameExistsException as e:
2146
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2521
            logger.error("Disabling D-Bus:", exc_info=e)
2147
2522
            use_dbus = False
2148
2523
            server_settings["use_dbus"] = False
2149
2524
            tcp_server.use_dbus = False
2161
2536
    
2162
2537
    client_class = Client
2163
2538
    if use_dbus:
2164
 
        client_class = functools.partial(ClientDBusTransitional,
2165
 
                                         bus = bus)
2166
 
    
2167
 
    special_settings = {
2168
 
        # Some settings need to be accessd by special methods;
2169
 
        # booleans need .getboolean(), etc.  Here is a list of them:
2170
 
        "approved_by_default":
2171
 
            lambda section:
2172
 
            client_config.getboolean(section, "approved_by_default"),
2173
 
        }
2174
 
    # Construct a new dict of client settings of this form:
2175
 
    # { client_name: {setting_name: value, ...}, ...}
2176
 
    # with exceptions for any special settings as defined above
2177
 
    client_settings = dict((clientname,
2178
 
                           dict((setting,
2179
 
                                 (value
2180
 
                                  if setting not in special_settings
2181
 
                                  else special_settings[setting]
2182
 
                                  (clientname)))
2183
 
                                for setting, value in
2184
 
                                client_config.items(clientname)))
2185
 
                          for clientname in client_config.sections())
2186
 
    
 
2539
        client_class = functools.partial(ClientDBus, bus = bus)
 
2540
    
 
2541
    client_settings = Client.config_parser(client_config)
2187
2542
    old_client_settings = {}
2188
 
    clients_data = []
 
2543
    clients_data = {}
 
2544
    
 
2545
    # This is used to redirect stdout and stderr for checker processes
 
2546
    global wnull
 
2547
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2548
    # Only used if server is running in foreground but not in debug
 
2549
    # mode
 
2550
    if debug or not foreground:
 
2551
        wnull.close()
2189
2552
    
2190
2553
    # Get client data and settings from last running state.
2191
2554
    if server_settings["restore"]:
2195
2558
                                                     (stored_state))
2196
2559
            os.remove(stored_state_path)
2197
2560
        except IOError as e:
2198
 
            logger.warning("Could not load persistent state: {0}"
2199
 
                           .format(e))
2200
 
            if e.errno != errno.ENOENT:
 
2561
            if e.errno == errno.ENOENT:
 
2562
                logger.warning("Could not load persistent state: {0}"
 
2563
                                .format(os.strerror(e.errno)))
 
2564
            else:
 
2565
                logger.critical("Could not load persistent state:",
 
2566
                                exc_info=e)
2201
2567
                raise
 
2568
        except EOFError as e:
 
2569
            logger.warning("Could not load persistent state: "
 
2570
                           "EOFError:", exc_info=e)
2202
2571
    
2203
 
    with Crypto() as crypt:
2204
 
        for client in clients_data:
2205
 
            client_name = client["name"]
 
2572
    with PGPEngine() as pgp:
 
2573
        for client_name, client in clients_data.iteritems():
 
2574
            # Skip removed clients
 
2575
            if client_name not in client_settings:
 
2576
                continue
2206
2577
            
2207
2578
            # Decide which value to use after restoring saved state.
2208
2579
            # We have three different values: Old config file,
2217
2588
                    if (name != "secret" and
2218
2589
                        value != old_client_settings[client_name]
2219
2590
                        [name]):
2220
 
                        setattr(client, name, value)
 
2591
                        client[name] = value
2221
2592
                except KeyError:
2222
2593
                    pass
2223
2594
            
2224
2595
            # Clients who has passed its expire date can still be
2225
 
            # enabled if its last checker was sucessful.  Clients
2226
 
            # whose checker failed before we stored its state is
2227
 
            # assumed to have failed all checkers during downtime.
2228
 
            if client["enabled"] and client["last_checked_ok"]:
2229
 
                if ((datetime.datetime.utcnow()
2230
 
                     - client["last_checked_ok"])
2231
 
                    > client["interval"]):
2232
 
                    if client["last_checker_status"] != 0:
 
2596
            # enabled if its last checker was successful.  Clients
 
2597
            # whose checker succeeded before we stored its state is
 
2598
            # assumed to have successfully run all checkers during
 
2599
            # downtime.
 
2600
            if client["enabled"]:
 
2601
                if datetime.datetime.utcnow() >= client["expires"]:
 
2602
                    if not client["last_checked_ok"]:
 
2603
                        logger.warning(
 
2604
                            "disabling client {0} - Client never "
 
2605
                            "performed a successful checker"
 
2606
                            .format(client_name))
 
2607
                        client["enabled"] = False
 
2608
                    elif client["last_checker_status"] != 0:
 
2609
                        logger.warning(
 
2610
                            "disabling client {0} - Client "
 
2611
                            "last checker failed with error code {1}"
 
2612
                            .format(client_name,
 
2613
                                    client["last_checker_status"]))
2233
2614
                        client["enabled"] = False
2234
2615
                    else:
2235
2616
                        client["expires"] = (datetime.datetime
2236
2617
                                             .utcnow()
2237
2618
                                             + client["timeout"])
2238
 
            
2239
 
            client["changedstate"] = (multiprocessing_manager
2240
 
                                      .Condition
2241
 
                                      (multiprocessing_manager
2242
 
                                       .Lock()))
2243
 
            if use_dbus:
2244
 
                new_client = (ClientDBusTransitional.__new__
2245
 
                              (ClientDBusTransitional))
2246
 
                tcp_server.clients[client_name] = new_client
2247
 
                new_client.bus = bus
2248
 
                for name, value in client.iteritems():
2249
 
                    setattr(new_client, name, value)
2250
 
                client_object_name = unicode(client_name).translate(
2251
 
                    {ord("."): ord("_"),
2252
 
                     ord("-"): ord("_")})
2253
 
                new_client.dbus_object_path = (dbus.ObjectPath
2254
 
                                               ("/clients/"
2255
 
                                                + client_object_name))
2256
 
                DBusObjectWithProperties.__init__(new_client,
2257
 
                                                  new_client.bus,
2258
 
                                                  new_client
2259
 
                                                  .dbus_object_path)
2260
 
            else:
2261
 
                tcp_server.clients[client_name] = (Client.__new__
2262
 
                                                   (Client))
2263
 
                for name, value in client.iteritems():
2264
 
                    setattr(tcp_server.clients[client_name],
2265
 
                            name, value)
2266
 
            
 
2619
                        logger.debug("Last checker succeeded,"
 
2620
                                     " keeping {0} enabled"
 
2621
                                     .format(client_name))
2267
2622
            try:
2268
 
                tcp_server.clients[client_name].secret = (
2269
 
                    crypt.decrypt(tcp_server.clients[client_name]
2270
 
                                  .encrypted_secret,
2271
 
                                  client_settings[client_name]
2272
 
                                  ["secret"]))
2273
 
            except CryptoError:
 
2623
                client["secret"] = (
 
2624
                    pgp.decrypt(client["encrypted_secret"],
 
2625
                                client_settings[client_name]
 
2626
                                ["secret"]))
 
2627
            except PGPError:
2274
2628
                # If decryption fails, we use secret from new settings
2275
 
                tcp_server.clients[client_name].secret = (
 
2629
                logger.debug("Failed to decrypt {0} old secret"
 
2630
                             .format(client_name))
 
2631
                client["secret"] = (
2276
2632
                    client_settings[client_name]["secret"])
2277
2633
    
2278
 
    # Create/remove clients based on new changes made to config
2279
 
    for clientname in set(old_client_settings) - set(client_settings):
2280
 
        del tcp_server.clients[clientname]
2281
 
    for clientname in set(client_settings) - set(old_client_settings):
2282
 
        tcp_server.clients[clientname] = (client_class(name
2283
 
                                                       = clientname,
2284
 
                                                       config =
2285
 
                                                       client_settings
2286
 
                                                       [clientname]))
 
2634
    # Add/remove clients based on new changes made to config
 
2635
    for client_name in (set(old_client_settings)
 
2636
                        - set(client_settings)):
 
2637
        del clients_data[client_name]
 
2638
    for client_name in (set(client_settings)
 
2639
                        - set(old_client_settings)):
 
2640
        clients_data[client_name] = client_settings[client_name]
 
2641
    
 
2642
    # Create all client objects
 
2643
    for client_name, client in clients_data.iteritems():
 
2644
        tcp_server.clients[client_name] = client_class(
 
2645
            name = client_name, settings = client,
 
2646
            server_settings = server_settings)
2287
2647
    
2288
2648
    if not tcp_server.clients:
2289
2649
        logger.warning("No clients defined")
2290
 
        
2291
 
    if not debug:
2292
 
        try:
2293
 
            with pidfile:
2294
 
                pid = os.getpid()
2295
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2296
 
            del pidfile
2297
 
        except IOError:
2298
 
            logger.error("Could not write to file %r with PID %d",
2299
 
                         pidfilename, pid)
2300
 
        except NameError:
2301
 
            # "pidfile" was never created
2302
 
            pass
 
2650
    
 
2651
    if not foreground:
 
2652
        if pidfile is not None:
 
2653
            try:
 
2654
                with pidfile:
 
2655
                    pid = os.getpid()
 
2656
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2657
            except IOError:
 
2658
                logger.error("Could not write to file %r with PID %d",
 
2659
                             pidfilename, pid)
 
2660
        del pidfile
2303
2661
        del pidfilename
2304
 
        
2305
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2306
2662
    
2307
2663
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2308
2664
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2309
2665
    
2310
2666
    if use_dbus:
2311
 
        class MandosDBusService(dbus.service.Object):
 
2667
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2668
                                        "se.bsnet.fukt.Mandos"})
 
2669
        class MandosDBusService(DBusObjectWithProperties):
2312
2670
            """A D-Bus proxy object"""
2313
2671
            def __init__(self):
2314
2672
                dbus.service.Object.__init__(self, bus, "/")
2315
2673
            _interface = "se.recompile.Mandos"
2316
2674
            
 
2675
            @dbus_interface_annotations(_interface)
 
2676
            def _foo(self):
 
2677
                return { "org.freedesktop.DBus.Property"
 
2678
                         ".EmitsChangedSignal":
 
2679
                             "false"}
 
2680
            
2317
2681
            @dbus.service.signal(_interface, signature="o")
2318
2682
            def ClientAdded(self, objpath):
2319
2683
                "D-Bus signal"
2361
2725
            
2362
2726
            del _interface
2363
2727
        
2364
 
        class MandosDBusServiceTransitional(MandosDBusService):
2365
 
            __metaclass__ = AlternateDBusNamesMetaclass
2366
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2728
        mandos_dbus_service = MandosDBusService()
2367
2729
    
2368
2730
    def cleanup():
2369
2731
        "Cleanup function; run on exit"
2370
2732
        service.cleanup()
2371
2733
        
2372
2734
        multiprocessing.active_children()
 
2735
        wnull.close()
2373
2736
        if not (tcp_server.clients or client_settings):
2374
2737
            return
2375
2738
        
2376
2739
        # Store client before exiting. Secrets are encrypted with key
2377
2740
        # based on what config file has. If config file is
2378
2741
        # removed/edited, old secret will thus be unrecovable.
2379
 
        clients = []
2380
 
        with Crypto() as crypt:
 
2742
        clients = {}
 
2743
        with PGPEngine() as pgp:
2381
2744
            for client in tcp_server.clients.itervalues():
2382
2745
                key = client_settings[client.name]["secret"]
2383
 
                client.encrypted_secret = crypt.encrypt(client.secret,
2384
 
                                                        key)
 
2746
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2747
                                                      key)
2385
2748
                client_dict = {}
2386
2749
                
2387
 
                # A list of attributes that will not be stored when
2388
 
                # shutting down.
2389
 
                exclude = set(("bus", "changedstate", "secret"))
 
2750
                # A list of attributes that can not be pickled
 
2751
                # + secret.
 
2752
                exclude = set(("bus", "changedstate", "secret",
 
2753
                               "checker", "server_settings"))
2390
2754
                for name, typ in (inspect.getmembers
2391
2755
                                  (dbus.service.Object)):
2392
2756
                    exclude.add(name)
2397
2761
                    if attr not in exclude:
2398
2762
                        client_dict[attr] = getattr(client, attr)
2399
2763
                
2400
 
                clients.append(client_dict)
 
2764
                clients[client.name] = client_dict
2401
2765
                del client_settings[client.name]["secret"]
2402
2766
        
2403
2767
        try:
2404
 
            with os.fdopen(os.open(stored_state_path,
2405
 
                                   os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2406
 
                                   0600), "wb") as stored_state:
 
2768
            with (tempfile.NamedTemporaryFile
 
2769
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2770
                   dir=os.path.dirname(stored_state_path),
 
2771
                   delete=False)) as stored_state:
2407
2772
                pickle.dump((clients, client_settings), stored_state)
 
2773
                tempname=stored_state.name
 
2774
            os.rename(tempname, stored_state_path)
2408
2775
        except (IOError, OSError) as e:
2409
 
            logger.warning("Could not save persistent state: {0}"
2410
 
                           .format(e))
2411
 
            if e.errno not in (errno.ENOENT, errno.EACCES):
2412
 
                raise
 
2776
            if not debug:
 
2777
                try:
 
2778
                    os.remove(tempname)
 
2779
                except NameError:
 
2780
                    pass
 
2781
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2782
                logger.warning("Could not save persistent state: {0}"
 
2783
                               .format(os.strerror(e.errno)))
 
2784
            else:
 
2785
                logger.warning("Could not save persistent state:",
 
2786
                               exc_info=e)
 
2787
                raise e
2413
2788
        
2414
2789
        # Delete all clients, and settings from config
2415
2790
        while tcp_server.clients:
2442
2817
    service.port = tcp_server.socket.getsockname()[1]
2443
2818
    if use_ipv6:
2444
2819
        logger.info("Now listening on address %r, port %d,"
2445
 
                    " flowinfo %d, scope_id %d"
2446
 
                    % tcp_server.socket.getsockname())
 
2820
                    " flowinfo %d, scope_id %d",
 
2821
                    *tcp_server.socket.getsockname())
2447
2822
    else:                       # IPv4
2448
 
        logger.info("Now listening on address %r, port %d"
2449
 
                    % tcp_server.socket.getsockname())
 
2823
        logger.info("Now listening on address %r, port %d",
 
2824
                    *tcp_server.socket.getsockname())
2450
2825
    
2451
2826
    #service.interface = tcp_server.socket.getsockname()[3]
2452
2827
    
2455
2830
        try:
2456
2831
            service.activate()
2457
2832
        except dbus.exceptions.DBusException as error:
2458
 
            logger.critical("DBusException: %s", error)
 
2833
            logger.critical("D-Bus Exception", exc_info=error)
2459
2834
            cleanup()
2460
2835
            sys.exit(1)
2461
2836
        # End of Avahi example code
2468
2843
        logger.debug("Starting main loop")
2469
2844
        main_loop.run()
2470
2845
    except AvahiError as error:
2471
 
        logger.critical("AvahiError: %s", error)
 
2846
        logger.critical("Avahi Error", exc_info=error)
2472
2847
        cleanup()
2473
2848
        sys.exit(1)
2474
2849
    except KeyboardInterrupt:
2479
2854
    # Must run before the D-Bus bus name gets deregistered
2480
2855
    cleanup()
2481
2856
 
2482
 
 
2483
2857
if __name__ == '__main__':
2484
2858
    main()