/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: 2008-09-06 15:34:21 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906153421-605ydhwyo404krh9
* initramfs-tools-hook: Use long options where available.  Use only
                        one "test" invocation instead of several.

* mandos-keygen: Use only one "test" invocation instead of several.
                 Use long options where available.  Strip newline from
                 entered password.

* plugin-runner.c (print_out_password): Do not strip trailing newline.
  (fallback): Strip trailing newline from getpass().

* plugin-runner.xml (PLUGINS): Plugins should not print trailing
                               newlines.

* plugins.d/password-prompt.c (main): Strip trailing newline.

* plugins.d/password-request.c (main): Bug fix: Read "pubkey.txt", not
                                       "pupkey.txt".

Show diffs side-by-side

added added

removed removed

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