/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2018-02-08 10:23:55 UTC
  • Revision ID: teddy@recompile.se-20180208102355-3ent7sf87i9h9kka
Update copyright year to 2018

* DBUS-API: Update copyright year to 2018.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* intro.xml: - '' -
* mandos: - '' -
* mandos-clients.conf.xml: - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml: - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml: - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* network-hooks.d/bridge: - '' -
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml: - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml: - '' -

Show diffs side-by-side

added added

removed removed

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