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