/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2022-04-23 20:39:28 UTC
  • Revision ID: teddy@recompile.se-20220423203928-q2ngppp3pt7cfv4x
Makefile: Add comment about phase out of -lpthread

* Makefile (dracut-module/password-agent): Add comment about -lpthread
  being unnecessary in GNU C library 2.34 and later.

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