/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-06 20:03:50 UTC
  • Revision ID: teddy@recompile.se-20180206200350-jzvorueb731xkph3
Update Debian Debhelper compatibility version.

* (debian/compat): Change to "10".

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