/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: 2012-05-26 22:56:38 UTC
  • mfrom: (589.1.1 socket-option)
  • Revision ID: teddy@recompile.se-20120526225638-4hvqyrvmj0036lfn
Merge "--socket" option for server.

This is suggested by the GNU Coding Standards' Table of Long Options,
and will probably also allow socket activation (e.g. by systemd(8)).

Show diffs side-by-side

added added

removed removed

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