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