/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2020-07-04 11:58:52 UTC
  • Revision ID: teddy@recompile.se-20200704115852-oquhnmng3zom4ldl
Update copyright year

* DBUS-API: Update copyright year to 2020
* debian/copyright: - '' -
* dracut-module/ask-password-mandos.service: - '' -
* dracut-module/password-agent.c: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* plugin-runner.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/plymouth.c: - '' -
* mandos-to-cryptroot-unlock: Update copyright year to 2019.

Show diffs side-by-side

added added

removed removed

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