/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-08-25 17:37:05 UTC
  • Revision ID: teddy@recompile.se-20160825173705-q2v6lban8ph9uw75
PEP8 compliance: mandos

* mandos: Add PEP8 compliance (as per the "pycodestyle" tool).

Show diffs side-by-side

added added

removed removed

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