/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 Hogeborn
  • Date: 2019-08-24 14:46:13 UTC
  • Revision ID: teddy@recompile.se-20190824144613-z46mn4m8v5x2ifnj
Server: Show Python warnings

* mandos: Show Python warnings, and use the logging system to do it.

Show diffs side-by-side

added added

removed removed

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