/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-05 21:42:56 UTC
  • Revision ID: teddy@recompile.se-20160305214256-79progf0wfkd9068
Add bug reporting information to manual pages

* bugs.xml: New file.
* intro.xml (BUGS): New section; include "bugs.xml".
* mandos-clients.conf.xml (BUGS): Include "bugs.xml".
* mandos-ctl.xml (BUGS): Uncommented; include "bugs.xml".
* mandos-keygen.xml (BUGS): - '' -
* mandos-monitor.xml (BUGS): Include "bugs.xml".
* mandos.conf.xml (BUGS): - '' -
* mandos.xml (BUGS): - '' -
* plugin-runner.xml (BUGS): - '' -
* plugins.d/askpass-fifo.xml (BUGS): New section; include
                                     "../bugs.xml".
* plugins.d/mandos-client.xml (BUGS): Uncommented; include
                                     "../bugs.xml".
* plugins.d/password-prompt.xml (BUGS): Include "../bugs.xml".
* plugins.d/plymouth.xml (BUGS): - '' -
* plugins.d/splashy.xml (BUGS): - '' -
* plugins.d/usplash.xml (BUGS): - '' -

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