/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-10-05 20:13:01 UTC
  • Revision ID: teddy@recompile.se-20161005201301-3ibock2agjb2ppe6
Tags: version-1.7.12-1
* Makefile (version): Change to 1.7.12.
* NEWS (Version 1.7.12): Add new entry.
* debian/changelog (1.7.12-1): - '' -

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