/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: 2022-04-23 23:58:39 UTC
  • Revision ID: teddy@recompile.se-20220423235839-cnt9aq1kjveqaydc
Bug fix in mandos-ctl: handle backslashes in password

* mandos-ctl (mode=password): When sending the password to gpg, use
  "printf" instead of "echo -n".  This avoids the behavior of the
  "echo" builtin in "dash", which always interprets backslash escape
  codes.

Reported-By: Jesse Norell <jesse@kci.net>

Show diffs side-by-side

added added

removed removed

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