/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

  • Committer: teddy at recompile
  • Date: 2020-02-07 20:53:34 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20200207205334-dp41p8c8vw0ytik5
Allow users to more easily alter mandos.service

The sysvinit script uses /etc/default/mandos as an environment file,
and supports adding additional server options to a DAEMON_ARGS
environment variable.  This should be supported by the systemd
service, too.

* mandos.service ([Service]/EnvironmentFile): New; set to
  "/etc/default/mandos ".
  ([Service]/ExecStart): Append "$DAEMON_ARGS".

Show diffs side-by-side

added added

removed removed

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