/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-03-01 09:39:25 UTC
  • Revision ID: teddy@recompile.se-20140301093925-0x6nwf21f0zljk6e
* debian/copyright: Change year to "2014".
* mandos-ctl: - '' -
* mandos-monitor: - '' -
* plugins.d/mandos-client.xml: - '' -

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