/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: 2016-10-29 14:22:26 UTC
  • Revision ID: teddy@recompile.se-20161029142226-n4s9d70tuk615pg1
Makefile: Clarify message when running client.

* Makefile (run-client): Clarify message.

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