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