/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-06-07 21:59:20 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 317.
  • Revision ID: teddy@recompile.se-20140607215920-r4qkj7ktnjyqmrn5
Make mandos-client use fexecve().

* plugins.d/mandos-client.d (run_network_hooks): Use fexecve().

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