/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2024-09-12 18:31:12 UTC
  • mfrom: (237.4.142 release)
  • Revision ID: teddy@recompile.se-20240912183112-xxy0akg67c0ky0t8
Merge from release branch

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