/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2011-08-08 21:12:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110808211237-jejsz5brjytrjot8
* Makefile (DOCS): Added "intro.8mandos".
  (intro.8mandos, intro.8mandos.xhtml): New.
* README: Replaced text with link, reference and short summary.
* intro.xml: New.
* mandos-clients.conf.xml (SEE ALSO): Added "intro(8mandos)".
* mandos-ctl.xml (SEE ALSO): - '' -
* mandos-keygen.xml (SEE ALSO): - '' -
* mandos-monitor.xml (SEE ALSO): - '' -
* mandos.conf.xml (SEE ALSO): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.xml (SEE ALSO): - '' -
* plugins.d/askpass-fifo.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -
* plugins.d/password-prompt.xml (SEE ALSO): - '' -
* plugins.d/plymouth.xml (SEE ALSO): - '' -
* plugins.d/splashy.xml (SEE ALSO): - '' -
* plugins.d/usplash.xml (SEE ALSO): - '' -

Show diffs side-by-side

added added

removed removed

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