/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-02-16 02:42:42 UTC
  • Revision ID: teddy@recompile.se-20140216024242-9wiw1nkxgt7ohovj
Fix running of self-tests.

* debian/control (Build-Depends): Add Python dependencies to
                                  successfully run self-tests.
* debian/copyright: GPLv3 now has its own license file - use it.
* debian/watch: Set PGP signature URL.
* mandos (main): Bug fix: When running self-tests, set exit code.
* mandos-ctl (main): Cosmetic fix; use os.EX_OK instead of plain 0.

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