/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

* network-hooks.d: New directory.
* network-hooks.d/bridge: New example hook.
* network-hooks.d/bridge.conf: Config file for bridge example hook.

Show diffs side-by-side

added added

removed removed

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