/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: 2011-10-09 16:38:18 UTC
  • mfrom: (513 trunk)
  • mto: (237.4.29 release)
  • mto: This revision was merged to the branch mainline in revision 514.
  • Revision ID: teddy@recompile.se-20111009163818-ihb35bqq0iat18k2
Merge from trunk.

Show diffs side-by-side

added added

removed removed

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