/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

* initramfs-tools-hook: Set DEVICE for network hooks.

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.12"
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.1"
 
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
 
466
        self.last_checked_ok = datetime.datetime.utcnow()
1111
467
        if self.disable_initiator_tag is not None:
1112
 
            GLib.source_remove(self.disable_initiator_tag)
1113
 
            self.disable_initiator_tag = None
 
468
            gobject.source_remove(self.disable_initiator_tag)
1114
469
        if getattr(self, "enabled", False):
1115
 
            self.disable_initiator_tag = GLib.timeout_add(
1116
 
                int(timeout.total_seconds() * 1000), self.disable)
 
470
            self.disable_initiator_tag = (gobject.timeout_add
 
471
                                          (_timedelta_to_milliseconds
 
472
                                           (timeout), self.disable))
1117
473
            self.expires = datetime.datetime.utcnow() + timeout
1118
 
 
 
474
    
1119
475
    def need_approval(self):
1120
476
        self.last_approval_request = datetime.datetime.utcnow()
1121
 
 
 
477
    
1122
478
    def start_checker(self):
1123
479
        """Start a new checker subprocess if one is not running.
1124
 
 
 
480
        
1125
481
        If a checker already exists, leave it running and do
1126
482
        nothing."""
1127
483
        # 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
 
484
        # did that, then if a checker (for some reason) started
 
485
        # running slowly and taking more than 'interval' time, the
 
486
        # client would inevitably timeout, since no checker would get
 
487
        # a chance to run to completion.  If we instead leave running
1132
488
        # checkers alone, the checker would have to take more time
1133
489
        # than 'timeout' for the client to be disabled, which is as it
1134
490
        # 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
 
491
        
 
492
        # If a checker exists, make sure it is not a zombie
 
493
        try:
 
494
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
495
        except (AttributeError, OSError) as error:
 
496
            if (isinstance(error, OSError)
 
497
                and error.errno != errno.ECHILD):
 
498
                raise error
 
499
        else:
 
500
            if pid:
 
501
                logger.warning("Checker was a zombie")
 
502
                gobject.source_remove(self.checker_callback_tag)
 
503
                self.checker_callback(pid, status,
 
504
                                      self.current_checker_command)
1140
505
        # Start a new checker if needed
1141
506
        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
507
            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
 
508
                # In case checker_command has exactly one % operator
 
509
                command = self.checker_command % self.host
 
510
            except TypeError:
 
511
                # Escape attributes for the shell
 
512
                escaped_attrs = dict(
 
513
                    (attr,
 
514
                     re.escape(unicode(str(getattr(self, attr, "")),
 
515
                                       errors=
 
516
                                       'replace')))
 
517
                    for attr in
 
518
                    self.runtime_expansions)
 
519
                
 
520
                try:
 
521
                    command = self.checker_command % escaped_attrs
 
522
                except TypeError as error:
 
523
                    logger.error('Could not format string "%s":'
 
524
                                 ' %s', self.checker_command, error)
 
525
                    return True # Try again later
1153
526
            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
 
527
            try:
 
528
                logger.info("Starting checker %r for %s",
 
529
                            command, self.name)
 
530
                # We don't need to redirect stdout and stderr, since
 
531
                # in normal mode, that is already done by daemon(),
 
532
                # and in debug mode we don't want to.  (Stdin is
 
533
                # always replaced by /dev/null.)
 
534
                self.checker = subprocess.Popen(command,
 
535
                                                close_fds=True,
 
536
                                                shell=True, cwd="/")
 
537
                self.checker_callback_tag = (gobject.child_watch_add
 
538
                                             (self.checker.pid,
 
539
                                              self.checker_callback,
 
540
                                              data=command))
 
541
                # The checker may have completed before the gobject
 
542
                # watch was added.  Check for this.
 
543
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
544
                if pid:
 
545
                    gobject.source_remove(self.checker_callback_tag)
 
546
                    self.checker_callback(pid, status, command)
 
547
            except OSError as error:
 
548
                logger.error("Failed to start subprocess: %s",
 
549
                             error)
 
550
        # Re-run this periodically if run by gobject.timeout_add
1181
551
        return True
1182
 
 
 
552
    
1183
553
    def stop_checker(self):
1184
554
        """Force the checker process, if any, to stop."""
1185
555
        if self.checker_callback_tag:
1186
 
            GLib.source_remove(self.checker_callback_tag)
 
556
            gobject.source_remove(self.checker_callback_tag)
1187
557
            self.checker_callback_tag = None
1188
558
        if getattr(self, "checker", None) is None:
1189
559
            return
1190
560
        logger.debug("Stopping checker for %(name)s", vars(self))
1191
 
        self.checker.terminate()
 
561
        try:
 
562
            os.kill(self.checker.pid, signal.SIGTERM)
 
563
            #time.sleep(0.5)
 
564
            #if self.checker.poll() is None:
 
565
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
566
        except OSError as error:
 
567
            if error.errno != errno.ESRCH: # No such process
 
568
                raise
1192
569
        self.checker = None
1193
570
 
1194
571
 
1195
 
def dbus_service_property(dbus_interface,
1196
 
                          signature="v",
1197
 
                          access="readwrite",
1198
 
                          byte_arrays=False):
 
572
def dbus_service_property(dbus_interface, signature="v",
 
573
                          access="readwrite", byte_arrays=False):
1199
574
    """Decorators for marking methods of a DBusObjectWithProperties to
1200
575
    become properties on the D-Bus.
1201
 
 
 
576
    
1202
577
    The decorated method will be called with no arguments by "Get"
1203
578
    and with one argument by "Set".
1204
 
 
 
579
    
1205
580
    The parameters, where they are supported, are the same as
1206
581
    dbus.service.method, except there is only "signature", since the
1207
582
    type from Get() and the type sent to Set() is the same.
1210
585
    # "Set" method, so we fail early here:
1211
586
    if byte_arrays and signature != "ay":
1212
587
        raise ValueError("Byte arrays not supported for non-'ay'"
1213
 
                         " signature {!r}".format(signature))
1214
 
 
 
588
                         " signature %r" % signature)
1215
589
    def decorator(func):
1216
590
        func._dbus_is_property = True
1217
591
        func._dbus_interface = dbus_interface
1220
594
        func._dbus_name = func.__name__
1221
595
        if func._dbus_name.endswith("_dbus_property"):
1222
596
            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
 
 
 
597
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
598
        return func
1269
599
    return decorator
1270
600
 
1271
601
 
1272
602
class DBusPropertyException(dbus.exceptions.DBusException):
1273
603
    """A base class for D-Bus property-related exceptions
1274
604
    """
1275
 
    pass
 
605
    def __unicode__(self):
 
606
        return unicode(str(self))
1276
607
 
1277
608
 
1278
609
class DBusPropertyAccessException(DBusPropertyException):
1287
618
    pass
1288
619
 
1289
620
 
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):
 
621
class DBusObjectWithProperties(dbus.service.Object):
1380
622
    """A D-Bus object with properties.
1381
 
 
 
623
    
1382
624
    Classes inheriting from this can use the dbus_service_property
1383
625
    decorator to expose methods as D-Bus properties.  It exposes the
1384
626
    standard Get(), Set(), and GetAll() methods on the D-Bus.
1385
627
    """
1386
 
 
 
628
    
 
629
    @staticmethod
 
630
    def _is_dbus_property(obj):
 
631
        return getattr(obj, "_dbus_is_property", False)
 
632
    
 
633
    def _get_all_dbus_properties(self):
 
634
        """Returns a generator of (name, attribute) pairs
 
635
        """
 
636
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
637
                for cls in self.__class__.__mro__
 
638
                for name, prop in
 
639
                inspect.getmembers(cls, self._is_dbus_property))
 
640
    
1387
641
    def _get_dbus_property(self, interface_name, property_name):
1388
642
        """Returns a bound method if one exists which is a D-Bus
1389
643
        property with the specified name and interface.
1390
644
        """
1391
 
        for cls in self.__class__.__mro__:
1392
 
            for name, value in inspect.getmembers(
1393
 
                    cls, self._is_dbus_thing("property")):
 
645
        for cls in  self.__class__.__mro__:
 
646
            for name, value in (inspect.getmembers
 
647
                                (cls, self._is_dbus_property)):
1394
648
                if (value._dbus_name == property_name
1395
649
                    and value._dbus_interface == interface_name):
1396
650
                    return value.__get__(self)
1397
 
 
 
651
        
1398
652
        # 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",
 
653
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
654
                                   + interface_name + "."
 
655
                                   + property_name)
 
656
    
 
657
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1413
658
                         out_signature="v")
1414
659
    def Get(self, interface_name, property_name):
1415
660
        """Standard D-Bus property Get() method, see D-Bus standard.
1421
666
        if not hasattr(value, "variant_level"):
1422
667
            return value
1423
668
        return type(value)(value, variant_level=value.variant_level+1)
1424
 
 
 
669
    
1425
670
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1426
671
    def Set(self, interface_name, property_name, value):
1427
672
        """Standard D-Bus property Set() method, see D-Bus standard.
1433
678
            # The byte_arrays option is not supported yet on
1434
679
            # signatures other than "ay".
1435
680
            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))
 
681
                raise ValueError
 
682
            value = dbus.ByteArray(''.join(unichr(byte)
 
683
                                           for byte in value))
1440
684
        prop(value)
1441
 
 
1442
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1443
 
                         in_signature="s",
 
685
    
 
686
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1444
687
                         out_signature="a{sv}")
1445
688
    def GetAll(self, interface_name):
1446
689
        """Standard D-Bus property GetAll() method, see D-Bus
1447
690
        standard.
1448
 
 
 
691
        
1449
692
        Note: Will not include properties with access="write".
1450
693
        """
1451
 
        properties = {}
1452
 
        for name, prop in self._get_all_dbus_things("property"):
 
694
        all = {}
 
695
        for name, prop in self._get_all_dbus_properties():
1453
696
            if (interface_name
1454
697
                and interface_name != prop._dbus_interface):
1455
698
                # Interface non-empty but did not match
1459
702
                continue
1460
703
            value = prop()
1461
704
            if not hasattr(value, "variant_level"):
1462
 
                properties[name] = value
 
705
                all[name] = value
1463
706
                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
 
 
 
707
            all[name] = type(value)(value, variant_level=
 
708
                                    value.variant_level+1)
 
709
        return dbus.Dictionary(all, signature="sv")
 
710
    
1476
711
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1477
712
                         out_signature="s",
1478
713
                         path_keyword='object_path',
1479
714
                         connection_keyword='connection')
1480
715
    def Introspect(self, object_path, connection):
1481
 
        """Overloading of standard D-Bus method.
1482
 
 
1483
 
        Inserts property tags and interface annotation tags.
 
716
        """Standard D-Bus method, overloaded to insert property tags.
1484
717
        """
1485
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1486
 
                                                         object_path,
1487
 
                                                         connection)
 
718
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
719
                                                   connection)
1488
720
        try:
1489
721
            document = xml.dom.minidom.parseString(xmlstring)
1490
 
 
1491
722
            def make_tag(document, name, prop):
1492
723
                e = document.createElement("property")
1493
724
                e.setAttribute("name", name)
1494
725
                e.setAttribute("type", prop._dbus_signature)
1495
726
                e.setAttribute("access", prop._dbus_access)
1496
727
                return e
1497
 
 
1498
728
            for if_tag in document.getElementsByTagName("interface"):
1499
 
                # Add property tags
1500
729
                for tag in (make_tag(document, name, prop)
1501
730
                            for name, prop
1502
 
                            in self._get_all_dbus_things("property")
 
731
                            in self._get_all_dbus_properties()
1503
732
                            if prop._dbus_interface
1504
733
                            == if_tag.getAttribute("name")):
1505
734
                    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
735
                # Add the names to the return values for the
1523
736
                # "org.freedesktop.DBus.Properties" methods
1524
737
                if (if_tag.getAttribute("name")
1539
752
        except (AttributeError, xml.dom.DOMException,
1540
753
                xml.parsers.expat.ExpatError) as error:
1541
754
            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):
 
755
                         error)
 
756
        return xmlstring
 
757
 
 
758
 
 
759
def datetime_to_dbus (dt, variant_level=0):
1618
760
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1619
761
    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).
 
762
        return dbus.String("", variant_level = variant_level)
 
763
    return dbus.String(dt.isoformat(),
 
764
                       variant_level=variant_level)
 
765
 
 
766
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
767
                                  .__metaclass__):
 
768
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
769
    will add additional D-Bus attributes matching a certain pattern.
1646
770
    """
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):
 
771
    def __new__(mcs, name, bases, attr):
 
772
        # Go through all the base classes which could have D-Bus
 
773
        # methods, signals, or properties in them
 
774
        for base in (b for b in bases
 
775
                     if issubclass(b, dbus.service.Object)):
 
776
            # Go though all attributes of the base class
 
777
            for attrname, attribute in inspect.getmembers(base):
1655
778
                # Ignore non-D-Bus attributes, and D-Bus attributes
1656
779
                # with the wrong interface name
1657
780
                if (not hasattr(attribute, "_dbus_interface")
1658
 
                    or not attribute._dbus_interface.startswith(
1659
 
                        orig_interface_name)):
 
781
                    or not attribute._dbus_interface
 
782
                    .startswith("se.recompile.Mandos")):
1660
783
                    continue
1661
784
                # Create an alternate D-Bus interface name based on
1662
785
                # the current name
1663
 
                alt_interface = attribute._dbus_interface.replace(
1664
 
                    orig_interface_name, alt_interface_name)
1665
 
                interface_names.add(alt_interface)
 
786
                alt_interface = (attribute._dbus_interface
 
787
                                 .replace("se.recompile.Mandos",
 
788
                                          "se.bsnet.fukt.Mandos"))
1666
789
                # Is this a D-Bus signal?
1667
790
                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(
 
791
                    # Extract the original non-method function by
 
792
                    # black magic
 
793
                    nonmethod_func = (dict(
1672
794
                            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)
 
795
                                attribute.__closure__))["func"]
 
796
                                      .cell_contents)
1680
797
                    # Create a new, but exactly alike, function
1681
798
                    # object, and decorate it to be a new D-Bus signal
1682
799
                    # 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
 
 
 
800
                    new_function = (dbus.service.signal
 
801
                                    (alt_interface,
 
802
                                     attribute._dbus_signature)
 
803
                                    (types.FunctionType(
 
804
                                nonmethod_func.func_code,
 
805
                                nonmethod_func.func_globals,
 
806
                                nonmethod_func.func_name,
 
807
                                nonmethod_func.func_defaults,
 
808
                                nonmethod_func.func_closure)))
1694
809
                    # 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
 
810
                    # old and new functions, so both the old and new
 
811
                    # signals gets sent when the function is called
1698
812
                    def fixscope(func1, func2):
1699
813
                        """This function is a scope container to pass
1700
814
                        func1 and func2 to the "call_both" function
1701
815
                        outside of its arguments"""
1702
 
 
1703
 
                        @functools.wraps(func2)
1704
816
                        def call_both(*args, **kwargs):
1705
817
                            """This function will emit two D-Bus
1706
818
                            signals by calling func1 and func2"""
1707
819
                            func1(*args, **kwargs)
1708
820
                            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
821
                        return call_both
1716
822
                    # Create the "call_both" function and add it to
1717
823
                    # the class
1718
 
                    attr[attrname] = fixscope(attribute, new_function)
 
824
                    attr[attrname] = fixscope(attribute,
 
825
                                              new_function)
1719
826
                # Is this a D-Bus method?
1720
827
                elif getattr(attribute, "_dbus_is_method", False):
1721
828
                    # Create a new, but exactly alike, function
1722
829
                    # object.  Decorate it to be a new D-Bus method
1723
830
                    # with the alternate D-Bus interface name.  Add it
1724
831
                    # 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
 
832
                    attr[attrname] = (dbus.service.method
 
833
                                      (alt_interface,
 
834
                                       attribute._dbus_in_signature,
 
835
                                       attribute._dbus_out_signature)
 
836
                                      (types.FunctionType
 
837
                                       (attribute.func_code,
 
838
                                        attribute.func_globals,
 
839
                                        attribute.func_name,
 
840
                                        attribute.func_defaults,
 
841
                                        attribute.func_closure)))
1737
842
                # Is this a D-Bus property?
1738
843
                elif getattr(attribute, "_dbus_is_property", False):
1739
844
                    # Create a new, but exactly alike, function
1740
845
                    # object, and decorate it to be a new D-Bus
1741
846
                    # property with the alternate D-Bus interface
1742
847
                    # 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"})
 
848
                    attr[attrname] = (dbus_service_property
 
849
                                      (alt_interface,
 
850
                                       attribute._dbus_signature,
 
851
                                       attribute._dbus_access,
 
852
                                       attribute
 
853
                                       ._dbus_get_args_options
 
854
                                       ["byte_arrays"])
 
855
                                      (types.FunctionType
 
856
                                       (attribute.func_code,
 
857
                                        attribute.func_globals,
 
858
                                        attribute.func_name,
 
859
                                        attribute.func_defaults,
 
860
                                        attribute.func_closure)))
 
861
        return type.__new__(mcs, name, bases, attr)
 
862
 
1795
863
class ClientDBus(Client, DBusObjectWithProperties):
1796
864
    """A Client class using D-Bus
1797
 
 
 
865
    
1798
866
    Attributes:
1799
867
    dbus_object_path: dbus.ObjectPath
1800
868
    bus: dbus.SystemBus()
1801
869
    """
1802
 
 
 
870
    
1803
871
    runtime_expansions = (Client.runtime_expansions
1804
 
                          + ("dbus_object_path", ))
1805
 
 
1806
 
    _interface = "se.recompile.Mandos.Client"
1807
 
 
 
872
                          + ("dbus_object_path",))
 
873
    
1808
874
    # dbus.service.Object doesn't use super(), so we can't either.
1809
 
 
1810
 
    def __init__(self, bus=None, *args, **kwargs):
 
875
    
 
876
    def __init__(self, bus = None, *args, **kwargs):
 
877
        self._approvals_pending = 0
1811
878
        self.bus = bus
1812
879
        Client.__init__(self, *args, **kwargs)
1813
880
        # Only now, when this client is initialized, can it show up on
1814
881
        # the D-Bus
1815
 
        client_object_name = str(self.name).translate(
 
882
        client_object_name = unicode(self.name).translate(
1816
883
            {ord("."): ord("_"),
1817
884
             ord("-"): ord("_")})
1818
 
        self.dbus_object_path = dbus.ObjectPath(
1819
 
            "/clients/" + client_object_name)
 
885
        self.dbus_object_path = (dbus.ObjectPath
 
886
                                 ("/clients/" + client_object_name))
1820
887
        DBusObjectWithProperties.__init__(self, self.bus,
1821
888
                                          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):
 
889
        
 
890
    def notifychangeproperty(transform_func,
 
891
                             dbus_name, type_func=lambda x: x,
 
892
                             variant_level=1):
1828
893
        """ Modify a variable so that it's a property which announces
1829
894
        its changes to DBus.
1830
895
 
1835
900
                   to the D-Bus.  Default: no transform
1836
901
        variant_level: D-Bus variant level.  Default: 1
1837
902
        """
1838
 
        attrname = "_{}".format(dbus_name)
1839
 
 
 
903
        attrname = "_{0}".format(dbus_name)
1840
904
        def setter(self, value):
1841
905
            if hasattr(self, "dbus_object_path"):
1842
906
                if (not hasattr(self, attrname) or
1843
907
                    type_func(getattr(self, attrname, None))
1844
908
                    != 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())
 
909
                    dbus_value = transform_func(type_func(value),
 
910
                                                variant_level
 
911
                                                =variant_level)
 
912
                    self.PropertyChanged(dbus.String(dbus_name),
 
913
                                         dbus_value)
1860
914
            setattr(self, attrname, value)
1861
 
 
 
915
        
1862
916
        return property(lambda self: getattr(self, attrname), setter)
1863
 
 
 
917
    
 
918
    
1864
919
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1865
920
    approvals_pending = notifychangeproperty(dbus.Boolean,
1866
921
                                             "ApprovalPending",
1867
 
                                             type_func=bool)
 
922
                                             type_func = bool)
1868
923
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1869
924
    last_enabled = notifychangeproperty(datetime_to_dbus,
1870
925
                                        "LastEnabled")
1871
 
    checker = notifychangeproperty(
1872
 
        dbus.Boolean, "CheckerRunning",
1873
 
        type_func=lambda checker: checker is not None)
 
926
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
927
                                   type_func = lambda checker:
 
928
                                       checker is not None)
1874
929
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1875
930
                                           "LastCheckedOK")
1876
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1877
 
                                               "LastCheckerStatus")
1878
931
    last_approval_request = notifychangeproperty(
1879
932
        datetime_to_dbus, "LastApprovalRequest")
1880
933
    approved_by_default = notifychangeproperty(dbus.Boolean,
1881
934
                                               "ApprovedByDefault")
1882
 
    approval_delay = notifychangeproperty(
1883
 
        dbus.UInt64, "ApprovalDelay",
1884
 
        type_func=lambda td: td.total_seconds() * 1000)
 
935
    approval_delay = notifychangeproperty(dbus.UInt16,
 
936
                                          "ApprovalDelay",
 
937
                                          type_func =
 
938
                                          _timedelta_to_milliseconds)
1885
939
    approval_duration = notifychangeproperty(
1886
 
        dbus.UInt64, "ApprovalDuration",
1887
 
        type_func=lambda td: td.total_seconds() * 1000)
 
940
        dbus.UInt16, "ApprovalDuration",
 
941
        type_func = _timedelta_to_milliseconds)
1888
942
    host = notifychangeproperty(dbus.String, "Host")
1889
 
    timeout = notifychangeproperty(
1890
 
        dbus.UInt64, "Timeout",
1891
 
        type_func=lambda td: td.total_seconds() * 1000)
 
943
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
 
944
                                   type_func =
 
945
                                   _timedelta_to_milliseconds)
1892
946
    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)
 
947
        dbus.UInt16, "ExtendedTimeout",
 
948
        type_func = _timedelta_to_milliseconds)
 
949
    interval = notifychangeproperty(dbus.UInt16,
 
950
                                    "Interval",
 
951
                                    type_func =
 
952
                                    _timedelta_to_milliseconds)
1898
953
    checker_command = notifychangeproperty(dbus.String, "Checker")
1899
 
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1900
 
                                  invalidate_only=True)
1901
 
 
 
954
    
1902
955
    del notifychangeproperty
1903
 
 
 
956
    
1904
957
    def __del__(self, *args, **kwargs):
1905
958
        try:
1906
959
            self.remove_from_connection()
1909
962
        if hasattr(DBusObjectWithProperties, "__del__"):
1910
963
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1911
964
        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:
 
965
    
 
966
    def checker_callback(self, pid, condition, command,
 
967
                         *args, **kwargs):
 
968
        self.checker_callback_tag = None
 
969
        self.checker = None
 
970
        if os.WIFEXITED(condition):
 
971
            exitstatus = os.WEXITSTATUS(condition)
1920
972
            # Emit D-Bus signal
1921
973
            self.CheckerCompleted(dbus.Int16(exitstatus),
1922
 
                                  # This is specific to GNU libC
1923
 
                                  dbus.Int64(exitstatus << 8),
 
974
                                  dbus.Int64(condition),
1924
975
                                  dbus.String(command))
1925
976
        else:
1926
977
            # Emit D-Bus signal
1927
978
            self.CheckerCompleted(dbus.Int16(-1),
1928
 
                                  dbus.Int64(
1929
 
                                      # This is specific to GNU libC
1930
 
                                      (exitstatus << 8)
1931
 
                                      | self.last_checker_signal),
 
979
                                  dbus.Int64(condition),
1932
980
                                  dbus.String(command))
1933
 
        return ret
1934
 
 
 
981
        
 
982
        return Client.checker_callback(self, pid, condition, command,
 
983
                                       *args, **kwargs)
 
984
    
1935
985
    def start_checker(self, *args, **kwargs):
1936
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
986
        old_checker = self.checker
 
987
        if self.checker is not None:
 
988
            old_checker_pid = self.checker.pid
 
989
        else:
 
990
            old_checker_pid = None
1937
991
        r = Client.start_checker(self, *args, **kwargs)
1938
992
        # Only if new checker process was started
1939
993
        if (self.checker is not None
1941
995
            # Emit D-Bus signal
1942
996
            self.CheckerStarted(self.current_checker_command)
1943
997
        return r
1944
 
 
 
998
    
1945
999
    def _reset_approved(self):
1946
 
        self.approved = None
 
1000
        self._approved = None
1947
1001
        return False
1948
 
 
 
1002
    
1949
1003
    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
1004
        self.send_changedstate()
1954
 
 
1955
 
    #  D-Bus methods, signals & properties
1956
 
 
1957
 
    #  Interfaces
1958
 
 
1959
 
    #  Signals
1960
 
 
 
1005
        self._approved = value
 
1006
        gobject.timeout_add(_timedelta_to_milliseconds
 
1007
                            (self.approval_duration),
 
1008
                            self._reset_approved)
 
1009
    
 
1010
    
 
1011
    ## D-Bus methods, signals & properties
 
1012
    _interface = "se.recompile.Mandos.Client"
 
1013
    
 
1014
    ## Signals
 
1015
    
1961
1016
    # CheckerCompleted - signal
1962
1017
    @dbus.service.signal(_interface, signature="nxs")
1963
1018
    def CheckerCompleted(self, exitcode, waitstatus, command):
1964
1019
        "D-Bus signal"
1965
1020
        pass
1966
 
 
 
1021
    
1967
1022
    # CheckerStarted - signal
1968
1023
    @dbus.service.signal(_interface, signature="s")
1969
1024
    def CheckerStarted(self, command):
1970
1025
        "D-Bus signal"
1971
1026
        pass
1972
 
 
 
1027
    
1973
1028
    # PropertyChanged - signal
1974
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1975
1029
    @dbus.service.signal(_interface, signature="sv")
1976
1030
    def PropertyChanged(self, property, value):
1977
1031
        "D-Bus signal"
1978
1032
        pass
1979
 
 
 
1033
    
1980
1034
    # GotSecret - signal
1981
1035
    @dbus.service.signal(_interface)
1982
1036
    def GotSecret(self):
1985
1039
        server to mandos-client
1986
1040
        """
1987
1041
        pass
1988
 
 
 
1042
    
1989
1043
    # Rejected - signal
1990
1044
    @dbus.service.signal(_interface, signature="s")
1991
1045
    def Rejected(self, reason):
1992
1046
        "D-Bus signal"
1993
1047
        pass
1994
 
 
 
1048
    
1995
1049
    # NeedApproval - signal
1996
1050
    @dbus.service.signal(_interface, signature="tb")
1997
1051
    def NeedApproval(self, timeout, default):
1998
1052
        "D-Bus signal"
1999
1053
        return self.need_approval()
2000
 
 
2001
 
    #  Methods
2002
 
 
 
1054
    
 
1055
    ## Methods
 
1056
    
2003
1057
    # Approve - method
2004
1058
    @dbus.service.method(_interface, in_signature="b")
2005
1059
    def Approve(self, value):
2006
1060
        self.approve(value)
2007
 
 
 
1061
    
2008
1062
    # CheckedOK - method
2009
1063
    @dbus.service.method(_interface)
2010
1064
    def CheckedOK(self):
2011
1065
        self.checked_ok()
2012
 
 
 
1066
    
2013
1067
    # Enable - method
2014
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2015
1068
    @dbus.service.method(_interface)
2016
1069
    def Enable(self):
2017
1070
        "D-Bus method"
2018
1071
        self.enable()
2019
 
 
 
1072
    
2020
1073
    # StartChecker - method
2021
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2022
1074
    @dbus.service.method(_interface)
2023
1075
    def StartChecker(self):
2024
1076
        "D-Bus method"
2025
1077
        self.start_checker()
2026
 
 
 
1078
    
2027
1079
    # Disable - method
2028
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2029
1080
    @dbus.service.method(_interface)
2030
1081
    def Disable(self):
2031
1082
        "D-Bus method"
2032
1083
        self.disable()
2033
 
 
 
1084
    
2034
1085
    # StopChecker - method
2035
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2036
1086
    @dbus.service.method(_interface)
2037
1087
    def StopChecker(self):
2038
1088
        self.stop_checker()
2039
 
 
2040
 
    #  Properties
2041
 
 
 
1089
    
 
1090
    ## Properties
 
1091
    
2042
1092
    # ApprovalPending - property
2043
1093
    @dbus_service_property(_interface, signature="b", access="read")
2044
1094
    def ApprovalPending_dbus_property(self):
2045
1095
        return dbus.Boolean(bool(self.approvals_pending))
2046
 
 
 
1096
    
2047
1097
    # ApprovedByDefault - property
2048
 
    @dbus_service_property(_interface,
2049
 
                           signature="b",
 
1098
    @dbus_service_property(_interface, signature="b",
2050
1099
                           access="readwrite")
2051
1100
    def ApprovedByDefault_dbus_property(self, value=None):
2052
1101
        if value is None:       # get
2053
1102
            return dbus.Boolean(self.approved_by_default)
2054
1103
        self.approved_by_default = bool(value)
2055
 
 
 
1104
    
2056
1105
    # ApprovalDelay - property
2057
 
    @dbus_service_property(_interface,
2058
 
                           signature="t",
 
1106
    @dbus_service_property(_interface, signature="t",
2059
1107
                           access="readwrite")
2060
1108
    def ApprovalDelay_dbus_property(self, value=None):
2061
1109
        if value is None:       # get
2062
 
            return dbus.UInt64(self.approval_delay.total_seconds()
2063
 
                               * 1000)
 
1110
            return dbus.UInt64(self.approval_delay_milliseconds())
2064
1111
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
2065
 
 
 
1112
    
2066
1113
    # ApprovalDuration - property
2067
 
    @dbus_service_property(_interface,
2068
 
                           signature="t",
 
1114
    @dbus_service_property(_interface, signature="t",
2069
1115
                           access="readwrite")
2070
1116
    def ApprovalDuration_dbus_property(self, value=None):
2071
1117
        if value is None:       # get
2072
 
            return dbus.UInt64(self.approval_duration.total_seconds()
2073
 
                               * 1000)
 
1118
            return dbus.UInt64(_timedelta_to_milliseconds(
 
1119
                    self.approval_duration))
2074
1120
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
2075
 
 
 
1121
    
2076
1122
    # Name - property
2077
 
    @dbus_annotations(
2078
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2079
1123
    @dbus_service_property(_interface, signature="s", access="read")
2080
1124
    def Name_dbus_property(self):
2081
1125
        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
 
 
 
1126
    
2090
1127
    # Fingerprint - property
2091
 
    @dbus_annotations(
2092
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2093
1128
    @dbus_service_property(_interface, signature="s", access="read")
2094
1129
    def Fingerprint_dbus_property(self):
2095
1130
        return dbus.String(self.fingerprint)
2096
 
 
 
1131
    
2097
1132
    # Host - property
2098
 
    @dbus_service_property(_interface,
2099
 
                           signature="s",
 
1133
    @dbus_service_property(_interface, signature="s",
2100
1134
                           access="readwrite")
2101
1135
    def Host_dbus_property(self, value=None):
2102
1136
        if value is None:       # get
2103
1137
            return dbus.String(self.host)
2104
 
        self.host = str(value)
2105
 
 
 
1138
        self.host = value
 
1139
    
2106
1140
    # Created - property
2107
 
    @dbus_annotations(
2108
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2109
1141
    @dbus_service_property(_interface, signature="s", access="read")
2110
1142
    def Created_dbus_property(self):
2111
 
        return datetime_to_dbus(self.created)
2112
 
 
 
1143
        return dbus.String(datetime_to_dbus(self.created))
 
1144
    
2113
1145
    # LastEnabled - property
2114
1146
    @dbus_service_property(_interface, signature="s", access="read")
2115
1147
    def LastEnabled_dbus_property(self):
2116
1148
        return datetime_to_dbus(self.last_enabled)
2117
 
 
 
1149
    
2118
1150
    # Enabled - property
2119
 
    @dbus_service_property(_interface,
2120
 
                           signature="b",
 
1151
    @dbus_service_property(_interface, signature="b",
2121
1152
                           access="readwrite")
2122
1153
    def Enabled_dbus_property(self, value=None):
2123
1154
        if value is None:       # get
2126
1157
            self.enable()
2127
1158
        else:
2128
1159
            self.disable()
2129
 
 
 
1160
    
2130
1161
    # LastCheckedOK - property
2131
 
    @dbus_service_property(_interface,
2132
 
                           signature="s",
 
1162
    @dbus_service_property(_interface, signature="s",
2133
1163
                           access="readwrite")
2134
1164
    def LastCheckedOK_dbus_property(self, value=None):
2135
1165
        if value is not None:
2136
1166
            self.checked_ok()
2137
1167
            return
2138
1168
        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
 
 
 
1169
    
2145
1170
    # Expires - property
2146
1171
    @dbus_service_property(_interface, signature="s", access="read")
2147
1172
    def Expires_dbus_property(self):
2148
1173
        return datetime_to_dbus(self.expires)
2149
 
 
 
1174
    
2150
1175
    # LastApprovalRequest - property
2151
1176
    @dbus_service_property(_interface, signature="s", access="read")
2152
1177
    def LastApprovalRequest_dbus_property(self):
2153
1178
        return datetime_to_dbus(self.last_approval_request)
2154
 
 
 
1179
    
2155
1180
    # Timeout - property
2156
 
    @dbus_service_property(_interface,
2157
 
                           signature="t",
 
1181
    @dbus_service_property(_interface, signature="t",
2158
1182
                           access="readwrite")
2159
1183
    def Timeout_dbus_property(self, value=None):
2160
1184
        if value is None:       # get
2161
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
2162
 
        old_timeout = self.timeout
 
1185
            return dbus.UInt64(self.timeout_milliseconds())
2163
1186
        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
 
 
 
1187
        if getattr(self, "disable_initiator_tag", None) is None:
 
1188
            return
 
1189
        # Reschedule timeout
 
1190
        gobject.source_remove(self.disable_initiator_tag)
 
1191
        self.disable_initiator_tag = None
 
1192
        self.expires = None
 
1193
        time_to_die = _timedelta_to_milliseconds((self
 
1194
                                                  .last_checked_ok
 
1195
                                                  + self.timeout)
 
1196
                                                 - datetime.datetime
 
1197
                                                 .utcnow())
 
1198
        if time_to_die <= 0:
 
1199
            # The timeout has passed
 
1200
            self.disable()
 
1201
        else:
 
1202
            self.expires = (datetime.datetime.utcnow()
 
1203
                            + datetime.timedelta(milliseconds =
 
1204
                                                 time_to_die))
 
1205
            self.disable_initiator_tag = (gobject.timeout_add
 
1206
                                          (time_to_die, self.disable))
 
1207
    
2180
1208
    # ExtendedTimeout - property
2181
 
    @dbus_service_property(_interface,
2182
 
                           signature="t",
 
1209
    @dbus_service_property(_interface, signature="t",
2183
1210
                           access="readwrite")
2184
1211
    def ExtendedTimeout_dbus_property(self, value=None):
2185
1212
        if value is None:       # get
2186
 
            return dbus.UInt64(self.extended_timeout.total_seconds()
2187
 
                               * 1000)
 
1213
            return dbus.UInt64(self.extended_timeout_milliseconds())
2188
1214
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2189
 
 
 
1215
    
2190
1216
    # Interval - property
2191
 
    @dbus_service_property(_interface,
2192
 
                           signature="t",
 
1217
    @dbus_service_property(_interface, signature="t",
2193
1218
                           access="readwrite")
2194
1219
    def Interval_dbus_property(self, value=None):
2195
1220
        if value is None:       # get
2196
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1221
            return dbus.UInt64(self.interval_milliseconds())
2197
1222
        self.interval = datetime.timedelta(0, 0, 0, value)
2198
1223
        if getattr(self, "checker_initiator_tag", None) is None:
2199
1224
            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
 
 
 
1225
        # Reschedule checker run
 
1226
        gobject.source_remove(self.checker_initiator_tag)
 
1227
        self.checker_initiator_tag = (gobject.timeout_add
 
1228
                                      (value, self.start_checker))
 
1229
        self.start_checker()    # Start one now, too
 
1230
    
2207
1231
    # Checker - property
2208
 
    @dbus_service_property(_interface,
2209
 
                           signature="s",
 
1232
    @dbus_service_property(_interface, signature="s",
2210
1233
                           access="readwrite")
2211
1234
    def Checker_dbus_property(self, value=None):
2212
1235
        if value is None:       # get
2213
1236
            return dbus.String(self.checker_command)
2214
 
        self.checker_command = str(value)
2215
 
 
 
1237
        self.checker_command = value
 
1238
    
2216
1239
    # CheckerRunning - property
2217
 
    @dbus_service_property(_interface,
2218
 
                           signature="b",
 
1240
    @dbus_service_property(_interface, signature="b",
2219
1241
                           access="readwrite")
2220
1242
    def CheckerRunning_dbus_property(self, value=None):
2221
1243
        if value is None:       # get
2224
1246
            self.start_checker()
2225
1247
        else:
2226
1248
            self.stop_checker()
2227
 
 
 
1249
    
2228
1250
    # ObjectPath - property
2229
 
    @dbus_annotations(
2230
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2231
 
         "org.freedesktop.DBus.Deprecated": "true"})
2232
1251
    @dbus_service_property(_interface, signature="o", access="read")
2233
1252
    def ObjectPath_dbus_property(self):
2234
 
        return self.dbus_object_path  # is already a dbus.ObjectPath
2235
 
 
 
1253
        return self.dbus_object_path # is already a dbus.ObjectPath
 
1254
    
2236
1255
    # 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)
 
1256
    @dbus_service_property(_interface, signature="ay",
 
1257
                           access="write", byte_arrays=True)
2244
1258
    def Secret_dbus_property(self, value):
2245
 
        self.secret = bytes(value)
2246
 
 
 
1259
        self.secret = str(value)
 
1260
    
2247
1261
    del _interface
2248
1262
 
2249
1263
 
2250
 
class ProxyClient:
2251
 
    def __init__(self, child_pipe, key_id, fpr, address):
 
1264
class ProxyClient(object):
 
1265
    def __init__(self, child_pipe, fpr, address):
2252
1266
        self._pipe = child_pipe
2253
 
        self._pipe.send(('init', key_id, fpr, address))
 
1267
        self._pipe.send(('init', fpr, address))
2254
1268
        if not self._pipe.recv():
2255
 
            raise KeyError(key_id or fpr)
2256
 
 
 
1269
            raise KeyError()
 
1270
    
2257
1271
    def __getattribute__(self, name):
2258
 
        if name == '_pipe':
 
1272
        if(name == '_pipe'):
2259
1273
            return super(ProxyClient, self).__getattribute__(name)
2260
1274
        self._pipe.send(('getattr', name))
2261
1275
        data = self._pipe.recv()
2262
1276
        if data[0] == 'data':
2263
1277
            return data[1]
2264
1278
        if data[0] == 'function':
2265
 
 
2266
1279
            def func(*args, **kwargs):
2267
1280
                self._pipe.send(('funcall', name, args, kwargs))
2268
1281
                return self._pipe.recv()[1]
2269
 
 
2270
1282
            return func
2271
 
 
 
1283
    
2272
1284
    def __setattr__(self, name, value):
2273
 
        if name == '_pipe':
 
1285
        if(name == '_pipe'):
2274
1286
            return super(ProxyClient, self).__setattr__(name, value)
2275
1287
        self._pipe.send(('setattr', name, value))
2276
1288
 
 
1289
class ClientDBusTransitional(ClientDBus):
 
1290
    __metaclass__ = AlternateDBusNamesMetaclass
2277
1291
 
2278
1292
class ClientHandler(socketserver.BaseRequestHandler, object):
2279
1293
    """A class to handle client connections.
2280
 
 
 
1294
    
2281
1295
    Instantiated once for each connection to handle it.
2282
1296
    Note: This will run in its own forked process."""
2283
 
 
 
1297
    
2284
1298
    def handle(self):
2285
1299
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2286
1300
            logger.info("TCP connection from: %s",
2287
 
                        str(self.client_address))
 
1301
                        unicode(self.client_address))
2288
1302
            logger.debug("Pipe FD: %d",
2289
1303
                         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"))
 
1304
            
 
1305
            session = (gnutls.connection
 
1306
                       .ClientSession(self.request,
 
1307
                                      gnutls.connection
 
1308
                                      .X509Credentials()))
 
1309
            
 
1310
            # Note: gnutls.connection.X509Credentials is really a
 
1311
            # generic GnuTLS certificate credentials object so long as
 
1312
            # no X.509 keys are added to it.  Therefore, we can use it
 
1313
            # here despite using OpenPGP certificates.
 
1314
            
 
1315
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
1316
            #                      "+AES-256-CBC", "+SHA1",
 
1317
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
1318
            #                      "+DHE-DSS"))
2297
1319
            # Use a fallback default, since this MUST be set.
2298
1320
            priority = self.server.gnutls_priority
2299
1321
            if priority is None:
2300
1322
                priority = "NORMAL"
2301
 
            gnutls.priority_set_direct(session._c_object,
2302
 
                                       priority.encode("utf-8"),
2303
 
                                       None)
2304
 
 
 
1323
            (gnutls.library.functions
 
1324
             .gnutls_priority_set_direct(session._c_object,
 
1325
                                         priority, None))
 
1326
            
2305
1327
            # Start communication using the Mandos protocol
2306
1328
            # Get protocol number
2307
1329
            line = self.request.makefile().readline()
2308
1330
            logger.debug("Protocol version: %r", line)
2309
1331
            try:
2310
1332
                if int(line.strip().split()[0]) > 1:
2311
 
                    raise RuntimeError(line)
 
1333
                    raise RuntimeError
2312
1334
            except (ValueError, IndexError, RuntimeError) as error:
2313
1335
                logger.error("Unknown protocol version: %s", error)
2314
1336
                return
2315
 
 
 
1337
            
2316
1338
            # Start GnuTLS connection
2317
1339
            try:
2318
1340
                session.handshake()
2319
 
            except gnutls.Error as error:
 
1341
            except gnutls.errors.GNUTLSError as error:
2320
1342
                logger.warning("Handshake failed: %s", error)
2321
1343
                # Do not run session.bye() here: the session is not
2322
1344
                # established.  Just abandon the request.
2323
1345
                return
2324
1346
            logger.debug("Handshake succeeded")
2325
 
 
 
1347
            
2326
1348
            approval_required = False
2327
1349
            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,
 
1350
                try:
 
1351
                    fpr = self.fingerprint(self.peer_certificate
 
1352
                                           (session))
 
1353
                except (TypeError,
 
1354
                        gnutls.errors.GNUTLSError) as error:
 
1355
                    logger.warning("Bad certificate: %s", error)
 
1356
                    return
 
1357
                logger.debug("Fingerprint: %s", fpr)
 
1358
                
 
1359
                try:
 
1360
                    client = ProxyClient(child_pipe, fpr,
2350
1361
                                         self.client_address)
2351
1362
                except KeyError:
2352
1363
                    return
2353
 
 
 
1364
                
2354
1365
                if client.approval_delay:
2355
1366
                    delay = client.approval_delay
2356
1367
                    client.approvals_pending += 1
2357
1368
                    approval_required = True
2358
 
 
 
1369
                
2359
1370
                while True:
2360
1371
                    if not client.enabled:
2361
1372
                        logger.info("Client %s is disabled",
2362
 
                                    client.name)
 
1373
                                       client.name)
2363
1374
                        if self.server.use_dbus:
2364
1375
                            # Emit D-Bus signal
2365
1376
                            client.Rejected("Disabled")
2366
1377
                        return
2367
 
 
2368
 
                    if client.approved or not client.approval_delay:
2369
 
                        # We are approved or approval is disabled
 
1378
                    
 
1379
                    if client._approved or not client.approval_delay:
 
1380
                        #We are approved or approval is disabled
2370
1381
                        break
2371
 
                    elif client.approved is None:
 
1382
                    elif client._approved is None:
2372
1383
                        logger.info("Client %s needs approval",
2373
1384
                                    client.name)
2374
1385
                        if self.server.use_dbus:
2375
1386
                            # Emit D-Bus signal
2376
1387
                            client.NeedApproval(
2377
 
                                client.approval_delay.total_seconds()
2378
 
                                * 1000, client.approved_by_default)
 
1388
                                client.approval_delay_milliseconds(),
 
1389
                                client.approved_by_default)
2379
1390
                    else:
2380
1391
                        logger.warning("Client %s was not approved",
2381
1392
                                       client.name)
2383
1394
                            # Emit D-Bus signal
2384
1395
                            client.Rejected("Denied")
2385
1396
                        return
2386
 
 
2387
 
                    # wait until timeout or approved
 
1397
                    
 
1398
                    #wait until timeout or approved
2388
1399
                    time = datetime.datetime.now()
2389
1400
                    client.changedstate.acquire()
2390
 
                    client.changedstate.wait(delay.total_seconds())
 
1401
                    (client.changedstate.wait
 
1402
                     (float(client._timedelta_to_milliseconds(delay)
 
1403
                            / 1000)))
2391
1404
                    client.changedstate.release()
2392
1405
                    time2 = datetime.datetime.now()
2393
1406
                    if (time2 - time) >= delay:
2403
1416
                            break
2404
1417
                    else:
2405
1418
                        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
 
 
 
1419
                
 
1420
                sent_size = 0
 
1421
                while sent_size < len(client.secret):
 
1422
                    try:
 
1423
                        sent = session.send(client.secret[sent_size:])
 
1424
                    except gnutls.errors.GNUTLSError as error:
 
1425
                        logger.warning("gnutls send failed")
 
1426
                        return
 
1427
                    logger.debug("Sent: %d, remaining: %d",
 
1428
                                 sent, len(client.secret)
 
1429
                                 - (sent_size + sent))
 
1430
                    sent_size += sent
 
1431
                
2414
1432
                logger.info("Sending secret to %s", client.name)
2415
1433
                # bump the timeout using extended_timeout
2416
 
                client.bump_timeout(client.extended_timeout)
 
1434
                client.checked_ok(client.extended_timeout)
2417
1435
                if self.server.use_dbus:
2418
1436
                    # Emit D-Bus signal
2419
1437
                    client.GotSecret()
2420
 
 
 
1438
            
2421
1439
            finally:
2422
1440
                if approval_required:
2423
1441
                    client.approvals_pending -= 1
2424
1442
                try:
2425
1443
                    session.bye()
2426
 
                except gnutls.Error as error:
2427
 
                    logger.warning("GnuTLS bye failed",
2428
 
                                   exc_info=error)
2429
 
 
 
1444
                except gnutls.errors.GNUTLSError as error:
 
1445
                    logger.warning("GnuTLS bye failed")
 
1446
    
2430
1447
    @staticmethod
2431
1448
    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""
 
1449
        "Return the peer's OpenPGP certificate as a bytestring"
 
1450
        # If not an OpenPGP certificate...
 
1451
        if (gnutls.library.functions
 
1452
            .gnutls_certificate_type_get(session._c_object)
 
1453
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
1454
            # ...do the normal thing
 
1455
            return session.peer_certificate
2448
1456
        list_size = ctypes.c_uint(1)
2449
 
        cert_list = (gnutls.certificate_get_peers
 
1457
        cert_list = (gnutls.library.functions
 
1458
                     .gnutls_certificate_get_peers
2450
1459
                     (session._c_object, ctypes.byref(list_size)))
2451
1460
        if not bool(cert_list) and list_size.value != 0:
2452
 
            raise gnutls.Error("error getting peer certificate")
 
1461
            raise gnutls.errors.GNUTLSError("error getting peer"
 
1462
                                            " certificate")
2453
1463
        if list_size.value == 0:
2454
1464
            return None
2455
1465
        cert = cert_list[0]
2456
1466
        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
 
 
 
1467
    
2493
1468
    @staticmethod
2494
1469
    def fingerprint(openpgp):
2495
1470
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2496
1471
        # 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)))
 
1472
        datum = (gnutls.library.types
 
1473
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1474
                                             ctypes.POINTER
 
1475
                                             (ctypes.c_ubyte)),
 
1476
                                 ctypes.c_uint(len(openpgp))))
2501
1477
        # New empty GnuTLS certificate
2502
 
        crt = gnutls.openpgp_crt_t()
2503
 
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
1478
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
1479
        (gnutls.library.functions
 
1480
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
2504
1481
        # Import the OpenPGP public key into the certificate
2505
 
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2506
 
                                  gnutls.OPENPGP_FMT_RAW)
 
1482
        (gnutls.library.functions
 
1483
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1484
                                    gnutls.library.constants
 
1485
                                    .GNUTLS_OPENPGP_FMT_RAW))
2507
1486
        # Verify the self signature in the key
2508
1487
        crtverify = ctypes.c_uint()
2509
 
        gnutls.openpgp_crt_verify_self(crt, 0,
2510
 
                                       ctypes.byref(crtverify))
 
1488
        (gnutls.library.functions
 
1489
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1490
                                         ctypes.byref(crtverify)))
2511
1491
        if crtverify.value != 0:
2512
 
            gnutls.openpgp_crt_deinit(crt)
2513
 
            raise gnutls.CertificateSecurityError(code
2514
 
                                                  =crtverify.value)
 
1492
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1493
            raise (gnutls.errors.CertificateSecurityError
 
1494
                   ("Verify failed"))
2515
1495
        # New buffer for the fingerprint
2516
1496
        buf = ctypes.create_string_buffer(20)
2517
1497
        buf_len = ctypes.c_size_t()
2518
1498
        # Get the fingerprint from the certificate into the buffer
2519
 
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2520
 
                                           ctypes.byref(buf_len))
 
1499
        (gnutls.library.functions
 
1500
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1501
                                             ctypes.byref(buf_len)))
2521
1502
        # Deinit the certificate
2522
 
        gnutls.openpgp_crt_deinit(crt)
 
1503
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2523
1504
        # Convert the buffer to a Python bytestring
2524
1505
        fpr = ctypes.string_at(buf, buf_len.value)
2525
1506
        # Convert the bytestring to hexadecimal notation
2526
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1507
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2527
1508
        return hex_fpr
2528
1509
 
2529
1510
 
2530
 
class MultiprocessingMixIn:
 
1511
class MultiprocessingMixIn(object):
2531
1512
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2532
 
 
2533
1513
    def sub_process_main(self, request, address):
2534
1514
        try:
2535
1515
            self.finish_request(request, address)
2536
 
        except Exception:
 
1516
        except:
2537
1517
            self.handle_error(request, address)
2538
1518
        self.close_request(request)
2539
 
 
 
1519
    
2540
1520
    def process_request(self, request, address):
2541
1521
        """Start a new process to process the request."""
2542
 
        proc = multiprocessing.Process(target=self.sub_process_main,
2543
 
                                       args=(request, address))
 
1522
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1523
                                       args = (request,
 
1524
                                               address))
2544
1525
        proc.start()
2545
1526
        return proc
2546
1527
 
2547
1528
 
2548
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
1529
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2549
1530
    """ adds a pipe to the MixIn """
2550
 
 
2551
1531
    def process_request(self, request, client_address):
2552
1532
        """Overrides and wraps the original process_request().
2553
 
 
 
1533
        
2554
1534
        This function creates a new pipe in self.pipe
2555
1535
        """
2556
1536
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
2557
 
 
 
1537
        
2558
1538
        proc = MultiprocessingMixIn.process_request(self, request,
2559
1539
                                                    client_address)
2560
1540
        self.child_pipe.close()
2561
1541
        self.add_pipe(parent_pipe, proc)
2562
 
 
 
1542
    
2563
1543
    def add_pipe(self, parent_pipe, proc):
2564
1544
        """Dummy function; override as necessary"""
2565
 
        raise NotImplementedError()
 
1545
        raise NotImplementedError
2566
1546
 
2567
1547
 
2568
1548
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2569
 
                     socketserver.TCPServer):
 
1549
                     socketserver.TCPServer, object):
2570
1550
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2571
 
 
 
1551
    
2572
1552
    Attributes:
2573
1553
        enabled:        Boolean; whether this server is activated yet
2574
1554
        interface:      None or a network interface name (string)
2575
1555
        use_ipv6:       Boolean; to use IPv6 or not
2576
1556
    """
2577
 
 
2578
1557
    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
 
        """
 
1558
                 interface=None, use_ipv6=True):
2585
1559
        self.interface = interface
2586
1560
        if use_ipv6:
2587
1561
            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
1562
        socketserver.TCPServer.__init__(self, server_address,
2616
1563
                                        RequestHandlerClass)
2617
 
 
2618
1564
    def server_bind(self):
2619
1565
        """This overrides the normal server_bind() function
2620
1566
        to bind to an interface if one was specified, and also NOT to
2621
1567
        bind to an address or port if they were not specified."""
2622
 
        global SO_BINDTODEVICE
2623
1568
        if self.interface is not None:
2624
1569
            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
 
1570
                logger.error("SO_BINDTODEVICE does not exist;"
 
1571
                             " cannot bind to interface %s",
 
1572
                             self.interface)
 
1573
            else:
 
1574
                try:
 
1575
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1576
                                           SO_BINDTODEVICE,
 
1577
                                           str(self.interface
 
1578
                                               + '\0'))
 
1579
                except socket.error as error:
 
1580
                    if error[0] == errno.EPERM:
 
1581
                        logger.error("No permission to"
 
1582
                                     " bind to interface %s",
 
1583
                                     self.interface)
 
1584
                    elif error[0] == errno.ENOPROTOOPT:
 
1585
                        logger.error("SO_BINDTODEVICE not available;"
 
1586
                                     " cannot bind to interface %s",
 
1587
                                     self.interface)
 
1588
                    else:
 
1589
                        raise
2646
1590
        # Only bind(2) the socket if we really need to.
2647
1591
        if self.server_address[0] or self.server_address[1]:
2648
 
            if self.server_address[1]:
2649
 
                self.allow_reuse_address = True
2650
1592
            if not self.server_address[0]:
2651
1593
                if self.address_family == socket.AF_INET6:
2652
 
                    any_address = "::"  # in6addr_any
 
1594
                    any_address = "::" # in6addr_any
2653
1595
                else:
2654
 
                    any_address = "0.0.0.0"  # INADDR_ANY
 
1596
                    any_address = socket.INADDR_ANY
2655
1597
                self.server_address = (any_address,
2656
1598
                                       self.server_address[1])
2657
1599
            elif not self.server_address[1]:
2658
 
                self.server_address = (self.server_address[0], 0)
 
1600
                self.server_address = (self.server_address[0],
 
1601
                                       0)
2659
1602
#                 if self.interface:
2660
1603
#                     self.server_address = (self.server_address[0],
2661
1604
#                                            0, # port
2667
1610
 
2668
1611
class MandosServer(IPv6_TCPServer):
2669
1612
    """Mandos server.
2670
 
 
 
1613
    
2671
1614
    Attributes:
2672
1615
        clients:        set of Client objects
2673
1616
        gnutls_priority GnuTLS priority string
2674
1617
        use_dbus:       Boolean; to emit D-Bus signals or not
2675
 
 
2676
 
    Assumes a GLib.MainLoop event loop.
 
1618
    
 
1619
    Assumes a gobject.MainLoop event loop.
2677
1620
    """
2678
 
 
2679
1621
    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):
 
1622
                 interface=None, use_ipv6=True, clients=None,
 
1623
                 gnutls_priority=None, use_dbus=True):
2686
1624
        self.enabled = False
2687
1625
        self.clients = clients
2688
1626
        if self.clients is None:
2689
 
            self.clients = {}
 
1627
            self.clients = set()
2690
1628
        self.use_dbus = use_dbus
2691
1629
        self.gnutls_priority = gnutls_priority
2692
1630
        IPv6_TCPServer.__init__(self, server_address,
2693
1631
                                RequestHandlerClass,
2694
 
                                interface=interface,
2695
 
                                use_ipv6=use_ipv6,
2696
 
                                socketfd=socketfd)
2697
 
 
 
1632
                                interface = interface,
 
1633
                                use_ipv6 = use_ipv6)
2698
1634
    def server_activate(self):
2699
1635
        if self.enabled:
2700
1636
            return socketserver.TCPServer.server_activate(self)
2701
 
 
 
1637
    
2702
1638
    def enable(self):
2703
1639
        self.enabled = True
2704
 
 
 
1640
    
2705
1641
    def add_pipe(self, parent_pipe, proc):
2706
1642
        # 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):
 
1643
        gobject.io_add_watch(parent_pipe.fileno(),
 
1644
                             gobject.IO_IN | gobject.IO_HUP,
 
1645
                             functools.partial(self.handle_ipc,
 
1646
                                               parent_pipe =
 
1647
                                               parent_pipe,
 
1648
                                               proc = proc))
 
1649
    
 
1650
    def handle_ipc(self, source, condition, parent_pipe=None,
 
1651
                   proc = None, client_object=None):
 
1652
        condition_names = {
 
1653
            gobject.IO_IN: "IN",   # There is data to read.
 
1654
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1655
                                    # blocking).
 
1656
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1657
            gobject.IO_ERR: "ERR", # Error condition.
 
1658
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1659
                                    # broken, usually for pipes and
 
1660
                                    # sockets).
 
1661
            }
 
1662
        conditions_string = ' | '.join(name
 
1663
                                       for cond, name in
 
1664
                                       condition_names.iteritems()
 
1665
                                       if cond & condition)
2718
1666
        # error, or the other end of multiprocessing.Pipe has closed
2719
 
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
 
1667
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2720
1668
            # Wait for other process to exit
2721
1669
            proc.join()
2722
1670
            return False
2723
 
 
 
1671
        
2724
1672
        # Read a request from the child
2725
1673
        request = parent_pipe.recv()
2726
1674
        command = request[0]
2727
 
 
 
1675
        
2728
1676
        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:
 
1677
            fpr = request[1]
 
1678
            address = request[2]
 
1679
            
 
1680
            for c in self.clients:
 
1681
                if c.fingerprint == fpr:
2741
1682
                    client = c
2742
1683
                    break
2743
1684
            else:
2744
 
                logger.info("Client not found for key ID: %s, address"
2745
 
                            ": %s", key_id or fpr, address)
 
1685
                logger.info("Client not found for fingerprint: %s, ad"
 
1686
                            "dress: %s", fpr, address)
2746
1687
                if self.use_dbus:
2747
1688
                    # Emit D-Bus signal
2748
 
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
 
1689
                    mandos_dbus_service.ClientNotFound(fpr,
2749
1690
                                                       address[0])
2750
1691
                parent_pipe.send(False)
2751
1692
                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))
 
1693
            
 
1694
            gobject.io_add_watch(parent_pipe.fileno(),
 
1695
                                 gobject.IO_IN | gobject.IO_HUP,
 
1696
                                 functools.partial(self.handle_ipc,
 
1697
                                                   parent_pipe =
 
1698
                                                   parent_pipe,
 
1699
                                                   proc = proc,
 
1700
                                                   client_object =
 
1701
                                                   client))
2760
1702
            parent_pipe.send(True)
2761
1703
            # remove the old hook in favor of the new above hook on
2762
1704
            # same fileno
2765
1707
            funcname = request[1]
2766
1708
            args = request[2]
2767
1709
            kwargs = request[3]
2768
 
 
 
1710
            
2769
1711
            parent_pipe.send(('data', getattr(client_object,
2770
1712
                                              funcname)(*args,
2771
 
                                                        **kwargs)))
2772
 
 
 
1713
                                                         **kwargs)))
 
1714
        
2773
1715
        if command == 'getattr':
2774
1716
            attrname = request[1]
2775
 
            if isinstance(client_object.__getattribute__(attrname),
2776
 
                          collections.abc.Callable):
2777
 
                parent_pipe.send(('function', ))
 
1717
            if callable(client_object.__getattribute__(attrname)):
 
1718
                parent_pipe.send(('function',))
2778
1719
            else:
2779
 
                parent_pipe.send((
2780
 
                    'data', client_object.__getattribute__(attrname)))
2781
 
 
 
1720
                parent_pipe.send(('data', client_object
 
1721
                                  .__getattribute__(attrname)))
 
1722
        
2782
1723
        if command == 'setattr':
2783
1724
            attrname = request[1]
2784
1725
            value = request[2]
2785
1726
            setattr(client_object, attrname, value)
2786
 
 
 
1727
        
2787
1728
        return True
2788
1729
 
2789
1730
 
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
1731
def string_to_delta(interval):
2892
1732
    """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
 
1733
    
 
1734
    >>> string_to_delta('7d')
 
1735
    datetime.timedelta(7)
 
1736
    >>> string_to_delta('60s')
 
1737
    datetime.timedelta(0, 60)
 
1738
    >>> string_to_delta('60m')
 
1739
    datetime.timedelta(0, 3600)
 
1740
    >>> string_to_delta('24h')
 
1741
    datetime.timedelta(1)
 
1742
    >>> string_to_delta('1w')
 
1743
    datetime.timedelta(7)
 
1744
    >>> string_to_delta('5m 30s')
 
1745
    datetime.timedelta(0, 330)
2906
1746
    """
2907
 
 
2908
 
    try:
2909
 
        return rfc3339_duration_to_delta(interval)
2910
 
    except ValueError:
2911
 
        pass
2912
 
 
2913
1747
    timevalue = datetime.timedelta(0)
2914
1748
    for s in interval.split():
2915
1749
        try:
2916
 
            suffix = s[-1]
 
1750
            suffix = unicode(s[-1])
2917
1751
            value = int(s[:-1])
2918
1752
            if suffix == "d":
2919
1753
                delta = datetime.timedelta(value)
2926
1760
            elif suffix == "w":
2927
1761
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2928
1762
            else:
2929
 
                raise ValueError("Unknown suffix {!r}".format(suffix))
2930
 
        except IndexError as e:
 
1763
                raise ValueError("Unknown suffix %r" % suffix)
 
1764
        except (ValueError, IndexError) as e:
2931
1765
            raise ValueError(*(e.args))
2932
1766
        timevalue += delta
2933
1767
    return timevalue
2934
1768
 
2935
1769
 
2936
 
def daemon(nochdir=False, noclose=False):
 
1770
def if_nametoindex(interface):
 
1771
    """Call the C function if_nametoindex(), or equivalent
 
1772
    
 
1773
    Note: This function cannot accept a unicode string."""
 
1774
    global if_nametoindex
 
1775
    try:
 
1776
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
1777
                          (ctypes.util.find_library("c"))
 
1778
                          .if_nametoindex)
 
1779
    except (OSError, AttributeError):
 
1780
        logger.warning("Doing if_nametoindex the hard way")
 
1781
        def if_nametoindex(interface):
 
1782
            "Get an interface index the hard way, i.e. using fcntl()"
 
1783
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
1784
            with contextlib.closing(socket.socket()) as s:
 
1785
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
1786
                                    struct.pack(str("16s16x"),
 
1787
                                                interface))
 
1788
            interface_index = struct.unpack(str("I"),
 
1789
                                            ifreq[16:20])[0]
 
1790
            return interface_index
 
1791
    return if_nametoindex(interface)
 
1792
 
 
1793
 
 
1794
def daemon(nochdir = False, noclose = False):
2937
1795
    """See daemon(3).  Standard BSD Unix function.
2938
 
 
 
1796
    
2939
1797
    This should really exist as os.daemon, but it doesn't (yet)."""
2940
1798
    if os.fork():
2941
1799
        sys.exit()
2946
1804
        sys.exit()
2947
1805
    if not noclose:
2948
1806
        # Close all standard open file descriptors
2949
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1807
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2950
1808
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2951
1809
            raise OSError(errno.ENODEV,
2952
 
                          "{} not a character device"
2953
 
                          .format(os.devnull))
 
1810
                          "%s not a character device"
 
1811
                          % os.path.devnull)
2954
1812
        os.dup2(null, sys.stdin.fileno())
2955
1813
        os.dup2(null, sys.stdout.fileno())
2956
1814
        os.dup2(null, sys.stderr.fileno())
2959
1817
 
2960
1818
 
2961
1819
def main():
2962
 
 
 
1820
    
2963
1821
    ##################################################################
2964
1822
    # Parsing of options, both command line and config file
2965
 
 
 
1823
    
2966
1824
    parser = argparse.ArgumentParser()
2967
1825
    parser.add_argument("-v", "--version", action="version",
2968
 
                        version="%(prog)s {}".format(version),
 
1826
                        version = "%%(prog)s %s" % version,
2969
1827
                        help="show version number and exit")
2970
1828
    parser.add_argument("-i", "--interface", metavar="IF",
2971
1829
                        help="Bind to interface IF")
2977
1835
                        help="Run self-test")
2978
1836
    parser.add_argument("--debug", action="store_true",
2979
1837
                        help="Debug mode; run in foreground and log"
2980
 
                        " to terminal", default=None)
 
1838
                        " to terminal")
2981
1839
    parser.add_argument("--debuglevel", metavar="LEVEL",
2982
1840
                        help="Debug level for stdout output")
2983
1841
    parser.add_argument("--priority", help="GnuTLS"
2990
1848
                        " files")
2991
1849
    parser.add_argument("--no-dbus", action="store_false",
2992
1850
                        dest="use_dbus", help="Do not provide D-Bus"
2993
 
                        " system bus interface", default=None)
 
1851
                        " system bus interface")
2994
1852
    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
 
 
 
1853
                        dest="use_ipv6", help="Do not use IPv6")
3011
1854
    options = parser.parse_args()
3012
 
 
 
1855
    
 
1856
    if options.check:
 
1857
        import doctest
 
1858
        doctest.testmod()
 
1859
        sys.exit()
 
1860
    
3013
1861
    # 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
 
 
 
1862
    server_defaults = { "interface": "",
 
1863
                        "address": "",
 
1864
                        "port": "",
 
1865
                        "debug": "False",
 
1866
                        "priority":
 
1867
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
1868
                        "servicename": "Mandos",
 
1869
                        "use_dbus": "True",
 
1870
                        "use_ipv6": "True",
 
1871
                        "debuglevel": "",
 
1872
                        }
 
1873
    
3037
1874
    # Parse config file for server-global settings
3038
 
    server_config = configparser.ConfigParser(server_defaults)
 
1875
    server_config = configparser.SafeConfigParser(server_defaults)
3039
1876
    del server_defaults
3040
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3041
 
    # Convert the ConfigParser object to a dict
 
1877
    server_config.read(os.path.join(options.configdir,
 
1878
                                    "mandos.conf"))
 
1879
    # Convert the SafeConfigParser object to a dict
3042
1880
    server_settings = server_config.defaults()
3043
1881
    # Use the appropriate methods on the non-string config options
3044
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3045
 
                   "foreground", "zeroconf"):
 
1882
    for option in ("debug", "use_dbus", "use_ipv6"):
3046
1883
        server_settings[option] = server_config.getboolean("DEFAULT",
3047
1884
                                                           option)
3048
1885
    if server_settings["port"]:
3049
1886
        server_settings["port"] = server_config.getint("DEFAULT",
3050
1887
                                                       "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
1888
    del server_config
3061
 
 
 
1889
    
3062
1890
    # Override the settings from the config file with command line
3063
1891
    # options, if set.
3064
1892
    for option in ("interface", "address", "port", "debug",
3065
 
                   "priority", "servicename", "configdir", "use_dbus",
3066
 
                   "use_ipv6", "debuglevel", "restore", "statedir",
3067
 
                   "socket", "foreground", "zeroconf"):
 
1893
                   "priority", "servicename", "configdir",
 
1894
                   "use_dbus", "use_ipv6", "debuglevel"):
3068
1895
        value = getattr(options, option)
3069
1896
        if value is not None:
3070
1897
            server_settings[option] = value
3071
1898
    del options
3072
1899
    # Force all strings to be unicode
3073
1900
    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
 
1901
        if type(server_settings[option]) is str:
 
1902
            server_settings[option] = unicode(server_settings[option])
3084
1903
    # Now we have our good server settings in "server_settings"
3085
 
 
 
1904
    
3086
1905
    ##################################################################
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
 
 
 
1906
    
3093
1907
    # For convenience
3094
1908
    debug = server_settings["debug"]
3095
1909
    debuglevel = server_settings["debuglevel"]
3096
1910
    use_dbus = server_settings["use_dbus"]
3097
1911
    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
 
 
 
1912
    
3112
1913
    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
 
 
 
1914
        syslogger.setFormatter(logging.Formatter
 
1915
                               ('Mandos (%s) [%%(process)d]:'
 
1916
                                ' %%(levelname)s: %%(message)s'
 
1917
                                % server_settings["servicename"]))
 
1918
    
3118
1919
    # Parse config file with clients
3119
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
1920
    client_defaults = { "timeout": "5m",
 
1921
                        "extended_timeout": "15m",
 
1922
                        "interval": "2m",
 
1923
                        "checker": "fping -q -- %%(host)s",
 
1924
                        "host": "",
 
1925
                        "approval_delay": "0s",
 
1926
                        "approval_duration": "1s",
 
1927
                        }
 
1928
    client_config = configparser.SafeConfigParser(client_defaults)
3120
1929
    client_config.read(os.path.join(server_settings["configdir"],
3121
1930
                                    "clients.conf"))
3122
 
 
 
1931
    
3123
1932
    global mandos_dbus_service
3124
1933
    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
 
1934
    
 
1935
    tcp_server = MandosServer((server_settings["address"],
 
1936
                               server_settings["port"]),
 
1937
                              ClientHandler,
 
1938
                              interface=(server_settings["interface"]
 
1939
                                         or None),
 
1940
                              use_ipv6=use_ipv6,
 
1941
                              gnutls_priority=
 
1942
                              server_settings["priority"],
 
1943
                              use_dbus=use_dbus)
 
1944
    if not debug:
 
1945
        pidfilename = "/var/run/mandos.pid"
 
1946
        try:
 
1947
            pidfile = open(pidfilename, "w")
 
1948
        except IOError:
 
1949
            logger.error("Could not open file %r", pidfilename)
 
1950
    
 
1951
    try:
 
1952
        uid = pwd.getpwnam("_mandos").pw_uid
 
1953
        gid = pwd.getpwnam("_mandos").pw_gid
 
1954
    except KeyError:
 
1955
        try:
 
1956
            uid = pwd.getpwnam("mandos").pw_uid
 
1957
            gid = pwd.getpwnam("mandos").pw_gid
3155
1958
        except KeyError:
3156
 
            continue
3157
 
    else:
3158
 
        uid = 65534
3159
 
        gid = 65534
 
1959
            try:
 
1960
                uid = pwd.getpwnam("nobody").pw_uid
 
1961
                gid = pwd.getpwnam("nobody").pw_gid
 
1962
            except KeyError:
 
1963
                uid = 65534
 
1964
                gid = 65534
3160
1965
    try:
3161
1966
        os.setgid(gid)
3162
1967
        os.setuid(uid)
3163
 
        if debug:
3164
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3165
 
                                                             gid))
3166
1968
    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
 
 
 
1969
        if error[0] != errno.EPERM:
 
1970
            raise error
 
1971
    
 
1972
    if not debug and not debuglevel:
 
1973
        syslogger.setLevel(logging.WARNING)
 
1974
        console.setLevel(logging.WARNING)
 
1975
    if debuglevel:
 
1976
        level = getattr(logging, debuglevel.upper())
 
1977
        syslogger.setLevel(level)
 
1978
        console.setLevel(level)
 
1979
    
3172
1980
    if debug:
3173
1981
        # Enable all possible GnuTLS debugging
3174
 
 
 
1982
        
3175
1983
        # "Use a log level over 10 to enable all debugging options."
3176
1984
        # - GnuTLS manual
3177
 
        gnutls.global_set_log_level(11)
3178
 
 
3179
 
        @gnutls.log_func
 
1985
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
1986
        
 
1987
        @gnutls.library.types.gnutls_log_func
3180
1988
        def debug_gnutls(level, string):
3181
1989
            logger.debug("GnuTLS: %s", string[:-1])
3182
 
 
3183
 
        gnutls.global_set_log_function(debug_gnutls)
3184
 
 
 
1990
        
 
1991
        (gnutls.library.functions
 
1992
         .gnutls_global_set_log_function(debug_gnutls))
 
1993
        
3185
1994
        # Redirect stdin so all checkers get /dev/null
3186
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1995
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3187
1996
        os.dup2(null, sys.stdin.fileno())
3188
1997
        if null > 2:
3189
1998
            os.close(null)
3190
 
 
 
1999
    else:
 
2000
        # No console logging
 
2001
        logger.removeHandler(console)
 
2002
    
3191
2003
    # Need to fork before connecting to D-Bus
3192
 
    if not foreground:
 
2004
    if not debug:
3193
2005
        # Close all input and output, do double fork, etc.
3194
2006
        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
 
 
 
2007
    
3201
2008
    global main_loop
3202
2009
    # From the Avahi example code
3203
 
    DBusGMainLoop(set_as_default=True)
3204
 
    main_loop = GLib.MainLoop()
 
2010
    DBusGMainLoop(set_as_default=True )
 
2011
    main_loop = gobject.MainLoop()
3205
2012
    bus = dbus.SystemBus()
3206
2013
    # End of Avahi example code
3207
2014
    if use_dbus:
3208
2015
        try:
3209
2016
            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)
 
2017
                                            bus, do_not_queue=True)
 
2018
            old_bus_name = (dbus.service.BusName
 
2019
                            ("se.bsnet.fukt.Mandos", bus,
 
2020
                             do_not_queue=True))
 
2021
        except dbus.exceptions.NameExistsException as e:
 
2022
            logger.error(unicode(e) + ", disabling D-Bus")
3217
2023
            use_dbus = False
3218
2024
            server_settings["use_dbus"] = False
3219
2025
            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
 
 
 
2026
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2027
    service = AvahiService(name = server_settings["servicename"],
 
2028
                           servicetype = "_mandos._tcp",
 
2029
                           protocol = protocol, bus = bus)
 
2030
    if server_settings["interface"]:
 
2031
        service.interface = (if_nametoindex
 
2032
                             (str(server_settings["interface"])))
 
2033
    
3231
2034
    global multiprocessing_manager
3232
2035
    multiprocessing_manager = multiprocessing.Manager()
3233
 
 
 
2036
    
3234
2037
    client_class = Client
3235
2038
    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))
 
2039
        client_class = functools.partial(ClientDBusTransitional,
 
2040
                                         bus = bus)
 
2041
    def client_config_items(config, section):
 
2042
        special_settings = {
 
2043
            "approved_by_default":
 
2044
                lambda: config.getboolean(section,
 
2045
                                          "approved_by_default"),
 
2046
            }
 
2047
        for name, value in config.items(section):
3369
2048
            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
 
 
 
2049
                yield (name, special_settings[name]())
 
2050
            except KeyError:
 
2051
                yield (name, value)
 
2052
    
 
2053
    tcp_server.clients.update(set(
 
2054
            client_class(name = section,
 
2055
                         config= dict(client_config_items(
 
2056
                        client_config, section)))
 
2057
            for section in client_config.sections()))
3395
2058
    if not tcp_server.clients:
3396
2059
        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
 
2060
        
 
2061
    if not debug:
 
2062
        try:
 
2063
            with pidfile:
 
2064
                pid = os.getpid()
 
2065
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2066
            del pidfile
 
2067
        except IOError:
 
2068
            logger.error("Could not write to file %r with PID %d",
 
2069
                         pidfilename, pid)
 
2070
        except NameError:
 
2071
            # "pidfile" was never created
 
2072
            pass
3408
2073
        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
 
 
 
2074
        
 
2075
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
2076
    
 
2077
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
2078
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
2079
    
3414
2080
    if use_dbus:
3415
 
 
3416
 
        @alternate_dbus_interfaces(
3417
 
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3418
 
        class MandosDBusService(DBusObjectWithObjectManager):
 
2081
        class MandosDBusService(dbus.service.Object):
3419
2082
            """A D-Bus proxy object"""
3420
 
 
3421
2083
            def __init__(self):
3422
2084
                dbus.service.Object.__init__(self, bus, "/")
3423
 
 
3424
2085
            _interface = "se.recompile.Mandos"
3425
 
 
 
2086
            
3426
2087
            @dbus.service.signal(_interface, signature="o")
3427
2088
            def ClientAdded(self, objpath):
3428
2089
                "D-Bus signal"
3429
2090
                pass
3430
 
 
 
2091
            
3431
2092
            @dbus.service.signal(_interface, signature="ss")
3432
 
            def ClientNotFound(self, key_id, address):
 
2093
            def ClientNotFound(self, fingerprint, address):
3433
2094
                "D-Bus signal"
3434
2095
                pass
3435
 
 
3436
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3437
 
                               "true"})
 
2096
            
3438
2097
            @dbus.service.signal(_interface, signature="os")
3439
2098
            def ClientRemoved(self, objpath, name):
3440
2099
                "D-Bus signal"
3441
2100
                pass
3442
 
 
3443
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3444
 
                               "true"})
 
2101
            
3445
2102
            @dbus.service.method(_interface, out_signature="ao")
3446
2103
            def GetAllClients(self):
3447
2104
                "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"})
 
2105
                return dbus.Array(c.dbus_object_path
 
2106
                                  for c in tcp_server.clients)
 
2107
            
3453
2108
            @dbus.service.method(_interface,
3454
2109
                                 out_signature="a{oa{sv}}")
3455
2110
            def GetAllClientsWithProperties(self):
3456
2111
                "D-Bus method"
3457
2112
                return dbus.Dictionary(
3458
 
                    {c.dbus_object_path: c.GetAll(
3459
 
                        "se.recompile.Mandos.Client")
3460
 
                     for c in tcp_server.clients.values()},
 
2113
                    ((c.dbus_object_path, c.GetAll(""))
 
2114
                     for c in tcp_server.clients),
3461
2115
                    signature="oa{sv}")
3462
 
 
 
2116
            
3463
2117
            @dbus.service.method(_interface, in_signature="o")
3464
2118
            def RemoveClient(self, object_path):
3465
2119
                "D-Bus method"
3466
 
                for c in tcp_server.clients.values():
 
2120
                for c in tcp_server.clients:
3467
2121
                    if c.dbus_object_path == object_path:
3468
 
                        del tcp_server.clients[c.name]
 
2122
                        tcp_server.clients.remove(c)
3469
2123
                        c.remove_from_connection()
3470
 
                        # Don't signal the disabling
 
2124
                        # Don't signal anything except ClientRemoved
3471
2125
                        c.disable(quiet=True)
3472
 
                        # Emit D-Bus signal for removal
3473
 
                        self.client_removed_signal(c)
 
2126
                        # Emit D-Bus signal
 
2127
                        self.ClientRemoved(object_path, c.name)
3474
2128
                        return
3475
2129
                raise KeyError(object_path)
3476
 
 
 
2130
            
3477
2131
            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
 
 
 
2132
        
 
2133
        class MandosDBusServiceTransitional(MandosDBusService):
 
2134
            __metaclass__ = AlternateDBusNamesMetaclass
 
2135
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2136
    
3522
2137
    def cleanup():
3523
2138
        "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
 
2139
        service.cleanup()
 
2140
        
 
2141
        multiprocessing.active_children()
3586
2142
        while tcp_server.clients:
3587
 
            name, client = tcp_server.clients.popitem()
 
2143
            client = tcp_server.clients.pop()
3588
2144
            if use_dbus:
3589
2145
                client.remove_from_connection()
3590
 
            # Don't signal the disabling
 
2146
            client.disable_hook = None
 
2147
            # Don't signal anything except ClientRemoved
3591
2148
            client.disable(quiet=True)
3592
 
            # Emit D-Bus signal for removal
3593
2149
            if use_dbus:
3594
 
                mandos_dbus_service.client_removed_signal(client)
3595
 
        client_settings.clear()
3596
 
 
 
2150
                # Emit D-Bus signal
 
2151
                mandos_dbus_service.ClientRemoved(client
 
2152
                                                  .dbus_object_path,
 
2153
                                                  client.name)
 
2154
    
3597
2155
    atexit.register(cleanup)
3598
 
 
3599
 
    for client in tcp_server.clients.values():
 
2156
    
 
2157
    for client in tcp_server.clients:
3600
2158
        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
 
 
 
2159
            # Emit D-Bus signal
 
2160
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
2161
        client.enable()
 
2162
    
3607
2163
    tcp_server.enable()
3608
2164
    tcp_server.server_activate()
3609
 
 
 
2165
    
3610
2166
    # Find out what port we got
3611
 
    if zeroconf:
3612
 
        service.port = tcp_server.socket.getsockname()[1]
 
2167
    service.port = tcp_server.socket.getsockname()[1]
3613
2168
    if use_ipv6:
3614
2169
        logger.info("Now listening on address %r, port %d,"
3615
 
                    " flowinfo %d, scope_id %d",
3616
 
                    *tcp_server.socket.getsockname())
 
2170
                    " flowinfo %d, scope_id %d"
 
2171
                    % tcp_server.socket.getsockname())
3617
2172
    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
 
 
 
2173
        logger.info("Now listening on address %r, port %d"
 
2174
                    % tcp_server.socket.getsockname())
 
2175
    
 
2176
    #service.interface = tcp_server.socket.getsockname()[3]
 
2177
    
3623
2178
    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
 
 
 
2179
        # From the Avahi example code
 
2180
        try:
 
2181
            service.activate()
 
2182
        except dbus.exceptions.DBusException as error:
 
2183
            logger.critical("DBusException: %s", error)
 
2184
            cleanup()
 
2185
            sys.exit(1)
 
2186
        # End of Avahi example code
 
2187
        
 
2188
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
2189
                             lambda *args, **kwargs:
 
2190
                             (tcp_server.handle_request
 
2191
                              (*args[2:], **kwargs) or True))
 
2192
        
3640
2193
        logger.debug("Starting main loop")
3641
2194
        main_loop.run()
3642
2195
    except AvahiError as error:
3643
 
        logger.critical("Avahi Error", exc_info=error)
 
2196
        logger.critical("AvahiError: %s", error)
3644
2197
        cleanup()
3645
2198
        sys.exit(1)
3646
2199
    except KeyboardInterrupt:
3651
2204
    # Must run before the D-Bus bus name gets deregistered
3652
2205
    cleanup()
3653
2206
 
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
2207
 
3671
2208
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()
 
2209
    main()