/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-08-08 21:12:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110808211237-jejsz5brjytrjot8
* Makefile (DOCS): Added "intro.8mandos".
  (intro.8mandos, intro.8mandos.xhtml): New.
* README: Replaced text with link, reference and short summary.
* intro.xml: New.
* mandos-clients.conf.xml (SEE ALSO): Added "intro(8mandos)".
* mandos-ctl.xml (SEE ALSO): - '' -
* mandos-keygen.xml (SEE ALSO): - '' -
* mandos-monitor.xml (SEE ALSO): - '' -
* mandos.conf.xml (SEE ALSO): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.xml (SEE ALSO): - '' -
* plugins.d/askpass-fifo.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -
* plugins.d/password-prompt.xml (SEE ALSO): - '' -
* plugins.d/plymouth.xml (SEE ALSO): - '' -
* plugins.d/splashy.xml (SEE ALSO): - '' -
* plugins.d/usplash.xml (SEE ALSO): - '' -

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