/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

Change "fukt.bsnet.se" to "recompile.se" throughout.

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