/mandos/trunk

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