/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-02-28 03:01:43 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 331.
  • Revision ID: teddy@recompile.se-20160228030143-i6w90r7wzkvlx9kq
Stop using python-gnutls.  Use GnuTLS 3.3 or later directly.

* INSTALL: Document dependency on GnuTLS 3.3 and remove dependency on
          Python-GnuTLS.

* debian/control (Source: mandos/Build-Depends): Add (>= 3.3.0) to
                                                 "libgnutls28-dev" and
                                                 "gnutls-dev".
  (Source: mandos/Build-Depends-Indep): Remove "python2.7-gnutls".
  (Package: mandos/Depends): Remove "python-gnutls" and
                             "python2.7-gnutls", add "libgnutls28-dev
                             (>= 3.3.0) | libgnutls30 (>= 3.3.0)"
* mandos: Remove imports of "gnutls" and all submodules.
  (GnuTLS, gnutls): New; simulate a "gnutls" module.  Change all
                    callers to match new shorter names.

Show diffs side-by-side

added added

removed removed

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