/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2008-09-21 13:42:34 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080921134234-jo8p4rwtm50yb4xj
* clients.conf ([bar]/secfile): Do not imply armored format.

* debian/control: Build-Depend on pkg-config.

* debian/mandos.prerm (remove): Bug fix; check for
                                "/etc/init.d/mandos", not
                                "/etc/init.d/ssh".

Show diffs side-by-side

added added

removed removed

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