/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: 2016-07-03 03:32:28 UTC
  • Revision ID: teddy@recompile.se-20160703033228-cafpnnfs53kdg52g
Change all http:// URLs to https:// wherever possible.

* INSTALL (Prerequisites/Libraries/Mandos Server): Change "http://" to
  "https://" wherever possible.
* Makefile (FORTIFY): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.c (main): - '' -
* plugins.d/mandos-client.c (start_mandos_communication): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2012 Teddy Hogeborn
15
 
# Copyright © 2008-2012 Björn Påhlsson
 
14
# Copyright © 2008-2016 Teddy Hogeborn
 
15
# Copyright © 2008-2016 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
try:
 
38
    from future_builtins import *
 
39
except ImportError:
 
40
    pass
 
41
 
 
42
try:
 
43
    import SocketServer as socketserver
 
44
except ImportError:
 
45
    import socketserver
38
46
import socket
39
47
import argparse
40
48
import datetime
41
49
import errno
42
 
import gnutls.crypto
43
 
import gnutls.connection
44
 
import gnutls.errors
45
 
import gnutls.library.functions
46
 
import gnutls.library.constants
47
 
import gnutls.library.types
48
 
import ConfigParser as configparser
 
50
try:
 
51
    import ConfigParser as configparser
 
52
except ImportError:
 
53
    import configparser
49
54
import sys
50
55
import re
51
56
import os
60
65
import struct
61
66
import fcntl
62
67
import functools
63
 
import cPickle as pickle
 
68
try:
 
69
    import cPickle as pickle
 
70
except ImportError:
 
71
    import pickle
64
72
import multiprocessing
65
73
import types
66
74
import binascii
67
75
import tempfile
 
76
import itertools
 
77
import collections
 
78
import codecs
68
79
 
69
80
import dbus
70
81
import dbus.service
71
 
import gobject
72
 
import avahi
 
82
from gi.repository import GLib
73
83
from dbus.mainloop.glib import DBusGMainLoop
74
84
import ctypes
75
85
import ctypes.util
76
86
import xml.dom.minidom
77
87
import inspect
78
 
import GnuPGInterface
79
88
 
 
89
# Try to find the value of SO_BINDTODEVICE:
80
90
try:
 
91
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
 
92
    # newer, and it is also the most natural place for it:
81
93
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
82
94
except AttributeError:
83
95
    try:
 
96
        # This is where SO_BINDTODEVICE was up to and including Python
 
97
        # 2.6, and also 3.2:
84
98
        from IN import SO_BINDTODEVICE
85
99
    except ImportError:
86
 
        SO_BINDTODEVICE = None
87
 
 
88
 
version = "1.5.2"
 
100
        # In Python 2.7 it seems to have been removed entirely.
 
101
        # Try running the C preprocessor:
 
102
        try:
 
103
            cc = subprocess.Popen(["cc", "--language=c", "-E",
 
104
                                   "/dev/stdin"],
 
105
                                  stdin=subprocess.PIPE,
 
106
                                  stdout=subprocess.PIPE)
 
107
            stdout = cc.communicate(
 
108
                "#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
 
109
            SO_BINDTODEVICE = int(stdout.splitlines()[-1])
 
110
        except (OSError, ValueError, IndexError):
 
111
            # No value found
 
112
            SO_BINDTODEVICE = None
 
113
 
 
114
if sys.version_info.major == 2:
 
115
    str = unicode
 
116
 
 
117
version = "1.7.10"
89
118
stored_state_file = "clients.pickle"
90
119
 
91
120
logger = logging.getLogger()
92
 
syslogger = (logging.handlers.SysLogHandler
93
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
 
              address = str("/dev/log")))
 
121
syslogger = None
95
122
 
96
123
try:
97
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
98
 
                      (ctypes.util.find_library("c"))
99
 
                      .if_nametoindex)
 
124
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
125
        ctypes.util.find_library("c")).if_nametoindex
100
126
except (OSError, AttributeError):
 
127
    
101
128
    def if_nametoindex(interface):
102
129
        "Get an interface index the hard way, i.e. using fcntl()"
103
130
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
104
131
        with contextlib.closing(socket.socket()) as s:
105
132
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
106
 
                                struct.pack(str("16s16x"),
107
 
                                            interface))
108
 
        interface_index = struct.unpack(str("I"),
109
 
                                        ifreq[16:20])[0]
 
133
                                struct.pack(b"16s16x", interface))
 
134
        interface_index = struct.unpack("I", ifreq[16:20])[0]
110
135
        return interface_index
111
136
 
112
137
 
 
138
def copy_function(func):
 
139
    """Make a copy of a function"""
 
140
    if sys.version_info.major == 2:
 
141
        return types.FunctionType(func.func_code,
 
142
                                  func.func_globals,
 
143
                                  func.func_name,
 
144
                                  func.func_defaults,
 
145
                                  func.func_closure)
 
146
    else:
 
147
        return types.FunctionType(func.__code__,
 
148
                                  func.__globals__,
 
149
                                  func.__name__,
 
150
                                  func.__defaults__,
 
151
                                  func.__closure__)
 
152
 
 
153
 
113
154
def initlogger(debug, level=logging.WARNING):
114
155
    """init logger and add loglevel"""
115
156
    
 
157
    global syslogger
 
158
    syslogger = (logging.handlers.SysLogHandler(
 
159
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
160
        address = "/dev/log"))
116
161
    syslogger.setFormatter(logging.Formatter
117
162
                           ('Mandos [%(process)d]: %(levelname)s:'
118
163
                            ' %(message)s'))
135
180
 
136
181
class PGPEngine(object):
137
182
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
183
    
138
184
    def __init__(self):
139
 
        self.gnupg = GnuPGInterface.GnuPG()
140
185
        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'])
 
186
        self.gpg = "gpg"
 
187
        try:
 
188
            output = subprocess.check_output(["gpgconf"])
 
189
            for line in output.splitlines():
 
190
                name, text, path = line.split(b":")
 
191
                if name == "gpg":
 
192
                    self.gpg = path
 
193
                    break
 
194
        except OSError as e:
 
195
            if e.errno != errno.ENOENT:
 
196
                raise
 
197
        self.gnupgargs = ['--batch',
 
198
                          '--homedir', self.tempdir,
 
199
                          '--force-mdc',
 
200
                          '--quiet']
 
201
        # Only GPG version 1 has the --no-use-agent option.
 
202
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
203
            self.gnupgargs.append("--no-use-agent")
147
204
    
148
205
    def __enter__(self):
149
206
        return self
150
207
    
151
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
208
    def __exit__(self, exc_type, exc_value, traceback):
152
209
        self._cleanup()
153
210
        return False
154
211
    
171
228
    def password_encode(self, password):
172
229
        # Passphrase can not be empty and can not contain newlines or
173
230
        # NUL bytes.  So we prefix it and hex encode it.
174
 
        return b"mandos" + binascii.hexlify(password)
 
231
        encoded = b"mandos" + binascii.hexlify(password)
 
232
        if len(encoded) > 2048:
 
233
            # GnuPG can't handle long passwords, so encode differently
 
234
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
235
                       .replace(b"\n", b"\\n")
 
236
                       .replace(b"\0", b"\\x00"))
 
237
        return encoded
175
238
    
176
239
    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
 
240
        passphrase = self.password_encode(password)
 
241
        with tempfile.NamedTemporaryFile(
 
242
                dir=self.tempdir) as passfile:
 
243
            passfile.write(passphrase)
 
244
            passfile.flush()
 
245
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
246
                                     '--passphrase-file',
 
247
                                     passfile.name]
 
248
                                    + self.gnupgargs,
 
249
                                    stdin = subprocess.PIPE,
 
250
                                    stdout = subprocess.PIPE,
 
251
                                    stderr = subprocess.PIPE)
 
252
            ciphertext, err = proc.communicate(input = data)
 
253
        if proc.returncode != 0:
 
254
            raise PGPError(err)
191
255
        return ciphertext
192
256
    
193
257
    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
 
258
        passphrase = self.password_encode(password)
 
259
        with tempfile.NamedTemporaryFile(
 
260
                dir = self.tempdir) as passfile:
 
261
            passfile.write(passphrase)
 
262
            passfile.flush()
 
263
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
264
                                     '--passphrase-file',
 
265
                                     passfile.name]
 
266
                                    + self.gnupgargs,
 
267
                                    stdin = subprocess.PIPE,
 
268
                                    stdout = subprocess.PIPE,
 
269
                                    stderr = subprocess.PIPE)
 
270
            decrypted_plaintext, err = proc.communicate(input = data)
 
271
        if proc.returncode != 0:
 
272
            raise PGPError(err)
208
273
        return decrypted_plaintext
209
274
 
210
 
 
 
275
# Pretend that we have an Avahi module
 
276
class Avahi(object):
 
277
    """This isn't so much a class as it is a module-like namespace.
 
278
    It is instantiated once, and simulates having an Avahi module."""
 
279
    IF_UNSPEC = -1              # avahi-common/address.h
 
280
    PROTO_UNSPEC = -1           # avahi-common/address.h
 
281
    PROTO_INET = 0              # avahi-common/address.h
 
282
    PROTO_INET6 = 1             # avahi-common/address.h
 
283
    DBUS_NAME = "org.freedesktop.Avahi"
 
284
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
 
285
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
 
286
    DBUS_PATH_SERVER = "/"
 
287
    def string_array_to_txt_array(self, t):
 
288
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
 
289
                           for s in t), signature="ay")
 
290
    ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
 
291
    ENTRY_GROUP_COLLISION = 3   # avahi-common/defs.h
 
292
    ENTRY_GROUP_FAILURE = 4     # avahi-common/defs.h
 
293
    SERVER_INVALID = 0          # avahi-common/defs.h
 
294
    SERVER_REGISTERING = 1      # avahi-common/defs.h
 
295
    SERVER_RUNNING = 2          # avahi-common/defs.h
 
296
    SERVER_COLLISION = 3        # avahi-common/defs.h
 
297
    SERVER_FAILURE = 4          # avahi-common/defs.h
 
298
avahi = Avahi()
211
299
 
212
300
class AvahiError(Exception):
213
301
    def __init__(self, value, *args, **kwargs):
214
302
        self.value = value
215
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
216
 
    def __unicode__(self):
217
 
        return unicode(repr(self.value))
 
303
        return super(AvahiError, self).__init__(value, *args,
 
304
                                                **kwargs)
 
305
 
218
306
 
219
307
class AvahiServiceError(AvahiError):
220
308
    pass
221
309
 
 
310
 
222
311
class AvahiGroupError(AvahiError):
223
312
    pass
224
313
 
231
320
               Used to optionally bind to the specified interface.
232
321
    name: string; Example: 'Mandos'
233
322
    type: string; Example: '_mandos._tcp'.
234
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
323
     See <https://www.iana.org/assignments/service-names-port-numbers>
235
324
    port: integer; what port to announce
236
325
    TXT: list of strings; TXT record for the service
237
326
    domain: string; Domain to publish on, default to .local if empty.
243
332
    server: D-Bus Server
244
333
    bus: dbus.SystemBus()
245
334
    """
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):
 
335
    
 
336
    def __init__(self,
 
337
                 interface = avahi.IF_UNSPEC,
 
338
                 name = None,
 
339
                 servicetype = None,
 
340
                 port = None,
 
341
                 TXT = None,
 
342
                 domain = "",
 
343
                 host = "",
 
344
                 max_renames = 32768,
 
345
                 protocol = avahi.PROTO_UNSPEC,
 
346
                 bus = None):
250
347
        self.interface = interface
251
348
        self.name = name
252
349
        self.type = servicetype
261
358
        self.server = None
262
359
        self.bus = bus
263
360
        self.entry_group_state_changed_match = None
264
 
    def rename(self):
 
361
    
 
362
    def rename(self, remove=True):
265
363
        """Derived from the Avahi example code"""
266
364
        if self.rename_count >= self.max_renames:
267
365
            logger.critical("No suitable Zeroconf service name found"
268
366
                            " after %i retries, exiting.",
269
367
                            self.rename_count)
270
368
            raise AvahiServiceError("Too many renames")
271
 
        self.name = unicode(self.server
272
 
                            .GetAlternativeServiceName(self.name))
 
369
        self.name = str(
 
370
            self.server.GetAlternativeServiceName(self.name))
 
371
        self.rename_count += 1
273
372
        logger.info("Changing Zeroconf service name to %r ...",
274
373
                    self.name)
275
 
        self.remove()
 
374
        if remove:
 
375
            self.remove()
276
376
        try:
277
377
            self.add()
278
378
        except dbus.exceptions.DBusException as error:
279
 
            logger.critical("DBusException: %s", error)
280
 
            self.cleanup()
281
 
            os._exit(1)
282
 
        self.rename_count += 1
 
379
            if (error.get_dbus_name()
 
380
                == "org.freedesktop.Avahi.CollisionError"):
 
381
                logger.info("Local Zeroconf service name collision.")
 
382
                return self.rename(remove=False)
 
383
            else:
 
384
                logger.critical("D-Bus Exception", exc_info=error)
 
385
                self.cleanup()
 
386
                os._exit(1)
 
387
    
283
388
    def remove(self):
284
389
        """Derived from the Avahi example code"""
285
390
        if self.entry_group_state_changed_match is not None:
287
392
            self.entry_group_state_changed_match = None
288
393
        if self.group is not None:
289
394
            self.group.Reset()
 
395
    
290
396
    def add(self):
291
397
        """Derived from the Avahi example code"""
292
398
        self.remove()
309
415
            dbus.UInt16(self.port),
310
416
            avahi.string_array_to_txt_array(self.TXT))
311
417
        self.group.Commit()
 
418
    
312
419
    def entry_group_state_changed(self, state, error):
313
420
        """Derived from the Avahi example code"""
314
421
        logger.debug("Avahi entry group state change: %i", state)
320
427
            self.rename()
321
428
        elif state == avahi.ENTRY_GROUP_FAILURE:
322
429
            logger.critical("Avahi: Error in group state changed %s",
323
 
                            unicode(error))
324
 
            raise AvahiGroupError("State changed: %s"
325
 
                                  % unicode(error))
 
430
                            str(error))
 
431
            raise AvahiGroupError("State changed: {!s}".format(error))
 
432
    
326
433
    def cleanup(self):
327
434
        """Derived from the Avahi example code"""
328
435
        if self.group is not None:
333
440
                pass
334
441
            self.group = None
335
442
        self.remove()
 
443
    
336
444
    def server_state_changed(self, state, error=None):
337
445
        """Derived from the Avahi example code"""
338
446
        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" }
 
447
        bad_states = {
 
448
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
449
            avahi.SERVER_REGISTERING: None,
 
450
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
451
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
452
        }
346
453
        if state in bad_states:
347
454
            if bad_states[state] is not None:
348
455
                if error is None:
351
458
                    logger.error(bad_states[state] + ": %r", error)
352
459
            self.cleanup()
353
460
        elif state == avahi.SERVER_RUNNING:
354
 
            self.add()
 
461
            try:
 
462
                self.add()
 
463
            except dbus.exceptions.DBusException as error:
 
464
                if (error.get_dbus_name()
 
465
                    == "org.freedesktop.Avahi.CollisionError"):
 
466
                    logger.info("Local Zeroconf service name"
 
467
                                " collision.")
 
468
                    return self.rename(remove=False)
 
469
                else:
 
470
                    logger.critical("D-Bus Exception", exc_info=error)
 
471
                    self.cleanup()
 
472
                    os._exit(1)
355
473
        else:
356
474
            if error is None:
357
475
                logger.debug("Unknown state: %r", state)
358
476
            else:
359
477
                logger.debug("Unknown state: %r: %r", state, error)
 
478
    
360
479
    def activate(self):
361
480
        """Derived from the Avahi example code"""
362
481
        if self.server is None:
366
485
                                    follow_name_owner_changes=True),
367
486
                avahi.DBUS_INTERFACE_SERVER)
368
487
        self.server.connect_to_signal("StateChanged",
369
 
                                 self.server_state_changed)
 
488
                                      self.server_state_changed)
370
489
        self.server_state_changed(self.server.GetState())
371
490
 
 
491
 
372
492
class AvahiServiceToSyslog(AvahiService):
373
 
    def rename(self):
 
493
    def rename(self, *args, **kwargs):
374
494
        """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))
 
495
        ret = AvahiService.rename(self, *args, **kwargs)
 
496
        syslogger.setFormatter(logging.Formatter(
 
497
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
498
            .format(self.name)))
380
499
        return ret
381
500
 
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
 
        
 
501
# Pretend that we have a GnuTLS module
 
502
class GnuTLS(object):
 
503
    """This isn't so much a class as it is a module-like namespace.
 
504
    It is instantiated once, and simulates having a GnuTLS module."""
 
505
    
 
506
    _library = ctypes.cdll.LoadLibrary(
 
507
        ctypes.util.find_library("gnutls"))
 
508
    _need_version = b"3.3.0"
 
509
    def __init__(self):
 
510
        # Need to use class name "GnuTLS" here, since this method is
 
511
        # called before the assignment to the "gnutls" global variable
 
512
        # happens.
 
513
        if GnuTLS.check_version(self._need_version) is None:
 
514
            raise GnuTLS.Error("Needs GnuTLS {} or later"
 
515
                               .format(self._need_version))
 
516
    
 
517
    # Unless otherwise indicated, the constants and types below are
 
518
    # all from the gnutls/gnutls.h C header file.
 
519
    
 
520
    # Constants
 
521
    E_SUCCESS = 0
 
522
    E_INTERRUPTED = -52
 
523
    E_AGAIN = -28
 
524
    CRT_OPENPGP = 2
 
525
    CLIENT = 2
 
526
    SHUT_RDWR = 0
 
527
    CRD_CERTIFICATE = 1
 
528
    E_NO_CERTIFICATE_FOUND = -49
 
529
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
530
    
 
531
    # Types
 
532
    class session_int(ctypes.Structure):
 
533
        _fields_ = []
 
534
    session_t = ctypes.POINTER(session_int)
 
535
    class certificate_credentials_st(ctypes.Structure):
 
536
        _fields_ = []
 
537
    certificate_credentials_t = ctypes.POINTER(
 
538
        certificate_credentials_st)
 
539
    certificate_type_t = ctypes.c_int
 
540
    class datum_t(ctypes.Structure):
 
541
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
542
                    ('size', ctypes.c_uint)]
 
543
    class openpgp_crt_int(ctypes.Structure):
 
544
        _fields_ = []
 
545
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
546
    openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
 
547
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
548
    credentials_type_t = ctypes.c_int
 
549
    transport_ptr_t = ctypes.c_void_p
 
550
    close_request_t = ctypes.c_int
 
551
    
 
552
    # Exceptions
 
553
    class Error(Exception):
 
554
        # We need to use the class name "GnuTLS" here, since this
 
555
        # exception might be raised from within GnuTLS.__init__,
 
556
        # which is called before the assignment to the "gnutls"
 
557
        # global variable has happened.
 
558
        def __init__(self, message = None, code = None, args=()):
 
559
            # Default usage is by a message string, but if a return
 
560
            # code is passed, convert it to a string with
 
561
            # gnutls.strerror()
 
562
            self.code = code
 
563
            if message is None and code is not None:
 
564
                message = GnuTLS.strerror(code)
 
565
            return super(GnuTLS.Error, self).__init__(
 
566
                message, *args)
 
567
    
 
568
    class CertificateSecurityError(Error):
 
569
        pass
 
570
    
 
571
    # Classes
 
572
    class Credentials(object):
 
573
        def __init__(self):
 
574
            self._c_object = gnutls.certificate_credentials_t()
 
575
            gnutls.certificate_allocate_credentials(
 
576
                ctypes.byref(self._c_object))
 
577
            self.type = gnutls.CRD_CERTIFICATE
 
578
        
 
579
        def __del__(self):
 
580
            gnutls.certificate_free_credentials(self._c_object)
 
581
    
 
582
    class ClientSession(object):
 
583
        def __init__(self, socket, credentials = None):
 
584
            self._c_object = gnutls.session_t()
 
585
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
586
            gnutls.set_default_priority(self._c_object)
 
587
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
588
            gnutls.handshake_set_private_extensions(self._c_object,
 
589
                                                    True)
 
590
            self.socket = socket
 
591
            if credentials is None:
 
592
                credentials = gnutls.Credentials()
 
593
            gnutls.credentials_set(self._c_object, credentials.type,
 
594
                                   ctypes.cast(credentials._c_object,
 
595
                                               ctypes.c_void_p))
 
596
            self.credentials = credentials
 
597
        
 
598
        def __del__(self):
 
599
            gnutls.deinit(self._c_object)
 
600
        
 
601
        def handshake(self):
 
602
            return gnutls.handshake(self._c_object)
 
603
        
 
604
        def send(self, data):
 
605
            data = bytes(data)
 
606
            data_len = len(data)
 
607
            while data_len > 0:
 
608
                data_len -= gnutls.record_send(self._c_object,
 
609
                                               data[-data_len:],
 
610
                                               data_len)
 
611
        
 
612
        def bye(self):
 
613
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
614
    
 
615
    # Error handling functions
 
616
    def _error_code(result):
 
617
        """A function to raise exceptions on errors, suitable
 
618
        for the 'restype' attribute on ctypes functions"""
 
619
        if result >= 0:
 
620
            return result
 
621
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
622
            raise gnutls.CertificateSecurityError(code = result)
 
623
        raise gnutls.Error(code = result)
 
624
    
 
625
    def _retry_on_error(result, func, arguments):
 
626
        """A function to retry on some errors, suitable
 
627
        for the 'errcheck' attribute on ctypes functions"""
 
628
        while result < 0:
 
629
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
630
                return _error_code(result)
 
631
            result = func(*arguments)
 
632
        return result
 
633
    
 
634
    # Unless otherwise indicated, the function declarations below are
 
635
    # all from the gnutls/gnutls.h C header file.
 
636
    
 
637
    # Functions
 
638
    priority_set_direct = _library.gnutls_priority_set_direct
 
639
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
640
                                    ctypes.POINTER(ctypes.c_char_p)]
 
641
    priority_set_direct.restype = _error_code
 
642
    
 
643
    init = _library.gnutls_init
 
644
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
645
    init.restype = _error_code
 
646
    
 
647
    set_default_priority = _library.gnutls_set_default_priority
 
648
    set_default_priority.argtypes = [session_t]
 
649
    set_default_priority.restype = _error_code
 
650
    
 
651
    record_send = _library.gnutls_record_send
 
652
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
653
                            ctypes.c_size_t]
 
654
    record_send.restype = ctypes.c_ssize_t
 
655
    record_send.errcheck = _retry_on_error
 
656
    
 
657
    certificate_allocate_credentials = (
 
658
        _library.gnutls_certificate_allocate_credentials)
 
659
    certificate_allocate_credentials.argtypes = [
 
660
        ctypes.POINTER(certificate_credentials_t)]
 
661
    certificate_allocate_credentials.restype = _error_code
 
662
    
 
663
    certificate_free_credentials = (
 
664
        _library.gnutls_certificate_free_credentials)
 
665
    certificate_free_credentials.argtypes = [certificate_credentials_t]
 
666
    certificate_free_credentials.restype = None
 
667
    
 
668
    handshake_set_private_extensions = (
 
669
        _library.gnutls_handshake_set_private_extensions)
 
670
    handshake_set_private_extensions.argtypes = [session_t,
 
671
                                                 ctypes.c_int]
 
672
    handshake_set_private_extensions.restype = None
 
673
    
 
674
    credentials_set = _library.gnutls_credentials_set
 
675
    credentials_set.argtypes = [session_t, credentials_type_t,
 
676
                                ctypes.c_void_p]
 
677
    credentials_set.restype = _error_code
 
678
    
 
679
    strerror = _library.gnutls_strerror
 
680
    strerror.argtypes = [ctypes.c_int]
 
681
    strerror.restype = ctypes.c_char_p
 
682
    
 
683
    certificate_type_get = _library.gnutls_certificate_type_get
 
684
    certificate_type_get.argtypes = [session_t]
 
685
    certificate_type_get.restype = _error_code
 
686
    
 
687
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
688
    certificate_get_peers.argtypes = [session_t,
 
689
                                      ctypes.POINTER(ctypes.c_uint)]
 
690
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
691
    
 
692
    global_set_log_level = _library.gnutls_global_set_log_level
 
693
    global_set_log_level.argtypes = [ctypes.c_int]
 
694
    global_set_log_level.restype = None
 
695
    
 
696
    global_set_log_function = _library.gnutls_global_set_log_function
 
697
    global_set_log_function.argtypes = [log_func]
 
698
    global_set_log_function.restype = None
 
699
    
 
700
    deinit = _library.gnutls_deinit
 
701
    deinit.argtypes = [session_t]
 
702
    deinit.restype = None
 
703
    
 
704
    handshake = _library.gnutls_handshake
 
705
    handshake.argtypes = [session_t]
 
706
    handshake.restype = _error_code
 
707
    handshake.errcheck = _retry_on_error
 
708
    
 
709
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
710
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
711
    transport_set_ptr.restype = None
 
712
    
 
713
    bye = _library.gnutls_bye
 
714
    bye.argtypes = [session_t, close_request_t]
 
715
    bye.restype = _error_code
 
716
    bye.errcheck = _retry_on_error
 
717
    
 
718
    check_version = _library.gnutls_check_version
 
719
    check_version.argtypes = [ctypes.c_char_p]
 
720
    check_version.restype = ctypes.c_char_p
 
721
    
 
722
    # All the function declarations below are from gnutls/openpgp.h
 
723
    
 
724
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
725
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
726
    openpgp_crt_init.restype = _error_code
 
727
    
 
728
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
729
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
730
                                   ctypes.POINTER(datum_t),
 
731
                                   openpgp_crt_fmt_t]
 
732
    openpgp_crt_import.restype = _error_code
 
733
    
 
734
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
735
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
736
                                        ctypes.POINTER(ctypes.c_uint)]
 
737
    openpgp_crt_verify_self.restype = _error_code
 
738
    
 
739
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
740
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
741
    openpgp_crt_deinit.restype = None
 
742
    
 
743
    openpgp_crt_get_fingerprint = (
 
744
        _library.gnutls_openpgp_crt_get_fingerprint)
 
745
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
746
                                            ctypes.c_void_p,
 
747
                                            ctypes.POINTER(
 
748
                                                ctypes.c_size_t)]
 
749
    openpgp_crt_get_fingerprint.restype = _error_code
 
750
    
 
751
    # Remove non-public functions
 
752
    del _error_code, _retry_on_error
 
753
# Create the global "gnutls" object, simulating a module
 
754
gnutls = GnuTLS()
 
755
 
 
756
def call_pipe(connection,       # : multiprocessing.Connection
 
757
              func, *args, **kwargs):
 
758
    """This function is meant to be called by multiprocessing.Process
 
759
    
 
760
    This function runs func(*args, **kwargs), and writes the resulting
 
761
    return value on the provided multiprocessing.Connection.
 
762
    """
 
763
    connection.send(func(*args, **kwargs))
 
764
    connection.close()
 
765
 
388
766
class Client(object):
389
767
    """A representation of a client host served by this server.
390
768
    
395
773
    checker:    subprocess.Popen(); a running checker process used
396
774
                                    to see if the client lives.
397
775
                                    'None' if no process is running.
398
 
    checker_callback_tag: a gobject event source tag, or None
 
776
    checker_callback_tag: a GLib event source tag, or None
399
777
    checker_command: string; External command which is run to check
400
778
                     if client lives.  %() expansions are done at
401
779
                     runtime with vars(self) as dict, so that for
402
780
                     instance %(name)s can be used in the command.
403
 
    checker_initiator_tag: a gobject event source tag, or None
 
781
    checker_initiator_tag: a GLib event source tag, or None
404
782
    created:    datetime.datetime(); (UTC) object creation
405
783
    client_structure: Object describing what attributes a client has
406
784
                      and is used for storing the client at exit
407
785
    current_checker_command: string; current running checker_command
408
 
    disable_initiator_tag: a gobject event source tag, or None
 
786
    disable_initiator_tag: a GLib event source tag, or None
409
787
    enabled:    bool()
410
788
    fingerprint: string (40 or 32 hexadecimal digits); used to
411
789
                 uniquely identify the client
416
794
    last_checker_status: integer between 0 and 255 reflecting exit
417
795
                         status of last checker. -1 reflects crashed
418
796
                         checker, -2 means no checker completed yet.
 
797
    last_checker_signal: The signal which killed the last checker, if
 
798
                         last_checker_status is -1
419
799
    last_enabled: datetime.datetime(); (UTC) or None
420
800
    name:       string; from the config file, used in log messages and
421
801
                        D-Bus identifiers
426
806
    runtime_expansions: Allowed attributes for runtime expansion.
427
807
    expires:    datetime.datetime(); time (UTC) when a client will be
428
808
                disabled, or None
 
809
    server_settings: The server_settings dict from main()
429
810
    """
430
811
    
431
812
    runtime_expansions = ("approval_delay", "approval_duration",
432
 
                          "created", "enabled", "fingerprint",
433
 
                          "host", "interval", "last_checked_ok",
 
813
                          "created", "enabled", "expires",
 
814
                          "fingerprint", "host", "interval",
 
815
                          "last_approval_request", "last_checked_ok",
434
816
                          "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
 
 
 
817
    client_defaults = {
 
818
        "timeout": "PT5M",
 
819
        "extended_timeout": "PT15M",
 
820
        "interval": "PT2M",
 
821
        "checker": "fping -q -- %%(host)s",
 
822
        "host": "",
 
823
        "approval_delay": "PT0S",
 
824
        "approval_duration": "PT1S",
 
825
        "approved_by_default": "True",
 
826
        "enabled": "True",
 
827
    }
 
828
    
461
829
    @staticmethod
462
830
    def config_parser(config):
463
831
        """Construct a new dict of client settings of this form:
478
846
            client["enabled"] = config.getboolean(client_name,
479
847
                                                  "enabled")
480
848
            
 
849
            # Uppercase and remove spaces from fingerprint for later
 
850
            # comparison purposes with return value from the
 
851
            # fingerprint() function
481
852
            client["fingerprint"] = (section["fingerprint"].upper()
482
853
                                     .replace(" ", ""))
483
854
            if "secret" in section:
484
 
                client["secret"] = section["secret"].decode("base64")
 
855
                client["secret"] = codecs.decode(section["secret"]
 
856
                                                 .encode("utf-8"),
 
857
                                                 "base64")
485
858
            elif "secfile" in section:
486
859
                with open(os.path.expanduser(os.path.expandvars
487
860
                                             (section["secfile"])),
488
861
                          "rb") as secfile:
489
862
                    client["secret"] = secfile.read()
490
863
            else:
491
 
                raise TypeError("No secret or secfile for section %s"
492
 
                                % section)
 
864
                raise TypeError("No secret or secfile for section {}"
 
865
                                .format(section))
493
866
            client["timeout"] = string_to_delta(section["timeout"])
494
867
            client["extended_timeout"] = string_to_delta(
495
868
                section["extended_timeout"])
504
877
            client["last_checker_status"] = -2
505
878
        
506
879
        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."""
 
880
    
 
881
    def __init__(self, settings, name = None, server_settings=None):
513
882
        self.name = name
 
883
        if server_settings is None:
 
884
            server_settings = {}
 
885
        self.server_settings = server_settings
514
886
        # adding all client settings
515
 
        for setting, value in settings.iteritems():
 
887
        for setting, value in settings.items():
516
888
            setattr(self, setting, value)
517
889
        
518
890
        if self.enabled:
524
896
        else:
525
897
            self.last_enabled = None
526
898
            self.expires = None
527
 
       
 
899
        
528
900
        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
901
        logger.debug("  Fingerprint: %s", self.fingerprint)
533
902
        self.created = settings.get("created",
534
903
                                    datetime.datetime.utcnow())
535
 
 
 
904
        
536
905
        # attributes specific for this server instance
537
906
        self.checker = None
538
907
        self.checker_initiator_tag = None
541
910
        self.current_checker_command = None
542
911
        self.approved = None
543
912
        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()
 
913
        self.changedstate = multiprocessing_manager.Condition(
 
914
            multiprocessing_manager.Lock())
 
915
        self.client_structure = [attr
 
916
                                 for attr in self.__dict__.keys()
549
917
                                 if not attr.startswith("_")]
550
918
        self.client_structure.append("client_structure")
551
919
        
552
 
        for name, t in inspect.getmembers(type(self),
553
 
                                          lambda obj:
554
 
                                              isinstance(obj,
555
 
                                                         property)):
 
920
        for name, t in inspect.getmembers(
 
921
                type(self), lambda obj: isinstance(obj, property)):
556
922
            if not name.startswith("_"):
557
923
                self.client_structure.append(name)
558
924
    
566
932
        if getattr(self, "enabled", False):
567
933
            # Already enabled
568
934
            return
569
 
        self.send_changedstate()
570
935
        self.expires = datetime.datetime.utcnow() + self.timeout
571
936
        self.enabled = True
572
937
        self.last_enabled = datetime.datetime.utcnow()
573
938
        self.init_checker()
 
939
        self.send_changedstate()
574
940
    
575
941
    def disable(self, quiet=True):
576
942
        """Disable this client."""
577
943
        if not getattr(self, "enabled", False):
578
944
            return False
579
945
        if not quiet:
580
 
            self.send_changedstate()
581
 
        if not quiet:
582
946
            logger.info("Disabling client %s", self.name)
583
 
        if getattr(self, "disable_initiator_tag", False):
584
 
            gobject.source_remove(self.disable_initiator_tag)
 
947
        if getattr(self, "disable_initiator_tag", None) is not None:
 
948
            GLib.source_remove(self.disable_initiator_tag)
585
949
            self.disable_initiator_tag = None
586
950
        self.expires = None
587
 
        if getattr(self, "checker_initiator_tag", False):
588
 
            gobject.source_remove(self.checker_initiator_tag)
 
951
        if getattr(self, "checker_initiator_tag", None) is not None:
 
952
            GLib.source_remove(self.checker_initiator_tag)
589
953
            self.checker_initiator_tag = None
590
954
        self.stop_checker()
591
955
        self.enabled = False
592
 
        # Do not run this again if called by a gobject.timeout_add
 
956
        if not quiet:
 
957
            self.send_changedstate()
 
958
        # Do not run this again if called by a GLib.timeout_add
593
959
        return False
594
960
    
595
961
    def __del__(self):
598
964
    def init_checker(self):
599
965
        # Schedule a new checker to be started an 'interval' from now,
600
966
        # and every interval from then on.
601
 
        self.checker_initiator_tag = (gobject.timeout_add
602
 
                                      (self.interval_milliseconds(),
603
 
                                       self.start_checker))
 
967
        if self.checker_initiator_tag is not None:
 
968
            GLib.source_remove(self.checker_initiator_tag)
 
969
        self.checker_initiator_tag = GLib.timeout_add(
 
970
            int(self.interval.total_seconds() * 1000),
 
971
            self.start_checker)
604
972
        # Schedule a disable() when 'timeout' has passed
605
 
        self.disable_initiator_tag = (gobject.timeout_add
606
 
                                   (self.timeout_milliseconds(),
607
 
                                    self.disable))
 
973
        if self.disable_initiator_tag is not None:
 
974
            GLib.source_remove(self.disable_initiator_tag)
 
975
        self.disable_initiator_tag = GLib.timeout_add(
 
976
            int(self.timeout.total_seconds() * 1000), self.disable)
608
977
        # Also start a new checker *right now*.
609
978
        self.start_checker()
610
979
    
611
 
    def checker_callback(self, pid, condition, command):
 
980
    def checker_callback(self, source, condition, connection,
 
981
                         command):
612
982
        """The checker has completed, so take appropriate actions."""
613
983
        self.checker_callback_tag = None
614
984
        self.checker = None
615
 
        if os.WIFEXITED(condition):
616
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
985
        # Read return code from connection (see call_pipe)
 
986
        returncode = connection.recv()
 
987
        connection.close()
 
988
        
 
989
        if returncode >= 0:
 
990
            self.last_checker_status = returncode
 
991
            self.last_checker_signal = None
617
992
            if self.last_checker_status == 0:
618
993
                logger.info("Checker for %(name)s succeeded",
619
994
                            vars(self))
620
995
                self.checked_ok()
621
996
            else:
622
 
                logger.info("Checker for %(name)s failed",
623
 
                            vars(self))
 
997
                logger.info("Checker for %(name)s failed", vars(self))
624
998
        else:
625
999
            self.last_checker_status = -1
 
1000
            self.last_checker_signal = -returncode
626
1001
            logger.warning("Checker for %(name)s crashed?",
627
1002
                           vars(self))
 
1003
        return False
628
1004
    
629
1005
    def checked_ok(self):
630
1006
        """Assert that the client has been seen, alive and well."""
631
1007
        self.last_checked_ok = datetime.datetime.utcnow()
632
1008
        self.last_checker_status = 0
 
1009
        self.last_checker_signal = None
633
1010
        self.bump_timeout()
634
1011
    
635
1012
    def bump_timeout(self, timeout=None):
637
1014
        if timeout is None:
638
1015
            timeout = self.timeout
639
1016
        if self.disable_initiator_tag is not None:
640
 
            gobject.source_remove(self.disable_initiator_tag)
 
1017
            GLib.source_remove(self.disable_initiator_tag)
 
1018
            self.disable_initiator_tag = None
641
1019
        if getattr(self, "enabled", False):
642
 
            self.disable_initiator_tag = (gobject.timeout_add
643
 
                                          (timedelta_to_milliseconds
644
 
                                           (timeout), self.disable))
 
1020
            self.disable_initiator_tag = GLib.timeout_add(
 
1021
                int(timeout.total_seconds() * 1000), self.disable)
645
1022
            self.expires = datetime.datetime.utcnow() + timeout
646
1023
    
647
1024
    def need_approval(self):
653
1030
        If a checker already exists, leave it running and do
654
1031
        nothing."""
655
1032
        # The reason for not killing a running checker is that if we
656
 
        # did that, then if a checker (for some reason) started
657
 
        # running slowly and taking more than 'interval' time, the
658
 
        # client would inevitably timeout, since no checker would get
659
 
        # a chance to run to completion.  If we instead leave running
 
1033
        # did that, and if a checker (for some reason) started running
 
1034
        # slowly and taking more than 'interval' time, then the client
 
1035
        # would inevitably timeout, since no checker would get a
 
1036
        # chance to run to completion.  If we instead leave running
660
1037
        # checkers alone, the checker would have to take more time
661
1038
        # than 'timeout' for the client to be disabled, which is as it
662
1039
        # should be.
663
1040
        
664
 
        # If a checker exists, make sure it is not a zombie
665
 
        try:
666
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
667
 
        except (AttributeError, OSError) as error:
668
 
            if (isinstance(error, OSError)
669
 
                and error.errno != errno.ECHILD):
670
 
                raise error
671
 
        else:
672
 
            if pid:
673
 
                logger.warning("Checker was a zombie")
674
 
                gobject.source_remove(self.checker_callback_tag)
675
 
                self.checker_callback(pid, status,
676
 
                                      self.current_checker_command)
 
1041
        if self.checker is not None and not self.checker.is_alive():
 
1042
            logger.warning("Checker was not alive; joining")
 
1043
            self.checker.join()
 
1044
            self.checker = None
677
1045
        # Start a new checker if needed
678
1046
        if self.checker is None:
 
1047
            # Escape attributes for the shell
 
1048
            escaped_attrs = {
 
1049
                attr: re.escape(str(getattr(self, attr)))
 
1050
                for attr in self.runtime_expansions }
679
1051
            try:
680
 
                # In case checker_command has exactly one % operator
681
 
                command = self.checker_command % self.host
682
 
            except TypeError:
683
 
                # Escape attributes for the shell
684
 
                escaped_attrs = dict(
685
 
                    (attr,
686
 
                     re.escape(unicode(str(getattr(self, attr, "")),
687
 
                                       errors=
688
 
                                       'replace')))
689
 
                    for attr in
690
 
                    self.runtime_expansions)
691
 
                
692
 
                try:
693
 
                    command = self.checker_command % escaped_attrs
694
 
                except TypeError as error:
695
 
                    logger.error('Could not format string "%s":'
696
 
                                 ' %s', self.checker_command, error)
697
 
                    return True # Try again later
 
1052
                command = self.checker_command % escaped_attrs
 
1053
            except TypeError as error:
 
1054
                logger.error('Could not format string "%s"',
 
1055
                             self.checker_command,
 
1056
                             exc_info=error)
 
1057
                return True     # Try again later
698
1058
            self.current_checker_command = command
699
 
            try:
700
 
                logger.info("Starting checker %r for %s",
701
 
                            command, self.name)
702
 
                # We don't need to redirect stdout and stderr, since
703
 
                # in normal mode, that is already done by daemon(),
704
 
                # and in debug mode we don't want to.  (Stdin is
705
 
                # always replaced by /dev/null.)
706
 
                self.checker = subprocess.Popen(command,
707
 
                                                close_fds=True,
708
 
                                                shell=True, cwd="/")
709
 
                self.checker_callback_tag = (gobject.child_watch_add
710
 
                                             (self.checker.pid,
711
 
                                              self.checker_callback,
712
 
                                              data=command))
713
 
                # The checker may have completed before the gobject
714
 
                # watch was added.  Check for this.
715
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
716
 
                if pid:
717
 
                    gobject.source_remove(self.checker_callback_tag)
718
 
                    self.checker_callback(pid, status, command)
719
 
            except OSError as error:
720
 
                logger.error("Failed to start subprocess: %s",
721
 
                             error)
722
 
        # Re-run this periodically if run by gobject.timeout_add
 
1059
            logger.info("Starting checker %r for %s", command,
 
1060
                        self.name)
 
1061
            # We don't need to redirect stdout and stderr, since
 
1062
            # in normal mode, that is already done by daemon(),
 
1063
            # and in debug mode we don't want to.  (Stdin is
 
1064
            # always replaced by /dev/null.)
 
1065
            # The exception is when not debugging but nevertheless
 
1066
            # running in the foreground; use the previously
 
1067
            # created wnull.
 
1068
            popen_args = { "close_fds": True,
 
1069
                           "shell": True,
 
1070
                           "cwd": "/" }
 
1071
            if (not self.server_settings["debug"]
 
1072
                and self.server_settings["foreground"]):
 
1073
                popen_args.update({"stdout": wnull,
 
1074
                                   "stderr": wnull })
 
1075
            pipe = multiprocessing.Pipe(duplex = False)
 
1076
            self.checker = multiprocessing.Process(
 
1077
                target = call_pipe,
 
1078
                args = (pipe[1], subprocess.call, command),
 
1079
                kwargs = popen_args)
 
1080
            self.checker.start()
 
1081
            self.checker_callback_tag = GLib.io_add_watch(
 
1082
                pipe[0].fileno(), GLib.IO_IN,
 
1083
                self.checker_callback, pipe[0], command)
 
1084
        # Re-run this periodically if run by GLib.timeout_add
723
1085
        return True
724
1086
    
725
1087
    def stop_checker(self):
726
1088
        """Force the checker process, if any, to stop."""
727
1089
        if self.checker_callback_tag:
728
 
            gobject.source_remove(self.checker_callback_tag)
 
1090
            GLib.source_remove(self.checker_callback_tag)
729
1091
            self.checker_callback_tag = None
730
1092
        if getattr(self, "checker", None) is None:
731
1093
            return
732
1094
        logger.debug("Stopping checker for %(name)s", vars(self))
733
 
        try:
734
 
            os.kill(self.checker.pid, signal.SIGTERM)
735
 
            #time.sleep(0.5)
736
 
            #if self.checker.poll() is None:
737
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
738
 
        except OSError as error:
739
 
            if error.errno != errno.ESRCH: # No such process
740
 
                raise
 
1095
        self.checker.terminate()
741
1096
        self.checker = None
742
1097
 
743
1098
 
744
 
def dbus_service_property(dbus_interface, signature="v",
745
 
                          access="readwrite", byte_arrays=False):
 
1099
def dbus_service_property(dbus_interface,
 
1100
                          signature="v",
 
1101
                          access="readwrite",
 
1102
                          byte_arrays=False):
746
1103
    """Decorators for marking methods of a DBusObjectWithProperties to
747
1104
    become properties on the D-Bus.
748
1105
    
757
1114
    # "Set" method, so we fail early here:
758
1115
    if byte_arrays and signature != "ay":
759
1116
        raise ValueError("Byte arrays not supported for non-'ay'"
760
 
                         " signature %r" % signature)
 
1117
                         " signature {!r}".format(signature))
 
1118
    
761
1119
    def decorator(func):
762
1120
        func._dbus_is_property = True
763
1121
        func._dbus_interface = dbus_interface
768
1126
            func._dbus_name = func._dbus_name[:-14]
769
1127
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
770
1128
        return func
 
1129
    
 
1130
    return decorator
 
1131
 
 
1132
 
 
1133
def dbus_interface_annotations(dbus_interface):
 
1134
    """Decorator for marking functions returning interface annotations
 
1135
    
 
1136
    Usage:
 
1137
    
 
1138
    @dbus_interface_annotations("org.example.Interface")
 
1139
    def _foo(self):  # Function name does not matter
 
1140
        return {"org.freedesktop.DBus.Deprecated": "true",
 
1141
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1142
                    "false"}
 
1143
    """
 
1144
    
 
1145
    def decorator(func):
 
1146
        func._dbus_is_interface = True
 
1147
        func._dbus_interface = dbus_interface
 
1148
        func._dbus_name = dbus_interface
 
1149
        return func
 
1150
    
 
1151
    return decorator
 
1152
 
 
1153
 
 
1154
def dbus_annotations(annotations):
 
1155
    """Decorator to annotate D-Bus methods, signals or properties
 
1156
    Usage:
 
1157
    
 
1158
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
1159
                       "org.freedesktop.DBus.Property."
 
1160
                       "EmitsChangedSignal": "false"})
 
1161
    @dbus_service_property("org.example.Interface", signature="b",
 
1162
                           access="r")
 
1163
    def Property_dbus_property(self):
 
1164
        return dbus.Boolean(False)
 
1165
    
 
1166
    See also the DBusObjectWithAnnotations class.
 
1167
    """
 
1168
    
 
1169
    def decorator(func):
 
1170
        func._dbus_annotations = annotations
 
1171
        return func
 
1172
    
771
1173
    return decorator
772
1174
 
773
1175
 
774
1176
class DBusPropertyException(dbus.exceptions.DBusException):
775
1177
    """A base class for D-Bus property-related exceptions
776
1178
    """
777
 
    def __unicode__(self):
778
 
        return unicode(str(self))
 
1179
    pass
779
1180
 
780
1181
 
781
1182
class DBusPropertyAccessException(DBusPropertyException):
790
1191
    pass
791
1192
 
792
1193
 
793
 
class DBusObjectWithProperties(dbus.service.Object):
 
1194
class DBusObjectWithAnnotations(dbus.service.Object):
 
1195
    """A D-Bus object with annotations.
 
1196
    
 
1197
    Classes inheriting from this can use the dbus_annotations
 
1198
    decorator to add annotations to methods or signals.
 
1199
    """
 
1200
    
 
1201
    @staticmethod
 
1202
    def _is_dbus_thing(thing):
 
1203
        """Returns a function testing if an attribute is a D-Bus thing
 
1204
        
 
1205
        If called like _is_dbus_thing("method") it returns a function
 
1206
        suitable for use as predicate to inspect.getmembers().
 
1207
        """
 
1208
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
1209
                                   False)
 
1210
    
 
1211
    def _get_all_dbus_things(self, thing):
 
1212
        """Returns a generator of (name, attribute) pairs
 
1213
        """
 
1214
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
1215
                 athing.__get__(self))
 
1216
                for cls in self.__class__.__mro__
 
1217
                for name, athing in
 
1218
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
1219
    
 
1220
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1221
                         out_signature = "s",
 
1222
                         path_keyword = 'object_path',
 
1223
                         connection_keyword = 'connection')
 
1224
    def Introspect(self, object_path, connection):
 
1225
        """Overloading of standard D-Bus method.
 
1226
        
 
1227
        Inserts annotation tags on methods and signals.
 
1228
        """
 
1229
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
1230
                                                   connection)
 
1231
        try:
 
1232
            document = xml.dom.minidom.parseString(xmlstring)
 
1233
            
 
1234
            for if_tag in document.getElementsByTagName("interface"):
 
1235
                # Add annotation tags
 
1236
                for typ in ("method", "signal"):
 
1237
                    for tag in if_tag.getElementsByTagName(typ):
 
1238
                        annots = dict()
 
1239
                        for name, prop in (self.
 
1240
                                           _get_all_dbus_things(typ)):
 
1241
                            if (name == tag.getAttribute("name")
 
1242
                                and prop._dbus_interface
 
1243
                                == if_tag.getAttribute("name")):
 
1244
                                annots.update(getattr(
 
1245
                                    prop, "_dbus_annotations", {}))
 
1246
                        for name, value in annots.items():
 
1247
                            ann_tag = document.createElement(
 
1248
                                "annotation")
 
1249
                            ann_tag.setAttribute("name", name)
 
1250
                            ann_tag.setAttribute("value", value)
 
1251
                            tag.appendChild(ann_tag)
 
1252
                # Add interface annotation tags
 
1253
                for annotation, value in dict(
 
1254
                    itertools.chain.from_iterable(
 
1255
                        annotations().items()
 
1256
                        for name, annotations
 
1257
                        in self._get_all_dbus_things("interface")
 
1258
                        if name == if_tag.getAttribute("name")
 
1259
                        )).items():
 
1260
                    ann_tag = document.createElement("annotation")
 
1261
                    ann_tag.setAttribute("name", annotation)
 
1262
                    ann_tag.setAttribute("value", value)
 
1263
                    if_tag.appendChild(ann_tag)
 
1264
                # Fix argument name for the Introspect method itself
 
1265
                if (if_tag.getAttribute("name")
 
1266
                                == dbus.INTROSPECTABLE_IFACE):
 
1267
                    for cn in if_tag.getElementsByTagName("method"):
 
1268
                        if cn.getAttribute("name") == "Introspect":
 
1269
                            for arg in cn.getElementsByTagName("arg"):
 
1270
                                if (arg.getAttribute("direction")
 
1271
                                    == "out"):
 
1272
                                    arg.setAttribute("name",
 
1273
                                                     "xml_data")
 
1274
            xmlstring = document.toxml("utf-8")
 
1275
            document.unlink()
 
1276
        except (AttributeError, xml.dom.DOMException,
 
1277
                xml.parsers.expat.ExpatError) as error:
 
1278
            logger.error("Failed to override Introspection method",
 
1279
                         exc_info=error)
 
1280
        return xmlstring
 
1281
 
 
1282
 
 
1283
class DBusObjectWithProperties(DBusObjectWithAnnotations):
794
1284
    """A D-Bus object with properties.
795
1285
    
796
1286
    Classes inheriting from this can use the dbus_service_property
798
1288
    standard Get(), Set(), and GetAll() methods on the D-Bus.
799
1289
    """
800
1290
    
801
 
    @staticmethod
802
 
    def _is_dbus_property(obj):
803
 
        return getattr(obj, "_dbus_is_property", False)
804
 
    
805
 
    def _get_all_dbus_properties(self):
806
 
        """Returns a generator of (name, attribute) pairs
807
 
        """
808
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
809
 
                for cls in self.__class__.__mro__
810
 
                for name, prop in
811
 
                inspect.getmembers(cls, self._is_dbus_property))
812
 
    
813
1291
    def _get_dbus_property(self, interface_name, property_name):
814
1292
        """Returns a bound method if one exists which is a D-Bus
815
1293
        property with the specified name and interface.
816
1294
        """
817
 
        for cls in  self.__class__.__mro__:
818
 
            for name, value in (inspect.getmembers
819
 
                                (cls, self._is_dbus_property)):
 
1295
        for cls in self.__class__.__mro__:
 
1296
            for name, value in inspect.getmembers(
 
1297
                    cls, self._is_dbus_thing("property")):
820
1298
                if (value._dbus_name == property_name
821
1299
                    and value._dbus_interface == interface_name):
822
1300
                    return value.__get__(self)
823
1301
        
824
1302
        # No such property
825
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
826
 
                                   + interface_name + "."
827
 
                                   + property_name)
828
 
    
829
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
1303
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
1304
            self.dbus_object_path, interface_name, property_name))
 
1305
    
 
1306
    @classmethod
 
1307
    def _get_all_interface_names(cls):
 
1308
        """Get a sequence of all interfaces supported by an object"""
 
1309
        return (name for name in set(getattr(getattr(x, attr),
 
1310
                                             "_dbus_interface", None)
 
1311
                                     for x in (inspect.getmro(cls))
 
1312
                                     for attr in dir(x))
 
1313
                if name is not None)
 
1314
    
 
1315
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1316
                         in_signature="ss",
830
1317
                         out_signature="v")
831
1318
    def Get(self, interface_name, property_name):
832
1319
        """Standard D-Bus property Get() method, see D-Bus standard.
850
1337
            # The byte_arrays option is not supported yet on
851
1338
            # signatures other than "ay".
852
1339
            if prop._dbus_signature != "ay":
853
 
                raise ValueError
 
1340
                raise ValueError("Byte arrays not supported for non-"
 
1341
                                 "'ay' signature {!r}"
 
1342
                                 .format(prop._dbus_signature))
854
1343
            value = dbus.ByteArray(b''.join(chr(byte)
855
1344
                                            for byte in value))
856
1345
        prop(value)
857
1346
    
858
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1347
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1348
                         in_signature="s",
859
1349
                         out_signature="a{sv}")
860
1350
    def GetAll(self, interface_name):
861
1351
        """Standard D-Bus property GetAll() method, see D-Bus
864
1354
        Note: Will not include properties with access="write".
865
1355
        """
866
1356
        properties = {}
867
 
        for name, prop in self._get_all_dbus_properties():
 
1357
        for name, prop in self._get_all_dbus_things("property"):
868
1358
            if (interface_name
869
1359
                and interface_name != prop._dbus_interface):
870
1360
                # Interface non-empty but did not match
876
1366
            if not hasattr(value, "variant_level"):
877
1367
                properties[name] = value
878
1368
                continue
879
 
            properties[name] = type(value)(value, variant_level=
880
 
                                           value.variant_level+1)
 
1369
            properties[name] = type(value)(
 
1370
                value, variant_level = value.variant_level + 1)
881
1371
        return dbus.Dictionary(properties, signature="sv")
882
1372
    
 
1373
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
1374
    def PropertiesChanged(self, interface_name, changed_properties,
 
1375
                          invalidated_properties):
 
1376
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
1377
        standard.
 
1378
        """
 
1379
        pass
 
1380
    
883
1381
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
884
1382
                         out_signature="s",
885
1383
                         path_keyword='object_path',
886
1384
                         connection_keyword='connection')
887
1385
    def Introspect(self, object_path, connection):
888
 
        """Standard D-Bus method, overloaded to insert property tags.
 
1386
        """Overloading of standard D-Bus method.
 
1387
        
 
1388
        Inserts property tags and interface annotation tags.
889
1389
        """
890
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
891
 
                                                   connection)
 
1390
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1391
                                                         object_path,
 
1392
                                                         connection)
892
1393
        try:
893
1394
            document = xml.dom.minidom.parseString(xmlstring)
 
1395
            
894
1396
            def make_tag(document, name, prop):
895
1397
                e = document.createElement("property")
896
1398
                e.setAttribute("name", name)
897
1399
                e.setAttribute("type", prop._dbus_signature)
898
1400
                e.setAttribute("access", prop._dbus_access)
899
1401
                return e
 
1402
            
900
1403
            for if_tag in document.getElementsByTagName("interface"):
 
1404
                # Add property tags
901
1405
                for tag in (make_tag(document, name, prop)
902
1406
                            for name, prop
903
 
                            in self._get_all_dbus_properties()
 
1407
                            in self._get_all_dbus_things("property")
904
1408
                            if prop._dbus_interface
905
1409
                            == if_tag.getAttribute("name")):
906
1410
                    if_tag.appendChild(tag)
 
1411
                # Add annotation tags for properties
 
1412
                for tag in if_tag.getElementsByTagName("property"):
 
1413
                    annots = dict()
 
1414
                    for name, prop in self._get_all_dbus_things(
 
1415
                            "property"):
 
1416
                        if (name == tag.getAttribute("name")
 
1417
                            and prop._dbus_interface
 
1418
                            == if_tag.getAttribute("name")):
 
1419
                            annots.update(getattr(
 
1420
                                prop, "_dbus_annotations", {}))
 
1421
                    for name, value in annots.items():
 
1422
                        ann_tag = document.createElement(
 
1423
                            "annotation")
 
1424
                        ann_tag.setAttribute("name", name)
 
1425
                        ann_tag.setAttribute("value", value)
 
1426
                        tag.appendChild(ann_tag)
907
1427
                # Add the names to the return values for the
908
1428
                # "org.freedesktop.DBus.Properties" methods
909
1429
                if (if_tag.getAttribute("name")
924
1444
        except (AttributeError, xml.dom.DOMException,
925
1445
                xml.parsers.expat.ExpatError) as error:
926
1446
            logger.error("Failed to override Introspection method",
927
 
                         error)
928
 
        return xmlstring
929
 
 
930
 
 
931
 
def datetime_to_dbus (dt, variant_level=0):
 
1447
                         exc_info=error)
 
1448
        return xmlstring
 
1449
 
 
1450
try:
 
1451
    dbus.OBJECT_MANAGER_IFACE
 
1452
except AttributeError:
 
1453
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1454
 
 
1455
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1456
    """A D-Bus object with an ObjectManager.
 
1457
    
 
1458
    Classes inheriting from this exposes the standard
 
1459
    GetManagedObjects call and the InterfacesAdded and
 
1460
    InterfacesRemoved signals on the standard
 
1461
    "org.freedesktop.DBus.ObjectManager" interface.
 
1462
    
 
1463
    Note: No signals are sent automatically; they must be sent
 
1464
    manually.
 
1465
    """
 
1466
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1467
                         out_signature = "a{oa{sa{sv}}}")
 
1468
    def GetManagedObjects(self):
 
1469
        """This function must be overridden"""
 
1470
        raise NotImplementedError()
 
1471
    
 
1472
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1473
                         signature = "oa{sa{sv}}")
 
1474
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1475
        pass
 
1476
    
 
1477
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
 
1478
    def InterfacesRemoved(self, object_path, interfaces):
 
1479
        pass
 
1480
    
 
1481
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1482
                         out_signature = "s",
 
1483
                         path_keyword = 'object_path',
 
1484
                         connection_keyword = 'connection')
 
1485
    def Introspect(self, object_path, connection):
 
1486
        """Overloading of standard D-Bus method.
 
1487
        
 
1488
        Override return argument name of GetManagedObjects to be
 
1489
        "objpath_interfaces_and_properties"
 
1490
        """
 
1491
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1492
                                                         object_path,
 
1493
                                                         connection)
 
1494
        try:
 
1495
            document = xml.dom.minidom.parseString(xmlstring)
 
1496
            
 
1497
            for if_tag in document.getElementsByTagName("interface"):
 
1498
                # Fix argument name for the GetManagedObjects method
 
1499
                if (if_tag.getAttribute("name")
 
1500
                                == dbus.OBJECT_MANAGER_IFACE):
 
1501
                    for cn in if_tag.getElementsByTagName("method"):
 
1502
                        if (cn.getAttribute("name")
 
1503
                            == "GetManagedObjects"):
 
1504
                            for arg in cn.getElementsByTagName("arg"):
 
1505
                                if (arg.getAttribute("direction")
 
1506
                                    == "out"):
 
1507
                                    arg.setAttribute(
 
1508
                                        "name",
 
1509
                                        "objpath_interfaces"
 
1510
                                        "_and_properties")
 
1511
            xmlstring = document.toxml("utf-8")
 
1512
            document.unlink()
 
1513
        except (AttributeError, xml.dom.DOMException,
 
1514
                xml.parsers.expat.ExpatError) as error:
 
1515
            logger.error("Failed to override Introspection method",
 
1516
                         exc_info = error)
 
1517
        return xmlstring
 
1518
 
 
1519
def datetime_to_dbus(dt, variant_level=0):
932
1520
    """Convert a UTC datetime.datetime() to a D-Bus type."""
933
1521
    if dt is None:
934
1522
        return dbus.String("", variant_level = variant_level)
935
 
    return dbus.String(dt.isoformat(),
936
 
                       variant_level=variant_level)
937
 
 
938
 
 
939
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
940
 
                                  .__metaclass__):
941
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
942
 
    will add additional D-Bus attributes matching a certain pattern.
 
1523
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
1524
 
 
1525
 
 
1526
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1527
    """A class decorator; applied to a subclass of
 
1528
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1529
    interface names according to the "alt_interface_names" mapping.
 
1530
    Usage:
 
1531
    
 
1532
    @alternate_dbus_interfaces({"org.example.Interface":
 
1533
                                    "net.example.AlternateInterface"})
 
1534
    class SampleDBusObject(dbus.service.Object):
 
1535
        @dbus.service.method("org.example.Interface")
 
1536
        def SampleDBusMethod():
 
1537
            pass
 
1538
    
 
1539
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1540
    reachable via two interfaces: "org.example.Interface" and
 
1541
    "net.example.AlternateInterface", the latter of which will have
 
1542
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1543
    "true", unless "deprecate" is passed with a False value.
 
1544
    
 
1545
    This works for methods and signals, and also for D-Bus properties
 
1546
    (from DBusObjectWithProperties) and interfaces (from the
 
1547
    dbus_interface_annotations decorator).
943
1548
    """
944
 
    def __new__(mcs, name, bases, attr):
945
 
        # Go through all the base classes which could have D-Bus
946
 
        # methods, signals, or properties in them
947
 
        for base in (b for b in bases
948
 
                     if issubclass(b, dbus.service.Object)):
949
 
            # Go though all attributes of the base class
950
 
            for attrname, attribute in inspect.getmembers(base):
 
1549
    
 
1550
    def wrapper(cls):
 
1551
        for orig_interface_name, alt_interface_name in (
 
1552
                alt_interface_names.items()):
 
1553
            attr = {}
 
1554
            interface_names = set()
 
1555
            # Go though all attributes of the class
 
1556
            for attrname, attribute in inspect.getmembers(cls):
951
1557
                # Ignore non-D-Bus attributes, and D-Bus attributes
952
1558
                # with the wrong interface name
953
1559
                if (not hasattr(attribute, "_dbus_interface")
954
 
                    or not attribute._dbus_interface
955
 
                    .startswith("se.recompile.Mandos")):
 
1560
                    or not attribute._dbus_interface.startswith(
 
1561
                        orig_interface_name)):
956
1562
                    continue
957
1563
                # Create an alternate D-Bus interface name based on
958
1564
                # the current name
959
 
                alt_interface = (attribute._dbus_interface
960
 
                                 .replace("se.recompile.Mandos",
961
 
                                          "se.bsnet.fukt.Mandos"))
 
1565
                alt_interface = attribute._dbus_interface.replace(
 
1566
                    orig_interface_name, alt_interface_name)
 
1567
                interface_names.add(alt_interface)
962
1568
                # Is this a D-Bus signal?
963
1569
                if getattr(attribute, "_dbus_is_signal", False):
964
 
                    # Extract the original non-method function by
965
 
                    # black magic
966
 
                    nonmethod_func = (dict(
 
1570
                    # Extract the original non-method undecorated
 
1571
                    # function by black magic
 
1572
                    if sys.version_info.major == 2:
 
1573
                        nonmethod_func = (dict(
967
1574
                            zip(attribute.func_code.co_freevars,
968
 
                                attribute.__closure__))["func"]
969
 
                                      .cell_contents)
 
1575
                                attribute.__closure__))
 
1576
                                          ["func"].cell_contents)
 
1577
                    else:
 
1578
                        nonmethod_func = (dict(
 
1579
                            zip(attribute.__code__.co_freevars,
 
1580
                                attribute.__closure__))
 
1581
                                          ["func"].cell_contents)
970
1582
                    # Create a new, but exactly alike, function
971
1583
                    # object, and decorate it to be a new D-Bus signal
972
1584
                    # with the alternate D-Bus interface name
973
 
                    new_function = (dbus.service.signal
974
 
                                    (alt_interface,
975
 
                                     attribute._dbus_signature)
976
 
                                    (types.FunctionType(
977
 
                                nonmethod_func.func_code,
978
 
                                nonmethod_func.func_globals,
979
 
                                nonmethod_func.func_name,
980
 
                                nonmethod_func.func_defaults,
981
 
                                nonmethod_func.func_closure)))
 
1585
                    new_function = copy_function(nonmethod_func)
 
1586
                    new_function = (dbus.service.signal(
 
1587
                        alt_interface,
 
1588
                        attribute._dbus_signature)(new_function))
 
1589
                    # Copy annotations, if any
 
1590
                    try:
 
1591
                        new_function._dbus_annotations = dict(
 
1592
                            attribute._dbus_annotations)
 
1593
                    except AttributeError:
 
1594
                        pass
982
1595
                    # Define a creator of a function to call both the
983
 
                    # old and new functions, so both the old and new
984
 
                    # signals gets sent when the function is called
 
1596
                    # original and alternate functions, so both the
 
1597
                    # original and alternate signals gets sent when
 
1598
                    # the function is called
985
1599
                    def fixscope(func1, func2):
986
1600
                        """This function is a scope container to pass
987
1601
                        func1 and func2 to the "call_both" function
988
1602
                        outside of its arguments"""
 
1603
                        
 
1604
                        @functools.wraps(func2)
989
1605
                        def call_both(*args, **kwargs):
990
1606
                            """This function will emit two D-Bus
991
1607
                            signals by calling func1 and func2"""
992
1608
                            func1(*args, **kwargs)
993
1609
                            func2(*args, **kwargs)
 
1610
                        # Make wrapper function look like a D-Bus signal
 
1611
                        for name, attr in inspect.getmembers(func2):
 
1612
                            if name.startswith("_dbus_"):
 
1613
                                setattr(call_both, name, attr)
 
1614
                        
994
1615
                        return call_both
995
1616
                    # Create the "call_both" function and add it to
996
1617
                    # the class
997
 
                    attr[attrname] = fixscope(attribute,
998
 
                                              new_function)
 
1618
                    attr[attrname] = fixscope(attribute, new_function)
999
1619
                # Is this a D-Bus method?
1000
1620
                elif getattr(attribute, "_dbus_is_method", False):
1001
1621
                    # Create a new, but exactly alike, function
1002
1622
                    # object.  Decorate it to be a new D-Bus method
1003
1623
                    # with the alternate D-Bus interface name.  Add it
1004
1624
                    # to the class.
1005
 
                    attr[attrname] = (dbus.service.method
1006
 
                                      (alt_interface,
1007
 
                                       attribute._dbus_in_signature,
1008
 
                                       attribute._dbus_out_signature)
1009
 
                                      (types.FunctionType
1010
 
                                       (attribute.func_code,
1011
 
                                        attribute.func_globals,
1012
 
                                        attribute.func_name,
1013
 
                                        attribute.func_defaults,
1014
 
                                        attribute.func_closure)))
 
1625
                    attr[attrname] = (
 
1626
                        dbus.service.method(
 
1627
                            alt_interface,
 
1628
                            attribute._dbus_in_signature,
 
1629
                            attribute._dbus_out_signature)
 
1630
                        (copy_function(attribute)))
 
1631
                    # Copy annotations, if any
 
1632
                    try:
 
1633
                        attr[attrname]._dbus_annotations = dict(
 
1634
                            attribute._dbus_annotations)
 
1635
                    except AttributeError:
 
1636
                        pass
1015
1637
                # Is this a D-Bus property?
1016
1638
                elif getattr(attribute, "_dbus_is_property", False):
1017
1639
                    # Create a new, but exactly alike, function
1018
1640
                    # object, and decorate it to be a new D-Bus
1019
1641
                    # property with the alternate D-Bus interface
1020
1642
                    # name.  Add it to the class.
1021
 
                    attr[attrname] = (dbus_service_property
1022
 
                                      (alt_interface,
1023
 
                                       attribute._dbus_signature,
1024
 
                                       attribute._dbus_access,
1025
 
                                       attribute
1026
 
                                       ._dbus_get_args_options
1027
 
                                       ["byte_arrays"])
1028
 
                                      (types.FunctionType
1029
 
                                       (attribute.func_code,
1030
 
                                        attribute.func_globals,
1031
 
                                        attribute.func_name,
1032
 
                                        attribute.func_defaults,
1033
 
                                        attribute.func_closure)))
1034
 
        return type.__new__(mcs, name, bases, attr)
1035
 
 
1036
 
 
 
1643
                    attr[attrname] = (dbus_service_property(
 
1644
                        alt_interface, attribute._dbus_signature,
 
1645
                        attribute._dbus_access,
 
1646
                        attribute._dbus_get_args_options
 
1647
                        ["byte_arrays"])
 
1648
                                      (copy_function(attribute)))
 
1649
                    # Copy annotations, if any
 
1650
                    try:
 
1651
                        attr[attrname]._dbus_annotations = dict(
 
1652
                            attribute._dbus_annotations)
 
1653
                    except AttributeError:
 
1654
                        pass
 
1655
                # Is this a D-Bus interface?
 
1656
                elif getattr(attribute, "_dbus_is_interface", False):
 
1657
                    # Create a new, but exactly alike, function
 
1658
                    # object.  Decorate it to be a new D-Bus interface
 
1659
                    # with the alternate D-Bus interface name.  Add it
 
1660
                    # to the class.
 
1661
                    attr[attrname] = (
 
1662
                        dbus_interface_annotations(alt_interface)
 
1663
                        (copy_function(attribute)))
 
1664
            if deprecate:
 
1665
                # Deprecate all alternate interfaces
 
1666
                iname="_AlternateDBusNames_interface_annotation{}"
 
1667
                for interface_name in interface_names:
 
1668
                    
 
1669
                    @dbus_interface_annotations(interface_name)
 
1670
                    def func(self):
 
1671
                        return { "org.freedesktop.DBus.Deprecated":
 
1672
                                 "true" }
 
1673
                    # Find an unused name
 
1674
                    for aname in (iname.format(i)
 
1675
                                  for i in itertools.count()):
 
1676
                        if aname not in attr:
 
1677
                            attr[aname] = func
 
1678
                            break
 
1679
            if interface_names:
 
1680
                # Replace the class with a new subclass of it with
 
1681
                # methods, signals, etc. as created above.
 
1682
                if sys.version_info.major == 2:
 
1683
                    cls = type(b"{}Alternate".format(cls.__name__),
 
1684
                               (cls, ), attr)
 
1685
                else:
 
1686
                    cls = type("{}Alternate".format(cls.__name__),
 
1687
                               (cls, ), attr)
 
1688
        return cls
 
1689
    
 
1690
    return wrapper
 
1691
 
 
1692
 
 
1693
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1694
                            "se.bsnet.fukt.Mandos"})
1037
1695
class ClientDBus(Client, DBusObjectWithProperties):
1038
1696
    """A Client class using D-Bus
1039
1697
    
1043
1701
    """
1044
1702
    
1045
1703
    runtime_expansions = (Client.runtime_expansions
1046
 
                          + ("dbus_object_path",))
 
1704
                          + ("dbus_object_path", ))
 
1705
    
 
1706
    _interface = "se.recompile.Mandos.Client"
1047
1707
    
1048
1708
    # dbus.service.Object doesn't use super(), so we can't either.
1049
1709
    
1052
1712
        Client.__init__(self, *args, **kwargs)
1053
1713
        # Only now, when this client is initialized, can it show up on
1054
1714
        # the D-Bus
1055
 
        client_object_name = unicode(self.name).translate(
 
1715
        client_object_name = str(self.name).translate(
1056
1716
            {ord("."): ord("_"),
1057
1717
             ord("-"): ord("_")})
1058
 
        self.dbus_object_path = (dbus.ObjectPath
1059
 
                                 ("/clients/" + client_object_name))
 
1718
        self.dbus_object_path = dbus.ObjectPath(
 
1719
            "/clients/" + client_object_name)
1060
1720
        DBusObjectWithProperties.__init__(self, self.bus,
1061
1721
                                          self.dbus_object_path)
1062
 
        
1063
 
    def notifychangeproperty(transform_func,
1064
 
                             dbus_name, type_func=lambda x: x,
1065
 
                             variant_level=1):
 
1722
    
 
1723
    def notifychangeproperty(transform_func, dbus_name,
 
1724
                             type_func=lambda x: x,
 
1725
                             variant_level=1,
 
1726
                             invalidate_only=False,
 
1727
                             _interface=_interface):
1066
1728
        """ Modify a variable so that it's a property which announces
1067
1729
        its changes to DBus.
1068
1730
        
1073
1735
                   to the D-Bus.  Default: no transform
1074
1736
        variant_level: D-Bus variant level.  Default: 1
1075
1737
        """
1076
 
        attrname = "_{0}".format(dbus_name)
 
1738
        attrname = "_{}".format(dbus_name)
 
1739
        
1077
1740
        def setter(self, value):
1078
1741
            if hasattr(self, "dbus_object_path"):
1079
1742
                if (not hasattr(self, attrname) or
1080
1743
                    type_func(getattr(self, attrname, None))
1081
1744
                    != type_func(value)):
1082
 
                    dbus_value = transform_func(type_func(value),
1083
 
                                                variant_level
1084
 
                                                =variant_level)
1085
 
                    self.PropertyChanged(dbus.String(dbus_name),
1086
 
                                         dbus_value)
 
1745
                    if invalidate_only:
 
1746
                        self.PropertiesChanged(
 
1747
                            _interface, dbus.Dictionary(),
 
1748
                            dbus.Array((dbus_name, )))
 
1749
                    else:
 
1750
                        dbus_value = transform_func(
 
1751
                            type_func(value),
 
1752
                            variant_level = variant_level)
 
1753
                        self.PropertyChanged(dbus.String(dbus_name),
 
1754
                                             dbus_value)
 
1755
                        self.PropertiesChanged(
 
1756
                            _interface,
 
1757
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1758
                                              dbus_value }),
 
1759
                            dbus.Array())
1087
1760
            setattr(self, attrname, value)
1088
1761
        
1089
1762
        return property(lambda self: getattr(self, attrname), setter)
1090
1763
    
1091
 
    
1092
1764
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1093
1765
    approvals_pending = notifychangeproperty(dbus.Boolean,
1094
1766
                                             "ApprovalPending",
1096
1768
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1097
1769
    last_enabled = notifychangeproperty(datetime_to_dbus,
1098
1770
                                        "LastEnabled")
1099
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1100
 
                                   type_func = lambda checker:
1101
 
                                       checker is not None)
 
1771
    checker = notifychangeproperty(
 
1772
        dbus.Boolean, "CheckerRunning",
 
1773
        type_func = lambda checker: checker is not None)
1102
1774
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1103
1775
                                           "LastCheckedOK")
1104
1776
    last_checker_status = notifychangeproperty(dbus.Int16,
1107
1779
        datetime_to_dbus, "LastApprovalRequest")
1108
1780
    approved_by_default = notifychangeproperty(dbus.Boolean,
1109
1781
                                               "ApprovedByDefault")
1110
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1111
 
                                          "ApprovalDelay",
1112
 
                                          type_func =
1113
 
                                          timedelta_to_milliseconds)
 
1782
    approval_delay = notifychangeproperty(
 
1783
        dbus.UInt64, "ApprovalDelay",
 
1784
        type_func = lambda td: td.total_seconds() * 1000)
1114
1785
    approval_duration = notifychangeproperty(
1115
1786
        dbus.UInt64, "ApprovalDuration",
1116
 
        type_func = timedelta_to_milliseconds)
 
1787
        type_func = lambda td: td.total_seconds() * 1000)
1117
1788
    host = notifychangeproperty(dbus.String, "Host")
1118
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1119
 
                                   type_func =
1120
 
                                   timedelta_to_milliseconds)
 
1789
    timeout = notifychangeproperty(
 
1790
        dbus.UInt64, "Timeout",
 
1791
        type_func = lambda td: td.total_seconds() * 1000)
1121
1792
    extended_timeout = notifychangeproperty(
1122
1793
        dbus.UInt64, "ExtendedTimeout",
1123
 
        type_func = timedelta_to_milliseconds)
1124
 
    interval = notifychangeproperty(dbus.UInt64,
1125
 
                                    "Interval",
1126
 
                                    type_func =
1127
 
                                    timedelta_to_milliseconds)
 
1794
        type_func = lambda td: td.total_seconds() * 1000)
 
1795
    interval = notifychangeproperty(
 
1796
        dbus.UInt64, "Interval",
 
1797
        type_func = lambda td: td.total_seconds() * 1000)
1128
1798
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1799
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1800
                                  invalidate_only=True)
1129
1801
    
1130
1802
    del notifychangeproperty
1131
1803
    
1138
1810
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1139
1811
        Client.__del__(self, *args, **kwargs)
1140
1812
    
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)
 
1813
    def checker_callback(self, source, condition,
 
1814
                         connection, command, *args, **kwargs):
 
1815
        ret = Client.checker_callback(self, source, condition,
 
1816
                                      connection, command, *args,
 
1817
                                      **kwargs)
 
1818
        exitstatus = self.last_checker_status
 
1819
        if exitstatus >= 0:
1147
1820
            # Emit D-Bus signal
1148
1821
            self.CheckerCompleted(dbus.Int16(exitstatus),
1149
 
                                  dbus.Int64(condition),
 
1822
                                  # This is specific to GNU libC
 
1823
                                  dbus.Int64(exitstatus << 8),
1150
1824
                                  dbus.String(command))
1151
1825
        else:
1152
1826
            # Emit D-Bus signal
1153
1827
            self.CheckerCompleted(dbus.Int16(-1),
1154
 
                                  dbus.Int64(condition),
 
1828
                                  dbus.Int64(
 
1829
                                      # This is specific to GNU libC
 
1830
                                      (exitstatus << 8)
 
1831
                                      | self.last_checker_signal),
1155
1832
                                  dbus.String(command))
1156
 
        
1157
 
        return Client.checker_callback(self, pid, condition, command,
1158
 
                                       *args, **kwargs)
 
1833
        return ret
1159
1834
    
1160
1835
    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
 
1836
        old_checker_pid = getattr(self.checker, "pid", None)
1166
1837
        r = Client.start_checker(self, *args, **kwargs)
1167
1838
        # Only if new checker process was started
1168
1839
        if (self.checker is not None
1176
1847
        return False
1177
1848
    
1178
1849
    def approve(self, value=True):
1179
 
        self.send_changedstate()
1180
1850
        self.approved = value
1181
 
        gobject.timeout_add(timedelta_to_milliseconds
1182
 
                            (self.approval_duration),
1183
 
                            self._reset_approved)
1184
 
    
 
1851
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1852
                             * 1000), self._reset_approved)
 
1853
        self.send_changedstate()
1185
1854
    
1186
1855
    ## D-Bus methods, signals & properties
1187
 
    _interface = "se.recompile.Mandos.Client"
 
1856
    
 
1857
    ## Interfaces
1188
1858
    
1189
1859
    ## Signals
1190
1860
    
1201
1871
        pass
1202
1872
    
1203
1873
    # PropertyChanged - signal
 
1874
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1204
1875
    @dbus.service.signal(_interface, signature="sv")
1205
1876
    def PropertyChanged(self, property, value):
1206
1877
        "D-Bus signal"
1240
1911
        self.checked_ok()
1241
1912
    
1242
1913
    # Enable - method
 
1914
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1243
1915
    @dbus.service.method(_interface)
1244
1916
    def Enable(self):
1245
1917
        "D-Bus method"
1246
1918
        self.enable()
1247
1919
    
1248
1920
    # StartChecker - method
 
1921
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1249
1922
    @dbus.service.method(_interface)
1250
1923
    def StartChecker(self):
1251
1924
        "D-Bus method"
1252
1925
        self.start_checker()
1253
1926
    
1254
1927
    # Disable - method
 
1928
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1255
1929
    @dbus.service.method(_interface)
1256
1930
    def Disable(self):
1257
1931
        "D-Bus method"
1258
1932
        self.disable()
1259
1933
    
1260
1934
    # StopChecker - method
 
1935
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1261
1936
    @dbus.service.method(_interface)
1262
1937
    def StopChecker(self):
1263
1938
        self.stop_checker()
1270
1945
        return dbus.Boolean(bool(self.approvals_pending))
1271
1946
    
1272
1947
    # ApprovedByDefault - property
1273
 
    @dbus_service_property(_interface, signature="b",
 
1948
    @dbus_service_property(_interface,
 
1949
                           signature="b",
1274
1950
                           access="readwrite")
1275
1951
    def ApprovedByDefault_dbus_property(self, value=None):
1276
1952
        if value is None:       # get
1278
1954
        self.approved_by_default = bool(value)
1279
1955
    
1280
1956
    # ApprovalDelay - property
1281
 
    @dbus_service_property(_interface, signature="t",
 
1957
    @dbus_service_property(_interface,
 
1958
                           signature="t",
1282
1959
                           access="readwrite")
1283
1960
    def ApprovalDelay_dbus_property(self, value=None):
1284
1961
        if value is None:       # get
1285
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1962
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1963
                               * 1000)
1286
1964
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1287
1965
    
1288
1966
    # ApprovalDuration - property
1289
 
    @dbus_service_property(_interface, signature="t",
 
1967
    @dbus_service_property(_interface,
 
1968
                           signature="t",
1290
1969
                           access="readwrite")
1291
1970
    def ApprovalDuration_dbus_property(self, value=None):
1292
1971
        if value is None:       # get
1293
 
            return dbus.UInt64(timedelta_to_milliseconds(
1294
 
                    self.approval_duration))
 
1972
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1973
                               * 1000)
1295
1974
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1296
1975
    
1297
1976
    # Name - property
 
1977
    @dbus_annotations(
 
1978
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1298
1979
    @dbus_service_property(_interface, signature="s", access="read")
1299
1980
    def Name_dbus_property(self):
1300
1981
        return dbus.String(self.name)
1301
1982
    
1302
1983
    # Fingerprint - property
 
1984
    @dbus_annotations(
 
1985
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1303
1986
    @dbus_service_property(_interface, signature="s", access="read")
1304
1987
    def Fingerprint_dbus_property(self):
1305
1988
        return dbus.String(self.fingerprint)
1306
1989
    
1307
1990
    # Host - property
1308
 
    @dbus_service_property(_interface, signature="s",
 
1991
    @dbus_service_property(_interface,
 
1992
                           signature="s",
1309
1993
                           access="readwrite")
1310
1994
    def Host_dbus_property(self, value=None):
1311
1995
        if value is None:       # get
1312
1996
            return dbus.String(self.host)
1313
 
        self.host = unicode(value)
 
1997
        self.host = str(value)
1314
1998
    
1315
1999
    # Created - property
 
2000
    @dbus_annotations(
 
2001
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1316
2002
    @dbus_service_property(_interface, signature="s", access="read")
1317
2003
    def Created_dbus_property(self):
1318
2004
        return datetime_to_dbus(self.created)
1323
2009
        return datetime_to_dbus(self.last_enabled)
1324
2010
    
1325
2011
    # Enabled - property
1326
 
    @dbus_service_property(_interface, signature="b",
 
2012
    @dbus_service_property(_interface,
 
2013
                           signature="b",
1327
2014
                           access="readwrite")
1328
2015
    def Enabled_dbus_property(self, value=None):
1329
2016
        if value is None:       # get
1334
2021
            self.disable()
1335
2022
    
1336
2023
    # LastCheckedOK - property
1337
 
    @dbus_service_property(_interface, signature="s",
 
2024
    @dbus_service_property(_interface,
 
2025
                           signature="s",
1338
2026
                           access="readwrite")
1339
2027
    def LastCheckedOK_dbus_property(self, value=None):
1340
2028
        if value is not None:
1343
2031
        return datetime_to_dbus(self.last_checked_ok)
1344
2032
    
1345
2033
    # LastCheckerStatus - property
1346
 
    @dbus_service_property(_interface, signature="n",
1347
 
                           access="read")
 
2034
    @dbus_service_property(_interface, signature="n", access="read")
1348
2035
    def LastCheckerStatus_dbus_property(self):
1349
2036
        return dbus.Int16(self.last_checker_status)
1350
2037
    
1359
2046
        return datetime_to_dbus(self.last_approval_request)
1360
2047
    
1361
2048
    # Timeout - property
1362
 
    @dbus_service_property(_interface, signature="t",
 
2049
    @dbus_service_property(_interface,
 
2050
                           signature="t",
1363
2051
                           access="readwrite")
1364
2052
    def Timeout_dbus_property(self, value=None):
1365
2053
        if value is None:       # get
1366
 
            return dbus.UInt64(self.timeout_milliseconds())
 
2054
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
2055
        old_timeout = self.timeout
1367
2056
        self.timeout = datetime.timedelta(0, 0, 0, value)
1368
 
        # Reschedule timeout
 
2057
        # Reschedule disabling
1369
2058
        if self.enabled:
1370
2059
            now = datetime.datetime.utcnow()
1371
 
            time_to_die = timedelta_to_milliseconds(
1372
 
                (self.last_checked_ok + self.timeout) - now)
1373
 
            if time_to_die <= 0:
 
2060
            self.expires += self.timeout - old_timeout
 
2061
            if self.expires <= now:
1374
2062
                # The timeout has passed
1375
2063
                self.disable()
1376
2064
            else:
1377
 
                self.expires = (now +
1378
 
                                datetime.timedelta(milliseconds =
1379
 
                                                   time_to_die))
1380
2065
                if (getattr(self, "disable_initiator_tag", None)
1381
2066
                    is None):
1382
2067
                    return
1383
 
                gobject.source_remove(self.disable_initiator_tag)
1384
 
                self.disable_initiator_tag = (gobject.timeout_add
1385
 
                                              (time_to_die,
1386
 
                                               self.disable))
 
2068
                GLib.source_remove(self.disable_initiator_tag)
 
2069
                self.disable_initiator_tag = GLib.timeout_add(
 
2070
                    int((self.expires - now).total_seconds() * 1000),
 
2071
                    self.disable)
1387
2072
    
1388
2073
    # ExtendedTimeout - property
1389
 
    @dbus_service_property(_interface, signature="t",
 
2074
    @dbus_service_property(_interface,
 
2075
                           signature="t",
1390
2076
                           access="readwrite")
1391
2077
    def ExtendedTimeout_dbus_property(self, value=None):
1392
2078
        if value is None:       # get
1393
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
2079
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
2080
                               * 1000)
1394
2081
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1395
2082
    
1396
2083
    # Interval - property
1397
 
    @dbus_service_property(_interface, signature="t",
 
2084
    @dbus_service_property(_interface,
 
2085
                           signature="t",
1398
2086
                           access="readwrite")
1399
2087
    def Interval_dbus_property(self, value=None):
1400
2088
        if value is None:       # get
1401
 
            return dbus.UInt64(self.interval_milliseconds())
 
2089
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1402
2090
        self.interval = datetime.timedelta(0, 0, 0, value)
1403
2091
        if getattr(self, "checker_initiator_tag", None) is None:
1404
2092
            return
1405
2093
        if self.enabled:
1406
2094
            # Reschedule checker run
1407
 
            gobject.source_remove(self.checker_initiator_tag)
1408
 
            self.checker_initiator_tag = (gobject.timeout_add
1409
 
                                          (value, self.start_checker))
1410
 
            self.start_checker()    # Start one now, too
 
2095
            GLib.source_remove(self.checker_initiator_tag)
 
2096
            self.checker_initiator_tag = GLib.timeout_add(
 
2097
                value, self.start_checker)
 
2098
            self.start_checker() # Start one now, too
1411
2099
    
1412
2100
    # Checker - property
1413
 
    @dbus_service_property(_interface, signature="s",
 
2101
    @dbus_service_property(_interface,
 
2102
                           signature="s",
1414
2103
                           access="readwrite")
1415
2104
    def Checker_dbus_property(self, value=None):
1416
2105
        if value is None:       # get
1417
2106
            return dbus.String(self.checker_command)
1418
 
        self.checker_command = unicode(value)
 
2107
        self.checker_command = str(value)
1419
2108
    
1420
2109
    # CheckerRunning - property
1421
 
    @dbus_service_property(_interface, signature="b",
 
2110
    @dbus_service_property(_interface,
 
2111
                           signature="b",
1422
2112
                           access="readwrite")
1423
2113
    def CheckerRunning_dbus_property(self, value=None):
1424
2114
        if value is None:       # get
1429
2119
            self.stop_checker()
1430
2120
    
1431
2121
    # ObjectPath - property
 
2122
    @dbus_annotations(
 
2123
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2124
         "org.freedesktop.DBus.Deprecated": "true"})
1432
2125
    @dbus_service_property(_interface, signature="o", access="read")
1433
2126
    def ObjectPath_dbus_property(self):
1434
2127
        return self.dbus_object_path # is already a dbus.ObjectPath
1435
2128
    
1436
2129
    # Secret = property
1437
 
    @dbus_service_property(_interface, signature="ay",
1438
 
                           access="write", byte_arrays=True)
 
2130
    @dbus_annotations(
 
2131
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2132
         "invalidates"})
 
2133
    @dbus_service_property(_interface,
 
2134
                           signature="ay",
 
2135
                           access="write",
 
2136
                           byte_arrays=True)
1439
2137
    def Secret_dbus_property(self, value):
1440
 
        self.secret = str(value)
 
2138
        self.secret = bytes(value)
1441
2139
    
1442
2140
    del _interface
1443
2141
 
1447
2145
        self._pipe = child_pipe
1448
2146
        self._pipe.send(('init', fpr, address))
1449
2147
        if not self._pipe.recv():
1450
 
            raise KeyError()
 
2148
            raise KeyError(fpr)
1451
2149
    
1452
2150
    def __getattribute__(self, name):
1453
2151
        if name == '_pipe':
1457
2155
        if data[0] == 'data':
1458
2156
            return data[1]
1459
2157
        if data[0] == 'function':
 
2158
            
1460
2159
            def func(*args, **kwargs):
1461
2160
                self._pipe.send(('funcall', name, args, kwargs))
1462
2161
                return self._pipe.recv()[1]
 
2162
            
1463
2163
            return func
1464
2164
    
1465
2165
    def __setattr__(self, name, value):
1468
2168
        self._pipe.send(('setattr', name, value))
1469
2169
 
1470
2170
 
1471
 
class ClientDBusTransitional(ClientDBus):
1472
 
    __metaclass__ = AlternateDBusNamesMetaclass
1473
 
 
1474
 
 
1475
2171
class ClientHandler(socketserver.BaseRequestHandler, object):
1476
2172
    """A class to handle client connections.
1477
2173
    
1481
2177
    def handle(self):
1482
2178
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1483
2179
            logger.info("TCP connection from: %s",
1484
 
                        unicode(self.client_address))
 
2180
                        str(self.client_address))
1485
2181
            logger.debug("Pipe FD: %d",
1486
2182
                         self.server.child_pipe.fileno())
1487
2183
            
1488
 
            session = (gnutls.connection
1489
 
                       .ClientSession(self.request,
1490
 
                                      gnutls.connection
1491
 
                                      .X509Credentials()))
1492
 
            
1493
 
            # Note: gnutls.connection.X509Credentials is really a
1494
 
            # generic GnuTLS certificate credentials object so long as
1495
 
            # no X.509 keys are added to it.  Therefore, we can use it
1496
 
            # here despite using OpenPGP certificates.
 
2184
            session = gnutls.ClientSession(self.request)
1497
2185
            
1498
2186
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1499
2187
            #                      "+AES-256-CBC", "+SHA1",
1503
2191
            priority = self.server.gnutls_priority
1504
2192
            if priority is None:
1505
2193
                priority = "NORMAL"
1506
 
            (gnutls.library.functions
1507
 
             .gnutls_priority_set_direct(session._c_object,
1508
 
                                         priority, None))
 
2194
            gnutls.priority_set_direct(session._c_object,
 
2195
                                       priority.encode("utf-8"),
 
2196
                                       None)
1509
2197
            
1510
2198
            # Start communication using the Mandos protocol
1511
2199
            # Get protocol number
1513
2201
            logger.debug("Protocol version: %r", line)
1514
2202
            try:
1515
2203
                if int(line.strip().split()[0]) > 1:
1516
 
                    raise RuntimeError
 
2204
                    raise RuntimeError(line)
1517
2205
            except (ValueError, IndexError, RuntimeError) as error:
1518
2206
                logger.error("Unknown protocol version: %s", error)
1519
2207
                return
1521
2209
            # Start GnuTLS connection
1522
2210
            try:
1523
2211
                session.handshake()
1524
 
            except gnutls.errors.GNUTLSError as error:
 
2212
            except gnutls.Error as error:
1525
2213
                logger.warning("Handshake failed: %s", error)
1526
2214
                # Do not run session.bye() here: the session is not
1527
2215
                # established.  Just abandon the request.
1531
2219
            approval_required = False
1532
2220
            try:
1533
2221
                try:
1534
 
                    fpr = self.fingerprint(self.peer_certificate
1535
 
                                           (session))
1536
 
                except (TypeError,
1537
 
                        gnutls.errors.GNUTLSError) as error:
 
2222
                    fpr = self.fingerprint(
 
2223
                        self.peer_certificate(session))
 
2224
                except (TypeError, gnutls.Error) as error:
1538
2225
                    logger.warning("Bad certificate: %s", error)
1539
2226
                    return
1540
2227
                logger.debug("Fingerprint: %s", fpr)
1553
2240
                while True:
1554
2241
                    if not client.enabled:
1555
2242
                        logger.info("Client %s is disabled",
1556
 
                                       client.name)
 
2243
                                    client.name)
1557
2244
                        if self.server.use_dbus:
1558
2245
                            # Emit D-Bus signal
1559
2246
                            client.Rejected("Disabled")
1568
2255
                        if self.server.use_dbus:
1569
2256
                            # Emit D-Bus signal
1570
2257
                            client.NeedApproval(
1571
 
                                client.approval_delay_milliseconds(),
1572
 
                                client.approved_by_default)
 
2258
                                client.approval_delay.total_seconds()
 
2259
                                * 1000, client.approved_by_default)
1573
2260
                    else:
1574
2261
                        logger.warning("Client %s was not approved",
1575
2262
                                       client.name)
1581
2268
                    #wait until timeout or approved
1582
2269
                    time = datetime.datetime.now()
1583
2270
                    client.changedstate.acquire()
1584
 
                    (client.changedstate.wait
1585
 
                     (float(client.timedelta_to_milliseconds(delay)
1586
 
                            / 1000)))
 
2271
                    client.changedstate.wait(delay.total_seconds())
1587
2272
                    client.changedstate.release()
1588
2273
                    time2 = datetime.datetime.now()
1589
2274
                    if (time2 - time) >= delay:
1600
2285
                    else:
1601
2286
                        delay -= time2 - time
1602
2287
                
1603
 
                sent_size = 0
1604
 
                while sent_size < len(client.secret):
1605
 
                    try:
1606
 
                        sent = session.send(client.secret[sent_size:])
1607
 
                    except gnutls.errors.GNUTLSError as error:
1608
 
                        logger.warning("gnutls send failed")
1609
 
                        return
1610
 
                    logger.debug("Sent: %d, remaining: %d",
1611
 
                                 sent, len(client.secret)
1612
 
                                 - (sent_size + sent))
1613
 
                    sent_size += sent
 
2288
                try:
 
2289
                    session.send(client.secret)
 
2290
                except gnutls.Error as error:
 
2291
                    logger.warning("gnutls send failed",
 
2292
                                   exc_info = error)
 
2293
                    return
1614
2294
                
1615
2295
                logger.info("Sending secret to %s", client.name)
1616
2296
                # bump the timeout using extended_timeout
1624
2304
                    client.approvals_pending -= 1
1625
2305
                try:
1626
2306
                    session.bye()
1627
 
                except gnutls.errors.GNUTLSError as error:
1628
 
                    logger.warning("GnuTLS bye failed")
 
2307
                except gnutls.Error as error:
 
2308
                    logger.warning("GnuTLS bye failed",
 
2309
                                   exc_info=error)
1629
2310
    
1630
2311
    @staticmethod
1631
2312
    def peer_certificate(session):
1632
2313
        "Return the peer's OpenPGP certificate as a bytestring"
1633
2314
        # If not an OpenPGP certificate...
1634
 
        if (gnutls.library.functions
1635
 
            .gnutls_certificate_type_get(session._c_object)
1636
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1637
 
            # ...do the normal thing
1638
 
            return session.peer_certificate
 
2315
        if (gnutls.certificate_type_get(session._c_object)
 
2316
            != gnutls.CRT_OPENPGP):
 
2317
            # ...return invalid data
 
2318
            return b""
1639
2319
        list_size = ctypes.c_uint(1)
1640
 
        cert_list = (gnutls.library.functions
1641
 
                     .gnutls_certificate_get_peers
 
2320
        cert_list = (gnutls.certificate_get_peers
1642
2321
                     (session._c_object, ctypes.byref(list_size)))
1643
2322
        if not bool(cert_list) and list_size.value != 0:
1644
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1645
 
                                            " certificate")
 
2323
            raise gnutls.Error("error getting peer certificate")
1646
2324
        if list_size.value == 0:
1647
2325
            return None
1648
2326
        cert = cert_list[0]
1652
2330
    def fingerprint(openpgp):
1653
2331
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1654
2332
        # New GnuTLS "datum" with the OpenPGP public key
1655
 
        datum = (gnutls.library.types
1656
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1657
 
                                             ctypes.POINTER
1658
 
                                             (ctypes.c_ubyte)),
1659
 
                                 ctypes.c_uint(len(openpgp))))
 
2333
        datum = gnutls.datum_t(
 
2334
            ctypes.cast(ctypes.c_char_p(openpgp),
 
2335
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2336
            ctypes.c_uint(len(openpgp)))
1660
2337
        # New empty GnuTLS certificate
1661
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1662
 
        (gnutls.library.functions
1663
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2338
        crt = gnutls.openpgp_crt_t()
 
2339
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1664
2340
        # Import the OpenPGP public key into the certificate
1665
 
        (gnutls.library.functions
1666
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1667
 
                                    gnutls.library.constants
1668
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2341
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2342
                                  gnutls.OPENPGP_FMT_RAW)
1669
2343
        # Verify the self signature in the key
1670
2344
        crtverify = ctypes.c_uint()
1671
 
        (gnutls.library.functions
1672
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1673
 
                                         ctypes.byref(crtverify)))
 
2345
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2346
                                       ctypes.byref(crtverify))
1674
2347
        if crtverify.value != 0:
1675
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1676
 
            raise (gnutls.errors.CertificateSecurityError
1677
 
                   ("Verify failed"))
 
2348
            gnutls.openpgp_crt_deinit(crt)
 
2349
            raise gnutls.CertificateSecurityError("Verify failed")
1678
2350
        # New buffer for the fingerprint
1679
2351
        buf = ctypes.create_string_buffer(20)
1680
2352
        buf_len = ctypes.c_size_t()
1681
2353
        # Get the fingerprint from the certificate into the buffer
1682
 
        (gnutls.library.functions
1683
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1684
 
                                             ctypes.byref(buf_len)))
 
2354
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2355
                                           ctypes.byref(buf_len))
1685
2356
        # Deinit the certificate
1686
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2357
        gnutls.openpgp_crt_deinit(crt)
1687
2358
        # Convert the buffer to a Python bytestring
1688
2359
        fpr = ctypes.string_at(buf, buf_len.value)
1689
2360
        # Convert the bytestring to hexadecimal notation
1693
2364
 
1694
2365
class MultiprocessingMixIn(object):
1695
2366
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2367
    
1696
2368
    def sub_process_main(self, request, address):
1697
2369
        try:
1698
2370
            self.finish_request(request, address)
1703
2375
    def process_request(self, request, address):
1704
2376
        """Start a new process to process the request."""
1705
2377
        proc = multiprocessing.Process(target = self.sub_process_main,
1706
 
                                       args = (request,
1707
 
                                               address))
 
2378
                                       args = (request, address))
1708
2379
        proc.start()
1709
2380
        return proc
1710
2381
 
1711
2382
 
1712
2383
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1713
2384
    """ adds a pipe to the MixIn """
 
2385
    
1714
2386
    def process_request(self, request, client_address):
1715
2387
        """Overrides and wraps the original process_request().
1716
2388
        
1725
2397
    
1726
2398
    def add_pipe(self, parent_pipe, proc):
1727
2399
        """Dummy function; override as necessary"""
1728
 
        raise NotImplementedError
 
2400
        raise NotImplementedError()
1729
2401
 
1730
2402
 
1731
2403
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1737
2409
        interface:      None or a network interface name (string)
1738
2410
        use_ipv6:       Boolean; to use IPv6 or not
1739
2411
    """
 
2412
    
1740
2413
    def __init__(self, server_address, RequestHandlerClass,
1741
 
                 interface=None, use_ipv6=True):
 
2414
                 interface=None,
 
2415
                 use_ipv6=True,
 
2416
                 socketfd=None):
 
2417
        """If socketfd is set, use that file descriptor instead of
 
2418
        creating a new one with socket.socket().
 
2419
        """
1742
2420
        self.interface = interface
1743
2421
        if use_ipv6:
1744
2422
            self.address_family = socket.AF_INET6
 
2423
        if socketfd is not None:
 
2424
            # Save the file descriptor
 
2425
            self.socketfd = socketfd
 
2426
            # Save the original socket.socket() function
 
2427
            self.socket_socket = socket.socket
 
2428
            # To implement --socket, we monkey patch socket.socket.
 
2429
            # 
 
2430
            # (When socketserver.TCPServer is a new-style class, we
 
2431
            # could make self.socket into a property instead of monkey
 
2432
            # patching socket.socket.)
 
2433
            # 
 
2434
            # Create a one-time-only replacement for socket.socket()
 
2435
            @functools.wraps(socket.socket)
 
2436
            def socket_wrapper(*args, **kwargs):
 
2437
                # Restore original function so subsequent calls are
 
2438
                # not affected.
 
2439
                socket.socket = self.socket_socket
 
2440
                del self.socket_socket
 
2441
                # This time only, return a new socket object from the
 
2442
                # saved file descriptor.
 
2443
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
2444
            # Replace socket.socket() function with wrapper
 
2445
            socket.socket = socket_wrapper
 
2446
        # The socketserver.TCPServer.__init__ will call
 
2447
        # socket.socket(), which might be our replacement,
 
2448
        # socket_wrapper(), if socketfd was set.
1745
2449
        socketserver.TCPServer.__init__(self, server_address,
1746
2450
                                        RequestHandlerClass)
 
2451
    
1747
2452
    def server_bind(self):
1748
2453
        """This overrides the normal server_bind() function
1749
2454
        to bind to an interface if one was specified, and also NOT to
1750
2455
        bind to an address or port if they were not specified."""
 
2456
        global SO_BINDTODEVICE
1751
2457
        if self.interface is not None:
1752
2458
            if SO_BINDTODEVICE is None:
1753
 
                logger.error("SO_BINDTODEVICE does not exist;"
1754
 
                             " cannot bind to interface %s",
1755
 
                             self.interface)
1756
 
            else:
1757
 
                try:
1758
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1759
 
                                           SO_BINDTODEVICE,
1760
 
                                           str(self.interface
1761
 
                                               + '\0'))
1762
 
                except socket.error as error:
1763
 
                    if error[0] == errno.EPERM:
1764
 
                        logger.error("No permission to"
1765
 
                                     " bind to interface %s",
1766
 
                                     self.interface)
1767
 
                    elif error[0] == errno.ENOPROTOOPT:
1768
 
                        logger.error("SO_BINDTODEVICE not available;"
1769
 
                                     " cannot bind to interface %s",
1770
 
                                     self.interface)
1771
 
                    else:
1772
 
                        raise
 
2459
                # Fall back to a hard-coded value which seems to be
 
2460
                # common enough.
 
2461
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2462
                SO_BINDTODEVICE = 25
 
2463
            try:
 
2464
                self.socket.setsockopt(
 
2465
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2466
                    (self.interface + "\0").encode("utf-8"))
 
2467
            except socket.error as error:
 
2468
                if error.errno == errno.EPERM:
 
2469
                    logger.error("No permission to bind to"
 
2470
                                 " interface %s", self.interface)
 
2471
                elif error.errno == errno.ENOPROTOOPT:
 
2472
                    logger.error("SO_BINDTODEVICE not available;"
 
2473
                                 " cannot bind to interface %s",
 
2474
                                 self.interface)
 
2475
                elif error.errno == errno.ENODEV:
 
2476
                    logger.error("Interface %s does not exist,"
 
2477
                                 " cannot bind", self.interface)
 
2478
                else:
 
2479
                    raise
1773
2480
        # Only bind(2) the socket if we really need to.
1774
2481
        if self.server_address[0] or self.server_address[1]:
1775
2482
            if not self.server_address[0]:
1776
2483
                if self.address_family == socket.AF_INET6:
1777
2484
                    any_address = "::" # in6addr_any
1778
2485
                else:
1779
 
                    any_address = socket.INADDR_ANY
 
2486
                    any_address = "0.0.0.0" # INADDR_ANY
1780
2487
                self.server_address = (any_address,
1781
2488
                                       self.server_address[1])
1782
2489
            elif not self.server_address[1]:
1783
 
                self.server_address = (self.server_address[0],
1784
 
                                       0)
 
2490
                self.server_address = (self.server_address[0], 0)
1785
2491
#                 if self.interface:
1786
2492
#                     self.server_address = (self.server_address[0],
1787
2493
#                                            0, # port
1799
2505
        gnutls_priority GnuTLS priority string
1800
2506
        use_dbus:       Boolean; to emit D-Bus signals or not
1801
2507
    
1802
 
    Assumes a gobject.MainLoop event loop.
 
2508
    Assumes a GLib.MainLoop event loop.
1803
2509
    """
 
2510
    
1804
2511
    def __init__(self, server_address, RequestHandlerClass,
1805
 
                 interface=None, use_ipv6=True, clients=None,
1806
 
                 gnutls_priority=None, use_dbus=True):
 
2512
                 interface=None,
 
2513
                 use_ipv6=True,
 
2514
                 clients=None,
 
2515
                 gnutls_priority=None,
 
2516
                 use_dbus=True,
 
2517
                 socketfd=None):
1807
2518
        self.enabled = False
1808
2519
        self.clients = clients
1809
2520
        if self.clients is None:
1813
2524
        IPv6_TCPServer.__init__(self, server_address,
1814
2525
                                RequestHandlerClass,
1815
2526
                                interface = interface,
1816
 
                                use_ipv6 = use_ipv6)
 
2527
                                use_ipv6 = use_ipv6,
 
2528
                                socketfd = socketfd)
 
2529
    
1817
2530
    def server_activate(self):
1818
2531
        if self.enabled:
1819
2532
            return socketserver.TCPServer.server_activate(self)
1823
2536
    
1824
2537
    def add_pipe(self, parent_pipe, proc):
1825
2538
        # Call "handle_ipc" for both data and EOF events
1826
 
        gobject.io_add_watch(parent_pipe.fileno(),
1827
 
                             gobject.IO_IN | gobject.IO_HUP,
1828
 
                             functools.partial(self.handle_ipc,
1829
 
                                               parent_pipe =
1830
 
                                               parent_pipe,
1831
 
                                               proc = proc))
 
2539
        GLib.io_add_watch(
 
2540
            parent_pipe.fileno(),
 
2541
            GLib.IO_IN | GLib.IO_HUP,
 
2542
            functools.partial(self.handle_ipc,
 
2543
                              parent_pipe = parent_pipe,
 
2544
                              proc = proc))
1832
2545
    
1833
 
    def handle_ipc(self, source, condition, parent_pipe=None,
1834
 
                   proc = None, client_object=None):
1835
 
        condition_names = {
1836
 
            gobject.IO_IN: "IN",   # There is data to read.
1837
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1838
 
                                    # blocking).
1839
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1840
 
            gobject.IO_ERR: "ERR", # Error condition.
1841
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1842
 
                                    # broken, usually for pipes and
1843
 
                                    # sockets).
1844
 
            }
1845
 
        conditions_string = ' | '.join(name
1846
 
                                       for cond, name in
1847
 
                                       condition_names.iteritems()
1848
 
                                       if cond & condition)
 
2546
    def handle_ipc(self, source, condition,
 
2547
                   parent_pipe=None,
 
2548
                   proc = None,
 
2549
                   client_object=None):
1849
2550
        # error, or the other end of multiprocessing.Pipe has closed
1850
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2551
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
1851
2552
            # Wait for other process to exit
1852
2553
            proc.join()
1853
2554
            return False
1860
2561
            fpr = request[1]
1861
2562
            address = request[2]
1862
2563
            
1863
 
            for c in self.clients.itervalues():
 
2564
            for c in self.clients.values():
1864
2565
                if c.fingerprint == fpr:
1865
2566
                    client = c
1866
2567
                    break
1874
2575
                parent_pipe.send(False)
1875
2576
                return False
1876
2577
            
1877
 
            gobject.io_add_watch(parent_pipe.fileno(),
1878
 
                                 gobject.IO_IN | gobject.IO_HUP,
1879
 
                                 functools.partial(self.handle_ipc,
1880
 
                                                   parent_pipe =
1881
 
                                                   parent_pipe,
1882
 
                                                   proc = proc,
1883
 
                                                   client_object =
1884
 
                                                   client))
 
2578
            GLib.io_add_watch(
 
2579
                parent_pipe.fileno(),
 
2580
                GLib.IO_IN | GLib.IO_HUP,
 
2581
                functools.partial(self.handle_ipc,
 
2582
                                  parent_pipe = parent_pipe,
 
2583
                                  proc = proc,
 
2584
                                  client_object = client))
1885
2585
            parent_pipe.send(True)
1886
2586
            # remove the old hook in favor of the new above hook on
1887
2587
            # same fileno
1893
2593
            
1894
2594
            parent_pipe.send(('data', getattr(client_object,
1895
2595
                                              funcname)(*args,
1896
 
                                                         **kwargs)))
 
2596
                                                        **kwargs)))
1897
2597
        
1898
2598
        if command == 'getattr':
1899
2599
            attrname = request[1]
1900
 
            if callable(client_object.__getattribute__(attrname)):
1901
 
                parent_pipe.send(('function',))
 
2600
            if isinstance(client_object.__getattribute__(attrname),
 
2601
                          collections.Callable):
 
2602
                parent_pipe.send(('function', ))
1902
2603
            else:
1903
 
                parent_pipe.send(('data', client_object
1904
 
                                  .__getattribute__(attrname)))
 
2604
                parent_pipe.send((
 
2605
                    'data', client_object.__getattribute__(attrname)))
1905
2606
        
1906
2607
        if command == 'setattr':
1907
2608
            attrname = request[1]
1911
2612
        return True
1912
2613
 
1913
2614
 
 
2615
def rfc3339_duration_to_delta(duration):
 
2616
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2617
    
 
2618
    >>> rfc3339_duration_to_delta("P7D")
 
2619
    datetime.timedelta(7)
 
2620
    >>> rfc3339_duration_to_delta("PT60S")
 
2621
    datetime.timedelta(0, 60)
 
2622
    >>> rfc3339_duration_to_delta("PT60M")
 
2623
    datetime.timedelta(0, 3600)
 
2624
    >>> rfc3339_duration_to_delta("PT24H")
 
2625
    datetime.timedelta(1)
 
2626
    >>> rfc3339_duration_to_delta("P1W")
 
2627
    datetime.timedelta(7)
 
2628
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2629
    datetime.timedelta(0, 330)
 
2630
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2631
    datetime.timedelta(1, 200)
 
2632
    """
 
2633
    
 
2634
    # Parsing an RFC 3339 duration with regular expressions is not
 
2635
    # possible - there would have to be multiple places for the same
 
2636
    # values, like seconds.  The current code, while more esoteric, is
 
2637
    # cleaner without depending on a parsing library.  If Python had a
 
2638
    # built-in library for parsing we would use it, but we'd like to
 
2639
    # avoid excessive use of external libraries.
 
2640
    
 
2641
    # New type for defining tokens, syntax, and semantics all-in-one
 
2642
    Token = collections.namedtuple("Token", (
 
2643
        "regexp",  # To match token; if "value" is not None, must have
 
2644
                   # a "group" containing digits
 
2645
        "value",   # datetime.timedelta or None
 
2646
        "followers"))           # Tokens valid after this token
 
2647
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2648
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2649
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2650
    token_second = Token(re.compile(r"(\d+)S"),
 
2651
                         datetime.timedelta(seconds=1),
 
2652
                         frozenset((token_end, )))
 
2653
    token_minute = Token(re.compile(r"(\d+)M"),
 
2654
                         datetime.timedelta(minutes=1),
 
2655
                         frozenset((token_second, token_end)))
 
2656
    token_hour = Token(re.compile(r"(\d+)H"),
 
2657
                       datetime.timedelta(hours=1),
 
2658
                       frozenset((token_minute, token_end)))
 
2659
    token_time = Token(re.compile(r"T"),
 
2660
                       None,
 
2661
                       frozenset((token_hour, token_minute,
 
2662
                                  token_second)))
 
2663
    token_day = Token(re.compile(r"(\d+)D"),
 
2664
                      datetime.timedelta(days=1),
 
2665
                      frozenset((token_time, token_end)))
 
2666
    token_month = Token(re.compile(r"(\d+)M"),
 
2667
                        datetime.timedelta(weeks=4),
 
2668
                        frozenset((token_day, token_end)))
 
2669
    token_year = Token(re.compile(r"(\d+)Y"),
 
2670
                       datetime.timedelta(weeks=52),
 
2671
                       frozenset((token_month, token_end)))
 
2672
    token_week = Token(re.compile(r"(\d+)W"),
 
2673
                       datetime.timedelta(weeks=1),
 
2674
                       frozenset((token_end, )))
 
2675
    token_duration = Token(re.compile(r"P"), None,
 
2676
                           frozenset((token_year, token_month,
 
2677
                                      token_day, token_time,
 
2678
                                      token_week)))
 
2679
    # Define starting values
 
2680
    value = datetime.timedelta() # Value so far
 
2681
    found_token = None
 
2682
    followers = frozenset((token_duration, )) # Following valid tokens
 
2683
    s = duration                # String left to parse
 
2684
    # Loop until end token is found
 
2685
    while found_token is not token_end:
 
2686
        # Search for any currently valid tokens
 
2687
        for token in followers:
 
2688
            match = token.regexp.match(s)
 
2689
            if match is not None:
 
2690
                # Token found
 
2691
                if token.value is not None:
 
2692
                    # Value found, parse digits
 
2693
                    factor = int(match.group(1), 10)
 
2694
                    # Add to value so far
 
2695
                    value += factor * token.value
 
2696
                # Strip token from string
 
2697
                s = token.regexp.sub("", s, 1)
 
2698
                # Go to found token
 
2699
                found_token = token
 
2700
                # Set valid next tokens
 
2701
                followers = found_token.followers
 
2702
                break
 
2703
        else:
 
2704
            # No currently valid tokens were found
 
2705
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2706
                             .format(duration))
 
2707
    # End token found
 
2708
    return value
 
2709
 
 
2710
 
1914
2711
def string_to_delta(interval):
1915
2712
    """Parse a string and return a datetime.timedelta
1916
2713
    
1927
2724
    >>> string_to_delta('5m 30s')
1928
2725
    datetime.timedelta(0, 330)
1929
2726
    """
 
2727
    
 
2728
    try:
 
2729
        return rfc3339_duration_to_delta(interval)
 
2730
    except ValueError:
 
2731
        pass
 
2732
    
1930
2733
    timevalue = datetime.timedelta(0)
1931
2734
    for s in interval.split():
1932
2735
        try:
1933
 
            suffix = unicode(s[-1])
 
2736
            suffix = s[-1]
1934
2737
            value = int(s[:-1])
1935
2738
            if suffix == "d":
1936
2739
                delta = datetime.timedelta(value)
1943
2746
            elif suffix == "w":
1944
2747
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1945
2748
            else:
1946
 
                raise ValueError("Unknown suffix %r" % suffix)
1947
 
        except (ValueError, IndexError) as e:
 
2749
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2750
        except IndexError as e:
1948
2751
            raise ValueError(*(e.args))
1949
2752
        timevalue += delta
1950
2753
    return timevalue
1963
2766
        sys.exit()
1964
2767
    if not noclose:
1965
2768
        # Close all standard open file descriptors
1966
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2769
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1967
2770
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1968
2771
            raise OSError(errno.ENODEV,
1969
 
                          "%s not a character device"
1970
 
                          % os.path.devnull)
 
2772
                          "{} not a character device"
 
2773
                          .format(os.devnull))
1971
2774
        os.dup2(null, sys.stdin.fileno())
1972
2775
        os.dup2(null, sys.stdout.fileno())
1973
2776
        os.dup2(null, sys.stderr.fileno())
1982
2785
    
1983
2786
    parser = argparse.ArgumentParser()
1984
2787
    parser.add_argument("-v", "--version", action="version",
1985
 
                        version = "%%(prog)s %s" % version,
 
2788
                        version = "%(prog)s {}".format(version),
1986
2789
                        help="show version number and exit")
1987
2790
    parser.add_argument("-i", "--interface", metavar="IF",
1988
2791
                        help="Bind to interface IF")
1994
2797
                        help="Run self-test")
1995
2798
    parser.add_argument("--debug", action="store_true",
1996
2799
                        help="Debug mode; run in foreground and log"
1997
 
                        " to terminal")
 
2800
                        " to terminal", default=None)
1998
2801
    parser.add_argument("--debuglevel", metavar="LEVEL",
1999
2802
                        help="Debug level for stdout output")
2000
2803
    parser.add_argument("--priority", help="GnuTLS"
2007
2810
                        " files")
2008
2811
    parser.add_argument("--no-dbus", action="store_false",
2009
2812
                        dest="use_dbus", help="Do not provide D-Bus"
2010
 
                        " system bus interface")
 
2813
                        " system bus interface", default=None)
2011
2814
    parser.add_argument("--no-ipv6", action="store_false",
2012
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2815
                        dest="use_ipv6", help="Do not use IPv6",
 
2816
                        default=None)
2013
2817
    parser.add_argument("--no-restore", action="store_false",
2014
2818
                        dest="restore", help="Do not restore stored"
2015
 
                        " state")
 
2819
                        " state", default=None)
 
2820
    parser.add_argument("--socket", type=int,
 
2821
                        help="Specify a file descriptor to a network"
 
2822
                        " socket to use instead of creating one")
2016
2823
    parser.add_argument("--statedir", metavar="DIR",
2017
2824
                        help="Directory to save/restore state in")
 
2825
    parser.add_argument("--foreground", action="store_true",
 
2826
                        help="Run in foreground", default=None)
 
2827
    parser.add_argument("--no-zeroconf", action="store_false",
 
2828
                        dest="zeroconf", help="Do not use Zeroconf",
 
2829
                        default=None)
2018
2830
    
2019
2831
    options = parser.parse_args()
2020
2832
    
2021
2833
    if options.check:
2022
2834
        import doctest
2023
 
        doctest.testmod()
2024
 
        sys.exit()
 
2835
        fail_count, test_count = doctest.testmod()
 
2836
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2025
2837
    
2026
2838
    # Default values for config file for server-global settings
2027
2839
    server_defaults = { "interface": "",
2029
2841
                        "port": "",
2030
2842
                        "debug": "False",
2031
2843
                        "priority":
2032
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2844
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2845
                        ":+SIGN-DSA-SHA256",
2033
2846
                        "servicename": "Mandos",
2034
2847
                        "use_dbus": "True",
2035
2848
                        "use_ipv6": "True",
2036
2849
                        "debuglevel": "",
2037
2850
                        "restore": "True",
2038
 
                        "statedir": "/var/lib/mandos"
2039
 
                        }
 
2851
                        "socket": "",
 
2852
                        "statedir": "/var/lib/mandos",
 
2853
                        "foreground": "False",
 
2854
                        "zeroconf": "True",
 
2855
                    }
2040
2856
    
2041
2857
    # Parse config file for server-global settings
2042
2858
    server_config = configparser.SafeConfigParser(server_defaults)
2043
2859
    del server_defaults
2044
 
    server_config.read(os.path.join(options.configdir,
2045
 
                                    "mandos.conf"))
 
2860
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2046
2861
    # Convert the SafeConfigParser object to a dict
2047
2862
    server_settings = server_config.defaults()
2048
2863
    # Use the appropriate methods on the non-string config options
2049
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2864
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2050
2865
        server_settings[option] = server_config.getboolean("DEFAULT",
2051
2866
                                                           option)
2052
2867
    if server_settings["port"]:
2053
2868
        server_settings["port"] = server_config.getint("DEFAULT",
2054
2869
                                                       "port")
 
2870
    if server_settings["socket"]:
 
2871
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2872
                                                         "socket")
 
2873
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2874
        # over with an opened os.devnull.  But we don't want this to
 
2875
        # happen with a supplied network socket.
 
2876
        if 0 <= server_settings["socket"] <= 2:
 
2877
            server_settings["socket"] = os.dup(server_settings
 
2878
                                               ["socket"])
2055
2879
    del server_config
2056
2880
    
2057
2881
    # Override the settings from the config file with command line
2058
2882
    # options, if set.
2059
2883
    for option in ("interface", "address", "port", "debug",
2060
 
                   "priority", "servicename", "configdir",
2061
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2062
 
                   "statedir"):
 
2884
                   "priority", "servicename", "configdir", "use_dbus",
 
2885
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2886
                   "socket", "foreground", "zeroconf"):
2063
2887
        value = getattr(options, option)
2064
2888
        if value is not None:
2065
2889
            server_settings[option] = value
2066
2890
    del options
2067
2891
    # Force all strings to be unicode
2068
2892
    for option in server_settings.keys():
2069
 
        if type(server_settings[option]) is str:
2070
 
            server_settings[option] = unicode(server_settings[option])
 
2893
        if isinstance(server_settings[option], bytes):
 
2894
            server_settings[option] = (server_settings[option]
 
2895
                                       .decode("utf-8"))
 
2896
    # Force all boolean options to be boolean
 
2897
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2898
                   "foreground", "zeroconf"):
 
2899
        server_settings[option] = bool(server_settings[option])
 
2900
    # Debug implies foreground
 
2901
    if server_settings["debug"]:
 
2902
        server_settings["foreground"] = True
2071
2903
    # Now we have our good server settings in "server_settings"
2072
2904
    
2073
2905
    ##################################################################
2074
2906
    
 
2907
    if (not server_settings["zeroconf"]
 
2908
        and not (server_settings["port"]
 
2909
                 or server_settings["socket"] != "")):
 
2910
        parser.error("Needs port or socket to work without Zeroconf")
 
2911
    
2075
2912
    # For convenience
2076
2913
    debug = server_settings["debug"]
2077
2914
    debuglevel = server_settings["debuglevel"]
2079
2916
    use_ipv6 = server_settings["use_ipv6"]
2080
2917
    stored_state_path = os.path.join(server_settings["statedir"],
2081
2918
                                     stored_state_file)
 
2919
    foreground = server_settings["foreground"]
 
2920
    zeroconf = server_settings["zeroconf"]
2082
2921
    
2083
2922
    if debug:
2084
2923
        initlogger(debug, logging.DEBUG)
2090
2929
            initlogger(debug, level)
2091
2930
    
2092
2931
    if server_settings["servicename"] != "Mandos":
2093
 
        syslogger.setFormatter(logging.Formatter
2094
 
                               ('Mandos (%s) [%%(process)d]:'
2095
 
                                ' %%(levelname)s: %%(message)s'
2096
 
                                % server_settings["servicename"]))
 
2932
        syslogger.setFormatter(
 
2933
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2934
                              ' %(levelname)s: %(message)s'.format(
 
2935
                                  server_settings["servicename"])))
2097
2936
    
2098
2937
    # Parse config file with clients
2099
2938
    client_config = configparser.SafeConfigParser(Client
2104
2943
    global mandos_dbus_service
2105
2944
    mandos_dbus_service = None
2106
2945
    
2107
 
    tcp_server = MandosServer((server_settings["address"],
2108
 
                               server_settings["port"]),
2109
 
                              ClientHandler,
2110
 
                              interface=(server_settings["interface"]
2111
 
                                         or None),
2112
 
                              use_ipv6=use_ipv6,
2113
 
                              gnutls_priority=
2114
 
                              server_settings["priority"],
2115
 
                              use_dbus=use_dbus)
2116
 
    if not debug:
2117
 
        pidfilename = "/var/run/mandos.pid"
 
2946
    socketfd = None
 
2947
    if server_settings["socket"] != "":
 
2948
        socketfd = server_settings["socket"]
 
2949
    tcp_server = MandosServer(
 
2950
        (server_settings["address"], server_settings["port"]),
 
2951
        ClientHandler,
 
2952
        interface=(server_settings["interface"] or None),
 
2953
        use_ipv6=use_ipv6,
 
2954
        gnutls_priority=server_settings["priority"],
 
2955
        use_dbus=use_dbus,
 
2956
        socketfd=socketfd)
 
2957
    if not foreground:
 
2958
        pidfilename = "/run/mandos.pid"
 
2959
        if not os.path.isdir("/run/."):
 
2960
            pidfilename = "/var/run/mandos.pid"
 
2961
        pidfile = None
2118
2962
        try:
2119
 
            pidfile = open(pidfilename, "w")
2120
 
        except IOError:
2121
 
            logger.error("Could not open file %r", pidfilename)
 
2963
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2964
        except IOError as e:
 
2965
            logger.error("Could not open file %r", pidfilename,
 
2966
                         exc_info=e)
2122
2967
    
2123
 
    try:
2124
 
        uid = pwd.getpwnam("_mandos").pw_uid
2125
 
        gid = pwd.getpwnam("_mandos").pw_gid
2126
 
    except KeyError:
 
2968
    for name, group in (("_mandos", "_mandos"),
 
2969
                        ("mandos", "mandos"),
 
2970
                        ("nobody", "nogroup")):
2127
2971
        try:
2128
 
            uid = pwd.getpwnam("mandos").pw_uid
2129
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2972
            uid = pwd.getpwnam(name).pw_uid
 
2973
            gid = pwd.getpwnam(group).pw_gid
 
2974
            break
2130
2975
        except KeyError:
2131
 
            try:
2132
 
                uid = pwd.getpwnam("nobody").pw_uid
2133
 
                gid = pwd.getpwnam("nobody").pw_gid
2134
 
            except KeyError:
2135
 
                uid = 65534
2136
 
                gid = 65534
 
2976
            continue
 
2977
    else:
 
2978
        uid = 65534
 
2979
        gid = 65534
2137
2980
    try:
2138
2981
        os.setgid(gid)
2139
2982
        os.setuid(uid)
 
2983
        if debug:
 
2984
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
2985
                                                             gid))
2140
2986
    except OSError as error:
2141
 
        if error[0] != errno.EPERM:
2142
 
            raise error
 
2987
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
2988
                       .format(uid, gid, os.strerror(error.errno)))
 
2989
        if error.errno != errno.EPERM:
 
2990
            raise
2143
2991
    
2144
2992
    if debug:
2145
2993
        # Enable all possible GnuTLS debugging
2146
2994
        
2147
2995
        # "Use a log level over 10 to enable all debugging options."
2148
2996
        # - GnuTLS manual
2149
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2997
        gnutls.global_set_log_level(11)
2150
2998
        
2151
 
        @gnutls.library.types.gnutls_log_func
 
2999
        @gnutls.log_func
2152
3000
        def debug_gnutls(level, string):
2153
3001
            logger.debug("GnuTLS: %s", string[:-1])
2154
3002
        
2155
 
        (gnutls.library.functions
2156
 
         .gnutls_global_set_log_function(debug_gnutls))
 
3003
        gnutls.global_set_log_function(debug_gnutls)
2157
3004
        
2158
3005
        # Redirect stdin so all checkers get /dev/null
2159
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
3006
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2160
3007
        os.dup2(null, sys.stdin.fileno())
2161
3008
        if null > 2:
2162
3009
            os.close(null)
2163
3010
    
2164
3011
    # Need to fork before connecting to D-Bus
2165
 
    if not debug:
 
3012
    if not foreground:
2166
3013
        # Close all input and output, do double fork, etc.
2167
3014
        daemon()
2168
3015
    
2169
 
    gobject.threads_init()
 
3016
    # multiprocessing will use threads, so before we use GLib we need
 
3017
    # to inform GLib that threads will be used.
 
3018
    GLib.threads_init()
2170
3019
    
2171
3020
    global main_loop
2172
3021
    # From the Avahi example code
2173
 
    DBusGMainLoop(set_as_default=True )
2174
 
    main_loop = gobject.MainLoop()
 
3022
    DBusGMainLoop(set_as_default=True)
 
3023
    main_loop = GLib.MainLoop()
2175
3024
    bus = dbus.SystemBus()
2176
3025
    # End of Avahi example code
2177
3026
    if use_dbus:
2178
3027
        try:
2179
3028
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2180
 
                                            bus, do_not_queue=True)
2181
 
            old_bus_name = (dbus.service.BusName
2182
 
                            ("se.bsnet.fukt.Mandos", bus,
2183
 
                             do_not_queue=True))
2184
 
        except dbus.exceptions.NameExistsException as e:
2185
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
3029
                                            bus,
 
3030
                                            do_not_queue=True)
 
3031
            old_bus_name = dbus.service.BusName(
 
3032
                "se.bsnet.fukt.Mandos", bus,
 
3033
                do_not_queue=True)
 
3034
        except dbus.exceptions.DBusException as e:
 
3035
            logger.error("Disabling D-Bus:", exc_info=e)
2186
3036
            use_dbus = False
2187
3037
            server_settings["use_dbus"] = False
2188
3038
            tcp_server.use_dbus = False
2189
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2190
 
    service = AvahiServiceToSyslog(name =
2191
 
                                   server_settings["servicename"],
2192
 
                                   servicetype = "_mandos._tcp",
2193
 
                                   protocol = protocol, bus = bus)
2194
 
    if server_settings["interface"]:
2195
 
        service.interface = (if_nametoindex
2196
 
                             (str(server_settings["interface"])))
 
3039
    if zeroconf:
 
3040
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
3041
        service = AvahiServiceToSyslog(
 
3042
            name = server_settings["servicename"],
 
3043
            servicetype = "_mandos._tcp",
 
3044
            protocol = protocol,
 
3045
            bus = bus)
 
3046
        if server_settings["interface"]:
 
3047
            service.interface = if_nametoindex(
 
3048
                server_settings["interface"].encode("utf-8"))
2197
3049
    
2198
3050
    global multiprocessing_manager
2199
3051
    multiprocessing_manager = multiprocessing.Manager()
2200
3052
    
2201
3053
    client_class = Client
2202
3054
    if use_dbus:
2203
 
        client_class = functools.partial(ClientDBusTransitional,
2204
 
                                         bus = bus)
 
3055
        client_class = functools.partial(ClientDBus, bus = bus)
2205
3056
    
2206
3057
    client_settings = Client.config_parser(client_config)
2207
3058
    old_client_settings = {}
2208
3059
    clients_data = {}
2209
3060
    
 
3061
    # This is used to redirect stdout and stderr for checker processes
 
3062
    global wnull
 
3063
    wnull = open(os.devnull, "w") # A writable /dev/null
 
3064
    # Only used if server is running in foreground but not in debug
 
3065
    # mode
 
3066
    if debug or not foreground:
 
3067
        wnull.close()
 
3068
    
2210
3069
    # Get client data and settings from last running state.
2211
3070
    if server_settings["restore"]:
2212
3071
        try:
2213
3072
            with open(stored_state_path, "rb") as stored_state:
2214
 
                clients_data, old_client_settings = (pickle.load
2215
 
                                                     (stored_state))
 
3073
                if sys.version_info.major == 2:                
 
3074
                    clients_data, old_client_settings = pickle.load(
 
3075
                        stored_state)
 
3076
                else:
 
3077
                    bytes_clients_data, bytes_old_client_settings = (
 
3078
                        pickle.load(stored_state, encoding = "bytes"))
 
3079
                    ### Fix bytes to strings
 
3080
                    ## clients_data
 
3081
                    # .keys()
 
3082
                    clients_data = { (key.decode("utf-8")
 
3083
                                      if isinstance(key, bytes)
 
3084
                                      else key): value
 
3085
                                     for key, value in
 
3086
                                     bytes_clients_data.items() }
 
3087
                    del bytes_clients_data
 
3088
                    for key in clients_data:
 
3089
                        value = { (k.decode("utf-8")
 
3090
                                   if isinstance(k, bytes) else k): v
 
3091
                                  for k, v in
 
3092
                                  clients_data[key].items() }
 
3093
                        clients_data[key] = value
 
3094
                        # .client_structure
 
3095
                        value["client_structure"] = [
 
3096
                            (s.decode("utf-8")
 
3097
                             if isinstance(s, bytes)
 
3098
                             else s) for s in
 
3099
                            value["client_structure"] ]
 
3100
                        # .name & .host
 
3101
                        for k in ("name", "host"):
 
3102
                            if isinstance(value[k], bytes):
 
3103
                                value[k] = value[k].decode("utf-8")
 
3104
                    ## old_client_settings
 
3105
                    # .keys()
 
3106
                    old_client_settings = {
 
3107
                        (key.decode("utf-8")
 
3108
                         if isinstance(key, bytes)
 
3109
                         else key): value
 
3110
                        for key, value in
 
3111
                        bytes_old_client_settings.items() }
 
3112
                    del bytes_old_client_settings
 
3113
                    # .host
 
3114
                    for value in old_client_settings.values():
 
3115
                        if isinstance(value["host"], bytes):
 
3116
                            value["host"] = (value["host"]
 
3117
                                             .decode("utf-8"))
2216
3118
            os.remove(stored_state_path)
2217
3119
        except IOError as e:
2218
 
            logger.warning("Could not load persistent state: {0}"
2219
 
                           .format(e))
2220
 
            if e.errno != errno.ENOENT:
 
3120
            if e.errno == errno.ENOENT:
 
3121
                logger.warning("Could not load persistent state:"
 
3122
                               " {}".format(os.strerror(e.errno)))
 
3123
            else:
 
3124
                logger.critical("Could not load persistent state:",
 
3125
                                exc_info=e)
2221
3126
                raise
2222
3127
        except EOFError as e:
2223
3128
            logger.warning("Could not load persistent state: "
2224
 
                           "EOFError: {0}".format(e))
 
3129
                           "EOFError:",
 
3130
                           exc_info=e)
2225
3131
    
2226
3132
    with PGPEngine() as pgp:
2227
 
        for client_name, client in clients_data.iteritems():
 
3133
        for client_name, client in clients_data.items():
 
3134
            # Skip removed clients
 
3135
            if client_name not in client_settings:
 
3136
                continue
 
3137
            
2228
3138
            # Decide which value to use after restoring saved state.
2229
3139
            # We have three different values: Old config file,
2230
3140
            # new config file, and saved state.
2235
3145
                    # For each value in new config, check if it
2236
3146
                    # differs from the old config value (Except for
2237
3147
                    # the "secret" attribute)
2238
 
                    if (name != "secret" and
2239
 
                        value != old_client_settings[client_name]
2240
 
                        [name]):
 
3148
                    if (name != "secret"
 
3149
                        and (value !=
 
3150
                             old_client_settings[client_name][name])):
2241
3151
                        client[name] = value
2242
3152
                except KeyError:
2243
3153
                    pass
2244
3154
            
2245
3155
            # Clients who has passed its expire date can still be
2246
 
            # enabled if its last checker was successful.  Clients
 
3156
            # enabled if its last checker was successful.  A Client
2247
3157
            # whose checker succeeded before we stored its state is
2248
3158
            # assumed to have successfully run all checkers during
2249
3159
            # downtime.
2251
3161
                if datetime.datetime.utcnow() >= client["expires"]:
2252
3162
                    if not client["last_checked_ok"]:
2253
3163
                        logger.warning(
2254
 
                            "disabling client {0} - Client never "
2255
 
                            "performed a successful checker"
2256
 
                            .format(client_name))
 
3164
                            "disabling client {} - Client never "
 
3165
                            "performed a successful checker".format(
 
3166
                                client_name))
2257
3167
                        client["enabled"] = False
2258
3168
                    elif client["last_checker_status"] != 0:
2259
3169
                        logger.warning(
2260
 
                            "disabling client {0} - Client "
2261
 
                            "last checker failed with error code {1}"
2262
 
                            .format(client_name,
2263
 
                                    client["last_checker_status"]))
 
3170
                            "disabling client {} - Client last"
 
3171
                            " checker failed with error code"
 
3172
                            " {}".format(
 
3173
                                client_name,
 
3174
                                client["last_checker_status"]))
2264
3175
                        client["enabled"] = False
2265
3176
                    else:
2266
 
                        client["expires"] = (datetime.datetime
2267
 
                                             .utcnow()
2268
 
                                             + client["timeout"])
 
3177
                        client["expires"] = (
 
3178
                            datetime.datetime.utcnow()
 
3179
                            + client["timeout"])
2269
3180
                        logger.debug("Last checker succeeded,"
2270
 
                                     " keeping {0} enabled"
2271
 
                                     .format(client_name))
 
3181
                                     " keeping {} enabled".format(
 
3182
                                         client_name))
2272
3183
            try:
2273
 
                client["secret"] = (
2274
 
                    pgp.decrypt(client["encrypted_secret"],
2275
 
                                client_settings[client_name]
2276
 
                                ["secret"]))
 
3184
                client["secret"] = pgp.decrypt(
 
3185
                    client["encrypted_secret"],
 
3186
                    client_settings[client_name]["secret"])
2277
3187
            except PGPError:
2278
3188
                # If decryption fails, we use secret from new settings
2279
 
                logger.debug("Failed to decrypt {0} old secret"
2280
 
                             .format(client_name))
2281
 
                client["secret"] = (
2282
 
                    client_settings[client_name]["secret"])
2283
 
 
 
3189
                logger.debug("Failed to decrypt {} old secret".format(
 
3190
                    client_name))
 
3191
                client["secret"] = (client_settings[client_name]
 
3192
                                    ["secret"])
2284
3193
    
2285
3194
    # Add/remove clients based on new changes made to config
2286
3195
    for client_name in (set(old_client_settings)
2289
3198
    for client_name in (set(client_settings)
2290
3199
                        - set(old_client_settings)):
2291
3200
        clients_data[client_name] = client_settings[client_name]
2292
 
 
 
3201
    
2293
3202
    # Create all client objects
2294
 
    for client_name, client in clients_data.iteritems():
 
3203
    for client_name, client in clients_data.items():
2295
3204
        tcp_server.clients[client_name] = client_class(
2296
 
            name = client_name, settings = client)
 
3205
            name = client_name,
 
3206
            settings = client,
 
3207
            server_settings = server_settings)
2297
3208
    
2298
3209
    if not tcp_server.clients:
2299
3210
        logger.warning("No clients defined")
2300
 
        
2301
 
    if not debug:
2302
 
        try:
2303
 
            with pidfile:
2304
 
                pid = os.getpid()
2305
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2306
 
            del pidfile
2307
 
        except IOError:
2308
 
            logger.error("Could not write to file %r with PID %d",
2309
 
                         pidfilename, pid)
2310
 
        except NameError:
2311
 
            # "pidfile" was never created
2312
 
            pass
 
3211
    
 
3212
    if not foreground:
 
3213
        if pidfile is not None:
 
3214
            pid = os.getpid()
 
3215
            try:
 
3216
                with pidfile:
 
3217
                    print(pid, file=pidfile)
 
3218
            except IOError:
 
3219
                logger.error("Could not write to file %r with PID %d",
 
3220
                             pidfilename, pid)
 
3221
        del pidfile
2313
3222
        del pidfilename
2314
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2315
3223
    
2316
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2317
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
3224
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3225
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3226
                             lambda: main_loop.quit() and False)
2318
3227
    
2319
3228
    if use_dbus:
2320
 
        class MandosDBusService(dbus.service.Object):
 
3229
        
 
3230
        @alternate_dbus_interfaces(
 
3231
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
3232
        class MandosDBusService(DBusObjectWithObjectManager):
2321
3233
            """A D-Bus proxy object"""
 
3234
            
2322
3235
            def __init__(self):
2323
3236
                dbus.service.Object.__init__(self, bus, "/")
 
3237
            
2324
3238
            _interface = "se.recompile.Mandos"
2325
3239
            
2326
3240
            @dbus.service.signal(_interface, signature="o")
2333
3247
                "D-Bus signal"
2334
3248
                pass
2335
3249
            
 
3250
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3251
                               "true"})
2336
3252
            @dbus.service.signal(_interface, signature="os")
2337
3253
            def ClientRemoved(self, objpath, name):
2338
3254
                "D-Bus signal"
2339
3255
                pass
2340
3256
            
 
3257
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3258
                               "true"})
2341
3259
            @dbus.service.method(_interface, out_signature="ao")
2342
3260
            def GetAllClients(self):
2343
3261
                "D-Bus method"
2344
 
                return dbus.Array(c.dbus_object_path
2345
 
                                  for c in
2346
 
                                  tcp_server.clients.itervalues())
 
3262
                return dbus.Array(c.dbus_object_path for c in
 
3263
                                  tcp_server.clients.values())
2347
3264
            
 
3265
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3266
                               "true"})
2348
3267
            @dbus.service.method(_interface,
2349
3268
                                 out_signature="a{oa{sv}}")
2350
3269
            def GetAllClientsWithProperties(self):
2351
3270
                "D-Bus method"
2352
3271
                return dbus.Dictionary(
2353
 
                    ((c.dbus_object_path, c.GetAll(""))
2354
 
                     for c in tcp_server.clients.itervalues()),
 
3272
                    { c.dbus_object_path: c.GetAll(
 
3273
                        "se.recompile.Mandos.Client")
 
3274
                      for c in tcp_server.clients.values() },
2355
3275
                    signature="oa{sv}")
2356
3276
            
2357
3277
            @dbus.service.method(_interface, in_signature="o")
2358
3278
            def RemoveClient(self, object_path):
2359
3279
                "D-Bus method"
2360
 
                for c in tcp_server.clients.itervalues():
 
3280
                for c in tcp_server.clients.values():
2361
3281
                    if c.dbus_object_path == object_path:
2362
3282
                        del tcp_server.clients[c.name]
2363
3283
                        c.remove_from_connection()
2364
 
                        # Don't signal anything except ClientRemoved
 
3284
                        # Don't signal the disabling
2365
3285
                        c.disable(quiet=True)
2366
 
                        # Emit D-Bus signal
2367
 
                        self.ClientRemoved(object_path, c.name)
 
3286
                        # Emit D-Bus signal for removal
 
3287
                        self.client_removed_signal(c)
2368
3288
                        return
2369
3289
                raise KeyError(object_path)
2370
3290
            
2371
3291
            del _interface
 
3292
            
 
3293
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3294
                                 out_signature = "a{oa{sa{sv}}}")
 
3295
            def GetManagedObjects(self):
 
3296
                """D-Bus method"""
 
3297
                return dbus.Dictionary(
 
3298
                    { client.dbus_object_path:
 
3299
                      dbus.Dictionary(
 
3300
                          { interface: client.GetAll(interface)
 
3301
                            for interface in
 
3302
                                 client._get_all_interface_names()})
 
3303
                      for client in tcp_server.clients.values()})
 
3304
            
 
3305
            def client_added_signal(self, client):
 
3306
                """Send the new standard signal and the old signal"""
 
3307
                if use_dbus:
 
3308
                    # New standard signal
 
3309
                    self.InterfacesAdded(
 
3310
                        client.dbus_object_path,
 
3311
                        dbus.Dictionary(
 
3312
                            { interface: client.GetAll(interface)
 
3313
                              for interface in
 
3314
                              client._get_all_interface_names()}))
 
3315
                    # Old signal
 
3316
                    self.ClientAdded(client.dbus_object_path)
 
3317
            
 
3318
            def client_removed_signal(self, client):
 
3319
                """Send the new standard signal and the old signal"""
 
3320
                if use_dbus:
 
3321
                    # New standard signal
 
3322
                    self.InterfacesRemoved(
 
3323
                        client.dbus_object_path,
 
3324
                        client._get_all_interface_names())
 
3325
                    # Old signal
 
3326
                    self.ClientRemoved(client.dbus_object_path,
 
3327
                                       client.name)
2372
3328
        
2373
 
        class MandosDBusServiceTransitional(MandosDBusService):
2374
 
            __metaclass__ = AlternateDBusNamesMetaclass
2375
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
3329
        mandos_dbus_service = MandosDBusService()
2376
3330
    
 
3331
    # Save modules to variables to exempt the modules from being
 
3332
    # unloaded before the function registered with atexit() is run.
 
3333
    mp = multiprocessing
 
3334
    wn = wnull
2377
3335
    def cleanup():
2378
3336
        "Cleanup function; run on exit"
2379
 
        service.cleanup()
 
3337
        if zeroconf:
 
3338
            service.cleanup()
2380
3339
        
2381
 
        multiprocessing.active_children()
 
3340
        mp.active_children()
 
3341
        wn.close()
2382
3342
        if not (tcp_server.clients or client_settings):
2383
3343
            return
2384
3344
        
2387
3347
        # removed/edited, old secret will thus be unrecovable.
2388
3348
        clients = {}
2389
3349
        with PGPEngine() as pgp:
2390
 
            for client in tcp_server.clients.itervalues():
 
3350
            for client in tcp_server.clients.values():
2391
3351
                key = client_settings[client.name]["secret"]
2392
3352
                client.encrypted_secret = pgp.encrypt(client.secret,
2393
3353
                                                      key)
2395
3355
                
2396
3356
                # A list of attributes that can not be pickled
2397
3357
                # + secret.
2398
 
                exclude = set(("bus", "changedstate", "secret",
2399
 
                               "checker"))
2400
 
                for name, typ in (inspect.getmembers
2401
 
                                  (dbus.service.Object)):
 
3358
                exclude = { "bus", "changedstate", "secret",
 
3359
                            "checker", "server_settings" }
 
3360
                for name, typ in inspect.getmembers(dbus.service
 
3361
                                                    .Object):
2402
3362
                    exclude.add(name)
2403
3363
                
2404
3364
                client_dict["encrypted_secret"] = (client
2411
3371
                del client_settings[client.name]["secret"]
2412
3372
        
2413
3373
        try:
2414
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2415
 
                                                prefix="clients-",
2416
 
                                                dir=os.path.dirname
2417
 
                                                (stored_state_path))
2418
 
            with os.fdopen(tempfd, "wb") as stored_state:
2419
 
                pickle.dump((clients, client_settings), stored_state)
 
3374
            with tempfile.NamedTemporaryFile(
 
3375
                    mode='wb',
 
3376
                    suffix=".pickle",
 
3377
                    prefix='clients-',
 
3378
                    dir=os.path.dirname(stored_state_path),
 
3379
                    delete=False) as stored_state:
 
3380
                pickle.dump((clients, client_settings), stored_state,
 
3381
                            protocol = 2)
 
3382
                tempname = stored_state.name
2420
3383
            os.rename(tempname, stored_state_path)
2421
3384
        except (IOError, OSError) as e:
2422
 
            logger.warning("Could not save persistent state: {0}"
2423
 
                           .format(e))
2424
3385
            if not debug:
2425
3386
                try:
2426
3387
                    os.remove(tempname)
2427
3388
                except NameError:
2428
3389
                    pass
2429
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2430
 
                                   errno.EEXIST)):
2431
 
                raise e
 
3390
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
3391
                logger.warning("Could not save persistent state: {}"
 
3392
                               .format(os.strerror(e.errno)))
 
3393
            else:
 
3394
                logger.warning("Could not save persistent state:",
 
3395
                               exc_info=e)
 
3396
                raise
2432
3397
        
2433
3398
        # Delete all clients, and settings from config
2434
3399
        while tcp_server.clients:
2435
3400
            name, client = tcp_server.clients.popitem()
2436
3401
            if use_dbus:
2437
3402
                client.remove_from_connection()
2438
 
            # Don't signal anything except ClientRemoved
 
3403
            # Don't signal the disabling
2439
3404
            client.disable(quiet=True)
 
3405
            # Emit D-Bus signal for removal
2440
3406
            if use_dbus:
2441
 
                # Emit D-Bus signal
2442
 
                mandos_dbus_service.ClientRemoved(client
2443
 
                                                  .dbus_object_path,
2444
 
                                                  client.name)
 
3407
                mandos_dbus_service.client_removed_signal(client)
2445
3408
        client_settings.clear()
2446
3409
    
2447
3410
    atexit.register(cleanup)
2448
3411
    
2449
 
    for client in tcp_server.clients.itervalues():
 
3412
    for client in tcp_server.clients.values():
2450
3413
        if use_dbus:
2451
 
            # Emit D-Bus signal
2452
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3414
            # Emit D-Bus signal for adding
 
3415
            mandos_dbus_service.client_added_signal(client)
2453
3416
        # Need to initiate checking of clients
2454
3417
        if client.enabled:
2455
3418
            client.init_checker()
2458
3421
    tcp_server.server_activate()
2459
3422
    
2460
3423
    # Find out what port we got
2461
 
    service.port = tcp_server.socket.getsockname()[1]
 
3424
    if zeroconf:
 
3425
        service.port = tcp_server.socket.getsockname()[1]
2462
3426
    if use_ipv6:
2463
3427
        logger.info("Now listening on address %r, port %d,"
2464
 
                    " flowinfo %d, scope_id %d"
2465
 
                    % tcp_server.socket.getsockname())
 
3428
                    " flowinfo %d, scope_id %d",
 
3429
                    *tcp_server.socket.getsockname())
2466
3430
    else:                       # IPv4
2467
 
        logger.info("Now listening on address %r, port %d"
2468
 
                    % tcp_server.socket.getsockname())
 
3431
        logger.info("Now listening on address %r, port %d",
 
3432
                    *tcp_server.socket.getsockname())
2469
3433
    
2470
3434
    #service.interface = tcp_server.socket.getsockname()[3]
2471
3435
    
2472
3436
    try:
2473
 
        # From the Avahi example code
2474
 
        try:
2475
 
            service.activate()
2476
 
        except dbus.exceptions.DBusException as error:
2477
 
            logger.critical("DBusException: %s", error)
2478
 
            cleanup()
2479
 
            sys.exit(1)
2480
 
        # End of Avahi example code
 
3437
        if zeroconf:
 
3438
            # From the Avahi example code
 
3439
            try:
 
3440
                service.activate()
 
3441
            except dbus.exceptions.DBusException as error:
 
3442
                logger.critical("D-Bus Exception", exc_info=error)
 
3443
                cleanup()
 
3444
                sys.exit(1)
 
3445
            # End of Avahi example code
2481
3446
        
2482
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2483
 
                             lambda *args, **kwargs:
2484
 
                             (tcp_server.handle_request
2485
 
                              (*args[2:], **kwargs) or True))
 
3447
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3448
                          lambda *args, **kwargs:
 
3449
                          (tcp_server.handle_request
 
3450
                           (*args[2:], **kwargs) or True))
2486
3451
        
2487
3452
        logger.debug("Starting main loop")
2488
3453
        main_loop.run()
2489
3454
    except AvahiError as error:
2490
 
        logger.critical("AvahiError: %s", error)
 
3455
        logger.critical("Avahi Error", exc_info=error)
2491
3456
        cleanup()
2492
3457
        sys.exit(1)
2493
3458
    except KeyboardInterrupt:
2498
3463
    # Must run before the D-Bus bus name gets deregistered
2499
3464
    cleanup()
2500
3465
 
 
3466
 
2501
3467
if __name__ == '__main__':
2502
3468
    main()