/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2018-02-22 09:20:19 UTC
  • Revision ID: teddy@recompile.se-20180222092019-ehyz79hzti9dnk2g
Client bug fix: Don't use leak sanitizer with leaking libraries

* Makefile (plugin-helpers/mandos-client): Remove "-fsanitize=leak"
  from CFLAGS.

Show diffs side-by-side

added added

removed removed

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