/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: 2015-07-20 03:03:33 UTC
  • Revision ID: teddy@recompile.se-20150720030333-203m2aeblypcsfte
Bug fix for GnuTLS 3: be compatible with old 2048-bit DSA keys.

The mandos-keygen program in Mandos version 1.6.0 and older generated
2048-bit DSA keys, and when GnuTLS uses these it has trouble
connecting using the Mandos default priority string.  This was
previously fixed in Mandos 1.6.2, but the bug reappeared when using
GnuTLS 3, so the default priority string has to change again; this
time also the Mandos client has to change its default, so now the
server and the client should use the same default priority string:

SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA:+SIGN-DSA-SHA256

* mandos (main/server_defaults): Changed default priority string.
* mandos-options.xml (/section/para[id="priority_compat"]): Removed.
  (/section/para[id="priority"]): Changed default priority string.
* mandos.conf ([DEFAULT]/priority): - '' -
* mandos.conf.xml (OPTIONS/priority): Refer to the id "priority"
                                      instead of "priority_compat".
* mandos.xml (OPTIONS/--priority): - '' -
* plugins.d/mandos-client.c (main): Changed default priority string.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
 
1
#!/usr/bin/python2.7
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2011 Teddy Hogeborn
15
 
# Copyright © 2008-2011 Björn Påhlsson
 
14
# Copyright © 2008-2015 Teddy Hogeborn
 
15
# Copyright © 2008-2015 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
31
# Contact the authors at <mandos@recompile.se>.
32
32
33
33
 
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
import SocketServer as socketserver
 
37
from future_builtins import *
 
38
 
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
38
43
import socket
39
44
import argparse
40
45
import datetime
45
50
import gnutls.library.functions
46
51
import gnutls.library.constants
47
52
import gnutls.library.types
48
 
import ConfigParser as configparser
 
53
try:
 
54
    import ConfigParser as configparser
 
55
except ImportError:
 
56
    import configparser
49
57
import sys
50
58
import re
51
59
import os
60
68
import struct
61
69
import fcntl
62
70
import functools
63
 
import cPickle as pickle
 
71
try:
 
72
    import cPickle as pickle
 
73
except ImportError:
 
74
    import pickle
64
75
import multiprocessing
65
76
import types
 
77
import binascii
 
78
import tempfile
 
79
import itertools
 
80
import collections
 
81
import codecs
66
82
 
67
83
import dbus
68
84
import dbus.service
69
 
import gobject
 
85
try:
 
86
    import gobject
 
87
except ImportError:
 
88
    from gi.repository import GObject as gobject
70
89
import avahi
71
90
from dbus.mainloop.glib import DBusGMainLoop
72
91
import ctypes
82
101
    except ImportError:
83
102
        SO_BINDTODEVICE = None
84
103
 
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)
 
104
if sys.version_info.major == 2:
 
105
    str = unicode
 
106
 
 
107
version = "1.6.9"
 
108
stored_state_file = "clients.pickle"
 
109
 
 
110
logger = logging.getLogger()
 
111
syslogger = None
 
112
 
 
113
try:
 
114
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
115
        ctypes.util.find_library("c")).if_nametoindex
 
116
except (OSError, AttributeError):
 
117
    
 
118
    def if_nametoindex(interface):
 
119
        "Get an interface index the hard way, i.e. using fcntl()"
 
120
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
121
        with contextlib.closing(socket.socket()) as s:
 
122
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
123
                                struct.pack(b"16s16x", interface))
 
124
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
125
        return interface_index
 
126
 
 
127
 
 
128
def initlogger(debug, level=logging.WARNING):
 
129
    """init logger and add loglevel"""
 
130
    
 
131
    global syslogger
 
132
    syslogger = (logging.handlers.SysLogHandler(
 
133
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
134
        address = "/dev/log"))
 
135
    syslogger.setFormatter(logging.Formatter
 
136
                           ('Mandos [%(process)d]: %(levelname)s:'
 
137
                            ' %(message)s'))
 
138
    logger.addHandler(syslogger)
 
139
    
 
140
    if debug:
 
141
        console = logging.StreamHandler()
 
142
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
143
                                               ' [%(process)d]:'
 
144
                                               ' %(levelname)s:'
 
145
                                               ' %(message)s'))
 
146
        logger.addHandler(console)
 
147
    logger.setLevel(level)
 
148
 
 
149
 
 
150
class PGPError(Exception):
 
151
    """Exception if encryption/decryption fails"""
 
152
    pass
 
153
 
 
154
 
 
155
class PGPEngine(object):
 
156
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
157
    
 
158
    def __init__(self):
 
159
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
160
        self.gnupgargs = ['--batch',
 
161
                          '--home', self.tempdir,
 
162
                          '--force-mdc',
 
163
                          '--quiet',
 
164
                          '--no-use-agent']
 
165
    
 
166
    def __enter__(self):
 
167
        return self
 
168
    
 
169
    def __exit__(self, exc_type, exc_value, traceback):
 
170
        self._cleanup()
 
171
        return False
 
172
    
 
173
    def __del__(self):
 
174
        self._cleanup()
 
175
    
 
176
    def _cleanup(self):
 
177
        if self.tempdir is not None:
 
178
            # Delete contents of tempdir
 
179
            for root, dirs, files in os.walk(self.tempdir,
 
180
                                             topdown = False):
 
181
                for filename in files:
 
182
                    os.remove(os.path.join(root, filename))
 
183
                for dirname in dirs:
 
184
                    os.rmdir(os.path.join(root, dirname))
 
185
            # Remove tempdir
 
186
            os.rmdir(self.tempdir)
 
187
            self.tempdir = None
 
188
    
 
189
    def password_encode(self, password):
 
190
        # Passphrase can not be empty and can not contain newlines or
 
191
        # NUL bytes.  So we prefix it and hex encode it.
 
192
        encoded = b"mandos" + binascii.hexlify(password)
 
193
        if len(encoded) > 2048:
 
194
            # GnuPG can't handle long passwords, so encode differently
 
195
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
196
                       .replace(b"\n", b"\\n")
 
197
                       .replace(b"\0", b"\\x00"))
 
198
        return encoded
 
199
    
 
200
    def encrypt(self, data, password):
 
201
        passphrase = self.password_encode(password)
 
202
        with tempfile.NamedTemporaryFile(
 
203
                dir=self.tempdir) as passfile:
 
204
            passfile.write(passphrase)
 
205
            passfile.flush()
 
206
            proc = subprocess.Popen(['gpg', '--symmetric',
 
207
                                     '--passphrase-file',
 
208
                                     passfile.name]
 
209
                                    + self.gnupgargs,
 
210
                                    stdin = subprocess.PIPE,
 
211
                                    stdout = subprocess.PIPE,
 
212
                                    stderr = subprocess.PIPE)
 
213
            ciphertext, err = proc.communicate(input = data)
 
214
        if proc.returncode != 0:
 
215
            raise PGPError(err)
 
216
        return ciphertext
 
217
    
 
218
    def decrypt(self, data, password):
 
219
        passphrase = self.password_encode(password)
 
220
        with tempfile.NamedTemporaryFile(
 
221
                dir = self.tempdir) as passfile:
 
222
            passfile.write(passphrase)
 
223
            passfile.flush()
 
224
            proc = subprocess.Popen(['gpg', '--decrypt',
 
225
                                     '--passphrase-file',
 
226
                                     passfile.name]
 
227
                                    + self.gnupgargs,
 
228
                                    stdin = subprocess.PIPE,
 
229
                                    stdout = subprocess.PIPE,
 
230
                                    stderr = subprocess.PIPE)
 
231
            decrypted_plaintext, err = proc.communicate(input = data)
 
232
        if proc.returncode != 0:
 
233
            raise PGPError(err)
 
234
        return decrypted_plaintext
 
235
 
103
236
 
104
237
class AvahiError(Exception):
105
238
    def __init__(self, value, *args, **kwargs):
106
239
        self.value = value
107
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
108
 
    def __unicode__(self):
109
 
        return unicode(repr(self.value))
 
240
        return super(AvahiError, self).__init__(value, *args,
 
241
                                                **kwargs)
 
242
 
110
243
 
111
244
class AvahiServiceError(AvahiError):
112
245
    pass
113
246
 
 
247
 
114
248
class AvahiGroupError(AvahiError):
115
249
    pass
116
250
 
123
257
               Used to optionally bind to the specified interface.
124
258
    name: string; Example: 'Mandos'
125
259
    type: string; Example: '_mandos._tcp'.
126
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
260
     See <https://www.iana.org/assignments/service-names-port-numbers>
127
261
    port: integer; what port to announce
128
262
    TXT: list of strings; TXT record for the service
129
263
    domain: string; Domain to publish on, default to .local if empty.
135
269
    server: D-Bus Server
136
270
    bus: dbus.SystemBus()
137
271
    """
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):
 
272
    
 
273
    def __init__(self,
 
274
                 interface = avahi.IF_UNSPEC,
 
275
                 name = None,
 
276
                 servicetype = None,
 
277
                 port = None,
 
278
                 TXT = None,
 
279
                 domain = "",
 
280
                 host = "",
 
281
                 max_renames = 32768,
 
282
                 protocol = avahi.PROTO_UNSPEC,
 
283
                 bus = None):
142
284
        self.interface = interface
143
285
        self.name = name
144
286
        self.type = servicetype
153
295
        self.server = None
154
296
        self.bus = bus
155
297
        self.entry_group_state_changed_match = None
156
 
    def rename(self):
 
298
    
 
299
    def rename(self, remove=True):
157
300
        """Derived from the Avahi example code"""
158
301
        if self.rename_count >= self.max_renames:
159
302
            logger.critical("No suitable Zeroconf service name found"
160
303
                            " after %i retries, exiting.",
161
304
                            self.rename_count)
162
305
            raise AvahiServiceError("Too many renames")
163
 
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
 
306
        self.name = str(
 
307
            self.server.GetAlternativeServiceName(self.name))
 
308
        self.rename_count += 1
164
309
        logger.info("Changing Zeroconf service name to %r ...",
165
310
                    self.name)
166
 
        syslogger.setFormatter(logging.Formatter
167
 
                               ('Mandos (%s) [%%(process)d]:'
168
 
                                ' %%(levelname)s: %%(message)s'
169
 
                                % self.name))
170
 
        self.remove()
 
311
        if remove:
 
312
            self.remove()
171
313
        try:
172
314
            self.add()
173
315
        except dbus.exceptions.DBusException as error:
174
 
            logger.critical("DBusException: %s", error)
175
 
            self.cleanup()
176
 
            os._exit(1)
177
 
        self.rename_count += 1
 
316
            if (error.get_dbus_name()
 
317
                == "org.freedesktop.Avahi.CollisionError"):
 
318
                logger.info("Local Zeroconf service name collision.")
 
319
                return self.rename(remove=False)
 
320
            else:
 
321
                logger.critical("D-Bus Exception", exc_info=error)
 
322
                self.cleanup()
 
323
                os._exit(1)
 
324
    
178
325
    def remove(self):
179
326
        """Derived from the Avahi example code"""
180
327
        if self.entry_group_state_changed_match is not None:
182
329
            self.entry_group_state_changed_match = None
183
330
        if self.group is not None:
184
331
            self.group.Reset()
 
332
    
185
333
    def add(self):
186
334
        """Derived from the Avahi example code"""
187
335
        self.remove()
192
340
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
193
341
        self.entry_group_state_changed_match = (
194
342
            self.group.connect_to_signal(
195
 
                'StateChanged', self .entry_group_state_changed))
 
343
                'StateChanged', self.entry_group_state_changed))
196
344
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
197
345
                     self.name, self.type)
198
346
        self.group.AddService(
204
352
            dbus.UInt16(self.port),
205
353
            avahi.string_array_to_txt_array(self.TXT))
206
354
        self.group.Commit()
 
355
    
207
356
    def entry_group_state_changed(self, state, error):
208
357
        """Derived from the Avahi example code"""
209
358
        logger.debug("Avahi entry group state change: %i", state)
215
364
            self.rename()
216
365
        elif state == avahi.ENTRY_GROUP_FAILURE:
217
366
            logger.critical("Avahi: Error in group state changed %s",
218
 
                            unicode(error))
219
 
            raise AvahiGroupError("State changed: %s"
220
 
                                  % unicode(error))
 
367
                            str(error))
 
368
            raise AvahiGroupError("State changed: {!s}".format(error))
 
369
    
221
370
    def cleanup(self):
222
371
        """Derived from the Avahi example code"""
223
372
        if self.group is not None:
224
373
            try:
225
374
                self.group.Free()
226
375
            except (dbus.exceptions.UnknownMethodException,
227
 
                    dbus.exceptions.DBusException) as e:
 
376
                    dbus.exceptions.DBusException):
228
377
                pass
229
378
            self.group = None
230
379
        self.remove()
 
380
    
231
381
    def server_state_changed(self, state, error=None):
232
382
        """Derived from the Avahi example code"""
233
383
        logger.debug("Avahi server state change: %i", state)
234
 
        bad_states = { avahi.SERVER_INVALID:
235
 
                           "Zeroconf server invalid",
236
 
                       avahi.SERVER_REGISTERING: None,
237
 
                       avahi.SERVER_COLLISION:
238
 
                           "Zeroconf server name collision",
239
 
                       avahi.SERVER_FAILURE:
240
 
                           "Zeroconf server failure" }
 
384
        bad_states = {
 
385
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
386
            avahi.SERVER_REGISTERING: None,
 
387
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
388
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
389
        }
241
390
        if state in bad_states:
242
391
            if bad_states[state] is not None:
243
392
                if error is None:
246
395
                    logger.error(bad_states[state] + ": %r", error)
247
396
            self.cleanup()
248
397
        elif state == avahi.SERVER_RUNNING:
249
 
            self.add()
 
398
            try:
 
399
                self.add()
 
400
            except dbus.exceptions.DBusException as error:
 
401
                if (error.get_dbus_name()
 
402
                    == "org.freedesktop.Avahi.CollisionError"):
 
403
                    logger.info("Local Zeroconf service name"
 
404
                                " collision.")
 
405
                    return self.rename(remove=False)
 
406
                else:
 
407
                    logger.critical("D-Bus Exception", exc_info=error)
 
408
                    self.cleanup()
 
409
                    os._exit(1)
250
410
        else:
251
411
            if error is None:
252
412
                logger.debug("Unknown state: %r", state)
253
413
            else:
254
414
                logger.debug("Unknown state: %r: %r", state, error)
 
415
    
255
416
    def activate(self):
256
417
        """Derived from the Avahi example code"""
257
418
        if self.server is None:
261
422
                                    follow_name_owner_changes=True),
262
423
                avahi.DBUS_INTERFACE_SERVER)
263
424
        self.server.connect_to_signal("StateChanged",
264
 
                                 self.server_state_changed)
 
425
                                      self.server_state_changed)
265
426
        self.server_state_changed(self.server.GetState())
266
427
 
267
428
 
268
 
def _timedelta_to_milliseconds(td):
269
 
    "Convert a datetime.timedelta() to milliseconds"
270
 
    return ((td.days * 24 * 60 * 60 * 1000)
271
 
            + (td.seconds * 1000)
272
 
            + (td.microseconds // 1000))
273
 
        
 
429
class AvahiServiceToSyslog(AvahiService):
 
430
    def rename(self, *args, **kwargs):
 
431
        """Add the new name to the syslog messages"""
 
432
        ret = AvahiService.rename(self, *args, **kwargs)
 
433
        syslogger.setFormatter(logging.Formatter(
 
434
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
435
            .format(self.name)))
 
436
        return ret
 
437
 
 
438
def call_pipe(connection,       # : multiprocessing.Connection
 
439
              func, *args, **kwargs):
 
440
    """This function is meant to be called by multiprocessing.Process
 
441
    
 
442
    This function runs func(*args, **kwargs), and writes the resulting
 
443
    return value on the provided multiprocessing.Connection.
 
444
    """
 
445
    connection.send(func(*args, **kwargs))
 
446
    connection.close()
 
447
 
274
448
class Client(object):
275
449
    """A representation of a client host served by this server.
276
450
    
277
451
    Attributes:
278
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
452
    approved:   bool(); 'None' if not yet approved/disapproved
279
453
    approval_delay: datetime.timedelta(); Time to wait for approval
280
454
    approval_duration: datetime.timedelta(); Duration of one approval
281
455
    checker:    subprocess.Popen(); a running checker process used
288
462
                     instance %(name)s can be used in the command.
289
463
    checker_initiator_tag: a gobject event source tag, or None
290
464
    created:    datetime.datetime(); (UTC) object creation
 
465
    client_structure: Object describing what attributes a client has
 
466
                      and is used for storing the client at exit
291
467
    current_checker_command: string; current running checker_command
292
 
    disable_hook:  If set, called by disable() as disable_hook(self)
293
468
    disable_initiator_tag: a gobject event source tag, or None
294
469
    enabled:    bool()
295
470
    fingerprint: string (40 or 32 hexadecimal digits); used to
298
473
    interval:   datetime.timedelta(); How often to start a new checker
299
474
    last_approval_request: datetime.datetime(); (UTC) or None
300
475
    last_checked_ok: datetime.datetime(); (UTC) or None
301
 
    last_enabled: datetime.datetime(); (UTC)
 
476
    last_checker_status: integer between 0 and 255 reflecting exit
 
477
                         status of last checker. -1 reflects crashed
 
478
                         checker, -2 means no checker completed yet.
 
479
    last_checker_signal: The signal which killed the last checker, if
 
480
                         last_checker_status is -1
 
481
    last_enabled: datetime.datetime(); (UTC) or None
302
482
    name:       string; from the config file, used in log messages and
303
483
                        D-Bus identifiers
304
484
    secret:     bytestring; sent verbatim (over TLS) to client
305
485
    timeout:    datetime.timedelta(); How long from last_checked_ok
306
486
                                      until this client is disabled
307
 
    extended_timeout:   extra long timeout when password has been sent
 
487
    extended_timeout:   extra long timeout when secret has been sent
308
488
    runtime_expansions: Allowed attributes for runtime expansion.
309
489
    expires:    datetime.datetime(); time (UTC) when a client will be
310
490
                disabled, or None
 
491
    server_settings: The server_settings dict from main()
311
492
    """
312
493
    
313
494
    runtime_expansions = ("approval_delay", "approval_duration",
314
 
                          "created", "enabled", "fingerprint",
315
 
                          "host", "interval", "last_checked_ok",
 
495
                          "created", "enabled", "expires",
 
496
                          "fingerprint", "host", "interval",
 
497
                          "last_approval_request", "last_checked_ok",
316
498
                          "last_enabled", "name", "timeout")
317
 
    
318
 
    def timeout_milliseconds(self):
319
 
        "Return the 'timeout' attribute in milliseconds"
320
 
        return _timedelta_to_milliseconds(self.timeout)
321
 
    
322
 
    def extended_timeout_milliseconds(self):
323
 
        "Return the 'extended_timeout' attribute in milliseconds"
324
 
        return _timedelta_to_milliseconds(self.extended_timeout)    
325
 
    
326
 
    def interval_milliseconds(self):
327
 
        "Return the 'interval' attribute in milliseconds"
328
 
        return _timedelta_to_milliseconds(self.interval)
329
 
    
330
 
    def approval_delay_milliseconds(self):
331
 
        return _timedelta_to_milliseconds(self.approval_delay)
332
 
    
333
 
    def __init__(self, name = None, disable_hook=None, config=None):
334
 
        """Note: the 'checker' key in 'config' sets the
335
 
        'checker_command' attribute and *not* the 'checker'
336
 
        attribute."""
 
499
    client_defaults = {
 
500
        "timeout": "PT5M",
 
501
        "extended_timeout": "PT15M",
 
502
        "interval": "PT2M",
 
503
        "checker": "fping -q -- %%(host)s",
 
504
        "host": "",
 
505
        "approval_delay": "PT0S",
 
506
        "approval_duration": "PT1S",
 
507
        "approved_by_default": "True",
 
508
        "enabled": "True",
 
509
    }
 
510
    
 
511
    @staticmethod
 
512
    def config_parser(config):
 
513
        """Construct a new dict of client settings of this form:
 
514
        { client_name: {setting_name: value, ...}, ...}
 
515
        with exceptions for any special settings as defined above.
 
516
        NOTE: Must be a pure function. Must return the same result
 
517
        value given the same arguments.
 
518
        """
 
519
        settings = {}
 
520
        for client_name in config.sections():
 
521
            section = dict(config.items(client_name))
 
522
            client = settings[client_name] = {}
 
523
            
 
524
            client["host"] = section["host"]
 
525
            # Reformat values from string types to Python types
 
526
            client["approved_by_default"] = config.getboolean(
 
527
                client_name, "approved_by_default")
 
528
            client["enabled"] = config.getboolean(client_name,
 
529
                                                  "enabled")
 
530
            
 
531
            # Uppercase and remove spaces from fingerprint for later
 
532
            # comparison purposes with return value from the
 
533
            # fingerprint() function
 
534
            client["fingerprint"] = (section["fingerprint"].upper()
 
535
                                     .replace(" ", ""))
 
536
            if "secret" in section:
 
537
                client["secret"] = section["secret"].decode("base64")
 
538
            elif "secfile" in section:
 
539
                with open(os.path.expanduser(os.path.expandvars
 
540
                                             (section["secfile"])),
 
541
                          "rb") as secfile:
 
542
                    client["secret"] = secfile.read()
 
543
            else:
 
544
                raise TypeError("No secret or secfile for section {}"
 
545
                                .format(section))
 
546
            client["timeout"] = string_to_delta(section["timeout"])
 
547
            client["extended_timeout"] = string_to_delta(
 
548
                section["extended_timeout"])
 
549
            client["interval"] = string_to_delta(section["interval"])
 
550
            client["approval_delay"] = string_to_delta(
 
551
                section["approval_delay"])
 
552
            client["approval_duration"] = string_to_delta(
 
553
                section["approval_duration"])
 
554
            client["checker_command"] = section["checker"]
 
555
            client["last_approval_request"] = None
 
556
            client["last_checked_ok"] = None
 
557
            client["last_checker_status"] = -2
 
558
        
 
559
        return settings
 
560
    
 
561
    def __init__(self, settings, name = None, server_settings=None):
337
562
        self.name = name
338
 
        if config is None:
339
 
            config = {}
 
563
        if server_settings is None:
 
564
            server_settings = {}
 
565
        self.server_settings = server_settings
 
566
        # adding all client settings
 
567
        for setting, value in settings.items():
 
568
            setattr(self, setting, value)
 
569
        
 
570
        if self.enabled:
 
571
            if not hasattr(self, "last_enabled"):
 
572
                self.last_enabled = datetime.datetime.utcnow()
 
573
            if not hasattr(self, "expires"):
 
574
                self.expires = (datetime.datetime.utcnow()
 
575
                                + self.timeout)
 
576
        else:
 
577
            self.last_enabled = None
 
578
            self.expires = None
 
579
        
340
580
        logger.debug("Creating client %r", self.name)
341
 
        # Uppercase and remove spaces from fingerprint for later
342
 
        # comparison purposes with return value from the fingerprint()
343
 
        # function
344
 
        self.fingerprint = (config["fingerprint"].upper()
345
 
                            .replace(" ", ""))
346
581
        logger.debug("  Fingerprint: %s", self.fingerprint)
347
 
        if "secret" in config:
348
 
            self.secret = config["secret"].decode("base64")
349
 
        elif "secfile" in config:
350
 
            with open(os.path.expanduser(os.path.expandvars
351
 
                                         (config["secfile"])),
352
 
                      "rb") as secfile:
353
 
                self.secret = secfile.read()
354
 
        else:
355
 
            raise TypeError("No secret or secfile for client %s"
356
 
                            % self.name)
357
 
        self.host = config.get("host", "")
358
 
        self.created = datetime.datetime.utcnow()
359
 
        self.enabled = False
360
 
        self.last_approval_request = None
361
 
        self.last_enabled = None
362
 
        self.last_checked_ok = None
363
 
        self.timeout = string_to_delta(config["timeout"])
364
 
        self.extended_timeout = string_to_delta(config["extended_timeout"])
365
 
        self.interval = string_to_delta(config["interval"])
366
 
        self.disable_hook = disable_hook
 
582
        self.created = settings.get("created",
 
583
                                    datetime.datetime.utcnow())
 
584
        
 
585
        # attributes specific for this server instance
367
586
        self.checker = None
368
587
        self.checker_initiator_tag = None
369
588
        self.disable_initiator_tag = None
370
 
        self.expires = None
371
589
        self.checker_callback_tag = None
372
 
        self.checker_command = config["checker"]
373
590
        self.current_checker_command = None
374
 
        self.last_connect = None
375
 
        self._approved = None
376
 
        self.approved_by_default = config.get("approved_by_default",
377
 
                                              True)
 
591
        self.approved = None
378
592
        self.approvals_pending = 0
379
 
        self.approval_delay = string_to_delta(
380
 
            config["approval_delay"])
381
 
        self.approval_duration = string_to_delta(
382
 
            config["approval_duration"])
383
 
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
 
593
        self.changedstate = multiprocessing_manager.Condition(
 
594
            multiprocessing_manager.Lock())
 
595
        self.client_structure = [attr
 
596
                                 for attr in self.__dict__.iterkeys()
 
597
                                 if not attr.startswith("_")]
 
598
        self.client_structure.append("client_structure")
 
599
        
 
600
        for name, t in inspect.getmembers(
 
601
                type(self), lambda obj: isinstance(obj, property)):
 
602
            if not name.startswith("_"):
 
603
                self.client_structure.append(name)
384
604
    
 
605
    # Send notice to process children that client state has changed
385
606
    def send_changedstate(self):
386
 
        self.changedstate.acquire()
387
 
        self.changedstate.notify_all()
388
 
        self.changedstate.release()
389
 
        
 
607
        with self.changedstate:
 
608
            self.changedstate.notify_all()
 
609
    
390
610
    def enable(self):
391
611
        """Start this client's checker and timeout hooks"""
392
612
        if getattr(self, "enabled", False):
393
613
            # Already enabled
394
614
            return
395
 
        self.send_changedstate()
396
 
        # Schedule a new checker to be started an 'interval' from now,
397
 
        # and every interval from then on.
398
 
        self.checker_initiator_tag = (gobject.timeout_add
399
 
                                      (self.interval_milliseconds(),
400
 
                                       self.start_checker))
401
 
        # Schedule a disable() when 'timeout' has passed
402
615
        self.expires = datetime.datetime.utcnow() + self.timeout
403
 
        self.disable_initiator_tag = (gobject.timeout_add
404
 
                                   (self.timeout_milliseconds(),
405
 
                                    self.disable))
406
616
        self.enabled = True
407
617
        self.last_enabled = datetime.datetime.utcnow()
408
 
        # Also start a new checker *right now*.
409
 
        self.start_checker()
 
618
        self.init_checker()
 
619
        self.send_changedstate()
410
620
    
411
621
    def disable(self, quiet=True):
412
622
        """Disable this client."""
413
623
        if not getattr(self, "enabled", False):
414
624
            return False
415
625
        if not quiet:
416
 
            self.send_changedstate()
417
 
        if not quiet:
418
626
            logger.info("Disabling client %s", self.name)
419
 
        if getattr(self, "disable_initiator_tag", False):
 
627
        if getattr(self, "disable_initiator_tag", None) is not None:
420
628
            gobject.source_remove(self.disable_initiator_tag)
421
629
            self.disable_initiator_tag = None
422
630
        self.expires = None
423
 
        if getattr(self, "checker_initiator_tag", False):
 
631
        if getattr(self, "checker_initiator_tag", None) is not None:
424
632
            gobject.source_remove(self.checker_initiator_tag)
425
633
            self.checker_initiator_tag = None
426
634
        self.stop_checker()
427
 
        if self.disable_hook:
428
 
            self.disable_hook(self)
429
635
        self.enabled = False
 
636
        if not quiet:
 
637
            self.send_changedstate()
430
638
        # Do not run this again if called by a gobject.timeout_add
431
639
        return False
432
640
    
433
641
    def __del__(self):
434
 
        self.disable_hook = None
435
642
        self.disable()
436
643
    
437
 
    def checker_callback(self, pid, condition, command):
 
644
    def init_checker(self):
 
645
        # Schedule a new checker to be started an 'interval' from now,
 
646
        # and every interval from then on.
 
647
        if self.checker_initiator_tag is not None:
 
648
            gobject.source_remove(self.checker_initiator_tag)
 
649
        self.checker_initiator_tag = gobject.timeout_add(
 
650
            int(self.interval.total_seconds() * 1000),
 
651
            self.start_checker)
 
652
        # Schedule a disable() when 'timeout' has passed
 
653
        if self.disable_initiator_tag is not None:
 
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
        self.disable_initiator_tag = gobject.timeout_add(
 
656
            int(self.timeout.total_seconds() * 1000), self.disable)
 
657
        # Also start a new checker *right now*.
 
658
        self.start_checker()
 
659
    
 
660
    def checker_callback(self, source, condition, connection,
 
661
                         command):
438
662
        """The checker has completed, so take appropriate actions."""
439
663
        self.checker_callback_tag = None
440
664
        self.checker = None
441
 
        if os.WIFEXITED(condition):
442
 
            exitstatus = os.WEXITSTATUS(condition)
443
 
            if exitstatus == 0:
 
665
        # Read return code from connection (see call_pipe)
 
666
        returncode = connection.recv()
 
667
        connection.close()
 
668
        
 
669
        if returncode >= 0:
 
670
            self.last_checker_status = returncode
 
671
            self.last_checker_signal = None
 
672
            if self.last_checker_status == 0:
444
673
                logger.info("Checker for %(name)s succeeded",
445
674
                            vars(self))
446
675
                self.checked_ok()
447
676
            else:
448
 
                logger.info("Checker for %(name)s failed",
449
 
                            vars(self))
 
677
                logger.info("Checker for %(name)s failed", vars(self))
450
678
        else:
 
679
            self.last_checker_status = -1
 
680
            self.last_checker_signal = -returncode
451
681
            logger.warning("Checker for %(name)s crashed?",
452
682
                           vars(self))
453
 
    
454
 
    def checked_ok(self, timeout=None):
455
 
        """Bump up the timeout for this client.
456
 
        
457
 
        This should only be called when the client has been seen,
458
 
        alive and well.
459
 
        """
 
683
        return False
 
684
    
 
685
    def checked_ok(self):
 
686
        """Assert that the client has been seen, alive and well."""
 
687
        self.last_checked_ok = datetime.datetime.utcnow()
 
688
        self.last_checker_status = 0
 
689
        self.last_checker_signal = None
 
690
        self.bump_timeout()
 
691
    
 
692
    def bump_timeout(self, timeout=None):
 
693
        """Bump up the timeout for this client."""
460
694
        if timeout is None:
461
695
            timeout = self.timeout
462
 
        self.last_checked_ok = datetime.datetime.utcnow()
463
 
        gobject.source_remove(self.disable_initiator_tag)
464
 
        self.expires = datetime.datetime.utcnow() + timeout
465
 
        self.disable_initiator_tag = (gobject.timeout_add
466
 
                                      (_timedelta_to_milliseconds(timeout),
467
 
                                       self.disable))
 
696
        if self.disable_initiator_tag is not None:
 
697
            gobject.source_remove(self.disable_initiator_tag)
 
698
            self.disable_initiator_tag = None
 
699
        if getattr(self, "enabled", False):
 
700
            self.disable_initiator_tag = gobject.timeout_add(
 
701
                int(timeout.total_seconds() * 1000), self.disable)
 
702
            self.expires = datetime.datetime.utcnow() + timeout
468
703
    
469
704
    def need_approval(self):
470
705
        self.last_approval_request = datetime.datetime.utcnow()
475
710
        If a checker already exists, leave it running and do
476
711
        nothing."""
477
712
        # The reason for not killing a running checker is that if we
478
 
        # did that, then if a checker (for some reason) started
479
 
        # running slowly and taking more than 'interval' time, the
480
 
        # client would inevitably timeout, since no checker would get
481
 
        # a chance to run to completion.  If we instead leave running
 
713
        # did that, and if a checker (for some reason) started running
 
714
        # slowly and taking more than 'interval' time, then the client
 
715
        # would inevitably timeout, since no checker would get a
 
716
        # chance to run to completion.  If we instead leave running
482
717
        # checkers alone, the checker would have to take more time
483
718
        # than 'timeout' for the client to be disabled, which is as it
484
719
        # should be.
485
720
        
486
 
        # If a checker exists, make sure it is not a zombie
487
 
        try:
488
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
489
 
        except (AttributeError, OSError) as error:
490
 
            if (isinstance(error, OSError)
491
 
                and error.errno != errno.ECHILD):
492
 
                raise error
493
 
        else:
494
 
            if pid:
495
 
                logger.warning("Checker was a zombie")
496
 
                gobject.source_remove(self.checker_callback_tag)
497
 
                self.checker_callback(pid, status,
498
 
                                      self.current_checker_command)
 
721
        if self.checker is not None and not self.checker.is_alive():
 
722
            logger.warning("Checker was not alive; joining")
 
723
            self.checker.join()
 
724
            self.checker = None
499
725
        # Start a new checker if needed
500
726
        if self.checker is None:
 
727
            # Escape attributes for the shell
 
728
            escaped_attrs = {
 
729
                attr: re.escape(str(getattr(self, attr)))
 
730
                for attr in self.runtime_expansions }
501
731
            try:
502
 
                # In case checker_command has exactly one % operator
503
 
                command = self.checker_command % self.host
504
 
            except TypeError:
505
 
                # Escape attributes for the shell
506
 
                escaped_attrs = dict(
507
 
                    (attr,
508
 
                     re.escape(unicode(str(getattr(self, attr, "")),
509
 
                                       errors=
510
 
                                       'replace')))
511
 
                    for attr in
512
 
                    self.runtime_expansions)
513
 
                
514
 
                try:
515
 
                    command = self.checker_command % escaped_attrs
516
 
                except TypeError as error:
517
 
                    logger.error('Could not format string "%s":'
518
 
                                 ' %s', self.checker_command, error)
519
 
                    return True # Try again later
 
732
                command = self.checker_command % escaped_attrs
 
733
            except TypeError as error:
 
734
                logger.error('Could not format string "%s"',
 
735
                             self.checker_command,
 
736
                             exc_info=error)
 
737
                return True     # Try again later
520
738
            self.current_checker_command = command
521
 
            try:
522
 
                logger.info("Starting checker %r for %s",
523
 
                            command, self.name)
524
 
                # We don't need to redirect stdout and stderr, since
525
 
                # in normal mode, that is already done by daemon(),
526
 
                # and in debug mode we don't want to.  (Stdin is
527
 
                # always replaced by /dev/null.)
528
 
                self.checker = subprocess.Popen(command,
529
 
                                                close_fds=True,
530
 
                                                shell=True, cwd="/")
531
 
                self.checker_callback_tag = (gobject.child_watch_add
532
 
                                             (self.checker.pid,
533
 
                                              self.checker_callback,
534
 
                                              data=command))
535
 
                # The checker may have completed before the gobject
536
 
                # watch was added.  Check for this.
537
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
538
 
                if pid:
539
 
                    gobject.source_remove(self.checker_callback_tag)
540
 
                    self.checker_callback(pid, status, command)
541
 
            except OSError as error:
542
 
                logger.error("Failed to start subprocess: %s",
543
 
                             error)
 
739
            logger.info("Starting checker %r for %s", command,
 
740
                        self.name)
 
741
            # We don't need to redirect stdout and stderr, since
 
742
            # in normal mode, that is already done by daemon(),
 
743
            # and in debug mode we don't want to.  (Stdin is
 
744
            # always replaced by /dev/null.)
 
745
            # The exception is when not debugging but nevertheless
 
746
            # running in the foreground; use the previously
 
747
            # created wnull.
 
748
            popen_args = { "close_fds": True,
 
749
                           "shell": True,
 
750
                           "cwd": "/" }
 
751
            if (not self.server_settings["debug"]
 
752
                and self.server_settings["foreground"]):
 
753
                popen_args.update({"stdout": wnull,
 
754
                                   "stderr": wnull })
 
755
            pipe = multiprocessing.Pipe(duplex = False)
 
756
            self.checker = multiprocessing.Process(
 
757
                target = call_pipe,
 
758
                args = (pipe[1], subprocess.call, command),
 
759
                kwargs = popen_args)
 
760
            self.checker.start()
 
761
            self.checker_callback_tag = gobject.io_add_watch(
 
762
                pipe[0].fileno(), gobject.IO_IN,
 
763
                self.checker_callback, pipe[0], command)
544
764
        # Re-run this periodically if run by gobject.timeout_add
545
765
        return True
546
766
    
552
772
        if getattr(self, "checker", None) is None:
553
773
            return
554
774
        logger.debug("Stopping checker for %(name)s", vars(self))
555
 
        try:
556
 
            os.kill(self.checker.pid, signal.SIGTERM)
557
 
            #time.sleep(0.5)
558
 
            #if self.checker.poll() is None:
559
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
560
 
        except OSError as error:
561
 
            if error.errno != errno.ESRCH: # No such process
562
 
                raise
 
775
        self.checker.terminate()
563
776
        self.checker = None
564
777
 
565
778
 
566
 
def dbus_service_property(dbus_interface, signature="v",
567
 
                          access="readwrite", byte_arrays=False):
 
779
def dbus_service_property(dbus_interface,
 
780
                          signature="v",
 
781
                          access="readwrite",
 
782
                          byte_arrays=False):
568
783
    """Decorators for marking methods of a DBusObjectWithProperties to
569
784
    become properties on the D-Bus.
570
785
    
579
794
    # "Set" method, so we fail early here:
580
795
    if byte_arrays and signature != "ay":
581
796
        raise ValueError("Byte arrays not supported for non-'ay'"
582
 
                         " signature %r" % signature)
 
797
                         " signature {!r}".format(signature))
 
798
    
583
799
    def decorator(func):
584
800
        func._dbus_is_property = True
585
801
        func._dbus_interface = dbus_interface
590
806
            func._dbus_name = func._dbus_name[:-14]
591
807
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
592
808
        return func
 
809
    
 
810
    return decorator
 
811
 
 
812
 
 
813
def dbus_interface_annotations(dbus_interface):
 
814
    """Decorator for marking functions returning interface annotations
 
815
    
 
816
    Usage:
 
817
    
 
818
    @dbus_interface_annotations("org.example.Interface")
 
819
    def _foo(self):  # Function name does not matter
 
820
        return {"org.freedesktop.DBus.Deprecated": "true",
 
821
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
822
                    "false"}
 
823
    """
 
824
    
 
825
    def decorator(func):
 
826
        func._dbus_is_interface = True
 
827
        func._dbus_interface = dbus_interface
 
828
        func._dbus_name = dbus_interface
 
829
        return func
 
830
    
 
831
    return decorator
 
832
 
 
833
 
 
834
def dbus_annotations(annotations):
 
835
    """Decorator to annotate D-Bus methods, signals or properties
 
836
    Usage:
 
837
    
 
838
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
839
                       "org.freedesktop.DBus.Property."
 
840
                       "EmitsChangedSignal": "false"})
 
841
    @dbus_service_property("org.example.Interface", signature="b",
 
842
                           access="r")
 
843
    def Property_dbus_property(self):
 
844
        return dbus.Boolean(False)
 
845
    """
 
846
    
 
847
    def decorator(func):
 
848
        func._dbus_annotations = annotations
 
849
        return func
 
850
    
593
851
    return decorator
594
852
 
595
853
 
596
854
class DBusPropertyException(dbus.exceptions.DBusException):
597
855
    """A base class for D-Bus property-related exceptions
598
856
    """
599
 
    def __unicode__(self):
600
 
        return unicode(str(self))
 
857
    pass
601
858
 
602
859
 
603
860
class DBusPropertyAccessException(DBusPropertyException):
621
878
    """
622
879
    
623
880
    @staticmethod
624
 
    def _is_dbus_property(obj):
625
 
        return getattr(obj, "_dbus_is_property", False)
 
881
    def _is_dbus_thing(thing):
 
882
        """Returns a function testing if an attribute is a D-Bus thing
 
883
        
 
884
        If called like _is_dbus_thing("method") it returns a function
 
885
        suitable for use as predicate to inspect.getmembers().
 
886
        """
 
887
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
888
                                   False)
626
889
    
627
 
    def _get_all_dbus_properties(self):
 
890
    def _get_all_dbus_things(self, thing):
628
891
        """Returns a generator of (name, attribute) pairs
629
892
        """
630
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
893
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
894
                 athing.__get__(self))
631
895
                for cls in self.__class__.__mro__
632
 
                for name, prop in inspect.getmembers(cls, self._is_dbus_property))
 
896
                for name, athing in
 
897
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
633
898
    
634
899
    def _get_dbus_property(self, interface_name, property_name):
635
900
        """Returns a bound method if one exists which is a D-Bus
636
901
        property with the specified name and interface.
637
902
        """
638
 
        for cls in  self.__class__.__mro__:
639
 
            for name, value in inspect.getmembers(cls, self._is_dbus_property):
640
 
                if value._dbus_name == property_name and value._dbus_interface == interface_name:
 
903
        for cls in self.__class__.__mro__:
 
904
            for name, value in inspect.getmembers(
 
905
                    cls, self._is_dbus_thing("property")):
 
906
                if (value._dbus_name == property_name
 
907
                    and value._dbus_interface == interface_name):
641
908
                    return value.__get__(self)
642
909
        
643
910
        # No such property
644
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
645
 
                                   + interface_name + "."
646
 
                                   + property_name)
647
 
 
 
911
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
912
            self.dbus_object_path, interface_name, property_name))
648
913
    
649
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
914
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
915
                         in_signature="ss",
650
916
                         out_signature="v")
651
917
    def Get(self, interface_name, property_name):
652
918
        """Standard D-Bus property Get() method, see D-Bus standard.
670
936
            # The byte_arrays option is not supported yet on
671
937
            # signatures other than "ay".
672
938
            if prop._dbus_signature != "ay":
673
 
                raise ValueError
674
 
            value = dbus.ByteArray(''.join(unichr(byte)
675
 
                                           for byte in value))
 
939
                raise ValueError("Byte arrays not supported for non-"
 
940
                                 "'ay' signature {!r}"
 
941
                                 .format(prop._dbus_signature))
 
942
            value = dbus.ByteArray(b''.join(chr(byte)
 
943
                                            for byte in value))
676
944
        prop(value)
677
945
    
678
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
946
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
947
                         in_signature="s",
679
948
                         out_signature="a{sv}")
680
949
    def GetAll(self, interface_name):
681
950
        """Standard D-Bus property GetAll() method, see D-Bus
683
952
        
684
953
        Note: Will not include properties with access="write".
685
954
        """
686
 
        all = {}
687
 
        for name, prop in self._get_all_dbus_properties():
 
955
        properties = {}
 
956
        for name, prop in self._get_all_dbus_things("property"):
688
957
            if (interface_name
689
958
                and interface_name != prop._dbus_interface):
690
959
                # Interface non-empty but did not match
694
963
                continue
695
964
            value = prop()
696
965
            if not hasattr(value, "variant_level"):
697
 
                all[name] = value
 
966
                properties[name] = value
698
967
                continue
699
 
            all[name] = type(value)(value, variant_level=
700
 
                                    value.variant_level+1)
701
 
        return dbus.Dictionary(all, signature="sv")
 
968
            properties[name] = type(value)(
 
969
                value, variant_level = value.variant_level + 1)
 
970
        return dbus.Dictionary(properties, signature="sv")
 
971
    
 
972
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
973
    def PropertiesChanged(self, interface_name, changed_properties,
 
974
                          invalidated_properties):
 
975
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
976
        standard.
 
977
        """
 
978
        pass
702
979
    
703
980
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
704
981
                         out_signature="s",
705
982
                         path_keyword='object_path',
706
983
                         connection_keyword='connection')
707
984
    def Introspect(self, object_path, connection):
708
 
        """Standard D-Bus method, overloaded to insert property tags.
 
985
        """Overloading of standard D-Bus method.
 
986
        
 
987
        Inserts property tags and interface annotation tags.
709
988
        """
710
989
        xmlstring = dbus.service.Object.Introspect(self, object_path,
711
990
                                                   connection)
712
991
        try:
713
992
            document = xml.dom.minidom.parseString(xmlstring)
 
993
            
714
994
            def make_tag(document, name, prop):
715
995
                e = document.createElement("property")
716
996
                e.setAttribute("name", name)
717
997
                e.setAttribute("type", prop._dbus_signature)
718
998
                e.setAttribute("access", prop._dbus_access)
719
999
                return e
 
1000
            
720
1001
            for if_tag in document.getElementsByTagName("interface"):
 
1002
                # Add property tags
721
1003
                for tag in (make_tag(document, name, prop)
722
1004
                            for name, prop
723
 
                            in self._get_all_dbus_properties()
 
1005
                            in self._get_all_dbus_things("property")
724
1006
                            if prop._dbus_interface
725
1007
                            == if_tag.getAttribute("name")):
726
1008
                    if_tag.appendChild(tag)
 
1009
                # Add annotation tags
 
1010
                for typ in ("method", "signal", "property"):
 
1011
                    for tag in if_tag.getElementsByTagName(typ):
 
1012
                        annots = dict()
 
1013
                        for name, prop in (self.
 
1014
                                           _get_all_dbus_things(typ)):
 
1015
                            if (name == tag.getAttribute("name")
 
1016
                                and prop._dbus_interface
 
1017
                                == if_tag.getAttribute("name")):
 
1018
                                annots.update(getattr(
 
1019
                                    prop, "_dbus_annotations", {}))
 
1020
                        for name, value in annots.items():
 
1021
                            ann_tag = document.createElement(
 
1022
                                "annotation")
 
1023
                            ann_tag.setAttribute("name", name)
 
1024
                            ann_tag.setAttribute("value", value)
 
1025
                            tag.appendChild(ann_tag)
 
1026
                # Add interface annotation tags
 
1027
                for annotation, value in dict(
 
1028
                    itertools.chain.from_iterable(
 
1029
                        annotations().items()
 
1030
                        for name, annotations
 
1031
                        in self._get_all_dbus_things("interface")
 
1032
                        if name == if_tag.getAttribute("name")
 
1033
                        )).items():
 
1034
                    ann_tag = document.createElement("annotation")
 
1035
                    ann_tag.setAttribute("name", annotation)
 
1036
                    ann_tag.setAttribute("value", value)
 
1037
                    if_tag.appendChild(ann_tag)
727
1038
                # Add the names to the return values for the
728
1039
                # "org.freedesktop.DBus.Properties" methods
729
1040
                if (if_tag.getAttribute("name")
744
1055
        except (AttributeError, xml.dom.DOMException,
745
1056
                xml.parsers.expat.ExpatError) as error:
746
1057
            logger.error("Failed to override Introspection method",
747
 
                         error)
 
1058
                         exc_info=error)
748
1059
        return xmlstring
749
1060
 
750
1061
 
751
 
def datetime_to_dbus (dt, variant_level=0):
 
1062
def datetime_to_dbus(dt, variant_level=0):
752
1063
    """Convert a UTC datetime.datetime() to a D-Bus type."""
753
1064
    if dt is None:
754
1065
        return dbus.String("", variant_level = variant_level)
755
 
    return dbus.String(dt.isoformat(),
756
 
                       variant_level=variant_level)
757
 
 
758
 
class transitional_dbus_metaclass(DBusObjectWithProperties.__metaclass__):
759
 
    def __new__(mcs, name, bases, attr):
760
 
        for attrname, old_dbusobj in inspect.getmembers(bases[0]):
761
 
            new_interface = getattr(old_dbusobj, "_dbus_interface", "").replace("se.bsnet.fukt.", "se.recompile.")
762
 
            if (getattr(old_dbusobj, "_dbus_is_signal", False)
763
 
                and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
764
 
                unwrappedfunc = dict(zip(old_dbusobj.func_code.co_freevars,
765
 
                                    old_dbusobj.__closure__))["func"].cell_contents
766
 
                newfunc = types.FunctionType(unwrappedfunc.func_code,
767
 
                                             unwrappedfunc.func_globals,
768
 
                                             unwrappedfunc.func_name,
769
 
                                             unwrappedfunc.func_defaults,
770
 
                                             unwrappedfunc.func_closure)
771
 
                new_dbusfunc = dbus.service.signal(
772
 
                    new_interface, old_dbusobj._dbus_signature)(newfunc)            
773
 
                attr["_transitional_" + attrname] = new_dbusfunc
774
 
 
775
 
                def fixscope(func1, func2):
776
 
                    def newcall(*args, **kwargs):
777
 
                        func1(*args, **kwargs)
778
 
                        func2(*args, **kwargs)
779
 
                    return newcall
780
 
 
781
 
                attr[attrname] = fixscope(old_dbusobj, new_dbusfunc)
782
 
            
783
 
            elif (getattr(old_dbusobj, "_dbus_is_method", False)
784
 
                and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
785
 
                new_dbusfunc = (dbus.service.method
786
 
                                (new_interface,
787
 
                                 old_dbusobj._dbus_in_signature,
788
 
                                 old_dbusobj._dbus_out_signature)
789
 
                                (types.FunctionType
790
 
                                 (old_dbusobj.func_code,
791
 
                                  old_dbusobj.func_globals,
792
 
                                  old_dbusobj.func_name,
793
 
                                  old_dbusobj.func_defaults,
794
 
                                  old_dbusobj.func_closure)))
795
 
 
796
 
                attr[attrname] = new_dbusfunc
797
 
            elif (getattr(old_dbusobj, "_dbus_is_property", False)
798
 
                  and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
799
 
                new_dbusfunc = (dbus_service_property
800
 
                                (new_interface,
801
 
                                 old_dbusobj._dbus_signature,
802
 
                                 old_dbusobj._dbus_access,
803
 
                                 old_dbusobj._dbus_get_args_options["byte_arrays"])
804
 
                                (types.FunctionType
805
 
                                 (old_dbusobj.func_code,
806
 
                                  old_dbusobj.func_globals,
807
 
                                  old_dbusobj.func_name,
808
 
                                  old_dbusobj.func_defaults,
809
 
                                  old_dbusobj.func_closure)))
810
 
 
811
 
                attr[attrname] = new_dbusfunc
812
 
        return type.__new__(mcs, name, bases, attr)
813
 
 
 
1066
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
1067
 
 
1068
 
 
1069
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1070
    """A class decorator; applied to a subclass of
 
1071
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1072
    interface names according to the "alt_interface_names" mapping.
 
1073
    Usage:
 
1074
    
 
1075
    @alternate_dbus_interfaces({"org.example.Interface":
 
1076
                                    "net.example.AlternateInterface"})
 
1077
    class SampleDBusObject(dbus.service.Object):
 
1078
        @dbus.service.method("org.example.Interface")
 
1079
        def SampleDBusMethod():
 
1080
            pass
 
1081
    
 
1082
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1083
    reachable via two interfaces: "org.example.Interface" and
 
1084
    "net.example.AlternateInterface", the latter of which will have
 
1085
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1086
    "true", unless "deprecate" is passed with a False value.
 
1087
    
 
1088
    This works for methods and signals, and also for D-Bus properties
 
1089
    (from DBusObjectWithProperties) and interfaces (from the
 
1090
    dbus_interface_annotations decorator).
 
1091
    """
 
1092
    
 
1093
    def wrapper(cls):
 
1094
        for orig_interface_name, alt_interface_name in (
 
1095
                alt_interface_names.items()):
 
1096
            attr = {}
 
1097
            interface_names = set()
 
1098
            # Go though all attributes of the class
 
1099
            for attrname, attribute in inspect.getmembers(cls):
 
1100
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1101
                # with the wrong interface name
 
1102
                if (not hasattr(attribute, "_dbus_interface")
 
1103
                    or not attribute._dbus_interface.startswith(
 
1104
                        orig_interface_name)):
 
1105
                    continue
 
1106
                # Create an alternate D-Bus interface name based on
 
1107
                # the current name
 
1108
                alt_interface = attribute._dbus_interface.replace(
 
1109
                    orig_interface_name, alt_interface_name)
 
1110
                interface_names.add(alt_interface)
 
1111
                # Is this a D-Bus signal?
 
1112
                if getattr(attribute, "_dbus_is_signal", False):
 
1113
                    if sys.version_info.major == 2:
 
1114
                        # Extract the original non-method undecorated
 
1115
                        # function by black magic
 
1116
                        nonmethod_func = (dict(
 
1117
                            zip(attribute.func_code.co_freevars,
 
1118
                                attribute.__closure__))
 
1119
                                          ["func"].cell_contents)
 
1120
                    else:
 
1121
                        nonmethod_func = attribute
 
1122
                    # Create a new, but exactly alike, function
 
1123
                    # object, and decorate it to be a new D-Bus signal
 
1124
                    # with the alternate D-Bus interface name
 
1125
                    if sys.version_info.major == 2:
 
1126
                        new_function = types.FunctionType(
 
1127
                            nonmethod_func.func_code,
 
1128
                            nonmethod_func.func_globals,
 
1129
                            nonmethod_func.func_name,
 
1130
                            nonmethod_func.func_defaults,
 
1131
                            nonmethod_func.func_closure)
 
1132
                    else:
 
1133
                        new_function = types.FunctionType(
 
1134
                            nonmethod_func.__code__,
 
1135
                            nonmethod_func.__globals__,
 
1136
                            nonmethod_func.__name__,
 
1137
                            nonmethod_func.__defaults__,
 
1138
                            nonmethod_func.__closure__)
 
1139
                    new_function = (dbus.service.signal(
 
1140
                        alt_interface,
 
1141
                        attribute._dbus_signature)(new_function))
 
1142
                    # Copy annotations, if any
 
1143
                    try:
 
1144
                        new_function._dbus_annotations = dict(
 
1145
                            attribute._dbus_annotations)
 
1146
                    except AttributeError:
 
1147
                        pass
 
1148
                    # Define a creator of a function to call both the
 
1149
                    # original and alternate functions, so both the
 
1150
                    # original and alternate signals gets sent when
 
1151
                    # the function is called
 
1152
                    def fixscope(func1, func2):
 
1153
                        """This function is a scope container to pass
 
1154
                        func1 and func2 to the "call_both" function
 
1155
                        outside of its arguments"""
 
1156
                        
 
1157
                        def call_both(*args, **kwargs):
 
1158
                            """This function will emit two D-Bus
 
1159
                            signals by calling func1 and func2"""
 
1160
                            func1(*args, **kwargs)
 
1161
                            func2(*args, **kwargs)
 
1162
                        
 
1163
                        return call_both
 
1164
                    # Create the "call_both" function and add it to
 
1165
                    # the class
 
1166
                    attr[attrname] = fixscope(attribute, new_function)
 
1167
                # Is this a D-Bus method?
 
1168
                elif getattr(attribute, "_dbus_is_method", False):
 
1169
                    # Create a new, but exactly alike, function
 
1170
                    # object.  Decorate it to be a new D-Bus method
 
1171
                    # with the alternate D-Bus interface name.  Add it
 
1172
                    # to the class.
 
1173
                    attr[attrname] = (
 
1174
                        dbus.service.method(
 
1175
                            alt_interface,
 
1176
                            attribute._dbus_in_signature,
 
1177
                            attribute._dbus_out_signature)
 
1178
                        (types.FunctionType(attribute.func_code,
 
1179
                                            attribute.func_globals,
 
1180
                                            attribute.func_name,
 
1181
                                            attribute.func_defaults,
 
1182
                                            attribute.func_closure)))
 
1183
                    # Copy annotations, if any
 
1184
                    try:
 
1185
                        attr[attrname]._dbus_annotations = dict(
 
1186
                            attribute._dbus_annotations)
 
1187
                    except AttributeError:
 
1188
                        pass
 
1189
                # Is this a D-Bus property?
 
1190
                elif getattr(attribute, "_dbus_is_property", False):
 
1191
                    # Create a new, but exactly alike, function
 
1192
                    # object, and decorate it to be a new D-Bus
 
1193
                    # property with the alternate D-Bus interface
 
1194
                    # name.  Add it to the class.
 
1195
                    attr[attrname] = (dbus_service_property(
 
1196
                        alt_interface, attribute._dbus_signature,
 
1197
                        attribute._dbus_access,
 
1198
                        attribute._dbus_get_args_options
 
1199
                        ["byte_arrays"])
 
1200
                                      (types.FunctionType(
 
1201
                                          attribute.func_code,
 
1202
                                          attribute.func_globals,
 
1203
                                          attribute.func_name,
 
1204
                                          attribute.func_defaults,
 
1205
                                          attribute.func_closure)))
 
1206
                    # Copy annotations, if any
 
1207
                    try:
 
1208
                        attr[attrname]._dbus_annotations = dict(
 
1209
                            attribute._dbus_annotations)
 
1210
                    except AttributeError:
 
1211
                        pass
 
1212
                # Is this a D-Bus interface?
 
1213
                elif getattr(attribute, "_dbus_is_interface", False):
 
1214
                    # Create a new, but exactly alike, function
 
1215
                    # object.  Decorate it to be a new D-Bus interface
 
1216
                    # with the alternate D-Bus interface name.  Add it
 
1217
                    # to the class.
 
1218
                    attr[attrname] = (
 
1219
                        dbus_interface_annotations(alt_interface)
 
1220
                        (types.FunctionType(attribute.func_code,
 
1221
                                            attribute.func_globals,
 
1222
                                            attribute.func_name,
 
1223
                                            attribute.func_defaults,
 
1224
                                            attribute.func_closure)))
 
1225
            if deprecate:
 
1226
                # Deprecate all alternate interfaces
 
1227
                iname="_AlternateDBusNames_interface_annotation{}"
 
1228
                for interface_name in interface_names:
 
1229
                    
 
1230
                    @dbus_interface_annotations(interface_name)
 
1231
                    def func(self):
 
1232
                        return { "org.freedesktop.DBus.Deprecated":
 
1233
                                 "true" }
 
1234
                    # Find an unused name
 
1235
                    for aname in (iname.format(i)
 
1236
                                  for i in itertools.count()):
 
1237
                        if aname not in attr:
 
1238
                            attr[aname] = func
 
1239
                            break
 
1240
            if interface_names:
 
1241
                # Replace the class with a new subclass of it with
 
1242
                # methods, signals, etc. as created above.
 
1243
                cls = type(b"{}Alternate".format(cls.__name__),
 
1244
                           (cls, ), attr)
 
1245
        return cls
 
1246
    
 
1247
    return wrapper
 
1248
 
 
1249
 
 
1250
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1251
                            "se.bsnet.fukt.Mandos"})
814
1252
class ClientDBus(Client, DBusObjectWithProperties):
815
1253
    """A Client class using D-Bus
816
1254
    
820
1258
    """
821
1259
    
822
1260
    runtime_expansions = (Client.runtime_expansions
823
 
                          + ("dbus_object_path",))
 
1261
                          + ("dbus_object_path", ))
 
1262
    
 
1263
    _interface = "se.recompile.Mandos.Client"
824
1264
    
825
1265
    # dbus.service.Object doesn't use super(), so we can't either.
826
1266
    
827
1267
    def __init__(self, bus = None, *args, **kwargs):
828
 
        self._approvals_pending = 0
829
1268
        self.bus = bus
830
1269
        Client.__init__(self, *args, **kwargs)
831
1270
        # Only now, when this client is initialized, can it show up on
832
1271
        # the D-Bus
833
 
        client_object_name = unicode(self.name).translate(
 
1272
        client_object_name = str(self.name).translate(
834
1273
            {ord("."): ord("_"),
835
1274
             ord("-"): ord("_")})
836
 
        self.dbus_object_path = (dbus.ObjectPath
837
 
                                 ("/clients/" + client_object_name))
 
1275
        self.dbus_object_path = dbus.ObjectPath(
 
1276
            "/clients/" + client_object_name)
838
1277
        DBusObjectWithProperties.__init__(self, self.bus,
839
1278
                                          self.dbus_object_path)
 
1279
    
 
1280
    def notifychangeproperty(transform_func, dbus_name,
 
1281
                             type_func=lambda x: x,
 
1282
                             variant_level=1,
 
1283
                             invalidate_only=False,
 
1284
                             _interface=_interface):
 
1285
        """ Modify a variable so that it's a property which announces
 
1286
        its changes to DBus.
840
1287
        
841
 
    def notifychangeproperty(transform_func,
842
 
                             dbus_name, type_func=lambda x: x,
843
 
                             variant_level=1):
844
 
        """ Modify a variable so that its a property that announce its
845
 
        changes to DBus.
846
 
        transform_fun: Function that takes a value and transform it to
847
 
                       DBus type.
848
 
        dbus_name: DBus name of the variable
 
1288
        transform_fun: Function that takes a value and a variant_level
 
1289
                       and transforms it to a D-Bus type.
 
1290
        dbus_name: D-Bus name of the variable
849
1291
        type_func: Function that transform the value before sending it
850
 
                   to DBus
851
 
        variant_level: DBus variant level. default: 1
 
1292
                   to the D-Bus.  Default: no transform
 
1293
        variant_level: D-Bus variant level.  Default: 1
852
1294
        """
853
 
        real_value = [None,]
 
1295
        attrname = "_{}".format(dbus_name)
 
1296
        
854
1297
        def setter(self, value):
855
 
            old_value = real_value[0]
856
 
            real_value[0] = value
857
1298
            if hasattr(self, "dbus_object_path"):
858
 
                if type_func(old_value) != type_func(real_value[0]):
859
 
                    dbus_value = transform_func(type_func(real_value[0]),
860
 
                                                variant_level)
861
 
                    self.PropertyChanged(dbus.String(dbus_name),
862
 
                                         dbus_value)
 
1299
                if (not hasattr(self, attrname) or
 
1300
                    type_func(getattr(self, attrname, None))
 
1301
                    != type_func(value)):
 
1302
                    if invalidate_only:
 
1303
                        self.PropertiesChanged(
 
1304
                            _interface, dbus.Dictionary(),
 
1305
                            dbus.Array((dbus_name, )))
 
1306
                    else:
 
1307
                        dbus_value = transform_func(
 
1308
                            type_func(value),
 
1309
                            variant_level = variant_level)
 
1310
                        self.PropertyChanged(dbus.String(dbus_name),
 
1311
                                             dbus_value)
 
1312
                        self.PropertiesChanged(
 
1313
                            _interface,
 
1314
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1315
                                              dbus_value }),
 
1316
                            dbus.Array())
 
1317
            setattr(self, attrname, value)
863
1318
        
864
 
        return property(lambda self: real_value[0], setter)
865
 
    
 
1319
        return property(lambda self: getattr(self, attrname), setter)
866
1320
    
867
1321
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
868
1322
    approvals_pending = notifychangeproperty(dbus.Boolean,
871
1325
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
872
1326
    last_enabled = notifychangeproperty(datetime_to_dbus,
873
1327
                                        "LastEnabled")
874
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
875
 
                                   type_func = lambda checker: checker is not None)
 
1328
    checker = notifychangeproperty(
 
1329
        dbus.Boolean, "CheckerRunning",
 
1330
        type_func = lambda checker: checker is not None)
876
1331
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
877
1332
                                           "LastCheckedOK")
878
 
    last_approval_request = notifychangeproperty(datetime_to_dbus,
879
 
                                                 "LastApprovalRequest")
 
1333
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1334
                                               "LastCheckerStatus")
 
1335
    last_approval_request = notifychangeproperty(
 
1336
        datetime_to_dbus, "LastApprovalRequest")
880
1337
    approved_by_default = notifychangeproperty(dbus.Boolean,
881
1338
                                               "ApprovedByDefault")
882
 
    approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",
883
 
                                          type_func = _timedelta_to_milliseconds)
884
 
    approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",
885
 
                                             type_func = _timedelta_to_milliseconds)
 
1339
    approval_delay = notifychangeproperty(
 
1340
        dbus.UInt64, "ApprovalDelay",
 
1341
        type_func = lambda td: td.total_seconds() * 1000)
 
1342
    approval_duration = notifychangeproperty(
 
1343
        dbus.UInt64, "ApprovalDuration",
 
1344
        type_func = lambda td: td.total_seconds() * 1000)
886
1345
    host = notifychangeproperty(dbus.String, "Host")
887
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
888
 
                                   type_func = _timedelta_to_milliseconds)
889
 
    extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",
890
 
                                            type_func = _timedelta_to_milliseconds)
891
 
    interval = notifychangeproperty(dbus.UInt16, "Interval",
892
 
                                    type_func = _timedelta_to_milliseconds)
 
1346
    timeout = notifychangeproperty(
 
1347
        dbus.UInt64, "Timeout",
 
1348
        type_func = lambda td: td.total_seconds() * 1000)
 
1349
    extended_timeout = notifychangeproperty(
 
1350
        dbus.UInt64, "ExtendedTimeout",
 
1351
        type_func = lambda td: td.total_seconds() * 1000)
 
1352
    interval = notifychangeproperty(
 
1353
        dbus.UInt64, "Interval",
 
1354
        type_func = lambda td: td.total_seconds() * 1000)
893
1355
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1356
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1357
                                  invalidate_only=True)
894
1358
    
895
1359
    del notifychangeproperty
896
1360
    
903
1367
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
904
1368
        Client.__del__(self, *args, **kwargs)
905
1369
    
906
 
    def checker_callback(self, pid, condition, command,
907
 
                         *args, **kwargs):
908
 
        self.checker_callback_tag = None
909
 
        self.checker = None
910
 
        if os.WIFEXITED(condition):
911
 
            exitstatus = os.WEXITSTATUS(condition)
 
1370
    def checker_callback(self, source, condition,
 
1371
                         connection, command, *args, **kwargs):
 
1372
        ret = Client.checker_callback(self, source, condition,
 
1373
                                      connection, command, *args,
 
1374
                                      **kwargs)
 
1375
        exitstatus = self.last_checker_status
 
1376
        if exitstatus >= 0:
912
1377
            # Emit D-Bus signal
913
1378
            self.CheckerCompleted(dbus.Int16(exitstatus),
914
 
                                  dbus.Int64(condition),
 
1379
                                  dbus.Int64(0),
915
1380
                                  dbus.String(command))
916
1381
        else:
917
1382
            # Emit D-Bus signal
918
1383
            self.CheckerCompleted(dbus.Int16(-1),
919
 
                                  dbus.Int64(condition),
 
1384
                                  dbus.Int64(
 
1385
                                      self.last_checker_signal),
920
1386
                                  dbus.String(command))
921
 
        
922
 
        return Client.checker_callback(self, pid, condition, command,
923
 
                                       *args, **kwargs)
 
1387
        return ret
924
1388
    
925
1389
    def start_checker(self, *args, **kwargs):
926
 
        old_checker = self.checker
927
 
        if self.checker is not None:
928
 
            old_checker_pid = self.checker.pid
929
 
        else:
930
 
            old_checker_pid = None
 
1390
        old_checker_pid = getattr(self.checker, "pid", None)
931
1391
        r = Client.start_checker(self, *args, **kwargs)
932
1392
        # Only if new checker process was started
933
1393
        if (self.checker is not None
937
1397
        return r
938
1398
    
939
1399
    def _reset_approved(self):
940
 
        self._approved = None
 
1400
        self.approved = None
941
1401
        return False
942
1402
    
943
1403
    def approve(self, value=True):
 
1404
        self.approved = value
 
1405
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1406
                                * 1000), self._reset_approved)
944
1407
        self.send_changedstate()
945
 
        self._approved = value
946
 
        gobject.timeout_add(_timedelta_to_milliseconds
947
 
                            (self.approval_duration),
948
 
                            self._reset_approved)
949
 
    
950
1408
    
951
1409
    ## D-Bus methods, signals & properties
952
 
    _interface = "se.bsnet.fukt.Mandos.Client"
953
 
 
 
1410
    
 
1411
    ## Interfaces
 
1412
    
954
1413
    ## Signals
955
1414
    
956
1415
    # CheckerCompleted - signal
966
1425
        pass
967
1426
    
968
1427
    # PropertyChanged - signal
 
1428
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
969
1429
    @dbus.service.signal(_interface, signature="sv")
970
1430
    def PropertyChanged(self, property, value):
971
1431
        "D-Bus signal"
1035
1495
        return dbus.Boolean(bool(self.approvals_pending))
1036
1496
    
1037
1497
    # ApprovedByDefault - property
1038
 
    @dbus_service_property(_interface, signature="b",
 
1498
    @dbus_service_property(_interface,
 
1499
                           signature="b",
1039
1500
                           access="readwrite")
1040
1501
    def ApprovedByDefault_dbus_property(self, value=None):
1041
1502
        if value is None:       # get
1043
1504
        self.approved_by_default = bool(value)
1044
1505
    
1045
1506
    # ApprovalDelay - property
1046
 
    @dbus_service_property(_interface, signature="t",
 
1507
    @dbus_service_property(_interface,
 
1508
                           signature="t",
1047
1509
                           access="readwrite")
1048
1510
    def ApprovalDelay_dbus_property(self, value=None):
1049
1511
        if value is None:       # get
1050
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1512
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1513
                               * 1000)
1051
1514
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1052
1515
    
1053
1516
    # ApprovalDuration - property
1054
 
    @dbus_service_property(_interface, signature="t",
 
1517
    @dbus_service_property(_interface,
 
1518
                           signature="t",
1055
1519
                           access="readwrite")
1056
1520
    def ApprovalDuration_dbus_property(self, value=None):
1057
1521
        if value is None:       # get
1058
 
            return dbus.UInt64(_timedelta_to_milliseconds(
1059
 
                    self.approval_duration))
 
1522
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1523
                               * 1000)
1060
1524
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1061
1525
    
1062
1526
    # Name - property
1070
1534
        return dbus.String(self.fingerprint)
1071
1535
    
1072
1536
    # Host - property
1073
 
    @dbus_service_property(_interface, signature="s",
 
1537
    @dbus_service_property(_interface,
 
1538
                           signature="s",
1074
1539
                           access="readwrite")
1075
1540
    def Host_dbus_property(self, value=None):
1076
1541
        if value is None:       # get
1077
1542
            return dbus.String(self.host)
1078
 
        self.host = value
 
1543
        self.host = str(value)
1079
1544
    
1080
1545
    # Created - property
1081
1546
    @dbus_service_property(_interface, signature="s", access="read")
1082
1547
    def Created_dbus_property(self):
1083
 
        return dbus.String(datetime_to_dbus(self.created))
 
1548
        return datetime_to_dbus(self.created)
1084
1549
    
1085
1550
    # LastEnabled - property
1086
1551
    @dbus_service_property(_interface, signature="s", access="read")
1088
1553
        return datetime_to_dbus(self.last_enabled)
1089
1554
    
1090
1555
    # Enabled - property
1091
 
    @dbus_service_property(_interface, signature="b",
 
1556
    @dbus_service_property(_interface,
 
1557
                           signature="b",
1092
1558
                           access="readwrite")
1093
1559
    def Enabled_dbus_property(self, value=None):
1094
1560
        if value is None:       # get
1099
1565
            self.disable()
1100
1566
    
1101
1567
    # LastCheckedOK - property
1102
 
    @dbus_service_property(_interface, signature="s",
 
1568
    @dbus_service_property(_interface,
 
1569
                           signature="s",
1103
1570
                           access="readwrite")
1104
1571
    def LastCheckedOK_dbus_property(self, value=None):
1105
1572
        if value is not None:
1107
1574
            return
1108
1575
        return datetime_to_dbus(self.last_checked_ok)
1109
1576
    
 
1577
    # LastCheckerStatus - property
 
1578
    @dbus_service_property(_interface, signature="n", access="read")
 
1579
    def LastCheckerStatus_dbus_property(self):
 
1580
        return dbus.Int16(self.last_checker_status)
 
1581
    
1110
1582
    # Expires - property
1111
1583
    @dbus_service_property(_interface, signature="s", access="read")
1112
1584
    def Expires_dbus_property(self):
1118
1590
        return datetime_to_dbus(self.last_approval_request)
1119
1591
    
1120
1592
    # Timeout - property
1121
 
    @dbus_service_property(_interface, signature="t",
 
1593
    @dbus_service_property(_interface,
 
1594
                           signature="t",
1122
1595
                           access="readwrite")
1123
1596
    def Timeout_dbus_property(self, value=None):
1124
1597
        if value is None:       # get
1125
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1598
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1599
        old_timeout = self.timeout
1126
1600
        self.timeout = datetime.timedelta(0, 0, 0, value)
1127
 
        if getattr(self, "disable_initiator_tag", None) is None:
1128
 
            return
1129
 
        # Reschedule timeout
1130
 
        gobject.source_remove(self.disable_initiator_tag)
1131
 
        self.disable_initiator_tag = None
1132
 
        self.expires = None
1133
 
        time_to_die = (self.
1134
 
                       _timedelta_to_milliseconds((self
1135
 
                                                   .last_checked_ok
1136
 
                                                   + self.timeout)
1137
 
                                                  - datetime.datetime
1138
 
                                                  .utcnow()))
1139
 
        if time_to_die <= 0:
1140
 
            # The timeout has passed
1141
 
            self.disable()
1142
 
        else:
1143
 
            self.expires = (datetime.datetime.utcnow()
1144
 
                            + datetime.timedelta(milliseconds = time_to_die))
1145
 
            self.disable_initiator_tag = (gobject.timeout_add
1146
 
                                          (time_to_die, self.disable))
 
1601
        # Reschedule disabling
 
1602
        if self.enabled:
 
1603
            now = datetime.datetime.utcnow()
 
1604
            self.expires += self.timeout - old_timeout
 
1605
            if self.expires <= now:
 
1606
                # The timeout has passed
 
1607
                self.disable()
 
1608
            else:
 
1609
                if (getattr(self, "disable_initiator_tag", None)
 
1610
                    is None):
 
1611
                    return
 
1612
                gobject.source_remove(self.disable_initiator_tag)
 
1613
                self.disable_initiator_tag = gobject.timeout_add(
 
1614
                    int((self.expires - now).total_seconds() * 1000),
 
1615
                    self.disable)
1147
1616
    
1148
1617
    # ExtendedTimeout - property
1149
 
    @dbus_service_property(_interface, signature="t",
 
1618
    @dbus_service_property(_interface,
 
1619
                           signature="t",
1150
1620
                           access="readwrite")
1151
1621
    def ExtendedTimeout_dbus_property(self, value=None):
1152
1622
        if value is None:       # get
1153
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1623
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1624
                               * 1000)
1154
1625
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1155
1626
    
1156
1627
    # Interval - property
1157
 
    @dbus_service_property(_interface, signature="t",
 
1628
    @dbus_service_property(_interface,
 
1629
                           signature="t",
1158
1630
                           access="readwrite")
1159
1631
    def Interval_dbus_property(self, value=None):
1160
1632
        if value is None:       # get
1161
 
            return dbus.UInt64(self.interval_milliseconds())
 
1633
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1162
1634
        self.interval = datetime.timedelta(0, 0, 0, value)
1163
1635
        if getattr(self, "checker_initiator_tag", None) is None:
1164
1636
            return
1165
 
        # Reschedule checker run
1166
 
        gobject.source_remove(self.checker_initiator_tag)
1167
 
        self.checker_initiator_tag = (gobject.timeout_add
1168
 
                                      (value, self.start_checker))
1169
 
        self.start_checker()    # Start one now, too
 
1637
        if self.enabled:
 
1638
            # Reschedule checker run
 
1639
            gobject.source_remove(self.checker_initiator_tag)
 
1640
            self.checker_initiator_tag = gobject.timeout_add(
 
1641
                value, self.start_checker)
 
1642
            self.start_checker() # Start one now, too
1170
1643
    
1171
1644
    # Checker - property
1172
 
    @dbus_service_property(_interface, signature="s",
 
1645
    @dbus_service_property(_interface,
 
1646
                           signature="s",
1173
1647
                           access="readwrite")
1174
1648
    def Checker_dbus_property(self, value=None):
1175
1649
        if value is None:       # get
1176
1650
            return dbus.String(self.checker_command)
1177
 
        self.checker_command = value
 
1651
        self.checker_command = str(value)
1178
1652
    
1179
1653
    # CheckerRunning - property
1180
 
    @dbus_service_property(_interface, signature="b",
 
1654
    @dbus_service_property(_interface,
 
1655
                           signature="b",
1181
1656
                           access="readwrite")
1182
1657
    def CheckerRunning_dbus_property(self, value=None):
1183
1658
        if value is None:       # get
1193
1668
        return self.dbus_object_path # is already a dbus.ObjectPath
1194
1669
    
1195
1670
    # Secret = property
1196
 
    @dbus_service_property(_interface, signature="ay",
1197
 
                           access="write", byte_arrays=True)
 
1671
    @dbus_service_property(_interface,
 
1672
                           signature="ay",
 
1673
                           access="write",
 
1674
                           byte_arrays=True)
1198
1675
    def Secret_dbus_property(self, value):
1199
 
        self.secret = str(value)
 
1676
        self.secret = bytes(value)
1200
1677
    
1201
1678
    del _interface
1202
1679
 
1206
1683
        self._pipe = child_pipe
1207
1684
        self._pipe.send(('init', fpr, address))
1208
1685
        if not self._pipe.recv():
1209
 
            raise KeyError()
 
1686
            raise KeyError(fpr)
1210
1687
    
1211
1688
    def __getattribute__(self, name):
1212
 
        if(name == '_pipe'):
 
1689
        if name == '_pipe':
1213
1690
            return super(ProxyClient, self).__getattribute__(name)
1214
1691
        self._pipe.send(('getattr', name))
1215
1692
        data = self._pipe.recv()
1216
1693
        if data[0] == 'data':
1217
1694
            return data[1]
1218
1695
        if data[0] == 'function':
 
1696
            
1219
1697
            def func(*args, **kwargs):
1220
1698
                self._pipe.send(('funcall', name, args, kwargs))
1221
1699
                return self._pipe.recv()[1]
 
1700
            
1222
1701
            return func
1223
1702
    
1224
1703
    def __setattr__(self, name, value):
1225
 
        if(name == '_pipe'):
 
1704
        if name == '_pipe':
1226
1705
            return super(ProxyClient, self).__setattr__(name, value)
1227
1706
        self._pipe.send(('setattr', name, value))
1228
1707
 
1229
 
class ClientDBusTransitional(ClientDBus):
1230
 
    __metaclass__ = transitional_dbus_metaclass
1231
1708
 
1232
1709
class ClientHandler(socketserver.BaseRequestHandler, object):
1233
1710
    """A class to handle client connections.
1238
1715
    def handle(self):
1239
1716
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1240
1717
            logger.info("TCP connection from: %s",
1241
 
                        unicode(self.client_address))
 
1718
                        str(self.client_address))
1242
1719
            logger.debug("Pipe FD: %d",
1243
1720
                         self.server.child_pipe.fileno())
1244
1721
            
1245
 
            session = (gnutls.connection
1246
 
                       .ClientSession(self.request,
1247
 
                                      gnutls.connection
1248
 
                                      .X509Credentials()))
 
1722
            session = gnutls.connection.ClientSession(
 
1723
                self.request, gnutls.connection .X509Credentials())
1249
1724
            
1250
1725
            # Note: gnutls.connection.X509Credentials is really a
1251
1726
            # generic GnuTLS certificate credentials object so long as
1260
1735
            priority = self.server.gnutls_priority
1261
1736
            if priority is None:
1262
1737
                priority = "NORMAL"
1263
 
            (gnutls.library.functions
1264
 
             .gnutls_priority_set_direct(session._c_object,
1265
 
                                         priority, None))
 
1738
            gnutls.library.functions.gnutls_priority_set_direct(
 
1739
                session._c_object, priority, None)
1266
1740
            
1267
1741
            # Start communication using the Mandos protocol
1268
1742
            # Get protocol number
1270
1744
            logger.debug("Protocol version: %r", line)
1271
1745
            try:
1272
1746
                if int(line.strip().split()[0]) > 1:
1273
 
                    raise RuntimeError
 
1747
                    raise RuntimeError(line)
1274
1748
            except (ValueError, IndexError, RuntimeError) as error:
1275
1749
                logger.error("Unknown protocol version: %s", error)
1276
1750
                return
1288
1762
            approval_required = False
1289
1763
            try:
1290
1764
                try:
1291
 
                    fpr = self.fingerprint(self.peer_certificate
1292
 
                                           (session))
 
1765
                    fpr = self.fingerprint(
 
1766
                        self.peer_certificate(session))
1293
1767
                except (TypeError,
1294
1768
                        gnutls.errors.GNUTLSError) as error:
1295
1769
                    logger.warning("Bad certificate: %s", error)
1310
1784
                while True:
1311
1785
                    if not client.enabled:
1312
1786
                        logger.info("Client %s is disabled",
1313
 
                                       client.name)
 
1787
                                    client.name)
1314
1788
                        if self.server.use_dbus:
1315
1789
                            # Emit D-Bus signal
1316
 
                            client.Rejected("Disabled")                    
 
1790
                            client.Rejected("Disabled")
1317
1791
                        return
1318
1792
                    
1319
 
                    if client._approved or not client.approval_delay:
 
1793
                    if client.approved or not client.approval_delay:
1320
1794
                        #We are approved or approval is disabled
1321
1795
                        break
1322
 
                    elif client._approved is None:
 
1796
                    elif client.approved is None:
1323
1797
                        logger.info("Client %s needs approval",
1324
1798
                                    client.name)
1325
1799
                        if self.server.use_dbus:
1326
1800
                            # Emit D-Bus signal
1327
1801
                            client.NeedApproval(
1328
 
                                client.approval_delay_milliseconds(),
1329
 
                                client.approved_by_default)
 
1802
                                client.approval_delay.total_seconds()
 
1803
                                * 1000, client.approved_by_default)
1330
1804
                    else:
1331
1805
                        logger.warning("Client %s was not approved",
1332
1806
                                       client.name)
1336
1810
                        return
1337
1811
                    
1338
1812
                    #wait until timeout or approved
1339
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1340
1813
                    time = datetime.datetime.now()
1341
1814
                    client.changedstate.acquire()
1342
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1815
                    client.changedstate.wait(delay.total_seconds())
1343
1816
                    client.changedstate.release()
1344
1817
                    time2 = datetime.datetime.now()
1345
1818
                    if (time2 - time) >= delay:
1361
1834
                    try:
1362
1835
                        sent = session.send(client.secret[sent_size:])
1363
1836
                    except gnutls.errors.GNUTLSError as error:
1364
 
                        logger.warning("gnutls send failed")
 
1837
                        logger.warning("gnutls send failed",
 
1838
                                       exc_info=error)
1365
1839
                        return
1366
 
                    logger.debug("Sent: %d, remaining: %d",
1367
 
                                 sent, len(client.secret)
1368
 
                                 - (sent_size + sent))
 
1840
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1841
                                 len(client.secret) - (sent_size
 
1842
                                                       + sent))
1369
1843
                    sent_size += sent
1370
1844
                
1371
1845
                logger.info("Sending secret to %s", client.name)
1372
 
                # bump the timeout as if seen
1373
 
                client.checked_ok(client.extended_timeout)
 
1846
                # bump the timeout using extended_timeout
 
1847
                client.bump_timeout(client.extended_timeout)
1374
1848
                if self.server.use_dbus:
1375
1849
                    # Emit D-Bus signal
1376
1850
                    client.GotSecret()
1381
1855
                try:
1382
1856
                    session.bye()
1383
1857
                except gnutls.errors.GNUTLSError as error:
1384
 
                    logger.warning("GnuTLS bye failed")
 
1858
                    logger.warning("GnuTLS bye failed",
 
1859
                                   exc_info=error)
1385
1860
    
1386
1861
    @staticmethod
1387
1862
    def peer_certificate(session):
1388
1863
        "Return the peer's OpenPGP certificate as a bytestring"
1389
1864
        # If not an OpenPGP certificate...
1390
 
        if (gnutls.library.functions
1391
 
            .gnutls_certificate_type_get(session._c_object)
 
1865
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
1866
                session._c_object)
1392
1867
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1393
1868
            # ...do the normal thing
1394
1869
            return session.peer_certificate
1408
1883
    def fingerprint(openpgp):
1409
1884
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1410
1885
        # New GnuTLS "datum" with the OpenPGP public key
1411
 
        datum = (gnutls.library.types
1412
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1413
 
                                             ctypes.POINTER
1414
 
                                             (ctypes.c_ubyte)),
1415
 
                                 ctypes.c_uint(len(openpgp))))
 
1886
        datum = gnutls.library.types.gnutls_datum_t(
 
1887
            ctypes.cast(ctypes.c_char_p(openpgp),
 
1888
                        ctypes.POINTER(ctypes.c_ubyte)),
 
1889
            ctypes.c_uint(len(openpgp)))
1416
1890
        # New empty GnuTLS certificate
1417
1891
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1418
 
        (gnutls.library.functions
1419
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
1892
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
1893
            ctypes.byref(crt))
1420
1894
        # Import the OpenPGP public key into the certificate
1421
 
        (gnutls.library.functions
1422
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1423
 
                                    gnutls.library.constants
1424
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
1895
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
1896
            crt, ctypes.byref(datum),
 
1897
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1425
1898
        # Verify the self signature in the key
1426
1899
        crtverify = ctypes.c_uint()
1427
 
        (gnutls.library.functions
1428
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1429
 
                                         ctypes.byref(crtverify)))
 
1900
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
1901
            crt, 0, ctypes.byref(crtverify))
1430
1902
        if crtverify.value != 0:
1431
1903
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1432
 
            raise (gnutls.errors.CertificateSecurityError
1433
 
                   ("Verify failed"))
 
1904
            raise gnutls.errors.CertificateSecurityError(
 
1905
                "Verify failed")
1434
1906
        # New buffer for the fingerprint
1435
1907
        buf = ctypes.create_string_buffer(20)
1436
1908
        buf_len = ctypes.c_size_t()
1437
1909
        # Get the fingerprint from the certificate into the buffer
1438
 
        (gnutls.library.functions
1439
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1440
 
                                             ctypes.byref(buf_len)))
 
1910
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
1911
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1441
1912
        # Deinit the certificate
1442
1913
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1443
1914
        # Convert the buffer to a Python bytestring
1444
1915
        fpr = ctypes.string_at(buf, buf_len.value)
1445
1916
        # Convert the bytestring to hexadecimal notation
1446
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1917
        hex_fpr = binascii.hexlify(fpr).upper()
1447
1918
        return hex_fpr
1448
1919
 
1449
1920
 
1450
1921
class MultiprocessingMixIn(object):
1451
1922
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1923
    
1452
1924
    def sub_process_main(self, request, address):
1453
1925
        try:
1454
1926
            self.finish_request(request, address)
1455
 
        except:
 
1927
        except Exception:
1456
1928
            self.handle_error(request, address)
1457
1929
        self.close_request(request)
1458
 
            
 
1930
    
1459
1931
    def process_request(self, request, address):
1460
1932
        """Start a new process to process the request."""
1461
 
        multiprocessing.Process(target = self.sub_process_main,
1462
 
                                args = (request, address)).start()
 
1933
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1934
                                       args = (request, address))
 
1935
        proc.start()
 
1936
        return proc
1463
1937
 
1464
1938
 
1465
1939
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1466
1940
    """ adds a pipe to the MixIn """
 
1941
    
1467
1942
    def process_request(self, request, client_address):
1468
1943
        """Overrides and wraps the original process_request().
1469
1944
        
1471
1946
        """
1472
1947
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1473
1948
        
1474
 
        super(MultiprocessingMixInWithPipe,
1475
 
              self).process_request(request, client_address)
 
1949
        proc = MultiprocessingMixIn.process_request(self, request,
 
1950
                                                    client_address)
1476
1951
        self.child_pipe.close()
1477
 
        self.add_pipe(parent_pipe)
 
1952
        self.add_pipe(parent_pipe, proc)
1478
1953
    
1479
 
    def add_pipe(self, parent_pipe):
 
1954
    def add_pipe(self, parent_pipe, proc):
1480
1955
        """Dummy function; override as necessary"""
1481
 
        raise NotImplementedError
 
1956
        raise NotImplementedError()
1482
1957
 
1483
1958
 
1484
1959
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1490
1965
        interface:      None or a network interface name (string)
1491
1966
        use_ipv6:       Boolean; to use IPv6 or not
1492
1967
    """
 
1968
    
1493
1969
    def __init__(self, server_address, RequestHandlerClass,
1494
 
                 interface=None, use_ipv6=True):
 
1970
                 interface=None,
 
1971
                 use_ipv6=True,
 
1972
                 socketfd=None):
 
1973
        """If socketfd is set, use that file descriptor instead of
 
1974
        creating a new one with socket.socket().
 
1975
        """
1495
1976
        self.interface = interface
1496
1977
        if use_ipv6:
1497
1978
            self.address_family = socket.AF_INET6
 
1979
        if socketfd is not None:
 
1980
            # Save the file descriptor
 
1981
            self.socketfd = socketfd
 
1982
            # Save the original socket.socket() function
 
1983
            self.socket_socket = socket.socket
 
1984
            # To implement --socket, we monkey patch socket.socket.
 
1985
            # 
 
1986
            # (When socketserver.TCPServer is a new-style class, we
 
1987
            # could make self.socket into a property instead of monkey
 
1988
            # patching socket.socket.)
 
1989
            # 
 
1990
            # Create a one-time-only replacement for socket.socket()
 
1991
            @functools.wraps(socket.socket)
 
1992
            def socket_wrapper(*args, **kwargs):
 
1993
                # Restore original function so subsequent calls are
 
1994
                # not affected.
 
1995
                socket.socket = self.socket_socket
 
1996
                del self.socket_socket
 
1997
                # This time only, return a new socket object from the
 
1998
                # saved file descriptor.
 
1999
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
2000
            # Replace socket.socket() function with wrapper
 
2001
            socket.socket = socket_wrapper
 
2002
        # The socketserver.TCPServer.__init__ will call
 
2003
        # socket.socket(), which might be our replacement,
 
2004
        # socket_wrapper(), if socketfd was set.
1498
2005
        socketserver.TCPServer.__init__(self, server_address,
1499
2006
                                        RequestHandlerClass)
 
2007
    
1500
2008
    def server_bind(self):
1501
2009
        """This overrides the normal server_bind() function
1502
2010
        to bind to an interface if one was specified, and also NOT to
1508
2016
                             self.interface)
1509
2017
            else:
1510
2018
                try:
1511
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1512
 
                                           SO_BINDTODEVICE,
1513
 
                                           str(self.interface
1514
 
                                               + '\0'))
 
2019
                    self.socket.setsockopt(
 
2020
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2021
                        (self.interface + "\0").encode("utf-8"))
1515
2022
                except socket.error as error:
1516
 
                    if error[0] == errno.EPERM:
1517
 
                        logger.error("No permission to"
1518
 
                                     " bind to interface %s",
1519
 
                                     self.interface)
1520
 
                    elif error[0] == errno.ENOPROTOOPT:
 
2023
                    if error.errno == errno.EPERM:
 
2024
                        logger.error("No permission to bind to"
 
2025
                                     " interface %s", self.interface)
 
2026
                    elif error.errno == errno.ENOPROTOOPT:
1521
2027
                        logger.error("SO_BINDTODEVICE not available;"
1522
2028
                                     " cannot bind to interface %s",
1523
2029
                                     self.interface)
 
2030
                    elif error.errno == errno.ENODEV:
 
2031
                        logger.error("Interface %s does not exist,"
 
2032
                                     " cannot bind", self.interface)
1524
2033
                    else:
1525
2034
                        raise
1526
2035
        # Only bind(2) the socket if we really need to.
1529
2038
                if self.address_family == socket.AF_INET6:
1530
2039
                    any_address = "::" # in6addr_any
1531
2040
                else:
1532
 
                    any_address = socket.INADDR_ANY
 
2041
                    any_address = "0.0.0.0" # INADDR_ANY
1533
2042
                self.server_address = (any_address,
1534
2043
                                       self.server_address[1])
1535
2044
            elif not self.server_address[1]:
1536
 
                self.server_address = (self.server_address[0],
1537
 
                                       0)
 
2045
                self.server_address = (self.server_address[0], 0)
1538
2046
#                 if self.interface:
1539
2047
#                     self.server_address = (self.server_address[0],
1540
2048
#                                            0, # port
1554
2062
    
1555
2063
    Assumes a gobject.MainLoop event loop.
1556
2064
    """
 
2065
    
1557
2066
    def __init__(self, server_address, RequestHandlerClass,
1558
 
                 interface=None, use_ipv6=True, clients=None,
1559
 
                 gnutls_priority=None, use_dbus=True):
 
2067
                 interface=None,
 
2068
                 use_ipv6=True,
 
2069
                 clients=None,
 
2070
                 gnutls_priority=None,
 
2071
                 use_dbus=True,
 
2072
                 socketfd=None):
1560
2073
        self.enabled = False
1561
2074
        self.clients = clients
1562
2075
        if self.clients is None:
1563
 
            self.clients = set()
 
2076
            self.clients = {}
1564
2077
        self.use_dbus = use_dbus
1565
2078
        self.gnutls_priority = gnutls_priority
1566
2079
        IPv6_TCPServer.__init__(self, server_address,
1567
2080
                                RequestHandlerClass,
1568
2081
                                interface = interface,
1569
 
                                use_ipv6 = use_ipv6)
 
2082
                                use_ipv6 = use_ipv6,
 
2083
                                socketfd = socketfd)
 
2084
    
1570
2085
    def server_activate(self):
1571
2086
        if self.enabled:
1572
2087
            return socketserver.TCPServer.server_activate(self)
 
2088
    
1573
2089
    def enable(self):
1574
2090
        self.enabled = True
1575
 
    def add_pipe(self, parent_pipe):
 
2091
    
 
2092
    def add_pipe(self, parent_pipe, proc):
1576
2093
        # Call "handle_ipc" for both data and EOF events
1577
 
        gobject.io_add_watch(parent_pipe.fileno(),
1578
 
                             gobject.IO_IN | gobject.IO_HUP,
1579
 
                             functools.partial(self.handle_ipc,
1580
 
                                               parent_pipe = parent_pipe))
1581
 
        
1582
 
    def handle_ipc(self, source, condition, parent_pipe=None,
 
2094
        gobject.io_add_watch(
 
2095
            parent_pipe.fileno(),
 
2096
            gobject.IO_IN | gobject.IO_HUP,
 
2097
            functools.partial(self.handle_ipc,
 
2098
                              parent_pipe = parent_pipe,
 
2099
                              proc = proc))
 
2100
    
 
2101
    def handle_ipc(self, source, condition,
 
2102
                   parent_pipe=None,
 
2103
                   proc = None,
1583
2104
                   client_object=None):
1584
 
        condition_names = {
1585
 
            gobject.IO_IN: "IN",   # There is data to read.
1586
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1587
 
                                    # blocking).
1588
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1589
 
            gobject.IO_ERR: "ERR", # Error condition.
1590
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1591
 
                                    # broken, usually for pipes and
1592
 
                                    # sockets).
1593
 
            }
1594
 
        conditions_string = ' | '.join(name
1595
 
                                       for cond, name in
1596
 
                                       condition_names.iteritems()
1597
 
                                       if cond & condition)
1598
 
        # error or the other end of multiprocessing.Pipe has closed
1599
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2105
        # error, or the other end of multiprocessing.Pipe has closed
 
2106
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2107
            # Wait for other process to exit
 
2108
            proc.join()
1600
2109
            return False
1601
2110
        
1602
2111
        # Read a request from the child
1607
2116
            fpr = request[1]
1608
2117
            address = request[2]
1609
2118
            
1610
 
            for c in self.clients:
 
2119
            for c in self.clients.itervalues():
1611
2120
                if c.fingerprint == fpr:
1612
2121
                    client = c
1613
2122
                    break
1616
2125
                            "dress: %s", fpr, address)
1617
2126
                if self.use_dbus:
1618
2127
                    # Emit D-Bus signal
1619
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2128
                    mandos_dbus_service.ClientNotFound(fpr,
 
2129
                                                       address[0])
1620
2130
                parent_pipe.send(False)
1621
2131
                return False
1622
2132
            
1623
 
            gobject.io_add_watch(parent_pipe.fileno(),
1624
 
                                 gobject.IO_IN | gobject.IO_HUP,
1625
 
                                 functools.partial(self.handle_ipc,
1626
 
                                                   parent_pipe = parent_pipe,
1627
 
                                                   client_object = client))
 
2133
            gobject.io_add_watch(
 
2134
                parent_pipe.fileno(),
 
2135
                gobject.IO_IN | gobject.IO_HUP,
 
2136
                functools.partial(self.handle_ipc,
 
2137
                                  parent_pipe = parent_pipe,
 
2138
                                  proc = proc,
 
2139
                                  client_object = client))
1628
2140
            parent_pipe.send(True)
1629
 
            # remove the old hook in favor of the new above hook on same fileno
 
2141
            # remove the old hook in favor of the new above hook on
 
2142
            # same fileno
1630
2143
            return False
1631
2144
        if command == 'funcall':
1632
2145
            funcname = request[1]
1633
2146
            args = request[2]
1634
2147
            kwargs = request[3]
1635
2148
            
1636
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
 
2149
            parent_pipe.send(('data', getattr(client_object,
 
2150
                                              funcname)(*args,
 
2151
                                                        **kwargs)))
1637
2152
        
1638
2153
        if command == 'getattr':
1639
2154
            attrname = request[1]
1640
 
            if callable(client_object.__getattribute__(attrname)):
1641
 
                parent_pipe.send(('function',))
 
2155
            if isinstance(client_object.__getattribute__(attrname),
 
2156
                          collections.Callable):
 
2157
                parent_pipe.send(('function', ))
1642
2158
            else:
1643
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2159
                parent_pipe.send((
 
2160
                    'data', client_object.__getattribute__(attrname)))
1644
2161
        
1645
2162
        if command == 'setattr':
1646
2163
            attrname = request[1]
1650
2167
        return True
1651
2168
 
1652
2169
 
 
2170
def rfc3339_duration_to_delta(duration):
 
2171
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2172
    
 
2173
    >>> rfc3339_duration_to_delta("P7D")
 
2174
    datetime.timedelta(7)
 
2175
    >>> rfc3339_duration_to_delta("PT60S")
 
2176
    datetime.timedelta(0, 60)
 
2177
    >>> rfc3339_duration_to_delta("PT60M")
 
2178
    datetime.timedelta(0, 3600)
 
2179
    >>> rfc3339_duration_to_delta("PT24H")
 
2180
    datetime.timedelta(1)
 
2181
    >>> rfc3339_duration_to_delta("P1W")
 
2182
    datetime.timedelta(7)
 
2183
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2184
    datetime.timedelta(0, 330)
 
2185
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2186
    datetime.timedelta(1, 200)
 
2187
    """
 
2188
    
 
2189
    # Parsing an RFC 3339 duration with regular expressions is not
 
2190
    # possible - there would have to be multiple places for the same
 
2191
    # values, like seconds.  The current code, while more esoteric, is
 
2192
    # cleaner without depending on a parsing library.  If Python had a
 
2193
    # built-in library for parsing we would use it, but we'd like to
 
2194
    # avoid excessive use of external libraries.
 
2195
    
 
2196
    # New type for defining tokens, syntax, and semantics all-in-one
 
2197
    Token = collections.namedtuple("Token", (
 
2198
        "regexp",  # To match token; if "value" is not None, must have
 
2199
                   # a "group" containing digits
 
2200
        "value",   # datetime.timedelta or None
 
2201
        "followers"))           # Tokens valid after this token
 
2202
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2203
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2204
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2205
    token_second = Token(re.compile(r"(\d+)S"),
 
2206
                         datetime.timedelta(seconds=1),
 
2207
                         frozenset((token_end, )))
 
2208
    token_minute = Token(re.compile(r"(\d+)M"),
 
2209
                         datetime.timedelta(minutes=1),
 
2210
                         frozenset((token_second, token_end)))
 
2211
    token_hour = Token(re.compile(r"(\d+)H"),
 
2212
                       datetime.timedelta(hours=1),
 
2213
                       frozenset((token_minute, token_end)))
 
2214
    token_time = Token(re.compile(r"T"),
 
2215
                       None,
 
2216
                       frozenset((token_hour, token_minute,
 
2217
                                  token_second)))
 
2218
    token_day = Token(re.compile(r"(\d+)D"),
 
2219
                      datetime.timedelta(days=1),
 
2220
                      frozenset((token_time, token_end)))
 
2221
    token_month = Token(re.compile(r"(\d+)M"),
 
2222
                        datetime.timedelta(weeks=4),
 
2223
                        frozenset((token_day, token_end)))
 
2224
    token_year = Token(re.compile(r"(\d+)Y"),
 
2225
                       datetime.timedelta(weeks=52),
 
2226
                       frozenset((token_month, token_end)))
 
2227
    token_week = Token(re.compile(r"(\d+)W"),
 
2228
                       datetime.timedelta(weeks=1),
 
2229
                       frozenset((token_end, )))
 
2230
    token_duration = Token(re.compile(r"P"), None,
 
2231
                           frozenset((token_year, token_month,
 
2232
                                      token_day, token_time,
 
2233
                                      token_week)))
 
2234
    # Define starting values
 
2235
    value = datetime.timedelta() # Value so far
 
2236
    found_token = None
 
2237
    followers = frozenset((token_duration, )) # Following valid tokens
 
2238
    s = duration                # String left to parse
 
2239
    # Loop until end token is found
 
2240
    while found_token is not token_end:
 
2241
        # Search for any currently valid tokens
 
2242
        for token in followers:
 
2243
            match = token.regexp.match(s)
 
2244
            if match is not None:
 
2245
                # Token found
 
2246
                if token.value is not None:
 
2247
                    # Value found, parse digits
 
2248
                    factor = int(match.group(1), 10)
 
2249
                    # Add to value so far
 
2250
                    value += factor * token.value
 
2251
                # Strip token from string
 
2252
                s = token.regexp.sub("", s, 1)
 
2253
                # Go to found token
 
2254
                found_token = token
 
2255
                # Set valid next tokens
 
2256
                followers = found_token.followers
 
2257
                break
 
2258
        else:
 
2259
            # No currently valid tokens were found
 
2260
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2261
                             .format(duration))
 
2262
    # End token found
 
2263
    return value
 
2264
 
 
2265
 
1653
2266
def string_to_delta(interval):
1654
2267
    """Parse a string and return a datetime.timedelta
1655
2268
    
1666
2279
    >>> string_to_delta('5m 30s')
1667
2280
    datetime.timedelta(0, 330)
1668
2281
    """
 
2282
    
 
2283
    try:
 
2284
        return rfc3339_duration_to_delta(interval)
 
2285
    except ValueError:
 
2286
        pass
 
2287
    
1669
2288
    timevalue = datetime.timedelta(0)
1670
2289
    for s in interval.split():
1671
2290
        try:
1672
 
            suffix = unicode(s[-1])
 
2291
            suffix = s[-1]
1673
2292
            value = int(s[:-1])
1674
2293
            if suffix == "d":
1675
2294
                delta = datetime.timedelta(value)
1682
2301
            elif suffix == "w":
1683
2302
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1684
2303
            else:
1685
 
                raise ValueError("Unknown suffix %r" % suffix)
1686
 
        except (ValueError, IndexError) as e:
 
2304
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2305
        except IndexError as e:
1687
2306
            raise ValueError(*(e.args))
1688
2307
        timevalue += delta
1689
2308
    return timevalue
1690
2309
 
1691
2310
 
1692
 
def if_nametoindex(interface):
1693
 
    """Call the C function if_nametoindex(), or equivalent
1694
 
    
1695
 
    Note: This function cannot accept a unicode string."""
1696
 
    global if_nametoindex
1697
 
    try:
1698
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1699
 
                          (ctypes.util.find_library("c"))
1700
 
                          .if_nametoindex)
1701
 
    except (OSError, AttributeError):
1702
 
        logger.warning("Doing if_nametoindex the hard way")
1703
 
        def if_nametoindex(interface):
1704
 
            "Get an interface index the hard way, i.e. using fcntl()"
1705
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1706
 
            with contextlib.closing(socket.socket()) as s:
1707
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1708
 
                                    struct.pack(str("16s16x"),
1709
 
                                                interface))
1710
 
            interface_index = struct.unpack(str("I"),
1711
 
                                            ifreq[16:20])[0]
1712
 
            return interface_index
1713
 
    return if_nametoindex(interface)
1714
 
 
1715
 
 
1716
2311
def daemon(nochdir = False, noclose = False):
1717
2312
    """See daemon(3).  Standard BSD Unix function.
1718
2313
    
1726
2321
        sys.exit()
1727
2322
    if not noclose:
1728
2323
        # Close all standard open file descriptors
1729
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2324
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1730
2325
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1731
2326
            raise OSError(errno.ENODEV,
1732
 
                          "%s not a character device"
1733
 
                          % os.path.devnull)
 
2327
                          "{} not a character device"
 
2328
                          .format(os.devnull))
1734
2329
        os.dup2(null, sys.stdin.fileno())
1735
2330
        os.dup2(null, sys.stdout.fileno())
1736
2331
        os.dup2(null, sys.stderr.fileno())
1745
2340
    
1746
2341
    parser = argparse.ArgumentParser()
1747
2342
    parser.add_argument("-v", "--version", action="version",
1748
 
                        version = "%%(prog)s %s" % version,
 
2343
                        version = "%(prog)s {}".format(version),
1749
2344
                        help="show version number and exit")
1750
2345
    parser.add_argument("-i", "--interface", metavar="IF",
1751
2346
                        help="Bind to interface IF")
1757
2352
                        help="Run self-test")
1758
2353
    parser.add_argument("--debug", action="store_true",
1759
2354
                        help="Debug mode; run in foreground and log"
1760
 
                        " to terminal")
 
2355
                        " to terminal", default=None)
1761
2356
    parser.add_argument("--debuglevel", metavar="LEVEL",
1762
2357
                        help="Debug level for stdout output")
1763
2358
    parser.add_argument("--priority", help="GnuTLS"
1770
2365
                        " files")
1771
2366
    parser.add_argument("--no-dbus", action="store_false",
1772
2367
                        dest="use_dbus", help="Do not provide D-Bus"
1773
 
                        " system bus interface")
 
2368
                        " system bus interface", default=None)
1774
2369
    parser.add_argument("--no-ipv6", action="store_false",
1775
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2370
                        dest="use_ipv6", help="Do not use IPv6",
 
2371
                        default=None)
 
2372
    parser.add_argument("--no-restore", action="store_false",
 
2373
                        dest="restore", help="Do not restore stored"
 
2374
                        " state", default=None)
 
2375
    parser.add_argument("--socket", type=int,
 
2376
                        help="Specify a file descriptor to a network"
 
2377
                        " socket to use instead of creating one")
 
2378
    parser.add_argument("--statedir", metavar="DIR",
 
2379
                        help="Directory to save/restore state in")
 
2380
    parser.add_argument("--foreground", action="store_true",
 
2381
                        help="Run in foreground", default=None)
 
2382
    parser.add_argument("--no-zeroconf", action="store_false",
 
2383
                        dest="zeroconf", help="Do not use Zeroconf",
 
2384
                        default=None)
 
2385
    
1776
2386
    options = parser.parse_args()
1777
2387
    
1778
2388
    if options.check:
1779
2389
        import doctest
1780
 
        doctest.testmod()
1781
 
        sys.exit()
 
2390
        fail_count, test_count = doctest.testmod()
 
2391
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1782
2392
    
1783
2393
    # Default values for config file for server-global settings
1784
2394
    server_defaults = { "interface": "",
1786
2396
                        "port": "",
1787
2397
                        "debug": "False",
1788
2398
                        "priority":
1789
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2399
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2400
                        ":+SIGN-DSA-SHA256",
1790
2401
                        "servicename": "Mandos",
1791
2402
                        "use_dbus": "True",
1792
2403
                        "use_ipv6": "True",
1793
2404
                        "debuglevel": "",
1794
 
                        }
 
2405
                        "restore": "True",
 
2406
                        "socket": "",
 
2407
                        "statedir": "/var/lib/mandos",
 
2408
                        "foreground": "False",
 
2409
                        "zeroconf": "True",
 
2410
                    }
1795
2411
    
1796
2412
    # Parse config file for server-global settings
1797
2413
    server_config = configparser.SafeConfigParser(server_defaults)
1798
2414
    del server_defaults
1799
 
    server_config.read(os.path.join(options.configdir,
1800
 
                                    "mandos.conf"))
 
2415
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
1801
2416
    # Convert the SafeConfigParser object to a dict
1802
2417
    server_settings = server_config.defaults()
1803
2418
    # Use the appropriate methods on the non-string config options
1804
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2419
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1805
2420
        server_settings[option] = server_config.getboolean("DEFAULT",
1806
2421
                                                           option)
1807
2422
    if server_settings["port"]:
1808
2423
        server_settings["port"] = server_config.getint("DEFAULT",
1809
2424
                                                       "port")
 
2425
    if server_settings["socket"]:
 
2426
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2427
                                                         "socket")
 
2428
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2429
        # over with an opened os.devnull.  But we don't want this to
 
2430
        # happen with a supplied network socket.
 
2431
        if 0 <= server_settings["socket"] <= 2:
 
2432
            server_settings["socket"] = os.dup(server_settings
 
2433
                                               ["socket"])
1810
2434
    del server_config
1811
2435
    
1812
2436
    # Override the settings from the config file with command line
1813
2437
    # options, if set.
1814
2438
    for option in ("interface", "address", "port", "debug",
1815
 
                   "priority", "servicename", "configdir",
1816
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2439
                   "priority", "servicename", "configdir", "use_dbus",
 
2440
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2441
                   "socket", "foreground", "zeroconf"):
1817
2442
        value = getattr(options, option)
1818
2443
        if value is not None:
1819
2444
            server_settings[option] = value
1820
2445
    del options
1821
2446
    # Force all strings to be unicode
1822
2447
    for option in server_settings.keys():
1823
 
        if type(server_settings[option]) is str:
1824
 
            server_settings[option] = unicode(server_settings[option])
 
2448
        if isinstance(server_settings[option], bytes):
 
2449
            server_settings[option] = (server_settings[option]
 
2450
                                       .decode("utf-8"))
 
2451
    # Force all boolean options to be boolean
 
2452
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2453
                   "foreground", "zeroconf"):
 
2454
        server_settings[option] = bool(server_settings[option])
 
2455
    # Debug implies foreground
 
2456
    if server_settings["debug"]:
 
2457
        server_settings["foreground"] = True
1825
2458
    # Now we have our good server settings in "server_settings"
1826
2459
    
1827
2460
    ##################################################################
1828
2461
    
 
2462
    if (not server_settings["zeroconf"]
 
2463
        and not (server_settings["port"]
 
2464
                 or server_settings["socket"] != "")):
 
2465
        parser.error("Needs port or socket to work without Zeroconf")
 
2466
    
1829
2467
    # For convenience
1830
2468
    debug = server_settings["debug"]
1831
2469
    debuglevel = server_settings["debuglevel"]
1832
2470
    use_dbus = server_settings["use_dbus"]
1833
2471
    use_ipv6 = server_settings["use_ipv6"]
 
2472
    stored_state_path = os.path.join(server_settings["statedir"],
 
2473
                                     stored_state_file)
 
2474
    foreground = server_settings["foreground"]
 
2475
    zeroconf = server_settings["zeroconf"]
 
2476
    
 
2477
    if debug:
 
2478
        initlogger(debug, logging.DEBUG)
 
2479
    else:
 
2480
        if not debuglevel:
 
2481
            initlogger(debug)
 
2482
        else:
 
2483
            level = getattr(logging, debuglevel.upper())
 
2484
            initlogger(debug, level)
1834
2485
    
1835
2486
    if server_settings["servicename"] != "Mandos":
1836
 
        syslogger.setFormatter(logging.Formatter
1837
 
                               ('Mandos (%s) [%%(process)d]:'
1838
 
                                ' %%(levelname)s: %%(message)s'
1839
 
                                % server_settings["servicename"]))
 
2487
        syslogger.setFormatter(
 
2488
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2489
                              ' %(levelname)s: %(message)s'.format(
 
2490
                                  server_settings["servicename"])))
1840
2491
    
1841
2492
    # Parse config file with clients
1842
 
    client_defaults = { "timeout": "5m",
1843
 
                        "extended_timeout": "15m",
1844
 
                        "interval": "2m",
1845
 
                        "checker": "fping -q -- %%(host)s",
1846
 
                        "host": "",
1847
 
                        "approval_delay": "0s",
1848
 
                        "approval_duration": "1s",
1849
 
                        }
1850
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2493
    client_config = configparser.SafeConfigParser(Client
 
2494
                                                  .client_defaults)
1851
2495
    client_config.read(os.path.join(server_settings["configdir"],
1852
2496
                                    "clients.conf"))
1853
2497
    
1854
2498
    global mandos_dbus_service
1855
2499
    mandos_dbus_service = None
1856
2500
    
1857
 
    tcp_server = MandosServer((server_settings["address"],
1858
 
                               server_settings["port"]),
1859
 
                              ClientHandler,
1860
 
                              interface=(server_settings["interface"]
1861
 
                                         or None),
1862
 
                              use_ipv6=use_ipv6,
1863
 
                              gnutls_priority=
1864
 
                              server_settings["priority"],
1865
 
                              use_dbus=use_dbus)
1866
 
    if not debug:
1867
 
        pidfilename = "/var/run/mandos.pid"
 
2501
    socketfd = None
 
2502
    if server_settings["socket"] != "":
 
2503
        socketfd = server_settings["socket"]
 
2504
    tcp_server = MandosServer(
 
2505
        (server_settings["address"], server_settings["port"]),
 
2506
        ClientHandler,
 
2507
        interface=(server_settings["interface"] or None),
 
2508
        use_ipv6=use_ipv6,
 
2509
        gnutls_priority=server_settings["priority"],
 
2510
        use_dbus=use_dbus,
 
2511
        socketfd=socketfd)
 
2512
    if not foreground:
 
2513
        pidfilename = "/run/mandos.pid"
 
2514
        if not os.path.isdir("/run/."):
 
2515
            pidfilename = "/var/run/mandos.pid"
 
2516
        pidfile = None
1868
2517
        try:
1869
 
            pidfile = open(pidfilename, "w")
1870
 
        except IOError:
1871
 
            logger.error("Could not open file %r", pidfilename)
 
2518
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2519
        except IOError as e:
 
2520
            logger.error("Could not open file %r", pidfilename,
 
2521
                         exc_info=e)
1872
2522
    
1873
 
    try:
1874
 
        uid = pwd.getpwnam("_mandos").pw_uid
1875
 
        gid = pwd.getpwnam("_mandos").pw_gid
1876
 
    except KeyError:
 
2523
    for name in ("_mandos", "mandos", "nobody"):
1877
2524
        try:
1878
 
            uid = pwd.getpwnam("mandos").pw_uid
1879
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2525
            uid = pwd.getpwnam(name).pw_uid
 
2526
            gid = pwd.getpwnam(name).pw_gid
 
2527
            break
1880
2528
        except KeyError:
1881
 
            try:
1882
 
                uid = pwd.getpwnam("nobody").pw_uid
1883
 
                gid = pwd.getpwnam("nobody").pw_gid
1884
 
            except KeyError:
1885
 
                uid = 65534
1886
 
                gid = 65534
 
2529
            continue
 
2530
    else:
 
2531
        uid = 65534
 
2532
        gid = 65534
1887
2533
    try:
1888
2534
        os.setgid(gid)
1889
2535
        os.setuid(uid)
1890
2536
    except OSError as error:
1891
 
        if error[0] != errno.EPERM:
1892
 
            raise error
1893
 
    
1894
 
    if not debug and not debuglevel:
1895
 
        syslogger.setLevel(logging.WARNING)
1896
 
        console.setLevel(logging.WARNING)
1897
 
    if debuglevel:
1898
 
        level = getattr(logging, debuglevel.upper())
1899
 
        syslogger.setLevel(level)
1900
 
        console.setLevel(level)
 
2537
        if error.errno != errno.EPERM:
 
2538
            raise
1901
2539
    
1902
2540
    if debug:
1903
2541
        # Enable all possible GnuTLS debugging
1910
2548
        def debug_gnutls(level, string):
1911
2549
            logger.debug("GnuTLS: %s", string[:-1])
1912
2550
        
1913
 
        (gnutls.library.functions
1914
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2551
        gnutls.library.functions.gnutls_global_set_log_function(
 
2552
            debug_gnutls)
1915
2553
        
1916
2554
        # Redirect stdin so all checkers get /dev/null
1917
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2555
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1918
2556
        os.dup2(null, sys.stdin.fileno())
1919
2557
        if null > 2:
1920
2558
            os.close(null)
1921
 
    else:
1922
 
        # No console logging
1923
 
        logger.removeHandler(console)
1924
2559
    
1925
2560
    # Need to fork before connecting to D-Bus
1926
 
    if not debug:
 
2561
    if not foreground:
1927
2562
        # Close all input and output, do double fork, etc.
1928
2563
        daemon()
1929
2564
    
 
2565
    # multiprocessing will use threads, so before we use gobject we
 
2566
    # need to inform gobject that threads will be used.
 
2567
    gobject.threads_init()
 
2568
    
1930
2569
    global main_loop
1931
2570
    # From the Avahi example code
1932
 
    DBusGMainLoop(set_as_default=True )
 
2571
    DBusGMainLoop(set_as_default=True)
1933
2572
    main_loop = gobject.MainLoop()
1934
2573
    bus = dbus.SystemBus()
1935
2574
    # End of Avahi example code
1936
2575
    if use_dbus:
1937
2576
        try:
1938
 
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1939
 
                                            bus, do_not_queue=True)
1940
 
            bus_name2 = dbus.service.BusName("se.recompile.Mandos",
1941
 
                                            bus, do_not_queue=True)
1942
 
        except dbus.exceptions.NameExistsException as e:
1943
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2577
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
2578
                                            bus,
 
2579
                                            do_not_queue=True)
 
2580
            old_bus_name = dbus.service.BusName(
 
2581
                "se.bsnet.fukt.Mandos", bus,
 
2582
                do_not_queue=True)
 
2583
        except dbus.exceptions.DBusException as e:
 
2584
            logger.error("Disabling D-Bus:", exc_info=e)
1944
2585
            use_dbus = False
1945
2586
            server_settings["use_dbus"] = False
1946
2587
            tcp_server.use_dbus = False
1947
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1948
 
    service = AvahiService(name = server_settings["servicename"],
1949
 
                           servicetype = "_mandos._tcp",
1950
 
                           protocol = protocol, bus = bus)
1951
 
    if server_settings["interface"]:
1952
 
        service.interface = (if_nametoindex
1953
 
                             (str(server_settings["interface"])))
 
2588
    if zeroconf:
 
2589
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2590
        service = AvahiServiceToSyslog(
 
2591
            name = server_settings["servicename"],
 
2592
            servicetype = "_mandos._tcp",
 
2593
            protocol = protocol,
 
2594
            bus = bus)
 
2595
        if server_settings["interface"]:
 
2596
            service.interface = if_nametoindex(
 
2597
                server_settings["interface"].encode("utf-8"))
1954
2598
    
1955
2599
    global multiprocessing_manager
1956
2600
    multiprocessing_manager = multiprocessing.Manager()
1957
2601
    
1958
2602
    client_class = Client
1959
2603
    if use_dbus:
1960
 
        client_class = functools.partial(ClientDBusTransitional, bus = bus)        
1961
 
    def client_config_items(config, section):
1962
 
        special_settings = {
1963
 
            "approved_by_default":
1964
 
                lambda: config.getboolean(section,
1965
 
                                          "approved_by_default"),
1966
 
            }
1967
 
        for name, value in config.items(section):
 
2604
        client_class = functools.partial(ClientDBus, bus = bus)
 
2605
    
 
2606
    client_settings = Client.config_parser(client_config)
 
2607
    old_client_settings = {}
 
2608
    clients_data = {}
 
2609
    
 
2610
    # This is used to redirect stdout and stderr for checker processes
 
2611
    global wnull
 
2612
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2613
    # Only used if server is running in foreground but not in debug
 
2614
    # mode
 
2615
    if debug or not foreground:
 
2616
        wnull.close()
 
2617
    
 
2618
    # Get client data and settings from last running state.
 
2619
    if server_settings["restore"]:
 
2620
        try:
 
2621
            with open(stored_state_path, "rb") as stored_state:
 
2622
                clients_data, old_client_settings = pickle.load(
 
2623
                    stored_state)
 
2624
            os.remove(stored_state_path)
 
2625
        except IOError as e:
 
2626
            if e.errno == errno.ENOENT:
 
2627
                logger.warning("Could not load persistent state:"
 
2628
                               " {}".format(os.strerror(e.errno)))
 
2629
            else:
 
2630
                logger.critical("Could not load persistent state:",
 
2631
                                exc_info=e)
 
2632
                raise
 
2633
        except EOFError as e:
 
2634
            logger.warning("Could not load persistent state: "
 
2635
                           "EOFError:",
 
2636
                           exc_info=e)
 
2637
    
 
2638
    with PGPEngine() as pgp:
 
2639
        for client_name, client in clients_data.items():
 
2640
            # Skip removed clients
 
2641
            if client_name not in client_settings:
 
2642
                continue
 
2643
            
 
2644
            # Decide which value to use after restoring saved state.
 
2645
            # We have three different values: Old config file,
 
2646
            # new config file, and saved state.
 
2647
            # New config value takes precedence if it differs from old
 
2648
            # config value, otherwise use saved state.
 
2649
            for name, value in client_settings[client_name].items():
 
2650
                try:
 
2651
                    # For each value in new config, check if it
 
2652
                    # differs from the old config value (Except for
 
2653
                    # the "secret" attribute)
 
2654
                    if (name != "secret"
 
2655
                        and (value !=
 
2656
                             old_client_settings[client_name][name])):
 
2657
                        client[name] = value
 
2658
                except KeyError:
 
2659
                    pass
 
2660
            
 
2661
            # Clients who has passed its expire date can still be
 
2662
            # enabled if its last checker was successful.  A Client
 
2663
            # whose checker succeeded before we stored its state is
 
2664
            # assumed to have successfully run all checkers during
 
2665
            # downtime.
 
2666
            if client["enabled"]:
 
2667
                if datetime.datetime.utcnow() >= client["expires"]:
 
2668
                    if not client["last_checked_ok"]:
 
2669
                        logger.warning(
 
2670
                            "disabling client {} - Client never "
 
2671
                            "performed a successful checker".format(
 
2672
                                client_name))
 
2673
                        client["enabled"] = False
 
2674
                    elif client["last_checker_status"] != 0:
 
2675
                        logger.warning(
 
2676
                            "disabling client {} - Client last"
 
2677
                            " checker failed with error code"
 
2678
                            " {}".format(
 
2679
                                client_name,
 
2680
                                client["last_checker_status"]))
 
2681
                        client["enabled"] = False
 
2682
                    else:
 
2683
                        client["expires"] = (
 
2684
                            datetime.datetime.utcnow()
 
2685
                            + client["timeout"])
 
2686
                        logger.debug("Last checker succeeded,"
 
2687
                                     " keeping {} enabled".format(
 
2688
                                         client_name))
1968
2689
            try:
1969
 
                yield (name, special_settings[name]())
1970
 
            except KeyError:
1971
 
                yield (name, value)
1972
 
    
1973
 
    tcp_server.clients.update(set(
1974
 
            client_class(name = section,
1975
 
                         config= dict(client_config_items(
1976
 
                        client_config, section)))
1977
 
            for section in client_config.sections()))
 
2690
                client["secret"] = pgp.decrypt(
 
2691
                    client["encrypted_secret"],
 
2692
                    client_settings[client_name]["secret"])
 
2693
            except PGPError:
 
2694
                # If decryption fails, we use secret from new settings
 
2695
                logger.debug("Failed to decrypt {} old secret".format(
 
2696
                    client_name))
 
2697
                client["secret"] = (client_settings[client_name]
 
2698
                                    ["secret"])
 
2699
    
 
2700
    # Add/remove clients based on new changes made to config
 
2701
    for client_name in (set(old_client_settings)
 
2702
                        - set(client_settings)):
 
2703
        del clients_data[client_name]
 
2704
    for client_name in (set(client_settings)
 
2705
                        - set(old_client_settings)):
 
2706
        clients_data[client_name] = client_settings[client_name]
 
2707
    
 
2708
    # Create all client objects
 
2709
    for client_name, client in clients_data.items():
 
2710
        tcp_server.clients[client_name] = client_class(
 
2711
            name = client_name,
 
2712
            settings = client,
 
2713
            server_settings = server_settings)
 
2714
    
1978
2715
    if not tcp_server.clients:
1979
2716
        logger.warning("No clients defined")
1980
 
        
1981
 
    if not debug:
1982
 
        try:
1983
 
            with pidfile:
1984
 
                pid = os.getpid()
1985
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
1986
 
            del pidfile
1987
 
        except IOError:
1988
 
            logger.error("Could not write to file %r with PID %d",
1989
 
                         pidfilename, pid)
1990
 
        except NameError:
1991
 
            # "pidfile" was never created
1992
 
            pass
 
2717
    
 
2718
    if not foreground:
 
2719
        if pidfile is not None:
 
2720
            pid = os.getpid()
 
2721
            try:
 
2722
                with pidfile:
 
2723
                    print(pid, file=pidfile)
 
2724
            except IOError:
 
2725
                logger.error("Could not write to file %r with PID %d",
 
2726
                             pidfilename, pid)
 
2727
        del pidfile
1993
2728
        del pidfilename
1994
 
        
1995
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1996
2729
    
1997
2730
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1998
2731
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1999
2732
    
2000
2733
    if use_dbus:
2001
 
        class MandosDBusService(dbus.service.Object):
 
2734
        
 
2735
        @alternate_dbus_interfaces(
 
2736
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2737
        class MandosDBusService(DBusObjectWithProperties):
2002
2738
            """A D-Bus proxy object"""
 
2739
            
2003
2740
            def __init__(self):
2004
2741
                dbus.service.Object.__init__(self, bus, "/")
2005
 
            _interface = "se.bsnet.fukt.Mandos"
 
2742
            
 
2743
            _interface = "se.recompile.Mandos"
 
2744
            
 
2745
            @dbus_interface_annotations(_interface)
 
2746
            def _foo(self):
 
2747
                return {
 
2748
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2749
                    "false" }
2006
2750
            
2007
2751
            @dbus.service.signal(_interface, signature="o")
2008
2752
            def ClientAdded(self, objpath):
2022
2766
            @dbus.service.method(_interface, out_signature="ao")
2023
2767
            def GetAllClients(self):
2024
2768
                "D-Bus method"
2025
 
                return dbus.Array(c.dbus_object_path
2026
 
                                  for c in tcp_server.clients)
 
2769
                return dbus.Array(c.dbus_object_path for c in
 
2770
                                  tcp_server.clients.itervalues())
2027
2771
            
2028
2772
            @dbus.service.method(_interface,
2029
2773
                                 out_signature="a{oa{sv}}")
2030
2774
            def GetAllClientsWithProperties(self):
2031
2775
                "D-Bus method"
2032
2776
                return dbus.Dictionary(
2033
 
                    ((c.dbus_object_path, c.GetAll(""))
2034
 
                     for c in tcp_server.clients),
 
2777
                    { c.dbus_object_path: c.GetAll("")
 
2778
                      for c in tcp_server.clients.itervalues() },
2035
2779
                    signature="oa{sv}")
2036
2780
            
2037
2781
            @dbus.service.method(_interface, in_signature="o")
2038
2782
            def RemoveClient(self, object_path):
2039
2783
                "D-Bus method"
2040
 
                for c in tcp_server.clients:
 
2784
                for c in tcp_server.clients.itervalues():
2041
2785
                    if c.dbus_object_path == object_path:
2042
 
                        tcp_server.clients.remove(c)
 
2786
                        del tcp_server.clients[c.name]
2043
2787
                        c.remove_from_connection()
2044
2788
                        # Don't signal anything except ClientRemoved
2045
2789
                        c.disable(quiet=True)
2050
2794
            
2051
2795
            del _interface
2052
2796
        
2053
 
        class MandosDBusServiceTransitional(MandosDBusService):
2054
 
            __metaclass__ = transitional_dbus_metaclass
2055
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2797
        mandos_dbus_service = MandosDBusService()
2056
2798
    
2057
2799
    def cleanup():
2058
2800
        "Cleanup function; run on exit"
2059
 
        service.cleanup()
2060
 
        
 
2801
        if zeroconf:
 
2802
            service.cleanup()
 
2803
        
 
2804
        multiprocessing.active_children()
 
2805
        wnull.close()
 
2806
        if not (tcp_server.clients or client_settings):
 
2807
            return
 
2808
        
 
2809
        # Store client before exiting. Secrets are encrypted with key
 
2810
        # based on what config file has. If config file is
 
2811
        # removed/edited, old secret will thus be unrecovable.
 
2812
        clients = {}
 
2813
        with PGPEngine() as pgp:
 
2814
            for client in tcp_server.clients.itervalues():
 
2815
                key = client_settings[client.name]["secret"]
 
2816
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2817
                                                      key)
 
2818
                client_dict = {}
 
2819
                
 
2820
                # A list of attributes that can not be pickled
 
2821
                # + secret.
 
2822
                exclude = { "bus", "changedstate", "secret",
 
2823
                            "checker", "server_settings" }
 
2824
                for name, typ in inspect.getmembers(dbus.service
 
2825
                                                    .Object):
 
2826
                    exclude.add(name)
 
2827
                
 
2828
                client_dict["encrypted_secret"] = (client
 
2829
                                                   .encrypted_secret)
 
2830
                for attr in client.client_structure:
 
2831
                    if attr not in exclude:
 
2832
                        client_dict[attr] = getattr(client, attr)
 
2833
                
 
2834
                clients[client.name] = client_dict
 
2835
                del client_settings[client.name]["secret"]
 
2836
        
 
2837
        try:
 
2838
            with tempfile.NamedTemporaryFile(
 
2839
                    mode='wb',
 
2840
                    suffix=".pickle",
 
2841
                    prefix='clients-',
 
2842
                    dir=os.path.dirname(stored_state_path),
 
2843
                    delete=False) as stored_state:
 
2844
                pickle.dump((clients, client_settings), stored_state)
 
2845
                tempname = stored_state.name
 
2846
            os.rename(tempname, stored_state_path)
 
2847
        except (IOError, OSError) as e:
 
2848
            if not debug:
 
2849
                try:
 
2850
                    os.remove(tempname)
 
2851
                except NameError:
 
2852
                    pass
 
2853
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2854
                logger.warning("Could not save persistent state: {}"
 
2855
                               .format(os.strerror(e.errno)))
 
2856
            else:
 
2857
                logger.warning("Could not save persistent state:",
 
2858
                               exc_info=e)
 
2859
                raise
 
2860
        
 
2861
        # Delete all clients, and settings from config
2061
2862
        while tcp_server.clients:
2062
 
            client = tcp_server.clients.pop()
 
2863
            name, client = tcp_server.clients.popitem()
2063
2864
            if use_dbus:
2064
2865
                client.remove_from_connection()
2065
 
            client.disable_hook = None
2066
2866
            # Don't signal anything except ClientRemoved
2067
2867
            client.disable(quiet=True)
2068
2868
            if use_dbus:
2069
2869
                # Emit D-Bus signal
2070
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2071
 
                                                  client.name)
 
2870
                mandos_dbus_service.ClientRemoved(
 
2871
                    client.dbus_object_path, client.name)
 
2872
        client_settings.clear()
2072
2873
    
2073
2874
    atexit.register(cleanup)
2074
2875
    
2075
 
    for client in tcp_server.clients:
 
2876
    for client in tcp_server.clients.itervalues():
2076
2877
        if use_dbus:
2077
2878
            # Emit D-Bus signal
2078
2879
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2079
 
        client.enable()
 
2880
        # Need to initiate checking of clients
 
2881
        if client.enabled:
 
2882
            client.init_checker()
2080
2883
    
2081
2884
    tcp_server.enable()
2082
2885
    tcp_server.server_activate()
2083
2886
    
2084
2887
    # Find out what port we got
2085
 
    service.port = tcp_server.socket.getsockname()[1]
 
2888
    if zeroconf:
 
2889
        service.port = tcp_server.socket.getsockname()[1]
2086
2890
    if use_ipv6:
2087
2891
        logger.info("Now listening on address %r, port %d,"
2088
 
                    " flowinfo %d, scope_id %d"
2089
 
                    % tcp_server.socket.getsockname())
 
2892
                    " flowinfo %d, scope_id %d",
 
2893
                    *tcp_server.socket.getsockname())
2090
2894
    else:                       # IPv4
2091
 
        logger.info("Now listening on address %r, port %d"
2092
 
                    % tcp_server.socket.getsockname())
 
2895
        logger.info("Now listening on address %r, port %d",
 
2896
                    *tcp_server.socket.getsockname())
2093
2897
    
2094
2898
    #service.interface = tcp_server.socket.getsockname()[3]
2095
2899
    
2096
2900
    try:
2097
 
        # From the Avahi example code
2098
 
        try:
2099
 
            service.activate()
2100
 
        except dbus.exceptions.DBusException as error:
2101
 
            logger.critical("DBusException: %s", error)
2102
 
            cleanup()
2103
 
            sys.exit(1)
2104
 
        # End of Avahi example code
 
2901
        if zeroconf:
 
2902
            # From the Avahi example code
 
2903
            try:
 
2904
                service.activate()
 
2905
            except dbus.exceptions.DBusException as error:
 
2906
                logger.critical("D-Bus Exception", exc_info=error)
 
2907
                cleanup()
 
2908
                sys.exit(1)
 
2909
            # End of Avahi example code
2105
2910
        
2106
2911
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2107
2912
                             lambda *args, **kwargs:
2111
2916
        logger.debug("Starting main loop")
2112
2917
        main_loop.run()
2113
2918
    except AvahiError as error:
2114
 
        logger.critical("AvahiError: %s", error)
 
2919
        logger.critical("Avahi Error", exc_info=error)
2115
2920
        cleanup()
2116
2921
        sys.exit(1)
2117
2922
    except KeyboardInterrupt: