/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-12 20:23:15 UTC
  • Revision ID: teddy@recompile.se-20160312202315-hu7b87ivetlxqbw3
Server: Fix minor thing with Python 3 compatibility

Fix another small thing with unpickling string values.

* mandos (main): When restoring pickled client data, only decode byte
                 string for "host" key if it really is a byte string.

Show diffs side-by-side

added added

removed removed

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