/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-10-08 04:11:22 UTC
  • Revision ID: teddy@recompile.se-20161008041122-xdqj4sw9h9i461fu
Fix bug when generating keys in a chroot environment.

* mandos-keygen (keygen): Use "%no-protection" statement in GnuPG
                          batch parameter file to make GnuPG 2.1 not
                          try to ask for a passphrase interactively.

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