/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: 2018-02-06 20:03:50 UTC
  • Revision ID: teddy@recompile.se-20180206200350-jzvorueb731xkph3
Update Debian Debhelper compatibility version.

* (debian/compat): Change to "10".

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