/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-10-05 20:13:01 UTC
  • Revision ID: teddy@recompile.se-20161005201301-3ibock2agjb2ppe6
Tags: version-1.7.12-1
* Makefile (version): Change to 1.7.12.
* NEWS (Version 1.7.12): Add new entry.
* debian/changelog (1.7.12-1): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
 
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
 
 
5
#
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
 
 
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2014 Teddy Hogeborn
15
 
# Copyright © 2008-2014 Björn Påhlsson
16
 
 
14
# Copyright © 2008-2016 Teddy Hogeborn
 
15
# Copyright © 2008-2016 Björn Påhlsson
 
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
19
19
# the Free Software Foundation, either version 3 of the License, or
23
23
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
24
24
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25
25
#     GNU General Public License for more details.
26
 
 
26
#
27
27
# You should have received a copy of the GNU General Public License
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
 
 
30
#
31
31
# Contact the authors at <mandos@recompile.se>.
32
 
 
32
#
33
33
 
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
from future_builtins import *
 
37
try:
 
38
    from future_builtins import *
 
39
except ImportError:
 
40
    pass
38
41
 
39
 
import SocketServer as socketserver
 
42
try:
 
43
    import SocketServer as socketserver
 
44
except ImportError:
 
45
    import socketserver
40
46
import socket
41
47
import argparse
42
48
import datetime
43
49
import errno
44
 
import gnutls.crypto
45
 
import gnutls.connection
46
 
import gnutls.errors
47
 
import gnutls.library.functions
48
 
import gnutls.library.constants
49
 
import gnutls.library.types
50
 
import ConfigParser as configparser
 
50
try:
 
51
    import ConfigParser as configparser
 
52
except ImportError:
 
53
    import configparser
51
54
import sys
52
55
import re
53
56
import os
62
65
import struct
63
66
import fcntl
64
67
import functools
65
 
import cPickle as pickle
 
68
try:
 
69
    import cPickle as pickle
 
70
except ImportError:
 
71
    import pickle
66
72
import multiprocessing
67
73
import types
68
74
import binascii
69
75
import tempfile
70
76
import itertools
71
77
import collections
 
78
import codecs
72
79
 
73
80
import dbus
74
81
import dbus.service
75
 
import gobject
76
 
import avahi
 
82
from gi.repository import GLib
77
83
from dbus.mainloop.glib import DBusGMainLoop
78
84
import ctypes
79
85
import ctypes.util
80
86
import xml.dom.minidom
81
87
import inspect
82
88
 
 
89
# Try to find the value of SO_BINDTODEVICE:
83
90
try:
 
91
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
 
92
    # newer, and it is also the most natural place for it:
84
93
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
94
except AttributeError:
86
95
    try:
 
96
        # This is where SO_BINDTODEVICE was up to and including Python
 
97
        # 2.6, and also 3.2:
87
98
        from IN import SO_BINDTODEVICE
88
99
    except ImportError:
89
 
        SO_BINDTODEVICE = None
90
 
 
91
 
version = "1.6.4"
 
100
        # In Python 2.7 it seems to have been removed entirely.
 
101
        # Try running the C preprocessor:
 
102
        try:
 
103
            cc = subprocess.Popen(["cc", "--language=c", "-E",
 
104
                                   "/dev/stdin"],
 
105
                                  stdin=subprocess.PIPE,
 
106
                                  stdout=subprocess.PIPE)
 
107
            stdout = cc.communicate(
 
108
                "#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
 
109
            SO_BINDTODEVICE = int(stdout.splitlines()[-1])
 
110
        except (OSError, ValueError, IndexError):
 
111
            # No value found
 
112
            SO_BINDTODEVICE = None
 
113
 
 
114
if sys.version_info.major == 2:
 
115
    str = unicode
 
116
 
 
117
version = "1.7.12"
92
118
stored_state_file = "clients.pickle"
93
119
 
94
120
logger = logging.getLogger()
95
121
syslogger = None
96
122
 
97
123
try:
98
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
99
 
                      (ctypes.util.find_library("c"))
100
 
                      .if_nametoindex)
 
124
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
125
        ctypes.util.find_library("c")).if_nametoindex
101
126
except (OSError, AttributeError):
 
127
 
102
128
    def if_nametoindex(interface):
103
129
        "Get an interface index the hard way, i.e. using fcntl()"
104
130
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
105
131
        with contextlib.closing(socket.socket()) as s:
106
132
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
 
                                struct.pack(str("16s16x"),
108
 
                                            interface))
109
 
        interface_index = struct.unpack(str("I"),
110
 
                                        ifreq[16:20])[0]
 
133
                                struct.pack(b"16s16x", interface))
 
134
        interface_index = struct.unpack("I", ifreq[16:20])[0]
111
135
        return interface_index
112
136
 
113
137
 
 
138
def copy_function(func):
 
139
    """Make a copy of a function"""
 
140
    if sys.version_info.major == 2:
 
141
        return types.FunctionType(func.func_code,
 
142
                                  func.func_globals,
 
143
                                  func.func_name,
 
144
                                  func.func_defaults,
 
145
                                  func.func_closure)
 
146
    else:
 
147
        return types.FunctionType(func.__code__,
 
148
                                  func.__globals__,
 
149
                                  func.__name__,
 
150
                                  func.__defaults__,
 
151
                                  func.__closure__)
 
152
 
 
153
 
114
154
def initlogger(debug, level=logging.WARNING):
115
155
    """init logger and add loglevel"""
116
 
    
117
 
    syslogger = (logging.handlers.SysLogHandler
118
 
                 (facility =
119
 
                  logging.handlers.SysLogHandler.LOG_DAEMON,
120
 
                  address = str("/dev/log")))
 
156
 
 
157
    global syslogger
 
158
    syslogger = (logging.handlers.SysLogHandler(
 
159
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
 
160
        address="/dev/log"))
121
161
    syslogger.setFormatter(logging.Formatter
122
162
                           ('Mandos [%(process)d]: %(levelname)s:'
123
163
                            ' %(message)s'))
124
164
    logger.addHandler(syslogger)
125
 
    
 
165
 
126
166
    if debug:
127
167
        console = logging.StreamHandler()
128
168
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
140
180
 
141
181
class PGPEngine(object):
142
182
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
183
 
143
184
    def __init__(self):
144
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
145
197
        self.gnupgargs = ['--batch',
146
 
                          '--home', self.tempdir,
 
198
                          '--homedir', self.tempdir,
147
199
                          '--force-mdc',
148
 
                          '--quiet',
149
 
                          '--no-use-agent']
150
 
    
 
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
 
151
205
    def __enter__(self):
152
206
        return self
153
 
    
 
207
 
154
208
    def __exit__(self, exc_type, exc_value, traceback):
155
209
        self._cleanup()
156
210
        return False
157
 
    
 
211
 
158
212
    def __del__(self):
159
213
        self._cleanup()
160
 
    
 
214
 
161
215
    def _cleanup(self):
162
216
        if self.tempdir is not None:
163
217
            # Delete contents of tempdir
164
218
            for root, dirs, files in os.walk(self.tempdir,
165
 
                                             topdown = False):
 
219
                                             topdown=False):
166
220
                for filename in files:
167
221
                    os.remove(os.path.join(root, filename))
168
222
                for dirname in dirs:
170
224
            # Remove tempdir
171
225
            os.rmdir(self.tempdir)
172
226
            self.tempdir = None
173
 
    
 
227
 
174
228
    def password_encode(self, password):
175
229
        # Passphrase can not be empty and can not contain newlines or
176
230
        # NUL bytes.  So we prefix it and hex encode it.
181
235
                       .replace(b"\n", b"\\n")
182
236
                       .replace(b"\0", b"\\x00"))
183
237
        return encoded
184
 
    
 
238
 
185
239
    def encrypt(self, data, password):
186
240
        passphrase = self.password_encode(password)
187
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
188
 
                                         ) as passfile:
 
241
        with tempfile.NamedTemporaryFile(
 
242
                dir=self.tempdir) as passfile:
189
243
            passfile.write(passphrase)
190
244
            passfile.flush()
191
 
            proc = subprocess.Popen(['gpg', '--symmetric',
 
245
            proc = subprocess.Popen([self.gpg, '--symmetric',
192
246
                                     '--passphrase-file',
193
247
                                     passfile.name]
194
248
                                    + self.gnupgargs,
195
 
                                    stdin = subprocess.PIPE,
196
 
                                    stdout = subprocess.PIPE,
197
 
                                    stderr = subprocess.PIPE)
198
 
            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)
199
253
        if proc.returncode != 0:
200
254
            raise PGPError(err)
201
255
        return ciphertext
202
 
    
 
256
 
203
257
    def decrypt(self, data, password):
204
258
        passphrase = self.password_encode(password)
205
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
206
 
                                         ) as passfile:
 
259
        with tempfile.NamedTemporaryFile(
 
260
                dir=self.tempdir) as passfile:
207
261
            passfile.write(passphrase)
208
262
            passfile.flush()
209
 
            proc = subprocess.Popen(['gpg', '--decrypt',
 
263
            proc = subprocess.Popen([self.gpg, '--decrypt',
210
264
                                     '--passphrase-file',
211
265
                                     passfile.name]
212
266
                                    + self.gnupgargs,
213
 
                                    stdin = subprocess.PIPE,
214
 
                                    stdout = subprocess.PIPE,
215
 
                                    stderr = subprocess.PIPE)
216
 
            decrypted_plaintext, err = proc.communicate(input
217
 
                                                        = data)
 
267
                                    stdin=subprocess.PIPE,
 
268
                                    stdout=subprocess.PIPE,
 
269
                                    stderr=subprocess.PIPE)
 
270
            decrypted_plaintext, err = proc.communicate(input=data)
218
271
        if proc.returncode != 0:
219
272
            raise PGPError(err)
220
273
        return decrypted_plaintext
221
274
 
222
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
 
223
303
class AvahiError(Exception):
224
304
    def __init__(self, value, *args, **kwargs):
225
305
        self.value = value
226
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
227
 
    def __unicode__(self):
228
 
        return unicode(repr(self.value))
 
306
        return super(AvahiError, self).__init__(value, *args,
 
307
                                                **kwargs)
 
308
 
229
309
 
230
310
class AvahiServiceError(AvahiError):
231
311
    pass
232
312
 
 
313
 
233
314
class AvahiGroupError(AvahiError):
234
315
    pass
235
316
 
236
317
 
237
318
class AvahiService(object):
238
319
    """An Avahi (Zeroconf) service.
239
 
    
 
320
 
240
321
    Attributes:
241
322
    interface: integer; avahi.IF_UNSPEC or an interface index.
242
323
               Used to optionally bind to the specified interface.
254
335
    server: D-Bus Server
255
336
    bus: dbus.SystemBus()
256
337
    """
257
 
    
258
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
259
 
                 servicetype = None, port = None, TXT = None,
260
 
                 domain = "", host = "", max_renames = 32768,
261
 
                 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):
262
350
        self.interface = interface
263
351
        self.name = name
264
352
        self.type = servicetype
273
361
        self.server = None
274
362
        self.bus = bus
275
363
        self.entry_group_state_changed_match = None
276
 
    
277
 
    def rename(self):
 
364
 
 
365
    def rename(self, remove=True):
278
366
        """Derived from the Avahi example code"""
279
367
        if self.rename_count >= self.max_renames:
280
368
            logger.critical("No suitable Zeroconf service name found"
281
369
                            " after %i retries, exiting.",
282
370
                            self.rename_count)
283
371
            raise AvahiServiceError("Too many renames")
284
 
        self.name = unicode(self.server
285
 
                            .GetAlternativeServiceName(self.name))
 
372
        self.name = str(
 
373
            self.server.GetAlternativeServiceName(self.name))
 
374
        self.rename_count += 1
286
375
        logger.info("Changing Zeroconf service name to %r ...",
287
376
                    self.name)
288
 
        self.remove()
 
377
        if remove:
 
378
            self.remove()
289
379
        try:
290
380
            self.add()
291
381
        except dbus.exceptions.DBusException as error:
292
 
            logger.critical("D-Bus Exception", exc_info=error)
293
 
            self.cleanup()
294
 
            os._exit(1)
295
 
        self.rename_count += 1
296
 
    
 
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
 
297
391
    def remove(self):
298
392
        """Derived from the Avahi example code"""
299
393
        if self.entry_group_state_changed_match is not None:
301
395
            self.entry_group_state_changed_match = None
302
396
        if self.group is not None:
303
397
            self.group.Reset()
304
 
    
 
398
 
305
399
    def add(self):
306
400
        """Derived from the Avahi example code"""
307
401
        self.remove()
324
418
            dbus.UInt16(self.port),
325
419
            avahi.string_array_to_txt_array(self.TXT))
326
420
        self.group.Commit()
327
 
    
 
421
 
328
422
    def entry_group_state_changed(self, state, error):
329
423
        """Derived from the Avahi example code"""
330
424
        logger.debug("Avahi entry group state change: %i", state)
331
 
        
 
425
 
332
426
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
333
427
            logger.debug("Zeroconf service established.")
334
428
        elif state == avahi.ENTRY_GROUP_COLLISION:
336
430
            self.rename()
337
431
        elif state == avahi.ENTRY_GROUP_FAILURE:
338
432
            logger.critical("Avahi: Error in group state changed %s",
339
 
                            unicode(error))
340
 
            raise AvahiGroupError("State changed: {0!s}"
341
 
                                  .format(error))
342
 
    
 
433
                            str(error))
 
434
            raise AvahiGroupError("State changed: {!s}".format(error))
 
435
 
343
436
    def cleanup(self):
344
437
        """Derived from the Avahi example code"""
345
438
        if self.group is not None:
350
443
                pass
351
444
            self.group = None
352
445
        self.remove()
353
 
    
 
446
 
354
447
    def server_state_changed(self, state, error=None):
355
448
        """Derived from the Avahi example code"""
356
449
        logger.debug("Avahi server state change: %i", state)
357
 
        bad_states = { avahi.SERVER_INVALID:
358
 
                           "Zeroconf server invalid",
359
 
                       avahi.SERVER_REGISTERING: None,
360
 
                       avahi.SERVER_COLLISION:
361
 
                           "Zeroconf server name collision",
362
 
                       avahi.SERVER_FAILURE:
363
 
                           "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
        }
364
456
        if state in bad_states:
365
457
            if bad_states[state] is not None:
366
458
                if error is None:
369
461
                    logger.error(bad_states[state] + ": %r", error)
370
462
            self.cleanup()
371
463
        elif state == avahi.SERVER_RUNNING:
372
 
            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)
373
476
        else:
374
477
            if error is None:
375
478
                logger.debug("Unknown state: %r", state)
376
479
            else:
377
480
                logger.debug("Unknown state: %r: %r", state, error)
378
 
    
 
481
 
379
482
    def activate(self):
380
483
        """Derived from the Avahi example code"""
381
484
        if self.server is None:
385
488
                                    follow_name_owner_changes=True),
386
489
                avahi.DBUS_INTERFACE_SERVER)
387
490
        self.server.connect_to_signal("StateChanged",
388
 
                                 self.server_state_changed)
 
491
                                      self.server_state_changed)
389
492
        self.server_state_changed(self.server.GetState())
390
493
 
391
494
 
392
495
class AvahiServiceToSyslog(AvahiService):
393
 
    def rename(self):
 
496
    def rename(self, *args, **kwargs):
394
497
        """Add the new name to the syslog messages"""
395
 
        ret = AvahiService.rename(self)
396
 
        syslogger.setFormatter(logging.Formatter
397
 
                               ('Mandos ({0}) [%(process)d]:'
398
 
                                ' %(levelname)s: %(message)s'
399
 
                                .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)))
400
502
        return ret
401
503
 
402
504
 
403
 
def timedelta_to_milliseconds(td):
404
 
    "Convert a datetime.timedelta() to milliseconds"
405
 
    return ((td.days * 24 * 60 * 60 * 1000)
406
 
            + (td.seconds * 1000)
407
 
            + (td.microseconds // 1000))
 
505
# Pretend that we have a GnuTLS module
 
506
class GnuTLS(object):
 
507
    """This isn't so much a class as it is a module-like namespace.
 
508
    It is instantiated once, and simulates having a GnuTLS module."""
 
509
 
 
510
    library = ctypes.util.find_library("gnutls")
 
511
    if library is None:
 
512
        library = ctypes.util.find_library("gnutls-deb0")
 
513
    _library = ctypes.cdll.LoadLibrary(library)
 
514
    del library
 
515
    _need_version = b"3.3.0"
 
516
 
 
517
    def __init__(self):
 
518
        # Need to use class name "GnuTLS" here, since this method is
 
519
        # called before the assignment to the "gnutls" global variable
 
520
        # happens.
 
521
        if GnuTLS.check_version(self._need_version) is None:
 
522
            raise GnuTLS.Error("Needs GnuTLS {} or later"
 
523
                               .format(self._need_version))
 
524
 
 
525
    # Unless otherwise indicated, the constants and types below are
 
526
    # all from the gnutls/gnutls.h C header file.
 
527
 
 
528
    # Constants
 
529
    E_SUCCESS = 0
 
530
    E_INTERRUPTED = -52
 
531
    E_AGAIN = -28
 
532
    CRT_OPENPGP = 2
 
533
    CLIENT = 2
 
534
    SHUT_RDWR = 0
 
535
    CRD_CERTIFICATE = 1
 
536
    E_NO_CERTIFICATE_FOUND = -49
 
537
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
538
 
 
539
    # Types
 
540
    class session_int(ctypes.Structure):
 
541
        _fields_ = []
 
542
    session_t = ctypes.POINTER(session_int)
 
543
 
 
544
    class certificate_credentials_st(ctypes.Structure):
 
545
        _fields_ = []
 
546
    certificate_credentials_t = ctypes.POINTER(
 
547
        certificate_credentials_st)
 
548
    certificate_type_t = ctypes.c_int
 
549
 
 
550
    class datum_t(ctypes.Structure):
 
551
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
552
                    ('size', ctypes.c_uint)]
 
553
 
 
554
    class openpgp_crt_int(ctypes.Structure):
 
555
        _fields_ = []
 
556
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
557
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
 
558
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
559
    credentials_type_t = ctypes.c_int
 
560
    transport_ptr_t = ctypes.c_void_p
 
561
    close_request_t = ctypes.c_int
 
562
 
 
563
    # Exceptions
 
564
    class Error(Exception):
 
565
        # We need to use the class name "GnuTLS" here, since this
 
566
        # exception might be raised from within GnuTLS.__init__,
 
567
        # which is called before the assignment to the "gnutls"
 
568
        # global variable has happened.
 
569
        def __init__(self, message=None, code=None, args=()):
 
570
            # Default usage is by a message string, but if a return
 
571
            # code is passed, convert it to a string with
 
572
            # gnutls.strerror()
 
573
            self.code = code
 
574
            if message is None and code is not None:
 
575
                message = GnuTLS.strerror(code)
 
576
            return super(GnuTLS.Error, self).__init__(
 
577
                message, *args)
 
578
 
 
579
    class CertificateSecurityError(Error):
 
580
        pass
 
581
 
 
582
    # Classes
 
583
    class Credentials(object):
 
584
        def __init__(self):
 
585
            self._c_object = gnutls.certificate_credentials_t()
 
586
            gnutls.certificate_allocate_credentials(
 
587
                ctypes.byref(self._c_object))
 
588
            self.type = gnutls.CRD_CERTIFICATE
 
589
 
 
590
        def __del__(self):
 
591
            gnutls.certificate_free_credentials(self._c_object)
 
592
 
 
593
    class ClientSession(object):
 
594
        def __init__(self, socket, credentials=None):
 
595
            self._c_object = gnutls.session_t()
 
596
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
597
            gnutls.set_default_priority(self._c_object)
 
598
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
599
            gnutls.handshake_set_private_extensions(self._c_object,
 
600
                                                    True)
 
601
            self.socket = socket
 
602
            if credentials is None:
 
603
                credentials = gnutls.Credentials()
 
604
            gnutls.credentials_set(self._c_object, credentials.type,
 
605
                                   ctypes.cast(credentials._c_object,
 
606
                                               ctypes.c_void_p))
 
607
            self.credentials = credentials
 
608
 
 
609
        def __del__(self):
 
610
            gnutls.deinit(self._c_object)
 
611
 
 
612
        def handshake(self):
 
613
            return gnutls.handshake(self._c_object)
 
614
 
 
615
        def send(self, data):
 
616
            data = bytes(data)
 
617
            data_len = len(data)
 
618
            while data_len > 0:
 
619
                data_len -= gnutls.record_send(self._c_object,
 
620
                                               data[-data_len:],
 
621
                                               data_len)
 
622
 
 
623
        def bye(self):
 
624
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
625
 
 
626
    # Error handling functions
 
627
    def _error_code(result):
 
628
        """A function to raise exceptions on errors, suitable
 
629
        for the 'restype' attribute on ctypes functions"""
 
630
        if result >= 0:
 
631
            return result
 
632
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
633
            raise gnutls.CertificateSecurityError(code=result)
 
634
        raise gnutls.Error(code=result)
 
635
 
 
636
    def _retry_on_error(result, func, arguments):
 
637
        """A function to retry on some errors, suitable
 
638
        for the 'errcheck' attribute on ctypes functions"""
 
639
        while result < 0:
 
640
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
641
                return _error_code(result)
 
642
            result = func(*arguments)
 
643
        return result
 
644
 
 
645
    # Unless otherwise indicated, the function declarations below are
 
646
    # all from the gnutls/gnutls.h C header file.
 
647
 
 
648
    # Functions
 
649
    priority_set_direct = _library.gnutls_priority_set_direct
 
650
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
651
                                    ctypes.POINTER(ctypes.c_char_p)]
 
652
    priority_set_direct.restype = _error_code
 
653
 
 
654
    init = _library.gnutls_init
 
655
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
656
    init.restype = _error_code
 
657
 
 
658
    set_default_priority = _library.gnutls_set_default_priority
 
659
    set_default_priority.argtypes = [session_t]
 
660
    set_default_priority.restype = _error_code
 
661
 
 
662
    record_send = _library.gnutls_record_send
 
663
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
664
                            ctypes.c_size_t]
 
665
    record_send.restype = ctypes.c_ssize_t
 
666
    record_send.errcheck = _retry_on_error
 
667
 
 
668
    certificate_allocate_credentials = (
 
669
        _library.gnutls_certificate_allocate_credentials)
 
670
    certificate_allocate_credentials.argtypes = [
 
671
        ctypes.POINTER(certificate_credentials_t)]
 
672
    certificate_allocate_credentials.restype = _error_code
 
673
 
 
674
    certificate_free_credentials = (
 
675
        _library.gnutls_certificate_free_credentials)
 
676
    certificate_free_credentials.argtypes = [
 
677
        certificate_credentials_t]
 
678
    certificate_free_credentials.restype = None
 
679
 
 
680
    handshake_set_private_extensions = (
 
681
        _library.gnutls_handshake_set_private_extensions)
 
682
    handshake_set_private_extensions.argtypes = [session_t,
 
683
                                                 ctypes.c_int]
 
684
    handshake_set_private_extensions.restype = None
 
685
 
 
686
    credentials_set = _library.gnutls_credentials_set
 
687
    credentials_set.argtypes = [session_t, credentials_type_t,
 
688
                                ctypes.c_void_p]
 
689
    credentials_set.restype = _error_code
 
690
 
 
691
    strerror = _library.gnutls_strerror
 
692
    strerror.argtypes = [ctypes.c_int]
 
693
    strerror.restype = ctypes.c_char_p
 
694
 
 
695
    certificate_type_get = _library.gnutls_certificate_type_get
 
696
    certificate_type_get.argtypes = [session_t]
 
697
    certificate_type_get.restype = _error_code
 
698
 
 
699
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
700
    certificate_get_peers.argtypes = [session_t,
 
701
                                      ctypes.POINTER(ctypes.c_uint)]
 
702
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
703
 
 
704
    global_set_log_level = _library.gnutls_global_set_log_level
 
705
    global_set_log_level.argtypes = [ctypes.c_int]
 
706
    global_set_log_level.restype = None
 
707
 
 
708
    global_set_log_function = _library.gnutls_global_set_log_function
 
709
    global_set_log_function.argtypes = [log_func]
 
710
    global_set_log_function.restype = None
 
711
 
 
712
    deinit = _library.gnutls_deinit
 
713
    deinit.argtypes = [session_t]
 
714
    deinit.restype = None
 
715
 
 
716
    handshake = _library.gnutls_handshake
 
717
    handshake.argtypes = [session_t]
 
718
    handshake.restype = _error_code
 
719
    handshake.errcheck = _retry_on_error
 
720
 
 
721
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
722
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
723
    transport_set_ptr.restype = None
 
724
 
 
725
    bye = _library.gnutls_bye
 
726
    bye.argtypes = [session_t, close_request_t]
 
727
    bye.restype = _error_code
 
728
    bye.errcheck = _retry_on_error
 
729
 
 
730
    check_version = _library.gnutls_check_version
 
731
    check_version.argtypes = [ctypes.c_char_p]
 
732
    check_version.restype = ctypes.c_char_p
 
733
 
 
734
    # All the function declarations below are from gnutls/openpgp.h
 
735
 
 
736
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
737
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
738
    openpgp_crt_init.restype = _error_code
 
739
 
 
740
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
741
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
742
                                   ctypes.POINTER(datum_t),
 
743
                                   openpgp_crt_fmt_t]
 
744
    openpgp_crt_import.restype = _error_code
 
745
 
 
746
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
747
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
748
                                        ctypes.POINTER(ctypes.c_uint)]
 
749
    openpgp_crt_verify_self.restype = _error_code
 
750
 
 
751
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
752
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
753
    openpgp_crt_deinit.restype = None
 
754
 
 
755
    openpgp_crt_get_fingerprint = (
 
756
        _library.gnutls_openpgp_crt_get_fingerprint)
 
757
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
758
                                            ctypes.c_void_p,
 
759
                                            ctypes.POINTER(
 
760
                                                ctypes.c_size_t)]
 
761
    openpgp_crt_get_fingerprint.restype = _error_code
 
762
 
 
763
    # Remove non-public functions
 
764
    del _error_code, _retry_on_error
 
765
# Create the global "gnutls" object, simulating a module
 
766
gnutls = GnuTLS()
 
767
 
 
768
 
 
769
def call_pipe(connection,       # : multiprocessing.Connection
 
770
              func, *args, **kwargs):
 
771
    """This function is meant to be called by multiprocessing.Process
 
772
 
 
773
    This function runs func(*args, **kwargs), and writes the resulting
 
774
    return value on the provided multiprocessing.Connection.
 
775
    """
 
776
    connection.send(func(*args, **kwargs))
 
777
    connection.close()
408
778
 
409
779
 
410
780
class Client(object):
411
781
    """A representation of a client host served by this server.
412
 
    
 
782
 
413
783
    Attributes:
414
784
    approved:   bool(); 'None' if not yet approved/disapproved
415
785
    approval_delay: datetime.timedelta(); Time to wait for approval
417
787
    checker:    subprocess.Popen(); a running checker process used
418
788
                                    to see if the client lives.
419
789
                                    'None' if no process is running.
420
 
    checker_callback_tag: a gobject event source tag, or None
 
790
    checker_callback_tag: a GLib event source tag, or None
421
791
    checker_command: string; External command which is run to check
422
792
                     if client lives.  %() expansions are done at
423
793
                     runtime with vars(self) as dict, so that for
424
794
                     instance %(name)s can be used in the command.
425
 
    checker_initiator_tag: a gobject event source tag, or None
 
795
    checker_initiator_tag: a GLib event source tag, or None
426
796
    created:    datetime.datetime(); (UTC) object creation
427
797
    client_structure: Object describing what attributes a client has
428
798
                      and is used for storing the client at exit
429
799
    current_checker_command: string; current running checker_command
430
 
    disable_initiator_tag: a gobject event source tag, or None
 
800
    disable_initiator_tag: a GLib event source tag, or None
431
801
    enabled:    bool()
432
802
    fingerprint: string (40 or 32 hexadecimal digits); used to
433
803
                 uniquely identify the client
438
808
    last_checker_status: integer between 0 and 255 reflecting exit
439
809
                         status of last checker. -1 reflects crashed
440
810
                         checker, -2 means no checker completed yet.
 
811
    last_checker_signal: The signal which killed the last checker, if
 
812
                         last_checker_status is -1
441
813
    last_enabled: datetime.datetime(); (UTC) or None
442
814
    name:       string; from the config file, used in log messages and
443
815
                        D-Bus identifiers
450
822
                disabled, or None
451
823
    server_settings: The server_settings dict from main()
452
824
    """
453
 
    
 
825
 
454
826
    runtime_expansions = ("approval_delay", "approval_duration",
455
827
                          "created", "enabled", "expires",
456
828
                          "fingerprint", "host", "interval",
457
829
                          "last_approval_request", "last_checked_ok",
458
830
                          "last_enabled", "name", "timeout")
459
 
    client_defaults = { "timeout": "PT5M",
460
 
                        "extended_timeout": "PT15M",
461
 
                        "interval": "PT2M",
462
 
                        "checker": "fping -q -- %%(host)s",
463
 
                        "host": "",
464
 
                        "approval_delay": "PT0S",
465
 
                        "approval_duration": "PT1S",
466
 
                        "approved_by_default": "True",
467
 
                        "enabled": "True",
468
 
                        }
469
 
    
470
 
    def timeout_milliseconds(self):
471
 
        "Return the 'timeout' attribute in milliseconds"
472
 
        return timedelta_to_milliseconds(self.timeout)
473
 
    
474
 
    def extended_timeout_milliseconds(self):
475
 
        "Return the 'extended_timeout' attribute in milliseconds"
476
 
        return timedelta_to_milliseconds(self.extended_timeout)
477
 
    
478
 
    def interval_milliseconds(self):
479
 
        "Return the 'interval' attribute in milliseconds"
480
 
        return timedelta_to_milliseconds(self.interval)
481
 
    
482
 
    def approval_delay_milliseconds(self):
483
 
        return timedelta_to_milliseconds(self.approval_delay)
484
 
    
 
831
    client_defaults = {
 
832
        "timeout": "PT5M",
 
833
        "extended_timeout": "PT15M",
 
834
        "interval": "PT2M",
 
835
        "checker": "fping -q -- %%(host)s",
 
836
        "host": "",
 
837
        "approval_delay": "PT0S",
 
838
        "approval_duration": "PT1S",
 
839
        "approved_by_default": "True",
 
840
        "enabled": "True",
 
841
    }
 
842
 
485
843
    @staticmethod
486
844
    def config_parser(config):
487
845
        """Construct a new dict of client settings of this form:
494
852
        for client_name in config.sections():
495
853
            section = dict(config.items(client_name))
496
854
            client = settings[client_name] = {}
497
 
            
 
855
 
498
856
            client["host"] = section["host"]
499
857
            # Reformat values from string types to Python types
500
858
            client["approved_by_default"] = config.getboolean(
501
859
                client_name, "approved_by_default")
502
860
            client["enabled"] = config.getboolean(client_name,
503
861
                                                  "enabled")
504
 
            
 
862
 
 
863
            # Uppercase and remove spaces from fingerprint for later
 
864
            # comparison purposes with return value from the
 
865
            # fingerprint() function
505
866
            client["fingerprint"] = (section["fingerprint"].upper()
506
867
                                     .replace(" ", ""))
507
868
            if "secret" in section:
508
 
                client["secret"] = section["secret"].decode("base64")
 
869
                client["secret"] = codecs.decode(section["secret"]
 
870
                                                 .encode("utf-8"),
 
871
                                                 "base64")
509
872
            elif "secfile" in section:
510
873
                with open(os.path.expanduser(os.path.expandvars
511
874
                                             (section["secfile"])),
512
875
                          "rb") as secfile:
513
876
                    client["secret"] = secfile.read()
514
877
            else:
515
 
                raise TypeError("No secret or secfile for section {0}"
 
878
                raise TypeError("No secret or secfile for section {}"
516
879
                                .format(section))
517
880
            client["timeout"] = string_to_delta(section["timeout"])
518
881
            client["extended_timeout"] = string_to_delta(
526
889
            client["last_approval_request"] = None
527
890
            client["last_checked_ok"] = None
528
891
            client["last_checker_status"] = -2
529
 
        
 
892
 
530
893
        return settings
531
 
    
532
 
    def __init__(self, settings, name = None, server_settings=None):
 
894
 
 
895
    def __init__(self, settings, name=None, server_settings=None):
533
896
        self.name = name
534
897
        if server_settings is None:
535
898
            server_settings = {}
536
899
        self.server_settings = server_settings
537
900
        # adding all client settings
538
 
        for setting, value in settings.iteritems():
 
901
        for setting, value in settings.items():
539
902
            setattr(self, setting, value)
540
 
        
 
903
 
541
904
        if self.enabled:
542
905
            if not hasattr(self, "last_enabled"):
543
906
                self.last_enabled = datetime.datetime.utcnow()
547
910
        else:
548
911
            self.last_enabled = None
549
912
            self.expires = None
550
 
        
 
913
 
551
914
        logger.debug("Creating client %r", self.name)
552
 
        # Uppercase and remove spaces from fingerprint for later
553
 
        # comparison purposes with return value from the fingerprint()
554
 
        # function
555
915
        logger.debug("  Fingerprint: %s", self.fingerprint)
556
916
        self.created = settings.get("created",
557
917
                                    datetime.datetime.utcnow())
558
 
        
 
918
 
559
919
        # attributes specific for this server instance
560
920
        self.checker = None
561
921
        self.checker_initiator_tag = None
564
924
        self.current_checker_command = None
565
925
        self.approved = None
566
926
        self.approvals_pending = 0
567
 
        self.changedstate = (multiprocessing_manager
568
 
                             .Condition(multiprocessing_manager
569
 
                                        .Lock()))
570
 
        self.client_structure = [attr for attr in
571
 
                                 self.__dict__.iterkeys()
 
927
        self.changedstate = multiprocessing_manager.Condition(
 
928
            multiprocessing_manager.Lock())
 
929
        self.client_structure = [attr
 
930
                                 for attr in self.__dict__.keys()
572
931
                                 if not attr.startswith("_")]
573
932
        self.client_structure.append("client_structure")
574
 
        
575
 
        for name, t in inspect.getmembers(type(self),
576
 
                                          lambda obj:
577
 
                                              isinstance(obj,
578
 
                                                         property)):
 
933
 
 
934
        for name, t in inspect.getmembers(
 
935
                type(self), lambda obj: isinstance(obj, property)):
579
936
            if not name.startswith("_"):
580
937
                self.client_structure.append(name)
581
 
    
 
938
 
582
939
    # Send notice to process children that client state has changed
583
940
    def send_changedstate(self):
584
941
        with self.changedstate:
585
942
            self.changedstate.notify_all()
586
 
    
 
943
 
587
944
    def enable(self):
588
945
        """Start this client's checker and timeout hooks"""
589
946
        if getattr(self, "enabled", False):
594
951
        self.last_enabled = datetime.datetime.utcnow()
595
952
        self.init_checker()
596
953
        self.send_changedstate()
597
 
    
 
954
 
598
955
    def disable(self, quiet=True):
599
956
        """Disable this client."""
600
957
        if not getattr(self, "enabled", False):
602
959
        if not quiet:
603
960
            logger.info("Disabling client %s", self.name)
604
961
        if getattr(self, "disable_initiator_tag", None) is not None:
605
 
            gobject.source_remove(self.disable_initiator_tag)
 
962
            GLib.source_remove(self.disable_initiator_tag)
606
963
            self.disable_initiator_tag = None
607
964
        self.expires = None
608
965
        if getattr(self, "checker_initiator_tag", None) is not None:
609
 
            gobject.source_remove(self.checker_initiator_tag)
 
966
            GLib.source_remove(self.checker_initiator_tag)
610
967
            self.checker_initiator_tag = None
611
968
        self.stop_checker()
612
969
        self.enabled = False
613
970
        if not quiet:
614
971
            self.send_changedstate()
615
 
        # Do not run this again if called by a gobject.timeout_add
 
972
        # Do not run this again if called by a GLib.timeout_add
616
973
        return False
617
 
    
 
974
 
618
975
    def __del__(self):
619
976
        self.disable()
620
 
    
 
977
 
621
978
    def init_checker(self):
622
979
        # Schedule a new checker to be started an 'interval' from now,
623
980
        # and every interval from then on.
624
981
        if self.checker_initiator_tag is not None:
625
 
            gobject.source_remove(self.checker_initiator_tag)
626
 
        self.checker_initiator_tag = (gobject.timeout_add
627
 
                                      (self.interval_milliseconds(),
628
 
                                       self.start_checker))
 
982
            GLib.source_remove(self.checker_initiator_tag)
 
983
        self.checker_initiator_tag = GLib.timeout_add(
 
984
            int(self.interval.total_seconds() * 1000),
 
985
            self.start_checker)
629
986
        # Schedule a disable() when 'timeout' has passed
630
987
        if self.disable_initiator_tag is not None:
631
 
            gobject.source_remove(self.disable_initiator_tag)
632
 
        self.disable_initiator_tag = (gobject.timeout_add
633
 
                                   (self.timeout_milliseconds(),
634
 
                                    self.disable))
 
988
            GLib.source_remove(self.disable_initiator_tag)
 
989
        self.disable_initiator_tag = GLib.timeout_add(
 
990
            int(self.timeout.total_seconds() * 1000), self.disable)
635
991
        # Also start a new checker *right now*.
636
992
        self.start_checker()
637
 
    
638
 
    def checker_callback(self, pid, condition, command):
 
993
 
 
994
    def checker_callback(self, source, condition, connection,
 
995
                         command):
639
996
        """The checker has completed, so take appropriate actions."""
640
997
        self.checker_callback_tag = None
641
998
        self.checker = None
642
 
        if os.WIFEXITED(condition):
643
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
999
        # Read return code from connection (see call_pipe)
 
1000
        returncode = connection.recv()
 
1001
        connection.close()
 
1002
 
 
1003
        if returncode >= 0:
 
1004
            self.last_checker_status = returncode
 
1005
            self.last_checker_signal = None
644
1006
            if self.last_checker_status == 0:
645
1007
                logger.info("Checker for %(name)s succeeded",
646
1008
                            vars(self))
647
1009
                self.checked_ok()
648
1010
            else:
649
 
                logger.info("Checker for %(name)s failed",
650
 
                            vars(self))
 
1011
                logger.info("Checker for %(name)s failed", vars(self))
651
1012
        else:
652
1013
            self.last_checker_status = -1
 
1014
            self.last_checker_signal = -returncode
653
1015
            logger.warning("Checker for %(name)s crashed?",
654
1016
                           vars(self))
655
 
    
 
1017
        return False
 
1018
 
656
1019
    def checked_ok(self):
657
1020
        """Assert that the client has been seen, alive and well."""
658
1021
        self.last_checked_ok = datetime.datetime.utcnow()
659
1022
        self.last_checker_status = 0
 
1023
        self.last_checker_signal = None
660
1024
        self.bump_timeout()
661
 
    
 
1025
 
662
1026
    def bump_timeout(self, timeout=None):
663
1027
        """Bump up the timeout for this client."""
664
1028
        if timeout is None:
665
1029
            timeout = self.timeout
666
1030
        if self.disable_initiator_tag is not None:
667
 
            gobject.source_remove(self.disable_initiator_tag)
 
1031
            GLib.source_remove(self.disable_initiator_tag)
668
1032
            self.disable_initiator_tag = None
669
1033
        if getattr(self, "enabled", False):
670
 
            self.disable_initiator_tag = (gobject.timeout_add
671
 
                                          (timedelta_to_milliseconds
672
 
                                           (timeout), self.disable))
 
1034
            self.disable_initiator_tag = GLib.timeout_add(
 
1035
                int(timeout.total_seconds() * 1000), self.disable)
673
1036
            self.expires = datetime.datetime.utcnow() + timeout
674
 
    
 
1037
 
675
1038
    def need_approval(self):
676
1039
        self.last_approval_request = datetime.datetime.utcnow()
677
 
    
 
1040
 
678
1041
    def start_checker(self):
679
1042
        """Start a new checker subprocess if one is not running.
680
 
        
 
1043
 
681
1044
        If a checker already exists, leave it running and do
682
1045
        nothing."""
683
1046
        # The reason for not killing a running checker is that if we
688
1051
        # checkers alone, the checker would have to take more time
689
1052
        # than 'timeout' for the client to be disabled, which is as it
690
1053
        # should be.
691
 
        
692
 
        # If a checker exists, make sure it is not a zombie
693
 
        try:
694
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
695
 
        except AttributeError:
696
 
            pass
697
 
        except OSError as error:
698
 
            if error.errno != errno.ECHILD:
699
 
                raise
700
 
        else:
701
 
            if pid:
702
 
                logger.warning("Checker was a zombie")
703
 
                gobject.source_remove(self.checker_callback_tag)
704
 
                self.checker_callback(pid, status,
705
 
                                      self.current_checker_command)
 
1054
 
 
1055
        if self.checker is not None and not self.checker.is_alive():
 
1056
            logger.warning("Checker was not alive; joining")
 
1057
            self.checker.join()
 
1058
            self.checker = None
706
1059
        # Start a new checker if needed
707
1060
        if self.checker is None:
708
1061
            # Escape attributes for the shell
709
 
            escaped_attrs = dict(
710
 
                (attr, re.escape(unicode(getattr(self, attr))))
711
 
                for attr in
712
 
                self.runtime_expansions)
 
1062
            escaped_attrs = {
 
1063
                attr: re.escape(str(getattr(self, attr)))
 
1064
                for attr in self.runtime_expansions}
713
1065
            try:
714
1066
                command = self.checker_command % escaped_attrs
715
1067
            except TypeError as error:
716
1068
                logger.error('Could not format string "%s"',
717
 
                             self.checker_command, exc_info=error)
718
 
                return True # Try again later
 
1069
                             self.checker_command,
 
1070
                             exc_info=error)
 
1071
                return True     # Try again later
719
1072
            self.current_checker_command = command
720
 
            try:
721
 
                logger.info("Starting checker %r for %s",
722
 
                            command, self.name)
723
 
                # We don't need to redirect stdout and stderr, since
724
 
                # in normal mode, that is already done by daemon(),
725
 
                # and in debug mode we don't want to.  (Stdin is
726
 
                # always replaced by /dev/null.)
727
 
                # The exception is when not debugging but nevertheless
728
 
                # running in the foreground; use the previously
729
 
                # created wnull.
730
 
                popen_args = {}
731
 
                if (not self.server_settings["debug"]
732
 
                    and self.server_settings["foreground"]):
733
 
                    popen_args.update({"stdout": wnull,
734
 
                                       "stderr": wnull })
735
 
                self.checker = subprocess.Popen(command,
736
 
                                                close_fds=True,
737
 
                                                shell=True, cwd="/",
738
 
                                                **popen_args)
739
 
            except OSError as error:
740
 
                logger.error("Failed to start subprocess",
741
 
                             exc_info=error)
742
 
                return True
743
 
            self.checker_callback_tag = (gobject.child_watch_add
744
 
                                         (self.checker.pid,
745
 
                                          self.checker_callback,
746
 
                                          data=command))
747
 
            # The checker may have completed before the gobject
748
 
            # watch was added.  Check for this.
749
 
            try:
750
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
751
 
            except OSError as error:
752
 
                if error.errno == errno.ECHILD:
753
 
                    # This should never happen
754
 
                    logger.error("Child process vanished",
755
 
                                 exc_info=error)
756
 
                    return True
757
 
                raise
758
 
            if pid:
759
 
                gobject.source_remove(self.checker_callback_tag)
760
 
                self.checker_callback(pid, status, command)
761
 
        # Re-run this periodically if run by gobject.timeout_add
 
1073
            logger.info("Starting checker %r for %s", command,
 
1074
                        self.name)
 
1075
            # We don't need to redirect stdout and stderr, since
 
1076
            # in normal mode, that is already done by daemon(),
 
1077
            # and in debug mode we don't want to.  (Stdin is
 
1078
            # always replaced by /dev/null.)
 
1079
            # The exception is when not debugging but nevertheless
 
1080
            # running in the foreground; use the previously
 
1081
            # created wnull.
 
1082
            popen_args = {"close_fds": True,
 
1083
                          "shell": True,
 
1084
                          "cwd": "/"}
 
1085
            if (not self.server_settings["debug"]
 
1086
                and self.server_settings["foreground"]):
 
1087
                popen_args.update({"stdout": wnull,
 
1088
                                   "stderr": wnull})
 
1089
            pipe = multiprocessing.Pipe(duplex=False)
 
1090
            self.checker = multiprocessing.Process(
 
1091
                target=call_pipe,
 
1092
                args=(pipe[1], subprocess.call, command),
 
1093
                kwargs=popen_args)
 
1094
            self.checker.start()
 
1095
            self.checker_callback_tag = GLib.io_add_watch(
 
1096
                pipe[0].fileno(), GLib.IO_IN,
 
1097
                self.checker_callback, pipe[0], command)
 
1098
        # Re-run this periodically if run by GLib.timeout_add
762
1099
        return True
763
 
    
 
1100
 
764
1101
    def stop_checker(self):
765
1102
        """Force the checker process, if any, to stop."""
766
1103
        if self.checker_callback_tag:
767
 
            gobject.source_remove(self.checker_callback_tag)
 
1104
            GLib.source_remove(self.checker_callback_tag)
768
1105
            self.checker_callback_tag = None
769
1106
        if getattr(self, "checker", None) is None:
770
1107
            return
771
1108
        logger.debug("Stopping checker for %(name)s", vars(self))
772
 
        try:
773
 
            self.checker.terminate()
774
 
            #time.sleep(0.5)
775
 
            #if self.checker.poll() is None:
776
 
            #    self.checker.kill()
777
 
        except OSError as error:
778
 
            if error.errno != errno.ESRCH: # No such process
779
 
                raise
 
1109
        self.checker.terminate()
780
1110
        self.checker = None
781
1111
 
782
1112
 
783
 
def dbus_service_property(dbus_interface, signature="v",
784
 
                          access="readwrite", byte_arrays=False):
 
1113
def dbus_service_property(dbus_interface,
 
1114
                          signature="v",
 
1115
                          access="readwrite",
 
1116
                          byte_arrays=False):
785
1117
    """Decorators for marking methods of a DBusObjectWithProperties to
786
1118
    become properties on the D-Bus.
787
 
    
 
1119
 
788
1120
    The decorated method will be called with no arguments by "Get"
789
1121
    and with one argument by "Set".
790
 
    
 
1122
 
791
1123
    The parameters, where they are supported, are the same as
792
1124
    dbus.service.method, except there is only "signature", since the
793
1125
    type from Get() and the type sent to Set() is the same.
796
1128
    # "Set" method, so we fail early here:
797
1129
    if byte_arrays and signature != "ay":
798
1130
        raise ValueError("Byte arrays not supported for non-'ay'"
799
 
                         " signature {0!r}".format(signature))
 
1131
                         " signature {!r}".format(signature))
 
1132
 
800
1133
    def decorator(func):
801
1134
        func._dbus_is_property = True
802
1135
        func._dbus_interface = dbus_interface
805
1138
        func._dbus_name = func.__name__
806
1139
        if func._dbus_name.endswith("_dbus_property"):
807
1140
            func._dbus_name = func._dbus_name[:-14]
808
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
1141
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
809
1142
        return func
 
1143
 
810
1144
    return decorator
811
1145
 
812
1146
 
813
1147
def dbus_interface_annotations(dbus_interface):
814
1148
    """Decorator for marking functions returning interface annotations
815
 
    
 
1149
 
816
1150
    Usage:
817
 
    
 
1151
 
818
1152
    @dbus_interface_annotations("org.example.Interface")
819
1153
    def _foo(self):  # Function name does not matter
820
1154
        return {"org.freedesktop.DBus.Deprecated": "true",
821
1155
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
822
1156
                    "false"}
823
1157
    """
 
1158
 
824
1159
    def decorator(func):
825
1160
        func._dbus_is_interface = True
826
1161
        func._dbus_interface = dbus_interface
827
1162
        func._dbus_name = dbus_interface
828
1163
        return func
 
1164
 
829
1165
    return decorator
830
1166
 
831
1167
 
832
1168
def dbus_annotations(annotations):
833
1169
    """Decorator to annotate D-Bus methods, signals or properties
834
1170
    Usage:
835
 
    
 
1171
 
 
1172
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
1173
                       "org.freedesktop.DBus.Property."
 
1174
                       "EmitsChangedSignal": "false"})
836
1175
    @dbus_service_property("org.example.Interface", signature="b",
837
1176
                           access="r")
838
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
839
 
                        "org.freedesktop.DBus.Property."
840
 
                        "EmitsChangedSignal": "false"})
841
1177
    def Property_dbus_property(self):
842
1178
        return dbus.Boolean(False)
 
1179
 
 
1180
    See also the DBusObjectWithAnnotations class.
843
1181
    """
 
1182
 
844
1183
    def decorator(func):
845
1184
        func._dbus_annotations = annotations
846
1185
        return func
 
1186
 
847
1187
    return decorator
848
1188
 
849
1189
 
850
1190
class DBusPropertyException(dbus.exceptions.DBusException):
851
1191
    """A base class for D-Bus property-related exceptions
852
1192
    """
853
 
    def __unicode__(self):
854
 
        return unicode(str(self))
 
1193
    pass
855
1194
 
856
1195
 
857
1196
class DBusPropertyAccessException(DBusPropertyException):
866
1205
    pass
867
1206
 
868
1207
 
869
 
class DBusObjectWithProperties(dbus.service.Object):
870
 
    """A D-Bus object with properties.
871
 
    
872
 
    Classes inheriting from this can use the dbus_service_property
873
 
    decorator to expose methods as D-Bus properties.  It exposes the
874
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1208
class DBusObjectWithAnnotations(dbus.service.Object):
 
1209
    """A D-Bus object with annotations.
 
1210
 
 
1211
    Classes inheriting from this can use the dbus_annotations
 
1212
    decorator to add annotations to methods or signals.
875
1213
    """
876
 
    
 
1214
 
877
1215
    @staticmethod
878
1216
    def _is_dbus_thing(thing):
879
1217
        """Returns a function testing if an attribute is a D-Bus thing
880
 
        
 
1218
 
881
1219
        If called like _is_dbus_thing("method") it returns a function
882
1220
        suitable for use as predicate to inspect.getmembers().
883
1221
        """
884
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
1222
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
885
1223
                                   False)
886
 
    
 
1224
 
887
1225
    def _get_all_dbus_things(self, thing):
888
1226
        """Returns a generator of (name, attribute) pairs
889
1227
        """
890
 
        return ((getattr(athing.__get__(self), "_dbus_name",
891
 
                         name),
 
1228
        return ((getattr(athing.__get__(self), "_dbus_name", name),
892
1229
                 athing.__get__(self))
893
1230
                for cls in self.__class__.__mro__
894
1231
                for name, athing in
895
 
                inspect.getmembers(cls,
896
 
                                   self._is_dbus_thing(thing)))
897
 
    
 
1232
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
1233
 
 
1234
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1235
                         out_signature="s",
 
1236
                         path_keyword='object_path',
 
1237
                         connection_keyword='connection')
 
1238
    def Introspect(self, object_path, connection):
 
1239
        """Overloading of standard D-Bus method.
 
1240
 
 
1241
        Inserts annotation tags on methods and signals.
 
1242
        """
 
1243
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
1244
                                                   connection)
 
1245
        try:
 
1246
            document = xml.dom.minidom.parseString(xmlstring)
 
1247
 
 
1248
            for if_tag in document.getElementsByTagName("interface"):
 
1249
                # Add annotation tags
 
1250
                for typ in ("method", "signal"):
 
1251
                    for tag in if_tag.getElementsByTagName(typ):
 
1252
                        annots = dict()
 
1253
                        for name, prop in (self.
 
1254
                                           _get_all_dbus_things(typ)):
 
1255
                            if (name == tag.getAttribute("name")
 
1256
                                and prop._dbus_interface
 
1257
                                == if_tag.getAttribute("name")):
 
1258
                                annots.update(getattr(
 
1259
                                    prop, "_dbus_annotations", {}))
 
1260
                        for name, value in annots.items():
 
1261
                            ann_tag = document.createElement(
 
1262
                                "annotation")
 
1263
                            ann_tag.setAttribute("name", name)
 
1264
                            ann_tag.setAttribute("value", value)
 
1265
                            tag.appendChild(ann_tag)
 
1266
                # Add interface annotation tags
 
1267
                for annotation, value in dict(
 
1268
                    itertools.chain.from_iterable(
 
1269
                        annotations().items()
 
1270
                        for name, annotations
 
1271
                        in self._get_all_dbus_things("interface")
 
1272
                        if name == if_tag.getAttribute("name")
 
1273
                        )).items():
 
1274
                    ann_tag = document.createElement("annotation")
 
1275
                    ann_tag.setAttribute("name", annotation)
 
1276
                    ann_tag.setAttribute("value", value)
 
1277
                    if_tag.appendChild(ann_tag)
 
1278
                # Fix argument name for the Introspect method itself
 
1279
                if (if_tag.getAttribute("name")
 
1280
                    == dbus.INTROSPECTABLE_IFACE):
 
1281
                    for cn in if_tag.getElementsByTagName("method"):
 
1282
                        if cn.getAttribute("name") == "Introspect":
 
1283
                            for arg in cn.getElementsByTagName("arg"):
 
1284
                                if (arg.getAttribute("direction")
 
1285
                                    == "out"):
 
1286
                                    arg.setAttribute("name",
 
1287
                                                     "xml_data")
 
1288
            xmlstring = document.toxml("utf-8")
 
1289
            document.unlink()
 
1290
        except (AttributeError, xml.dom.DOMException,
 
1291
                xml.parsers.expat.ExpatError) as error:
 
1292
            logger.error("Failed to override Introspection method",
 
1293
                         exc_info=error)
 
1294
        return xmlstring
 
1295
 
 
1296
 
 
1297
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
1298
    """A D-Bus object with properties.
 
1299
 
 
1300
    Classes inheriting from this can use the dbus_service_property
 
1301
    decorator to expose methods as D-Bus properties.  It exposes the
 
1302
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1303
    """
 
1304
 
898
1305
    def _get_dbus_property(self, interface_name, property_name):
899
1306
        """Returns a bound method if one exists which is a D-Bus
900
1307
        property with the specified name and interface.
901
1308
        """
902
 
        for cls in  self.__class__.__mro__:
903
 
            for name, value in (inspect.getmembers
904
 
                                (cls,
905
 
                                 self._is_dbus_thing("property"))):
 
1309
        for cls in self.__class__.__mro__:
 
1310
            for name, value in inspect.getmembers(
 
1311
                    cls, self._is_dbus_thing("property")):
906
1312
                if (value._dbus_name == property_name
907
1313
                    and value._dbus_interface == interface_name):
908
1314
                    return value.__get__(self)
909
 
        
 
1315
 
910
1316
        # No such property
911
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
912
 
                                   + interface_name + "."
913
 
                                   + property_name)
914
 
    
915
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
1317
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
1318
            self.dbus_object_path, interface_name, property_name))
 
1319
 
 
1320
    @classmethod
 
1321
    def _get_all_interface_names(cls):
 
1322
        """Get a sequence of all interfaces supported by an object"""
 
1323
        return (name for name in set(getattr(getattr(x, attr),
 
1324
                                             "_dbus_interface", None)
 
1325
                                     for x in (inspect.getmro(cls))
 
1326
                                     for attr in dir(x))
 
1327
                if name is not None)
 
1328
 
 
1329
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1330
                         in_signature="ss",
916
1331
                         out_signature="v")
917
1332
    def Get(self, interface_name, property_name):
918
1333
        """Standard D-Bus property Get() method, see D-Bus standard.
924
1339
        if not hasattr(value, "variant_level"):
925
1340
            return value
926
1341
        return type(value)(value, variant_level=value.variant_level+1)
927
 
    
 
1342
 
928
1343
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
929
1344
    def Set(self, interface_name, property_name, value):
930
1345
        """Standard D-Bus property Set() method, see D-Bus standard.
937
1352
            # signatures other than "ay".
938
1353
            if prop._dbus_signature != "ay":
939
1354
                raise ValueError("Byte arrays not supported for non-"
940
 
                                 "'ay' signature {0!r}"
 
1355
                                 "'ay' signature {!r}"
941
1356
                                 .format(prop._dbus_signature))
942
1357
            value = dbus.ByteArray(b''.join(chr(byte)
943
1358
                                            for byte in value))
944
1359
        prop(value)
945
 
    
946
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1360
 
 
1361
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1362
                         in_signature="s",
947
1363
                         out_signature="a{sv}")
948
1364
    def GetAll(self, interface_name):
949
1365
        """Standard D-Bus property GetAll() method, see D-Bus
950
1366
        standard.
951
 
        
 
1367
 
952
1368
        Note: Will not include properties with access="write".
953
1369
        """
954
1370
        properties = {}
964
1380
            if not hasattr(value, "variant_level"):
965
1381
                properties[name] = value
966
1382
                continue
967
 
            properties[name] = type(value)(value, variant_level=
968
 
                                           value.variant_level+1)
 
1383
            properties[name] = type(value)(
 
1384
                value, variant_level=value.variant_level + 1)
969
1385
        return dbus.Dictionary(properties, signature="sv")
970
 
    
 
1386
 
 
1387
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
1388
    def PropertiesChanged(self, interface_name, changed_properties,
 
1389
                          invalidated_properties):
 
1390
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
1391
        standard.
 
1392
        """
 
1393
        pass
 
1394
 
971
1395
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
972
1396
                         out_signature="s",
973
1397
                         path_keyword='object_path',
974
1398
                         connection_keyword='connection')
975
1399
    def Introspect(self, object_path, connection):
976
1400
        """Overloading of standard D-Bus method.
977
 
        
 
1401
 
978
1402
        Inserts property tags and interface annotation tags.
979
1403
        """
980
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
981
 
                                                   connection)
 
1404
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1405
                                                         object_path,
 
1406
                                                         connection)
982
1407
        try:
983
1408
            document = xml.dom.minidom.parseString(xmlstring)
 
1409
 
984
1410
            def make_tag(document, name, prop):
985
1411
                e = document.createElement("property")
986
1412
                e.setAttribute("name", name)
987
1413
                e.setAttribute("type", prop._dbus_signature)
988
1414
                e.setAttribute("access", prop._dbus_access)
989
1415
                return e
 
1416
 
990
1417
            for if_tag in document.getElementsByTagName("interface"):
991
1418
                # Add property tags
992
1419
                for tag in (make_tag(document, name, prop)
995
1422
                            if prop._dbus_interface
996
1423
                            == if_tag.getAttribute("name")):
997
1424
                    if_tag.appendChild(tag)
998
 
                # Add annotation tags
999
 
                for typ in ("method", "signal", "property"):
1000
 
                    for tag in if_tag.getElementsByTagName(typ):
1001
 
                        annots = dict()
1002
 
                        for name, prop in (self.
1003
 
                                           _get_all_dbus_things(typ)):
1004
 
                            if (name == tag.getAttribute("name")
1005
 
                                and prop._dbus_interface
1006
 
                                == if_tag.getAttribute("name")):
1007
 
                                annots.update(getattr
1008
 
                                              (prop,
1009
 
                                               "_dbus_annotations",
1010
 
                                               {}))
1011
 
                        for name, value in annots.iteritems():
1012
 
                            ann_tag = document.createElement(
1013
 
                                "annotation")
1014
 
                            ann_tag.setAttribute("name", name)
1015
 
                            ann_tag.setAttribute("value", value)
1016
 
                            tag.appendChild(ann_tag)
1017
 
                # Add interface annotation tags
1018
 
                for annotation, value in dict(
1019
 
                    itertools.chain.from_iterable(
1020
 
                        annotations().iteritems()
1021
 
                        for name, annotations in
1022
 
                        self._get_all_dbus_things("interface")
1023
 
                        if name == if_tag.getAttribute("name")
1024
 
                        )).iteritems():
1025
 
                    ann_tag = document.createElement("annotation")
1026
 
                    ann_tag.setAttribute("name", annotation)
1027
 
                    ann_tag.setAttribute("value", value)
1028
 
                    if_tag.appendChild(ann_tag)
 
1425
                # Add annotation tags for properties
 
1426
                for tag in if_tag.getElementsByTagName("property"):
 
1427
                    annots = dict()
 
1428
                    for name, prop in self._get_all_dbus_things(
 
1429
                            "property"):
 
1430
                        if (name == tag.getAttribute("name")
 
1431
                            and prop._dbus_interface
 
1432
                            == if_tag.getAttribute("name")):
 
1433
                            annots.update(getattr(
 
1434
                                prop, "_dbus_annotations", {}))
 
1435
                    for name, value in annots.items():
 
1436
                        ann_tag = document.createElement(
 
1437
                            "annotation")
 
1438
                        ann_tag.setAttribute("name", name)
 
1439
                        ann_tag.setAttribute("value", value)
 
1440
                        tag.appendChild(ann_tag)
1029
1441
                # Add the names to the return values for the
1030
1442
                # "org.freedesktop.DBus.Properties" methods
1031
1443
                if (if_tag.getAttribute("name")
1049
1461
                         exc_info=error)
1050
1462
        return xmlstring
1051
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
 
1052
1534
 
1053
1535
def datetime_to_dbus(dt, variant_level=0):
1054
1536
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1055
1537
    if dt is None:
1056
 
        return dbus.String("", variant_level = variant_level)
1057
 
    return dbus.String(dt.isoformat(),
1058
 
                       variant_level=variant_level)
 
1538
        return dbus.String("", variant_level=variant_level)
 
1539
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1059
1540
 
1060
1541
 
1061
1542
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1063
1544
    dbus.service.Object, it will add alternate D-Bus attributes with
1064
1545
    interface names according to the "alt_interface_names" mapping.
1065
1546
    Usage:
1066
 
    
 
1547
 
1067
1548
    @alternate_dbus_interfaces({"org.example.Interface":
1068
1549
                                    "net.example.AlternateInterface"})
1069
1550
    class SampleDBusObject(dbus.service.Object):
1070
1551
        @dbus.service.method("org.example.Interface")
1071
1552
        def SampleDBusMethod():
1072
1553
            pass
1073
 
    
 
1554
 
1074
1555
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1075
1556
    reachable via two interfaces: "org.example.Interface" and
1076
1557
    "net.example.AlternateInterface", the latter of which will have
1077
1558
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1078
1559
    "true", unless "deprecate" is passed with a False value.
1079
 
    
 
1560
 
1080
1561
    This works for methods and signals, and also for D-Bus properties
1081
1562
    (from DBusObjectWithProperties) and interfaces (from the
1082
1563
    dbus_interface_annotations decorator).
1083
1564
    """
 
1565
 
1084
1566
    def wrapper(cls):
1085
1567
        for orig_interface_name, alt_interface_name in (
1086
 
            alt_interface_names.iteritems()):
 
1568
                alt_interface_names.items()):
1087
1569
            attr = {}
1088
1570
            interface_names = set()
1089
1571
            # Go though all attributes of the class
1091
1573
                # Ignore non-D-Bus attributes, and D-Bus attributes
1092
1574
                # with the wrong interface name
1093
1575
                if (not hasattr(attribute, "_dbus_interface")
1094
 
                    or not attribute._dbus_interface
1095
 
                    .startswith(orig_interface_name)):
 
1576
                    or not attribute._dbus_interface.startswith(
 
1577
                        orig_interface_name)):
1096
1578
                    continue
1097
1579
                # Create an alternate D-Bus interface name based on
1098
1580
                # the current name
1099
 
                alt_interface = (attribute._dbus_interface
1100
 
                                 .replace(orig_interface_name,
1101
 
                                          alt_interface_name))
 
1581
                alt_interface = attribute._dbus_interface.replace(
 
1582
                    orig_interface_name, alt_interface_name)
1102
1583
                interface_names.add(alt_interface)
1103
1584
                # Is this a D-Bus signal?
1104
1585
                if getattr(attribute, "_dbus_is_signal", False):
1105
1586
                    # Extract the original non-method undecorated
1106
1587
                    # function by black magic
1107
 
                    nonmethod_func = (dict(
 
1588
                    if sys.version_info.major == 2:
 
1589
                        nonmethod_func = (dict(
1108
1590
                            zip(attribute.func_code.co_freevars,
1109
 
                                attribute.__closure__))["func"]
1110
 
                                      .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)
1111
1598
                    # Create a new, but exactly alike, function
1112
1599
                    # object, and decorate it to be a new D-Bus signal
1113
1600
                    # with the alternate D-Bus interface name
1114
 
                    new_function = (dbus.service.signal
1115
 
                                    (alt_interface,
1116
 
                                     attribute._dbus_signature)
1117
 
                                    (types.FunctionType(
1118
 
                                nonmethod_func.func_code,
1119
 
                                nonmethod_func.func_globals,
1120
 
                                nonmethod_func.func_name,
1121
 
                                nonmethod_func.func_defaults,
1122
 
                                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))
1123
1605
                    # Copy annotations, if any
1124
1606
                    try:
1125
 
                        new_function._dbus_annotations = (
1126
 
                            dict(attribute._dbus_annotations))
 
1607
                        new_function._dbus_annotations = dict(
 
1608
                            attribute._dbus_annotations)
1127
1609
                    except AttributeError:
1128
1610
                        pass
 
1611
 
1129
1612
                    # Define a creator of a function to call both the
1130
1613
                    # original and alternate functions, so both the
1131
1614
                    # original and alternate signals gets sent when
1134
1617
                        """This function is a scope container to pass
1135
1618
                        func1 and func2 to the "call_both" function
1136
1619
                        outside of its arguments"""
 
1620
 
 
1621
                        @functools.wraps(func2)
1137
1622
                        def call_both(*args, **kwargs):
1138
1623
                            """This function will emit two D-Bus
1139
1624
                            signals by calling func1 and func2"""
1140
1625
                            func1(*args, **kwargs)
1141
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
 
1142
1633
                        return call_both
1143
1634
                    # Create the "call_both" function and add it to
1144
1635
                    # the class
1149
1640
                    # object.  Decorate it to be a new D-Bus method
1150
1641
                    # with the alternate D-Bus interface name.  Add it
1151
1642
                    # to the class.
1152
 
                    attr[attrname] = (dbus.service.method
1153
 
                                      (alt_interface,
1154
 
                                       attribute._dbus_in_signature,
1155
 
                                       attribute._dbus_out_signature)
1156
 
                                      (types.FunctionType
1157
 
                                       (attribute.func_code,
1158
 
                                        attribute.func_globals,
1159
 
                                        attribute.func_name,
1160
 
                                        attribute.func_defaults,
1161
 
                                        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)))
1162
1649
                    # Copy annotations, if any
1163
1650
                    try:
1164
 
                        attr[attrname]._dbus_annotations = (
1165
 
                            dict(attribute._dbus_annotations))
 
1651
                        attr[attrname]._dbus_annotations = dict(
 
1652
                            attribute._dbus_annotations)
1166
1653
                    except AttributeError:
1167
1654
                        pass
1168
1655
                # Is this a D-Bus property?
1171
1658
                    # object, and decorate it to be a new D-Bus
1172
1659
                    # property with the alternate D-Bus interface
1173
1660
                    # name.  Add it to the class.
1174
 
                    attr[attrname] = (dbus_service_property
1175
 
                                      (alt_interface,
1176
 
                                       attribute._dbus_signature,
1177
 
                                       attribute._dbus_access,
1178
 
                                       attribute
1179
 
                                       ._dbus_get_args_options
1180
 
                                       ["byte_arrays"])
1181
 
                                      (types.FunctionType
1182
 
                                       (attribute.func_code,
1183
 
                                        attribute.func_globals,
1184
 
                                        attribute.func_name,
1185
 
                                        attribute.func_defaults,
1186
 
                                        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)))
1187
1667
                    # Copy annotations, if any
1188
1668
                    try:
1189
 
                        attr[attrname]._dbus_annotations = (
1190
 
                            dict(attribute._dbus_annotations))
 
1669
                        attr[attrname]._dbus_annotations = dict(
 
1670
                            attribute._dbus_annotations)
1191
1671
                    except AttributeError:
1192
1672
                        pass
1193
1673
                # Is this a D-Bus interface?
1196
1676
                    # object.  Decorate it to be a new D-Bus interface
1197
1677
                    # with the alternate D-Bus interface name.  Add it
1198
1678
                    # to the class.
1199
 
                    attr[attrname] = (dbus_interface_annotations
1200
 
                                      (alt_interface)
1201
 
                                      (types.FunctionType
1202
 
                                       (attribute.func_code,
1203
 
                                        attribute.func_globals,
1204
 
                                        attribute.func_name,
1205
 
                                        attribute.func_defaults,
1206
 
                                        attribute.func_closure)))
 
1679
                    attr[attrname] = (
 
1680
                        dbus_interface_annotations(alt_interface)
 
1681
                        (copy_function(attribute)))
1207
1682
            if deprecate:
1208
1683
                # Deprecate all alternate interfaces
1209
 
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1684
                iname = "_AlternateDBusNames_interface_annotation{}"
1210
1685
                for interface_name in interface_names:
 
1686
 
1211
1687
                    @dbus_interface_annotations(interface_name)
1212
1688
                    def func(self):
1213
 
                        return { "org.freedesktop.DBus.Deprecated":
1214
 
                                     "true" }
 
1689
                        return {"org.freedesktop.DBus.Deprecated":
 
1690
                                "true"}
1215
1691
                    # Find an unused name
1216
1692
                    for aname in (iname.format(i)
1217
1693
                                  for i in itertools.count()):
1221
1697
            if interface_names:
1222
1698
                # Replace the class with a new subclass of it with
1223
1699
                # methods, signals, etc. as created above.
1224
 
                cls = type(b"{0}Alternate".format(cls.__name__),
1225
 
                           (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)
1226
1706
        return cls
 
1707
 
1227
1708
    return wrapper
1228
1709
 
1229
1710
 
1230
1711
@alternate_dbus_interfaces({"se.recompile.Mandos":
1231
 
                                "se.bsnet.fukt.Mandos"})
 
1712
                            "se.bsnet.fukt.Mandos"})
1232
1713
class ClientDBus(Client, DBusObjectWithProperties):
1233
1714
    """A Client class using D-Bus
1234
 
    
 
1715
 
1235
1716
    Attributes:
1236
1717
    dbus_object_path: dbus.ObjectPath
1237
1718
    bus: dbus.SystemBus()
1238
1719
    """
1239
 
    
 
1720
 
1240
1721
    runtime_expansions = (Client.runtime_expansions
1241
 
                          + ("dbus_object_path",))
1242
 
    
 
1722
                          + ("dbus_object_path", ))
 
1723
 
 
1724
    _interface = "se.recompile.Mandos.Client"
 
1725
 
1243
1726
    # dbus.service.Object doesn't use super(), so we can't either.
1244
 
    
1245
 
    def __init__(self, bus = None, *args, **kwargs):
 
1727
 
 
1728
    def __init__(self, bus=None, *args, **kwargs):
1246
1729
        self.bus = bus
1247
1730
        Client.__init__(self, *args, **kwargs)
1248
1731
        # Only now, when this client is initialized, can it show up on
1249
1732
        # the D-Bus
1250
 
        client_object_name = unicode(self.name).translate(
 
1733
        client_object_name = str(self.name).translate(
1251
1734
            {ord("."): ord("_"),
1252
1735
             ord("-"): ord("_")})
1253
 
        self.dbus_object_path = (dbus.ObjectPath
1254
 
                                 ("/clients/" + client_object_name))
 
1736
        self.dbus_object_path = dbus.ObjectPath(
 
1737
            "/clients/" + client_object_name)
1255
1738
        DBusObjectWithProperties.__init__(self, self.bus,
1256
1739
                                          self.dbus_object_path)
1257
 
    
1258
 
    def notifychangeproperty(transform_func,
1259
 
                             dbus_name, type_func=lambda x: x,
1260
 
                             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):
1261
1746
        """ Modify a variable so that it's a property which announces
1262
1747
        its changes to DBus.
1263
 
        
 
1748
 
1264
1749
        transform_fun: Function that takes a value and a variant_level
1265
1750
                       and transforms it to a D-Bus type.
1266
1751
        dbus_name: D-Bus name of the variable
1268
1753
                   to the D-Bus.  Default: no transform
1269
1754
        variant_level: D-Bus variant level.  Default: 1
1270
1755
        """
1271
 
        attrname = "_{0}".format(dbus_name)
 
1756
        attrname = "_{}".format(dbus_name)
 
1757
 
1272
1758
        def setter(self, value):
1273
1759
            if hasattr(self, "dbus_object_path"):
1274
1760
                if (not hasattr(self, attrname) or
1275
1761
                    type_func(getattr(self, attrname, None))
1276
1762
                    != type_func(value)):
1277
 
                    dbus_value = transform_func(type_func(value),
1278
 
                                                variant_level
1279
 
                                                =variant_level)
1280
 
                    self.PropertyChanged(dbus.String(dbus_name),
1281
 
                                         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())
1282
1778
            setattr(self, attrname, value)
1283
 
        
 
1779
 
1284
1780
        return property(lambda self: getattr(self, attrname), setter)
1285
 
    
 
1781
 
1286
1782
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1287
1783
    approvals_pending = notifychangeproperty(dbus.Boolean,
1288
1784
                                             "ApprovalPending",
1289
 
                                             type_func = bool)
 
1785
                                             type_func=bool)
1290
1786
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1291
1787
    last_enabled = notifychangeproperty(datetime_to_dbus,
1292
1788
                                        "LastEnabled")
1293
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1294
 
                                   type_func = lambda checker:
1295
 
                                       checker is not None)
 
1789
    checker = notifychangeproperty(
 
1790
        dbus.Boolean, "CheckerRunning",
 
1791
        type_func=lambda checker: checker is not None)
1296
1792
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1297
1793
                                           "LastCheckedOK")
1298
1794
    last_checker_status = notifychangeproperty(dbus.Int16,
1301
1797
        datetime_to_dbus, "LastApprovalRequest")
1302
1798
    approved_by_default = notifychangeproperty(dbus.Boolean,
1303
1799
                                               "ApprovedByDefault")
1304
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1305
 
                                          "ApprovalDelay",
1306
 
                                          type_func =
1307
 
                                          timedelta_to_milliseconds)
 
1800
    approval_delay = notifychangeproperty(
 
1801
        dbus.UInt64, "ApprovalDelay",
 
1802
        type_func=lambda td: td.total_seconds() * 1000)
1308
1803
    approval_duration = notifychangeproperty(
1309
1804
        dbus.UInt64, "ApprovalDuration",
1310
 
        type_func = timedelta_to_milliseconds)
 
1805
        type_func=lambda td: td.total_seconds() * 1000)
1311
1806
    host = notifychangeproperty(dbus.String, "Host")
1312
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1313
 
                                   type_func =
1314
 
                                   timedelta_to_milliseconds)
 
1807
    timeout = notifychangeproperty(
 
1808
        dbus.UInt64, "Timeout",
 
1809
        type_func=lambda td: td.total_seconds() * 1000)
1315
1810
    extended_timeout = notifychangeproperty(
1316
1811
        dbus.UInt64, "ExtendedTimeout",
1317
 
        type_func = timedelta_to_milliseconds)
1318
 
    interval = notifychangeproperty(dbus.UInt64,
1319
 
                                    "Interval",
1320
 
                                    type_func =
1321
 
                                    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)
1322
1816
    checker_command = notifychangeproperty(dbus.String, "Checker")
1323
 
    
 
1817
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1818
                                  invalidate_only=True)
 
1819
 
1324
1820
    del notifychangeproperty
1325
 
    
 
1821
 
1326
1822
    def __del__(self, *args, **kwargs):
1327
1823
        try:
1328
1824
            self.remove_from_connection()
1331
1827
        if hasattr(DBusObjectWithProperties, "__del__"):
1332
1828
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1333
1829
        Client.__del__(self, *args, **kwargs)
1334
 
    
1335
 
    def checker_callback(self, pid, condition, command,
1336
 
                         *args, **kwargs):
1337
 
        self.checker_callback_tag = None
1338
 
        self.checker = None
1339
 
        if os.WIFEXITED(condition):
1340
 
            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:
1341
1838
            # Emit D-Bus signal
1342
1839
            self.CheckerCompleted(dbus.Int16(exitstatus),
1343
 
                                  dbus.Int64(condition),
 
1840
                                  # This is specific to GNU libC
 
1841
                                  dbus.Int64(exitstatus << 8),
1344
1842
                                  dbus.String(command))
1345
1843
        else:
1346
1844
            # Emit D-Bus signal
1347
1845
            self.CheckerCompleted(dbus.Int16(-1),
1348
 
                                  dbus.Int64(condition),
 
1846
                                  dbus.Int64(
 
1847
                                      # This is specific to GNU libC
 
1848
                                      (exitstatus << 8)
 
1849
                                      | self.last_checker_signal),
1349
1850
                                  dbus.String(command))
1350
 
        
1351
 
        return Client.checker_callback(self, pid, condition, command,
1352
 
                                       *args, **kwargs)
1353
 
    
 
1851
        return ret
 
1852
 
1354
1853
    def start_checker(self, *args, **kwargs):
1355
1854
        old_checker_pid = getattr(self.checker, "pid", None)
1356
1855
        r = Client.start_checker(self, *args, **kwargs)
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
2857
        fail_count, test_count = doctest.testmod()
2345
2858
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2346
 
    
 
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
2385
2899
            server_settings["socket"] = os.dup(server_settings
2386
2900
                                               ["socket"])
2387
2901
    del server_config
2388
 
    
 
2902
 
2389
2903
    # Override the settings from the config file with command line
2390
2904
    # options, if set.
2391
2905
    for option in ("interface", "address", "port", "debug",
2392
 
                   "priority", "servicename", "configdir",
2393
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2394
 
                   "statedir", "socket", "foreground"):
 
2906
                   "priority", "servicename", "configdir", "use_dbus",
 
2907
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2908
                   "socket", "foreground", "zeroconf"):
2395
2909
        value = getattr(options, option)
2396
2910
        if value is not None:
2397
2911
            server_settings[option] = value
2398
2912
    del options
2399
2913
    # Force all strings to be unicode
2400
2914
    for option in server_settings.keys():
2401
 
        if type(server_settings[option]) is str:
2402
 
            server_settings[option] = unicode(server_settings[option])
 
2915
        if isinstance(server_settings[option], bytes):
 
2916
            server_settings[option] = (server_settings[option]
 
2917
                                       .decode("utf-8"))
2403
2918
    # Force all boolean options to be boolean
2404
2919
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2405
 
                   "foreground"):
 
2920
                   "foreground", "zeroconf"):
2406
2921
        server_settings[option] = bool(server_settings[option])
2407
2922
    # Debug implies foreground
2408
2923
    if server_settings["debug"]:
2409
2924
        server_settings["foreground"] = True
2410
2925
    # Now we have our good server settings in "server_settings"
2411
 
    
 
2926
 
2412
2927
    ##################################################################
2413
 
    
 
2928
 
 
2929
    if (not server_settings["zeroconf"]
 
2930
        and not (server_settings["port"]
 
2931
                 or server_settings["socket"] != "")):
 
2932
        parser.error("Needs port or socket to work without Zeroconf")
 
2933
 
2414
2934
    # For convenience
2415
2935
    debug = server_settings["debug"]
2416
2936
    debuglevel = server_settings["debuglevel"]
2419
2939
    stored_state_path = os.path.join(server_settings["statedir"],
2420
2940
                                     stored_state_file)
2421
2941
    foreground = server_settings["foreground"]
2422
 
    
 
2942
    zeroconf = server_settings["zeroconf"]
 
2943
 
2423
2944
    if debug:
2424
2945
        initlogger(debug, logging.DEBUG)
2425
2946
    else:
2428
2949
        else:
2429
2950
            level = getattr(logging, debuglevel.upper())
2430
2951
            initlogger(debug, level)
2431
 
    
 
2952
 
2432
2953
    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
 
    
 
2954
        syslogger.setFormatter(
 
2955
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2956
                              ' %(levelname)s: %(message)s'.format(
 
2957
                                  server_settings["servicename"])))
 
2958
 
2439
2959
    # Parse config file with clients
2440
2960
    client_config = configparser.SafeConfigParser(Client
2441
2961
                                                  .client_defaults)
2442
2962
    client_config.read(os.path.join(server_settings["configdir"],
2443
2963
                                    "clients.conf"))
2444
 
    
 
2964
 
2445
2965
    global mandos_dbus_service
2446
2966
    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))
 
2967
 
 
2968
    socketfd = None
 
2969
    if server_settings["socket"] != "":
 
2970
        socketfd = server_settings["socket"]
 
2971
    tcp_server = MandosServer(
 
2972
        (server_settings["address"], server_settings["port"]),
 
2973
        ClientHandler,
 
2974
        interface=(server_settings["interface"] or None),
 
2975
        use_ipv6=use_ipv6,
 
2976
        gnutls_priority=server_settings["priority"],
 
2977
        use_dbus=use_dbus,
 
2978
        socketfd=socketfd)
2459
2979
    if not foreground:
2460
2980
        pidfilename = "/run/mandos.pid"
2461
2981
        if not os.path.isdir("/run/."):
2462
2982
            pidfilename = "/var/run/mandos.pid"
2463
2983
        pidfile = None
2464
2984
        try:
2465
 
            pidfile = open(pidfilename, "w")
 
2985
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2466
2986
        except IOError as e:
2467
2987
            logger.error("Could not open file %r", pidfilename,
2468
2988
                         exc_info=e)
2469
 
    
2470
 
    for name in ("_mandos", "mandos", "nobody"):
 
2989
 
 
2990
    for name, group in (("_mandos", "_mandos"),
 
2991
                        ("mandos", "mandos"),
 
2992
                        ("nobody", "nogroup")):
2471
2993
        try:
2472
2994
            uid = pwd.getpwnam(name).pw_uid
2473
 
            gid = pwd.getpwnam(name).pw_gid
 
2995
            gid = pwd.getpwnam(group).pw_gid
2474
2996
            break
2475
2997
        except KeyError:
2476
2998
            continue
2480
3002
    try:
2481
3003
        os.setgid(gid)
2482
3004
        os.setuid(uid)
 
3005
        if debug:
 
3006
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3007
                                                             gid))
2483
3008
    except OSError as error:
 
3009
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3010
                       .format(uid, gid, os.strerror(error.errno)))
2484
3011
        if error.errno != errno.EPERM:
2485
3012
            raise
2486
 
    
 
3013
 
2487
3014
    if debug:
2488
3015
        # Enable all possible GnuTLS debugging
2489
 
        
 
3016
 
2490
3017
        # "Use a log level over 10 to enable all debugging options."
2491
3018
        # - GnuTLS manual
2492
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
2493
 
        
2494
 
        @gnutls.library.types.gnutls_log_func
 
3019
        gnutls.global_set_log_level(11)
 
3020
 
 
3021
        @gnutls.log_func
2495
3022
        def debug_gnutls(level, string):
2496
3023
            logger.debug("GnuTLS: %s", string[:-1])
2497
 
        
2498
 
        (gnutls.library.functions
2499
 
         .gnutls_global_set_log_function(debug_gnutls))
2500
 
        
 
3024
 
 
3025
        gnutls.global_set_log_function(debug_gnutls)
 
3026
 
2501
3027
        # Redirect stdin so all checkers get /dev/null
2502
3028
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2503
3029
        os.dup2(null, sys.stdin.fileno())
2504
3030
        if null > 2:
2505
3031
            os.close(null)
2506
 
    
 
3032
 
2507
3033
    # Need to fork before connecting to D-Bus
2508
3034
    if not foreground:
2509
3035
        # Close all input and output, do double fork, etc.
2510
3036
        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
 
    
 
3037
 
 
3038
    # multiprocessing will use threads, so before we use GLib we need
 
3039
    # to inform GLib that threads will be used.
 
3040
    GLib.threads_init()
 
3041
 
2516
3042
    global main_loop
2517
3043
    # From the Avahi example code
2518
3044
    DBusGMainLoop(set_as_default=True)
2519
 
    main_loop = gobject.MainLoop()
 
3045
    main_loop = GLib.MainLoop()
2520
3046
    bus = dbus.SystemBus()
2521
3047
    # End of Avahi example code
2522
3048
    if use_dbus:
2523
3049
        try:
2524
3050
            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:
 
3051
                                            bus,
 
3052
                                            do_not_queue=True)
 
3053
            old_bus_name = dbus.service.BusName(
 
3054
                "se.bsnet.fukt.Mandos", bus,
 
3055
                do_not_queue=True)
 
3056
        except dbus.exceptions.DBusException as e:
2530
3057
            logger.error("Disabling D-Bus:", exc_info=e)
2531
3058
            use_dbus = False
2532
3059
            server_settings["use_dbus"] = False
2533
3060
            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
 
    
 
3061
    if zeroconf:
 
3062
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
3063
        service = AvahiServiceToSyslog(
 
3064
            name=server_settings["servicename"],
 
3065
            servicetype="_mandos._tcp",
 
3066
            protocol=protocol,
 
3067
            bus=bus)
 
3068
        if server_settings["interface"]:
 
3069
            service.interface = if_nametoindex(
 
3070
                server_settings["interface"].encode("utf-8"))
 
3071
 
2543
3072
    global multiprocessing_manager
2544
3073
    multiprocessing_manager = multiprocessing.Manager()
2545
 
    
 
3074
 
2546
3075
    client_class = Client
2547
3076
    if use_dbus:
2548
 
        client_class = functools.partial(ClientDBus, bus = bus)
2549
 
    
 
3077
        client_class = functools.partial(ClientDBus, bus=bus)
 
3078
 
2550
3079
    client_settings = Client.config_parser(client_config)
2551
3080
    old_client_settings = {}
2552
3081
    clients_data = {}
2553
 
    
 
3082
 
2554
3083
    # This is used to redirect stdout and stderr for checker processes
2555
3084
    global wnull
2556
 
    wnull = open(os.devnull, "w") # A writable /dev/null
 
3085
    wnull = open(os.devnull, "w")  # A writable /dev/null
2557
3086
    # Only used if server is running in foreground but not in debug
2558
3087
    # mode
2559
3088
    if debug or not foreground:
2560
3089
        wnull.close()
2561
 
    
 
3090
 
2562
3091
    # Get client data and settings from last running state.
2563
3092
    if server_settings["restore"]:
2564
3093
        try:
2565
3094
            with open(stored_state_path, "rb") as stored_state:
2566
 
                clients_data, old_client_settings = (pickle.load
2567
 
                                                     (stored_state))
 
3095
                if sys.version_info.major == 2:
 
3096
                    clients_data, old_client_settings = pickle.load(
 
3097
                        stored_state)
 
3098
                else:
 
3099
                    bytes_clients_data, bytes_old_client_settings = (
 
3100
                        pickle.load(stored_state, encoding="bytes"))
 
3101
                    #   Fix bytes to strings
 
3102
                    #  clients_data
 
3103
                    # .keys()
 
3104
                    clients_data = {(key.decode("utf-8")
 
3105
                                     if isinstance(key, bytes)
 
3106
                                     else key): value
 
3107
                                    for key, value in
 
3108
                                    bytes_clients_data.items()}
 
3109
                    del bytes_clients_data
 
3110
                    for key in clients_data:
 
3111
                        value = {(k.decode("utf-8")
 
3112
                                  if isinstance(k, bytes) else k): v
 
3113
                                 for k, v in
 
3114
                                 clients_data[key].items()}
 
3115
                        clients_data[key] = value
 
3116
                        # .client_structure
 
3117
                        value["client_structure"] = [
 
3118
                            (s.decode("utf-8")
 
3119
                             if isinstance(s, bytes)
 
3120
                             else s) for s in
 
3121
                            value["client_structure"]]
 
3122
                        # .name & .host
 
3123
                        for k in ("name", "host"):
 
3124
                            if isinstance(value[k], bytes):
 
3125
                                value[k] = value[k].decode("utf-8")
 
3126
                    #  old_client_settings
 
3127
                    # .keys()
 
3128
                    old_client_settings = {
 
3129
                        (key.decode("utf-8")
 
3130
                         if isinstance(key, bytes)
 
3131
                         else key): value
 
3132
                        for key, value in
 
3133
                        bytes_old_client_settings.items()}
 
3134
                    del bytes_old_client_settings
 
3135
                    # .host
 
3136
                    for value in old_client_settings.values():
 
3137
                        if isinstance(value["host"], bytes):
 
3138
                            value["host"] = (value["host"]
 
3139
                                             .decode("utf-8"))
2568
3140
            os.remove(stored_state_path)
2569
3141
        except IOError as e:
2570
3142
            if e.errno == errno.ENOENT:
2571
 
                logger.warning("Could not load persistent state: {0}"
2572
 
                                .format(os.strerror(e.errno)))
 
3143
                logger.warning("Could not load persistent state:"
 
3144
                               " {}".format(os.strerror(e.errno)))
2573
3145
            else:
2574
3146
                logger.critical("Could not load persistent state:",
2575
3147
                                exc_info=e)
2576
3148
                raise
2577
3149
        except EOFError as e:
2578
3150
            logger.warning("Could not load persistent state: "
2579
 
                           "EOFError:", exc_info=e)
2580
 
    
 
3151
                           "EOFError:",
 
3152
                           exc_info=e)
 
3153
 
2581
3154
    with PGPEngine() as pgp:
2582
 
        for client_name, client in clients_data.iteritems():
 
3155
        for client_name, client in clients_data.items():
2583
3156
            # Skip removed clients
2584
3157
            if client_name not in client_settings:
2585
3158
                continue
2586
 
            
 
3159
 
2587
3160
            # Decide which value to use after restoring saved state.
2588
3161
            # We have three different values: Old config file,
2589
3162
            # new config file, and saved state.
2594
3167
                    # For each value in new config, check if it
2595
3168
                    # differs from the old config value (Except for
2596
3169
                    # the "secret" attribute)
2597
 
                    if (name != "secret" and
2598
 
                        value != old_client_settings[client_name]
2599
 
                        [name]):
 
3170
                    if (name != "secret"
 
3171
                        and (value !=
 
3172
                             old_client_settings[client_name][name])):
2600
3173
                        client[name] = value
2601
3174
                except KeyError:
2602
3175
                    pass
2603
 
            
 
3176
 
2604
3177
            # Clients who has passed its expire date can still be
2605
 
            # enabled if its last checker was successful.  Clients
 
3178
            # enabled if its last checker was successful.  A Client
2606
3179
            # whose checker succeeded before we stored its state is
2607
3180
            # assumed to have successfully run all checkers during
2608
3181
            # downtime.
2610
3183
                if datetime.datetime.utcnow() >= client["expires"]:
2611
3184
                    if not client["last_checked_ok"]:
2612
3185
                        logger.warning(
2613
 
                            "disabling client {0} - Client never "
2614
 
                            "performed a successful checker"
2615
 
                            .format(client_name))
 
3186
                            "disabling client {} - Client never "
 
3187
                            "performed a successful checker".format(
 
3188
                                client_name))
2616
3189
                        client["enabled"] = False
2617
3190
                    elif client["last_checker_status"] != 0:
2618
3191
                        logger.warning(
2619
 
                            "disabling client {0} - Client "
2620
 
                            "last checker failed with error code {1}"
2621
 
                            .format(client_name,
2622
 
                                    client["last_checker_status"]))
 
3192
                            "disabling client {} - Client last"
 
3193
                            " checker failed with error code"
 
3194
                            " {}".format(
 
3195
                                client_name,
 
3196
                                client["last_checker_status"]))
2623
3197
                        client["enabled"] = False
2624
3198
                    else:
2625
 
                        client["expires"] = (datetime.datetime
2626
 
                                             .utcnow()
2627
 
                                             + client["timeout"])
 
3199
                        client["expires"] = (
 
3200
                            datetime.datetime.utcnow()
 
3201
                            + client["timeout"])
2628
3202
                        logger.debug("Last checker succeeded,"
2629
 
                                     " keeping {0} enabled"
2630
 
                                     .format(client_name))
 
3203
                                     " keeping {} enabled".format(
 
3204
                                         client_name))
2631
3205
            try:
2632
 
                client["secret"] = (
2633
 
                    pgp.decrypt(client["encrypted_secret"],
2634
 
                                client_settings[client_name]
2635
 
                                ["secret"]))
 
3206
                client["secret"] = pgp.decrypt(
 
3207
                    client["encrypted_secret"],
 
3208
                    client_settings[client_name]["secret"])
2636
3209
            except PGPError:
2637
3210
                # 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
 
    
 
3211
                logger.debug("Failed to decrypt {} old secret".format(
 
3212
                    client_name))
 
3213
                client["secret"] = (client_settings[client_name]
 
3214
                                    ["secret"])
 
3215
 
2643
3216
    # Add/remove clients based on new changes made to config
2644
3217
    for client_name in (set(old_client_settings)
2645
3218
                        - set(client_settings)):
2647
3220
    for client_name in (set(client_settings)
2648
3221
                        - set(old_client_settings)):
2649
3222
        clients_data[client_name] = client_settings[client_name]
2650
 
    
 
3223
 
2651
3224
    # Create all client objects
2652
 
    for client_name, client in clients_data.iteritems():
 
3225
    for client_name, client in clients_data.items():
2653
3226
        tcp_server.clients[client_name] = client_class(
2654
 
            name = client_name, settings = client,
2655
 
            server_settings = server_settings)
2656
 
    
 
3227
            name=client_name,
 
3228
            settings=client,
 
3229
            server_settings=server_settings)
 
3230
 
2657
3231
    if not tcp_server.clients:
2658
3232
        logger.warning("No clients defined")
2659
 
    
 
3233
 
2660
3234
    if not foreground:
2661
3235
        if pidfile is not None:
 
3236
            pid = os.getpid()
2662
3237
            try:
2663
3238
                with pidfile:
2664
 
                    pid = os.getpid()
2665
 
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
3239
                    print(pid, file=pidfile)
2666
3240
            except IOError:
2667
3241
                logger.error("Could not write to file %r with PID %d",
2668
3242
                             pidfilename, pid)
2669
3243
        del pidfile
2670
3244
        del pidfilename
2671
 
    
2672
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2673
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2674
 
    
 
3245
 
 
3246
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3247
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3248
                             lambda: main_loop.quit() and False)
 
3249
 
2675
3250
    if use_dbus:
2676
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2677
 
                                        "se.bsnet.fukt.Mandos"})
2678
 
        class MandosDBusService(DBusObjectWithProperties):
 
3251
 
 
3252
        @alternate_dbus_interfaces(
 
3253
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3254
        class MandosDBusService(DBusObjectWithObjectManager):
2679
3255
            """A D-Bus proxy object"""
 
3256
 
2680
3257
            def __init__(self):
2681
3258
                dbus.service.Object.__init__(self, bus, "/")
 
3259
 
2682
3260
            _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
 
            
 
3261
 
2690
3262
            @dbus.service.signal(_interface, signature="o")
2691
3263
            def ClientAdded(self, objpath):
2692
3264
                "D-Bus signal"
2693
3265
                pass
2694
 
            
 
3266
 
2695
3267
            @dbus.service.signal(_interface, signature="ss")
2696
3268
            def ClientNotFound(self, fingerprint, address):
2697
3269
                "D-Bus signal"
2698
3270
                pass
2699
 
            
 
3271
 
 
3272
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3273
                               "true"})
2700
3274
            @dbus.service.signal(_interface, signature="os")
2701
3275
            def ClientRemoved(self, objpath, name):
2702
3276
                "D-Bus signal"
2703
3277
                pass
2704
 
            
 
3278
 
 
3279
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3280
                               "true"})
2705
3281
            @dbus.service.method(_interface, out_signature="ao")
2706
3282
            def GetAllClients(self):
2707
3283
                "D-Bus method"
2708
 
                return dbus.Array(c.dbus_object_path
2709
 
                                  for c in
2710
 
                                  tcp_server.clients.itervalues())
2711
 
            
 
3284
                return dbus.Array(c.dbus_object_path for c in
 
3285
                                  tcp_server.clients.values())
 
3286
 
 
3287
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3288
                               "true"})
2712
3289
            @dbus.service.method(_interface,
2713
3290
                                 out_signature="a{oa{sv}}")
2714
3291
            def GetAllClientsWithProperties(self):
2715
3292
                "D-Bus method"
2716
3293
                return dbus.Dictionary(
2717
 
                    ((c.dbus_object_path, c.GetAll(""))
2718
 
                     for c in tcp_server.clients.itervalues()),
 
3294
                    {c.dbus_object_path: c.GetAll(
 
3295
                        "se.recompile.Mandos.Client")
 
3296
                     for c in tcp_server.clients.values()},
2719
3297
                    signature="oa{sv}")
2720
 
            
 
3298
 
2721
3299
            @dbus.service.method(_interface, in_signature="o")
2722
3300
            def RemoveClient(self, object_path):
2723
3301
                "D-Bus method"
2724
 
                for c in tcp_server.clients.itervalues():
 
3302
                for c in tcp_server.clients.values():
2725
3303
                    if c.dbus_object_path == object_path:
2726
3304
                        del tcp_server.clients[c.name]
2727
3305
                        c.remove_from_connection()
2728
 
                        # Don't signal anything except ClientRemoved
 
3306
                        # Don't signal the disabling
2729
3307
                        c.disable(quiet=True)
2730
 
                        # Emit D-Bus signal
2731
 
                        self.ClientRemoved(object_path, c.name)
 
3308
                        # Emit D-Bus signal for removal
 
3309
                        self.client_removed_signal(c)
2732
3310
                        return
2733
3311
                raise KeyError(object_path)
2734
 
            
 
3312
 
2735
3313
            del _interface
2736
 
        
 
3314
 
 
3315
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3316
                                 out_signature="a{oa{sa{sv}}}")
 
3317
            def GetManagedObjects(self):
 
3318
                """D-Bus method"""
 
3319
                return dbus.Dictionary(
 
3320
                    {client.dbus_object_path:
 
3321
                     dbus.Dictionary(
 
3322
                         {interface: client.GetAll(interface)
 
3323
                          for interface in
 
3324
                          client._get_all_interface_names()})
 
3325
                     for client in tcp_server.clients.values()})
 
3326
 
 
3327
            def client_added_signal(self, client):
 
3328
                """Send the new standard signal and the old signal"""
 
3329
                if use_dbus:
 
3330
                    # New standard signal
 
3331
                    self.InterfacesAdded(
 
3332
                        client.dbus_object_path,
 
3333
                        dbus.Dictionary(
 
3334
                            {interface: client.GetAll(interface)
 
3335
                             for interface in
 
3336
                             client._get_all_interface_names()}))
 
3337
                    # Old signal
 
3338
                    self.ClientAdded(client.dbus_object_path)
 
3339
 
 
3340
            def client_removed_signal(self, client):
 
3341
                """Send the new standard signal and the old signal"""
 
3342
                if use_dbus:
 
3343
                    # New standard signal
 
3344
                    self.InterfacesRemoved(
 
3345
                        client.dbus_object_path,
 
3346
                        client._get_all_interface_names())
 
3347
                    # Old signal
 
3348
                    self.ClientRemoved(client.dbus_object_path,
 
3349
                                       client.name)
 
3350
 
2737
3351
        mandos_dbus_service = MandosDBusService()
2738
 
    
 
3352
 
 
3353
    # Save modules to variables to exempt the modules from being
 
3354
    # unloaded before the function registered with atexit() is run.
 
3355
    mp = multiprocessing
 
3356
    wn = wnull
 
3357
 
2739
3358
    def cleanup():
2740
3359
        "Cleanup function; run on exit"
2741
 
        service.cleanup()
2742
 
        
2743
 
        multiprocessing.active_children()
2744
 
        wnull.close()
 
3360
        if zeroconf:
 
3361
            service.cleanup()
 
3362
 
 
3363
        mp.active_children()
 
3364
        wn.close()
2745
3365
        if not (tcp_server.clients or client_settings):
2746
3366
            return
2747
 
        
 
3367
 
2748
3368
        # Store client before exiting. Secrets are encrypted with key
2749
3369
        # based on what config file has. If config file is
2750
3370
        # removed/edited, old secret will thus be unrecovable.
2751
3371
        clients = {}
2752
3372
        with PGPEngine() as pgp:
2753
 
            for client in tcp_server.clients.itervalues():
 
3373
            for client in tcp_server.clients.values():
2754
3374
                key = client_settings[client.name]["secret"]
2755
3375
                client.encrypted_secret = pgp.encrypt(client.secret,
2756
3376
                                                      key)
2757
3377
                client_dict = {}
2758
 
                
 
3378
 
2759
3379
                # A list of attributes that can not be pickled
2760
3380
                # + secret.
2761
 
                exclude = set(("bus", "changedstate", "secret",
2762
 
                               "checker", "server_settings"))
2763
 
                for name, typ in (inspect.getmembers
2764
 
                                  (dbus.service.Object)):
 
3381
                exclude = {"bus", "changedstate", "secret",
 
3382
                           "checker", "server_settings"}
 
3383
                for name, typ in inspect.getmembers(dbus.service
 
3384
                                                    .Object):
2765
3385
                    exclude.add(name)
2766
 
                
 
3386
 
2767
3387
                client_dict["encrypted_secret"] = (client
2768
3388
                                                   .encrypted_secret)
2769
3389
                for attr in client.client_structure:
2770
3390
                    if attr not in exclude:
2771
3391
                        client_dict[attr] = getattr(client, attr)
2772
 
                
 
3392
 
2773
3393
                clients[client.name] = client_dict
2774
3394
                del client_settings[client.name]["secret"]
2775
 
        
 
3395
 
2776
3396
        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
 
3397
            with tempfile.NamedTemporaryFile(
 
3398
                    mode='wb',
 
3399
                    suffix=".pickle",
 
3400
                    prefix='clients-',
 
3401
                    dir=os.path.dirname(stored_state_path),
 
3402
                    delete=False) as stored_state:
 
3403
                pickle.dump((clients, client_settings), stored_state,
 
3404
                            protocol=2)
 
3405
                tempname = stored_state.name
2783
3406
            os.rename(tempname, stored_state_path)
2784
3407
        except (IOError, OSError) as e:
2785
3408
            if not debug:
2788
3411
                except NameError:
2789
3412
                    pass
2790
3413
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2791
 
                logger.warning("Could not save persistent state: {0}"
 
3414
                logger.warning("Could not save persistent state: {}"
2792
3415
                               .format(os.strerror(e.errno)))
2793
3416
            else:
2794
3417
                logger.warning("Could not save persistent state:",
2795
3418
                               exc_info=e)
2796
3419
                raise
2797
 
        
 
3420
 
2798
3421
        # Delete all clients, and settings from config
2799
3422
        while tcp_server.clients:
2800
3423
            name, client = tcp_server.clients.popitem()
2801
3424
            if use_dbus:
2802
3425
                client.remove_from_connection()
2803
 
            # Don't signal anything except ClientRemoved
 
3426
            # Don't signal the disabling
2804
3427
            client.disable(quiet=True)
 
3428
            # Emit D-Bus signal for removal
2805
3429
            if use_dbus:
2806
 
                # Emit D-Bus signal
2807
 
                mandos_dbus_service.ClientRemoved(client
2808
 
                                                  .dbus_object_path,
2809
 
                                                  client.name)
 
3430
                mandos_dbus_service.client_removed_signal(client)
2810
3431
        client_settings.clear()
2811
 
    
 
3432
 
2812
3433
    atexit.register(cleanup)
2813
 
    
2814
 
    for client in tcp_server.clients.itervalues():
 
3434
 
 
3435
    for client in tcp_server.clients.values():
2815
3436
        if use_dbus:
2816
 
            # Emit D-Bus signal
2817
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3437
            # Emit D-Bus signal for adding
 
3438
            mandos_dbus_service.client_added_signal(client)
2818
3439
        # Need to initiate checking of clients
2819
3440
        if client.enabled:
2820
3441
            client.init_checker()
2821
 
    
 
3442
 
2822
3443
    tcp_server.enable()
2823
3444
    tcp_server.server_activate()
2824
 
    
 
3445
 
2825
3446
    # Find out what port we got
2826
 
    service.port = tcp_server.socket.getsockname()[1]
 
3447
    if zeroconf:
 
3448
        service.port = tcp_server.socket.getsockname()[1]
2827
3449
    if use_ipv6:
2828
3450
        logger.info("Now listening on address %r, port %d,"
2829
3451
                    " flowinfo %d, scope_id %d",
2831
3453
    else:                       # IPv4
2832
3454
        logger.info("Now listening on address %r, port %d",
2833
3455
                    *tcp_server.socket.getsockname())
2834
 
    
2835
 
    #service.interface = tcp_server.socket.getsockname()[3]
2836
 
    
 
3456
 
 
3457
    # service.interface = tcp_server.socket.getsockname()[3]
 
3458
 
2837
3459
    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
 
        
 
3460
        if zeroconf:
 
3461
            # From the Avahi example code
 
3462
            try:
 
3463
                service.activate()
 
3464
            except dbus.exceptions.DBusException as error:
 
3465
                logger.critical("D-Bus Exception", exc_info=error)
 
3466
                cleanup()
 
3467
                sys.exit(1)
 
3468
            # End of Avahi example code
 
3469
 
 
3470
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3471
                          lambda *args, **kwargs:
 
3472
                          (tcp_server.handle_request
 
3473
                           (*args[2:], **kwargs) or True))
 
3474
 
2852
3475
        logger.debug("Starting main loop")
2853
3476
        main_loop.run()
2854
3477
    except AvahiError as error:
2863
3486
    # Must run before the D-Bus bus name gets deregistered
2864
3487
    cleanup()
2865
3488
 
 
3489
 
2866
3490
if __name__ == '__main__':
2867
3491
    main()