/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2020-07-04 08:59:37 UTC
  • Revision ID: teddy@recompile.se-20200704085937-r495zb32nfng9lnt
In initramfs-tools boots, only use setsid when available

* initramfs-tools-script: If available, use setsid to start
  mandos-to-cryptroot-unlock.

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