/mandos/trunk

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