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