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