/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2012-11-14 21:03:24 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 303.
  • Revision ID: teddy@recompile.se-20121114210324-n7m7k0ki2ncmje3a
* mandos-ctl (string_to_delta): Try to parse RFC 3339 duration before
                                anything else.  This also minimizes
                                the changes from the last release.
  (PGPEngine): Use straight subprocess.Popen() to call "gpg".
* mandos-monitor (UserInterface.run): Fix grammar.

Show diffs side-by-side

added added

removed removed

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