/mandos/trunk

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