/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: 2023-02-07 23:03:33 UTC
  • mto: This revision was merged to the branch mainline in revision 408.
  • Revision ID: teddy@recompile.se-20230207230333-5halrp7943pgb3w1
Server: Bug fix: Stagger checker runs when creating clients

* mandos (Client.enable()): Do not set self.expires here; move it to
  "init_checker".
  (Client.init_checker()): Take new "randomize_start" argument.  If
  True, randomize delay before starting checker.  Also, do not start
  checker right now, but instead extend expire time so that the
  scheduled checker always has time to run.
  (Checker.start_checker): Take new "start_was_randomized" argument.
  If True, reset scheduled checker runs to be 'interval' apart,
  instead of using the initial delay.  (Bug fix)
  (main): On startup, pass argument randomize_start=True to
  client.init_checker() when initizlizing checkers for all enabled
  clients.

Reported-by: Louis Charreau <Louis.Charreau@vadesecure.com>
Suggested-by: Louis Charreau <Louis.Charreau@vadesecure.com>
Fixes: 1200 ("Server: Stagger checker runs when creating clients")

Show diffs side-by-side

added added

removed removed

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