/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

* debian/mandos-client.postinst: Converted to Bourne shell.  Also
                                 minor message change.
* debian/mandos-client.postrm: Minor message change.
* debian/mandos.postinst: Converted to Bourne shell.  Also minor
                          message change.
* debian/mandos.prerm: Minor message change.

Show diffs side-by-side

added added

removed removed

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