/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-12 20:23:15 UTC
  • Revision ID: teddy@recompile.se-20160312202315-hu7b87ivetlxqbw3
Server: Fix minor thing with Python 3 compatibility

Fix another small thing with unpickling string values.

* mandos (main): When restoring pickled client data, only decode byte
                 string for "host" key if it really is a byte string.

Show diffs side-by-side

added added

removed removed

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