/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-10-29 14:22:26 UTC
  • Revision ID: teddy@recompile.se-20161029142226-n4s9d70tuk615pg1
Makefile: Clarify message when running client.

* Makefile (run-client): Clarify message.

Show diffs side-by-side

added added

removed removed

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