/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

* Makefile (DOCBOOKTOMAN): Also check manual pages for warnings.
* debian/control (Build-Depends): Added "man".

Show diffs side-by-side

added added

removed removed

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