/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-10-20 15:25:09 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 305.
  • Revision ID: teddy@recompile.se-20131020152509-zkhuy2yse76w10hg
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
  (purge-server): PID file changed to "/run/mandos.pid".
* debian/compat: Changed to "9".
* debian/control (Standards-Version): Updated to "3.9.4".
  (DM-Upload-Allowed): Removed.
  (mandos/Depends): Add "initscripts (>= 2.88dsf-13.3)" to be able to
                    use the "/run" directory (for mandos.pid).
* debian/copyright (Copyright): Update year.
* init.d-mandos (PIDFILE): Changed to "/run/mandos.pid".
* mandos: Update copyright year.
  (pidfilename): Changed to "/run/mandos.pid".
* mandos-clients.conf.xml (OPTIONS/approval_delay): Bug fix: default
                                                    is "PT0S" - using
                                                    the new RFC 3339
                                                    duration syntax.
* mandos-keygen: Update copyright year.
* mandos-monitor: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
  (FILES): PID file changed to "/run/mandos.pid".
* plugin-runner.c: Update copyright year.
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -

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-2013 Teddy Hogeborn
 
15
# Copyright © 2008-2013 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"
 
91
version = "1.6.1"
90
92
stored_state_file = "clients.pickle"
91
93
 
92
94
logger = logging.getLogger()
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
 
 
394
 
380
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
    
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.
 
432
                         checker, -2 means no checker completed yet.
418
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"
447
474
    def approval_delay_milliseconds(self):
448
475
        return timedelta_to_milliseconds(self.approval_delay)
449
476
    
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."""
 
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 = config.get("enabled", True)
477
 
        self.last_approval_request = None
478
 
        if self.enabled:
479
 
            self.last_enabled = datetime.datetime.utcnow()
480
 
        else:
481
 
            self.last_enabled = None
482
 
        self.last_checked_ok = None
483
 
        self.last_checker_status = None
484
 
        self.timeout = string_to_delta(config["timeout"])
485
 
        self.extended_timeout = string_to_delta(config
486
 
                                                ["extended_timeout"])
487
 
        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
488
552
        self.checker = None
489
553
        self.checker_initiator_tag = None
490
554
        self.disable_initiator_tag = None
491
 
        if self.enabled:
492
 
            self.expires = datetime.datetime.utcnow() + self.timeout
493
 
        else:
494
 
            self.expires = None
495
555
        self.checker_callback_tag = None
496
 
        self.checker_command = config["checker"]
497
556
        self.current_checker_command = None
498
557
        self.approved = None
499
 
        self.approved_by_default = config.get("approved_by_default",
500
 
                                              True)
501
558
        self.approvals_pending = 0
502
 
        self.approval_delay = string_to_delta(
503
 
            config["approval_delay"])
504
 
        self.approval_duration = string_to_delta(
505
 
            config["approval_duration"])
506
559
        self.changedstate = (multiprocessing_manager
507
560
                             .Condition(multiprocessing_manager
508
561
                                        .Lock()))
528
581
        if getattr(self, "enabled", False):
529
582
            # Already enabled
530
583
            return
531
 
        self.send_changedstate()
532
584
        self.expires = datetime.datetime.utcnow() + self.timeout
533
585
        self.enabled = True
534
586
        self.last_enabled = datetime.datetime.utcnow()
535
587
        self.init_checker()
 
588
        self.send_changedstate()
536
589
    
537
590
    def disable(self, quiet=True):
538
591
        """Disable this client."""
539
592
        if not getattr(self, "enabled", False):
540
593
            return False
541
594
        if not quiet:
542
 
            self.send_changedstate()
543
 
        if not quiet:
544
595
            logger.info("Disabling client %s", self.name)
545
 
        if getattr(self, "disable_initiator_tag", False):
 
596
        if getattr(self, "disable_initiator_tag", None) is not None:
546
597
            gobject.source_remove(self.disable_initiator_tag)
547
598
            self.disable_initiator_tag = None
548
599
        self.expires = None
549
 
        if getattr(self, "checker_initiator_tag", False):
 
600
        if getattr(self, "checker_initiator_tag", None) is not None:
550
601
            gobject.source_remove(self.checker_initiator_tag)
551
602
            self.checker_initiator_tag = None
552
603
        self.stop_checker()
553
604
        self.enabled = False
 
605
        if not quiet:
 
606
            self.send_changedstate()
554
607
        # Do not run this again if called by a gobject.timeout_add
555
608
        return False
556
609
    
560
613
    def init_checker(self):
561
614
        # Schedule a new checker to be started an 'interval' from now,
562
615
        # and every interval from then on.
 
616
        if self.checker_initiator_tag is not None:
 
617
            gobject.source_remove(self.checker_initiator_tag)
563
618
        self.checker_initiator_tag = (gobject.timeout_add
564
619
                                      (self.interval_milliseconds(),
565
620
                                       self.start_checker))
566
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)
567
624
        self.disable_initiator_tag = (gobject.timeout_add
568
625
                                   (self.timeout_milliseconds(),
569
626
                                    self.disable))
575
632
        self.checker_callback_tag = None
576
633
        self.checker = None
577
634
        if os.WIFEXITED(condition):
578
 
            self.last_checker_status =  os.WEXITSTATUS(condition)
 
635
            self.last_checker_status = os.WEXITSTATUS(condition)
579
636
            if self.last_checker_status == 0:
580
637
                logger.info("Checker for %(name)s succeeded",
581
638
                            vars(self))
588
645
            logger.warning("Checker for %(name)s crashed?",
589
646
                           vars(self))
590
647
    
591
 
    def checked_ok(self, timeout=None):
592
 
        """Bump up the timeout for this client.
593
 
        
594
 
        This should only be called when the client has been seen,
595
 
        alive and well.
596
 
        """
 
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."""
597
656
        if timeout is None:
598
657
            timeout = self.timeout
599
 
        self.last_checked_ok = datetime.datetime.utcnow()
600
658
        if self.disable_initiator_tag is not None:
601
659
            gobject.source_remove(self.disable_initiator_tag)
 
660
            self.disable_initiator_tag = None
602
661
        if getattr(self, "enabled", False):
603
662
            self.disable_initiator_tag = (gobject.timeout_add
604
663
                                          (timedelta_to_milliseconds
614
673
        If a checker already exists, leave it running and do
615
674
        nothing."""
616
675
        # The reason for not killing a running checker is that if we
617
 
        # did that, then if a checker (for some reason) started
618
 
        # running slowly and taking more than 'interval' time, the
619
 
        # client would inevitably timeout, since no checker would get
620
 
        # 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
621
680
        # checkers alone, the checker would have to take more time
622
681
        # than 'timeout' for the client to be disabled, which is as it
623
682
        # should be.
637
696
                                      self.current_checker_command)
638
697
        # Start a new checker if needed
639
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)
640
704
            try:
641
 
                # In case checker_command has exactly one % operator
642
 
                command = self.checker_command % self.host
643
 
            except TypeError:
644
 
                # Escape attributes for the shell
645
 
                escaped_attrs = dict(
646
 
                    (attr,
647
 
                     re.escape(unicode(str(getattr(self, attr, "")),
648
 
                                       errors=
649
 
                                       'replace')))
650
 
                    for attr in
651
 
                    self.runtime_expansions)
652
 
                
653
 
                try:
654
 
                    command = self.checker_command % escaped_attrs
655
 
                except TypeError as error:
656
 
                    logger.error('Could not format string "%s":'
657
 
                                 ' %s', self.checker_command, error)
658
 
                    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
659
710
            self.current_checker_command = command
660
711
            try:
661
712
                logger.info("Starting checker %r for %s",
664
715
                # in normal mode, that is already done by daemon(),
665
716
                # and in debug mode we don't want to.  (Stdin is
666
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 })
667
726
                self.checker = subprocess.Popen(command,
668
727
                                                close_fds=True,
669
 
                                                shell=True, cwd="/")
670
 
                self.checker_callback_tag = (gobject.child_watch_add
671
 
                                             (self.checker.pid,
672
 
                                              self.checker_callback,
673
 
                                              data=command))
674
 
                # The checker may have completed before the gobject
675
 
                # 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:
676
741
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
677
 
                if pid:
678
 
                    gobject.source_remove(self.checker_callback_tag)
679
 
                    self.checker_callback(pid, status, command)
680
742
            except OSError as error:
681
 
                logger.error("Failed to start subprocess: %s",
682
 
                             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)
683
752
        # Re-run this periodically if run by gobject.timeout_add
684
753
        return True
685
754
    
692
761
            return
693
762
        logger.debug("Stopping checker for %(name)s", vars(self))
694
763
        try:
695
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
764
            self.checker.terminate()
696
765
            #time.sleep(0.5)
697
766
            #if self.checker.poll() is None:
698
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
767
            #    self.checker.kill()
699
768
        except OSError as error:
700
769
            if error.errno != errno.ESRCH: # No such process
701
770
                raise
718
787
    # "Set" method, so we fail early here:
719
788
    if byte_arrays and signature != "ay":
720
789
        raise ValueError("Byte arrays not supported for non-'ay'"
721
 
                         " signature %r" % signature)
 
790
                         " signature {0!r}".format(signature))
722
791
    def decorator(func):
723
792
        func._dbus_is_property = True
724
793
        func._dbus_interface = dbus_interface
732
801
    return decorator
733
802
 
734
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
 
735
841
class DBusPropertyException(dbus.exceptions.DBusException):
736
842
    """A base class for D-Bus property-related exceptions
737
843
    """
760
866
    """
761
867
    
762
868
    @staticmethod
763
 
    def _is_dbus_property(obj):
764
 
        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)
765
877
    
766
 
    def _get_all_dbus_properties(self):
 
878
    def _get_all_dbus_things(self, thing):
767
879
        """Returns a generator of (name, attribute) pairs
768
880
        """
769
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
881
        return ((getattr(athing.__get__(self), "_dbus_name",
 
882
                         name),
 
883
                 athing.__get__(self))
770
884
                for cls in self.__class__.__mro__
771
 
                for name, prop in
772
 
                inspect.getmembers(cls, self._is_dbus_property))
 
885
                for name, athing in
 
886
                inspect.getmembers(cls,
 
887
                                   self._is_dbus_thing(thing)))
773
888
    
774
889
    def _get_dbus_property(self, interface_name, property_name):
775
890
        """Returns a bound method if one exists which is a D-Bus
777
892
        """
778
893
        for cls in  self.__class__.__mro__:
779
894
            for name, value in (inspect.getmembers
780
 
                                (cls, self._is_dbus_property)):
 
895
                                (cls,
 
896
                                 self._is_dbus_thing("property"))):
781
897
                if (value._dbus_name == property_name
782
898
                    and value._dbus_interface == interface_name):
783
899
                    return value.__get__(self)
812
928
            # signatures other than "ay".
813
929
            if prop._dbus_signature != "ay":
814
930
                raise ValueError
815
 
            value = dbus.ByteArray(''.join(unichr(byte)
816
 
                                           for byte in value))
 
931
            value = dbus.ByteArray(b''.join(chr(byte)
 
932
                                            for byte in value))
817
933
        prop(value)
818
934
    
819
935
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
825
941
        Note: Will not include properties with access="write".
826
942
        """
827
943
        properties = {}
828
 
        for name, prop in self._get_all_dbus_properties():
 
944
        for name, prop in self._get_all_dbus_things("property"):
829
945
            if (interface_name
830
946
                and interface_name != prop._dbus_interface):
831
947
                # Interface non-empty but did not match
846
962
                         path_keyword='object_path',
847
963
                         connection_keyword='connection')
848
964
    def Introspect(self, object_path, connection):
849
 
        """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.
850
968
        """
851
969
        xmlstring = dbus.service.Object.Introspect(self, object_path,
852
970
                                                   connection)
859
977
                e.setAttribute("access", prop._dbus_access)
860
978
                return e
861
979
            for if_tag in document.getElementsByTagName("interface"):
 
980
                # Add property tags
862
981
                for tag in (make_tag(document, name, prop)
863
982
                            for name, prop
864
 
                            in self._get_all_dbus_properties()
 
983
                            in self._get_all_dbus_things("property")
865
984
                            if prop._dbus_interface
866
985
                            == if_tag.getAttribute("name")):
867
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)
868
1018
                # Add the names to the return values for the
869
1019
                # "org.freedesktop.DBus.Properties" methods
870
1020
                if (if_tag.getAttribute("name")
885
1035
        except (AttributeError, xml.dom.DOMException,
886
1036
                xml.parsers.expat.ExpatError) as error:
887
1037
            logger.error("Failed to override Introspection method",
888
 
                         error)
 
1038
                         exc_info=error)
889
1039
        return xmlstring
890
1040
 
891
1041
 
892
 
def datetime_to_dbus (dt, variant_level=0):
 
1042
def datetime_to_dbus(dt, variant_level=0):
893
1043
    """Convert a UTC datetime.datetime() to a D-Bus type."""
894
1044
    if dt is None:
895
1045
        return dbus.String("", variant_level = variant_level)
897
1047
                       variant_level=variant_level)
898
1048
 
899
1049
 
900
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
901
 
                                  .__metaclass__):
902
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
903
 
    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).
904
1072
    """
905
 
    def __new__(mcs, name, bases, attr):
906
 
        # Go through all the base classes which could have D-Bus
907
 
        # methods, signals, or properties in them
908
 
        for base in (b for b in bases
909
 
                     if issubclass(b, dbus.service.Object)):
910
 
            # Go though all attributes of the base class
911
 
            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):
912
1080
                # Ignore non-D-Bus attributes, and D-Bus attributes
913
1081
                # with the wrong interface name
914
1082
                if (not hasattr(attribute, "_dbus_interface")
915
1083
                    or not attribute._dbus_interface
916
 
                    .startswith("se.recompile.Mandos")):
 
1084
                    .startswith(orig_interface_name)):
917
1085
                    continue
918
1086
                # Create an alternate D-Bus interface name based on
919
1087
                # the current name
920
1088
                alt_interface = (attribute._dbus_interface
921
 
                                 .replace("se.recompile.Mandos",
922
 
                                          "se.bsnet.fukt.Mandos"))
 
1089
                                 .replace(orig_interface_name,
 
1090
                                          alt_interface_name))
 
1091
                interface_names.add(alt_interface)
923
1092
                # Is this a D-Bus signal?
924
1093
                if getattr(attribute, "_dbus_is_signal", False):
925
 
                    # Extract the original non-method function by
926
 
                    # black magic
 
1094
                    # Extract the original non-method undecorated
 
1095
                    # function by black magic
927
1096
                    nonmethod_func = (dict(
928
1097
                            zip(attribute.func_code.co_freevars,
929
1098
                                attribute.__closure__))["func"]
940
1109
                                nonmethod_func.func_name,
941
1110
                                nonmethod_func.func_defaults,
942
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
943
1118
                    # Define a creator of a function to call both the
944
 
                    # old and new functions, so both the old and new
945
 
                    # 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
946
1122
                    def fixscope(func1, func2):
947
1123
                        """This function is a scope container to pass
948
1124
                        func1 and func2 to the "call_both" function
955
1131
                        return call_both
956
1132
                    # Create the "call_both" function and add it to
957
1133
                    # the class
958
 
                    attr[attrname] = fixscope(attribute,
959
 
                                              new_function)
 
1134
                    attr[attrname] = fixscope(attribute, new_function)
960
1135
                # Is this a D-Bus method?
961
1136
                elif getattr(attribute, "_dbus_is_method", False):
962
1137
                    # Create a new, but exactly alike, function
973
1148
                                        attribute.func_name,
974
1149
                                        attribute.func_defaults,
975
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
976
1157
                # Is this a D-Bus property?
977
1158
                elif getattr(attribute, "_dbus_is_property", False):
978
1159
                    # Create a new, but exactly alike, function
992
1173
                                        attribute.func_name,
993
1174
                                        attribute.func_defaults,
994
1175
                                        attribute.func_closure)))
995
 
        return type.__new__(mcs, name, bases, attr)
996
 
 
997
 
 
 
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"})
998
1221
class ClientDBus(Client, DBusObjectWithProperties):
999
1222
    """A Client class using D-Bus
1000
1223
    
1011
1234
    def __init__(self, bus = None, *args, **kwargs):
1012
1235
        self.bus = bus
1013
1236
        Client.__init__(self, *args, **kwargs)
1014
 
        
1015
 
        self._approvals_pending = 0
1016
1237
        # Only now, when this client is initialized, can it show up on
1017
1238
        # the D-Bus
1018
1239
        client_object_name = unicode(self.name).translate(
1022
1243
                                 ("/clients/" + client_object_name))
1023
1244
        DBusObjectWithProperties.__init__(self, self.bus,
1024
1245
                                          self.dbus_object_path)
1025
 
        
 
1246
    
1026
1247
    def notifychangeproperty(transform_func,
1027
1248
                             dbus_name, type_func=lambda x: x,
1028
1249
                             variant_level=1):
1051
1272
        
1052
1273
        return property(lambda self: getattr(self, attrname), setter)
1053
1274
    
1054
 
    
1055
1275
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1056
1276
    approvals_pending = notifychangeproperty(dbus.Boolean,
1057
1277
                                             "ApprovalPending",
1064
1284
                                       checker is not None)
1065
1285
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1066
1286
                                           "LastCheckedOK")
 
1287
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1288
                                               "LastCheckerStatus")
1067
1289
    last_approval_request = notifychangeproperty(
1068
1290
        datetime_to_dbus, "LastApprovalRequest")
1069
1291
    approved_by_default = notifychangeproperty(dbus.Boolean,
1070
1292
                                               "ApprovedByDefault")
1071
 
    approval_delay = notifychangeproperty(dbus.UInt16,
 
1293
    approval_delay = notifychangeproperty(dbus.UInt64,
1072
1294
                                          "ApprovalDelay",
1073
1295
                                          type_func =
1074
1296
                                          timedelta_to_milliseconds)
1075
1297
    approval_duration = notifychangeproperty(
1076
 
        dbus.UInt16, "ApprovalDuration",
 
1298
        dbus.UInt64, "ApprovalDuration",
1077
1299
        type_func = timedelta_to_milliseconds)
1078
1300
    host = notifychangeproperty(dbus.String, "Host")
1079
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
 
1301
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1080
1302
                                   type_func =
1081
1303
                                   timedelta_to_milliseconds)
1082
1304
    extended_timeout = notifychangeproperty(
1083
 
        dbus.UInt16, "ExtendedTimeout",
 
1305
        dbus.UInt64, "ExtendedTimeout",
1084
1306
        type_func = timedelta_to_milliseconds)
1085
 
    interval = notifychangeproperty(dbus.UInt16,
 
1307
    interval = notifychangeproperty(dbus.UInt64,
1086
1308
                                    "Interval",
1087
1309
                                    type_func =
1088
1310
                                    timedelta_to_milliseconds)
1137
1359
        return False
1138
1360
    
1139
1361
    def approve(self, value=True):
1140
 
        self.send_changedstate()
1141
1362
        self.approved = value
1142
1363
        gobject.timeout_add(timedelta_to_milliseconds
1143
1364
                            (self.approval_duration),
1144
1365
                            self._reset_approved)
1145
 
    
 
1366
        self.send_changedstate()
1146
1367
    
1147
1368
    ## D-Bus methods, signals & properties
1148
1369
    _interface = "se.recompile.Mandos.Client"
1149
1370
    
 
1371
    ## Interfaces
 
1372
    
 
1373
    @dbus_interface_annotations(_interface)
 
1374
    def _foo(self):
 
1375
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1376
                     "false"}
 
1377
    
1150
1378
    ## Signals
1151
1379
    
1152
1380
    # CheckerCompleted - signal
1188
1416
        "D-Bus signal"
1189
1417
        return self.need_approval()
1190
1418
    
1191
 
    # NeRwequest - signal
1192
 
    @dbus.service.signal(_interface, signature="s")
1193
 
    def NewRequest(self, ip):
1194
 
        """D-Bus signal
1195
 
        Is sent after a client request a password.
1196
 
        """
1197
 
        pass
1198
 
    
1199
1419
    ## Methods
1200
1420
    
1201
1421
    # Approve - method
1279
1499
    def Host_dbus_property(self, value=None):
1280
1500
        if value is None:       # get
1281
1501
            return dbus.String(self.host)
1282
 
        self.host = value
 
1502
        self.host = unicode(value)
1283
1503
    
1284
1504
    # Created - property
1285
1505
    @dbus_service_property(_interface, signature="s", access="read")
1311
1531
            return
1312
1532
        return datetime_to_dbus(self.last_checked_ok)
1313
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
    
1314
1540
    # Expires - property
1315
1541
    @dbus_service_property(_interface, signature="s", access="read")
1316
1542
    def Expires_dbus_property(self):
1327
1553
    def Timeout_dbus_property(self, value=None):
1328
1554
        if value is None:       # get
1329
1555
            return dbus.UInt64(self.timeout_milliseconds())
 
1556
        old_timeout = self.timeout
1330
1557
        self.timeout = datetime.timedelta(0, 0, 0, value)
1331
 
        if getattr(self, "disable_initiator_tag", None) is None:
1332
 
            return
1333
 
        # Reschedule timeout
1334
 
        gobject.source_remove(self.disable_initiator_tag)
1335
 
        self.disable_initiator_tag = None
1336
 
        self.expires = None
1337
 
        time_to_die = timedelta_to_milliseconds((self
1338
 
                                                 .last_checked_ok
1339
 
                                                 + self.timeout)
1340
 
                                                - datetime.datetime
1341
 
                                                .utcnow())
1342
 
        if time_to_die <= 0:
1343
 
            # The timeout has passed
1344
 
            self.disable()
1345
 
        else:
1346
 
            self.expires = (datetime.datetime.utcnow()
1347
 
                            + datetime.timedelta(milliseconds =
1348
 
                                                 time_to_die))
1349
 
            self.disable_initiator_tag = (gobject.timeout_add
1350
 
                                          (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))
1351
1574
    
1352
1575
    # ExtendedTimeout - property
1353
1576
    @dbus_service_property(_interface, signature="t",
1379
1602
    def Checker_dbus_property(self, value=None):
1380
1603
        if value is None:       # get
1381
1604
            return dbus.String(self.checker_command)
1382
 
        self.checker_command = value
 
1605
        self.checker_command = unicode(value)
1383
1606
    
1384
1607
    # CheckerRunning - property
1385
1608
    @dbus_service_property(_interface, signature="b",
1432
1655
        self._pipe.send(('setattr', name, value))
1433
1656
 
1434
1657
 
1435
 
class ClientDBusTransitional(ClientDBus):
1436
 
    __metaclass__ = AlternateDBusNamesMetaclass
1437
 
 
1438
 
 
1439
1658
class ClientHandler(socketserver.BaseRequestHandler, object):
1440
1659
    """A class to handle client connections.
1441
1660
    
1509
1728
                except KeyError:
1510
1729
                    return
1511
1730
                
1512
 
                if self.server.use_dbus:
1513
 
                    # Emit D-Bus signal
1514
 
                    client.NewRequest(str(self.client_address))
1515
 
                
1516
1731
                if client.approval_delay:
1517
1732
                    delay = client.approval_delay
1518
1733
                    client.approvals_pending += 1
1549
1764
                    #wait until timeout or approved
1550
1765
                    time = datetime.datetime.now()
1551
1766
                    client.changedstate.acquire()
1552
 
                    (client.changedstate.wait
1553
 
                     (float(client.timedelta_to_milliseconds(delay)
1554
 
                            / 1000)))
 
1767
                    client.changedstate.wait(
 
1768
                        float(timedelta_to_milliseconds(delay)
 
1769
                              / 1000))
1555
1770
                    client.changedstate.release()
1556
1771
                    time2 = datetime.datetime.now()
1557
1772
                    if (time2 - time) >= delay:
1573
1788
                    try:
1574
1789
                        sent = session.send(client.secret[sent_size:])
1575
1790
                    except gnutls.errors.GNUTLSError as error:
1576
 
                        logger.warning("gnutls send failed")
 
1791
                        logger.warning("gnutls send failed",
 
1792
                                       exc_info=error)
1577
1793
                        return
1578
1794
                    logger.debug("Sent: %d, remaining: %d",
1579
1795
                                 sent, len(client.secret)
1582
1798
                
1583
1799
                logger.info("Sending secret to %s", client.name)
1584
1800
                # bump the timeout using extended_timeout
1585
 
                client.checked_ok(client.extended_timeout)
 
1801
                client.bump_timeout(client.extended_timeout)
1586
1802
                if self.server.use_dbus:
1587
1803
                    # Emit D-Bus signal
1588
1804
                    client.GotSecret()
1593
1809
                try:
1594
1810
                    session.bye()
1595
1811
                except gnutls.errors.GNUTLSError as error:
1596
 
                    logger.warning("GnuTLS bye failed")
 
1812
                    logger.warning("GnuTLS bye failed",
 
1813
                                   exc_info=error)
1597
1814
    
1598
1815
    @staticmethod
1599
1816
    def peer_certificate(session):
1664
1881
    def sub_process_main(self, request, address):
1665
1882
        try:
1666
1883
            self.finish_request(request, address)
1667
 
        except:
 
1884
        except Exception:
1668
1885
            self.handle_error(request, address)
1669
1886
        self.close_request(request)
1670
1887
    
1671
1888
    def process_request(self, request, address):
1672
1889
        """Start a new process to process the request."""
1673
1890
        proc = multiprocessing.Process(target = self.sub_process_main,
1674
 
                                       args = (request,
1675
 
                                               address))
 
1891
                                       args = (request, address))
1676
1892
        proc.start()
1677
1893
        return proc
1678
1894
 
1706
1922
        use_ipv6:       Boolean; to use IPv6 or not
1707
1923
    """
1708
1924
    def __init__(self, server_address, RequestHandlerClass,
1709
 
                 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
        """
1710
1929
        self.interface = interface
1711
1930
        if use_ipv6:
1712
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.
1713
1958
        socketserver.TCPServer.__init__(self, server_address,
1714
1959
                                        RequestHandlerClass)
 
1960
    
1715
1961
    def server_bind(self):
1716
1962
        """This overrides the normal server_bind() function
1717
1963
        to bind to an interface if one was specified, and also NOT to
1725
1971
                try:
1726
1972
                    self.socket.setsockopt(socket.SOL_SOCKET,
1727
1973
                                           SO_BINDTODEVICE,
1728
 
                                           str(self.interface
1729
 
                                               + '\0'))
 
1974
                                           str(self.interface + '\0'))
1730
1975
                except socket.error as error:
1731
 
                    if error[0] == errno.EPERM:
1732
 
                        logger.error("No permission to"
1733
 
                                     " bind to interface %s",
1734
 
                                     self.interface)
1735
 
                    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:
1736
1980
                        logger.error("SO_BINDTODEVICE not available;"
1737
1981
                                     " cannot bind to interface %s",
1738
1982
                                     self.interface)
 
1983
                    elif error.errno == errno.ENODEV:
 
1984
                        logger.error("Interface %s does not exist,"
 
1985
                                     " cannot bind", self.interface)
1739
1986
                    else:
1740
1987
                        raise
1741
1988
        # Only bind(2) the socket if we really need to.
1744
1991
                if self.address_family == socket.AF_INET6:
1745
1992
                    any_address = "::" # in6addr_any
1746
1993
                else:
1747
 
                    any_address = socket.INADDR_ANY
 
1994
                    any_address = "0.0.0.0" # INADDR_ANY
1748
1995
                self.server_address = (any_address,
1749
1996
                                       self.server_address[1])
1750
1997
            elif not self.server_address[1]:
1771
2018
    """
1772
2019
    def __init__(self, server_address, RequestHandlerClass,
1773
2020
                 interface=None, use_ipv6=True, clients=None,
1774
 
                 gnutls_priority=None, use_dbus=True):
 
2021
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1775
2022
        self.enabled = False
1776
2023
        self.clients = clients
1777
2024
        if self.clients is None:
1781
2028
        IPv6_TCPServer.__init__(self, server_address,
1782
2029
                                RequestHandlerClass,
1783
2030
                                interface = interface,
1784
 
                                use_ipv6 = use_ipv6)
 
2031
                                use_ipv6 = use_ipv6,
 
2032
                                socketfd = socketfd)
1785
2033
    def server_activate(self):
1786
2034
        if self.enabled:
1787
2035
            return socketserver.TCPServer.server_activate(self)
1800
2048
    
1801
2049
    def handle_ipc(self, source, condition, parent_pipe=None,
1802
2050
                   proc = None, client_object=None):
1803
 
        condition_names = {
1804
 
            gobject.IO_IN: "IN",   # There is data to read.
1805
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1806
 
                                    # blocking).
1807
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1808
 
            gobject.IO_ERR: "ERR", # Error condition.
1809
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1810
 
                                    # broken, usually for pipes and
1811
 
                                    # sockets).
1812
 
            }
1813
 
        conditions_string = ' | '.join(name
1814
 
                                       for cond, name in
1815
 
                                       condition_names.iteritems()
1816
 
                                       if cond & condition)
1817
2051
        # error, or the other end of multiprocessing.Pipe has closed
1818
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2052
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1819
2053
            # Wait for other process to exit
1820
2054
            proc.join()
1821
2055
            return False
1879
2113
        return True
1880
2114
 
1881
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
 
1882
2215
def string_to_delta(interval):
1883
2216
    """Parse a string and return a datetime.timedelta
1884
2217
    
1895
2228
    >>> string_to_delta('5m 30s')
1896
2229
    datetime.timedelta(0, 330)
1897
2230
    """
 
2231
    
 
2232
    try:
 
2233
        return rfc3339_duration_to_delta(interval)
 
2234
    except ValueError:
 
2235
        pass
 
2236
    
1898
2237
    timevalue = datetime.timedelta(0)
1899
2238
    for s in interval.split():
1900
2239
        try:
1911
2250
            elif suffix == "w":
1912
2251
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1913
2252
            else:
1914
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2253
                raise ValueError("Unknown suffix {0!r}"
 
2254
                                 .format(suffix))
1915
2255
        except (ValueError, IndexError) as e:
1916
2256
            raise ValueError(*(e.args))
1917
2257
        timevalue += delta
1931
2271
        sys.exit()
1932
2272
    if not noclose:
1933
2273
        # Close all standard open file descriptors
1934
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2274
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1935
2275
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1936
2276
            raise OSError(errno.ENODEV,
1937
 
                          "%s not a character device"
1938
 
                          % os.path.devnull)
 
2277
                          "{0} not a character device"
 
2278
                          .format(os.devnull))
1939
2279
        os.dup2(null, sys.stdin.fileno())
1940
2280
        os.dup2(null, sys.stdout.fileno())
1941
2281
        os.dup2(null, sys.stderr.fileno())
1950
2290
    
1951
2291
    parser = argparse.ArgumentParser()
1952
2292
    parser.add_argument("-v", "--version", action="version",
1953
 
                        version = "%%(prog)s %s" % version,
 
2293
                        version = "%(prog)s {0}".format(version),
1954
2294
                        help="show version number and exit")
1955
2295
    parser.add_argument("-i", "--interface", metavar="IF",
1956
2296
                        help="Bind to interface IF")
1962
2302
                        help="Run self-test")
1963
2303
    parser.add_argument("--debug", action="store_true",
1964
2304
                        help="Debug mode; run in foreground and log"
1965
 
                        " to terminal")
 
2305
                        " to terminal", default=None)
1966
2306
    parser.add_argument("--debuglevel", metavar="LEVEL",
1967
2307
                        help="Debug level for stdout output")
1968
2308
    parser.add_argument("--priority", help="GnuTLS"
1975
2315
                        " files")
1976
2316
    parser.add_argument("--no-dbus", action="store_false",
1977
2317
                        dest="use_dbus", help="Do not provide D-Bus"
1978
 
                        " system bus interface")
 
2318
                        " system bus interface", default=None)
1979
2319
    parser.add_argument("--no-ipv6", action="store_false",
1980
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2320
                        dest="use_ipv6", help="Do not use IPv6",
 
2321
                        default=None)
1981
2322
    parser.add_argument("--no-restore", action="store_false",
1982
2323
                        dest="restore", help="Do not restore stored"
1983
 
                        " state")
 
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")
1984
2328
    parser.add_argument("--statedir", metavar="DIR",
1985
2329
                        help="Directory to save/restore state in")
 
2330
    parser.add_argument("--foreground", action="store_true",
 
2331
                        help="Run in foreground", default=None)
1986
2332
    
1987
2333
    options = parser.parse_args()
1988
2334
    
1997
2343
                        "port": "",
1998
2344
                        "debug": "False",
1999
2345
                        "priority":
2000
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2346
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224",
2001
2347
                        "servicename": "Mandos",
2002
2348
                        "use_dbus": "True",
2003
2349
                        "use_ipv6": "True",
2004
2350
                        "debuglevel": "",
2005
2351
                        "restore": "True",
2006
 
                        "statedir": "/var/lib/mandos"
 
2352
                        "socket": "",
 
2353
                        "statedir": "/var/lib/mandos",
 
2354
                        "foreground": "False",
2007
2355
                        }
2008
2356
    
2009
2357
    # Parse config file for server-global settings
2014
2362
    # Convert the SafeConfigParser object to a dict
2015
2363
    server_settings = server_config.defaults()
2016
2364
    # Use the appropriate methods on the non-string config options
2017
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2365
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2018
2366
        server_settings[option] = server_config.getboolean("DEFAULT",
2019
2367
                                                           option)
2020
2368
    if server_settings["port"]:
2021
2369
        server_settings["port"] = server_config.getint("DEFAULT",
2022
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"])
2023
2380
    del server_config
2024
2381
    
2025
2382
    # Override the settings from the config file with command line
2027
2384
    for option in ("interface", "address", "port", "debug",
2028
2385
                   "priority", "servicename", "configdir",
2029
2386
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2030
 
                   "statedir"):
 
2387
                   "statedir", "socket", "foreground"):
2031
2388
        value = getattr(options, option)
2032
2389
        if value is not None:
2033
2390
            server_settings[option] = value
2036
2393
    for option in server_settings.keys():
2037
2394
        if type(server_settings[option]) is str:
2038
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
2039
2403
    # Now we have our good server settings in "server_settings"
2040
2404
    
2041
2405
    ##################################################################
2047
2411
    use_ipv6 = server_settings["use_ipv6"]
2048
2412
    stored_state_path = os.path.join(server_settings["statedir"],
2049
2413
                                     stored_state_file)
 
2414
    foreground = server_settings["foreground"]
2050
2415
    
2051
2416
    if debug:
2052
 
        initlogger(logging.DEBUG)
 
2417
        initlogger(debug, logging.DEBUG)
2053
2418
    else:
2054
2419
        if not debuglevel:
2055
 
            initlogger()
 
2420
            initlogger(debug)
2056
2421
        else:
2057
2422
            level = getattr(logging, debuglevel.upper())
2058
 
            initlogger(level)
 
2423
            initlogger(debug, level)
2059
2424
    
2060
2425
    if server_settings["servicename"] != "Mandos":
2061
2426
        syslogger.setFormatter(logging.Formatter
2062
 
                               ('Mandos (%s) [%%(process)d]:'
2063
 
                                ' %%(levelname)s: %%(message)s'
2064
 
                                % server_settings["servicename"]))
 
2427
                               ('Mandos ({0}) [%(process)d]:'
 
2428
                                ' %(levelname)s: %(message)s'
 
2429
                                .format(server_settings
 
2430
                                        ["servicename"])))
2065
2431
    
2066
2432
    # Parse config file with clients
2067
 
    client_defaults = { "timeout": "5m",
2068
 
                        "extended_timeout": "15m",
2069
 
                        "interval": "2m",
2070
 
                        "checker": "fping -q -- %%(host)s",
2071
 
                        "host": "",
2072
 
                        "approval_delay": "0s",
2073
 
                        "approval_duration": "1s",
2074
 
                        }
2075
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2433
    client_config = configparser.SafeConfigParser(Client
 
2434
                                                  .client_defaults)
2076
2435
    client_config.read(os.path.join(server_settings["configdir"],
2077
2436
                                    "clients.conf"))
2078
2437
    
2087
2446
                              use_ipv6=use_ipv6,
2088
2447
                              gnutls_priority=
2089
2448
                              server_settings["priority"],
2090
 
                              use_dbus=use_dbus)
2091
 
    if not debug:
2092
 
        pidfilename = "/var/run/mandos.pid"
 
2449
                              use_dbus=use_dbus,
 
2450
                              socketfd=(server_settings["socket"]
 
2451
                                        or None))
 
2452
    if not foreground:
 
2453
        pidfilename = "/run/mandos.pid"
 
2454
        pidfile = None
2093
2455
        try:
2094
2456
            pidfile = open(pidfilename, "w")
2095
 
        except IOError:
2096
 
            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)
2097
2460
    
2098
 
    try:
2099
 
        uid = pwd.getpwnam("_mandos").pw_uid
2100
 
        gid = pwd.getpwnam("_mandos").pw_gid
2101
 
    except KeyError:
 
2461
    for name in ("_mandos", "mandos", "nobody"):
2102
2462
        try:
2103
 
            uid = pwd.getpwnam("mandos").pw_uid
2104
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2463
            uid = pwd.getpwnam(name).pw_uid
 
2464
            gid = pwd.getpwnam(name).pw_gid
 
2465
            break
2105
2466
        except KeyError:
2106
 
            try:
2107
 
                uid = pwd.getpwnam("nobody").pw_uid
2108
 
                gid = pwd.getpwnam("nobody").pw_gid
2109
 
            except KeyError:
2110
 
                uid = 65534
2111
 
                gid = 65534
 
2467
            continue
 
2468
    else:
 
2469
        uid = 65534
 
2470
        gid = 65534
2112
2471
    try:
2113
2472
        os.setgid(gid)
2114
2473
        os.setuid(uid)
2115
2474
    except OSError as error:
2116
 
        if error[0] != errno.EPERM:
 
2475
        if error.errno != errno.EPERM:
2117
2476
            raise error
2118
2477
    
2119
2478
    if debug:
2131
2490
         .gnutls_global_set_log_function(debug_gnutls))
2132
2491
        
2133
2492
        # Redirect stdin so all checkers get /dev/null
2134
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2493
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2135
2494
        os.dup2(null, sys.stdin.fileno())
2136
2495
        if null > 2:
2137
2496
            os.close(null)
2138
 
    else:
2139
 
        # No console logging
2140
 
        logger.removeHandler(console)
2141
2497
    
2142
2498
    # Need to fork before connecting to D-Bus
2143
 
    if not debug:
 
2499
    if not foreground:
2144
2500
        # Close all input and output, do double fork, etc.
2145
2501
        daemon()
2146
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
    
2147
2507
    global main_loop
2148
2508
    # From the Avahi example code
2149
 
    DBusGMainLoop(set_as_default=True )
 
2509
    DBusGMainLoop(set_as_default=True)
2150
2510
    main_loop = gobject.MainLoop()
2151
2511
    bus = dbus.SystemBus()
2152
2512
    # End of Avahi example code
2158
2518
                            ("se.bsnet.fukt.Mandos", bus,
2159
2519
                             do_not_queue=True))
2160
2520
        except dbus.exceptions.NameExistsException as e:
2161
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2521
            logger.error("Disabling D-Bus:", exc_info=e)
2162
2522
            use_dbus = False
2163
2523
            server_settings["use_dbus"] = False
2164
2524
            tcp_server.use_dbus = False
2176
2536
    
2177
2537
    client_class = Client
2178
2538
    if use_dbus:
2179
 
        client_class = functools.partial(ClientDBusTransitional,
2180
 
                                         bus = bus)
2181
 
    
2182
 
    special_settings = {
2183
 
        # Some settings need to be accessd by special methods;
2184
 
        # booleans need .getboolean(), etc.  Here is a list of them:
2185
 
        "approved_by_default":
2186
 
            lambda section:
2187
 
            client_config.getboolean(section, "approved_by_default"),
2188
 
        "enabled":
2189
 
            lambda section:
2190
 
            client_config.getboolean(section, "enabled"),
2191
 
        }
2192
 
    # Construct a new dict of client settings of this form:
2193
 
    # { client_name: {setting_name: value, ...}, ...}
2194
 
    # with exceptions for any special settings as defined above
2195
 
    client_settings = dict((clientname,
2196
 
                           dict((setting,
2197
 
                                 (value
2198
 
                                  if setting not in special_settings
2199
 
                                  else special_settings[setting]
2200
 
                                  (clientname)))
2201
 
                                for setting, value in
2202
 
                                client_config.items(clientname)))
2203
 
                          for clientname in client_config.sections())
2204
 
    
 
2539
        client_class = functools.partial(ClientDBus, bus = bus)
 
2540
    
 
2541
    client_settings = Client.config_parser(client_config)
2205
2542
    old_client_settings = {}
2206
 
    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()
2207
2552
    
2208
2553
    # Get client data and settings from last running state.
2209
2554
    if server_settings["restore"]:
2213
2558
                                                     (stored_state))
2214
2559
            os.remove(stored_state_path)
2215
2560
        except IOError as e:
2216
 
            logger.warning("Could not load persistent state: {0}"
2217
 
                           .format(e))
2218
 
            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)
2219
2567
                raise
 
2568
        except EOFError as e:
 
2569
            logger.warning("Could not load persistent state: "
 
2570
                           "EOFError:", exc_info=e)
2220
2571
    
2221
 
    with Crypto() as crypt:
2222
 
        for client in clients_data:
2223
 
            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
2224
2577
            
2225
2578
            # Decide which value to use after restoring saved state.
2226
2579
            # We have three different values: Old config file,
2235
2588
                    if (name != "secret" and
2236
2589
                        value != old_client_settings[client_name]
2237
2590
                        [name]):
2238
 
                        setattr(client, name, value)
 
2591
                        client[name] = value
2239
2592
                except KeyError:
2240
2593
                    pass
2241
2594
            
2242
2595
            # Clients who has passed its expire date can still be
2243
 
            # enabled if its last checker was sucessful.  Clients
2244
 
            # whose checker failed before we stored its state is
2245
 
            # assumed to have failed all checkers during downtime.
2246
 
            if client["enabled"] and client["last_checked_ok"]:
2247
 
                if ((datetime.datetime.utcnow()
2248
 
                     - client["last_checked_ok"])
2249
 
                    > client["interval"]):
2250
 
                    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"]))
2251
2614
                        client["enabled"] = False
2252
2615
                    else:
2253
2616
                        client["expires"] = (datetime.datetime
2254
2617
                                             .utcnow()
2255
2618
                                             + client["timeout"])
2256
 
            
2257
 
            client["changedstate"] = (multiprocessing_manager
2258
 
                                      .Condition
2259
 
                                      (multiprocessing_manager
2260
 
                                       .Lock()))
2261
 
            if use_dbus:
2262
 
                new_client = (ClientDBusTransitional.__new__
2263
 
                              (ClientDBusTransitional))
2264
 
                tcp_server.clients[client_name] = new_client
2265
 
                new_client.bus = bus
2266
 
                for name, value in client.iteritems():
2267
 
                    setattr(new_client, name, value)
2268
 
                client_object_name = unicode(client_name).translate(
2269
 
                    {ord("."): ord("_"),
2270
 
                     ord("-"): ord("_")})
2271
 
                new_client.dbus_object_path = (dbus.ObjectPath
2272
 
                                               ("/clients/"
2273
 
                                                + client_object_name))
2274
 
                DBusObjectWithProperties.__init__(new_client,
2275
 
                                                  new_client.bus,
2276
 
                                                  new_client
2277
 
                                                  .dbus_object_path)
2278
 
            else:
2279
 
                tcp_server.clients[client_name] = (Client.__new__
2280
 
                                                   (Client))
2281
 
                for name, value in client.iteritems():
2282
 
                    setattr(tcp_server.clients[client_name],
2283
 
                            name, value)
2284
 
            
 
2619
                        logger.debug("Last checker succeeded,"
 
2620
                                     " keeping {0} enabled"
 
2621
                                     .format(client_name))
2285
2622
            try:
2286
 
                tcp_server.clients[client_name].secret = (
2287
 
                    crypt.decrypt(tcp_server.clients[client_name]
2288
 
                                  .encrypted_secret,
2289
 
                                  client_settings[client_name]
2290
 
                                  ["secret"]))
2291
 
            except CryptoError:
 
2623
                client["secret"] = (
 
2624
                    pgp.decrypt(client["encrypted_secret"],
 
2625
                                client_settings[client_name]
 
2626
                                ["secret"]))
 
2627
            except PGPError:
2292
2628
                # If decryption fails, we use secret from new settings
2293
 
                tcp_server.clients[client_name].secret = (
 
2629
                logger.debug("Failed to decrypt {0} old secret"
 
2630
                             .format(client_name))
 
2631
                client["secret"] = (
2294
2632
                    client_settings[client_name]["secret"])
2295
2633
    
2296
 
    # Create/remove clients based on new changes made to config
2297
 
    for clientname in set(old_client_settings) - set(client_settings):
2298
 
        del tcp_server.clients[clientname]
2299
 
    for clientname in set(client_settings) - set(old_client_settings):
2300
 
        tcp_server.clients[clientname] = (client_class(name
2301
 
                                                       = clientname,
2302
 
                                                       config =
2303
 
                                                       client_settings
2304
 
                                                       [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)
2305
2647
    
2306
2648
    if not tcp_server.clients:
2307
2649
        logger.warning("No clients defined")
2308
 
        
2309
 
    if not debug:
2310
 
        try:
2311
 
            with pidfile:
2312
 
                pid = os.getpid()
2313
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2314
 
            del pidfile
2315
 
        except IOError:
2316
 
            logger.error("Could not write to file %r with PID %d",
2317
 
                         pidfilename, pid)
2318
 
        except NameError:
2319
 
            # "pidfile" was never created
2320
 
            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
2321
2661
        del pidfilename
2322
 
        
2323
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2324
2662
    
2325
2663
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2326
2664
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2327
2665
    
2328
2666
    if use_dbus:
2329
 
        class MandosDBusService(dbus.service.Object):
 
2667
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2668
                                        "se.bsnet.fukt.Mandos"})
 
2669
        class MandosDBusService(DBusObjectWithProperties):
2330
2670
            """A D-Bus proxy object"""
2331
2671
            def __init__(self):
2332
2672
                dbus.service.Object.__init__(self, bus, "/")
2333
2673
            _interface = "se.recompile.Mandos"
2334
2674
            
 
2675
            @dbus_interface_annotations(_interface)
 
2676
            def _foo(self):
 
2677
                return { "org.freedesktop.DBus.Property"
 
2678
                         ".EmitsChangedSignal":
 
2679
                             "false"}
 
2680
            
2335
2681
            @dbus.service.signal(_interface, signature="o")
2336
2682
            def ClientAdded(self, objpath):
2337
2683
                "D-Bus signal"
2379
2725
            
2380
2726
            del _interface
2381
2727
        
2382
 
        class MandosDBusServiceTransitional(MandosDBusService):
2383
 
            __metaclass__ = AlternateDBusNamesMetaclass
2384
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2728
        mandos_dbus_service = MandosDBusService()
2385
2729
    
2386
2730
    def cleanup():
2387
2731
        "Cleanup function; run on exit"
2388
2732
        service.cleanup()
2389
2733
        
2390
2734
        multiprocessing.active_children()
 
2735
        wnull.close()
2391
2736
        if not (tcp_server.clients or client_settings):
2392
2737
            return
2393
2738
        
2394
2739
        # Store client before exiting. Secrets are encrypted with key
2395
2740
        # based on what config file has. If config file is
2396
2741
        # removed/edited, old secret will thus be unrecovable.
2397
 
        clients = []
2398
 
        with Crypto() as crypt:
 
2742
        clients = {}
 
2743
        with PGPEngine() as pgp:
2399
2744
            for client in tcp_server.clients.itervalues():
2400
2745
                key = client_settings[client.name]["secret"]
2401
 
                client.encrypted_secret = crypt.encrypt(client.secret,
2402
 
                                                        key)
 
2746
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2747
                                                      key)
2403
2748
                client_dict = {}
2404
2749
                
2405
 
                # A list of attributes that will not be stored when
2406
 
                # shutting down.
2407
 
                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"))
2408
2754
                for name, typ in (inspect.getmembers
2409
2755
                                  (dbus.service.Object)):
2410
2756
                    exclude.add(name)
2415
2761
                    if attr not in exclude:
2416
2762
                        client_dict[attr] = getattr(client, attr)
2417
2763
                
2418
 
                clients.append(client_dict)
 
2764
                clients[client.name] = client_dict
2419
2765
                del client_settings[client.name]["secret"]
2420
2766
        
2421
2767
        try:
2422
 
            with os.fdopen(os.open(stored_state_path,
2423
 
                                   os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2424
 
                                   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:
2425
2772
                pickle.dump((clients, client_settings), stored_state)
 
2773
                tempname=stored_state.name
 
2774
            os.rename(tempname, stored_state_path)
2426
2775
        except (IOError, OSError) as e:
2427
 
            logger.warning("Could not save persistent state: {0}"
2428
 
                           .format(e))
2429
 
            if e.errno not in (errno.ENOENT, errno.EACCES):
2430
 
                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
2431
2788
        
2432
2789
        # Delete all clients, and settings from config
2433
2790
        while tcp_server.clients:
2460
2817
    service.port = tcp_server.socket.getsockname()[1]
2461
2818
    if use_ipv6:
2462
2819
        logger.info("Now listening on address %r, port %d,"
2463
 
                    " flowinfo %d, scope_id %d"
2464
 
                    % tcp_server.socket.getsockname())
 
2820
                    " flowinfo %d, scope_id %d",
 
2821
                    *tcp_server.socket.getsockname())
2465
2822
    else:                       # IPv4
2466
 
        logger.info("Now listening on address %r, port %d"
2467
 
                    % tcp_server.socket.getsockname())
 
2823
        logger.info("Now listening on address %r, port %d",
 
2824
                    *tcp_server.socket.getsockname())
2468
2825
    
2469
2826
    #service.interface = tcp_server.socket.getsockname()[3]
2470
2827
    
2473
2830
        try:
2474
2831
            service.activate()
2475
2832
        except dbus.exceptions.DBusException as error:
2476
 
            logger.critical("DBusException: %s", error)
 
2833
            logger.critical("D-Bus Exception", exc_info=error)
2477
2834
            cleanup()
2478
2835
            sys.exit(1)
2479
2836
        # End of Avahi example code
2486
2843
        logger.debug("Starting main loop")
2487
2844
        main_loop.run()
2488
2845
    except AvahiError as error:
2489
 
        logger.critical("AvahiError: %s", error)
 
2846
        logger.critical("Avahi Error", exc_info=error)
2490
2847
        cleanup()
2491
2848
        sys.exit(1)
2492
2849
    except KeyboardInterrupt:
2497
2854
    # Must run before the D-Bus bus name gets deregistered
2498
2855
    cleanup()
2499
2856
 
2500
 
 
2501
2857
if __name__ == '__main__':
2502
2858
    main()