/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 at recompile
  • Date: 2011-12-27 14:15:40 UTC
  • Revision ID: teddy@recompile.se-20111227141540-ajrabf33q59jfa7t
Reorder TODO entries

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python2.7
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2014 Teddy Hogeborn
15
 
# Copyright © 2008-2014 Björn Påhlsson
 
14
# Copyright © 2008-2011 Teddy Hogeborn
 
15
# Copyright © 2008-2011 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
 
 
39
37
import SocketServer as socketserver
40
38
import socket
41
39
import argparse
67
65
import types
68
66
import binascii
69
67
import tempfile
70
 
import itertools
71
 
import collections
72
68
 
73
69
import dbus
74
70
import dbus.service
79
75
import ctypes.util
80
76
import xml.dom.minidom
81
77
import inspect
 
78
import GnuPGInterface
82
79
 
83
80
try:
84
81
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
85
    except ImportError:
89
86
        SO_BINDTODEVICE = None
90
87
 
91
 
version = "1.6.8"
 
88
version = "1.4.1"
92
89
stored_state_file = "clients.pickle"
93
90
 
94
91
logger = logging.getLogger()
95
 
syslogger = None
 
92
syslogger = (logging.handlers.SysLogHandler
 
93
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
94
              address = str("/dev/log")))
96
95
 
97
96
try:
98
97
    if_nametoindex = (ctypes.cdll.LoadLibrary
104
103
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
105
104
        with contextlib.closing(socket.socket()) as s:
106
105
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
 
                                struct.pack(b"16s16x", interface))
108
 
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
106
                                struct.pack(str("16s16x"),
 
107
                                            interface))
 
108
        interface_index = struct.unpack(str("I"),
 
109
                                        ifreq[16:20])[0]
109
110
        return interface_index
110
111
 
111
112
 
112
113
def initlogger(debug, level=logging.WARNING):
113
114
    """init logger and add loglevel"""
114
115
    
115
 
    global syslogger
116
 
    syslogger = (logging.handlers.SysLogHandler
117
 
                 (facility =
118
 
                  logging.handlers.SysLogHandler.LOG_DAEMON,
119
 
                  address = "/dev/log"))
120
116
    syslogger.setFormatter(logging.Formatter
121
117
                           ('Mandos [%(process)d]: %(levelname)s:'
122
118
                            ' %(message)s'))
140
136
class PGPEngine(object):
141
137
    """A simple class for OpenPGP symmetric encryption & decryption"""
142
138
    def __init__(self):
 
139
        self.gnupg = GnuPGInterface.GnuPG()
143
140
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
144
 
        self.gnupgargs = ['--batch',
145
 
                          '--home', self.tempdir,
146
 
                          '--force-mdc',
147
 
                          '--quiet',
148
 
                          '--no-use-agent']
 
141
        self.gnupg = GnuPGInterface.GnuPG()
 
142
        self.gnupg.options.meta_interactive = False
 
143
        self.gnupg.options.homedir = self.tempdir
 
144
        self.gnupg.options.extra_args.extend(['--force-mdc',
 
145
                                              '--quiet'])
149
146
    
150
147
    def __enter__(self):
151
148
        return self
152
149
    
153
 
    def __exit__(self, exc_type, exc_value, traceback):
 
150
    def __exit__ (self, exc_type, exc_value, traceback):
154
151
        self._cleanup()
155
152
        return False
156
153
    
173
170
    def password_encode(self, password):
174
171
        # Passphrase can not be empty and can not contain newlines or
175
172
        # NUL bytes.  So we prefix it and hex encode it.
176
 
        encoded = b"mandos" + binascii.hexlify(password)
177
 
        if len(encoded) > 2048:
178
 
            # GnuPG can't handle long passwords, so encode differently
179
 
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
180
 
                       .replace(b"\n", b"\\n")
181
 
                       .replace(b"\0", b"\\x00"))
182
 
        return encoded
 
173
        return b"mandos" + binascii.hexlify(password)
183
174
    
184
175
    def encrypt(self, data, password):
185
 
        passphrase = self.password_encode(password)
186
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
187
 
                                         ) as passfile:
188
 
            passfile.write(passphrase)
189
 
            passfile.flush()
190
 
            proc = subprocess.Popen(['gpg', '--symmetric',
191
 
                                     '--passphrase-file',
192
 
                                     passfile.name]
193
 
                                    + self.gnupgargs,
194
 
                                    stdin = subprocess.PIPE,
195
 
                                    stdout = subprocess.PIPE,
196
 
                                    stderr = subprocess.PIPE)
197
 
            ciphertext, err = proc.communicate(input = data)
198
 
        if proc.returncode != 0:
199
 
            raise PGPError(err)
 
176
        self.gnupg.passphrase = self.password_encode(password)
 
177
        with open(os.devnull) as devnull:
 
178
            try:
 
179
                proc = self.gnupg.run(['--symmetric'],
 
180
                                      create_fhs=['stdin', 'stdout'],
 
181
                                      attach_fhs={'stderr': devnull})
 
182
                with contextlib.closing(proc.handles['stdin']) as f:
 
183
                    f.write(data)
 
184
                with contextlib.closing(proc.handles['stdout']) as f:
 
185
                    ciphertext = f.read()
 
186
                proc.wait()
 
187
            except IOError as e:
 
188
                raise PGPError(e)
 
189
        self.gnupg.passphrase = None
200
190
        return ciphertext
201
191
    
202
192
    def decrypt(self, data, password):
203
 
        passphrase = self.password_encode(password)
204
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
205
 
                                         ) as passfile:
206
 
            passfile.write(passphrase)
207
 
            passfile.flush()
208
 
            proc = subprocess.Popen(['gpg', '--decrypt',
209
 
                                     '--passphrase-file',
210
 
                                     passfile.name]
211
 
                                    + self.gnupgargs,
212
 
                                    stdin = subprocess.PIPE,
213
 
                                    stdout = subprocess.PIPE,
214
 
                                    stderr = subprocess.PIPE)
215
 
            decrypted_plaintext, err = proc.communicate(input
216
 
                                                        = data)
217
 
        if proc.returncode != 0:
218
 
            raise PGPError(err)
 
193
        self.gnupg.passphrase = self.password_encode(password)
 
194
        with open(os.devnull) as devnull:
 
195
            try:
 
196
                proc = self.gnupg.run(['--decrypt'],
 
197
                                      create_fhs=['stdin', 'stdout'],
 
198
                                      attach_fhs={'stderr': devnull})
 
199
                with contextlib.closing(proc.handles['stdin'] ) as f:
 
200
                    f.write(data)
 
201
                with contextlib.closing(proc.handles['stdout']) as f:
 
202
                    decrypted_plaintext = f.read()
 
203
                proc.wait()
 
204
            except IOError as e:
 
205
                raise PGPError(e)
 
206
        self.gnupg.passphrase = None
219
207
        return decrypted_plaintext
220
208
 
221
209
 
 
210
 
222
211
class AvahiError(Exception):
223
212
    def __init__(self, value, *args, **kwargs):
224
213
        self.value = value
225
 
        return super(AvahiError, self).__init__(value, *args,
226
 
                                                **kwargs)
 
214
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
215
    def __unicode__(self):
 
216
        return unicode(repr(self.value))
227
217
 
228
218
class AvahiServiceError(AvahiError):
229
219
    pass
240
230
               Used to optionally bind to the specified interface.
241
231
    name: string; Example: 'Mandos'
242
232
    type: string; Example: '_mandos._tcp'.
243
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
233
                  See <http://www.dns-sd.org/ServiceTypes.html>
244
234
    port: integer; what port to announce
245
235
    TXT: list of strings; TXT record for the service
246
236
    domain: string; Domain to publish on, default to .local if empty.
252
242
    server: D-Bus Server
253
243
    bus: dbus.SystemBus()
254
244
    """
255
 
    
256
245
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
257
246
                 servicetype = None, port = None, TXT = None,
258
247
                 domain = "", host = "", max_renames = 32768,
271
260
        self.server = None
272
261
        self.bus = bus
273
262
        self.entry_group_state_changed_match = None
274
 
    
275
263
    def rename(self):
276
264
        """Derived from the Avahi example code"""
277
265
        if self.rename_count >= self.max_renames:
287
275
        try:
288
276
            self.add()
289
277
        except dbus.exceptions.DBusException as error:
290
 
            logger.critical("D-Bus Exception", exc_info=error)
 
278
            logger.critical("DBusException: %s", error)
291
279
            self.cleanup()
292
280
            os._exit(1)
293
281
        self.rename_count += 1
294
 
    
295
282
    def remove(self):
296
283
        """Derived from the Avahi example code"""
297
284
        if self.entry_group_state_changed_match is not None:
299
286
            self.entry_group_state_changed_match = None
300
287
        if self.group is not None:
301
288
            self.group.Reset()
302
 
    
303
289
    def add(self):
304
290
        """Derived from the Avahi example code"""
305
291
        self.remove()
322
308
            dbus.UInt16(self.port),
323
309
            avahi.string_array_to_txt_array(self.TXT))
324
310
        self.group.Commit()
325
 
    
326
311
    def entry_group_state_changed(self, state, error):
327
312
        """Derived from the Avahi example code"""
328
313
        logger.debug("Avahi entry group state change: %i", state)
335
320
        elif state == avahi.ENTRY_GROUP_FAILURE:
336
321
            logger.critical("Avahi: Error in group state changed %s",
337
322
                            unicode(error))
338
 
            raise AvahiGroupError("State changed: {!s}"
339
 
                                  .format(error))
340
 
    
 
323
            raise AvahiGroupError("State changed: %s"
 
324
                                  % unicode(error))
341
325
    def cleanup(self):
342
326
        """Derived from the Avahi example code"""
343
327
        if self.group is not None:
348
332
                pass
349
333
            self.group = None
350
334
        self.remove()
351
 
    
352
335
    def server_state_changed(self, state, error=None):
353
336
        """Derived from the Avahi example code"""
354
337
        logger.debug("Avahi server state change: %i", state)
373
356
                logger.debug("Unknown state: %r", state)
374
357
            else:
375
358
                logger.debug("Unknown state: %r: %r", state, error)
376
 
    
377
359
    def activate(self):
378
360
        """Derived from the Avahi example code"""
379
361
        if self.server is None:
386
368
                                 self.server_state_changed)
387
369
        self.server_state_changed(self.server.GetState())
388
370
 
389
 
 
390
371
class AvahiServiceToSyslog(AvahiService):
391
372
    def rename(self):
392
373
        """Add the new name to the syslog messages"""
393
374
        ret = AvahiService.rename(self)
394
375
        syslogger.setFormatter(logging.Formatter
395
 
                               ('Mandos ({}) [%(process)d]:'
396
 
                                ' %(levelname)s: %(message)s'
397
 
                                .format(self.name)))
 
376
                               ('Mandos (%s) [%%(process)d]:'
 
377
                                ' %%(levelname)s: %%(message)s'
 
378
                                % self.name))
398
379
        return ret
399
380
 
400
 
 
 
381
def timedelta_to_milliseconds(td):
 
382
    "Convert a datetime.timedelta() to milliseconds"
 
383
    return ((td.days * 24 * 60 * 60 * 1000)
 
384
            + (td.seconds * 1000)
 
385
            + (td.microseconds // 1000))
 
386
        
401
387
class Client(object):
402
388
    """A representation of a client host served by this server.
403
389
    
428
414
    last_checked_ok: datetime.datetime(); (UTC) or None
429
415
    last_checker_status: integer between 0 and 255 reflecting exit
430
416
                         status of last checker. -1 reflects crashed
431
 
                         checker, -2 means no checker completed yet.
 
417
                         checker, or None.
432
418
    last_enabled: datetime.datetime(); (UTC) or None
433
419
    name:       string; from the config file, used in log messages and
434
420
                        D-Bus identifiers
435
421
    secret:     bytestring; sent verbatim (over TLS) to client
436
422
    timeout:    datetime.timedelta(); How long from last_checked_ok
437
423
                                      until this client is disabled
438
 
    extended_timeout:   extra long timeout when secret has been sent
 
424
    extended_timeout:   extra long timeout when password has been sent
439
425
    runtime_expansions: Allowed attributes for runtime expansion.
440
426
    expires:    datetime.datetime(); time (UTC) when a client will be
441
427
                disabled, or None
442
 
    server_settings: The server_settings dict from main()
443
428
    """
444
429
    
445
430
    runtime_expansions = ("approval_delay", "approval_duration",
446
 
                          "created", "enabled", "expires",
447
 
                          "fingerprint", "host", "interval",
448
 
                          "last_approval_request", "last_checked_ok",
 
431
                          "created", "enabled", "fingerprint",
 
432
                          "host", "interval", "last_checked_ok",
449
433
                          "last_enabled", "name", "timeout")
450
 
    client_defaults = { "timeout": "PT5M",
451
 
                        "extended_timeout": "PT15M",
452
 
                        "interval": "PT2M",
 
434
    client_defaults = { "timeout": "5m",
 
435
                        "extended_timeout": "15m",
 
436
                        "interval": "2m",
453
437
                        "checker": "fping -q -- %%(host)s",
454
438
                        "host": "",
455
 
                        "approval_delay": "PT0S",
456
 
                        "approval_duration": "PT1S",
 
439
                        "approval_delay": "0s",
 
440
                        "approval_duration": "1s",
457
441
                        "approved_by_default": "True",
458
442
                        "enabled": "True",
459
443
                        }
460
444
    
 
445
    def timeout_milliseconds(self):
 
446
        "Return the 'timeout' attribute in milliseconds"
 
447
        return timedelta_to_milliseconds(self.timeout)
 
448
    
 
449
    def extended_timeout_milliseconds(self):
 
450
        "Return the 'extended_timeout' attribute in milliseconds"
 
451
        return timedelta_to_milliseconds(self.extended_timeout)
 
452
    
 
453
    def interval_milliseconds(self):
 
454
        "Return the 'interval' attribute in milliseconds"
 
455
        return timedelta_to_milliseconds(self.interval)
 
456
    
 
457
    def approval_delay_milliseconds(self):
 
458
        return timedelta_to_milliseconds(self.approval_delay)
 
459
 
461
460
    @staticmethod
462
461
    def config_parser(config):
463
 
        """Construct a new dict of client settings of this form:
 
462
        """ Construct a new dict of client settings of this form:
464
463
        { client_name: {setting_name: value, ...}, ...}
465
 
        with exceptions for any special settings as defined above.
466
 
        NOTE: Must be a pure function. Must return the same result
467
 
        value given the same arguments.
468
 
        """
 
464
        with exceptions for any special settings as defined above"""
469
465
        settings = {}
470
466
        for client_name in config.sections():
471
467
            section = dict(config.items(client_name))
475
471
            # Reformat values from string types to Python types
476
472
            client["approved_by_default"] = config.getboolean(
477
473
                client_name, "approved_by_default")
478
 
            client["enabled"] = config.getboolean(client_name,
479
 
                                                  "enabled")
 
474
            client["enabled"] = config.getboolean(client_name, "enabled")
480
475
            
481
476
            client["fingerprint"] = (section["fingerprint"].upper()
482
477
                                     .replace(" ", ""))
488
483
                          "rb") as secfile:
489
484
                    client["secret"] = secfile.read()
490
485
            else:
491
 
                raise TypeError("No secret or secfile for section {}"
492
 
                                .format(section))
 
486
                raise TypeError("No secret or secfile for section %s"
 
487
                                % section)
493
488
            client["timeout"] = string_to_delta(section["timeout"])
494
489
            client["extended_timeout"] = string_to_delta(
495
490
                section["extended_timeout"])
501
496
            client["checker_command"] = section["checker"]
502
497
            client["last_approval_request"] = None
503
498
            client["last_checked_ok"] = None
504
 
            client["last_checker_status"] = -2
505
 
        
 
499
            client["last_checker_status"] = None
 
500
            if client["enabled"]:
 
501
                client["last_enabled"] = datetime.datetime.utcnow()
 
502
                client["expires"] = (datetime.datetime.utcnow()
 
503
                                     + client["timeout"])
 
504
            else:
 
505
                client["last_enabled"] = None
 
506
                client["expires"] = None
 
507
 
506
508
        return settings
507
 
    
508
 
    def __init__(self, settings, name = None, server_settings=None):
 
509
        
 
510
        
 
511
    def __init__(self, settings, name = None):
 
512
        """Note: the 'checker' key in 'config' sets the
 
513
        'checker_command' attribute and *not* the 'checker'
 
514
        attribute."""
509
515
        self.name = name
510
 
        if server_settings is None:
511
 
            server_settings = {}
512
 
        self.server_settings = server_settings
513
516
        # adding all client settings
514
 
        for setting, value in settings.items():
 
517
        for setting, value in settings.iteritems():
515
518
            setattr(self, setting, value)
516
519
        
517
 
        if self.enabled:
518
 
            if not hasattr(self, "last_enabled"):
519
 
                self.last_enabled = datetime.datetime.utcnow()
520
 
            if not hasattr(self, "expires"):
521
 
                self.expires = (datetime.datetime.utcnow()
522
 
                                + self.timeout)
523
 
        else:
524
 
            self.last_enabled = None
525
 
            self.expires = None
526
 
        
527
520
        logger.debug("Creating client %r", self.name)
528
521
        # Uppercase and remove spaces from fingerprint for later
529
522
        # comparison purposes with return value from the fingerprint()
530
523
        # function
531
524
        logger.debug("  Fingerprint: %s", self.fingerprint)
532
 
        self.created = settings.get("created",
533
 
                                    datetime.datetime.utcnow())
534
 
        
 
525
        self.created = settings.get("created", datetime.datetime.utcnow())
 
526
 
535
527
        # attributes specific for this server instance
536
528
        self.checker = None
537
529
        self.checker_initiator_tag = None
565
557
        if getattr(self, "enabled", False):
566
558
            # Already enabled
567
559
            return
 
560
        self.send_changedstate()
568
561
        self.expires = datetime.datetime.utcnow() + self.timeout
569
562
        self.enabled = True
570
563
        self.last_enabled = datetime.datetime.utcnow()
571
564
        self.init_checker()
572
 
        self.send_changedstate()
573
565
    
574
566
    def disable(self, quiet=True):
575
567
        """Disable this client."""
576
568
        if not getattr(self, "enabled", False):
577
569
            return False
578
570
        if not quiet:
 
571
            self.send_changedstate()
 
572
        if not quiet:
579
573
            logger.info("Disabling client %s", self.name)
580
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
574
        if getattr(self, "disable_initiator_tag", False):
581
575
            gobject.source_remove(self.disable_initiator_tag)
582
576
            self.disable_initiator_tag = None
583
577
        self.expires = None
584
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
578
        if getattr(self, "checker_initiator_tag", False):
585
579
            gobject.source_remove(self.checker_initiator_tag)
586
580
            self.checker_initiator_tag = None
587
581
        self.stop_checker()
588
582
        self.enabled = False
589
 
        if not quiet:
590
 
            self.send_changedstate()
591
583
        # Do not run this again if called by a gobject.timeout_add
592
584
        return False
593
585
    
597
589
    def init_checker(self):
598
590
        # Schedule a new checker to be started an 'interval' from now,
599
591
        # and every interval from then on.
600
 
        if self.checker_initiator_tag is not None:
601
 
            gobject.source_remove(self.checker_initiator_tag)
602
592
        self.checker_initiator_tag = (gobject.timeout_add
603
 
                                      (int(self.interval
604
 
                                           .total_seconds() * 1000),
 
593
                                      (self.interval_milliseconds(),
605
594
                                       self.start_checker))
606
595
        # Schedule a disable() when 'timeout' has passed
607
 
        if self.disable_initiator_tag is not None:
608
 
            gobject.source_remove(self.disable_initiator_tag)
609
596
        self.disable_initiator_tag = (gobject.timeout_add
610
 
                                      (int(self.timeout
611
 
                                           .total_seconds() * 1000),
612
 
                                       self.disable))
 
597
                                   (self.timeout_milliseconds(),
 
598
                                    self.disable))
613
599
        # Also start a new checker *right now*.
614
600
        self.start_checker()
615
601
    
631
617
            logger.warning("Checker for %(name)s crashed?",
632
618
                           vars(self))
633
619
    
634
 
    def checked_ok(self):
635
 
        """Assert that the client has been seen, alive and well."""
636
 
        self.last_checked_ok = datetime.datetime.utcnow()
637
 
        self.last_checker_status = 0
638
 
        self.bump_timeout()
639
 
    
640
 
    def bump_timeout(self, timeout=None):
641
 
        """Bump up the timeout for this client."""
 
620
    def checked_ok(self, timeout=None):
 
621
        """Bump up the timeout for this client.
 
622
        
 
623
        This should only be called when the client has been seen,
 
624
        alive and well.
 
625
        """
642
626
        if timeout is None:
643
627
            timeout = self.timeout
 
628
        self.last_checked_ok = datetime.datetime.utcnow()
644
629
        if self.disable_initiator_tag is not None:
645
630
            gobject.source_remove(self.disable_initiator_tag)
646
 
            self.disable_initiator_tag = None
647
631
        if getattr(self, "enabled", False):
648
632
            self.disable_initiator_tag = (gobject.timeout_add
649
 
                                          (int(timeout.total_seconds()
650
 
                                               * 1000), self.disable))
 
633
                                          (timedelta_to_milliseconds
 
634
                                           (timeout), self.disable))
651
635
            self.expires = datetime.datetime.utcnow() + timeout
652
636
    
653
637
    def need_approval(self):
659
643
        If a checker already exists, leave it running and do
660
644
        nothing."""
661
645
        # The reason for not killing a running checker is that if we
662
 
        # did that, and if a checker (for some reason) started running
663
 
        # slowly and taking more than 'interval' time, then the client
664
 
        # would inevitably timeout, since no checker would get a
665
 
        # chance to run to completion.  If we instead leave running
 
646
        # did that, then if a checker (for some reason) started
 
647
        # running slowly and taking more than 'interval' time, the
 
648
        # client would inevitably timeout, since no checker would get
 
649
        # a chance to run to completion.  If we instead leave running
666
650
        # checkers alone, the checker would have to take more time
667
651
        # than 'timeout' for the client to be disabled, which is as it
668
652
        # should be.
670
654
        # If a checker exists, make sure it is not a zombie
671
655
        try:
672
656
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
673
 
        except AttributeError:
674
 
            pass
675
 
        except OSError as error:
676
 
            if error.errno != errno.ECHILD:
677
 
                raise
 
657
        except (AttributeError, OSError) as error:
 
658
            if (isinstance(error, OSError)
 
659
                and error.errno != errno.ECHILD):
 
660
                raise error
678
661
        else:
679
662
            if pid:
680
663
                logger.warning("Checker was a zombie")
683
666
                                      self.current_checker_command)
684
667
        # Start a new checker if needed
685
668
        if self.checker is None:
686
 
            # Escape attributes for the shell
687
 
            escaped_attrs = { attr:
688
 
                                  re.escape(unicode(getattr(self,
689
 
                                                            attr)))
690
 
                              for attr in self.runtime_expansions }
691
669
            try:
692
 
                command = self.checker_command % escaped_attrs
693
 
            except TypeError as error:
694
 
                logger.error('Could not format string "%s"',
695
 
                             self.checker_command, exc_info=error)
696
 
                return True # Try again later
 
670
                # In case checker_command has exactly one % operator
 
671
                command = self.checker_command % self.host
 
672
            except TypeError:
 
673
                # Escape attributes for the shell
 
674
                escaped_attrs = dict(
 
675
                    (attr,
 
676
                     re.escape(unicode(str(getattr(self, attr, "")),
 
677
                                       errors=
 
678
                                       'replace')))
 
679
                    for attr in
 
680
                    self.runtime_expansions)
 
681
                
 
682
                try:
 
683
                    command = self.checker_command % escaped_attrs
 
684
                except TypeError as error:
 
685
                    logger.error('Could not format string "%s":'
 
686
                                 ' %s', self.checker_command, error)
 
687
                    return True # Try again later
697
688
            self.current_checker_command = command
698
689
            try:
699
690
                logger.info("Starting checker %r for %s",
702
693
                # in normal mode, that is already done by daemon(),
703
694
                # and in debug mode we don't want to.  (Stdin is
704
695
                # always replaced by /dev/null.)
705
 
                # The exception is when not debugging but nevertheless
706
 
                # running in the foreground; use the previously
707
 
                # created wnull.
708
 
                popen_args = {}
709
 
                if (not self.server_settings["debug"]
710
 
                    and self.server_settings["foreground"]):
711
 
                    popen_args.update({"stdout": wnull,
712
 
                                       "stderr": wnull })
713
696
                self.checker = subprocess.Popen(command,
714
697
                                                close_fds=True,
715
 
                                                shell=True, cwd="/",
716
 
                                                **popen_args)
717
 
            except OSError as error:
718
 
                logger.error("Failed to start subprocess",
719
 
                             exc_info=error)
720
 
                return True
721
 
            self.checker_callback_tag = (gobject.child_watch_add
722
 
                                         (self.checker.pid,
723
 
                                          self.checker_callback,
724
 
                                          data=command))
725
 
            # The checker may have completed before the gobject
726
 
            # watch was added.  Check for this.
727
 
            try:
 
698
                                                shell=True, cwd="/")
 
699
                self.checker_callback_tag = (gobject.child_watch_add
 
700
                                             (self.checker.pid,
 
701
                                              self.checker_callback,
 
702
                                              data=command))
 
703
                # The checker may have completed before the gobject
 
704
                # watch was added.  Check for this.
728
705
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
706
                if pid:
 
707
                    gobject.source_remove(self.checker_callback_tag)
 
708
                    self.checker_callback(pid, status, command)
729
709
            except OSError as error:
730
 
                if error.errno == errno.ECHILD:
731
 
                    # This should never happen
732
 
                    logger.error("Child process vanished",
733
 
                                 exc_info=error)
734
 
                    return True
735
 
                raise
736
 
            if pid:
737
 
                gobject.source_remove(self.checker_callback_tag)
738
 
                self.checker_callback(pid, status, command)
 
710
                logger.error("Failed to start subprocess: %s",
 
711
                             error)
739
712
        # Re-run this periodically if run by gobject.timeout_add
740
713
        return True
741
714
    
748
721
            return
749
722
        logger.debug("Stopping checker for %(name)s", vars(self))
750
723
        try:
751
 
            self.checker.terminate()
 
724
            os.kill(self.checker.pid, signal.SIGTERM)
752
725
            #time.sleep(0.5)
753
726
            #if self.checker.poll() is None:
754
 
            #    self.checker.kill()
 
727
            #    os.kill(self.checker.pid, signal.SIGKILL)
755
728
        except OSError as error:
756
729
            if error.errno != errno.ESRCH: # No such process
757
730
                raise
774
747
    # "Set" method, so we fail early here:
775
748
    if byte_arrays and signature != "ay":
776
749
        raise ValueError("Byte arrays not supported for non-'ay'"
777
 
                         " signature {!r}".format(signature))
 
750
                         " signature %r" % signature)
778
751
    def decorator(func):
779
752
        func._dbus_is_property = True
780
753
        func._dbus_interface = dbus_interface
788
761
    return decorator
789
762
 
790
763
 
791
 
def dbus_interface_annotations(dbus_interface):
792
 
    """Decorator for marking functions returning interface annotations
793
 
    
794
 
    Usage:
795
 
    
796
 
    @dbus_interface_annotations("org.example.Interface")
797
 
    def _foo(self):  # Function name does not matter
798
 
        return {"org.freedesktop.DBus.Deprecated": "true",
799
 
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
800
 
                    "false"}
801
 
    """
802
 
    def decorator(func):
803
 
        func._dbus_is_interface = True
804
 
        func._dbus_interface = dbus_interface
805
 
        func._dbus_name = dbus_interface
806
 
        return func
807
 
    return decorator
808
 
 
809
 
 
810
 
def dbus_annotations(annotations):
811
 
    """Decorator to annotate D-Bus methods, signals or properties
812
 
    Usage:
813
 
    
814
 
    @dbus_service_property("org.example.Interface", signature="b",
815
 
                           access="r")
816
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
817
 
                        "org.freedesktop.DBus.Property."
818
 
                        "EmitsChangedSignal": "false"})
819
 
    def Property_dbus_property(self):
820
 
        return dbus.Boolean(False)
821
 
    """
822
 
    def decorator(func):
823
 
        func._dbus_annotations = annotations
824
 
        return func
825
 
    return decorator
826
 
 
827
 
 
828
764
class DBusPropertyException(dbus.exceptions.DBusException):
829
765
    """A base class for D-Bus property-related exceptions
830
766
    """
831
 
    pass
 
767
    def __unicode__(self):
 
768
        return unicode(str(self))
 
769
 
832
770
 
833
771
class DBusPropertyAccessException(DBusPropertyException):
834
772
    """A property's access permissions disallows an operation.
851
789
    """
852
790
    
853
791
    @staticmethod
854
 
    def _is_dbus_thing(thing):
855
 
        """Returns a function testing if an attribute is a D-Bus thing
856
 
        
857
 
        If called like _is_dbus_thing("method") it returns a function
858
 
        suitable for use as predicate to inspect.getmembers().
859
 
        """
860
 
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
861
 
                                   False)
 
792
    def _is_dbus_property(obj):
 
793
        return getattr(obj, "_dbus_is_property", False)
862
794
    
863
 
    def _get_all_dbus_things(self, thing):
 
795
    def _get_all_dbus_properties(self):
864
796
        """Returns a generator of (name, attribute) pairs
865
797
        """
866
 
        return ((getattr(athing.__get__(self), "_dbus_name",
867
 
                         name),
868
 
                 athing.__get__(self))
 
798
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
869
799
                for cls in self.__class__.__mro__
870
 
                for name, athing in
871
 
                inspect.getmembers(cls,
872
 
                                   self._is_dbus_thing(thing)))
 
800
                for name, prop in
 
801
                inspect.getmembers(cls, self._is_dbus_property))
873
802
    
874
803
    def _get_dbus_property(self, interface_name, property_name):
875
804
        """Returns a bound method if one exists which is a D-Bus
877
806
        """
878
807
        for cls in  self.__class__.__mro__:
879
808
            for name, value in (inspect.getmembers
880
 
                                (cls,
881
 
                                 self._is_dbus_thing("property"))):
 
809
                                (cls, self._is_dbus_property)):
882
810
                if (value._dbus_name == property_name
883
811
                    and value._dbus_interface == interface_name):
884
812
                    return value.__get__(self)
912
840
            # The byte_arrays option is not supported yet on
913
841
            # signatures other than "ay".
914
842
            if prop._dbus_signature != "ay":
915
 
                raise ValueError("Byte arrays not supported for non-"
916
 
                                 "'ay' signature {!r}"
917
 
                                 .format(prop._dbus_signature))
918
 
            value = dbus.ByteArray(b''.join(chr(byte)
919
 
                                            for byte in value))
 
843
                raise ValueError
 
844
            value = dbus.ByteArray(''.join(unichr(byte)
 
845
                                           for byte in value))
920
846
        prop(value)
921
847
    
922
848
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
928
854
        Note: Will not include properties with access="write".
929
855
        """
930
856
        properties = {}
931
 
        for name, prop in self._get_all_dbus_things("property"):
 
857
        for name, prop in self._get_all_dbus_properties():
932
858
            if (interface_name
933
859
                and interface_name != prop._dbus_interface):
934
860
                # Interface non-empty but did not match
949
875
                         path_keyword='object_path',
950
876
                         connection_keyword='connection')
951
877
    def Introspect(self, object_path, connection):
952
 
        """Overloading of standard D-Bus method.
953
 
        
954
 
        Inserts property tags and interface annotation tags.
 
878
        """Standard D-Bus method, overloaded to insert property tags.
955
879
        """
956
880
        xmlstring = dbus.service.Object.Introspect(self, object_path,
957
881
                                                   connection)
964
888
                e.setAttribute("access", prop._dbus_access)
965
889
                return e
966
890
            for if_tag in document.getElementsByTagName("interface"):
967
 
                # Add property tags
968
891
                for tag in (make_tag(document, name, prop)
969
892
                            for name, prop
970
 
                            in self._get_all_dbus_things("property")
 
893
                            in self._get_all_dbus_properties()
971
894
                            if prop._dbus_interface
972
895
                            == if_tag.getAttribute("name")):
973
896
                    if_tag.appendChild(tag)
974
 
                # Add annotation tags
975
 
                for typ in ("method", "signal", "property"):
976
 
                    for tag in if_tag.getElementsByTagName(typ):
977
 
                        annots = dict()
978
 
                        for name, prop in (self.
979
 
                                           _get_all_dbus_things(typ)):
980
 
                            if (name == tag.getAttribute("name")
981
 
                                and prop._dbus_interface
982
 
                                == if_tag.getAttribute("name")):
983
 
                                annots.update(getattr
984
 
                                              (prop,
985
 
                                               "_dbus_annotations",
986
 
                                               {}))
987
 
                        for name, value in annots.items():
988
 
                            ann_tag = document.createElement(
989
 
                                "annotation")
990
 
                            ann_tag.setAttribute("name", name)
991
 
                            ann_tag.setAttribute("value", value)
992
 
                            tag.appendChild(ann_tag)
993
 
                # Add interface annotation tags
994
 
                for annotation, value in dict(
995
 
                    itertools.chain.from_iterable(
996
 
                        annotations().items()
997
 
                        for name, annotations in
998
 
                        self._get_all_dbus_things("interface")
999
 
                        if name == if_tag.getAttribute("name")
1000
 
                        )).items():
1001
 
                    ann_tag = document.createElement("annotation")
1002
 
                    ann_tag.setAttribute("name", annotation)
1003
 
                    ann_tag.setAttribute("value", value)
1004
 
                    if_tag.appendChild(ann_tag)
1005
897
                # Add the names to the return values for the
1006
898
                # "org.freedesktop.DBus.Properties" methods
1007
899
                if (if_tag.getAttribute("name")
1022
914
        except (AttributeError, xml.dom.DOMException,
1023
915
                xml.parsers.expat.ExpatError) as error:
1024
916
            logger.error("Failed to override Introspection method",
1025
 
                         exc_info=error)
 
917
                         error)
1026
918
        return xmlstring
1027
919
 
1028
920
 
1029
 
def datetime_to_dbus(dt, variant_level=0):
 
921
def datetime_to_dbus (dt, variant_level=0):
1030
922
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1031
923
    if dt is None:
1032
924
        return dbus.String("", variant_level = variant_level)
1034
926
                       variant_level=variant_level)
1035
927
 
1036
928
 
1037
 
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1038
 
    """A class decorator; applied to a subclass of
1039
 
    dbus.service.Object, it will add alternate D-Bus attributes with
1040
 
    interface names according to the "alt_interface_names" mapping.
1041
 
    Usage:
1042
 
    
1043
 
    @alternate_dbus_interfaces({"org.example.Interface":
1044
 
                                    "net.example.AlternateInterface"})
1045
 
    class SampleDBusObject(dbus.service.Object):
1046
 
        @dbus.service.method("org.example.Interface")
1047
 
        def SampleDBusMethod():
1048
 
            pass
1049
 
    
1050
 
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1051
 
    reachable via two interfaces: "org.example.Interface" and
1052
 
    "net.example.AlternateInterface", the latter of which will have
1053
 
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1054
 
    "true", unless "deprecate" is passed with a False value.
1055
 
    
1056
 
    This works for methods and signals, and also for D-Bus properties
1057
 
    (from DBusObjectWithProperties) and interfaces (from the
1058
 
    dbus_interface_annotations decorator).
 
929
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
930
                                  .__metaclass__):
 
931
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
932
    will add additional D-Bus attributes matching a certain pattern.
1059
933
    """
1060
 
    def wrapper(cls):
1061
 
        for orig_interface_name, alt_interface_name in (
1062
 
            alt_interface_names.items()):
1063
 
            attr = {}
1064
 
            interface_names = set()
1065
 
            # Go though all attributes of the class
1066
 
            for attrname, attribute in inspect.getmembers(cls):
 
934
    def __new__(mcs, name, bases, attr):
 
935
        # Go through all the base classes which could have D-Bus
 
936
        # methods, signals, or properties in them
 
937
        for base in (b for b in bases
 
938
                     if issubclass(b, dbus.service.Object)):
 
939
            # Go though all attributes of the base class
 
940
            for attrname, attribute in inspect.getmembers(base):
1067
941
                # Ignore non-D-Bus attributes, and D-Bus attributes
1068
942
                # with the wrong interface name
1069
943
                if (not hasattr(attribute, "_dbus_interface")
1070
944
                    or not attribute._dbus_interface
1071
 
                    .startswith(orig_interface_name)):
 
945
                    .startswith("se.recompile.Mandos")):
1072
946
                    continue
1073
947
                # Create an alternate D-Bus interface name based on
1074
948
                # the current name
1075
949
                alt_interface = (attribute._dbus_interface
1076
 
                                 .replace(orig_interface_name,
1077
 
                                          alt_interface_name))
1078
 
                interface_names.add(alt_interface)
 
950
                                 .replace("se.recompile.Mandos",
 
951
                                          "se.bsnet.fukt.Mandos"))
1079
952
                # Is this a D-Bus signal?
1080
953
                if getattr(attribute, "_dbus_is_signal", False):
1081
 
                    # Extract the original non-method undecorated
1082
 
                    # function by black magic
 
954
                    # Extract the original non-method function by
 
955
                    # black magic
1083
956
                    nonmethod_func = (dict(
1084
957
                            zip(attribute.func_code.co_freevars,
1085
958
                                attribute.__closure__))["func"]
1096
969
                                nonmethod_func.func_name,
1097
970
                                nonmethod_func.func_defaults,
1098
971
                                nonmethod_func.func_closure)))
1099
 
                    # Copy annotations, if any
1100
 
                    try:
1101
 
                        new_function._dbus_annotations = (
1102
 
                            dict(attribute._dbus_annotations))
1103
 
                    except AttributeError:
1104
 
                        pass
1105
972
                    # Define a creator of a function to call both the
1106
 
                    # original and alternate functions, so both the
1107
 
                    # original and alternate signals gets sent when
1108
 
                    # the function is called
 
973
                    # old and new functions, so both the old and new
 
974
                    # signals gets sent when the function is called
1109
975
                    def fixscope(func1, func2):
1110
976
                        """This function is a scope container to pass
1111
977
                        func1 and func2 to the "call_both" function
1118
984
                        return call_both
1119
985
                    # Create the "call_both" function and add it to
1120
986
                    # the class
1121
 
                    attr[attrname] = fixscope(attribute, new_function)
 
987
                    attr[attrname] = fixscope(attribute,
 
988
                                              new_function)
1122
989
                # Is this a D-Bus method?
1123
990
                elif getattr(attribute, "_dbus_is_method", False):
1124
991
                    # Create a new, but exactly alike, function
1135
1002
                                        attribute.func_name,
1136
1003
                                        attribute.func_defaults,
1137
1004
                                        attribute.func_closure)))
1138
 
                    # Copy annotations, if any
1139
 
                    try:
1140
 
                        attr[attrname]._dbus_annotations = (
1141
 
                            dict(attribute._dbus_annotations))
1142
 
                    except AttributeError:
1143
 
                        pass
1144
1005
                # Is this a D-Bus property?
1145
1006
                elif getattr(attribute, "_dbus_is_property", False):
1146
1007
                    # Create a new, but exactly alike, function
1160
1021
                                        attribute.func_name,
1161
1022
                                        attribute.func_defaults,
1162
1023
                                        attribute.func_closure)))
1163
 
                    # Copy annotations, if any
1164
 
                    try:
1165
 
                        attr[attrname]._dbus_annotations = (
1166
 
                            dict(attribute._dbus_annotations))
1167
 
                    except AttributeError:
1168
 
                        pass
1169
 
                # Is this a D-Bus interface?
1170
 
                elif getattr(attribute, "_dbus_is_interface", False):
1171
 
                    # Create a new, but exactly alike, function
1172
 
                    # object.  Decorate it to be a new D-Bus interface
1173
 
                    # with the alternate D-Bus interface name.  Add it
1174
 
                    # to the class.
1175
 
                    attr[attrname] = (dbus_interface_annotations
1176
 
                                      (alt_interface)
1177
 
                                      (types.FunctionType
1178
 
                                       (attribute.func_code,
1179
 
                                        attribute.func_globals,
1180
 
                                        attribute.func_name,
1181
 
                                        attribute.func_defaults,
1182
 
                                        attribute.func_closure)))
1183
 
            if deprecate:
1184
 
                # Deprecate all alternate interfaces
1185
 
                iname="_AlternateDBusNames_interface_annotation{}"
1186
 
                for interface_name in interface_names:
1187
 
                    @dbus_interface_annotations(interface_name)
1188
 
                    def func(self):
1189
 
                        return { "org.freedesktop.DBus.Deprecated":
1190
 
                                     "true" }
1191
 
                    # Find an unused name
1192
 
                    for aname in (iname.format(i)
1193
 
                                  for i in itertools.count()):
1194
 
                        if aname not in attr:
1195
 
                            attr[aname] = func
1196
 
                            break
1197
 
            if interface_names:
1198
 
                # Replace the class with a new subclass of it with
1199
 
                # methods, signals, etc. as created above.
1200
 
                cls = type(b"{}Alternate".format(cls.__name__),
1201
 
                           (cls,), attr)
1202
 
        return cls
1203
 
    return wrapper
1204
 
 
1205
 
 
1206
 
@alternate_dbus_interfaces({"se.recompile.Mandos":
1207
 
                                "se.bsnet.fukt.Mandos"})
 
1024
        return type.__new__(mcs, name, bases, attr)
 
1025
 
 
1026
 
1208
1027
class ClientDBus(Client, DBusObjectWithProperties):
1209
1028
    """A Client class using D-Bus
1210
1029
    
1221
1040
    def __init__(self, bus = None, *args, **kwargs):
1222
1041
        self.bus = bus
1223
1042
        Client.__init__(self, *args, **kwargs)
 
1043
        self._approvals_pending = 0
 
1044
        
 
1045
        self._approvals_pending = 0
1224
1046
        # Only now, when this client is initialized, can it show up on
1225
1047
        # the D-Bus
1226
1048
        client_object_name = unicode(self.name).translate(
1230
1052
                                 ("/clients/" + client_object_name))
1231
1053
        DBusObjectWithProperties.__init__(self, self.bus,
1232
1054
                                          self.dbus_object_path)
1233
 
    
 
1055
        
1234
1056
    def notifychangeproperty(transform_func,
1235
1057
                             dbus_name, type_func=lambda x: x,
1236
1058
                             variant_level=1):
1244
1066
                   to the D-Bus.  Default: no transform
1245
1067
        variant_level: D-Bus variant level.  Default: 1
1246
1068
        """
1247
 
        attrname = "_{}".format(dbus_name)
 
1069
        attrname = "_{0}".format(dbus_name)
1248
1070
        def setter(self, value):
1249
1071
            if hasattr(self, "dbus_object_path"):
1250
1072
                if (not hasattr(self, attrname) or
1259
1081
        
1260
1082
        return property(lambda self: getattr(self, attrname), setter)
1261
1083
    
 
1084
    
1262
1085
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1263
1086
    approvals_pending = notifychangeproperty(dbus.Boolean,
1264
1087
                                             "ApprovalPending",
1271
1094
                                       checker is not None)
1272
1095
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1273
1096
                                           "LastCheckedOK")
1274
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1275
 
                                               "LastCheckerStatus")
1276
1097
    last_approval_request = notifychangeproperty(
1277
1098
        datetime_to_dbus, "LastApprovalRequest")
1278
1099
    approved_by_default = notifychangeproperty(dbus.Boolean,
1280
1101
    approval_delay = notifychangeproperty(dbus.UInt64,
1281
1102
                                          "ApprovalDelay",
1282
1103
                                          type_func =
1283
 
                                          lambda td: td.total_seconds()
1284
 
                                          * 1000)
 
1104
                                          timedelta_to_milliseconds)
1285
1105
    approval_duration = notifychangeproperty(
1286
1106
        dbus.UInt64, "ApprovalDuration",
1287
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1107
        type_func = timedelta_to_milliseconds)
1288
1108
    host = notifychangeproperty(dbus.String, "Host")
1289
1109
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1290
 
                                   type_func = lambda td:
1291
 
                                       td.total_seconds() * 1000)
 
1110
                                   type_func =
 
1111
                                   timedelta_to_milliseconds)
1292
1112
    extended_timeout = notifychangeproperty(
1293
1113
        dbus.UInt64, "ExtendedTimeout",
1294
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1114
        type_func = timedelta_to_milliseconds)
1295
1115
    interval = notifychangeproperty(dbus.UInt64,
1296
1116
                                    "Interval",
1297
1117
                                    type_func =
1298
 
                                    lambda td: td.total_seconds()
1299
 
                                    * 1000)
 
1118
                                    timedelta_to_milliseconds)
1300
1119
    checker_command = notifychangeproperty(dbus.String, "Checker")
1301
1120
    
1302
1121
    del notifychangeproperty
1330
1149
                                       *args, **kwargs)
1331
1150
    
1332
1151
    def start_checker(self, *args, **kwargs):
1333
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
1152
        old_checker = self.checker
 
1153
        if self.checker is not None:
 
1154
            old_checker_pid = self.checker.pid
 
1155
        else:
 
1156
            old_checker_pid = None
1334
1157
        r = Client.start_checker(self, *args, **kwargs)
1335
1158
        # Only if new checker process was started
1336
1159
        if (self.checker is not None
1344
1167
        return False
1345
1168
    
1346
1169
    def approve(self, value=True):
 
1170
        self.send_changedstate()
1347
1171
        self.approved = value
1348
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1349
 
                                * 1000), self._reset_approved)
1350
 
        self.send_changedstate()
 
1172
        gobject.timeout_add(timedelta_to_milliseconds
 
1173
                            (self.approval_duration),
 
1174
                            self._reset_approved)
 
1175
    
1351
1176
    
1352
1177
    ## D-Bus methods, signals & properties
1353
1178
    _interface = "se.recompile.Mandos.Client"
1354
1179
    
1355
 
    ## Interfaces
1356
 
    
1357
 
    @dbus_interface_annotations(_interface)
1358
 
    def _foo(self):
1359
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1360
 
                     "false"}
1361
 
    
1362
1180
    ## Signals
1363
1181
    
1364
1182
    # CheckerCompleted - signal
1400
1218
        "D-Bus signal"
1401
1219
        return self.need_approval()
1402
1220
    
 
1221
    # NeRwequest - signal
 
1222
    @dbus.service.signal(_interface, signature="s")
 
1223
    def NewRequest(self, ip):
 
1224
        """D-Bus signal
 
1225
        Is sent after a client request a password.
 
1226
        """
 
1227
        pass
 
1228
    
1403
1229
    ## Methods
1404
1230
    
1405
1231
    # Approve - method
1455
1281
                           access="readwrite")
1456
1282
    def ApprovalDelay_dbus_property(self, value=None):
1457
1283
        if value is None:       # get
1458
 
            return dbus.UInt64(self.approval_delay.total_seconds()
1459
 
                               * 1000)
 
1284
            return dbus.UInt64(self.approval_delay_milliseconds())
1460
1285
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1461
1286
    
1462
1287
    # ApprovalDuration - property
1464
1289
                           access="readwrite")
1465
1290
    def ApprovalDuration_dbus_property(self, value=None):
1466
1291
        if value is None:       # get
1467
 
            return dbus.UInt64(self.approval_duration.total_seconds()
1468
 
                               * 1000)
 
1292
            return dbus.UInt64(timedelta_to_milliseconds(
 
1293
                    self.approval_duration))
1469
1294
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1470
1295
    
1471
1296
    # Name - property
1516
1341
            return
1517
1342
        return datetime_to_dbus(self.last_checked_ok)
1518
1343
    
1519
 
    # LastCheckerStatus - property
1520
 
    @dbus_service_property(_interface, signature="n",
1521
 
                           access="read")
1522
 
    def LastCheckerStatus_dbus_property(self):
1523
 
        return dbus.Int16(self.last_checker_status)
1524
 
    
1525
1344
    # Expires - property
1526
1345
    @dbus_service_property(_interface, signature="s", access="read")
1527
1346
    def Expires_dbus_property(self):
1537
1356
                           access="readwrite")
1538
1357
    def Timeout_dbus_property(self, value=None):
1539
1358
        if value is None:       # get
1540
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1541
 
        old_timeout = self.timeout
 
1359
            return dbus.UInt64(self.timeout_milliseconds())
1542
1360
        self.timeout = datetime.timedelta(0, 0, 0, value)
1543
 
        # Reschedule disabling
1544
 
        if self.enabled:
1545
 
            now = datetime.datetime.utcnow()
1546
 
            self.expires += self.timeout - old_timeout
1547
 
            if self.expires <= now:
1548
 
                # The timeout has passed
1549
 
                self.disable()
1550
 
            else:
1551
 
                if (getattr(self, "disable_initiator_tag", None)
1552
 
                    is None):
1553
 
                    return
1554
 
                gobject.source_remove(self.disable_initiator_tag)
1555
 
                self.disable_initiator_tag = (
1556
 
                    gobject.timeout_add(
1557
 
                        int((self.expires - now).total_seconds()
1558
 
                            * 1000), self.disable))
 
1361
        if getattr(self, "disable_initiator_tag", None) is None:
 
1362
            return
 
1363
        # Reschedule timeout
 
1364
        gobject.source_remove(self.disable_initiator_tag)
 
1365
        self.disable_initiator_tag = None
 
1366
        self.expires = None
 
1367
        time_to_die = timedelta_to_milliseconds((self
 
1368
                                                 .last_checked_ok
 
1369
                                                 + self.timeout)
 
1370
                                                - datetime.datetime
 
1371
                                                .utcnow())
 
1372
        if time_to_die <= 0:
 
1373
            # The timeout has passed
 
1374
            self.disable()
 
1375
        else:
 
1376
            self.expires = (datetime.datetime.utcnow()
 
1377
                            + datetime.timedelta(milliseconds =
 
1378
                                                 time_to_die))
 
1379
            self.disable_initiator_tag = (gobject.timeout_add
 
1380
                                          (time_to_die, self.disable))
1559
1381
    
1560
1382
    # ExtendedTimeout - property
1561
1383
    @dbus_service_property(_interface, signature="t",
1562
1384
                           access="readwrite")
1563
1385
    def ExtendedTimeout_dbus_property(self, value=None):
1564
1386
        if value is None:       # get
1565
 
            return dbus.UInt64(self.extended_timeout.total_seconds()
1566
 
                               * 1000)
 
1387
            return dbus.UInt64(self.extended_timeout_milliseconds())
1567
1388
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1568
1389
    
1569
1390
    # Interval - property
1571
1392
                           access="readwrite")
1572
1393
    def Interval_dbus_property(self, value=None):
1573
1394
        if value is None:       # get
1574
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1395
            return dbus.UInt64(self.interval_milliseconds())
1575
1396
        self.interval = datetime.timedelta(0, 0, 0, value)
1576
1397
        if getattr(self, "checker_initiator_tag", None) is None:
1577
1398
            return
1610
1431
    @dbus_service_property(_interface, signature="ay",
1611
1432
                           access="write", byte_arrays=True)
1612
1433
    def Secret_dbus_property(self, value):
1613
 
        self.secret = bytes(value)
 
1434
        self.secret = str(value)
1614
1435
    
1615
1436
    del _interface
1616
1437
 
1641
1462
        self._pipe.send(('setattr', name, value))
1642
1463
 
1643
1464
 
 
1465
class ClientDBusTransitional(ClientDBus):
 
1466
    __metaclass__ = AlternateDBusNamesMetaclass
 
1467
 
 
1468
 
1644
1469
class ClientHandler(socketserver.BaseRequestHandler, object):
1645
1470
    """A class to handle client connections.
1646
1471
    
1682
1507
            logger.debug("Protocol version: %r", line)
1683
1508
            try:
1684
1509
                if int(line.strip().split()[0]) > 1:
1685
 
                    raise RuntimeError(line)
 
1510
                    raise RuntimeError
1686
1511
            except (ValueError, IndexError, RuntimeError) as error:
1687
1512
                logger.error("Unknown protocol version: %s", error)
1688
1513
                return
1714
1539
                except KeyError:
1715
1540
                    return
1716
1541
                
 
1542
                if self.server.use_dbus:
 
1543
                    # Emit D-Bus signal
 
1544
                    client.NewRequest(str(self.client_address))
 
1545
                
1717
1546
                if client.approval_delay:
1718
1547
                    delay = client.approval_delay
1719
1548
                    client.approvals_pending += 1
1737
1566
                        if self.server.use_dbus:
1738
1567
                            # Emit D-Bus signal
1739
1568
                            client.NeedApproval(
1740
 
                                client.approval_delay.total_seconds()
1741
 
                                * 1000, client.approved_by_default)
 
1569
                                client.approval_delay_milliseconds(),
 
1570
                                client.approved_by_default)
1742
1571
                    else:
1743
1572
                        logger.warning("Client %s was not approved",
1744
1573
                                       client.name)
1750
1579
                    #wait until timeout or approved
1751
1580
                    time = datetime.datetime.now()
1752
1581
                    client.changedstate.acquire()
1753
 
                    client.changedstate.wait(delay.total_seconds())
 
1582
                    (client.changedstate.wait
 
1583
                     (float(client.timedelta_to_milliseconds(delay)
 
1584
                            / 1000)))
1754
1585
                    client.changedstate.release()
1755
1586
                    time2 = datetime.datetime.now()
1756
1587
                    if (time2 - time) >= delay:
1772
1603
                    try:
1773
1604
                        sent = session.send(client.secret[sent_size:])
1774
1605
                    except gnutls.errors.GNUTLSError as error:
1775
 
                        logger.warning("gnutls send failed",
1776
 
                                       exc_info=error)
 
1606
                        logger.warning("gnutls send failed")
1777
1607
                        return
1778
1608
                    logger.debug("Sent: %d, remaining: %d",
1779
1609
                                 sent, len(client.secret)
1782
1612
                
1783
1613
                logger.info("Sending secret to %s", client.name)
1784
1614
                # bump the timeout using extended_timeout
1785
 
                client.bump_timeout(client.extended_timeout)
 
1615
                client.checked_ok(client.extended_timeout)
1786
1616
                if self.server.use_dbus:
1787
1617
                    # Emit D-Bus signal
1788
1618
                    client.GotSecret()
1793
1623
                try:
1794
1624
                    session.bye()
1795
1625
                except gnutls.errors.GNUTLSError as error:
1796
 
                    logger.warning("GnuTLS bye failed",
1797
 
                                   exc_info=error)
 
1626
                    logger.warning("GnuTLS bye failed")
1798
1627
    
1799
1628
    @staticmethod
1800
1629
    def peer_certificate(session):
1872
1701
    def process_request(self, request, address):
1873
1702
        """Start a new process to process the request."""
1874
1703
        proc = multiprocessing.Process(target = self.sub_process_main,
1875
 
                                       args = (request, address))
 
1704
                                       args = (request,
 
1705
                                               address))
1876
1706
        proc.start()
1877
1707
        return proc
1878
1708
 
1893
1723
    
1894
1724
    def add_pipe(self, parent_pipe, proc):
1895
1725
        """Dummy function; override as necessary"""
1896
 
        raise NotImplementedError()
 
1726
        raise NotImplementedError
1897
1727
 
1898
1728
 
1899
1729
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1906
1736
        use_ipv6:       Boolean; to use IPv6 or not
1907
1737
    """
1908
1738
    def __init__(self, server_address, RequestHandlerClass,
1909
 
                 interface=None, use_ipv6=True, socketfd=None):
1910
 
        """If socketfd is set, use that file descriptor instead of
1911
 
        creating a new one with socket.socket().
1912
 
        """
 
1739
                 interface=None, use_ipv6=True):
1913
1740
        self.interface = interface
1914
1741
        if use_ipv6:
1915
1742
            self.address_family = socket.AF_INET6
1916
 
        if socketfd is not None:
1917
 
            # Save the file descriptor
1918
 
            self.socketfd = socketfd
1919
 
            # Save the original socket.socket() function
1920
 
            self.socket_socket = socket.socket
1921
 
            # To implement --socket, we monkey patch socket.socket.
1922
 
            # 
1923
 
            # (When socketserver.TCPServer is a new-style class, we
1924
 
            # could make self.socket into a property instead of monkey
1925
 
            # patching socket.socket.)
1926
 
            # 
1927
 
            # Create a one-time-only replacement for socket.socket()
1928
 
            @functools.wraps(socket.socket)
1929
 
            def socket_wrapper(*args, **kwargs):
1930
 
                # Restore original function so subsequent calls are
1931
 
                # not affected.
1932
 
                socket.socket = self.socket_socket
1933
 
                del self.socket_socket
1934
 
                # This time only, return a new socket object from the
1935
 
                # saved file descriptor.
1936
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
1937
 
            # Replace socket.socket() function with wrapper
1938
 
            socket.socket = socket_wrapper
1939
 
        # The socketserver.TCPServer.__init__ will call
1940
 
        # socket.socket(), which might be our replacement,
1941
 
        # socket_wrapper(), if socketfd was set.
1942
1743
        socketserver.TCPServer.__init__(self, server_address,
1943
1744
                                        RequestHandlerClass)
1944
 
    
1945
1745
    def server_bind(self):
1946
1746
        """This overrides the normal server_bind() function
1947
1747
        to bind to an interface if one was specified, and also NOT to
1955
1755
                try:
1956
1756
                    self.socket.setsockopt(socket.SOL_SOCKET,
1957
1757
                                           SO_BINDTODEVICE,
1958
 
                                           (self.interface + "\0")
1959
 
                                           .encode("utf-8"))
 
1758
                                           str(self.interface
 
1759
                                               + '\0'))
1960
1760
                except socket.error as error:
1961
 
                    if error.errno == errno.EPERM:
1962
 
                        logger.error("No permission to bind to"
1963
 
                                     " interface %s", self.interface)
1964
 
                    elif error.errno == errno.ENOPROTOOPT:
 
1761
                    if error[0] == errno.EPERM:
 
1762
                        logger.error("No permission to"
 
1763
                                     " bind to interface %s",
 
1764
                                     self.interface)
 
1765
                    elif error[0] == errno.ENOPROTOOPT:
1965
1766
                        logger.error("SO_BINDTODEVICE not available;"
1966
1767
                                     " cannot bind to interface %s",
1967
1768
                                     self.interface)
1968
 
                    elif error.errno == errno.ENODEV:
1969
 
                        logger.error("Interface %s does not exist,"
1970
 
                                     " cannot bind", self.interface)
1971
1769
                    else:
1972
1770
                        raise
1973
1771
        # Only bind(2) the socket if we really need to.
1976
1774
                if self.address_family == socket.AF_INET6:
1977
1775
                    any_address = "::" # in6addr_any
1978
1776
                else:
1979
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1777
                    any_address = socket.INADDR_ANY
1980
1778
                self.server_address = (any_address,
1981
1779
                                       self.server_address[1])
1982
1780
            elif not self.server_address[1]:
2003
1801
    """
2004
1802
    def __init__(self, server_address, RequestHandlerClass,
2005
1803
                 interface=None, use_ipv6=True, clients=None,
2006
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
1804
                 gnutls_priority=None, use_dbus=True):
2007
1805
        self.enabled = False
2008
1806
        self.clients = clients
2009
1807
        if self.clients is None:
2013
1811
        IPv6_TCPServer.__init__(self, server_address,
2014
1812
                                RequestHandlerClass,
2015
1813
                                interface = interface,
2016
 
                                use_ipv6 = use_ipv6,
2017
 
                                socketfd = socketfd)
 
1814
                                use_ipv6 = use_ipv6)
2018
1815
    def server_activate(self):
2019
1816
        if self.enabled:
2020
1817
            return socketserver.TCPServer.server_activate(self)
2033
1830
    
2034
1831
    def handle_ipc(self, source, condition, parent_pipe=None,
2035
1832
                   proc = None, client_object=None):
 
1833
        condition_names = {
 
1834
            gobject.IO_IN: "IN",   # There is data to read.
 
1835
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1836
                                    # blocking).
 
1837
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1838
            gobject.IO_ERR: "ERR", # Error condition.
 
1839
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1840
                                    # broken, usually for pipes and
 
1841
                                    # sockets).
 
1842
            }
 
1843
        conditions_string = ' | '.join(name
 
1844
                                       for cond, name in
 
1845
                                       condition_names.iteritems()
 
1846
                                       if cond & condition)
2036
1847
        # error, or the other end of multiprocessing.Pipe has closed
2037
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
1848
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2038
1849
            # Wait for other process to exit
2039
1850
            proc.join()
2040
1851
            return False
2098
1909
        return True
2099
1910
 
2100
1911
 
2101
 
def rfc3339_duration_to_delta(duration):
2102
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2103
 
    
2104
 
    >>> rfc3339_duration_to_delta("P7D")
2105
 
    datetime.timedelta(7)
2106
 
    >>> rfc3339_duration_to_delta("PT60S")
2107
 
    datetime.timedelta(0, 60)
2108
 
    >>> rfc3339_duration_to_delta("PT60M")
2109
 
    datetime.timedelta(0, 3600)
2110
 
    >>> rfc3339_duration_to_delta("PT24H")
2111
 
    datetime.timedelta(1)
2112
 
    >>> rfc3339_duration_to_delta("P1W")
2113
 
    datetime.timedelta(7)
2114
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2115
 
    datetime.timedelta(0, 330)
2116
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2117
 
    datetime.timedelta(1, 200)
2118
 
    """
2119
 
    
2120
 
    # Parsing an RFC 3339 duration with regular expressions is not
2121
 
    # possible - there would have to be multiple places for the same
2122
 
    # values, like seconds.  The current code, while more esoteric, is
2123
 
    # cleaner without depending on a parsing library.  If Python had a
2124
 
    # built-in library for parsing we would use it, but we'd like to
2125
 
    # avoid excessive use of external libraries.
2126
 
    
2127
 
    # New type for defining tokens, syntax, and semantics all-in-one
2128
 
    Token = collections.namedtuple("Token",
2129
 
                                   ("regexp", # To match token; if
2130
 
                                              # "value" is not None,
2131
 
                                              # must have a "group"
2132
 
                                              # containing digits
2133
 
                                    "value",  # datetime.timedelta or
2134
 
                                              # None
2135
 
                                    "followers")) # Tokens valid after
2136
 
                                                  # this token
2137
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2138
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2139
 
    token_end = Token(re.compile(r"$"), None, frozenset())
2140
 
    token_second = Token(re.compile(r"(\d+)S"),
2141
 
                         datetime.timedelta(seconds=1),
2142
 
                         frozenset((token_end,)))
2143
 
    token_minute = Token(re.compile(r"(\d+)M"),
2144
 
                         datetime.timedelta(minutes=1),
2145
 
                         frozenset((token_second, token_end)))
2146
 
    token_hour = Token(re.compile(r"(\d+)H"),
2147
 
                       datetime.timedelta(hours=1),
2148
 
                       frozenset((token_minute, token_end)))
2149
 
    token_time = Token(re.compile(r"T"),
2150
 
                       None,
2151
 
                       frozenset((token_hour, token_minute,
2152
 
                                  token_second)))
2153
 
    token_day = Token(re.compile(r"(\d+)D"),
2154
 
                      datetime.timedelta(days=1),
2155
 
                      frozenset((token_time, token_end)))
2156
 
    token_month = Token(re.compile(r"(\d+)M"),
2157
 
                        datetime.timedelta(weeks=4),
2158
 
                        frozenset((token_day, token_end)))
2159
 
    token_year = Token(re.compile(r"(\d+)Y"),
2160
 
                       datetime.timedelta(weeks=52),
2161
 
                       frozenset((token_month, token_end)))
2162
 
    token_week = Token(re.compile(r"(\d+)W"),
2163
 
                       datetime.timedelta(weeks=1),
2164
 
                       frozenset((token_end,)))
2165
 
    token_duration = Token(re.compile(r"P"), None,
2166
 
                           frozenset((token_year, token_month,
2167
 
                                      token_day, token_time,
2168
 
                                      token_week)))
2169
 
    # Define starting values
2170
 
    value = datetime.timedelta() # Value so far
2171
 
    found_token = None
2172
 
    followers = frozenset((token_duration,)) # Following valid tokens
2173
 
    s = duration                # String left to parse
2174
 
    # Loop until end token is found
2175
 
    while found_token is not token_end:
2176
 
        # Search for any currently valid tokens
2177
 
        for token in followers:
2178
 
            match = token.regexp.match(s)
2179
 
            if match is not None:
2180
 
                # Token found
2181
 
                if token.value is not None:
2182
 
                    # Value found, parse digits
2183
 
                    factor = int(match.group(1), 10)
2184
 
                    # Add to value so far
2185
 
                    value += factor * token.value
2186
 
                # Strip token from string
2187
 
                s = token.regexp.sub("", s, 1)
2188
 
                # Go to found token
2189
 
                found_token = token
2190
 
                # Set valid next tokens
2191
 
                followers = found_token.followers
2192
 
                break
2193
 
        else:
2194
 
            # No currently valid tokens were found
2195
 
            raise ValueError("Invalid RFC 3339 duration")
2196
 
    # End token found
2197
 
    return value
2198
 
 
2199
 
 
2200
1912
def string_to_delta(interval):
2201
1913
    """Parse a string and return a datetime.timedelta
2202
1914
    
2213
1925
    >>> string_to_delta('5m 30s')
2214
1926
    datetime.timedelta(0, 330)
2215
1927
    """
2216
 
    
2217
 
    try:
2218
 
        return rfc3339_duration_to_delta(interval)
2219
 
    except ValueError:
2220
 
        pass
2221
 
    
2222
1928
    timevalue = datetime.timedelta(0)
2223
1929
    for s in interval.split():
2224
1930
        try:
2225
 
            suffix = s[-1]
 
1931
            suffix = unicode(s[-1])
2226
1932
            value = int(s[:-1])
2227
1933
            if suffix == "d":
2228
1934
                delta = datetime.timedelta(value)
2235
1941
            elif suffix == "w":
2236
1942
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2237
1943
            else:
2238
 
                raise ValueError("Unknown suffix {!r}"
2239
 
                                 .format(suffix))
2240
 
        except IndexError as e:
 
1944
                raise ValueError("Unknown suffix %r" % suffix)
 
1945
        except (ValueError, IndexError) as e:
2241
1946
            raise ValueError(*(e.args))
2242
1947
        timevalue += delta
2243
1948
    return timevalue
2256
1961
        sys.exit()
2257
1962
    if not noclose:
2258
1963
        # Close all standard open file descriptors
2259
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1964
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2260
1965
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2261
 
            raise OSError(errno.ENODEV, "{} not a character device"
2262
 
                          .format(os.devnull))
 
1966
            raise OSError(errno.ENODEV,
 
1967
                          "%s not a character device"
 
1968
                          % os.path.devnull)
2263
1969
        os.dup2(null, sys.stdin.fileno())
2264
1970
        os.dup2(null, sys.stdout.fileno())
2265
1971
        os.dup2(null, sys.stderr.fileno())
2274
1980
    
2275
1981
    parser = argparse.ArgumentParser()
2276
1982
    parser.add_argument("-v", "--version", action="version",
2277
 
                        version = "%(prog)s {}".format(version),
 
1983
                        version = "%%(prog)s %s" % version,
2278
1984
                        help="show version number and exit")
2279
1985
    parser.add_argument("-i", "--interface", metavar="IF",
2280
1986
                        help="Bind to interface IF")
2286
1992
                        help="Run self-test")
2287
1993
    parser.add_argument("--debug", action="store_true",
2288
1994
                        help="Debug mode; run in foreground and log"
2289
 
                        " to terminal", default=None)
 
1995
                        " to terminal")
2290
1996
    parser.add_argument("--debuglevel", metavar="LEVEL",
2291
1997
                        help="Debug level for stdout output")
2292
1998
    parser.add_argument("--priority", help="GnuTLS"
2299
2005
                        " files")
2300
2006
    parser.add_argument("--no-dbus", action="store_false",
2301
2007
                        dest="use_dbus", help="Do not provide D-Bus"
2302
 
                        " system bus interface", default=None)
 
2008
                        " system bus interface")
2303
2009
    parser.add_argument("--no-ipv6", action="store_false",
2304
 
                        dest="use_ipv6", help="Do not use IPv6",
2305
 
                        default=None)
 
2010
                        dest="use_ipv6", help="Do not use IPv6")
2306
2011
    parser.add_argument("--no-restore", action="store_false",
2307
2012
                        dest="restore", help="Do not restore stored"
2308
 
                        " state", default=None)
2309
 
    parser.add_argument("--socket", type=int,
2310
 
                        help="Specify a file descriptor to a network"
2311
 
                        " socket to use instead of creating one")
 
2013
                        " state")
2312
2014
    parser.add_argument("--statedir", metavar="DIR",
2313
2015
                        help="Directory to save/restore state in")
2314
 
    parser.add_argument("--foreground", action="store_true",
2315
 
                        help="Run in foreground", default=None)
2316
 
    parser.add_argument("--no-zeroconf", action="store_false",
2317
 
                        dest="zeroconf", help="Do not use Zeroconf",
2318
 
                        default=None)
2319
2016
    
2320
2017
    options = parser.parse_args()
2321
2018
    
2322
2019
    if options.check:
2323
2020
        import doctest
2324
 
        fail_count, test_count = doctest.testmod()
2325
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2021
        doctest.testmod()
 
2022
        sys.exit()
2326
2023
    
2327
2024
    # Default values for config file for server-global settings
2328
2025
    server_defaults = { "interface": "",
2330
2027
                        "port": "",
2331
2028
                        "debug": "False",
2332
2029
                        "priority":
2333
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2030
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2334
2031
                        "servicename": "Mandos",
2335
2032
                        "use_dbus": "True",
2336
2033
                        "use_ipv6": "True",
2337
2034
                        "debuglevel": "",
2338
2035
                        "restore": "True",
2339
 
                        "socket": "",
2340
 
                        "statedir": "/var/lib/mandos",
2341
 
                        "foreground": "False",
2342
 
                        "zeroconf": "True",
 
2036
                        "statedir": "/var/lib/mandos"
2343
2037
                        }
2344
2038
    
2345
2039
    # Parse config file for server-global settings
2350
2044
    # Convert the SafeConfigParser object to a dict
2351
2045
    server_settings = server_config.defaults()
2352
2046
    # Use the appropriate methods on the non-string config options
2353
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
2047
    for option in ("debug", "use_dbus", "use_ipv6"):
2354
2048
        server_settings[option] = server_config.getboolean("DEFAULT",
2355
2049
                                                           option)
2356
2050
    if server_settings["port"]:
2357
2051
        server_settings["port"] = server_config.getint("DEFAULT",
2358
2052
                                                       "port")
2359
 
    if server_settings["socket"]:
2360
 
        server_settings["socket"] = server_config.getint("DEFAULT",
2361
 
                                                         "socket")
2362
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
2363
 
        # over with an opened os.devnull.  But we don't want this to
2364
 
        # happen with a supplied network socket.
2365
 
        if 0 <= server_settings["socket"] <= 2:
2366
 
            server_settings["socket"] = os.dup(server_settings
2367
 
                                               ["socket"])
2368
2053
    del server_config
2369
2054
    
2370
2055
    # Override the settings from the config file with command line
2372
2057
    for option in ("interface", "address", "port", "debug",
2373
2058
                   "priority", "servicename", "configdir",
2374
2059
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2375
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
2060
                   "statedir"):
2376
2061
        value = getattr(options, option)
2377
2062
        if value is not None:
2378
2063
            server_settings[option] = value
2379
2064
    del options
2380
2065
    # Force all strings to be unicode
2381
2066
    for option in server_settings.keys():
2382
 
        if isinstance(server_settings[option], bytes):
2383
 
            server_settings[option] = (server_settings[option]
2384
 
                                       .decode("utf-8"))
2385
 
    # Force all boolean options to be boolean
2386
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2387
 
                   "foreground", "zeroconf"):
2388
 
        server_settings[option] = bool(server_settings[option])
2389
 
    # Debug implies foreground
2390
 
    if server_settings["debug"]:
2391
 
        server_settings["foreground"] = True
 
2067
        if type(server_settings[option]) is str:
 
2068
            server_settings[option] = unicode(server_settings[option])
2392
2069
    # Now we have our good server settings in "server_settings"
2393
2070
    
2394
2071
    ##################################################################
2395
2072
    
2396
 
    if (not server_settings["zeroconf"] and
2397
 
        not (server_settings["port"]
2398
 
             or server_settings["socket"] != "")):
2399
 
            parser.error("Needs port or socket to work without"
2400
 
                         " Zeroconf")
2401
 
    
2402
2073
    # For convenience
2403
2074
    debug = server_settings["debug"]
2404
2075
    debuglevel = server_settings["debuglevel"]
2406
2077
    use_ipv6 = server_settings["use_ipv6"]
2407
2078
    stored_state_path = os.path.join(server_settings["statedir"],
2408
2079
                                     stored_state_file)
2409
 
    foreground = server_settings["foreground"]
2410
 
    zeroconf = server_settings["zeroconf"]
2411
2080
    
2412
2081
    if debug:
2413
2082
        initlogger(debug, logging.DEBUG)
2420
2089
    
2421
2090
    if server_settings["servicename"] != "Mandos":
2422
2091
        syslogger.setFormatter(logging.Formatter
2423
 
                               ('Mandos ({}) [%(process)d]:'
2424
 
                                ' %(levelname)s: %(message)s'
2425
 
                                .format(server_settings
2426
 
                                        ["servicename"])))
 
2092
                               ('Mandos (%s) [%%(process)d]:'
 
2093
                                ' %%(levelname)s: %%(message)s'
 
2094
                                % server_settings["servicename"]))
2427
2095
    
2428
2096
    # Parse config file with clients
2429
 
    client_config = configparser.SafeConfigParser(Client
2430
 
                                                  .client_defaults)
 
2097
    client_config = configparser.SafeConfigParser(Client.client_defaults)
2431
2098
    client_config.read(os.path.join(server_settings["configdir"],
2432
2099
                                    "clients.conf"))
2433
2100
    
2434
2101
    global mandos_dbus_service
2435
2102
    mandos_dbus_service = None
2436
2103
    
2437
 
    socketfd = None
2438
 
    if server_settings["socket"] != "":
2439
 
        socketfd = server_settings["socket"]
2440
2104
    tcp_server = MandosServer((server_settings["address"],
2441
2105
                               server_settings["port"]),
2442
2106
                              ClientHandler,
2445
2109
                              use_ipv6=use_ipv6,
2446
2110
                              gnutls_priority=
2447
2111
                              server_settings["priority"],
2448
 
                              use_dbus=use_dbus,
2449
 
                              socketfd=socketfd)
2450
 
    if not foreground:
2451
 
        pidfilename = "/run/mandos.pid"
2452
 
        if not os.path.isdir("/run/."):
2453
 
            pidfilename = "/var/run/mandos.pid"
2454
 
        pidfile = None
 
2112
                              use_dbus=use_dbus)
 
2113
    if not debug:
 
2114
        pidfilename = "/var/run/mandos.pid"
2455
2115
        try:
2456
2116
            pidfile = open(pidfilename, "w")
2457
 
        except IOError as e:
2458
 
            logger.error("Could not open file %r", pidfilename,
2459
 
                         exc_info=e)
 
2117
        except IOError:
 
2118
            logger.error("Could not open file %r", pidfilename)
2460
2119
    
2461
 
    for name in ("_mandos", "mandos", "nobody"):
 
2120
    try:
 
2121
        uid = pwd.getpwnam("_mandos").pw_uid
 
2122
        gid = pwd.getpwnam("_mandos").pw_gid
 
2123
    except KeyError:
2462
2124
        try:
2463
 
            uid = pwd.getpwnam(name).pw_uid
2464
 
            gid = pwd.getpwnam(name).pw_gid
2465
 
            break
 
2125
            uid = pwd.getpwnam("mandos").pw_uid
 
2126
            gid = pwd.getpwnam("mandos").pw_gid
2466
2127
        except KeyError:
2467
 
            continue
2468
 
    else:
2469
 
        uid = 65534
2470
 
        gid = 65534
 
2128
            try:
 
2129
                uid = pwd.getpwnam("nobody").pw_uid
 
2130
                gid = pwd.getpwnam("nobody").pw_gid
 
2131
            except KeyError:
 
2132
                uid = 65534
 
2133
                gid = 65534
2471
2134
    try:
2472
2135
        os.setgid(gid)
2473
2136
        os.setuid(uid)
2474
2137
    except OSError as error:
2475
 
        if error.errno != errno.EPERM:
2476
 
            raise
 
2138
        if error[0] != errno.EPERM:
 
2139
            raise error
2477
2140
    
2478
2141
    if debug:
2479
2142
        # Enable all possible GnuTLS debugging
2490
2153
         .gnutls_global_set_log_function(debug_gnutls))
2491
2154
        
2492
2155
        # Redirect stdin so all checkers get /dev/null
2493
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
2156
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2494
2157
        os.dup2(null, sys.stdin.fileno())
2495
2158
        if null > 2:
2496
2159
            os.close(null)
2497
2160
    
2498
2161
    # Need to fork before connecting to D-Bus
2499
 
    if not foreground:
 
2162
    if not debug:
2500
2163
        # Close all input and output, do double fork, etc.
2501
2164
        daemon()
2502
2165
    
2503
 
    # multiprocessing will use threads, so before we use gobject we
2504
 
    # need to inform gobject that threads will be used.
2505
2166
    gobject.threads_init()
2506
2167
    
2507
2168
    global main_loop
2508
2169
    # From the Avahi example code
2509
 
    DBusGMainLoop(set_as_default=True)
 
2170
    DBusGMainLoop(set_as_default=True )
2510
2171
    main_loop = gobject.MainLoop()
2511
2172
    bus = dbus.SystemBus()
2512
2173
    # End of Avahi example code
2518
2179
                            ("se.bsnet.fukt.Mandos", bus,
2519
2180
                             do_not_queue=True))
2520
2181
        except dbus.exceptions.NameExistsException as e:
2521
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
2182
            logger.error(unicode(e) + ", disabling D-Bus")
2522
2183
            use_dbus = False
2523
2184
            server_settings["use_dbus"] = False
2524
2185
            tcp_server.use_dbus = False
2525
 
    if zeroconf:
2526
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2527
 
        service = AvahiServiceToSyslog(name =
2528
 
                                       server_settings["servicename"],
2529
 
                                       servicetype = "_mandos._tcp",
2530
 
                                       protocol = protocol, bus = bus)
2531
 
        if server_settings["interface"]:
2532
 
            service.interface = (if_nametoindex
2533
 
                                 (server_settings["interface"]
2534
 
                                  .encode("utf-8")))
 
2186
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2187
    service = AvahiServiceToSyslog(name =
 
2188
                                   server_settings["servicename"],
 
2189
                                   servicetype = "_mandos._tcp",
 
2190
                                   protocol = protocol, bus = bus)
 
2191
    if server_settings["interface"]:
 
2192
        service.interface = (if_nametoindex
 
2193
                             (str(server_settings["interface"])))
2535
2194
    
2536
2195
    global multiprocessing_manager
2537
2196
    multiprocessing_manager = multiprocessing.Manager()
2538
2197
    
2539
2198
    client_class = Client
2540
2199
    if use_dbus:
2541
 
        client_class = functools.partial(ClientDBus, bus = bus)
 
2200
        client_class = functools.partial(ClientDBusTransitional,
 
2201
                                         bus = bus)
2542
2202
    
2543
2203
    client_settings = Client.config_parser(client_config)
2544
2204
    old_client_settings = {}
2545
2205
    clients_data = {}
2546
2206
    
2547
 
    # This is used to redirect stdout and stderr for checker processes
2548
 
    global wnull
2549
 
    wnull = open(os.devnull, "w") # A writable /dev/null
2550
 
    # Only used if server is running in foreground but not in debug
2551
 
    # mode
2552
 
    if debug or not foreground:
2553
 
        wnull.close()
2554
 
    
2555
2207
    # Get client data and settings from last running state.
2556
2208
    if server_settings["restore"]:
2557
2209
        try:
2560
2212
                                                     (stored_state))
2561
2213
            os.remove(stored_state_path)
2562
2214
        except IOError as e:
2563
 
            if e.errno == errno.ENOENT:
2564
 
                logger.warning("Could not load persistent state: {}"
2565
 
                                .format(os.strerror(e.errno)))
2566
 
            else:
2567
 
                logger.critical("Could not load persistent state:",
2568
 
                                exc_info=e)
 
2215
            logger.warning("Could not load persistent state: {0}"
 
2216
                           .format(e))
 
2217
            if e.errno != errno.ENOENT:
2569
2218
                raise
2570
2219
        except EOFError as e:
2571
2220
            logger.warning("Could not load persistent state: "
2572
 
                           "EOFError:", exc_info=e)
 
2221
                           "EOFError: {0}".format(e))
2573
2222
    
2574
2223
    with PGPEngine() as pgp:
2575
 
        for client_name, client in clients_data.items():
2576
 
            # Skip removed clients
2577
 
            if client_name not in client_settings:
2578
 
                continue
2579
 
            
 
2224
        for client_name, client in clients_data.iteritems():
2580
2225
            # Decide which value to use after restoring saved state.
2581
2226
            # We have three different values: Old config file,
2582
2227
            # new config file, and saved state.
2596
2241
            
2597
2242
            # Clients who has passed its expire date can still be
2598
2243
            # enabled if its last checker was successful.  Clients
2599
 
            # whose checker succeeded before we stored its state is
2600
 
            # assumed to have successfully run all checkers during
2601
 
            # downtime.
 
2244
            # whose checker failed before we stored its state is
 
2245
            # assumed to have failed all checkers during downtime.
2602
2246
            if client["enabled"]:
2603
2247
                if datetime.datetime.utcnow() >= client["expires"]:
2604
2248
                    if not client["last_checked_ok"]:
2605
2249
                        logger.warning(
2606
 
                            "disabling client {} - Client never "
2607
 
                            "performed a successful checker"
2608
 
                            .format(client_name))
 
2250
                            "disabling client {0} - Client never "
 
2251
                            "performed a successfull checker"
 
2252
                            .format(client["name"]))
2609
2253
                        client["enabled"] = False
2610
2254
                    elif client["last_checker_status"] != 0:
2611
2255
                        logger.warning(
2612
 
                            "disabling client {} - Client last"
2613
 
                            " checker failed with error code {}"
2614
 
                            .format(client_name,
 
2256
                            "disabling client {0} - Client "
 
2257
                            "last checker failed with error code {1}"
 
2258
                            .format(client["name"],
2615
2259
                                    client["last_checker_status"]))
2616
2260
                        client["enabled"] = False
2617
2261
                    else:
2618
2262
                        client["expires"] = (datetime.datetime
2619
2263
                                             .utcnow()
2620
2264
                                             + client["timeout"])
2621
 
                        logger.debug("Last checker succeeded,"
2622
 
                                     " keeping {} enabled"
2623
 
                                     .format(client_name))
 
2265
                    
2624
2266
            try:
2625
2267
                client["secret"] = (
2626
2268
                    pgp.decrypt(client["encrypted_secret"],
2628
2270
                                ["secret"]))
2629
2271
            except PGPError:
2630
2272
                # If decryption fails, we use secret from new settings
2631
 
                logger.debug("Failed to decrypt {} old secret"
 
2273
                logger.debug("Failed to decrypt {0} old secret"
2632
2274
                             .format(client_name))
2633
2275
                client["secret"] = (
2634
2276
                    client_settings[client_name]["secret"])
 
2277
 
2635
2278
    
2636
2279
    # Add/remove clients based on new changes made to config
2637
 
    for client_name in (set(old_client_settings)
2638
 
                        - set(client_settings)):
 
2280
    for client_name in set(old_client_settings) - set(client_settings):
2639
2281
        del clients_data[client_name]
2640
 
    for client_name in (set(client_settings)
2641
 
                        - set(old_client_settings)):
 
2282
    for client_name in set(client_settings) - set(old_client_settings):
2642
2283
        clients_data[client_name] = client_settings[client_name]
2643
 
    
2644
 
    # Create all client objects
2645
 
    for client_name, client in clients_data.items():
 
2284
 
 
2285
    # Create clients all clients
 
2286
    for client_name, client in clients_data.iteritems():
2646
2287
        tcp_server.clients[client_name] = client_class(
2647
 
            name = client_name, settings = client,
2648
 
            server_settings = server_settings)
 
2288
            name = client_name, settings = client)
2649
2289
    
2650
2290
    if not tcp_server.clients:
2651
2291
        logger.warning("No clients defined")
2652
 
    
2653
 
    if not foreground:
2654
 
        if pidfile is not None:
2655
 
            try:
2656
 
                with pidfile:
2657
 
                    pid = os.getpid()
2658
 
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
2659
 
            except IOError:
2660
 
                logger.error("Could not write to file %r with PID %d",
2661
 
                             pidfilename, pid)
2662
 
        del pidfile
 
2292
        
 
2293
    if not debug:
 
2294
        try:
 
2295
            with pidfile:
 
2296
                pid = os.getpid()
 
2297
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2298
            del pidfile
 
2299
        except IOError:
 
2300
            logger.error("Could not write to file %r with PID %d",
 
2301
                         pidfilename, pid)
 
2302
        except NameError:
 
2303
            # "pidfile" was never created
 
2304
            pass
2663
2305
        del pidfilename
 
2306
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2664
2307
    
2665
2308
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2666
2309
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2667
2310
    
2668
2311
    if use_dbus:
2669
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2670
 
                                        "se.bsnet.fukt.Mandos"})
2671
 
        class MandosDBusService(DBusObjectWithProperties):
 
2312
        class MandosDBusService(dbus.service.Object):
2672
2313
            """A D-Bus proxy object"""
2673
2314
            def __init__(self):
2674
2315
                dbus.service.Object.__init__(self, bus, "/")
2675
2316
            _interface = "se.recompile.Mandos"
2676
2317
            
2677
 
            @dbus_interface_annotations(_interface)
2678
 
            def _foo(self):
2679
 
                return { "org.freedesktop.DBus.Property"
2680
 
                         ".EmitsChangedSignal":
2681
 
                             "false"}
2682
 
            
2683
2318
            @dbus.service.signal(_interface, signature="o")
2684
2319
            def ClientAdded(self, objpath):
2685
2320
                "D-Bus signal"
2727
2362
            
2728
2363
            del _interface
2729
2364
        
2730
 
        mandos_dbus_service = MandosDBusService()
 
2365
        class MandosDBusServiceTransitional(MandosDBusService):
 
2366
            __metaclass__ = AlternateDBusNamesMetaclass
 
2367
        mandos_dbus_service = MandosDBusServiceTransitional()
2731
2368
    
2732
2369
    def cleanup():
2733
2370
        "Cleanup function; run on exit"
2734
 
        if zeroconf:
2735
 
            service.cleanup()
 
2371
        service.cleanup()
2736
2372
        
2737
2373
        multiprocessing.active_children()
2738
 
        wnull.close()
2739
2374
        if not (tcp_server.clients or client_settings):
2740
2375
            return
2741
2376
        
2752
2387
                
2753
2388
                # A list of attributes that can not be pickled
2754
2389
                # + secret.
2755
 
                exclude = { "bus", "changedstate", "secret",
2756
 
                            "checker", "server_settings" }
 
2390
                exclude = set(("bus", "changedstate", "secret",
 
2391
                               "checker"))
2757
2392
                for name, typ in (inspect.getmembers
2758
2393
                                  (dbus.service.Object)):
2759
2394
                    exclude.add(name)
2768
2403
                del client_settings[client.name]["secret"]
2769
2404
        
2770
2405
        try:
2771
 
            with (tempfile.NamedTemporaryFile
2772
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2773
 
                   dir=os.path.dirname(stored_state_path),
2774
 
                   delete=False)) as stored_state:
 
2406
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
 
2407
                                                prefix="clients-",
 
2408
                                                dir=os.path.dirname
 
2409
                                                (stored_state_path))
 
2410
            with os.fdopen(tempfd, "wb") as stored_state:
2775
2411
                pickle.dump((clients, client_settings), stored_state)
2776
 
                tempname=stored_state.name
2777
2412
            os.rename(tempname, stored_state_path)
2778
2413
        except (IOError, OSError) as e:
 
2414
            logger.warning("Could not save persistent state: {0}"
 
2415
                           .format(e))
2779
2416
            if not debug:
2780
2417
                try:
2781
2418
                    os.remove(tempname)
2782
2419
                except NameError:
2783
2420
                    pass
2784
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2785
 
                logger.warning("Could not save persistent state: {}"
2786
 
                               .format(os.strerror(e.errno)))
2787
 
            else:
2788
 
                logger.warning("Could not save persistent state:",
2789
 
                               exc_info=e)
2790
 
                raise
 
2421
            if e.errno not in set((errno.ENOENT, errno.EACCES,
 
2422
                                   errno.EEXIST)):
 
2423
                raise e
2791
2424
        
2792
2425
        # Delete all clients, and settings from config
2793
2426
        while tcp_server.clients:
2817
2450
    tcp_server.server_activate()
2818
2451
    
2819
2452
    # Find out what port we got
2820
 
    if zeroconf:
2821
 
        service.port = tcp_server.socket.getsockname()[1]
 
2453
    service.port = tcp_server.socket.getsockname()[1]
2822
2454
    if use_ipv6:
2823
2455
        logger.info("Now listening on address %r, port %d,"
2824
 
                    " flowinfo %d, scope_id %d",
2825
 
                    *tcp_server.socket.getsockname())
 
2456
                    " flowinfo %d, scope_id %d"
 
2457
                    % tcp_server.socket.getsockname())
2826
2458
    else:                       # IPv4
2827
 
        logger.info("Now listening on address %r, port %d",
2828
 
                    *tcp_server.socket.getsockname())
 
2459
        logger.info("Now listening on address %r, port %d"
 
2460
                    % tcp_server.socket.getsockname())
2829
2461
    
2830
2462
    #service.interface = tcp_server.socket.getsockname()[3]
2831
2463
    
2832
2464
    try:
2833
 
        if zeroconf:
2834
 
            # From the Avahi example code
2835
 
            try:
2836
 
                service.activate()
2837
 
            except dbus.exceptions.DBusException as error:
2838
 
                logger.critical("D-Bus Exception", exc_info=error)
2839
 
                cleanup()
2840
 
                sys.exit(1)
2841
 
            # End of Avahi example code
 
2465
        # From the Avahi example code
 
2466
        try:
 
2467
            service.activate()
 
2468
        except dbus.exceptions.DBusException as error:
 
2469
            logger.critical("DBusException: %s", error)
 
2470
            cleanup()
 
2471
            sys.exit(1)
 
2472
        # End of Avahi example code
2842
2473
        
2843
2474
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2844
2475
                             lambda *args, **kwargs:
2848
2479
        logger.debug("Starting main loop")
2849
2480
        main_loop.run()
2850
2481
    except AvahiError as error:
2851
 
        logger.critical("Avahi Error", exc_info=error)
 
2482
        logger.critical("AvahiError: %s", error)
2852
2483
        cleanup()
2853
2484
        sys.exit(1)
2854
2485
    except KeyboardInterrupt: