/mandos/release

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