/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: 2017-08-20 14:14:14 UTC
  • Revision ID: teddy@recompile.se-20170820141414-m034xuebg7ccaeui
Add some more restrictions to the systemd service file.

* mandos.service ([Service]/ProtectKernelTunables): New; set to "yes".
  ([Service]/ProtectControlGroups): - '' -

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