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