/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

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

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

Show diffs side-by-side

added added

removed removed

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