/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-06-21 19:47:30 UTC
  • mfrom: (854 trunk)
  • mto: This revision was merged to the branch mainline in revision 855.
  • Revision ID: teddy@recompile.se-20160621194730-sb4zcfg961tvuic2
Merge from trunk

Show diffs side-by-side

added added

removed removed

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