/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: Björn Påhlsson
  • Date: 2011-10-02 19:18:24 UTC
  • mto: This revision was merged to the branch mainline in revision 505.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

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