/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
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.4.1"
87
 
 
88
 
#logger = logging.getLogger('mandos')
89
 
logger = logging.Logger('mandos')
90
 
syslogger = (logging.handlers.SysLogHandler
91
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
 
              address = str("/dev/log")))
93
 
syslogger.setFormatter(logging.Formatter
94
 
                       ('Mandos [%(process)d]: %(levelname)s:'
95
 
                        ' %(message)s'))
96
 
logger.addHandler(syslogger)
97
 
 
98
 
console = logging.StreamHandler()
99
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
100
 
                                       ' %(levelname)s:'
101
 
                                       ' %(message)s'))
102
 
logger.addHandler(console)
 
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
164
 
                            .GetAlternativeServiceName(self.name))
 
306
        self.name = str(
 
307
            self.server.GetAlternativeServiceName(self.name))
 
308
        self.rename_count += 1
165
309
        logger.info("Changing Zeroconf service name to %r ...",
166
310
                    self.name)
167
 
        syslogger.setFormatter(logging.Formatter
168
 
                               ('Mandos (%s) [%%(process)d]:'
169
 
                                ' %%(levelname)s: %%(message)s'
170
 
                                % self.name))
171
 
        self.remove()
 
311
        if remove:
 
312
            self.remove()
172
313
        try:
173
314
            self.add()
174
315
        except dbus.exceptions.DBusException as error:
175
 
            logger.critical("DBusException: %s", error)
176
 
            self.cleanup()
177
 
            os._exit(1)
178
 
        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
    
179
325
    def remove(self):
180
326
        """Derived from the Avahi example code"""
181
327
        if self.entry_group_state_changed_match is not None:
183
329
            self.entry_group_state_changed_match = None
184
330
        if self.group is not None:
185
331
            self.group.Reset()
 
332
    
186
333
    def add(self):
187
334
        """Derived from the Avahi example code"""
188
335
        self.remove()
193
340
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
194
341
        self.entry_group_state_changed_match = (
195
342
            self.group.connect_to_signal(
196
 
                'StateChanged', self .entry_group_state_changed))
 
343
                'StateChanged', self.entry_group_state_changed))
197
344
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
198
345
                     self.name, self.type)
199
346
        self.group.AddService(
205
352
            dbus.UInt16(self.port),
206
353
            avahi.string_array_to_txt_array(self.TXT))
207
354
        self.group.Commit()
 
355
    
208
356
    def entry_group_state_changed(self, state, error):
209
357
        """Derived from the Avahi example code"""
210
358
        logger.debug("Avahi entry group state change: %i", state)
216
364
            self.rename()
217
365
        elif state == avahi.ENTRY_GROUP_FAILURE:
218
366
            logger.critical("Avahi: Error in group state changed %s",
219
 
                            unicode(error))
220
 
            raise AvahiGroupError("State changed: %s"
221
 
                                  % unicode(error))
 
367
                            str(error))
 
368
            raise AvahiGroupError("State changed: {!s}".format(error))
 
369
    
222
370
    def cleanup(self):
223
371
        """Derived from the Avahi example code"""
224
372
        if self.group is not None:
225
373
            try:
226
374
                self.group.Free()
227
375
            except (dbus.exceptions.UnknownMethodException,
228
 
                    dbus.exceptions.DBusException) as e:
 
376
                    dbus.exceptions.DBusException):
229
377
                pass
230
378
            self.group = None
231
379
        self.remove()
 
380
    
232
381
    def server_state_changed(self, state, error=None):
233
382
        """Derived from the Avahi example code"""
234
383
        logger.debug("Avahi server state change: %i", state)
235
 
        bad_states = { avahi.SERVER_INVALID:
236
 
                           "Zeroconf server invalid",
237
 
                       avahi.SERVER_REGISTERING: None,
238
 
                       avahi.SERVER_COLLISION:
239
 
                           "Zeroconf server name collision",
240
 
                       avahi.SERVER_FAILURE:
241
 
                           "Zeroconf server failure" }
 
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
        }
242
390
        if state in bad_states:
243
391
            if bad_states[state] is not None:
244
392
                if error is None:
247
395
                    logger.error(bad_states[state] + ": %r", error)
248
396
            self.cleanup()
249
397
        elif state == avahi.SERVER_RUNNING:
250
 
            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)
251
410
        else:
252
411
            if error is None:
253
412
                logger.debug("Unknown state: %r", state)
254
413
            else:
255
414
                logger.debug("Unknown state: %r: %r", state, error)
 
415
    
256
416
    def activate(self):
257
417
        """Derived from the Avahi example code"""
258
418
        if self.server is None:
262
422
                                    follow_name_owner_changes=True),
263
423
                avahi.DBUS_INTERFACE_SERVER)
264
424
        self.server.connect_to_signal("StateChanged",
265
 
                                 self.server_state_changed)
 
425
                                      self.server_state_changed)
266
426
        self.server_state_changed(self.server.GetState())
267
427
 
268
428
 
269
 
def _timedelta_to_milliseconds(td):
270
 
    "Convert a datetime.timedelta() to milliseconds"
271
 
    return ((td.days * 24 * 60 * 60 * 1000)
272
 
            + (td.seconds * 1000)
273
 
            + (td.microseconds // 1000))
274
 
        
 
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
 
275
448
class Client(object):
276
449
    """A representation of a client host served by this server.
277
450
    
278
451
    Attributes:
279
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
452
    approved:   bool(); 'None' if not yet approved/disapproved
280
453
    approval_delay: datetime.timedelta(); Time to wait for approval
281
454
    approval_duration: datetime.timedelta(); Duration of one approval
282
455
    checker:    subprocess.Popen(); a running checker process used
289
462
                     instance %(name)s can be used in the command.
290
463
    checker_initiator_tag: a gobject event source tag, or None
291
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
292
467
    current_checker_command: string; current running checker_command
293
 
    disable_hook:  If set, called by disable() as disable_hook(self)
294
468
    disable_initiator_tag: a gobject event source tag, or None
295
469
    enabled:    bool()
296
470
    fingerprint: string (40 or 32 hexadecimal digits); used to
299
473
    interval:   datetime.timedelta(); How often to start a new checker
300
474
    last_approval_request: datetime.datetime(); (UTC) or None
301
475
    last_checked_ok: datetime.datetime(); (UTC) or None
302
 
    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
303
482
    name:       string; from the config file, used in log messages and
304
483
                        D-Bus identifiers
305
484
    secret:     bytestring; sent verbatim (over TLS) to client
306
485
    timeout:    datetime.timedelta(); How long from last_checked_ok
307
486
                                      until this client is disabled
308
 
    extended_timeout:   extra long timeout when password has been sent
 
487
    extended_timeout:   extra long timeout when secret has been sent
309
488
    runtime_expansions: Allowed attributes for runtime expansion.
310
489
    expires:    datetime.datetime(); time (UTC) when a client will be
311
490
                disabled, or None
 
491
    server_settings: The server_settings dict from main()
312
492
    """
313
493
    
314
494
    runtime_expansions = ("approval_delay", "approval_duration",
315
 
                          "created", "enabled", "fingerprint",
316
 
                          "host", "interval", "last_checked_ok",
 
495
                          "created", "enabled", "expires",
 
496
                          "fingerprint", "host", "interval",
 
497
                          "last_approval_request", "last_checked_ok",
317
498
                          "last_enabled", "name", "timeout")
318
 
    
319
 
    def timeout_milliseconds(self):
320
 
        "Return the 'timeout' attribute in milliseconds"
321
 
        return _timedelta_to_milliseconds(self.timeout)
322
 
    
323
 
    def extended_timeout_milliseconds(self):
324
 
        "Return the 'extended_timeout' attribute in milliseconds"
325
 
        return _timedelta_to_milliseconds(self.extended_timeout)
326
 
    
327
 
    def interval_milliseconds(self):
328
 
        "Return the 'interval' attribute in milliseconds"
329
 
        return _timedelta_to_milliseconds(self.interval)
330
 
    
331
 
    def approval_delay_milliseconds(self):
332
 
        return _timedelta_to_milliseconds(self.approval_delay)
333
 
    
334
 
    def __init__(self, name = None, disable_hook=None, config=None):
335
 
        """Note: the 'checker' key in 'config' sets the
336
 
        'checker_command' attribute and *not* the 'checker'
337
 
        attribute."""
 
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):
338
562
        self.name = name
339
 
        if config is None:
340
 
            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
        
341
580
        logger.debug("Creating client %r", self.name)
342
 
        # Uppercase and remove spaces from fingerprint for later
343
 
        # comparison purposes with return value from the fingerprint()
344
 
        # function
345
 
        self.fingerprint = (config["fingerprint"].upper()
346
 
                            .replace(" ", ""))
347
581
        logger.debug("  Fingerprint: %s", self.fingerprint)
348
 
        if "secret" in config:
349
 
            self.secret = config["secret"].decode("base64")
350
 
        elif "secfile" in config:
351
 
            with open(os.path.expanduser(os.path.expandvars
352
 
                                         (config["secfile"])),
353
 
                      "rb") as secfile:
354
 
                self.secret = secfile.read()
355
 
        else:
356
 
            raise TypeError("No secret or secfile for client %s"
357
 
                            % self.name)
358
 
        self.host = config.get("host", "")
359
 
        self.created = datetime.datetime.utcnow()
360
 
        self.enabled = False
361
 
        self.last_approval_request = None
362
 
        self.last_enabled = None
363
 
        self.last_checked_ok = None
364
 
        self.timeout = string_to_delta(config["timeout"])
365
 
        self.extended_timeout = string_to_delta(config
366
 
                                                ["extended_timeout"])
367
 
        self.interval = string_to_delta(config["interval"])
368
 
        self.disable_hook = disable_hook
 
582
        self.created = settings.get("created",
 
583
                                    datetime.datetime.utcnow())
 
584
        
 
585
        # attributes specific for this server instance
369
586
        self.checker = None
370
587
        self.checker_initiator_tag = None
371
588
        self.disable_initiator_tag = None
372
 
        self.expires = None
373
589
        self.checker_callback_tag = None
374
 
        self.checker_command = config["checker"]
375
590
        self.current_checker_command = None
376
 
        self.last_connect = None
377
 
        self._approved = None
378
 
        self.approved_by_default = config.get("approved_by_default",
379
 
                                              True)
 
591
        self.approved = None
380
592
        self.approvals_pending = 0
381
 
        self.approval_delay = string_to_delta(
382
 
            config["approval_delay"])
383
 
        self.approval_duration = string_to_delta(
384
 
            config["approval_duration"])
385
 
        self.changedstate = (multiprocessing_manager
386
 
                             .Condition(multiprocessing_manager
387
 
                                        .Lock()))
 
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)
388
604
    
 
605
    # Send notice to process children that client state has changed
389
606
    def send_changedstate(self):
390
 
        self.changedstate.acquire()
391
 
        self.changedstate.notify_all()
392
 
        self.changedstate.release()
 
607
        with self.changedstate:
 
608
            self.changedstate.notify_all()
393
609
    
394
610
    def enable(self):
395
611
        """Start this client's checker and timeout hooks"""
396
612
        if getattr(self, "enabled", False):
397
613
            # Already enabled
398
614
            return
399
 
        self.send_changedstate()
400
 
        # Schedule a new checker to be started an 'interval' from now,
401
 
        # and every interval from then on.
402
 
        self.checker_initiator_tag = (gobject.timeout_add
403
 
                                      (self.interval_milliseconds(),
404
 
                                       self.start_checker))
405
 
        # Schedule a disable() when 'timeout' has passed
406
615
        self.expires = datetime.datetime.utcnow() + self.timeout
407
 
        self.disable_initiator_tag = (gobject.timeout_add
408
 
                                   (self.timeout_milliseconds(),
409
 
                                    self.disable))
410
616
        self.enabled = True
411
617
        self.last_enabled = datetime.datetime.utcnow()
412
 
        # Also start a new checker *right now*.
413
 
        self.start_checker()
 
618
        self.init_checker()
 
619
        self.send_changedstate()
414
620
    
415
621
    def disable(self, quiet=True):
416
622
        """Disable this client."""
417
623
        if not getattr(self, "enabled", False):
418
624
            return False
419
625
        if not quiet:
420
 
            self.send_changedstate()
421
 
        if not quiet:
422
626
            logger.info("Disabling client %s", self.name)
423
 
        if getattr(self, "disable_initiator_tag", False):
 
627
        if getattr(self, "disable_initiator_tag", None) is not None:
424
628
            gobject.source_remove(self.disable_initiator_tag)
425
629
            self.disable_initiator_tag = None
426
630
        self.expires = None
427
 
        if getattr(self, "checker_initiator_tag", False):
 
631
        if getattr(self, "checker_initiator_tag", None) is not None:
428
632
            gobject.source_remove(self.checker_initiator_tag)
429
633
            self.checker_initiator_tag = None
430
634
        self.stop_checker()
431
 
        if self.disable_hook:
432
 
            self.disable_hook(self)
433
635
        self.enabled = False
 
636
        if not quiet:
 
637
            self.send_changedstate()
434
638
        # Do not run this again if called by a gobject.timeout_add
435
639
        return False
436
640
    
437
641
    def __del__(self):
438
 
        self.disable_hook = None
439
642
        self.disable()
440
643
    
441
 
    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):
442
662
        """The checker has completed, so take appropriate actions."""
443
663
        self.checker_callback_tag = None
444
664
        self.checker = None
445
 
        if os.WIFEXITED(condition):
446
 
            exitstatus = os.WEXITSTATUS(condition)
447
 
            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:
448
673
                logger.info("Checker for %(name)s succeeded",
449
674
                            vars(self))
450
675
                self.checked_ok()
451
676
            else:
452
 
                logger.info("Checker for %(name)s failed",
453
 
                            vars(self))
 
677
                logger.info("Checker for %(name)s failed", vars(self))
454
678
        else:
 
679
            self.last_checker_status = -1
 
680
            self.last_checker_signal = -returncode
455
681
            logger.warning("Checker for %(name)s crashed?",
456
682
                           vars(self))
457
 
    
458
 
    def checked_ok(self, timeout=None):
459
 
        """Bump up the timeout for this client.
460
 
        
461
 
        This should only be called when the client has been seen,
462
 
        alive and well.
463
 
        """
 
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."""
464
694
        if timeout is None:
465
695
            timeout = self.timeout
466
 
        self.last_checked_ok = datetime.datetime.utcnow()
467
696
        if self.disable_initiator_tag is not None:
468
697
            gobject.source_remove(self.disable_initiator_tag)
 
698
            self.disable_initiator_tag = None
469
699
        if getattr(self, "enabled", False):
470
 
            self.disable_initiator_tag = (gobject.timeout_add
471
 
                                          (_timedelta_to_milliseconds
472
 
                                           (timeout), self.disable))
 
700
            self.disable_initiator_tag = gobject.timeout_add(
 
701
                int(timeout.total_seconds() * 1000), self.disable)
473
702
            self.expires = datetime.datetime.utcnow() + timeout
474
703
    
475
704
    def need_approval(self):
481
710
        If a checker already exists, leave it running and do
482
711
        nothing."""
483
712
        # The reason for not killing a running checker is that if we
484
 
        # did that, then if a checker (for some reason) started
485
 
        # running slowly and taking more than 'interval' time, the
486
 
        # client would inevitably timeout, since no checker would get
487
 
        # a chance to run to completion.  If we instead leave running
 
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
488
717
        # checkers alone, the checker would have to take more time
489
718
        # than 'timeout' for the client to be disabled, which is as it
490
719
        # should be.
491
720
        
492
 
        # If a checker exists, make sure it is not a zombie
493
 
        try:
494
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
495
 
        except (AttributeError, OSError) as error:
496
 
            if (isinstance(error, OSError)
497
 
                and error.errno != errno.ECHILD):
498
 
                raise error
499
 
        else:
500
 
            if pid:
501
 
                logger.warning("Checker was a zombie")
502
 
                gobject.source_remove(self.checker_callback_tag)
503
 
                self.checker_callback(pid, status,
504
 
                                      self.current_checker_command)
 
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
505
725
        # Start a new checker if needed
506
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 }
507
731
            try:
508
 
                # In case checker_command has exactly one % operator
509
 
                command = self.checker_command % self.host
510
 
            except TypeError:
511
 
                # Escape attributes for the shell
512
 
                escaped_attrs = dict(
513
 
                    (attr,
514
 
                     re.escape(unicode(str(getattr(self, attr, "")),
515
 
                                       errors=
516
 
                                       'replace')))
517
 
                    for attr in
518
 
                    self.runtime_expansions)
519
 
                
520
 
                try:
521
 
                    command = self.checker_command % escaped_attrs
522
 
                except TypeError as error:
523
 
                    logger.error('Could not format string "%s":'
524
 
                                 ' %s', self.checker_command, error)
525
 
                    return True # Try again later
 
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
526
738
            self.current_checker_command = command
527
 
            try:
528
 
                logger.info("Starting checker %r for %s",
529
 
                            command, self.name)
530
 
                # We don't need to redirect stdout and stderr, since
531
 
                # in normal mode, that is already done by daemon(),
532
 
                # and in debug mode we don't want to.  (Stdin is
533
 
                # always replaced by /dev/null.)
534
 
                self.checker = subprocess.Popen(command,
535
 
                                                close_fds=True,
536
 
                                                shell=True, cwd="/")
537
 
                self.checker_callback_tag = (gobject.child_watch_add
538
 
                                             (self.checker.pid,
539
 
                                              self.checker_callback,
540
 
                                              data=command))
541
 
                # The checker may have completed before the gobject
542
 
                # watch was added.  Check for this.
543
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
544
 
                if pid:
545
 
                    gobject.source_remove(self.checker_callback_tag)
546
 
                    self.checker_callback(pid, status, command)
547
 
            except OSError as error:
548
 
                logger.error("Failed to start subprocess: %s",
549
 
                             error)
 
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)
550
764
        # Re-run this periodically if run by gobject.timeout_add
551
765
        return True
552
766
    
558
772
        if getattr(self, "checker", None) is None:
559
773
            return
560
774
        logger.debug("Stopping checker for %(name)s", vars(self))
561
 
        try:
562
 
            os.kill(self.checker.pid, signal.SIGTERM)
563
 
            #time.sleep(0.5)
564
 
            #if self.checker.poll() is None:
565
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
566
 
        except OSError as error:
567
 
            if error.errno != errno.ESRCH: # No such process
568
 
                raise
 
775
        self.checker.terminate()
569
776
        self.checker = None
570
777
 
571
778
 
572
 
def dbus_service_property(dbus_interface, signature="v",
573
 
                          access="readwrite", byte_arrays=False):
 
779
def dbus_service_property(dbus_interface,
 
780
                          signature="v",
 
781
                          access="readwrite",
 
782
                          byte_arrays=False):
574
783
    """Decorators for marking methods of a DBusObjectWithProperties to
575
784
    become properties on the D-Bus.
576
785
    
585
794
    # "Set" method, so we fail early here:
586
795
    if byte_arrays and signature != "ay":
587
796
        raise ValueError("Byte arrays not supported for non-'ay'"
588
 
                         " signature %r" % signature)
 
797
                         " signature {!r}".format(signature))
 
798
    
589
799
    def decorator(func):
590
800
        func._dbus_is_property = True
591
801
        func._dbus_interface = dbus_interface
596
806
            func._dbus_name = func._dbus_name[:-14]
597
807
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
598
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
    
599
851
    return decorator
600
852
 
601
853
 
602
854
class DBusPropertyException(dbus.exceptions.DBusException):
603
855
    """A base class for D-Bus property-related exceptions
604
856
    """
605
 
    def __unicode__(self):
606
 
        return unicode(str(self))
 
857
    pass
607
858
 
608
859
 
609
860
class DBusPropertyAccessException(DBusPropertyException):
627
878
    """
628
879
    
629
880
    @staticmethod
630
 
    def _is_dbus_property(obj):
631
 
        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)
632
889
    
633
 
    def _get_all_dbus_properties(self):
 
890
    def _get_all_dbus_things(self, thing):
634
891
        """Returns a generator of (name, attribute) pairs
635
892
        """
636
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
893
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
894
                 athing.__get__(self))
637
895
                for cls in self.__class__.__mro__
638
 
                for name, prop in
639
 
                inspect.getmembers(cls, self._is_dbus_property))
 
896
                for name, athing in
 
897
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
640
898
    
641
899
    def _get_dbus_property(self, interface_name, property_name):
642
900
        """Returns a bound method if one exists which is a D-Bus
643
901
        property with the specified name and interface.
644
902
        """
645
 
        for cls in  self.__class__.__mro__:
646
 
            for name, value in (inspect.getmembers
647
 
                                (cls, self._is_dbus_property)):
 
903
        for cls in self.__class__.__mro__:
 
904
            for name, value in inspect.getmembers(
 
905
                    cls, self._is_dbus_thing("property")):
648
906
                if (value._dbus_name == property_name
649
907
                    and value._dbus_interface == interface_name):
650
908
                    return value.__get__(self)
651
909
        
652
910
        # No such property
653
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
654
 
                                   + interface_name + "."
655
 
                                   + property_name)
 
911
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
912
            self.dbus_object_path, interface_name, property_name))
656
913
    
657
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
914
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
915
                         in_signature="ss",
658
916
                         out_signature="v")
659
917
    def Get(self, interface_name, property_name):
660
918
        """Standard D-Bus property Get() method, see D-Bus standard.
678
936
            # The byte_arrays option is not supported yet on
679
937
            # signatures other than "ay".
680
938
            if prop._dbus_signature != "ay":
681
 
                raise ValueError
682
 
            value = dbus.ByteArray(''.join(unichr(byte)
683
 
                                           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))
684
944
        prop(value)
685
945
    
686
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
946
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
947
                         in_signature="s",
687
948
                         out_signature="a{sv}")
688
949
    def GetAll(self, interface_name):
689
950
        """Standard D-Bus property GetAll() method, see D-Bus
691
952
        
692
953
        Note: Will not include properties with access="write".
693
954
        """
694
 
        all = {}
695
 
        for name, prop in self._get_all_dbus_properties():
 
955
        properties = {}
 
956
        for name, prop in self._get_all_dbus_things("property"):
696
957
            if (interface_name
697
958
                and interface_name != prop._dbus_interface):
698
959
                # Interface non-empty but did not match
702
963
                continue
703
964
            value = prop()
704
965
            if not hasattr(value, "variant_level"):
705
 
                all[name] = value
 
966
                properties[name] = value
706
967
                continue
707
 
            all[name] = type(value)(value, variant_level=
708
 
                                    value.variant_level+1)
709
 
        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
710
979
    
711
980
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
712
981
                         out_signature="s",
713
982
                         path_keyword='object_path',
714
983
                         connection_keyword='connection')
715
984
    def Introspect(self, object_path, connection):
716
 
        """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.
717
988
        """
718
989
        xmlstring = dbus.service.Object.Introspect(self, object_path,
719
990
                                                   connection)
720
991
        try:
721
992
            document = xml.dom.minidom.parseString(xmlstring)
 
993
            
722
994
            def make_tag(document, name, prop):
723
995
                e = document.createElement("property")
724
996
                e.setAttribute("name", name)
725
997
                e.setAttribute("type", prop._dbus_signature)
726
998
                e.setAttribute("access", prop._dbus_access)
727
999
                return e
 
1000
            
728
1001
            for if_tag in document.getElementsByTagName("interface"):
 
1002
                # Add property tags
729
1003
                for tag in (make_tag(document, name, prop)
730
1004
                            for name, prop
731
 
                            in self._get_all_dbus_properties()
 
1005
                            in self._get_all_dbus_things("property")
732
1006
                            if prop._dbus_interface
733
1007
                            == if_tag.getAttribute("name")):
734
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)
735
1038
                # Add the names to the return values for the
736
1039
                # "org.freedesktop.DBus.Properties" methods
737
1040
                if (if_tag.getAttribute("name")
752
1055
        except (AttributeError, xml.dom.DOMException,
753
1056
                xml.parsers.expat.ExpatError) as error:
754
1057
            logger.error("Failed to override Introspection method",
755
 
                         error)
 
1058
                         exc_info=error)
756
1059
        return xmlstring
757
1060
 
758
1061
 
759
 
def datetime_to_dbus (dt, variant_level=0):
 
1062
def datetime_to_dbus(dt, variant_level=0):
760
1063
    """Convert a UTC datetime.datetime() to a D-Bus type."""
761
1064
    if dt is None:
762
1065
        return dbus.String("", variant_level = variant_level)
763
 
    return dbus.String(dt.isoformat(),
764
 
                       variant_level=variant_level)
765
 
 
766
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
767
 
                                  .__metaclass__):
768
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
769
 
    will add additional D-Bus attributes matching a certain pattern.
 
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).
770
1091
    """
771
 
    def __new__(mcs, name, bases, attr):
772
 
        # Go through all the base classes which could have D-Bus
773
 
        # methods, signals, or properties in them
774
 
        for base in (b for b in bases
775
 
                     if issubclass(b, dbus.service.Object)):
776
 
            # Go though all attributes of the base class
777
 
            for attrname, attribute in inspect.getmembers(base):
 
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):
778
1100
                # Ignore non-D-Bus attributes, and D-Bus attributes
779
1101
                # with the wrong interface name
780
1102
                if (not hasattr(attribute, "_dbus_interface")
781
 
                    or not attribute._dbus_interface
782
 
                    .startswith("se.recompile.Mandos")):
 
1103
                    or not attribute._dbus_interface.startswith(
 
1104
                        orig_interface_name)):
783
1105
                    continue
784
1106
                # Create an alternate D-Bus interface name based on
785
1107
                # the current name
786
 
                alt_interface = (attribute._dbus_interface
787
 
                                 .replace("se.recompile.Mandos",
788
 
                                          "se.bsnet.fukt.Mandos"))
 
1108
                alt_interface = attribute._dbus_interface.replace(
 
1109
                    orig_interface_name, alt_interface_name)
 
1110
                interface_names.add(alt_interface)
789
1111
                # Is this a D-Bus signal?
790
1112
                if getattr(attribute, "_dbus_is_signal", False):
791
 
                    # Extract the original non-method function by
792
 
                    # black magic
793
 
                    nonmethod_func = (dict(
 
1113
                    if sys.version_info.major == 2:
 
1114
                        # Extract the original non-method undecorated
 
1115
                        # function by black magic
 
1116
                        nonmethod_func = (dict(
794
1117
                            zip(attribute.func_code.co_freevars,
795
 
                                attribute.__closure__))["func"]
796
 
                                      .cell_contents)
 
1118
                                attribute.__closure__))
 
1119
                                          ["func"].cell_contents)
 
1120
                    else:
 
1121
                        nonmethod_func = attribute
797
1122
                    # Create a new, but exactly alike, function
798
1123
                    # object, and decorate it to be a new D-Bus signal
799
1124
                    # with the alternate D-Bus interface name
800
 
                    new_function = (dbus.service.signal
801
 
                                    (alt_interface,
802
 
                                     attribute._dbus_signature)
803
 
                                    (types.FunctionType(
804
 
                                nonmethod_func.func_code,
805
 
                                nonmethod_func.func_globals,
806
 
                                nonmethod_func.func_name,
807
 
                                nonmethod_func.func_defaults,
808
 
                                nonmethod_func.func_closure)))
 
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
809
1148
                    # Define a creator of a function to call both the
810
 
                    # old and new functions, so both the old and new
811
 
                    # signals gets sent when the function is called
 
1149
                    # original and alternate functions, so both the
 
1150
                    # original and alternate signals gets sent when
 
1151
                    # the function is called
812
1152
                    def fixscope(func1, func2):
813
1153
                        """This function is a scope container to pass
814
1154
                        func1 and func2 to the "call_both" function
815
1155
                        outside of its arguments"""
 
1156
                        
816
1157
                        def call_both(*args, **kwargs):
817
1158
                            """This function will emit two D-Bus
818
1159
                            signals by calling func1 and func2"""
819
1160
                            func1(*args, **kwargs)
820
1161
                            func2(*args, **kwargs)
 
1162
                        
821
1163
                        return call_both
822
1164
                    # Create the "call_both" function and add it to
823
1165
                    # the class
824
 
                    attr[attrname] = fixscope(attribute,
825
 
                                              new_function)
 
1166
                    attr[attrname] = fixscope(attribute, new_function)
826
1167
                # Is this a D-Bus method?
827
1168
                elif getattr(attribute, "_dbus_is_method", False):
828
1169
                    # Create a new, but exactly alike, function
829
1170
                    # object.  Decorate it to be a new D-Bus method
830
1171
                    # with the alternate D-Bus interface name.  Add it
831
1172
                    # to the class.
832
 
                    attr[attrname] = (dbus.service.method
833
 
                                      (alt_interface,
834
 
                                       attribute._dbus_in_signature,
835
 
                                       attribute._dbus_out_signature)
836
 
                                      (types.FunctionType
837
 
                                       (attribute.func_code,
838
 
                                        attribute.func_globals,
839
 
                                        attribute.func_name,
840
 
                                        attribute.func_defaults,
841
 
                                        attribute.func_closure)))
 
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
842
1189
                # Is this a D-Bus property?
843
1190
                elif getattr(attribute, "_dbus_is_property", False):
844
1191
                    # Create a new, but exactly alike, function
845
1192
                    # object, and decorate it to be a new D-Bus
846
1193
                    # property with the alternate D-Bus interface
847
1194
                    # name.  Add it to the class.
848
 
                    attr[attrname] = (dbus_service_property
849
 
                                      (alt_interface,
850
 
                                       attribute._dbus_signature,
851
 
                                       attribute._dbus_access,
852
 
                                       attribute
853
 
                                       ._dbus_get_args_options
854
 
                                       ["byte_arrays"])
855
 
                                      (types.FunctionType
856
 
                                       (attribute.func_code,
857
 
                                        attribute.func_globals,
858
 
                                        attribute.func_name,
859
 
                                        attribute.func_defaults,
860
 
                                        attribute.func_closure)))
861
 
        return type.__new__(mcs, name, bases, attr)
862
 
 
 
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"})
863
1252
class ClientDBus(Client, DBusObjectWithProperties):
864
1253
    """A Client class using D-Bus
865
1254
    
869
1258
    """
870
1259
    
871
1260
    runtime_expansions = (Client.runtime_expansions
872
 
                          + ("dbus_object_path",))
 
1261
                          + ("dbus_object_path", ))
 
1262
    
 
1263
    _interface = "se.recompile.Mandos.Client"
873
1264
    
874
1265
    # dbus.service.Object doesn't use super(), so we can't either.
875
1266
    
876
1267
    def __init__(self, bus = None, *args, **kwargs):
877
 
        self._approvals_pending = 0
878
1268
        self.bus = bus
879
1269
        Client.__init__(self, *args, **kwargs)
880
1270
        # Only now, when this client is initialized, can it show up on
881
1271
        # the D-Bus
882
 
        client_object_name = unicode(self.name).translate(
 
1272
        client_object_name = str(self.name).translate(
883
1273
            {ord("."): ord("_"),
884
1274
             ord("-"): ord("_")})
885
 
        self.dbus_object_path = (dbus.ObjectPath
886
 
                                 ("/clients/" + client_object_name))
 
1275
        self.dbus_object_path = dbus.ObjectPath(
 
1276
            "/clients/" + client_object_name)
887
1277
        DBusObjectWithProperties.__init__(self, self.bus,
888
1278
                                          self.dbus_object_path)
889
 
        
890
 
    def notifychangeproperty(transform_func,
891
 
                             dbus_name, type_func=lambda x: x,
892
 
                             variant_level=1):
 
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):
893
1285
        """ Modify a variable so that it's a property which announces
894
1286
        its changes to DBus.
895
 
 
 
1287
        
896
1288
        transform_fun: Function that takes a value and a variant_level
897
1289
                       and transforms it to a D-Bus type.
898
1290
        dbus_name: D-Bus name of the variable
900
1292
                   to the D-Bus.  Default: no transform
901
1293
        variant_level: D-Bus variant level.  Default: 1
902
1294
        """
903
 
        attrname = "_{0}".format(dbus_name)
 
1295
        attrname = "_{}".format(dbus_name)
 
1296
        
904
1297
        def setter(self, value):
905
1298
            if hasattr(self, "dbus_object_path"):
906
1299
                if (not hasattr(self, attrname) or
907
1300
                    type_func(getattr(self, attrname, None))
908
1301
                    != type_func(value)):
909
 
                    dbus_value = transform_func(type_func(value),
910
 
                                                variant_level
911
 
                                                =variant_level)
912
 
                    self.PropertyChanged(dbus.String(dbus_name),
913
 
                                         dbus_value)
 
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())
914
1317
            setattr(self, attrname, value)
915
1318
        
916
1319
        return property(lambda self: getattr(self, attrname), setter)
917
1320
    
918
 
    
919
1321
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
920
1322
    approvals_pending = notifychangeproperty(dbus.Boolean,
921
1323
                                             "ApprovalPending",
923
1325
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
924
1326
    last_enabled = notifychangeproperty(datetime_to_dbus,
925
1327
                                        "LastEnabled")
926
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
927
 
                                   type_func = lambda checker:
928
 
                                       checker is not None)
 
1328
    checker = notifychangeproperty(
 
1329
        dbus.Boolean, "CheckerRunning",
 
1330
        type_func = lambda checker: checker is not None)
929
1331
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
930
1332
                                           "LastCheckedOK")
 
1333
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1334
                                               "LastCheckerStatus")
931
1335
    last_approval_request = notifychangeproperty(
932
1336
        datetime_to_dbus, "LastApprovalRequest")
933
1337
    approved_by_default = notifychangeproperty(dbus.Boolean,
934
1338
                                               "ApprovedByDefault")
935
 
    approval_delay = notifychangeproperty(dbus.UInt16,
936
 
                                          "ApprovalDelay",
937
 
                                          type_func =
938
 
                                          _timedelta_to_milliseconds)
 
1339
    approval_delay = notifychangeproperty(
 
1340
        dbus.UInt64, "ApprovalDelay",
 
1341
        type_func = lambda td: td.total_seconds() * 1000)
939
1342
    approval_duration = notifychangeproperty(
940
 
        dbus.UInt16, "ApprovalDuration",
941
 
        type_func = _timedelta_to_milliseconds)
 
1343
        dbus.UInt64, "ApprovalDuration",
 
1344
        type_func = lambda td: td.total_seconds() * 1000)
942
1345
    host = notifychangeproperty(dbus.String, "Host")
943
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
944
 
                                   type_func =
945
 
                                   _timedelta_to_milliseconds)
 
1346
    timeout = notifychangeproperty(
 
1347
        dbus.UInt64, "Timeout",
 
1348
        type_func = lambda td: td.total_seconds() * 1000)
946
1349
    extended_timeout = notifychangeproperty(
947
 
        dbus.UInt16, "ExtendedTimeout",
948
 
        type_func = _timedelta_to_milliseconds)
949
 
    interval = notifychangeproperty(dbus.UInt16,
950
 
                                    "Interval",
951
 
                                    type_func =
952
 
                                    _timedelta_to_milliseconds)
 
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)
953
1355
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1356
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1357
                                  invalidate_only=True)
954
1358
    
955
1359
    del notifychangeproperty
956
1360
    
963
1367
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
964
1368
        Client.__del__(self, *args, **kwargs)
965
1369
    
966
 
    def checker_callback(self, pid, condition, command,
967
 
                         *args, **kwargs):
968
 
        self.checker_callback_tag = None
969
 
        self.checker = None
970
 
        if os.WIFEXITED(condition):
971
 
            exitstatus = os.WEXITSTATUS(condition)
 
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:
972
1377
            # Emit D-Bus signal
973
1378
            self.CheckerCompleted(dbus.Int16(exitstatus),
974
 
                                  dbus.Int64(condition),
 
1379
                                  dbus.Int64(0),
975
1380
                                  dbus.String(command))
976
1381
        else:
977
1382
            # Emit D-Bus signal
978
1383
            self.CheckerCompleted(dbus.Int16(-1),
979
 
                                  dbus.Int64(condition),
 
1384
                                  dbus.Int64(
 
1385
                                      self.last_checker_signal),
980
1386
                                  dbus.String(command))
981
 
        
982
 
        return Client.checker_callback(self, pid, condition, command,
983
 
                                       *args, **kwargs)
 
1387
        return ret
984
1388
    
985
1389
    def start_checker(self, *args, **kwargs):
986
 
        old_checker = self.checker
987
 
        if self.checker is not None:
988
 
            old_checker_pid = self.checker.pid
989
 
        else:
990
 
            old_checker_pid = None
 
1390
        old_checker_pid = getattr(self.checker, "pid", None)
991
1391
        r = Client.start_checker(self, *args, **kwargs)
992
1392
        # Only if new checker process was started
993
1393
        if (self.checker is not None
997
1397
        return r
998
1398
    
999
1399
    def _reset_approved(self):
1000
 
        self._approved = None
 
1400
        self.approved = None
1001
1401
        return False
1002
1402
    
1003
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)
1004
1407
        self.send_changedstate()
1005
 
        self._approved = value
1006
 
        gobject.timeout_add(_timedelta_to_milliseconds
1007
 
                            (self.approval_duration),
1008
 
                            self._reset_approved)
1009
 
    
1010
1408
    
1011
1409
    ## D-Bus methods, signals & properties
1012
 
    _interface = "se.recompile.Mandos.Client"
 
1410
    
 
1411
    ## Interfaces
1013
1412
    
1014
1413
    ## Signals
1015
1414
    
1026
1425
        pass
1027
1426
    
1028
1427
    # PropertyChanged - signal
 
1428
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1029
1429
    @dbus.service.signal(_interface, signature="sv")
1030
1430
    def PropertyChanged(self, property, value):
1031
1431
        "D-Bus signal"
1095
1495
        return dbus.Boolean(bool(self.approvals_pending))
1096
1496
    
1097
1497
    # ApprovedByDefault - property
1098
 
    @dbus_service_property(_interface, signature="b",
 
1498
    @dbus_service_property(_interface,
 
1499
                           signature="b",
1099
1500
                           access="readwrite")
1100
1501
    def ApprovedByDefault_dbus_property(self, value=None):
1101
1502
        if value is None:       # get
1103
1504
        self.approved_by_default = bool(value)
1104
1505
    
1105
1506
    # ApprovalDelay - property
1106
 
    @dbus_service_property(_interface, signature="t",
 
1507
    @dbus_service_property(_interface,
 
1508
                           signature="t",
1107
1509
                           access="readwrite")
1108
1510
    def ApprovalDelay_dbus_property(self, value=None):
1109
1511
        if value is None:       # get
1110
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1512
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1513
                               * 1000)
1111
1514
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1112
1515
    
1113
1516
    # ApprovalDuration - property
1114
 
    @dbus_service_property(_interface, signature="t",
 
1517
    @dbus_service_property(_interface,
 
1518
                           signature="t",
1115
1519
                           access="readwrite")
1116
1520
    def ApprovalDuration_dbus_property(self, value=None):
1117
1521
        if value is None:       # get
1118
 
            return dbus.UInt64(_timedelta_to_milliseconds(
1119
 
                    self.approval_duration))
 
1522
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1523
                               * 1000)
1120
1524
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1121
1525
    
1122
1526
    # Name - property
1130
1534
        return dbus.String(self.fingerprint)
1131
1535
    
1132
1536
    # Host - property
1133
 
    @dbus_service_property(_interface, signature="s",
 
1537
    @dbus_service_property(_interface,
 
1538
                           signature="s",
1134
1539
                           access="readwrite")
1135
1540
    def Host_dbus_property(self, value=None):
1136
1541
        if value is None:       # get
1137
1542
            return dbus.String(self.host)
1138
 
        self.host = value
 
1543
        self.host = str(value)
1139
1544
    
1140
1545
    # Created - property
1141
1546
    @dbus_service_property(_interface, signature="s", access="read")
1142
1547
    def Created_dbus_property(self):
1143
 
        return dbus.String(datetime_to_dbus(self.created))
 
1548
        return datetime_to_dbus(self.created)
1144
1549
    
1145
1550
    # LastEnabled - property
1146
1551
    @dbus_service_property(_interface, signature="s", access="read")
1148
1553
        return datetime_to_dbus(self.last_enabled)
1149
1554
    
1150
1555
    # Enabled - property
1151
 
    @dbus_service_property(_interface, signature="b",
 
1556
    @dbus_service_property(_interface,
 
1557
                           signature="b",
1152
1558
                           access="readwrite")
1153
1559
    def Enabled_dbus_property(self, value=None):
1154
1560
        if value is None:       # get
1159
1565
            self.disable()
1160
1566
    
1161
1567
    # LastCheckedOK - property
1162
 
    @dbus_service_property(_interface, signature="s",
 
1568
    @dbus_service_property(_interface,
 
1569
                           signature="s",
1163
1570
                           access="readwrite")
1164
1571
    def LastCheckedOK_dbus_property(self, value=None):
1165
1572
        if value is not None:
1167
1574
            return
1168
1575
        return datetime_to_dbus(self.last_checked_ok)
1169
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
    
1170
1582
    # Expires - property
1171
1583
    @dbus_service_property(_interface, signature="s", access="read")
1172
1584
    def Expires_dbus_property(self):
1178
1590
        return datetime_to_dbus(self.last_approval_request)
1179
1591
    
1180
1592
    # Timeout - property
1181
 
    @dbus_service_property(_interface, signature="t",
 
1593
    @dbus_service_property(_interface,
 
1594
                           signature="t",
1182
1595
                           access="readwrite")
1183
1596
    def Timeout_dbus_property(self, value=None):
1184
1597
        if value is None:       # get
1185
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1598
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1599
        old_timeout = self.timeout
1186
1600
        self.timeout = datetime.timedelta(0, 0, 0, value)
1187
 
        if getattr(self, "disable_initiator_tag", None) is None:
1188
 
            return
1189
 
        # Reschedule timeout
1190
 
        gobject.source_remove(self.disable_initiator_tag)
1191
 
        self.disable_initiator_tag = None
1192
 
        self.expires = None
1193
 
        time_to_die = _timedelta_to_milliseconds((self
1194
 
                                                  .last_checked_ok
1195
 
                                                  + self.timeout)
1196
 
                                                 - datetime.datetime
1197
 
                                                 .utcnow())
1198
 
        if time_to_die <= 0:
1199
 
            # The timeout has passed
1200
 
            self.disable()
1201
 
        else:
1202
 
            self.expires = (datetime.datetime.utcnow()
1203
 
                            + datetime.timedelta(milliseconds =
1204
 
                                                 time_to_die))
1205
 
            self.disable_initiator_tag = (gobject.timeout_add
1206
 
                                          (time_to_die, self.disable))
 
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)
1207
1616
    
1208
1617
    # ExtendedTimeout - property
1209
 
    @dbus_service_property(_interface, signature="t",
 
1618
    @dbus_service_property(_interface,
 
1619
                           signature="t",
1210
1620
                           access="readwrite")
1211
1621
    def ExtendedTimeout_dbus_property(self, value=None):
1212
1622
        if value is None:       # get
1213
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1623
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1624
                               * 1000)
1214
1625
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1215
1626
    
1216
1627
    # Interval - property
1217
 
    @dbus_service_property(_interface, signature="t",
 
1628
    @dbus_service_property(_interface,
 
1629
                           signature="t",
1218
1630
                           access="readwrite")
1219
1631
    def Interval_dbus_property(self, value=None):
1220
1632
        if value is None:       # get
1221
 
            return dbus.UInt64(self.interval_milliseconds())
 
1633
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1222
1634
        self.interval = datetime.timedelta(0, 0, 0, value)
1223
1635
        if getattr(self, "checker_initiator_tag", None) is None:
1224
1636
            return
1225
 
        # Reschedule checker run
1226
 
        gobject.source_remove(self.checker_initiator_tag)
1227
 
        self.checker_initiator_tag = (gobject.timeout_add
1228
 
                                      (value, self.start_checker))
1229
 
        self.start_checker()    # Start one now, too
 
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
1230
1643
    
1231
1644
    # Checker - property
1232
 
    @dbus_service_property(_interface, signature="s",
 
1645
    @dbus_service_property(_interface,
 
1646
                           signature="s",
1233
1647
                           access="readwrite")
1234
1648
    def Checker_dbus_property(self, value=None):
1235
1649
        if value is None:       # get
1236
1650
            return dbus.String(self.checker_command)
1237
 
        self.checker_command = value
 
1651
        self.checker_command = str(value)
1238
1652
    
1239
1653
    # CheckerRunning - property
1240
 
    @dbus_service_property(_interface, signature="b",
 
1654
    @dbus_service_property(_interface,
 
1655
                           signature="b",
1241
1656
                           access="readwrite")
1242
1657
    def CheckerRunning_dbus_property(self, value=None):
1243
1658
        if value is None:       # get
1253
1668
        return self.dbus_object_path # is already a dbus.ObjectPath
1254
1669
    
1255
1670
    # Secret = property
1256
 
    @dbus_service_property(_interface, signature="ay",
1257
 
                           access="write", byte_arrays=True)
 
1671
    @dbus_service_property(_interface,
 
1672
                           signature="ay",
 
1673
                           access="write",
 
1674
                           byte_arrays=True)
1258
1675
    def Secret_dbus_property(self, value):
1259
 
        self.secret = str(value)
 
1676
        self.secret = bytes(value)
1260
1677
    
1261
1678
    del _interface
1262
1679
 
1266
1683
        self._pipe = child_pipe
1267
1684
        self._pipe.send(('init', fpr, address))
1268
1685
        if not self._pipe.recv():
1269
 
            raise KeyError()
 
1686
            raise KeyError(fpr)
1270
1687
    
1271
1688
    def __getattribute__(self, name):
1272
 
        if(name == '_pipe'):
 
1689
        if name == '_pipe':
1273
1690
            return super(ProxyClient, self).__getattribute__(name)
1274
1691
        self._pipe.send(('getattr', name))
1275
1692
        data = self._pipe.recv()
1276
1693
        if data[0] == 'data':
1277
1694
            return data[1]
1278
1695
        if data[0] == 'function':
 
1696
            
1279
1697
            def func(*args, **kwargs):
1280
1698
                self._pipe.send(('funcall', name, args, kwargs))
1281
1699
                return self._pipe.recv()[1]
 
1700
            
1282
1701
            return func
1283
1702
    
1284
1703
    def __setattr__(self, name, value):
1285
 
        if(name == '_pipe'):
 
1704
        if name == '_pipe':
1286
1705
            return super(ProxyClient, self).__setattr__(name, value)
1287
1706
        self._pipe.send(('setattr', name, value))
1288
1707
 
1289
 
class ClientDBusTransitional(ClientDBus):
1290
 
    __metaclass__ = AlternateDBusNamesMetaclass
1291
1708
 
1292
1709
class ClientHandler(socketserver.BaseRequestHandler, object):
1293
1710
    """A class to handle client connections.
1298
1715
    def handle(self):
1299
1716
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1300
1717
            logger.info("TCP connection from: %s",
1301
 
                        unicode(self.client_address))
 
1718
                        str(self.client_address))
1302
1719
            logger.debug("Pipe FD: %d",
1303
1720
                         self.server.child_pipe.fileno())
1304
1721
            
1305
 
            session = (gnutls.connection
1306
 
                       .ClientSession(self.request,
1307
 
                                      gnutls.connection
1308
 
                                      .X509Credentials()))
 
1722
            session = gnutls.connection.ClientSession(
 
1723
                self.request, gnutls.connection .X509Credentials())
1309
1724
            
1310
1725
            # Note: gnutls.connection.X509Credentials is really a
1311
1726
            # generic GnuTLS certificate credentials object so long as
1320
1735
            priority = self.server.gnutls_priority
1321
1736
            if priority is None:
1322
1737
                priority = "NORMAL"
1323
 
            (gnutls.library.functions
1324
 
             .gnutls_priority_set_direct(session._c_object,
1325
 
                                         priority, None))
 
1738
            gnutls.library.functions.gnutls_priority_set_direct(
 
1739
                session._c_object, priority, None)
1326
1740
            
1327
1741
            # Start communication using the Mandos protocol
1328
1742
            # Get protocol number
1330
1744
            logger.debug("Protocol version: %r", line)
1331
1745
            try:
1332
1746
                if int(line.strip().split()[0]) > 1:
1333
 
                    raise RuntimeError
 
1747
                    raise RuntimeError(line)
1334
1748
            except (ValueError, IndexError, RuntimeError) as error:
1335
1749
                logger.error("Unknown protocol version: %s", error)
1336
1750
                return
1348
1762
            approval_required = False
1349
1763
            try:
1350
1764
                try:
1351
 
                    fpr = self.fingerprint(self.peer_certificate
1352
 
                                           (session))
 
1765
                    fpr = self.fingerprint(
 
1766
                        self.peer_certificate(session))
1353
1767
                except (TypeError,
1354
1768
                        gnutls.errors.GNUTLSError) as error:
1355
1769
                    logger.warning("Bad certificate: %s", error)
1370
1784
                while True:
1371
1785
                    if not client.enabled:
1372
1786
                        logger.info("Client %s is disabled",
1373
 
                                       client.name)
 
1787
                                    client.name)
1374
1788
                        if self.server.use_dbus:
1375
1789
                            # Emit D-Bus signal
1376
1790
                            client.Rejected("Disabled")
1377
1791
                        return
1378
1792
                    
1379
 
                    if client._approved or not client.approval_delay:
 
1793
                    if client.approved or not client.approval_delay:
1380
1794
                        #We are approved or approval is disabled
1381
1795
                        break
1382
 
                    elif client._approved is None:
 
1796
                    elif client.approved is None:
1383
1797
                        logger.info("Client %s needs approval",
1384
1798
                                    client.name)
1385
1799
                        if self.server.use_dbus:
1386
1800
                            # Emit D-Bus signal
1387
1801
                            client.NeedApproval(
1388
 
                                client.approval_delay_milliseconds(),
1389
 
                                client.approved_by_default)
 
1802
                                client.approval_delay.total_seconds()
 
1803
                                * 1000, client.approved_by_default)
1390
1804
                    else:
1391
1805
                        logger.warning("Client %s was not approved",
1392
1806
                                       client.name)
1398
1812
                    #wait until timeout or approved
1399
1813
                    time = datetime.datetime.now()
1400
1814
                    client.changedstate.acquire()
1401
 
                    (client.changedstate.wait
1402
 
                     (float(client._timedelta_to_milliseconds(delay)
1403
 
                            / 1000)))
 
1815
                    client.changedstate.wait(delay.total_seconds())
1404
1816
                    client.changedstate.release()
1405
1817
                    time2 = datetime.datetime.now()
1406
1818
                    if (time2 - time) >= delay:
1422
1834
                    try:
1423
1835
                        sent = session.send(client.secret[sent_size:])
1424
1836
                    except gnutls.errors.GNUTLSError as error:
1425
 
                        logger.warning("gnutls send failed")
 
1837
                        logger.warning("gnutls send failed",
 
1838
                                       exc_info=error)
1426
1839
                        return
1427
 
                    logger.debug("Sent: %d, remaining: %d",
1428
 
                                 sent, len(client.secret)
1429
 
                                 - (sent_size + sent))
 
1840
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1841
                                 len(client.secret) - (sent_size
 
1842
                                                       + sent))
1430
1843
                    sent_size += sent
1431
1844
                
1432
1845
                logger.info("Sending secret to %s", client.name)
1433
1846
                # bump the timeout using extended_timeout
1434
 
                client.checked_ok(client.extended_timeout)
 
1847
                client.bump_timeout(client.extended_timeout)
1435
1848
                if self.server.use_dbus:
1436
1849
                    # Emit D-Bus signal
1437
1850
                    client.GotSecret()
1442
1855
                try:
1443
1856
                    session.bye()
1444
1857
                except gnutls.errors.GNUTLSError as error:
1445
 
                    logger.warning("GnuTLS bye failed")
 
1858
                    logger.warning("GnuTLS bye failed",
 
1859
                                   exc_info=error)
1446
1860
    
1447
1861
    @staticmethod
1448
1862
    def peer_certificate(session):
1449
1863
        "Return the peer's OpenPGP certificate as a bytestring"
1450
1864
        # If not an OpenPGP certificate...
1451
 
        if (gnutls.library.functions
1452
 
            .gnutls_certificate_type_get(session._c_object)
 
1865
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
1866
                session._c_object)
1453
1867
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1454
1868
            # ...do the normal thing
1455
1869
            return session.peer_certificate
1469
1883
    def fingerprint(openpgp):
1470
1884
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1471
1885
        # New GnuTLS "datum" with the OpenPGP public key
1472
 
        datum = (gnutls.library.types
1473
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1474
 
                                             ctypes.POINTER
1475
 
                                             (ctypes.c_ubyte)),
1476
 
                                 ctypes.c_uint(len(openpgp))))
 
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)))
1477
1890
        # New empty GnuTLS certificate
1478
1891
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1479
 
        (gnutls.library.functions
1480
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
1892
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
1893
            ctypes.byref(crt))
1481
1894
        # Import the OpenPGP public key into the certificate
1482
 
        (gnutls.library.functions
1483
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1484
 
                                    gnutls.library.constants
1485
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
1895
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
1896
            crt, ctypes.byref(datum),
 
1897
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1486
1898
        # Verify the self signature in the key
1487
1899
        crtverify = ctypes.c_uint()
1488
 
        (gnutls.library.functions
1489
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1490
 
                                         ctypes.byref(crtverify)))
 
1900
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
1901
            crt, 0, ctypes.byref(crtverify))
1491
1902
        if crtverify.value != 0:
1492
1903
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1493
 
            raise (gnutls.errors.CertificateSecurityError
1494
 
                   ("Verify failed"))
 
1904
            raise gnutls.errors.CertificateSecurityError(
 
1905
                "Verify failed")
1495
1906
        # New buffer for the fingerprint
1496
1907
        buf = ctypes.create_string_buffer(20)
1497
1908
        buf_len = ctypes.c_size_t()
1498
1909
        # Get the fingerprint from the certificate into the buffer
1499
 
        (gnutls.library.functions
1500
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1501
 
                                             ctypes.byref(buf_len)))
 
1910
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
1911
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1502
1912
        # Deinit the certificate
1503
1913
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1504
1914
        # Convert the buffer to a Python bytestring
1505
1915
        fpr = ctypes.string_at(buf, buf_len.value)
1506
1916
        # Convert the bytestring to hexadecimal notation
1507
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1917
        hex_fpr = binascii.hexlify(fpr).upper()
1508
1918
        return hex_fpr
1509
1919
 
1510
1920
 
1511
1921
class MultiprocessingMixIn(object):
1512
1922
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1923
    
1513
1924
    def sub_process_main(self, request, address):
1514
1925
        try:
1515
1926
            self.finish_request(request, address)
1516
 
        except:
 
1927
        except Exception:
1517
1928
            self.handle_error(request, address)
1518
1929
        self.close_request(request)
1519
1930
    
1520
1931
    def process_request(self, request, address):
1521
1932
        """Start a new process to process the request."""
1522
1933
        proc = multiprocessing.Process(target = self.sub_process_main,
1523
 
                                       args = (request,
1524
 
                                               address))
 
1934
                                       args = (request, address))
1525
1935
        proc.start()
1526
1936
        return proc
1527
1937
 
1528
1938
 
1529
1939
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1530
1940
    """ adds a pipe to the MixIn """
 
1941
    
1531
1942
    def process_request(self, request, client_address):
1532
1943
        """Overrides and wraps the original process_request().
1533
1944
        
1542
1953
    
1543
1954
    def add_pipe(self, parent_pipe, proc):
1544
1955
        """Dummy function; override as necessary"""
1545
 
        raise NotImplementedError
 
1956
        raise NotImplementedError()
1546
1957
 
1547
1958
 
1548
1959
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1554
1965
        interface:      None or a network interface name (string)
1555
1966
        use_ipv6:       Boolean; to use IPv6 or not
1556
1967
    """
 
1968
    
1557
1969
    def __init__(self, server_address, RequestHandlerClass,
1558
 
                 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
        """
1559
1976
        self.interface = interface
1560
1977
        if use_ipv6:
1561
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.
1562
2005
        socketserver.TCPServer.__init__(self, server_address,
1563
2006
                                        RequestHandlerClass)
 
2007
    
1564
2008
    def server_bind(self):
1565
2009
        """This overrides the normal server_bind() function
1566
2010
        to bind to an interface if one was specified, and also NOT to
1572
2016
                             self.interface)
1573
2017
            else:
1574
2018
                try:
1575
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1576
 
                                           SO_BINDTODEVICE,
1577
 
                                           str(self.interface
1578
 
                                               + '\0'))
 
2019
                    self.socket.setsockopt(
 
2020
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2021
                        (self.interface + "\0").encode("utf-8"))
1579
2022
                except socket.error as error:
1580
 
                    if error[0] == errno.EPERM:
1581
 
                        logger.error("No permission to"
1582
 
                                     " bind to interface %s",
1583
 
                                     self.interface)
1584
 
                    elif error[0] == errno.ENOPROTOOPT:
 
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:
1585
2027
                        logger.error("SO_BINDTODEVICE not available;"
1586
2028
                                     " cannot bind to interface %s",
1587
2029
                                     self.interface)
 
2030
                    elif error.errno == errno.ENODEV:
 
2031
                        logger.error("Interface %s does not exist,"
 
2032
                                     " cannot bind", self.interface)
1588
2033
                    else:
1589
2034
                        raise
1590
2035
        # Only bind(2) the socket if we really need to.
1593
2038
                if self.address_family == socket.AF_INET6:
1594
2039
                    any_address = "::" # in6addr_any
1595
2040
                else:
1596
 
                    any_address = socket.INADDR_ANY
 
2041
                    any_address = "0.0.0.0" # INADDR_ANY
1597
2042
                self.server_address = (any_address,
1598
2043
                                       self.server_address[1])
1599
2044
            elif not self.server_address[1]:
1600
 
                self.server_address = (self.server_address[0],
1601
 
                                       0)
 
2045
                self.server_address = (self.server_address[0], 0)
1602
2046
#                 if self.interface:
1603
2047
#                     self.server_address = (self.server_address[0],
1604
2048
#                                            0, # port
1618
2062
    
1619
2063
    Assumes a gobject.MainLoop event loop.
1620
2064
    """
 
2065
    
1621
2066
    def __init__(self, server_address, RequestHandlerClass,
1622
 
                 interface=None, use_ipv6=True, clients=None,
1623
 
                 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):
1624
2073
        self.enabled = False
1625
2074
        self.clients = clients
1626
2075
        if self.clients is None:
1627
 
            self.clients = set()
 
2076
            self.clients = {}
1628
2077
        self.use_dbus = use_dbus
1629
2078
        self.gnutls_priority = gnutls_priority
1630
2079
        IPv6_TCPServer.__init__(self, server_address,
1631
2080
                                RequestHandlerClass,
1632
2081
                                interface = interface,
1633
 
                                use_ipv6 = use_ipv6)
 
2082
                                use_ipv6 = use_ipv6,
 
2083
                                socketfd = socketfd)
 
2084
    
1634
2085
    def server_activate(self):
1635
2086
        if self.enabled:
1636
2087
            return socketserver.TCPServer.server_activate(self)
1640
2091
    
1641
2092
    def add_pipe(self, parent_pipe, proc):
1642
2093
        # Call "handle_ipc" for both data and EOF events
1643
 
        gobject.io_add_watch(parent_pipe.fileno(),
1644
 
                             gobject.IO_IN | gobject.IO_HUP,
1645
 
                             functools.partial(self.handle_ipc,
1646
 
                                               parent_pipe =
1647
 
                                               parent_pipe,
1648
 
                                               proc = proc))
 
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))
1649
2100
    
1650
 
    def handle_ipc(self, source, condition, parent_pipe=None,
1651
 
                   proc = None, client_object=None):
1652
 
        condition_names = {
1653
 
            gobject.IO_IN: "IN",   # There is data to read.
1654
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1655
 
                                    # blocking).
1656
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1657
 
            gobject.IO_ERR: "ERR", # Error condition.
1658
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1659
 
                                    # broken, usually for pipes and
1660
 
                                    # sockets).
1661
 
            }
1662
 
        conditions_string = ' | '.join(name
1663
 
                                       for cond, name in
1664
 
                                       condition_names.iteritems()
1665
 
                                       if cond & condition)
 
2101
    def handle_ipc(self, source, condition,
 
2102
                   parent_pipe=None,
 
2103
                   proc = None,
 
2104
                   client_object=None):
1666
2105
        # error, or the other end of multiprocessing.Pipe has closed
1667
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2106
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1668
2107
            # Wait for other process to exit
1669
2108
            proc.join()
1670
2109
            return False
1677
2116
            fpr = request[1]
1678
2117
            address = request[2]
1679
2118
            
1680
 
            for c in self.clients:
 
2119
            for c in self.clients.itervalues():
1681
2120
                if c.fingerprint == fpr:
1682
2121
                    client = c
1683
2122
                    break
1691
2130
                parent_pipe.send(False)
1692
2131
                return False
1693
2132
            
1694
 
            gobject.io_add_watch(parent_pipe.fileno(),
1695
 
                                 gobject.IO_IN | gobject.IO_HUP,
1696
 
                                 functools.partial(self.handle_ipc,
1697
 
                                                   parent_pipe =
1698
 
                                                   parent_pipe,
1699
 
                                                   proc = proc,
1700
 
                                                   client_object =
1701
 
                                                   client))
 
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))
1702
2140
            parent_pipe.send(True)
1703
2141
            # remove the old hook in favor of the new above hook on
1704
2142
            # same fileno
1710
2148
            
1711
2149
            parent_pipe.send(('data', getattr(client_object,
1712
2150
                                              funcname)(*args,
1713
 
                                                         **kwargs)))
 
2151
                                                        **kwargs)))
1714
2152
        
1715
2153
        if command == 'getattr':
1716
2154
            attrname = request[1]
1717
 
            if callable(client_object.__getattribute__(attrname)):
1718
 
                parent_pipe.send(('function',))
 
2155
            if isinstance(client_object.__getattribute__(attrname),
 
2156
                          collections.Callable):
 
2157
                parent_pipe.send(('function', ))
1719
2158
            else:
1720
 
                parent_pipe.send(('data', client_object
1721
 
                                  .__getattribute__(attrname)))
 
2159
                parent_pipe.send((
 
2160
                    'data', client_object.__getattribute__(attrname)))
1722
2161
        
1723
2162
        if command == 'setattr':
1724
2163
            attrname = request[1]
1728
2167
        return True
1729
2168
 
1730
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
 
1731
2266
def string_to_delta(interval):
1732
2267
    """Parse a string and return a datetime.timedelta
1733
2268
    
1744
2279
    >>> string_to_delta('5m 30s')
1745
2280
    datetime.timedelta(0, 330)
1746
2281
    """
 
2282
    
 
2283
    try:
 
2284
        return rfc3339_duration_to_delta(interval)
 
2285
    except ValueError:
 
2286
        pass
 
2287
    
1747
2288
    timevalue = datetime.timedelta(0)
1748
2289
    for s in interval.split():
1749
2290
        try:
1750
 
            suffix = unicode(s[-1])
 
2291
            suffix = s[-1]
1751
2292
            value = int(s[:-1])
1752
2293
            if suffix == "d":
1753
2294
                delta = datetime.timedelta(value)
1760
2301
            elif suffix == "w":
1761
2302
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1762
2303
            else:
1763
 
                raise ValueError("Unknown suffix %r" % suffix)
1764
 
        except (ValueError, IndexError) as e:
 
2304
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2305
        except IndexError as e:
1765
2306
            raise ValueError(*(e.args))
1766
2307
        timevalue += delta
1767
2308
    return timevalue
1768
2309
 
1769
2310
 
1770
 
def if_nametoindex(interface):
1771
 
    """Call the C function if_nametoindex(), or equivalent
1772
 
    
1773
 
    Note: This function cannot accept a unicode string."""
1774
 
    global if_nametoindex
1775
 
    try:
1776
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1777
 
                          (ctypes.util.find_library("c"))
1778
 
                          .if_nametoindex)
1779
 
    except (OSError, AttributeError):
1780
 
        logger.warning("Doing if_nametoindex the hard way")
1781
 
        def if_nametoindex(interface):
1782
 
            "Get an interface index the hard way, i.e. using fcntl()"
1783
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1784
 
            with contextlib.closing(socket.socket()) as s:
1785
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1786
 
                                    struct.pack(str("16s16x"),
1787
 
                                                interface))
1788
 
            interface_index = struct.unpack(str("I"),
1789
 
                                            ifreq[16:20])[0]
1790
 
            return interface_index
1791
 
    return if_nametoindex(interface)
1792
 
 
1793
 
 
1794
2311
def daemon(nochdir = False, noclose = False):
1795
2312
    """See daemon(3).  Standard BSD Unix function.
1796
2313
    
1804
2321
        sys.exit()
1805
2322
    if not noclose:
1806
2323
        # Close all standard open file descriptors
1807
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2324
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1808
2325
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1809
2326
            raise OSError(errno.ENODEV,
1810
 
                          "%s not a character device"
1811
 
                          % os.path.devnull)
 
2327
                          "{} not a character device"
 
2328
                          .format(os.devnull))
1812
2329
        os.dup2(null, sys.stdin.fileno())
1813
2330
        os.dup2(null, sys.stdout.fileno())
1814
2331
        os.dup2(null, sys.stderr.fileno())
1823
2340
    
1824
2341
    parser = argparse.ArgumentParser()
1825
2342
    parser.add_argument("-v", "--version", action="version",
1826
 
                        version = "%%(prog)s %s" % version,
 
2343
                        version = "%(prog)s {}".format(version),
1827
2344
                        help="show version number and exit")
1828
2345
    parser.add_argument("-i", "--interface", metavar="IF",
1829
2346
                        help="Bind to interface IF")
1835
2352
                        help="Run self-test")
1836
2353
    parser.add_argument("--debug", action="store_true",
1837
2354
                        help="Debug mode; run in foreground and log"
1838
 
                        " to terminal")
 
2355
                        " to terminal", default=None)
1839
2356
    parser.add_argument("--debuglevel", metavar="LEVEL",
1840
2357
                        help="Debug level for stdout output")
1841
2358
    parser.add_argument("--priority", help="GnuTLS"
1848
2365
                        " files")
1849
2366
    parser.add_argument("--no-dbus", action="store_false",
1850
2367
                        dest="use_dbus", help="Do not provide D-Bus"
1851
 
                        " system bus interface")
 
2368
                        " system bus interface", default=None)
1852
2369
    parser.add_argument("--no-ipv6", action="store_false",
1853
 
                        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
    
1854
2386
    options = parser.parse_args()
1855
2387
    
1856
2388
    if options.check:
1857
2389
        import doctest
1858
 
        doctest.testmod()
1859
 
        sys.exit()
 
2390
        fail_count, test_count = doctest.testmod()
 
2391
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1860
2392
    
1861
2393
    # Default values for config file for server-global settings
1862
2394
    server_defaults = { "interface": "",
1864
2396
                        "port": "",
1865
2397
                        "debug": "False",
1866
2398
                        "priority":
1867
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2399
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2400
                        ":+SIGN-DSA-SHA256",
1868
2401
                        "servicename": "Mandos",
1869
2402
                        "use_dbus": "True",
1870
2403
                        "use_ipv6": "True",
1871
2404
                        "debuglevel": "",
1872
 
                        }
 
2405
                        "restore": "True",
 
2406
                        "socket": "",
 
2407
                        "statedir": "/var/lib/mandos",
 
2408
                        "foreground": "False",
 
2409
                        "zeroconf": "True",
 
2410
                    }
1873
2411
    
1874
2412
    # Parse config file for server-global settings
1875
2413
    server_config = configparser.SafeConfigParser(server_defaults)
1876
2414
    del server_defaults
1877
 
    server_config.read(os.path.join(options.configdir,
1878
 
                                    "mandos.conf"))
 
2415
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
1879
2416
    # Convert the SafeConfigParser object to a dict
1880
2417
    server_settings = server_config.defaults()
1881
2418
    # Use the appropriate methods on the non-string config options
1882
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2419
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1883
2420
        server_settings[option] = server_config.getboolean("DEFAULT",
1884
2421
                                                           option)
1885
2422
    if server_settings["port"]:
1886
2423
        server_settings["port"] = server_config.getint("DEFAULT",
1887
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"])
1888
2434
    del server_config
1889
2435
    
1890
2436
    # Override the settings from the config file with command line
1891
2437
    # options, if set.
1892
2438
    for option in ("interface", "address", "port", "debug",
1893
 
                   "priority", "servicename", "configdir",
1894
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2439
                   "priority", "servicename", "configdir", "use_dbus",
 
2440
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2441
                   "socket", "foreground", "zeroconf"):
1895
2442
        value = getattr(options, option)
1896
2443
        if value is not None:
1897
2444
            server_settings[option] = value
1898
2445
    del options
1899
2446
    # Force all strings to be unicode
1900
2447
    for option in server_settings.keys():
1901
 
        if type(server_settings[option]) is str:
1902
 
            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
1903
2458
    # Now we have our good server settings in "server_settings"
1904
2459
    
1905
2460
    ##################################################################
1906
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
    
1907
2467
    # For convenience
1908
2468
    debug = server_settings["debug"]
1909
2469
    debuglevel = server_settings["debuglevel"]
1910
2470
    use_dbus = server_settings["use_dbus"]
1911
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)
1912
2485
    
1913
2486
    if server_settings["servicename"] != "Mandos":
1914
 
        syslogger.setFormatter(logging.Formatter
1915
 
                               ('Mandos (%s) [%%(process)d]:'
1916
 
                                ' %%(levelname)s: %%(message)s'
1917
 
                                % server_settings["servicename"]))
 
2487
        syslogger.setFormatter(
 
2488
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2489
                              ' %(levelname)s: %(message)s'.format(
 
2490
                                  server_settings["servicename"])))
1918
2491
    
1919
2492
    # Parse config file with clients
1920
 
    client_defaults = { "timeout": "5m",
1921
 
                        "extended_timeout": "15m",
1922
 
                        "interval": "2m",
1923
 
                        "checker": "fping -q -- %%(host)s",
1924
 
                        "host": "",
1925
 
                        "approval_delay": "0s",
1926
 
                        "approval_duration": "1s",
1927
 
                        }
1928
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2493
    client_config = configparser.SafeConfigParser(Client
 
2494
                                                  .client_defaults)
1929
2495
    client_config.read(os.path.join(server_settings["configdir"],
1930
2496
                                    "clients.conf"))
1931
2497
    
1932
2498
    global mandos_dbus_service
1933
2499
    mandos_dbus_service = None
1934
2500
    
1935
 
    tcp_server = MandosServer((server_settings["address"],
1936
 
                               server_settings["port"]),
1937
 
                              ClientHandler,
1938
 
                              interface=(server_settings["interface"]
1939
 
                                         or None),
1940
 
                              use_ipv6=use_ipv6,
1941
 
                              gnutls_priority=
1942
 
                              server_settings["priority"],
1943
 
                              use_dbus=use_dbus)
1944
 
    if not debug:
1945
 
        pidfilename = "/var/run/mandos.pid"
 
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
1946
2517
        try:
1947
 
            pidfile = open(pidfilename, "w")
1948
 
        except IOError:
1949
 
            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)
1950
2522
    
1951
 
    try:
1952
 
        uid = pwd.getpwnam("_mandos").pw_uid
1953
 
        gid = pwd.getpwnam("_mandos").pw_gid
1954
 
    except KeyError:
 
2523
    for name in ("_mandos", "mandos", "nobody"):
1955
2524
        try:
1956
 
            uid = pwd.getpwnam("mandos").pw_uid
1957
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2525
            uid = pwd.getpwnam(name).pw_uid
 
2526
            gid = pwd.getpwnam(name).pw_gid
 
2527
            break
1958
2528
        except KeyError:
1959
 
            try:
1960
 
                uid = pwd.getpwnam("nobody").pw_uid
1961
 
                gid = pwd.getpwnam("nobody").pw_gid
1962
 
            except KeyError:
1963
 
                uid = 65534
1964
 
                gid = 65534
 
2529
            continue
 
2530
    else:
 
2531
        uid = 65534
 
2532
        gid = 65534
1965
2533
    try:
1966
2534
        os.setgid(gid)
1967
2535
        os.setuid(uid)
1968
2536
    except OSError as error:
1969
 
        if error[0] != errno.EPERM:
1970
 
            raise error
1971
 
    
1972
 
    if not debug and not debuglevel:
1973
 
        syslogger.setLevel(logging.WARNING)
1974
 
        console.setLevel(logging.WARNING)
1975
 
    if debuglevel:
1976
 
        level = getattr(logging, debuglevel.upper())
1977
 
        syslogger.setLevel(level)
1978
 
        console.setLevel(level)
 
2537
        if error.errno != errno.EPERM:
 
2538
            raise
1979
2539
    
1980
2540
    if debug:
1981
2541
        # Enable all possible GnuTLS debugging
1988
2548
        def debug_gnutls(level, string):
1989
2549
            logger.debug("GnuTLS: %s", string[:-1])
1990
2550
        
1991
 
        (gnutls.library.functions
1992
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2551
        gnutls.library.functions.gnutls_global_set_log_function(
 
2552
            debug_gnutls)
1993
2553
        
1994
2554
        # Redirect stdin so all checkers get /dev/null
1995
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2555
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1996
2556
        os.dup2(null, sys.stdin.fileno())
1997
2557
        if null > 2:
1998
2558
            os.close(null)
1999
 
    else:
2000
 
        # No console logging
2001
 
        logger.removeHandler(console)
2002
2559
    
2003
2560
    # Need to fork before connecting to D-Bus
2004
 
    if not debug:
 
2561
    if not foreground:
2005
2562
        # Close all input and output, do double fork, etc.
2006
2563
        daemon()
2007
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
    
2008
2569
    global main_loop
2009
2570
    # From the Avahi example code
2010
 
    DBusGMainLoop(set_as_default=True )
 
2571
    DBusGMainLoop(set_as_default=True)
2011
2572
    main_loop = gobject.MainLoop()
2012
2573
    bus = dbus.SystemBus()
2013
2574
    # End of Avahi example code
2014
2575
    if use_dbus:
2015
2576
        try:
2016
2577
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2017
 
                                            bus, do_not_queue=True)
2018
 
            old_bus_name = (dbus.service.BusName
2019
 
                            ("se.bsnet.fukt.Mandos", bus,
2020
 
                             do_not_queue=True))
2021
 
        except dbus.exceptions.NameExistsException as e:
2022
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
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)
2023
2585
            use_dbus = False
2024
2586
            server_settings["use_dbus"] = False
2025
2587
            tcp_server.use_dbus = False
2026
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2027
 
    service = AvahiService(name = server_settings["servicename"],
2028
 
                           servicetype = "_mandos._tcp",
2029
 
                           protocol = protocol, bus = bus)
2030
 
    if server_settings["interface"]:
2031
 
        service.interface = (if_nametoindex
2032
 
                             (str(server_settings["interface"])))
 
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"))
2033
2598
    
2034
2599
    global multiprocessing_manager
2035
2600
    multiprocessing_manager = multiprocessing.Manager()
2036
2601
    
2037
2602
    client_class = Client
2038
2603
    if use_dbus:
2039
 
        client_class = functools.partial(ClientDBusTransitional,
2040
 
                                         bus = bus)
2041
 
    def client_config_items(config, section):
2042
 
        special_settings = {
2043
 
            "approved_by_default":
2044
 
                lambda: config.getboolean(section,
2045
 
                                          "approved_by_default"),
2046
 
            }
2047
 
        for name, value in config.items(section):
 
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))
2048
2689
            try:
2049
 
                yield (name, special_settings[name]())
2050
 
            except KeyError:
2051
 
                yield (name, value)
2052
 
    
2053
 
    tcp_server.clients.update(set(
2054
 
            client_class(name = section,
2055
 
                         config= dict(client_config_items(
2056
 
                        client_config, section)))
2057
 
            for section in client_config.sections()))
 
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
    
2058
2715
    if not tcp_server.clients:
2059
2716
        logger.warning("No clients defined")
2060
 
        
2061
 
    if not debug:
2062
 
        try:
2063
 
            with pidfile:
2064
 
                pid = os.getpid()
2065
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2066
 
            del pidfile
2067
 
        except IOError:
2068
 
            logger.error("Could not write to file %r with PID %d",
2069
 
                         pidfilename, pid)
2070
 
        except NameError:
2071
 
            # "pidfile" was never created
2072
 
            pass
 
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
2073
2728
        del pidfilename
2074
 
        
2075
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2076
2729
    
2077
2730
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2078
2731
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2079
2732
    
2080
2733
    if use_dbus:
2081
 
        class MandosDBusService(dbus.service.Object):
 
2734
        
 
2735
        @alternate_dbus_interfaces(
 
2736
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2737
        class MandosDBusService(DBusObjectWithProperties):
2082
2738
            """A D-Bus proxy object"""
 
2739
            
2083
2740
            def __init__(self):
2084
2741
                dbus.service.Object.__init__(self, bus, "/")
 
2742
            
2085
2743
            _interface = "se.recompile.Mandos"
2086
2744
            
 
2745
            @dbus_interface_annotations(_interface)
 
2746
            def _foo(self):
 
2747
                return {
 
2748
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2749
                    "false" }
 
2750
            
2087
2751
            @dbus.service.signal(_interface, signature="o")
2088
2752
            def ClientAdded(self, objpath):
2089
2753
                "D-Bus signal"
2102
2766
            @dbus.service.method(_interface, out_signature="ao")
2103
2767
            def GetAllClients(self):
2104
2768
                "D-Bus method"
2105
 
                return dbus.Array(c.dbus_object_path
2106
 
                                  for c in tcp_server.clients)
 
2769
                return dbus.Array(c.dbus_object_path for c in
 
2770
                                  tcp_server.clients.itervalues())
2107
2771
            
2108
2772
            @dbus.service.method(_interface,
2109
2773
                                 out_signature="a{oa{sv}}")
2110
2774
            def GetAllClientsWithProperties(self):
2111
2775
                "D-Bus method"
2112
2776
                return dbus.Dictionary(
2113
 
                    ((c.dbus_object_path, c.GetAll(""))
2114
 
                     for c in tcp_server.clients),
 
2777
                    { c.dbus_object_path: c.GetAll("")
 
2778
                      for c in tcp_server.clients.itervalues() },
2115
2779
                    signature="oa{sv}")
2116
2780
            
2117
2781
            @dbus.service.method(_interface, in_signature="o")
2118
2782
            def RemoveClient(self, object_path):
2119
2783
                "D-Bus method"
2120
 
                for c in tcp_server.clients:
 
2784
                for c in tcp_server.clients.itervalues():
2121
2785
                    if c.dbus_object_path == object_path:
2122
 
                        tcp_server.clients.remove(c)
 
2786
                        del tcp_server.clients[c.name]
2123
2787
                        c.remove_from_connection()
2124
2788
                        # Don't signal anything except ClientRemoved
2125
2789
                        c.disable(quiet=True)
2130
2794
            
2131
2795
            del _interface
2132
2796
        
2133
 
        class MandosDBusServiceTransitional(MandosDBusService):
2134
 
            __metaclass__ = AlternateDBusNamesMetaclass
2135
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2797
        mandos_dbus_service = MandosDBusService()
2136
2798
    
2137
2799
    def cleanup():
2138
2800
        "Cleanup function; run on exit"
2139
 
        service.cleanup()
 
2801
        if zeroconf:
 
2802
            service.cleanup()
2140
2803
        
2141
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
2142
2862
        while tcp_server.clients:
2143
 
            client = tcp_server.clients.pop()
 
2863
            name, client = tcp_server.clients.popitem()
2144
2864
            if use_dbus:
2145
2865
                client.remove_from_connection()
2146
 
            client.disable_hook = None
2147
2866
            # Don't signal anything except ClientRemoved
2148
2867
            client.disable(quiet=True)
2149
2868
            if use_dbus:
2150
2869
                # Emit D-Bus signal
2151
 
                mandos_dbus_service.ClientRemoved(client
2152
 
                                                  .dbus_object_path,
2153
 
                                                  client.name)
 
2870
                mandos_dbus_service.ClientRemoved(
 
2871
                    client.dbus_object_path, client.name)
 
2872
        client_settings.clear()
2154
2873
    
2155
2874
    atexit.register(cleanup)
2156
2875
    
2157
 
    for client in tcp_server.clients:
 
2876
    for client in tcp_server.clients.itervalues():
2158
2877
        if use_dbus:
2159
2878
            # Emit D-Bus signal
2160
2879
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2161
 
        client.enable()
 
2880
        # Need to initiate checking of clients
 
2881
        if client.enabled:
 
2882
            client.init_checker()
2162
2883
    
2163
2884
    tcp_server.enable()
2164
2885
    tcp_server.server_activate()
2165
2886
    
2166
2887
    # Find out what port we got
2167
 
    service.port = tcp_server.socket.getsockname()[1]
 
2888
    if zeroconf:
 
2889
        service.port = tcp_server.socket.getsockname()[1]
2168
2890
    if use_ipv6:
2169
2891
        logger.info("Now listening on address %r, port %d,"
2170
 
                    " flowinfo %d, scope_id %d"
2171
 
                    % tcp_server.socket.getsockname())
 
2892
                    " flowinfo %d, scope_id %d",
 
2893
                    *tcp_server.socket.getsockname())
2172
2894
    else:                       # IPv4
2173
 
        logger.info("Now listening on address %r, port %d"
2174
 
                    % tcp_server.socket.getsockname())
 
2895
        logger.info("Now listening on address %r, port %d",
 
2896
                    *tcp_server.socket.getsockname())
2175
2897
    
2176
2898
    #service.interface = tcp_server.socket.getsockname()[3]
2177
2899
    
2178
2900
    try:
2179
 
        # From the Avahi example code
2180
 
        try:
2181
 
            service.activate()
2182
 
        except dbus.exceptions.DBusException as error:
2183
 
            logger.critical("DBusException: %s", error)
2184
 
            cleanup()
2185
 
            sys.exit(1)
2186
 
        # End of Avahi example code
 
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
2187
2910
        
2188
2911
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2189
2912
                             lambda *args, **kwargs:
2193
2916
        logger.debug("Starting main loop")
2194
2917
        main_loop.run()
2195
2918
    except AvahiError as error:
2196
 
        logger.critical("AvahiError: %s", error)
 
2919
        logger.critical("Avahi Error", exc_info=error)
2197
2920
        cleanup()
2198
2921
        sys.exit(1)
2199
2922
    except KeyboardInterrupt: