/mandos/trunk

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