/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-07-20 03:03:33 UTC
  • Revision ID: teddy@recompile.se-20150720030333-203m2aeblypcsfte
Bug fix for GnuTLS 3: be compatible with old 2048-bit DSA keys.

The mandos-keygen program in Mandos version 1.6.0 and older generated
2048-bit DSA keys, and when GnuTLS uses these it has trouble
connecting using the Mandos default priority string.  This was
previously fixed in Mandos 1.6.2, but the bug reappeared when using
GnuTLS 3, so the default priority string has to change again; this
time also the Mandos client has to change its default, so now the
server and the client should use the same default priority string:

SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA:+SIGN-DSA-SHA256

* mandos (main/server_defaults): Changed default priority string.
* mandos-options.xml (/section/para[id="priority_compat"]): Removed.
  (/section/para[id="priority"]): Changed default priority string.
* mandos.conf ([DEFAULT]/priority): - '' -
* mandos.conf.xml (OPTIONS/priority): Refer to the id "priority"
                                      instead of "priority_compat".
* mandos.xml (OPTIONS/--priority): - '' -
* plugins.d/mandos-client.c (main): Changed default priority string.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
 
1
#!/usr/bin/python2.7
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-2012 Teddy Hogeborn
15
 
# Copyright © 2008-2012 Björn Påhlsson
 
14
# Copyright © 2008-2015 Teddy Hogeborn
 
15
# Copyright © 2008-2015 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
 
import SocketServer as socketserver
 
37
from future_builtins import *
 
38
 
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
38
43
import socket
39
44
import argparse
40
45
import datetime
45
50
import gnutls.library.functions
46
51
import gnutls.library.constants
47
52
import gnutls.library.types
48
 
import ConfigParser as configparser
 
53
try:
 
54
    import ConfigParser as configparser
 
55
except ImportError:
 
56
    import configparser
49
57
import sys
50
58
import re
51
59
import os
60
68
import struct
61
69
import fcntl
62
70
import functools
63
 
import cPickle as pickle
 
71
try:
 
72
    import cPickle as pickle
 
73
except ImportError:
 
74
    import pickle
64
75
import multiprocessing
65
76
import types
66
77
import binascii
67
78
import tempfile
 
79
import itertools
 
80
import collections
 
81
import codecs
68
82
 
69
83
import dbus
70
84
import dbus.service
71
 
import gobject
 
85
try:
 
86
    import gobject
 
87
except ImportError:
 
88
    from gi.repository import GObject as gobject
72
89
import avahi
73
90
from dbus.mainloop.glib import DBusGMainLoop
74
91
import ctypes
75
92
import ctypes.util
76
93
import xml.dom.minidom
77
94
import inspect
78
 
import GnuPGInterface
79
95
 
80
96
try:
81
97
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
101
    except ImportError:
86
102
        SO_BINDTODEVICE = None
87
103
 
88
 
version = "1.5.0"
 
104
if sys.version_info.major == 2:
 
105
    str = unicode
 
106
 
 
107
version = "1.6.9"
89
108
stored_state_file = "clients.pickle"
90
109
 
91
110
logger = logging.getLogger()
92
 
syslogger = (logging.handlers.SysLogHandler
93
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
 
              address = str("/dev/log")))
 
111
syslogger = None
95
112
 
96
113
try:
97
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
98
 
                      (ctypes.util.find_library("c"))
99
 
                      .if_nametoindex)
 
114
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
115
        ctypes.util.find_library("c")).if_nametoindex
100
116
except (OSError, AttributeError):
 
117
    
101
118
    def if_nametoindex(interface):
102
119
        "Get an interface index the hard way, i.e. using fcntl()"
103
120
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
104
121
        with contextlib.closing(socket.socket()) as s:
105
122
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
106
 
                                struct.pack(str("16s16x"),
107
 
                                            interface))
108
 
        interface_index = struct.unpack(str("I"),
109
 
                                        ifreq[16:20])[0]
 
123
                                struct.pack(b"16s16x", interface))
 
124
        interface_index = struct.unpack("I", ifreq[16:20])[0]
110
125
        return interface_index
111
126
 
112
127
 
113
128
def initlogger(debug, level=logging.WARNING):
114
129
    """init logger and add loglevel"""
115
130
    
 
131
    global syslogger
 
132
    syslogger = (logging.handlers.SysLogHandler(
 
133
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
134
        address = "/dev/log"))
116
135
    syslogger.setFormatter(logging.Formatter
117
136
                           ('Mandos [%(process)d]: %(levelname)s:'
118
137
                            ' %(message)s'))
135
154
 
136
155
class PGPEngine(object):
137
156
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
157
    
138
158
    def __init__(self):
139
 
        self.gnupg = GnuPGInterface.GnuPG()
140
159
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
141
 
        self.gnupg = GnuPGInterface.GnuPG()
142
 
        self.gnupg.options.meta_interactive = False
143
 
        self.gnupg.options.homedir = self.tempdir
144
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
145
 
                                              '--quiet',
146
 
                                              '--no-use-agent'])
 
160
        self.gnupgargs = ['--batch',
 
161
                          '--home', self.tempdir,
 
162
                          '--force-mdc',
 
163
                          '--quiet',
 
164
                          '--no-use-agent']
147
165
    
148
166
    def __enter__(self):
149
167
        return self
150
168
    
151
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
169
    def __exit__(self, exc_type, exc_value, traceback):
152
170
        self._cleanup()
153
171
        return False
154
172
    
171
189
    def password_encode(self, password):
172
190
        # Passphrase can not be empty and can not contain newlines or
173
191
        # NUL bytes.  So we prefix it and hex encode it.
174
 
        return b"mandos" + binascii.hexlify(password)
 
192
        encoded = b"mandos" + binascii.hexlify(password)
 
193
        if len(encoded) > 2048:
 
194
            # GnuPG can't handle long passwords, so encode differently
 
195
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
196
                       .replace(b"\n", b"\\n")
 
197
                       .replace(b"\0", b"\\x00"))
 
198
        return encoded
175
199
    
176
200
    def encrypt(self, data, password):
177
 
        self.gnupg.passphrase = self.password_encode(password)
178
 
        with open(os.devnull) as devnull:
179
 
            try:
180
 
                proc = self.gnupg.run(['--symmetric'],
181
 
                                      create_fhs=['stdin', 'stdout'],
182
 
                                      attach_fhs={'stderr': devnull})
183
 
                with contextlib.closing(proc.handles['stdin']) as f:
184
 
                    f.write(data)
185
 
                with contextlib.closing(proc.handles['stdout']) as f:
186
 
                    ciphertext = f.read()
187
 
                proc.wait()
188
 
            except IOError as e:
189
 
                raise PGPError(e)
190
 
        self.gnupg.passphrase = None
 
201
        passphrase = self.password_encode(password)
 
202
        with tempfile.NamedTemporaryFile(
 
203
                dir=self.tempdir) as passfile:
 
204
            passfile.write(passphrase)
 
205
            passfile.flush()
 
206
            proc = subprocess.Popen(['gpg', '--symmetric',
 
207
                                     '--passphrase-file',
 
208
                                     passfile.name]
 
209
                                    + self.gnupgargs,
 
210
                                    stdin = subprocess.PIPE,
 
211
                                    stdout = subprocess.PIPE,
 
212
                                    stderr = subprocess.PIPE)
 
213
            ciphertext, err = proc.communicate(input = data)
 
214
        if proc.returncode != 0:
 
215
            raise PGPError(err)
191
216
        return ciphertext
192
217
    
193
218
    def decrypt(self, data, password):
194
 
        self.gnupg.passphrase = self.password_encode(password)
195
 
        with open(os.devnull) as devnull:
196
 
            try:
197
 
                proc = self.gnupg.run(['--decrypt'],
198
 
                                      create_fhs=['stdin', 'stdout'],
199
 
                                      attach_fhs={'stderr': devnull})
200
 
                with contextlib.closing(proc.handles['stdin'] ) as f:
201
 
                    f.write(data)
202
 
                with contextlib.closing(proc.handles['stdout']) as f:
203
 
                    decrypted_plaintext = f.read()
204
 
                proc.wait()
205
 
            except IOError as e:
206
 
                raise PGPError(e)
207
 
        self.gnupg.passphrase = None
 
219
        passphrase = self.password_encode(password)
 
220
        with tempfile.NamedTemporaryFile(
 
221
                dir = self.tempdir) as passfile:
 
222
            passfile.write(passphrase)
 
223
            passfile.flush()
 
224
            proc = subprocess.Popen(['gpg', '--decrypt',
 
225
                                     '--passphrase-file',
 
226
                                     passfile.name]
 
227
                                    + self.gnupgargs,
 
228
                                    stdin = subprocess.PIPE,
 
229
                                    stdout = subprocess.PIPE,
 
230
                                    stderr = subprocess.PIPE)
 
231
            decrypted_plaintext, err = proc.communicate(input = data)
 
232
        if proc.returncode != 0:
 
233
            raise PGPError(err)
208
234
        return decrypted_plaintext
209
235
 
210
236
 
211
 
 
212
237
class AvahiError(Exception):
213
238
    def __init__(self, value, *args, **kwargs):
214
239
        self.value = value
215
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
216
 
    def __unicode__(self):
217
 
        return unicode(repr(self.value))
 
240
        return super(AvahiError, self).__init__(value, *args,
 
241
                                                **kwargs)
 
242
 
218
243
 
219
244
class AvahiServiceError(AvahiError):
220
245
    pass
221
246
 
 
247
 
222
248
class AvahiGroupError(AvahiError):
223
249
    pass
224
250
 
231
257
               Used to optionally bind to the specified interface.
232
258
    name: string; Example: 'Mandos'
233
259
    type: string; Example: '_mandos._tcp'.
234
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
260
     See <https://www.iana.org/assignments/service-names-port-numbers>
235
261
    port: integer; what port to announce
236
262
    TXT: list of strings; TXT record for the service
237
263
    domain: string; Domain to publish on, default to .local if empty.
243
269
    server: D-Bus Server
244
270
    bus: dbus.SystemBus()
245
271
    """
246
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
247
 
                 servicetype = None, port = None, TXT = None,
248
 
                 domain = "", host = "", max_renames = 32768,
249
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
272
    
 
273
    def __init__(self,
 
274
                 interface = avahi.IF_UNSPEC,
 
275
                 name = None,
 
276
                 servicetype = None,
 
277
                 port = None,
 
278
                 TXT = None,
 
279
                 domain = "",
 
280
                 host = "",
 
281
                 max_renames = 32768,
 
282
                 protocol = avahi.PROTO_UNSPEC,
 
283
                 bus = None):
250
284
        self.interface = interface
251
285
        self.name = name
252
286
        self.type = servicetype
261
295
        self.server = None
262
296
        self.bus = bus
263
297
        self.entry_group_state_changed_match = None
264
 
    def rename(self):
 
298
    
 
299
    def rename(self, remove=True):
265
300
        """Derived from the Avahi example code"""
266
301
        if self.rename_count >= self.max_renames:
267
302
            logger.critical("No suitable Zeroconf service name found"
268
303
                            " after %i retries, exiting.",
269
304
                            self.rename_count)
270
305
            raise AvahiServiceError("Too many renames")
271
 
        self.name = unicode(self.server
272
 
                            .GetAlternativeServiceName(self.name))
 
306
        self.name = str(
 
307
            self.server.GetAlternativeServiceName(self.name))
 
308
        self.rename_count += 1
273
309
        logger.info("Changing Zeroconf service name to %r ...",
274
310
                    self.name)
275
 
        self.remove()
 
311
        if remove:
 
312
            self.remove()
276
313
        try:
277
314
            self.add()
278
315
        except dbus.exceptions.DBusException as error:
279
 
            logger.critical("DBusException: %s", error)
280
 
            self.cleanup()
281
 
            os._exit(1)
282
 
        self.rename_count += 1
 
316
            if (error.get_dbus_name()
 
317
                == "org.freedesktop.Avahi.CollisionError"):
 
318
                logger.info("Local Zeroconf service name collision.")
 
319
                return self.rename(remove=False)
 
320
            else:
 
321
                logger.critical("D-Bus Exception", exc_info=error)
 
322
                self.cleanup()
 
323
                os._exit(1)
 
324
    
283
325
    def remove(self):
284
326
        """Derived from the Avahi example code"""
285
327
        if self.entry_group_state_changed_match is not None:
287
329
            self.entry_group_state_changed_match = None
288
330
        if self.group is not None:
289
331
            self.group.Reset()
 
332
    
290
333
    def add(self):
291
334
        """Derived from the Avahi example code"""
292
335
        self.remove()
309
352
            dbus.UInt16(self.port),
310
353
            avahi.string_array_to_txt_array(self.TXT))
311
354
        self.group.Commit()
 
355
    
312
356
    def entry_group_state_changed(self, state, error):
313
357
        """Derived from the Avahi example code"""
314
358
        logger.debug("Avahi entry group state change: %i", state)
320
364
            self.rename()
321
365
        elif state == avahi.ENTRY_GROUP_FAILURE:
322
366
            logger.critical("Avahi: Error in group state changed %s",
323
 
                            unicode(error))
324
 
            raise AvahiGroupError("State changed: %s"
325
 
                                  % unicode(error))
 
367
                            str(error))
 
368
            raise AvahiGroupError("State changed: {!s}".format(error))
 
369
    
326
370
    def cleanup(self):
327
371
        """Derived from the Avahi example code"""
328
372
        if self.group is not None:
333
377
                pass
334
378
            self.group = None
335
379
        self.remove()
 
380
    
336
381
    def server_state_changed(self, state, error=None):
337
382
        """Derived from the Avahi example code"""
338
383
        logger.debug("Avahi server state change: %i", state)
339
 
        bad_states = { avahi.SERVER_INVALID:
340
 
                           "Zeroconf server invalid",
341
 
                       avahi.SERVER_REGISTERING: None,
342
 
                       avahi.SERVER_COLLISION:
343
 
                           "Zeroconf server name collision",
344
 
                       avahi.SERVER_FAILURE:
345
 
                           "Zeroconf server failure" }
 
384
        bad_states = {
 
385
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
386
            avahi.SERVER_REGISTERING: None,
 
387
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
388
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
389
        }
346
390
        if state in bad_states:
347
391
            if bad_states[state] is not None:
348
392
                if error is None:
351
395
                    logger.error(bad_states[state] + ": %r", error)
352
396
            self.cleanup()
353
397
        elif state == avahi.SERVER_RUNNING:
354
 
            self.add()
 
398
            try:
 
399
                self.add()
 
400
            except dbus.exceptions.DBusException as error:
 
401
                if (error.get_dbus_name()
 
402
                    == "org.freedesktop.Avahi.CollisionError"):
 
403
                    logger.info("Local Zeroconf service name"
 
404
                                " collision.")
 
405
                    return self.rename(remove=False)
 
406
                else:
 
407
                    logger.critical("D-Bus Exception", exc_info=error)
 
408
                    self.cleanup()
 
409
                    os._exit(1)
355
410
        else:
356
411
            if error is None:
357
412
                logger.debug("Unknown state: %r", state)
358
413
            else:
359
414
                logger.debug("Unknown state: %r: %r", state, error)
 
415
    
360
416
    def activate(self):
361
417
        """Derived from the Avahi example code"""
362
418
        if self.server is None:
366
422
                                    follow_name_owner_changes=True),
367
423
                avahi.DBUS_INTERFACE_SERVER)
368
424
        self.server.connect_to_signal("StateChanged",
369
 
                                 self.server_state_changed)
 
425
                                      self.server_state_changed)
370
426
        self.server_state_changed(self.server.GetState())
371
427
 
 
428
 
372
429
class AvahiServiceToSyslog(AvahiService):
373
 
    def rename(self):
 
430
    def rename(self, *args, **kwargs):
374
431
        """Add the new name to the syslog messages"""
375
 
        ret = AvahiService.rename(self)
376
 
        syslogger.setFormatter(logging.Formatter
377
 
                               ('Mandos (%s) [%%(process)d]:'
378
 
                                ' %%(levelname)s: %%(message)s'
379
 
                                % self.name))
 
432
        ret = AvahiService.rename(self, *args, **kwargs)
 
433
        syslogger.setFormatter(logging.Formatter(
 
434
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
435
            .format(self.name)))
380
436
        return ret
381
437
 
382
 
def timedelta_to_milliseconds(td):
383
 
    "Convert a datetime.timedelta() to milliseconds"
384
 
    return ((td.days * 24 * 60 * 60 * 1000)
385
 
            + (td.seconds * 1000)
386
 
            + (td.microseconds // 1000))
387
 
        
 
438
def call_pipe(connection,       # : multiprocessing.Connection
 
439
              func, *args, **kwargs):
 
440
    """This function is meant to be called by multiprocessing.Process
 
441
    
 
442
    This function runs func(*args, **kwargs), and writes the resulting
 
443
    return value on the provided multiprocessing.Connection.
 
444
    """
 
445
    connection.send(func(*args, **kwargs))
 
446
    connection.close()
 
447
 
388
448
class Client(object):
389
449
    """A representation of a client host served by this server.
390
450
    
415
475
    last_checked_ok: datetime.datetime(); (UTC) or None
416
476
    last_checker_status: integer between 0 and 255 reflecting exit
417
477
                         status of last checker. -1 reflects crashed
418
 
                         checker, or None.
 
478
                         checker, -2 means no checker completed yet.
 
479
    last_checker_signal: The signal which killed the last checker, if
 
480
                         last_checker_status is -1
419
481
    last_enabled: datetime.datetime(); (UTC) or None
420
482
    name:       string; from the config file, used in log messages and
421
483
                        D-Bus identifiers
422
484
    secret:     bytestring; sent verbatim (over TLS) to client
423
485
    timeout:    datetime.timedelta(); How long from last_checked_ok
424
486
                                      until this client is disabled
425
 
    extended_timeout:   extra long timeout when password has been sent
 
487
    extended_timeout:   extra long timeout when secret has been sent
426
488
    runtime_expansions: Allowed attributes for runtime expansion.
427
489
    expires:    datetime.datetime(); time (UTC) when a client will be
428
490
                disabled, or None
 
491
    server_settings: The server_settings dict from main()
429
492
    """
430
493
    
431
494
    runtime_expansions = ("approval_delay", "approval_duration",
432
 
                          "created", "enabled", "fingerprint",
433
 
                          "host", "interval", "last_checked_ok",
 
495
                          "created", "enabled", "expires",
 
496
                          "fingerprint", "host", "interval",
 
497
                          "last_approval_request", "last_checked_ok",
434
498
                          "last_enabled", "name", "timeout")
435
 
    client_defaults = { "timeout": "5m",
436
 
                        "extended_timeout": "15m",
437
 
                        "interval": "2m",
438
 
                        "checker": "fping -q -- %%(host)s",
439
 
                        "host": "",
440
 
                        "approval_delay": "0s",
441
 
                        "approval_duration": "1s",
442
 
                        "approved_by_default": "True",
443
 
                        "enabled": "True",
444
 
                        }
445
 
    
446
 
    def timeout_milliseconds(self):
447
 
        "Return the 'timeout' attribute in milliseconds"
448
 
        return timedelta_to_milliseconds(self.timeout)
449
 
    
450
 
    def extended_timeout_milliseconds(self):
451
 
        "Return the 'extended_timeout' attribute in milliseconds"
452
 
        return timedelta_to_milliseconds(self.extended_timeout)
453
 
    
454
 
    def interval_milliseconds(self):
455
 
        "Return the 'interval' attribute in milliseconds"
456
 
        return timedelta_to_milliseconds(self.interval)
457
 
    
458
 
    def approval_delay_milliseconds(self):
459
 
        return timedelta_to_milliseconds(self.approval_delay)
460
 
 
 
499
    client_defaults = {
 
500
        "timeout": "PT5M",
 
501
        "extended_timeout": "PT15M",
 
502
        "interval": "PT2M",
 
503
        "checker": "fping -q -- %%(host)s",
 
504
        "host": "",
 
505
        "approval_delay": "PT0S",
 
506
        "approval_duration": "PT1S",
 
507
        "approved_by_default": "True",
 
508
        "enabled": "True",
 
509
    }
 
510
    
461
511
    @staticmethod
462
512
    def config_parser(config):
463
513
        """Construct a new dict of client settings of this form:
478
528
            client["enabled"] = config.getboolean(client_name,
479
529
                                                  "enabled")
480
530
            
 
531
            # Uppercase and remove spaces from fingerprint for later
 
532
            # comparison purposes with return value from the
 
533
            # fingerprint() function
481
534
            client["fingerprint"] = (section["fingerprint"].upper()
482
535
                                     .replace(" ", ""))
483
536
            if "secret" in section:
488
541
                          "rb") as secfile:
489
542
                    client["secret"] = secfile.read()
490
543
            else:
491
 
                raise TypeError("No secret or secfile for section %s"
492
 
                                % section)
 
544
                raise TypeError("No secret or secfile for section {}"
 
545
                                .format(section))
493
546
            client["timeout"] = string_to_delta(section["timeout"])
494
547
            client["extended_timeout"] = string_to_delta(
495
548
                section["extended_timeout"])
501
554
            client["checker_command"] = section["checker"]
502
555
            client["last_approval_request"] = None
503
556
            client["last_checked_ok"] = None
504
 
            client["last_checker_status"] = None
 
557
            client["last_checker_status"] = -2
505
558
        
506
559
        return settings
507
 
        
508
 
        
509
 
    def __init__(self, settings, name = None):
510
 
        """Note: the 'checker' key in 'config' sets the
511
 
        'checker_command' attribute and *not* the 'checker'
512
 
        attribute."""
 
560
    
 
561
    def __init__(self, settings, name = None, server_settings=None):
513
562
        self.name = name
 
563
        if server_settings is None:
 
564
            server_settings = {}
 
565
        self.server_settings = server_settings
514
566
        # adding all client settings
515
 
        for setting, value in settings.iteritems():
 
567
        for setting, value in settings.items():
516
568
            setattr(self, setting, value)
517
569
        
518
570
        if self.enabled:
524
576
        else:
525
577
            self.last_enabled = None
526
578
            self.expires = None
527
 
       
 
579
        
528
580
        logger.debug("Creating client %r", self.name)
529
 
        # Uppercase and remove spaces from fingerprint for later
530
 
        # comparison purposes with return value from the fingerprint()
531
 
        # function
532
581
        logger.debug("  Fingerprint: %s", self.fingerprint)
533
582
        self.created = settings.get("created",
534
583
                                    datetime.datetime.utcnow())
535
 
 
 
584
        
536
585
        # attributes specific for this server instance
537
586
        self.checker = None
538
587
        self.checker_initiator_tag = None
541
590
        self.current_checker_command = None
542
591
        self.approved = None
543
592
        self.approvals_pending = 0
544
 
        self.changedstate = (multiprocessing_manager
545
 
                             .Condition(multiprocessing_manager
546
 
                                        .Lock()))
547
 
        self.client_structure = [attr for attr in
548
 
                                 self.__dict__.iterkeys()
 
593
        self.changedstate = multiprocessing_manager.Condition(
 
594
            multiprocessing_manager.Lock())
 
595
        self.client_structure = [attr
 
596
                                 for attr in self.__dict__.iterkeys()
549
597
                                 if not attr.startswith("_")]
550
598
        self.client_structure.append("client_structure")
551
599
        
552
 
        for name, t in inspect.getmembers(type(self),
553
 
                                          lambda obj:
554
 
                                              isinstance(obj,
555
 
                                                         property)):
 
600
        for name, t in inspect.getmembers(
 
601
                type(self), lambda obj: isinstance(obj, property)):
556
602
            if not name.startswith("_"):
557
603
                self.client_structure.append(name)
558
604
    
566
612
        if getattr(self, "enabled", False):
567
613
            # Already enabled
568
614
            return
569
 
        self.send_changedstate()
570
615
        self.expires = datetime.datetime.utcnow() + self.timeout
571
616
        self.enabled = True
572
617
        self.last_enabled = datetime.datetime.utcnow()
573
618
        self.init_checker()
 
619
        self.send_changedstate()
574
620
    
575
621
    def disable(self, quiet=True):
576
622
        """Disable this client."""
577
623
        if not getattr(self, "enabled", False):
578
624
            return False
579
625
        if not quiet:
580
 
            self.send_changedstate()
581
 
        if not quiet:
582
626
            logger.info("Disabling client %s", self.name)
583
 
        if getattr(self, "disable_initiator_tag", False):
 
627
        if getattr(self, "disable_initiator_tag", None) is not None:
584
628
            gobject.source_remove(self.disable_initiator_tag)
585
629
            self.disable_initiator_tag = None
586
630
        self.expires = None
587
 
        if getattr(self, "checker_initiator_tag", False):
 
631
        if getattr(self, "checker_initiator_tag", None) is not None:
588
632
            gobject.source_remove(self.checker_initiator_tag)
589
633
            self.checker_initiator_tag = None
590
634
        self.stop_checker()
591
635
        self.enabled = False
 
636
        if not quiet:
 
637
            self.send_changedstate()
592
638
        # Do not run this again if called by a gobject.timeout_add
593
639
        return False
594
640
    
598
644
    def init_checker(self):
599
645
        # Schedule a new checker to be started an 'interval' from now,
600
646
        # and every interval from then on.
601
 
        self.checker_initiator_tag = (gobject.timeout_add
602
 
                                      (self.interval_milliseconds(),
603
 
                                       self.start_checker))
 
647
        if self.checker_initiator_tag is not None:
 
648
            gobject.source_remove(self.checker_initiator_tag)
 
649
        self.checker_initiator_tag = gobject.timeout_add(
 
650
            int(self.interval.total_seconds() * 1000),
 
651
            self.start_checker)
604
652
        # Schedule a disable() when 'timeout' has passed
605
 
        self.disable_initiator_tag = (gobject.timeout_add
606
 
                                   (self.timeout_milliseconds(),
607
 
                                    self.disable))
 
653
        if self.disable_initiator_tag is not None:
 
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
        self.disable_initiator_tag = gobject.timeout_add(
 
656
            int(self.timeout.total_seconds() * 1000), self.disable)
608
657
        # Also start a new checker *right now*.
609
658
        self.start_checker()
610
659
    
611
 
    def checker_callback(self, pid, condition, command):
 
660
    def checker_callback(self, source, condition, connection,
 
661
                         command):
612
662
        """The checker has completed, so take appropriate actions."""
613
663
        self.checker_callback_tag = None
614
664
        self.checker = None
615
 
        if os.WIFEXITED(condition):
616
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
665
        # Read return code from connection (see call_pipe)
 
666
        returncode = connection.recv()
 
667
        connection.close()
 
668
        
 
669
        if returncode >= 0:
 
670
            self.last_checker_status = returncode
 
671
            self.last_checker_signal = None
617
672
            if self.last_checker_status == 0:
618
673
                logger.info("Checker for %(name)s succeeded",
619
674
                            vars(self))
620
675
                self.checked_ok()
621
676
            else:
622
 
                logger.info("Checker for %(name)s failed",
623
 
                            vars(self))
 
677
                logger.info("Checker for %(name)s failed", vars(self))
624
678
        else:
625
679
            self.last_checker_status = -1
 
680
            self.last_checker_signal = -returncode
626
681
            logger.warning("Checker for %(name)s crashed?",
627
682
                           vars(self))
628
 
    
629
 
    def checked_ok(self, timeout=None):
630
 
        """Bump up the timeout for this client.
631
 
        
632
 
        This should only be called when the client has been seen,
633
 
        alive and well.
634
 
        """
 
683
        return False
 
684
    
 
685
    def checked_ok(self):
 
686
        """Assert that the client has been seen, alive and well."""
 
687
        self.last_checked_ok = datetime.datetime.utcnow()
 
688
        self.last_checker_status = 0
 
689
        self.last_checker_signal = None
 
690
        self.bump_timeout()
 
691
    
 
692
    def bump_timeout(self, timeout=None):
 
693
        """Bump up the timeout for this client."""
635
694
        if timeout is None:
636
695
            timeout = self.timeout
637
 
        self.last_checked_ok = datetime.datetime.utcnow()
638
696
        if self.disable_initiator_tag is not None:
639
697
            gobject.source_remove(self.disable_initiator_tag)
 
698
            self.disable_initiator_tag = None
640
699
        if getattr(self, "enabled", False):
641
 
            self.disable_initiator_tag = (gobject.timeout_add
642
 
                                          (timedelta_to_milliseconds
643
 
                                           (timeout), self.disable))
 
700
            self.disable_initiator_tag = gobject.timeout_add(
 
701
                int(timeout.total_seconds() * 1000), self.disable)
644
702
            self.expires = datetime.datetime.utcnow() + timeout
645
703
    
646
704
    def need_approval(self):
652
710
        If a checker already exists, leave it running and do
653
711
        nothing."""
654
712
        # The reason for not killing a running checker is that if we
655
 
        # did that, then if a checker (for some reason) started
656
 
        # running slowly and taking more than 'interval' time, the
657
 
        # client would inevitably timeout, since no checker would get
658
 
        # a chance to run to completion.  If we instead leave running
 
713
        # did that, and if a checker (for some reason) started running
 
714
        # slowly and taking more than 'interval' time, then the client
 
715
        # would inevitably timeout, since no checker would get a
 
716
        # chance to run to completion.  If we instead leave running
659
717
        # checkers alone, the checker would have to take more time
660
718
        # than 'timeout' for the client to be disabled, which is as it
661
719
        # should be.
662
720
        
663
 
        # If a checker exists, make sure it is not a zombie
664
 
        try:
665
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
666
 
        except (AttributeError, OSError) as error:
667
 
            if (isinstance(error, OSError)
668
 
                and error.errno != errno.ECHILD):
669
 
                raise error
670
 
        else:
671
 
            if pid:
672
 
                logger.warning("Checker was a zombie")
673
 
                gobject.source_remove(self.checker_callback_tag)
674
 
                self.checker_callback(pid, status,
675
 
                                      self.current_checker_command)
 
721
        if self.checker is not None and not self.checker.is_alive():
 
722
            logger.warning("Checker was not alive; joining")
 
723
            self.checker.join()
 
724
            self.checker = None
676
725
        # Start a new checker if needed
677
726
        if self.checker is None:
 
727
            # Escape attributes for the shell
 
728
            escaped_attrs = {
 
729
                attr: re.escape(str(getattr(self, attr)))
 
730
                for attr in self.runtime_expansions }
678
731
            try:
679
 
                # In case checker_command has exactly one % operator
680
 
                command = self.checker_command % self.host
681
 
            except TypeError:
682
 
                # Escape attributes for the shell
683
 
                escaped_attrs = dict(
684
 
                    (attr,
685
 
                     re.escape(unicode(str(getattr(self, attr, "")),
686
 
                                       errors=
687
 
                                       'replace')))
688
 
                    for attr in
689
 
                    self.runtime_expansions)
690
 
                
691
 
                try:
692
 
                    command = self.checker_command % escaped_attrs
693
 
                except TypeError as error:
694
 
                    logger.error('Could not format string "%s":'
695
 
                                 ' %s', self.checker_command, error)
696
 
                    return True # Try again later
 
732
                command = self.checker_command % escaped_attrs
 
733
            except TypeError as error:
 
734
                logger.error('Could not format string "%s"',
 
735
                             self.checker_command,
 
736
                             exc_info=error)
 
737
                return True     # Try again later
697
738
            self.current_checker_command = command
698
 
            try:
699
 
                logger.info("Starting checker %r for %s",
700
 
                            command, self.name)
701
 
                # We don't need to redirect stdout and stderr, since
702
 
                # in normal mode, that is already done by daemon(),
703
 
                # and in debug mode we don't want to.  (Stdin is
704
 
                # always replaced by /dev/null.)
705
 
                self.checker = subprocess.Popen(command,
706
 
                                                close_fds=True,
707
 
                                                shell=True, cwd="/")
708
 
                self.checker_callback_tag = (gobject.child_watch_add
709
 
                                             (self.checker.pid,
710
 
                                              self.checker_callback,
711
 
                                              data=command))
712
 
                # The checker may have completed before the gobject
713
 
                # watch was added.  Check for this.
714
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
715
 
                if pid:
716
 
                    gobject.source_remove(self.checker_callback_tag)
717
 
                    self.checker_callback(pid, status, command)
718
 
            except OSError as error:
719
 
                logger.error("Failed to start subprocess: %s",
720
 
                             error)
 
739
            logger.info("Starting checker %r for %s", command,
 
740
                        self.name)
 
741
            # We don't need to redirect stdout and stderr, since
 
742
            # in normal mode, that is already done by daemon(),
 
743
            # and in debug mode we don't want to.  (Stdin is
 
744
            # always replaced by /dev/null.)
 
745
            # The exception is when not debugging but nevertheless
 
746
            # running in the foreground; use the previously
 
747
            # created wnull.
 
748
            popen_args = { "close_fds": True,
 
749
                           "shell": True,
 
750
                           "cwd": "/" }
 
751
            if (not self.server_settings["debug"]
 
752
                and self.server_settings["foreground"]):
 
753
                popen_args.update({"stdout": wnull,
 
754
                                   "stderr": wnull })
 
755
            pipe = multiprocessing.Pipe(duplex = False)
 
756
            self.checker = multiprocessing.Process(
 
757
                target = call_pipe,
 
758
                args = (pipe[1], subprocess.call, command),
 
759
                kwargs = popen_args)
 
760
            self.checker.start()
 
761
            self.checker_callback_tag = gobject.io_add_watch(
 
762
                pipe[0].fileno(), gobject.IO_IN,
 
763
                self.checker_callback, pipe[0], command)
721
764
        # Re-run this periodically if run by gobject.timeout_add
722
765
        return True
723
766
    
729
772
        if getattr(self, "checker", None) is None:
730
773
            return
731
774
        logger.debug("Stopping checker for %(name)s", vars(self))
732
 
        try:
733
 
            os.kill(self.checker.pid, signal.SIGTERM)
734
 
            #time.sleep(0.5)
735
 
            #if self.checker.poll() is None:
736
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
737
 
        except OSError as error:
738
 
            if error.errno != errno.ESRCH: # No such process
739
 
                raise
 
775
        self.checker.terminate()
740
776
        self.checker = None
741
777
 
742
778
 
743
 
def dbus_service_property(dbus_interface, signature="v",
744
 
                          access="readwrite", byte_arrays=False):
 
779
def dbus_service_property(dbus_interface,
 
780
                          signature="v",
 
781
                          access="readwrite",
 
782
                          byte_arrays=False):
745
783
    """Decorators for marking methods of a DBusObjectWithProperties to
746
784
    become properties on the D-Bus.
747
785
    
756
794
    # "Set" method, so we fail early here:
757
795
    if byte_arrays and signature != "ay":
758
796
        raise ValueError("Byte arrays not supported for non-'ay'"
759
 
                         " signature %r" % signature)
 
797
                         " signature {!r}".format(signature))
 
798
    
760
799
    def decorator(func):
761
800
        func._dbus_is_property = True
762
801
        func._dbus_interface = dbus_interface
767
806
            func._dbus_name = func._dbus_name[:-14]
768
807
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
769
808
        return func
 
809
    
 
810
    return decorator
 
811
 
 
812
 
 
813
def dbus_interface_annotations(dbus_interface):
 
814
    """Decorator for marking functions returning interface annotations
 
815
    
 
816
    Usage:
 
817
    
 
818
    @dbus_interface_annotations("org.example.Interface")
 
819
    def _foo(self):  # Function name does not matter
 
820
        return {"org.freedesktop.DBus.Deprecated": "true",
 
821
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
822
                    "false"}
 
823
    """
 
824
    
 
825
    def decorator(func):
 
826
        func._dbus_is_interface = True
 
827
        func._dbus_interface = dbus_interface
 
828
        func._dbus_name = dbus_interface
 
829
        return func
 
830
    
 
831
    return decorator
 
832
 
 
833
 
 
834
def dbus_annotations(annotations):
 
835
    """Decorator to annotate D-Bus methods, signals or properties
 
836
    Usage:
 
837
    
 
838
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
839
                       "org.freedesktop.DBus.Property."
 
840
                       "EmitsChangedSignal": "false"})
 
841
    @dbus_service_property("org.example.Interface", signature="b",
 
842
                           access="r")
 
843
    def Property_dbus_property(self):
 
844
        return dbus.Boolean(False)
 
845
    """
 
846
    
 
847
    def decorator(func):
 
848
        func._dbus_annotations = annotations
 
849
        return func
 
850
    
770
851
    return decorator
771
852
 
772
853
 
773
854
class DBusPropertyException(dbus.exceptions.DBusException):
774
855
    """A base class for D-Bus property-related exceptions
775
856
    """
776
 
    def __unicode__(self):
777
 
        return unicode(str(self))
 
857
    pass
778
858
 
779
859
 
780
860
class DBusPropertyAccessException(DBusPropertyException):
798
878
    """
799
879
    
800
880
    @staticmethod
801
 
    def _is_dbus_property(obj):
802
 
        return getattr(obj, "_dbus_is_property", False)
 
881
    def _is_dbus_thing(thing):
 
882
        """Returns a function testing if an attribute is a D-Bus thing
 
883
        
 
884
        If called like _is_dbus_thing("method") it returns a function
 
885
        suitable for use as predicate to inspect.getmembers().
 
886
        """
 
887
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
888
                                   False)
803
889
    
804
 
    def _get_all_dbus_properties(self):
 
890
    def _get_all_dbus_things(self, thing):
805
891
        """Returns a generator of (name, attribute) pairs
806
892
        """
807
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
893
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
894
                 athing.__get__(self))
808
895
                for cls in self.__class__.__mro__
809
 
                for name, prop in
810
 
                inspect.getmembers(cls, self._is_dbus_property))
 
896
                for name, athing in
 
897
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
811
898
    
812
899
    def _get_dbus_property(self, interface_name, property_name):
813
900
        """Returns a bound method if one exists which is a D-Bus
814
901
        property with the specified name and interface.
815
902
        """
816
 
        for cls in  self.__class__.__mro__:
817
 
            for name, value in (inspect.getmembers
818
 
                                (cls, self._is_dbus_property)):
 
903
        for cls in self.__class__.__mro__:
 
904
            for name, value in inspect.getmembers(
 
905
                    cls, self._is_dbus_thing("property")):
819
906
                if (value._dbus_name == property_name
820
907
                    and value._dbus_interface == interface_name):
821
908
                    return value.__get__(self)
822
909
        
823
910
        # No such property
824
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
825
 
                                   + interface_name + "."
826
 
                                   + property_name)
 
911
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
912
            self.dbus_object_path, interface_name, property_name))
827
913
    
828
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
914
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
915
                         in_signature="ss",
829
916
                         out_signature="v")
830
917
    def Get(self, interface_name, property_name):
831
918
        """Standard D-Bus property Get() method, see D-Bus standard.
849
936
            # The byte_arrays option is not supported yet on
850
937
            # signatures other than "ay".
851
938
            if prop._dbus_signature != "ay":
852
 
                raise ValueError
 
939
                raise ValueError("Byte arrays not supported for non-"
 
940
                                 "'ay' signature {!r}"
 
941
                                 .format(prop._dbus_signature))
853
942
            value = dbus.ByteArray(b''.join(chr(byte)
854
943
                                            for byte in value))
855
944
        prop(value)
856
945
    
857
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
946
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
947
                         in_signature="s",
858
948
                         out_signature="a{sv}")
859
949
    def GetAll(self, interface_name):
860
950
        """Standard D-Bus property GetAll() method, see D-Bus
863
953
        Note: Will not include properties with access="write".
864
954
        """
865
955
        properties = {}
866
 
        for name, prop in self._get_all_dbus_properties():
 
956
        for name, prop in self._get_all_dbus_things("property"):
867
957
            if (interface_name
868
958
                and interface_name != prop._dbus_interface):
869
959
                # Interface non-empty but did not match
875
965
            if not hasattr(value, "variant_level"):
876
966
                properties[name] = value
877
967
                continue
878
 
            properties[name] = type(value)(value, variant_level=
879
 
                                           value.variant_level+1)
 
968
            properties[name] = type(value)(
 
969
                value, variant_level = value.variant_level + 1)
880
970
        return dbus.Dictionary(properties, signature="sv")
881
971
    
 
972
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
973
    def PropertiesChanged(self, interface_name, changed_properties,
 
974
                          invalidated_properties):
 
975
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
976
        standard.
 
977
        """
 
978
        pass
 
979
    
882
980
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
883
981
                         out_signature="s",
884
982
                         path_keyword='object_path',
885
983
                         connection_keyword='connection')
886
984
    def Introspect(self, object_path, connection):
887
 
        """Standard D-Bus method, overloaded to insert property tags.
 
985
        """Overloading of standard D-Bus method.
 
986
        
 
987
        Inserts property tags and interface annotation tags.
888
988
        """
889
989
        xmlstring = dbus.service.Object.Introspect(self, object_path,
890
990
                                                   connection)
891
991
        try:
892
992
            document = xml.dom.minidom.parseString(xmlstring)
 
993
            
893
994
            def make_tag(document, name, prop):
894
995
                e = document.createElement("property")
895
996
                e.setAttribute("name", name)
896
997
                e.setAttribute("type", prop._dbus_signature)
897
998
                e.setAttribute("access", prop._dbus_access)
898
999
                return e
 
1000
            
899
1001
            for if_tag in document.getElementsByTagName("interface"):
 
1002
                # Add property tags
900
1003
                for tag in (make_tag(document, name, prop)
901
1004
                            for name, prop
902
 
                            in self._get_all_dbus_properties()
 
1005
                            in self._get_all_dbus_things("property")
903
1006
                            if prop._dbus_interface
904
1007
                            == if_tag.getAttribute("name")):
905
1008
                    if_tag.appendChild(tag)
 
1009
                # Add annotation tags
 
1010
                for typ in ("method", "signal", "property"):
 
1011
                    for tag in if_tag.getElementsByTagName(typ):
 
1012
                        annots = dict()
 
1013
                        for name, prop in (self.
 
1014
                                           _get_all_dbus_things(typ)):
 
1015
                            if (name == tag.getAttribute("name")
 
1016
                                and prop._dbus_interface
 
1017
                                == if_tag.getAttribute("name")):
 
1018
                                annots.update(getattr(
 
1019
                                    prop, "_dbus_annotations", {}))
 
1020
                        for name, value in annots.items():
 
1021
                            ann_tag = document.createElement(
 
1022
                                "annotation")
 
1023
                            ann_tag.setAttribute("name", name)
 
1024
                            ann_tag.setAttribute("value", value)
 
1025
                            tag.appendChild(ann_tag)
 
1026
                # Add interface annotation tags
 
1027
                for annotation, value in dict(
 
1028
                    itertools.chain.from_iterable(
 
1029
                        annotations().items()
 
1030
                        for name, annotations
 
1031
                        in self._get_all_dbus_things("interface")
 
1032
                        if name == if_tag.getAttribute("name")
 
1033
                        )).items():
 
1034
                    ann_tag = document.createElement("annotation")
 
1035
                    ann_tag.setAttribute("name", annotation)
 
1036
                    ann_tag.setAttribute("value", value)
 
1037
                    if_tag.appendChild(ann_tag)
906
1038
                # Add the names to the return values for the
907
1039
                # "org.freedesktop.DBus.Properties" methods
908
1040
                if (if_tag.getAttribute("name")
923
1055
        except (AttributeError, xml.dom.DOMException,
924
1056
                xml.parsers.expat.ExpatError) as error:
925
1057
            logger.error("Failed to override Introspection method",
926
 
                         error)
 
1058
                         exc_info=error)
927
1059
        return xmlstring
928
1060
 
929
1061
 
930
 
def datetime_to_dbus (dt, variant_level=0):
 
1062
def datetime_to_dbus(dt, variant_level=0):
931
1063
    """Convert a UTC datetime.datetime() to a D-Bus type."""
932
1064
    if dt is None:
933
1065
        return dbus.String("", variant_level = variant_level)
934
 
    return dbus.String(dt.isoformat(),
935
 
                       variant_level=variant_level)
936
 
 
937
 
 
938
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
939
 
                                  .__metaclass__):
940
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
941
 
    will add additional D-Bus attributes matching a certain pattern.
 
1066
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
1067
 
 
1068
 
 
1069
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1070
    """A class decorator; applied to a subclass of
 
1071
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1072
    interface names according to the "alt_interface_names" mapping.
 
1073
    Usage:
 
1074
    
 
1075
    @alternate_dbus_interfaces({"org.example.Interface":
 
1076
                                    "net.example.AlternateInterface"})
 
1077
    class SampleDBusObject(dbus.service.Object):
 
1078
        @dbus.service.method("org.example.Interface")
 
1079
        def SampleDBusMethod():
 
1080
            pass
 
1081
    
 
1082
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1083
    reachable via two interfaces: "org.example.Interface" and
 
1084
    "net.example.AlternateInterface", the latter of which will have
 
1085
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1086
    "true", unless "deprecate" is passed with a False value.
 
1087
    
 
1088
    This works for methods and signals, and also for D-Bus properties
 
1089
    (from DBusObjectWithProperties) and interfaces (from the
 
1090
    dbus_interface_annotations decorator).
942
1091
    """
943
 
    def __new__(mcs, name, bases, attr):
944
 
        # Go through all the base classes which could have D-Bus
945
 
        # methods, signals, or properties in them
946
 
        for base in (b for b in bases
947
 
                     if issubclass(b, dbus.service.Object)):
948
 
            # Go though all attributes of the base class
949
 
            for attrname, attribute in inspect.getmembers(base):
 
1092
    
 
1093
    def wrapper(cls):
 
1094
        for orig_interface_name, alt_interface_name in (
 
1095
                alt_interface_names.items()):
 
1096
            attr = {}
 
1097
            interface_names = set()
 
1098
            # Go though all attributes of the class
 
1099
            for attrname, attribute in inspect.getmembers(cls):
950
1100
                # Ignore non-D-Bus attributes, and D-Bus attributes
951
1101
                # with the wrong interface name
952
1102
                if (not hasattr(attribute, "_dbus_interface")
953
 
                    or not attribute._dbus_interface
954
 
                    .startswith("se.recompile.Mandos")):
 
1103
                    or not attribute._dbus_interface.startswith(
 
1104
                        orig_interface_name)):
955
1105
                    continue
956
1106
                # Create an alternate D-Bus interface name based on
957
1107
                # the current name
958
 
                alt_interface = (attribute._dbus_interface
959
 
                                 .replace("se.recompile.Mandos",
960
 
                                          "se.bsnet.fukt.Mandos"))
 
1108
                alt_interface = attribute._dbus_interface.replace(
 
1109
                    orig_interface_name, alt_interface_name)
 
1110
                interface_names.add(alt_interface)
961
1111
                # Is this a D-Bus signal?
962
1112
                if getattr(attribute, "_dbus_is_signal", False):
963
 
                    # Extract the original non-method function by
964
 
                    # black magic
965
 
                    nonmethod_func = (dict(
 
1113
                    if sys.version_info.major == 2:
 
1114
                        # Extract the original non-method undecorated
 
1115
                        # function by black magic
 
1116
                        nonmethod_func = (dict(
966
1117
                            zip(attribute.func_code.co_freevars,
967
 
                                attribute.__closure__))["func"]
968
 
                                      .cell_contents)
 
1118
                                attribute.__closure__))
 
1119
                                          ["func"].cell_contents)
 
1120
                    else:
 
1121
                        nonmethod_func = attribute
969
1122
                    # Create a new, but exactly alike, function
970
1123
                    # object, and decorate it to be a new D-Bus signal
971
1124
                    # with the alternate D-Bus interface name
972
 
                    new_function = (dbus.service.signal
973
 
                                    (alt_interface,
974
 
                                     attribute._dbus_signature)
975
 
                                    (types.FunctionType(
976
 
                                nonmethod_func.func_code,
977
 
                                nonmethod_func.func_globals,
978
 
                                nonmethod_func.func_name,
979
 
                                nonmethod_func.func_defaults,
980
 
                                nonmethod_func.func_closure)))
 
1125
                    if sys.version_info.major == 2:
 
1126
                        new_function = types.FunctionType(
 
1127
                            nonmethod_func.func_code,
 
1128
                            nonmethod_func.func_globals,
 
1129
                            nonmethod_func.func_name,
 
1130
                            nonmethod_func.func_defaults,
 
1131
                            nonmethod_func.func_closure)
 
1132
                    else:
 
1133
                        new_function = types.FunctionType(
 
1134
                            nonmethod_func.__code__,
 
1135
                            nonmethod_func.__globals__,
 
1136
                            nonmethod_func.__name__,
 
1137
                            nonmethod_func.__defaults__,
 
1138
                            nonmethod_func.__closure__)
 
1139
                    new_function = (dbus.service.signal(
 
1140
                        alt_interface,
 
1141
                        attribute._dbus_signature)(new_function))
 
1142
                    # Copy annotations, if any
 
1143
                    try:
 
1144
                        new_function._dbus_annotations = dict(
 
1145
                            attribute._dbus_annotations)
 
1146
                    except AttributeError:
 
1147
                        pass
981
1148
                    # Define a creator of a function to call both the
982
 
                    # old and new functions, so both the old and new
983
 
                    # signals gets sent when the function is called
 
1149
                    # original and alternate functions, so both the
 
1150
                    # original and alternate signals gets sent when
 
1151
                    # the function is called
984
1152
                    def fixscope(func1, func2):
985
1153
                        """This function is a scope container to pass
986
1154
                        func1 and func2 to the "call_both" function
987
1155
                        outside of its arguments"""
 
1156
                        
988
1157
                        def call_both(*args, **kwargs):
989
1158
                            """This function will emit two D-Bus
990
1159
                            signals by calling func1 and func2"""
991
1160
                            func1(*args, **kwargs)
992
1161
                            func2(*args, **kwargs)
 
1162
                        
993
1163
                        return call_both
994
1164
                    # Create the "call_both" function and add it to
995
1165
                    # the class
996
 
                    attr[attrname] = fixscope(attribute,
997
 
                                              new_function)
 
1166
                    attr[attrname] = fixscope(attribute, new_function)
998
1167
                # Is this a D-Bus method?
999
1168
                elif getattr(attribute, "_dbus_is_method", False):
1000
1169
                    # Create a new, but exactly alike, function
1001
1170
                    # object.  Decorate it to be a new D-Bus method
1002
1171
                    # with the alternate D-Bus interface name.  Add it
1003
1172
                    # to the class.
1004
 
                    attr[attrname] = (dbus.service.method
1005
 
                                      (alt_interface,
1006
 
                                       attribute._dbus_in_signature,
1007
 
                                       attribute._dbus_out_signature)
1008
 
                                      (types.FunctionType
1009
 
                                       (attribute.func_code,
1010
 
                                        attribute.func_globals,
1011
 
                                        attribute.func_name,
1012
 
                                        attribute.func_defaults,
1013
 
                                        attribute.func_closure)))
 
1173
                    attr[attrname] = (
 
1174
                        dbus.service.method(
 
1175
                            alt_interface,
 
1176
                            attribute._dbus_in_signature,
 
1177
                            attribute._dbus_out_signature)
 
1178
                        (types.FunctionType(attribute.func_code,
 
1179
                                            attribute.func_globals,
 
1180
                                            attribute.func_name,
 
1181
                                            attribute.func_defaults,
 
1182
                                            attribute.func_closure)))
 
1183
                    # Copy annotations, if any
 
1184
                    try:
 
1185
                        attr[attrname]._dbus_annotations = dict(
 
1186
                            attribute._dbus_annotations)
 
1187
                    except AttributeError:
 
1188
                        pass
1014
1189
                # Is this a D-Bus property?
1015
1190
                elif getattr(attribute, "_dbus_is_property", False):
1016
1191
                    # Create a new, but exactly alike, function
1017
1192
                    # object, and decorate it to be a new D-Bus
1018
1193
                    # property with the alternate D-Bus interface
1019
1194
                    # name.  Add it to the class.
1020
 
                    attr[attrname] = (dbus_service_property
1021
 
                                      (alt_interface,
1022
 
                                       attribute._dbus_signature,
1023
 
                                       attribute._dbus_access,
1024
 
                                       attribute
1025
 
                                       ._dbus_get_args_options
1026
 
                                       ["byte_arrays"])
1027
 
                                      (types.FunctionType
1028
 
                                       (attribute.func_code,
1029
 
                                        attribute.func_globals,
1030
 
                                        attribute.func_name,
1031
 
                                        attribute.func_defaults,
1032
 
                                        attribute.func_closure)))
1033
 
        return type.__new__(mcs, name, bases, attr)
1034
 
 
1035
 
 
 
1195
                    attr[attrname] = (dbus_service_property(
 
1196
                        alt_interface, attribute._dbus_signature,
 
1197
                        attribute._dbus_access,
 
1198
                        attribute._dbus_get_args_options
 
1199
                        ["byte_arrays"])
 
1200
                                      (types.FunctionType(
 
1201
                                          attribute.func_code,
 
1202
                                          attribute.func_globals,
 
1203
                                          attribute.func_name,
 
1204
                                          attribute.func_defaults,
 
1205
                                          attribute.func_closure)))
 
1206
                    # Copy annotations, if any
 
1207
                    try:
 
1208
                        attr[attrname]._dbus_annotations = dict(
 
1209
                            attribute._dbus_annotations)
 
1210
                    except AttributeError:
 
1211
                        pass
 
1212
                # Is this a D-Bus interface?
 
1213
                elif getattr(attribute, "_dbus_is_interface", False):
 
1214
                    # Create a new, but exactly alike, function
 
1215
                    # object.  Decorate it to be a new D-Bus interface
 
1216
                    # with the alternate D-Bus interface name.  Add it
 
1217
                    # to the class.
 
1218
                    attr[attrname] = (
 
1219
                        dbus_interface_annotations(alt_interface)
 
1220
                        (types.FunctionType(attribute.func_code,
 
1221
                                            attribute.func_globals,
 
1222
                                            attribute.func_name,
 
1223
                                            attribute.func_defaults,
 
1224
                                            attribute.func_closure)))
 
1225
            if deprecate:
 
1226
                # Deprecate all alternate interfaces
 
1227
                iname="_AlternateDBusNames_interface_annotation{}"
 
1228
                for interface_name in interface_names:
 
1229
                    
 
1230
                    @dbus_interface_annotations(interface_name)
 
1231
                    def func(self):
 
1232
                        return { "org.freedesktop.DBus.Deprecated":
 
1233
                                 "true" }
 
1234
                    # Find an unused name
 
1235
                    for aname in (iname.format(i)
 
1236
                                  for i in itertools.count()):
 
1237
                        if aname not in attr:
 
1238
                            attr[aname] = func
 
1239
                            break
 
1240
            if interface_names:
 
1241
                # Replace the class with a new subclass of it with
 
1242
                # methods, signals, etc. as created above.
 
1243
                cls = type(b"{}Alternate".format(cls.__name__),
 
1244
                           (cls, ), attr)
 
1245
        return cls
 
1246
    
 
1247
    return wrapper
 
1248
 
 
1249
 
 
1250
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1251
                            "se.bsnet.fukt.Mandos"})
1036
1252
class ClientDBus(Client, DBusObjectWithProperties):
1037
1253
    """A Client class using D-Bus
1038
1254
    
1042
1258
    """
1043
1259
    
1044
1260
    runtime_expansions = (Client.runtime_expansions
1045
 
                          + ("dbus_object_path",))
 
1261
                          + ("dbus_object_path", ))
 
1262
    
 
1263
    _interface = "se.recompile.Mandos.Client"
1046
1264
    
1047
1265
    # dbus.service.Object doesn't use super(), so we can't either.
1048
1266
    
1049
1267
    def __init__(self, bus = None, *args, **kwargs):
1050
1268
        self.bus = bus
1051
1269
        Client.__init__(self, *args, **kwargs)
1052
 
        self._approvals_pending = 0
1053
 
        
1054
 
        self._approvals_pending = 0
1055
1270
        # Only now, when this client is initialized, can it show up on
1056
1271
        # the D-Bus
1057
 
        client_object_name = unicode(self.name).translate(
 
1272
        client_object_name = str(self.name).translate(
1058
1273
            {ord("."): ord("_"),
1059
1274
             ord("-"): ord("_")})
1060
 
        self.dbus_object_path = (dbus.ObjectPath
1061
 
                                 ("/clients/" + client_object_name))
 
1275
        self.dbus_object_path = dbus.ObjectPath(
 
1276
            "/clients/" + client_object_name)
1062
1277
        DBusObjectWithProperties.__init__(self, self.bus,
1063
1278
                                          self.dbus_object_path)
1064
 
        
1065
 
    def notifychangeproperty(transform_func,
1066
 
                             dbus_name, type_func=lambda x: x,
1067
 
                             variant_level=1):
 
1279
    
 
1280
    def notifychangeproperty(transform_func, dbus_name,
 
1281
                             type_func=lambda x: x,
 
1282
                             variant_level=1,
 
1283
                             invalidate_only=False,
 
1284
                             _interface=_interface):
1068
1285
        """ Modify a variable so that it's a property which announces
1069
1286
        its changes to DBus.
1070
1287
        
1075
1292
                   to the D-Bus.  Default: no transform
1076
1293
        variant_level: D-Bus variant level.  Default: 1
1077
1294
        """
1078
 
        attrname = "_{0}".format(dbus_name)
 
1295
        attrname = "_{}".format(dbus_name)
 
1296
        
1079
1297
        def setter(self, value):
1080
1298
            if hasattr(self, "dbus_object_path"):
1081
1299
                if (not hasattr(self, attrname) or
1082
1300
                    type_func(getattr(self, attrname, None))
1083
1301
                    != type_func(value)):
1084
 
                    dbus_value = transform_func(type_func(value),
1085
 
                                                variant_level
1086
 
                                                =variant_level)
1087
 
                    self.PropertyChanged(dbus.String(dbus_name),
1088
 
                                         dbus_value)
 
1302
                    if invalidate_only:
 
1303
                        self.PropertiesChanged(
 
1304
                            _interface, dbus.Dictionary(),
 
1305
                            dbus.Array((dbus_name, )))
 
1306
                    else:
 
1307
                        dbus_value = transform_func(
 
1308
                            type_func(value),
 
1309
                            variant_level = variant_level)
 
1310
                        self.PropertyChanged(dbus.String(dbus_name),
 
1311
                                             dbus_value)
 
1312
                        self.PropertiesChanged(
 
1313
                            _interface,
 
1314
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1315
                                              dbus_value }),
 
1316
                            dbus.Array())
1089
1317
            setattr(self, attrname, value)
1090
1318
        
1091
1319
        return property(lambda self: getattr(self, attrname), setter)
1092
1320
    
1093
 
    
1094
1321
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1095
1322
    approvals_pending = notifychangeproperty(dbus.Boolean,
1096
1323
                                             "ApprovalPending",
1098
1325
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1099
1326
    last_enabled = notifychangeproperty(datetime_to_dbus,
1100
1327
                                        "LastEnabled")
1101
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1102
 
                                   type_func = lambda checker:
1103
 
                                       checker is not None)
 
1328
    checker = notifychangeproperty(
 
1329
        dbus.Boolean, "CheckerRunning",
 
1330
        type_func = lambda checker: checker is not None)
1104
1331
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1105
1332
                                           "LastCheckedOK")
 
1333
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1334
                                               "LastCheckerStatus")
1106
1335
    last_approval_request = notifychangeproperty(
1107
1336
        datetime_to_dbus, "LastApprovalRequest")
1108
1337
    approved_by_default = notifychangeproperty(dbus.Boolean,
1109
1338
                                               "ApprovedByDefault")
1110
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1111
 
                                          "ApprovalDelay",
1112
 
                                          type_func =
1113
 
                                          timedelta_to_milliseconds)
 
1339
    approval_delay = notifychangeproperty(
 
1340
        dbus.UInt64, "ApprovalDelay",
 
1341
        type_func = lambda td: td.total_seconds() * 1000)
1114
1342
    approval_duration = notifychangeproperty(
1115
1343
        dbus.UInt64, "ApprovalDuration",
1116
 
        type_func = timedelta_to_milliseconds)
 
1344
        type_func = lambda td: td.total_seconds() * 1000)
1117
1345
    host = notifychangeproperty(dbus.String, "Host")
1118
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1119
 
                                   type_func =
1120
 
                                   timedelta_to_milliseconds)
 
1346
    timeout = notifychangeproperty(
 
1347
        dbus.UInt64, "Timeout",
 
1348
        type_func = lambda td: td.total_seconds() * 1000)
1121
1349
    extended_timeout = notifychangeproperty(
1122
1350
        dbus.UInt64, "ExtendedTimeout",
1123
 
        type_func = timedelta_to_milliseconds)
1124
 
    interval = notifychangeproperty(dbus.UInt64,
1125
 
                                    "Interval",
1126
 
                                    type_func =
1127
 
                                    timedelta_to_milliseconds)
 
1351
        type_func = lambda td: td.total_seconds() * 1000)
 
1352
    interval = notifychangeproperty(
 
1353
        dbus.UInt64, "Interval",
 
1354
        type_func = lambda td: td.total_seconds() * 1000)
1128
1355
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1356
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1357
                                  invalidate_only=True)
1129
1358
    
1130
1359
    del notifychangeproperty
1131
1360
    
1138
1367
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1139
1368
        Client.__del__(self, *args, **kwargs)
1140
1369
    
1141
 
    def checker_callback(self, pid, condition, command,
1142
 
                         *args, **kwargs):
1143
 
        self.checker_callback_tag = None
1144
 
        self.checker = None
1145
 
        if os.WIFEXITED(condition):
1146
 
            exitstatus = os.WEXITSTATUS(condition)
 
1370
    def checker_callback(self, source, condition,
 
1371
                         connection, command, *args, **kwargs):
 
1372
        ret = Client.checker_callback(self, source, condition,
 
1373
                                      connection, command, *args,
 
1374
                                      **kwargs)
 
1375
        exitstatus = self.last_checker_status
 
1376
        if exitstatus >= 0:
1147
1377
            # Emit D-Bus signal
1148
1378
            self.CheckerCompleted(dbus.Int16(exitstatus),
1149
 
                                  dbus.Int64(condition),
 
1379
                                  dbus.Int64(0),
1150
1380
                                  dbus.String(command))
1151
1381
        else:
1152
1382
            # Emit D-Bus signal
1153
1383
            self.CheckerCompleted(dbus.Int16(-1),
1154
 
                                  dbus.Int64(condition),
 
1384
                                  dbus.Int64(
 
1385
                                      self.last_checker_signal),
1155
1386
                                  dbus.String(command))
1156
 
        
1157
 
        return Client.checker_callback(self, pid, condition, command,
1158
 
                                       *args, **kwargs)
 
1387
        return ret
1159
1388
    
1160
1389
    def start_checker(self, *args, **kwargs):
1161
 
        old_checker = self.checker
1162
 
        if self.checker is not None:
1163
 
            old_checker_pid = self.checker.pid
1164
 
        else:
1165
 
            old_checker_pid = None
 
1390
        old_checker_pid = getattr(self.checker, "pid", None)
1166
1391
        r = Client.start_checker(self, *args, **kwargs)
1167
1392
        # Only if new checker process was started
1168
1393
        if (self.checker is not None
1176
1401
        return False
1177
1402
    
1178
1403
    def approve(self, value=True):
1179
 
        self.send_changedstate()
1180
1404
        self.approved = value
1181
 
        gobject.timeout_add(timedelta_to_milliseconds
1182
 
                            (self.approval_duration),
1183
 
                            self._reset_approved)
1184
 
    
 
1405
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1406
                                * 1000), self._reset_approved)
 
1407
        self.send_changedstate()
1185
1408
    
1186
1409
    ## D-Bus methods, signals & properties
1187
 
    _interface = "se.recompile.Mandos.Client"
 
1410
    
 
1411
    ## Interfaces
1188
1412
    
1189
1413
    ## Signals
1190
1414
    
1201
1425
        pass
1202
1426
    
1203
1427
    # PropertyChanged - signal
 
1428
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1204
1429
    @dbus.service.signal(_interface, signature="sv")
1205
1430
    def PropertyChanged(self, property, value):
1206
1431
        "D-Bus signal"
1227
1452
        "D-Bus signal"
1228
1453
        return self.need_approval()
1229
1454
    
1230
 
    # NeRwequest - signal
1231
 
    @dbus.service.signal(_interface, signature="s")
1232
 
    def NewRequest(self, ip):
1233
 
        """D-Bus signal
1234
 
        Is sent after a client request a password.
1235
 
        """
1236
 
        pass
1237
 
    
1238
1455
    ## Methods
1239
1456
    
1240
1457
    # Approve - method
1278
1495
        return dbus.Boolean(bool(self.approvals_pending))
1279
1496
    
1280
1497
    # ApprovedByDefault - property
1281
 
    @dbus_service_property(_interface, signature="b",
 
1498
    @dbus_service_property(_interface,
 
1499
                           signature="b",
1282
1500
                           access="readwrite")
1283
1501
    def ApprovedByDefault_dbus_property(self, value=None):
1284
1502
        if value is None:       # get
1286
1504
        self.approved_by_default = bool(value)
1287
1505
    
1288
1506
    # ApprovalDelay - property
1289
 
    @dbus_service_property(_interface, signature="t",
 
1507
    @dbus_service_property(_interface,
 
1508
                           signature="t",
1290
1509
                           access="readwrite")
1291
1510
    def ApprovalDelay_dbus_property(self, value=None):
1292
1511
        if value is None:       # get
1293
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1512
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1513
                               * 1000)
1294
1514
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1295
1515
    
1296
1516
    # ApprovalDuration - property
1297
 
    @dbus_service_property(_interface, signature="t",
 
1517
    @dbus_service_property(_interface,
 
1518
                           signature="t",
1298
1519
                           access="readwrite")
1299
1520
    def ApprovalDuration_dbus_property(self, value=None):
1300
1521
        if value is None:       # get
1301
 
            return dbus.UInt64(timedelta_to_milliseconds(
1302
 
                    self.approval_duration))
 
1522
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1523
                               * 1000)
1303
1524
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1304
1525
    
1305
1526
    # Name - property
1313
1534
        return dbus.String(self.fingerprint)
1314
1535
    
1315
1536
    # Host - property
1316
 
    @dbus_service_property(_interface, signature="s",
 
1537
    @dbus_service_property(_interface,
 
1538
                           signature="s",
1317
1539
                           access="readwrite")
1318
1540
    def Host_dbus_property(self, value=None):
1319
1541
        if value is None:       # get
1320
1542
            return dbus.String(self.host)
1321
 
        self.host = unicode(value)
 
1543
        self.host = str(value)
1322
1544
    
1323
1545
    # Created - property
1324
1546
    @dbus_service_property(_interface, signature="s", access="read")
1331
1553
        return datetime_to_dbus(self.last_enabled)
1332
1554
    
1333
1555
    # Enabled - property
1334
 
    @dbus_service_property(_interface, signature="b",
 
1556
    @dbus_service_property(_interface,
 
1557
                           signature="b",
1335
1558
                           access="readwrite")
1336
1559
    def Enabled_dbus_property(self, value=None):
1337
1560
        if value is None:       # get
1342
1565
            self.disable()
1343
1566
    
1344
1567
    # LastCheckedOK - property
1345
 
    @dbus_service_property(_interface, signature="s",
 
1568
    @dbus_service_property(_interface,
 
1569
                           signature="s",
1346
1570
                           access="readwrite")
1347
1571
    def LastCheckedOK_dbus_property(self, value=None):
1348
1572
        if value is not None:
1350
1574
            return
1351
1575
        return datetime_to_dbus(self.last_checked_ok)
1352
1576
    
 
1577
    # LastCheckerStatus - property
 
1578
    @dbus_service_property(_interface, signature="n", access="read")
 
1579
    def LastCheckerStatus_dbus_property(self):
 
1580
        return dbus.Int16(self.last_checker_status)
 
1581
    
1353
1582
    # Expires - property
1354
1583
    @dbus_service_property(_interface, signature="s", access="read")
1355
1584
    def Expires_dbus_property(self):
1361
1590
        return datetime_to_dbus(self.last_approval_request)
1362
1591
    
1363
1592
    # Timeout - property
1364
 
    @dbus_service_property(_interface, signature="t",
 
1593
    @dbus_service_property(_interface,
 
1594
                           signature="t",
1365
1595
                           access="readwrite")
1366
1596
    def Timeout_dbus_property(self, value=None):
1367
1597
        if value is None:       # get
1368
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1598
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1599
        old_timeout = self.timeout
1369
1600
        self.timeout = datetime.timedelta(0, 0, 0, value)
1370
 
        # Reschedule timeout
 
1601
        # Reschedule disabling
1371
1602
        if self.enabled:
1372
1603
            now = datetime.datetime.utcnow()
1373
 
            time_to_die = timedelta_to_milliseconds(
1374
 
                (self.last_checked_ok + self.timeout) - now)
1375
 
            if time_to_die <= 0:
 
1604
            self.expires += self.timeout - old_timeout
 
1605
            if self.expires <= now:
1376
1606
                # The timeout has passed
1377
1607
                self.disable()
1378
1608
            else:
1379
 
                self.expires = (now +
1380
 
                                datetime.timedelta(milliseconds =
1381
 
                                                   time_to_die))
1382
1609
                if (getattr(self, "disable_initiator_tag", None)
1383
1610
                    is None):
1384
1611
                    return
1385
1612
                gobject.source_remove(self.disable_initiator_tag)
1386
 
                self.disable_initiator_tag = (gobject.timeout_add
1387
 
                                              (time_to_die,
1388
 
                                               self.disable))
 
1613
                self.disable_initiator_tag = gobject.timeout_add(
 
1614
                    int((self.expires - now).total_seconds() * 1000),
 
1615
                    self.disable)
1389
1616
    
1390
1617
    # ExtendedTimeout - property
1391
 
    @dbus_service_property(_interface, signature="t",
 
1618
    @dbus_service_property(_interface,
 
1619
                           signature="t",
1392
1620
                           access="readwrite")
1393
1621
    def ExtendedTimeout_dbus_property(self, value=None):
1394
1622
        if value is None:       # get
1395
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1623
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1624
                               * 1000)
1396
1625
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1397
1626
    
1398
1627
    # Interval - property
1399
 
    @dbus_service_property(_interface, signature="t",
 
1628
    @dbus_service_property(_interface,
 
1629
                           signature="t",
1400
1630
                           access="readwrite")
1401
1631
    def Interval_dbus_property(self, value=None):
1402
1632
        if value is None:       # get
1403
 
            return dbus.UInt64(self.interval_milliseconds())
 
1633
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1404
1634
        self.interval = datetime.timedelta(0, 0, 0, value)
1405
1635
        if getattr(self, "checker_initiator_tag", None) is None:
1406
1636
            return
1407
1637
        if self.enabled:
1408
1638
            # Reschedule checker run
1409
1639
            gobject.source_remove(self.checker_initiator_tag)
1410
 
            self.checker_initiator_tag = (gobject.timeout_add
1411
 
                                          (value, self.start_checker))
1412
 
            self.start_checker()    # Start one now, too
 
1640
            self.checker_initiator_tag = gobject.timeout_add(
 
1641
                value, self.start_checker)
 
1642
            self.start_checker() # Start one now, too
1413
1643
    
1414
1644
    # Checker - property
1415
 
    @dbus_service_property(_interface, signature="s",
 
1645
    @dbus_service_property(_interface,
 
1646
                           signature="s",
1416
1647
                           access="readwrite")
1417
1648
    def Checker_dbus_property(self, value=None):
1418
1649
        if value is None:       # get
1419
1650
            return dbus.String(self.checker_command)
1420
 
        self.checker_command = unicode(value)
 
1651
        self.checker_command = str(value)
1421
1652
    
1422
1653
    # CheckerRunning - property
1423
 
    @dbus_service_property(_interface, signature="b",
 
1654
    @dbus_service_property(_interface,
 
1655
                           signature="b",
1424
1656
                           access="readwrite")
1425
1657
    def CheckerRunning_dbus_property(self, value=None):
1426
1658
        if value is None:       # get
1436
1668
        return self.dbus_object_path # is already a dbus.ObjectPath
1437
1669
    
1438
1670
    # Secret = property
1439
 
    @dbus_service_property(_interface, signature="ay",
1440
 
                           access="write", byte_arrays=True)
 
1671
    @dbus_service_property(_interface,
 
1672
                           signature="ay",
 
1673
                           access="write",
 
1674
                           byte_arrays=True)
1441
1675
    def Secret_dbus_property(self, value):
1442
 
        self.secret = str(value)
 
1676
        self.secret = bytes(value)
1443
1677
    
1444
1678
    del _interface
1445
1679
 
1449
1683
        self._pipe = child_pipe
1450
1684
        self._pipe.send(('init', fpr, address))
1451
1685
        if not self._pipe.recv():
1452
 
            raise KeyError()
 
1686
            raise KeyError(fpr)
1453
1687
    
1454
1688
    def __getattribute__(self, name):
1455
1689
        if name == '_pipe':
1459
1693
        if data[0] == 'data':
1460
1694
            return data[1]
1461
1695
        if data[0] == 'function':
 
1696
            
1462
1697
            def func(*args, **kwargs):
1463
1698
                self._pipe.send(('funcall', name, args, kwargs))
1464
1699
                return self._pipe.recv()[1]
 
1700
            
1465
1701
            return func
1466
1702
    
1467
1703
    def __setattr__(self, name, value):
1470
1706
        self._pipe.send(('setattr', name, value))
1471
1707
 
1472
1708
 
1473
 
class ClientDBusTransitional(ClientDBus):
1474
 
    __metaclass__ = AlternateDBusNamesMetaclass
1475
 
 
1476
 
 
1477
1709
class ClientHandler(socketserver.BaseRequestHandler, object):
1478
1710
    """A class to handle client connections.
1479
1711
    
1483
1715
    def handle(self):
1484
1716
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1485
1717
            logger.info("TCP connection from: %s",
1486
 
                        unicode(self.client_address))
 
1718
                        str(self.client_address))
1487
1719
            logger.debug("Pipe FD: %d",
1488
1720
                         self.server.child_pipe.fileno())
1489
1721
            
1490
 
            session = (gnutls.connection
1491
 
                       .ClientSession(self.request,
1492
 
                                      gnutls.connection
1493
 
                                      .X509Credentials()))
 
1722
            session = gnutls.connection.ClientSession(
 
1723
                self.request, gnutls.connection .X509Credentials())
1494
1724
            
1495
1725
            # Note: gnutls.connection.X509Credentials is really a
1496
1726
            # generic GnuTLS certificate credentials object so long as
1505
1735
            priority = self.server.gnutls_priority
1506
1736
            if priority is None:
1507
1737
                priority = "NORMAL"
1508
 
            (gnutls.library.functions
1509
 
             .gnutls_priority_set_direct(session._c_object,
1510
 
                                         priority, None))
 
1738
            gnutls.library.functions.gnutls_priority_set_direct(
 
1739
                session._c_object, priority, None)
1511
1740
            
1512
1741
            # Start communication using the Mandos protocol
1513
1742
            # Get protocol number
1515
1744
            logger.debug("Protocol version: %r", line)
1516
1745
            try:
1517
1746
                if int(line.strip().split()[0]) > 1:
1518
 
                    raise RuntimeError
 
1747
                    raise RuntimeError(line)
1519
1748
            except (ValueError, IndexError, RuntimeError) as error:
1520
1749
                logger.error("Unknown protocol version: %s", error)
1521
1750
                return
1533
1762
            approval_required = False
1534
1763
            try:
1535
1764
                try:
1536
 
                    fpr = self.fingerprint(self.peer_certificate
1537
 
                                           (session))
 
1765
                    fpr = self.fingerprint(
 
1766
                        self.peer_certificate(session))
1538
1767
                except (TypeError,
1539
1768
                        gnutls.errors.GNUTLSError) as error:
1540
1769
                    logger.warning("Bad certificate: %s", error)
1547
1776
                except KeyError:
1548
1777
                    return
1549
1778
                
1550
 
                if self.server.use_dbus:
1551
 
                    # Emit D-Bus signal
1552
 
                    client.NewRequest(str(self.client_address))
1553
 
                
1554
1779
                if client.approval_delay:
1555
1780
                    delay = client.approval_delay
1556
1781
                    client.approvals_pending += 1
1559
1784
                while True:
1560
1785
                    if not client.enabled:
1561
1786
                        logger.info("Client %s is disabled",
1562
 
                                       client.name)
 
1787
                                    client.name)
1563
1788
                        if self.server.use_dbus:
1564
1789
                            # Emit D-Bus signal
1565
1790
                            client.Rejected("Disabled")
1574
1799
                        if self.server.use_dbus:
1575
1800
                            # Emit D-Bus signal
1576
1801
                            client.NeedApproval(
1577
 
                                client.approval_delay_milliseconds(),
1578
 
                                client.approved_by_default)
 
1802
                                client.approval_delay.total_seconds()
 
1803
                                * 1000, client.approved_by_default)
1579
1804
                    else:
1580
1805
                        logger.warning("Client %s was not approved",
1581
1806
                                       client.name)
1587
1812
                    #wait until timeout or approved
1588
1813
                    time = datetime.datetime.now()
1589
1814
                    client.changedstate.acquire()
1590
 
                    (client.changedstate.wait
1591
 
                     (float(client.timedelta_to_milliseconds(delay)
1592
 
                            / 1000)))
 
1815
                    client.changedstate.wait(delay.total_seconds())
1593
1816
                    client.changedstate.release()
1594
1817
                    time2 = datetime.datetime.now()
1595
1818
                    if (time2 - time) >= delay:
1611
1834
                    try:
1612
1835
                        sent = session.send(client.secret[sent_size:])
1613
1836
                    except gnutls.errors.GNUTLSError as error:
1614
 
                        logger.warning("gnutls send failed")
 
1837
                        logger.warning("gnutls send failed",
 
1838
                                       exc_info=error)
1615
1839
                        return
1616
 
                    logger.debug("Sent: %d, remaining: %d",
1617
 
                                 sent, len(client.secret)
1618
 
                                 - (sent_size + sent))
 
1840
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1841
                                 len(client.secret) - (sent_size
 
1842
                                                       + sent))
1619
1843
                    sent_size += sent
1620
1844
                
1621
1845
                logger.info("Sending secret to %s", client.name)
1622
1846
                # bump the timeout using extended_timeout
1623
 
                client.checked_ok(client.extended_timeout)
 
1847
                client.bump_timeout(client.extended_timeout)
1624
1848
                if self.server.use_dbus:
1625
1849
                    # Emit D-Bus signal
1626
1850
                    client.GotSecret()
1631
1855
                try:
1632
1856
                    session.bye()
1633
1857
                except gnutls.errors.GNUTLSError as error:
1634
 
                    logger.warning("GnuTLS bye failed")
 
1858
                    logger.warning("GnuTLS bye failed",
 
1859
                                   exc_info=error)
1635
1860
    
1636
1861
    @staticmethod
1637
1862
    def peer_certificate(session):
1638
1863
        "Return the peer's OpenPGP certificate as a bytestring"
1639
1864
        # If not an OpenPGP certificate...
1640
 
        if (gnutls.library.functions
1641
 
            .gnutls_certificate_type_get(session._c_object)
 
1865
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
1866
                session._c_object)
1642
1867
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1643
1868
            # ...do the normal thing
1644
1869
            return session.peer_certificate
1658
1883
    def fingerprint(openpgp):
1659
1884
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1660
1885
        # New GnuTLS "datum" with the OpenPGP public key
1661
 
        datum = (gnutls.library.types
1662
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1663
 
                                             ctypes.POINTER
1664
 
                                             (ctypes.c_ubyte)),
1665
 
                                 ctypes.c_uint(len(openpgp))))
 
1886
        datum = gnutls.library.types.gnutls_datum_t(
 
1887
            ctypes.cast(ctypes.c_char_p(openpgp),
 
1888
                        ctypes.POINTER(ctypes.c_ubyte)),
 
1889
            ctypes.c_uint(len(openpgp)))
1666
1890
        # New empty GnuTLS certificate
1667
1891
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1668
 
        (gnutls.library.functions
1669
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
1892
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
1893
            ctypes.byref(crt))
1670
1894
        # Import the OpenPGP public key into the certificate
1671
 
        (gnutls.library.functions
1672
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1673
 
                                    gnutls.library.constants
1674
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
1895
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
1896
            crt, ctypes.byref(datum),
 
1897
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1675
1898
        # Verify the self signature in the key
1676
1899
        crtverify = ctypes.c_uint()
1677
 
        (gnutls.library.functions
1678
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1679
 
                                         ctypes.byref(crtverify)))
 
1900
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
1901
            crt, 0, ctypes.byref(crtverify))
1680
1902
        if crtverify.value != 0:
1681
1903
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1682
 
            raise (gnutls.errors.CertificateSecurityError
1683
 
                   ("Verify failed"))
 
1904
            raise gnutls.errors.CertificateSecurityError(
 
1905
                "Verify failed")
1684
1906
        # New buffer for the fingerprint
1685
1907
        buf = ctypes.create_string_buffer(20)
1686
1908
        buf_len = ctypes.c_size_t()
1687
1909
        # Get the fingerprint from the certificate into the buffer
1688
 
        (gnutls.library.functions
1689
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1690
 
                                             ctypes.byref(buf_len)))
 
1910
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
1911
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1691
1912
        # Deinit the certificate
1692
1913
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1693
1914
        # Convert the buffer to a Python bytestring
1699
1920
 
1700
1921
class MultiprocessingMixIn(object):
1701
1922
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1923
    
1702
1924
    def sub_process_main(self, request, address):
1703
1925
        try:
1704
1926
            self.finish_request(request, address)
1709
1931
    def process_request(self, request, address):
1710
1932
        """Start a new process to process the request."""
1711
1933
        proc = multiprocessing.Process(target = self.sub_process_main,
1712
 
                                       args = (request,
1713
 
                                               address))
 
1934
                                       args = (request, address))
1714
1935
        proc.start()
1715
1936
        return proc
1716
1937
 
1717
1938
 
1718
1939
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1719
1940
    """ adds a pipe to the MixIn """
 
1941
    
1720
1942
    def process_request(self, request, client_address):
1721
1943
        """Overrides and wraps the original process_request().
1722
1944
        
1731
1953
    
1732
1954
    def add_pipe(self, parent_pipe, proc):
1733
1955
        """Dummy function; override as necessary"""
1734
 
        raise NotImplementedError
 
1956
        raise NotImplementedError()
1735
1957
 
1736
1958
 
1737
1959
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1743
1965
        interface:      None or a network interface name (string)
1744
1966
        use_ipv6:       Boolean; to use IPv6 or not
1745
1967
    """
 
1968
    
1746
1969
    def __init__(self, server_address, RequestHandlerClass,
1747
 
                 interface=None, use_ipv6=True):
 
1970
                 interface=None,
 
1971
                 use_ipv6=True,
 
1972
                 socketfd=None):
 
1973
        """If socketfd is set, use that file descriptor instead of
 
1974
        creating a new one with socket.socket().
 
1975
        """
1748
1976
        self.interface = interface
1749
1977
        if use_ipv6:
1750
1978
            self.address_family = socket.AF_INET6
 
1979
        if socketfd is not None:
 
1980
            # Save the file descriptor
 
1981
            self.socketfd = socketfd
 
1982
            # Save the original socket.socket() function
 
1983
            self.socket_socket = socket.socket
 
1984
            # To implement --socket, we monkey patch socket.socket.
 
1985
            # 
 
1986
            # (When socketserver.TCPServer is a new-style class, we
 
1987
            # could make self.socket into a property instead of monkey
 
1988
            # patching socket.socket.)
 
1989
            # 
 
1990
            # Create a one-time-only replacement for socket.socket()
 
1991
            @functools.wraps(socket.socket)
 
1992
            def socket_wrapper(*args, **kwargs):
 
1993
                # Restore original function so subsequent calls are
 
1994
                # not affected.
 
1995
                socket.socket = self.socket_socket
 
1996
                del self.socket_socket
 
1997
                # This time only, return a new socket object from the
 
1998
                # saved file descriptor.
 
1999
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
2000
            # Replace socket.socket() function with wrapper
 
2001
            socket.socket = socket_wrapper
 
2002
        # The socketserver.TCPServer.__init__ will call
 
2003
        # socket.socket(), which might be our replacement,
 
2004
        # socket_wrapper(), if socketfd was set.
1751
2005
        socketserver.TCPServer.__init__(self, server_address,
1752
2006
                                        RequestHandlerClass)
 
2007
    
1753
2008
    def server_bind(self):
1754
2009
        """This overrides the normal server_bind() function
1755
2010
        to bind to an interface if one was specified, and also NOT to
1761
2016
                             self.interface)
1762
2017
            else:
1763
2018
                try:
1764
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1765
 
                                           SO_BINDTODEVICE,
1766
 
                                           str(self.interface
1767
 
                                               + '\0'))
 
2019
                    self.socket.setsockopt(
 
2020
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2021
                        (self.interface + "\0").encode("utf-8"))
1768
2022
                except socket.error as error:
1769
 
                    if error[0] == errno.EPERM:
1770
 
                        logger.error("No permission to"
1771
 
                                     " bind to interface %s",
1772
 
                                     self.interface)
1773
 
                    elif error[0] == errno.ENOPROTOOPT:
 
2023
                    if error.errno == errno.EPERM:
 
2024
                        logger.error("No permission to bind to"
 
2025
                                     " interface %s", self.interface)
 
2026
                    elif error.errno == errno.ENOPROTOOPT:
1774
2027
                        logger.error("SO_BINDTODEVICE not available;"
1775
2028
                                     " cannot bind to interface %s",
1776
2029
                                     self.interface)
 
2030
                    elif error.errno == errno.ENODEV:
 
2031
                        logger.error("Interface %s does not exist,"
 
2032
                                     " cannot bind", self.interface)
1777
2033
                    else:
1778
2034
                        raise
1779
2035
        # Only bind(2) the socket if we really need to.
1782
2038
                if self.address_family == socket.AF_INET6:
1783
2039
                    any_address = "::" # in6addr_any
1784
2040
                else:
1785
 
                    any_address = socket.INADDR_ANY
 
2041
                    any_address = "0.0.0.0" # INADDR_ANY
1786
2042
                self.server_address = (any_address,
1787
2043
                                       self.server_address[1])
1788
2044
            elif not self.server_address[1]:
1789
 
                self.server_address = (self.server_address[0],
1790
 
                                       0)
 
2045
                self.server_address = (self.server_address[0], 0)
1791
2046
#                 if self.interface:
1792
2047
#                     self.server_address = (self.server_address[0],
1793
2048
#                                            0, # port
1807
2062
    
1808
2063
    Assumes a gobject.MainLoop event loop.
1809
2064
    """
 
2065
    
1810
2066
    def __init__(self, server_address, RequestHandlerClass,
1811
 
                 interface=None, use_ipv6=True, clients=None,
1812
 
                 gnutls_priority=None, use_dbus=True):
 
2067
                 interface=None,
 
2068
                 use_ipv6=True,
 
2069
                 clients=None,
 
2070
                 gnutls_priority=None,
 
2071
                 use_dbus=True,
 
2072
                 socketfd=None):
1813
2073
        self.enabled = False
1814
2074
        self.clients = clients
1815
2075
        if self.clients is None:
1819
2079
        IPv6_TCPServer.__init__(self, server_address,
1820
2080
                                RequestHandlerClass,
1821
2081
                                interface = interface,
1822
 
                                use_ipv6 = use_ipv6)
 
2082
                                use_ipv6 = use_ipv6,
 
2083
                                socketfd = socketfd)
 
2084
    
1823
2085
    def server_activate(self):
1824
2086
        if self.enabled:
1825
2087
            return socketserver.TCPServer.server_activate(self)
1829
2091
    
1830
2092
    def add_pipe(self, parent_pipe, proc):
1831
2093
        # Call "handle_ipc" for both data and EOF events
1832
 
        gobject.io_add_watch(parent_pipe.fileno(),
1833
 
                             gobject.IO_IN | gobject.IO_HUP,
1834
 
                             functools.partial(self.handle_ipc,
1835
 
                                               parent_pipe =
1836
 
                                               parent_pipe,
1837
 
                                               proc = proc))
 
2094
        gobject.io_add_watch(
 
2095
            parent_pipe.fileno(),
 
2096
            gobject.IO_IN | gobject.IO_HUP,
 
2097
            functools.partial(self.handle_ipc,
 
2098
                              parent_pipe = parent_pipe,
 
2099
                              proc = proc))
1838
2100
    
1839
 
    def handle_ipc(self, source, condition, parent_pipe=None,
1840
 
                   proc = None, client_object=None):
1841
 
        condition_names = {
1842
 
            gobject.IO_IN: "IN",   # There is data to read.
1843
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1844
 
                                    # blocking).
1845
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1846
 
            gobject.IO_ERR: "ERR", # Error condition.
1847
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1848
 
                                    # broken, usually for pipes and
1849
 
                                    # sockets).
1850
 
            }
1851
 
        conditions_string = ' | '.join(name
1852
 
                                       for cond, name in
1853
 
                                       condition_names.iteritems()
1854
 
                                       if cond & condition)
 
2101
    def handle_ipc(self, source, condition,
 
2102
                   parent_pipe=None,
 
2103
                   proc = None,
 
2104
                   client_object=None):
1855
2105
        # error, or the other end of multiprocessing.Pipe has closed
1856
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2106
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1857
2107
            # Wait for other process to exit
1858
2108
            proc.join()
1859
2109
            return False
1880
2130
                parent_pipe.send(False)
1881
2131
                return False
1882
2132
            
1883
 
            gobject.io_add_watch(parent_pipe.fileno(),
1884
 
                                 gobject.IO_IN | gobject.IO_HUP,
1885
 
                                 functools.partial(self.handle_ipc,
1886
 
                                                   parent_pipe =
1887
 
                                                   parent_pipe,
1888
 
                                                   proc = proc,
1889
 
                                                   client_object =
1890
 
                                                   client))
 
2133
            gobject.io_add_watch(
 
2134
                parent_pipe.fileno(),
 
2135
                gobject.IO_IN | gobject.IO_HUP,
 
2136
                functools.partial(self.handle_ipc,
 
2137
                                  parent_pipe = parent_pipe,
 
2138
                                  proc = proc,
 
2139
                                  client_object = client))
1891
2140
            parent_pipe.send(True)
1892
2141
            # remove the old hook in favor of the new above hook on
1893
2142
            # same fileno
1899
2148
            
1900
2149
            parent_pipe.send(('data', getattr(client_object,
1901
2150
                                              funcname)(*args,
1902
 
                                                         **kwargs)))
 
2151
                                                        **kwargs)))
1903
2152
        
1904
2153
        if command == 'getattr':
1905
2154
            attrname = request[1]
1906
 
            if callable(client_object.__getattribute__(attrname)):
1907
 
                parent_pipe.send(('function',))
 
2155
            if isinstance(client_object.__getattribute__(attrname),
 
2156
                          collections.Callable):
 
2157
                parent_pipe.send(('function', ))
1908
2158
            else:
1909
 
                parent_pipe.send(('data', client_object
1910
 
                                  .__getattribute__(attrname)))
 
2159
                parent_pipe.send((
 
2160
                    'data', client_object.__getattribute__(attrname)))
1911
2161
        
1912
2162
        if command == 'setattr':
1913
2163
            attrname = request[1]
1917
2167
        return True
1918
2168
 
1919
2169
 
 
2170
def rfc3339_duration_to_delta(duration):
 
2171
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2172
    
 
2173
    >>> rfc3339_duration_to_delta("P7D")
 
2174
    datetime.timedelta(7)
 
2175
    >>> rfc3339_duration_to_delta("PT60S")
 
2176
    datetime.timedelta(0, 60)
 
2177
    >>> rfc3339_duration_to_delta("PT60M")
 
2178
    datetime.timedelta(0, 3600)
 
2179
    >>> rfc3339_duration_to_delta("PT24H")
 
2180
    datetime.timedelta(1)
 
2181
    >>> rfc3339_duration_to_delta("P1W")
 
2182
    datetime.timedelta(7)
 
2183
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2184
    datetime.timedelta(0, 330)
 
2185
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2186
    datetime.timedelta(1, 200)
 
2187
    """
 
2188
    
 
2189
    # Parsing an RFC 3339 duration with regular expressions is not
 
2190
    # possible - there would have to be multiple places for the same
 
2191
    # values, like seconds.  The current code, while more esoteric, is
 
2192
    # cleaner without depending on a parsing library.  If Python had a
 
2193
    # built-in library for parsing we would use it, but we'd like to
 
2194
    # avoid excessive use of external libraries.
 
2195
    
 
2196
    # New type for defining tokens, syntax, and semantics all-in-one
 
2197
    Token = collections.namedtuple("Token", (
 
2198
        "regexp",  # To match token; if "value" is not None, must have
 
2199
                   # a "group" containing digits
 
2200
        "value",   # datetime.timedelta or None
 
2201
        "followers"))           # Tokens valid after this token
 
2202
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2203
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2204
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2205
    token_second = Token(re.compile(r"(\d+)S"),
 
2206
                         datetime.timedelta(seconds=1),
 
2207
                         frozenset((token_end, )))
 
2208
    token_minute = Token(re.compile(r"(\d+)M"),
 
2209
                         datetime.timedelta(minutes=1),
 
2210
                         frozenset((token_second, token_end)))
 
2211
    token_hour = Token(re.compile(r"(\d+)H"),
 
2212
                       datetime.timedelta(hours=1),
 
2213
                       frozenset((token_minute, token_end)))
 
2214
    token_time = Token(re.compile(r"T"),
 
2215
                       None,
 
2216
                       frozenset((token_hour, token_minute,
 
2217
                                  token_second)))
 
2218
    token_day = Token(re.compile(r"(\d+)D"),
 
2219
                      datetime.timedelta(days=1),
 
2220
                      frozenset((token_time, token_end)))
 
2221
    token_month = Token(re.compile(r"(\d+)M"),
 
2222
                        datetime.timedelta(weeks=4),
 
2223
                        frozenset((token_day, token_end)))
 
2224
    token_year = Token(re.compile(r"(\d+)Y"),
 
2225
                       datetime.timedelta(weeks=52),
 
2226
                       frozenset((token_month, token_end)))
 
2227
    token_week = Token(re.compile(r"(\d+)W"),
 
2228
                       datetime.timedelta(weeks=1),
 
2229
                       frozenset((token_end, )))
 
2230
    token_duration = Token(re.compile(r"P"), None,
 
2231
                           frozenset((token_year, token_month,
 
2232
                                      token_day, token_time,
 
2233
                                      token_week)))
 
2234
    # Define starting values
 
2235
    value = datetime.timedelta() # Value so far
 
2236
    found_token = None
 
2237
    followers = frozenset((token_duration, )) # Following valid tokens
 
2238
    s = duration                # String left to parse
 
2239
    # Loop until end token is found
 
2240
    while found_token is not token_end:
 
2241
        # Search for any currently valid tokens
 
2242
        for token in followers:
 
2243
            match = token.regexp.match(s)
 
2244
            if match is not None:
 
2245
                # Token found
 
2246
                if token.value is not None:
 
2247
                    # Value found, parse digits
 
2248
                    factor = int(match.group(1), 10)
 
2249
                    # Add to value so far
 
2250
                    value += factor * token.value
 
2251
                # Strip token from string
 
2252
                s = token.regexp.sub("", s, 1)
 
2253
                # Go to found token
 
2254
                found_token = token
 
2255
                # Set valid next tokens
 
2256
                followers = found_token.followers
 
2257
                break
 
2258
        else:
 
2259
            # No currently valid tokens were found
 
2260
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2261
                             .format(duration))
 
2262
    # End token found
 
2263
    return value
 
2264
 
 
2265
 
1920
2266
def string_to_delta(interval):
1921
2267
    """Parse a string and return a datetime.timedelta
1922
2268
    
1933
2279
    >>> string_to_delta('5m 30s')
1934
2280
    datetime.timedelta(0, 330)
1935
2281
    """
 
2282
    
 
2283
    try:
 
2284
        return rfc3339_duration_to_delta(interval)
 
2285
    except ValueError:
 
2286
        pass
 
2287
    
1936
2288
    timevalue = datetime.timedelta(0)
1937
2289
    for s in interval.split():
1938
2290
        try:
1939
 
            suffix = unicode(s[-1])
 
2291
            suffix = s[-1]
1940
2292
            value = int(s[:-1])
1941
2293
            if suffix == "d":
1942
2294
                delta = datetime.timedelta(value)
1949
2301
            elif suffix == "w":
1950
2302
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1951
2303
            else:
1952
 
                raise ValueError("Unknown suffix %r" % suffix)
1953
 
        except (ValueError, IndexError) as e:
 
2304
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2305
        except IndexError as e:
1954
2306
            raise ValueError(*(e.args))
1955
2307
        timevalue += delta
1956
2308
    return timevalue
1969
2321
        sys.exit()
1970
2322
    if not noclose:
1971
2323
        # Close all standard open file descriptors
1972
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2324
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1973
2325
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1974
2326
            raise OSError(errno.ENODEV,
1975
 
                          "%s not a character device"
1976
 
                          % os.path.devnull)
 
2327
                          "{} not a character device"
 
2328
                          .format(os.devnull))
1977
2329
        os.dup2(null, sys.stdin.fileno())
1978
2330
        os.dup2(null, sys.stdout.fileno())
1979
2331
        os.dup2(null, sys.stderr.fileno())
1988
2340
    
1989
2341
    parser = argparse.ArgumentParser()
1990
2342
    parser.add_argument("-v", "--version", action="version",
1991
 
                        version = "%%(prog)s %s" % version,
 
2343
                        version = "%(prog)s {}".format(version),
1992
2344
                        help="show version number and exit")
1993
2345
    parser.add_argument("-i", "--interface", metavar="IF",
1994
2346
                        help="Bind to interface IF")
2000
2352
                        help="Run self-test")
2001
2353
    parser.add_argument("--debug", action="store_true",
2002
2354
                        help="Debug mode; run in foreground and log"
2003
 
                        " to terminal")
 
2355
                        " to terminal", default=None)
2004
2356
    parser.add_argument("--debuglevel", metavar="LEVEL",
2005
2357
                        help="Debug level for stdout output")
2006
2358
    parser.add_argument("--priority", help="GnuTLS"
2013
2365
                        " files")
2014
2366
    parser.add_argument("--no-dbus", action="store_false",
2015
2367
                        dest="use_dbus", help="Do not provide D-Bus"
2016
 
                        " system bus interface")
 
2368
                        " system bus interface", default=None)
2017
2369
    parser.add_argument("--no-ipv6", action="store_false",
2018
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2370
                        dest="use_ipv6", help="Do not use IPv6",
 
2371
                        default=None)
2019
2372
    parser.add_argument("--no-restore", action="store_false",
2020
2373
                        dest="restore", help="Do not restore stored"
2021
 
                        " state")
 
2374
                        " state", default=None)
 
2375
    parser.add_argument("--socket", type=int,
 
2376
                        help="Specify a file descriptor to a network"
 
2377
                        " socket to use instead of creating one")
2022
2378
    parser.add_argument("--statedir", metavar="DIR",
2023
2379
                        help="Directory to save/restore state in")
 
2380
    parser.add_argument("--foreground", action="store_true",
 
2381
                        help="Run in foreground", default=None)
 
2382
    parser.add_argument("--no-zeroconf", action="store_false",
 
2383
                        dest="zeroconf", help="Do not use Zeroconf",
 
2384
                        default=None)
2024
2385
    
2025
2386
    options = parser.parse_args()
2026
2387
    
2027
2388
    if options.check:
2028
2389
        import doctest
2029
 
        doctest.testmod()
2030
 
        sys.exit()
 
2390
        fail_count, test_count = doctest.testmod()
 
2391
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2031
2392
    
2032
2393
    # Default values for config file for server-global settings
2033
2394
    server_defaults = { "interface": "",
2035
2396
                        "port": "",
2036
2397
                        "debug": "False",
2037
2398
                        "priority":
2038
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2399
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2400
                        ":+SIGN-DSA-SHA256",
2039
2401
                        "servicename": "Mandos",
2040
2402
                        "use_dbus": "True",
2041
2403
                        "use_ipv6": "True",
2042
2404
                        "debuglevel": "",
2043
2405
                        "restore": "True",
2044
 
                        "statedir": "/var/lib/mandos"
2045
 
                        }
 
2406
                        "socket": "",
 
2407
                        "statedir": "/var/lib/mandos",
 
2408
                        "foreground": "False",
 
2409
                        "zeroconf": "True",
 
2410
                    }
2046
2411
    
2047
2412
    # Parse config file for server-global settings
2048
2413
    server_config = configparser.SafeConfigParser(server_defaults)
2049
2414
    del server_defaults
2050
 
    server_config.read(os.path.join(options.configdir,
2051
 
                                    "mandos.conf"))
 
2415
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2052
2416
    # Convert the SafeConfigParser object to a dict
2053
2417
    server_settings = server_config.defaults()
2054
2418
    # Use the appropriate methods on the non-string config options
2055
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2419
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2056
2420
        server_settings[option] = server_config.getboolean("DEFAULT",
2057
2421
                                                           option)
2058
2422
    if server_settings["port"]:
2059
2423
        server_settings["port"] = server_config.getint("DEFAULT",
2060
2424
                                                       "port")
 
2425
    if server_settings["socket"]:
 
2426
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2427
                                                         "socket")
 
2428
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2429
        # over with an opened os.devnull.  But we don't want this to
 
2430
        # happen with a supplied network socket.
 
2431
        if 0 <= server_settings["socket"] <= 2:
 
2432
            server_settings["socket"] = os.dup(server_settings
 
2433
                                               ["socket"])
2061
2434
    del server_config
2062
2435
    
2063
2436
    # Override the settings from the config file with command line
2064
2437
    # options, if set.
2065
2438
    for option in ("interface", "address", "port", "debug",
2066
 
                   "priority", "servicename", "configdir",
2067
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2068
 
                   "statedir"):
 
2439
                   "priority", "servicename", "configdir", "use_dbus",
 
2440
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2441
                   "socket", "foreground", "zeroconf"):
2069
2442
        value = getattr(options, option)
2070
2443
        if value is not None:
2071
2444
            server_settings[option] = value
2072
2445
    del options
2073
2446
    # Force all strings to be unicode
2074
2447
    for option in server_settings.keys():
2075
 
        if type(server_settings[option]) is str:
2076
 
            server_settings[option] = unicode(server_settings[option])
 
2448
        if isinstance(server_settings[option], bytes):
 
2449
            server_settings[option] = (server_settings[option]
 
2450
                                       .decode("utf-8"))
 
2451
    # Force all boolean options to be boolean
 
2452
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2453
                   "foreground", "zeroconf"):
 
2454
        server_settings[option] = bool(server_settings[option])
 
2455
    # Debug implies foreground
 
2456
    if server_settings["debug"]:
 
2457
        server_settings["foreground"] = True
2077
2458
    # Now we have our good server settings in "server_settings"
2078
2459
    
2079
2460
    ##################################################################
2080
2461
    
 
2462
    if (not server_settings["zeroconf"]
 
2463
        and not (server_settings["port"]
 
2464
                 or server_settings["socket"] != "")):
 
2465
        parser.error("Needs port or socket to work without Zeroconf")
 
2466
    
2081
2467
    # For convenience
2082
2468
    debug = server_settings["debug"]
2083
2469
    debuglevel = server_settings["debuglevel"]
2085
2471
    use_ipv6 = server_settings["use_ipv6"]
2086
2472
    stored_state_path = os.path.join(server_settings["statedir"],
2087
2473
                                     stored_state_file)
 
2474
    foreground = server_settings["foreground"]
 
2475
    zeroconf = server_settings["zeroconf"]
2088
2476
    
2089
2477
    if debug:
2090
2478
        initlogger(debug, logging.DEBUG)
2096
2484
            initlogger(debug, level)
2097
2485
    
2098
2486
    if server_settings["servicename"] != "Mandos":
2099
 
        syslogger.setFormatter(logging.Formatter
2100
 
                               ('Mandos (%s) [%%(process)d]:'
2101
 
                                ' %%(levelname)s: %%(message)s'
2102
 
                                % server_settings["servicename"]))
 
2487
        syslogger.setFormatter(
 
2488
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2489
                              ' %(levelname)s: %(message)s'.format(
 
2490
                                  server_settings["servicename"])))
2103
2491
    
2104
2492
    # Parse config file with clients
2105
2493
    client_config = configparser.SafeConfigParser(Client
2110
2498
    global mandos_dbus_service
2111
2499
    mandos_dbus_service = None
2112
2500
    
2113
 
    tcp_server = MandosServer((server_settings["address"],
2114
 
                               server_settings["port"]),
2115
 
                              ClientHandler,
2116
 
                              interface=(server_settings["interface"]
2117
 
                                         or None),
2118
 
                              use_ipv6=use_ipv6,
2119
 
                              gnutls_priority=
2120
 
                              server_settings["priority"],
2121
 
                              use_dbus=use_dbus)
2122
 
    if not debug:
2123
 
        pidfilename = "/var/run/mandos.pid"
 
2501
    socketfd = None
 
2502
    if server_settings["socket"] != "":
 
2503
        socketfd = server_settings["socket"]
 
2504
    tcp_server = MandosServer(
 
2505
        (server_settings["address"], server_settings["port"]),
 
2506
        ClientHandler,
 
2507
        interface=(server_settings["interface"] or None),
 
2508
        use_ipv6=use_ipv6,
 
2509
        gnutls_priority=server_settings["priority"],
 
2510
        use_dbus=use_dbus,
 
2511
        socketfd=socketfd)
 
2512
    if not foreground:
 
2513
        pidfilename = "/run/mandos.pid"
 
2514
        if not os.path.isdir("/run/."):
 
2515
            pidfilename = "/var/run/mandos.pid"
 
2516
        pidfile = None
2124
2517
        try:
2125
 
            pidfile = open(pidfilename, "w")
2126
 
        except IOError:
2127
 
            logger.error("Could not open file %r", pidfilename)
 
2518
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2519
        except IOError as e:
 
2520
            logger.error("Could not open file %r", pidfilename,
 
2521
                         exc_info=e)
2128
2522
    
2129
 
    try:
2130
 
        uid = pwd.getpwnam("_mandos").pw_uid
2131
 
        gid = pwd.getpwnam("_mandos").pw_gid
2132
 
    except KeyError:
 
2523
    for name in ("_mandos", "mandos", "nobody"):
2133
2524
        try:
2134
 
            uid = pwd.getpwnam("mandos").pw_uid
2135
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2525
            uid = pwd.getpwnam(name).pw_uid
 
2526
            gid = pwd.getpwnam(name).pw_gid
 
2527
            break
2136
2528
        except KeyError:
2137
 
            try:
2138
 
                uid = pwd.getpwnam("nobody").pw_uid
2139
 
                gid = pwd.getpwnam("nobody").pw_gid
2140
 
            except KeyError:
2141
 
                uid = 65534
2142
 
                gid = 65534
 
2529
            continue
 
2530
    else:
 
2531
        uid = 65534
 
2532
        gid = 65534
2143
2533
    try:
2144
2534
        os.setgid(gid)
2145
2535
        os.setuid(uid)
2146
2536
    except OSError as error:
2147
 
        if error[0] != errno.EPERM:
2148
 
            raise error
 
2537
        if error.errno != errno.EPERM:
 
2538
            raise
2149
2539
    
2150
2540
    if debug:
2151
2541
        # Enable all possible GnuTLS debugging
2158
2548
        def debug_gnutls(level, string):
2159
2549
            logger.debug("GnuTLS: %s", string[:-1])
2160
2550
        
2161
 
        (gnutls.library.functions
2162
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2551
        gnutls.library.functions.gnutls_global_set_log_function(
 
2552
            debug_gnutls)
2163
2553
        
2164
2554
        # Redirect stdin so all checkers get /dev/null
2165
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2555
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2166
2556
        os.dup2(null, sys.stdin.fileno())
2167
2557
        if null > 2:
2168
2558
            os.close(null)
2169
2559
    
2170
2560
    # Need to fork before connecting to D-Bus
2171
 
    if not debug:
 
2561
    if not foreground:
2172
2562
        # Close all input and output, do double fork, etc.
2173
2563
        daemon()
2174
2564
    
 
2565
    # multiprocessing will use threads, so before we use gobject we
 
2566
    # need to inform gobject that threads will be used.
2175
2567
    gobject.threads_init()
2176
2568
    
2177
2569
    global main_loop
2178
2570
    # From the Avahi example code
2179
 
    DBusGMainLoop(set_as_default=True )
 
2571
    DBusGMainLoop(set_as_default=True)
2180
2572
    main_loop = gobject.MainLoop()
2181
2573
    bus = dbus.SystemBus()
2182
2574
    # End of Avahi example code
2183
2575
    if use_dbus:
2184
2576
        try:
2185
2577
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2186
 
                                            bus, do_not_queue=True)
2187
 
            old_bus_name = (dbus.service.BusName
2188
 
                            ("se.bsnet.fukt.Mandos", bus,
2189
 
                             do_not_queue=True))
2190
 
        except dbus.exceptions.NameExistsException as e:
2191
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2578
                                            bus,
 
2579
                                            do_not_queue=True)
 
2580
            old_bus_name = dbus.service.BusName(
 
2581
                "se.bsnet.fukt.Mandos", bus,
 
2582
                do_not_queue=True)
 
2583
        except dbus.exceptions.DBusException as e:
 
2584
            logger.error("Disabling D-Bus:", exc_info=e)
2192
2585
            use_dbus = False
2193
2586
            server_settings["use_dbus"] = False
2194
2587
            tcp_server.use_dbus = False
2195
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2196
 
    service = AvahiServiceToSyslog(name =
2197
 
                                   server_settings["servicename"],
2198
 
                                   servicetype = "_mandos._tcp",
2199
 
                                   protocol = protocol, bus = bus)
2200
 
    if server_settings["interface"]:
2201
 
        service.interface = (if_nametoindex
2202
 
                             (str(server_settings["interface"])))
 
2588
    if zeroconf:
 
2589
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2590
        service = AvahiServiceToSyslog(
 
2591
            name = server_settings["servicename"],
 
2592
            servicetype = "_mandos._tcp",
 
2593
            protocol = protocol,
 
2594
            bus = bus)
 
2595
        if server_settings["interface"]:
 
2596
            service.interface = if_nametoindex(
 
2597
                server_settings["interface"].encode("utf-8"))
2203
2598
    
2204
2599
    global multiprocessing_manager
2205
2600
    multiprocessing_manager = multiprocessing.Manager()
2206
2601
    
2207
2602
    client_class = Client
2208
2603
    if use_dbus:
2209
 
        client_class = functools.partial(ClientDBusTransitional,
2210
 
                                         bus = bus)
 
2604
        client_class = functools.partial(ClientDBus, bus = bus)
2211
2605
    
2212
2606
    client_settings = Client.config_parser(client_config)
2213
2607
    old_client_settings = {}
2214
2608
    clients_data = {}
2215
2609
    
 
2610
    # This is used to redirect stdout and stderr for checker processes
 
2611
    global wnull
 
2612
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2613
    # Only used if server is running in foreground but not in debug
 
2614
    # mode
 
2615
    if debug or not foreground:
 
2616
        wnull.close()
 
2617
    
2216
2618
    # Get client data and settings from last running state.
2217
2619
    if server_settings["restore"]:
2218
2620
        try:
2219
2621
            with open(stored_state_path, "rb") as stored_state:
2220
 
                clients_data, old_client_settings = (pickle.load
2221
 
                                                     (stored_state))
 
2622
                clients_data, old_client_settings = pickle.load(
 
2623
                    stored_state)
2222
2624
            os.remove(stored_state_path)
2223
2625
        except IOError as e:
2224
 
            logger.warning("Could not load persistent state: {0}"
2225
 
                           .format(e))
2226
 
            if e.errno != errno.ENOENT:
 
2626
            if e.errno == errno.ENOENT:
 
2627
                logger.warning("Could not load persistent state:"
 
2628
                               " {}".format(os.strerror(e.errno)))
 
2629
            else:
 
2630
                logger.critical("Could not load persistent state:",
 
2631
                                exc_info=e)
2227
2632
                raise
2228
2633
        except EOFError as e:
2229
2634
            logger.warning("Could not load persistent state: "
2230
 
                           "EOFError: {0}".format(e))
 
2635
                           "EOFError:",
 
2636
                           exc_info=e)
2231
2637
    
2232
2638
    with PGPEngine() as pgp:
2233
 
        for client_name, client in clients_data.iteritems():
 
2639
        for client_name, client in clients_data.items():
 
2640
            # Skip removed clients
 
2641
            if client_name not in client_settings:
 
2642
                continue
 
2643
            
2234
2644
            # Decide which value to use after restoring saved state.
2235
2645
            # We have three different values: Old config file,
2236
2646
            # new config file, and saved state.
2241
2651
                    # For each value in new config, check if it
2242
2652
                    # differs from the old config value (Except for
2243
2653
                    # the "secret" attribute)
2244
 
                    if (name != "secret" and
2245
 
                        value != old_client_settings[client_name]
2246
 
                        [name]):
 
2654
                    if (name != "secret"
 
2655
                        and (value !=
 
2656
                             old_client_settings[client_name][name])):
2247
2657
                        client[name] = value
2248
2658
                except KeyError:
2249
2659
                    pass
2250
2660
            
2251
2661
            # Clients who has passed its expire date can still be
2252
 
            # enabled if its last checker was successful.  Clients
2253
 
            # whose checker failed before we stored its state is
2254
 
            # assumed to have failed all checkers during downtime.
 
2662
            # enabled if its last checker was successful.  A Client
 
2663
            # whose checker succeeded before we stored its state is
 
2664
            # assumed to have successfully run all checkers during
 
2665
            # downtime.
2255
2666
            if client["enabled"]:
2256
2667
                if datetime.datetime.utcnow() >= client["expires"]:
2257
2668
                    if not client["last_checked_ok"]:
2258
2669
                        logger.warning(
2259
 
                            "disabling client {0} - Client never "
2260
 
                            "performed a successfull checker"
2261
 
                            .format(client["name"]))
 
2670
                            "disabling client {} - Client never "
 
2671
                            "performed a successful checker".format(
 
2672
                                client_name))
2262
2673
                        client["enabled"] = False
2263
2674
                    elif client["last_checker_status"] != 0:
2264
2675
                        logger.warning(
2265
 
                            "disabling client {0} - Client "
2266
 
                            "last checker failed with error code {1}"
2267
 
                            .format(client["name"],
2268
 
                                    client["last_checker_status"]))
 
2676
                            "disabling client {} - Client last"
 
2677
                            " checker failed with error code"
 
2678
                            " {}".format(
 
2679
                                client_name,
 
2680
                                client["last_checker_status"]))
2269
2681
                        client["enabled"] = False
2270
2682
                    else:
2271
 
                        client["expires"] = (datetime.datetime
2272
 
                                             .utcnow()
2273
 
                                             + client["timeout"])
 
2683
                        client["expires"] = (
 
2684
                            datetime.datetime.utcnow()
 
2685
                            + client["timeout"])
2274
2686
                        logger.debug("Last checker succeeded,"
2275
 
                                     " keeping {0} enabled"
2276
 
                                     .format(client["name"]))
 
2687
                                     " keeping {} enabled".format(
 
2688
                                         client_name))
2277
2689
            try:
2278
 
                client["secret"] = (
2279
 
                    pgp.decrypt(client["encrypted_secret"],
2280
 
                                client_settings[client_name]
2281
 
                                ["secret"]))
 
2690
                client["secret"] = pgp.decrypt(
 
2691
                    client["encrypted_secret"],
 
2692
                    client_settings[client_name]["secret"])
2282
2693
            except PGPError:
2283
2694
                # If decryption fails, we use secret from new settings
2284
 
                logger.debug("Failed to decrypt {0} old secret"
2285
 
                             .format(client_name))
2286
 
                client["secret"] = (
2287
 
                    client_settings[client_name]["secret"])
2288
 
 
 
2695
                logger.debug("Failed to decrypt {} old secret".format(
 
2696
                    client_name))
 
2697
                client["secret"] = (client_settings[client_name]
 
2698
                                    ["secret"])
2289
2699
    
2290
2700
    # Add/remove clients based on new changes made to config
2291
2701
    for client_name in (set(old_client_settings)
2294
2704
    for client_name in (set(client_settings)
2295
2705
                        - set(old_client_settings)):
2296
2706
        clients_data[client_name] = client_settings[client_name]
2297
 
 
2298
 
    # Create clients all clients
2299
 
    for client_name, client in clients_data.iteritems():
 
2707
    
 
2708
    # Create all client objects
 
2709
    for client_name, client in clients_data.items():
2300
2710
        tcp_server.clients[client_name] = client_class(
2301
 
            name = client_name, settings = client)
 
2711
            name = client_name,
 
2712
            settings = client,
 
2713
            server_settings = server_settings)
2302
2714
    
2303
2715
    if not tcp_server.clients:
2304
2716
        logger.warning("No clients defined")
2305
 
        
2306
 
    if not debug:
2307
 
        try:
2308
 
            with pidfile:
2309
 
                pid = os.getpid()
2310
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2311
 
            del pidfile
2312
 
        except IOError:
2313
 
            logger.error("Could not write to file %r with PID %d",
2314
 
                         pidfilename, pid)
2315
 
        except NameError:
2316
 
            # "pidfile" was never created
2317
 
            pass
 
2717
    
 
2718
    if not foreground:
 
2719
        if pidfile is not None:
 
2720
            pid = os.getpid()
 
2721
            try:
 
2722
                with pidfile:
 
2723
                    print(pid, file=pidfile)
 
2724
            except IOError:
 
2725
                logger.error("Could not write to file %r with PID %d",
 
2726
                             pidfilename, pid)
 
2727
        del pidfile
2318
2728
        del pidfilename
2319
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2320
2729
    
2321
2730
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2322
2731
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2323
2732
    
2324
2733
    if use_dbus:
2325
 
        class MandosDBusService(dbus.service.Object):
 
2734
        
 
2735
        @alternate_dbus_interfaces(
 
2736
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2737
        class MandosDBusService(DBusObjectWithProperties):
2326
2738
            """A D-Bus proxy object"""
 
2739
            
2327
2740
            def __init__(self):
2328
2741
                dbus.service.Object.__init__(self, bus, "/")
 
2742
            
2329
2743
            _interface = "se.recompile.Mandos"
2330
2744
            
 
2745
            @dbus_interface_annotations(_interface)
 
2746
            def _foo(self):
 
2747
                return {
 
2748
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2749
                    "false" }
 
2750
            
2331
2751
            @dbus.service.signal(_interface, signature="o")
2332
2752
            def ClientAdded(self, objpath):
2333
2753
                "D-Bus signal"
2346
2766
            @dbus.service.method(_interface, out_signature="ao")
2347
2767
            def GetAllClients(self):
2348
2768
                "D-Bus method"
2349
 
                return dbus.Array(c.dbus_object_path
2350
 
                                  for c in
 
2769
                return dbus.Array(c.dbus_object_path for c in
2351
2770
                                  tcp_server.clients.itervalues())
2352
2771
            
2353
2772
            @dbus.service.method(_interface,
2355
2774
            def GetAllClientsWithProperties(self):
2356
2775
                "D-Bus method"
2357
2776
                return dbus.Dictionary(
2358
 
                    ((c.dbus_object_path, c.GetAll(""))
2359
 
                     for c in tcp_server.clients.itervalues()),
 
2777
                    { c.dbus_object_path: c.GetAll("")
 
2778
                      for c in tcp_server.clients.itervalues() },
2360
2779
                    signature="oa{sv}")
2361
2780
            
2362
2781
            @dbus.service.method(_interface, in_signature="o")
2375
2794
            
2376
2795
            del _interface
2377
2796
        
2378
 
        class MandosDBusServiceTransitional(MandosDBusService):
2379
 
            __metaclass__ = AlternateDBusNamesMetaclass
2380
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2797
        mandos_dbus_service = MandosDBusService()
2381
2798
    
2382
2799
    def cleanup():
2383
2800
        "Cleanup function; run on exit"
2384
 
        service.cleanup()
 
2801
        if zeroconf:
 
2802
            service.cleanup()
2385
2803
        
2386
2804
        multiprocessing.active_children()
 
2805
        wnull.close()
2387
2806
        if not (tcp_server.clients or client_settings):
2388
2807
            return
2389
2808
        
2400
2819
                
2401
2820
                # A list of attributes that can not be pickled
2402
2821
                # + secret.
2403
 
                exclude = set(("bus", "changedstate", "secret",
2404
 
                               "checker"))
2405
 
                for name, typ in (inspect.getmembers
2406
 
                                  (dbus.service.Object)):
 
2822
                exclude = { "bus", "changedstate", "secret",
 
2823
                            "checker", "server_settings" }
 
2824
                for name, typ in inspect.getmembers(dbus.service
 
2825
                                                    .Object):
2407
2826
                    exclude.add(name)
2408
2827
                
2409
2828
                client_dict["encrypted_secret"] = (client
2416
2835
                del client_settings[client.name]["secret"]
2417
2836
        
2418
2837
        try:
2419
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2420
 
                                                prefix="clients-",
2421
 
                                                dir=os.path.dirname
2422
 
                                                (stored_state_path))
2423
 
            with os.fdopen(tempfd, "wb") as stored_state:
 
2838
            with tempfile.NamedTemporaryFile(
 
2839
                    mode='wb',
 
2840
                    suffix=".pickle",
 
2841
                    prefix='clients-',
 
2842
                    dir=os.path.dirname(stored_state_path),
 
2843
                    delete=False) as stored_state:
2424
2844
                pickle.dump((clients, client_settings), stored_state)
 
2845
                tempname = stored_state.name
2425
2846
            os.rename(tempname, stored_state_path)
2426
2847
        except (IOError, OSError) as e:
2427
 
            logger.warning("Could not save persistent state: {0}"
2428
 
                           .format(e))
2429
2848
            if not debug:
2430
2849
                try:
2431
2850
                    os.remove(tempname)
2432
2851
                except NameError:
2433
2852
                    pass
2434
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2435
 
                                   errno.EEXIST)):
2436
 
                raise e
 
2853
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2854
                logger.warning("Could not save persistent state: {}"
 
2855
                               .format(os.strerror(e.errno)))
 
2856
            else:
 
2857
                logger.warning("Could not save persistent state:",
 
2858
                               exc_info=e)
 
2859
                raise
2437
2860
        
2438
2861
        # Delete all clients, and settings from config
2439
2862
        while tcp_server.clients:
2444
2867
            client.disable(quiet=True)
2445
2868
            if use_dbus:
2446
2869
                # Emit D-Bus signal
2447
 
                mandos_dbus_service.ClientRemoved(client
2448
 
                                                  .dbus_object_path,
2449
 
                                                  client.name)
 
2870
                mandos_dbus_service.ClientRemoved(
 
2871
                    client.dbus_object_path, client.name)
2450
2872
        client_settings.clear()
2451
2873
    
2452
2874
    atexit.register(cleanup)
2463
2885
    tcp_server.server_activate()
2464
2886
    
2465
2887
    # Find out what port we got
2466
 
    service.port = tcp_server.socket.getsockname()[1]
 
2888
    if zeroconf:
 
2889
        service.port = tcp_server.socket.getsockname()[1]
2467
2890
    if use_ipv6:
2468
2891
        logger.info("Now listening on address %r, port %d,"
2469
 
                    " flowinfo %d, scope_id %d"
2470
 
                    % tcp_server.socket.getsockname())
 
2892
                    " flowinfo %d, scope_id %d",
 
2893
                    *tcp_server.socket.getsockname())
2471
2894
    else:                       # IPv4
2472
 
        logger.info("Now listening on address %r, port %d"
2473
 
                    % tcp_server.socket.getsockname())
 
2895
        logger.info("Now listening on address %r, port %d",
 
2896
                    *tcp_server.socket.getsockname())
2474
2897
    
2475
2898
    #service.interface = tcp_server.socket.getsockname()[3]
2476
2899
    
2477
2900
    try:
2478
 
        # From the Avahi example code
2479
 
        try:
2480
 
            service.activate()
2481
 
        except dbus.exceptions.DBusException as error:
2482
 
            logger.critical("DBusException: %s", error)
2483
 
            cleanup()
2484
 
            sys.exit(1)
2485
 
        # End of Avahi example code
 
2901
        if zeroconf:
 
2902
            # From the Avahi example code
 
2903
            try:
 
2904
                service.activate()
 
2905
            except dbus.exceptions.DBusException as error:
 
2906
                logger.critical("D-Bus Exception", exc_info=error)
 
2907
                cleanup()
 
2908
                sys.exit(1)
 
2909
            # End of Avahi example code
2486
2910
        
2487
2911
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2488
2912
                             lambda *args, **kwargs:
2492
2916
        logger.debug("Starting main loop")
2493
2917
        main_loop.run()
2494
2918
    except AvahiError as error:
2495
 
        logger.critical("AvahiError: %s", error)
 
2919
        logger.critical("Avahi Error", exc_info=error)
2496
2920
        cleanup()
2497
2921
        sys.exit(1)
2498
2922
    except KeyboardInterrupt:
2503
2927
    # Must run before the D-Bus bus name gets deregistered
2504
2928
    cleanup()
2505
2929
 
 
2930
 
2506
2931
if __name__ == '__main__':
2507
2932
    main()