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