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