/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-10-26 19:05:21 UTC
  • Revision ID: teddy@recompile.se-20131026190521-giagilisbyciox2h
Fall back to /var/run for pidfile if /run is not a directory.

This is for old (possibly non-Debian) systems which have not migrated
from /var/run to /run yet.

* init.d-mandos (PIDFILE): Fall back to /var/run/mandos.pid if /run is
                           not a directory.
* mandos (pidfilename): - '' -
* mandos.xml (FILES): Document fallback to /var/run/mandos.pid if /run
                      is not a directory.

Reported-by: Nathanael D. Noblet <nathanael@gnat.ca>
Suggested-by: Nathanael D. Noblet <nathanael@gnat.ca>

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