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