/mandos/release

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