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