/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2019-12-04 23:52:20 UTC
  • Revision ID: teddy@recompile.se-20191204235220-yn88brp0scmqwy2t
Remove non-project-specific pattern from .bzrignore

Only project-specific patterns should be in the .bzrignore file.
Other generic patterns should be in the ~/.config/breezy/ignore and
~/.bazaar/ignore files.

* .bzrignore (.tramp_history): Remove.

Show diffs side-by-side

added added

removed removed

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