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