/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Björn Påhlsson
  • Date: 2011-11-09 11:16:17 UTC
  • mto: (518.2.5 persistent-state-gpgme)
  • mto: This revision was merged to the branch mainline in revision 520.
  • Revision ID: belorn@fukt.bsnet.se-20111109111617-jpey2sy4dupqzabc
Persistent state: New feature. Client state is now stored when mandos
                  server exits, and restored when starting up. Secrets
                  are encrypted with key based on clients config file.
--no-restore: New argument to mandos server. Disables restore
              functionallity
minor changes: clients are now dicts!

Show diffs side-by-side

added added

removed removed

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