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