/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: 2011-04-02 06:37:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110402063718-13ldrcuu0t33sdc4
* mandos: Tolerate restarting Avahi servers.  Also Changed to new
          "except x as y" exception syntax.
  (AvahiService.entry_group_state_changed_match): New; contains the
                                                  SignalMatch object.
  (AvahiService.remove): Really remove the group and the signal
                         connection, if any.
  (AvahiService.add): Always create a new group and signal connection.
  (AvahiService.cleanup): Changed to simply call remove().
  (AvahiService.server_state_changed): Handle and log more bad states.
  (AvahiService.activate): Set "follow_name_owner_changes=True" on the
                           Avahi Server proxy object.
  (ClientDBus.checked_ok): Do not return anything.
  (ClientDBus.CheckedOK): Do not return anything, as documented.
* mandos-monitor: Call D-Bus methods asynchronously.

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