/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2013-12-31 16:02:18 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 307.
  • Revision ID: teddy@recompile.se-20131231160218-plmmb0o0iifkd5l2
Specify BusName in systemd service file.

* mandos.service (BusName): Uncommented.

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