/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

Miscellaneous fixes prompted by lintian:

* debian/control (Conflicts): Changed to "Breaks:".
* debian/copyright: Updated format.
* debian/mandos-client.postinst: Use "set -e" instead of "#!/bin/sh -e".
* debian/mandos-client.postrm: - '' -
* debian/mandos.postinst: - '' -
* debian/mandos.prerm: Consistent magic.
* mandos: Small comment change.
* mandos-clients.conf.xml (OPTIONS/extended_timeout): Fix spelling.

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.0"
 
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
665
 
        if self.disable_initiator_tag is not None:
666
 
            gobject.source_remove(self.disable_initiator_tag)
667
 
            self.disable_initiator_tag = None
668
 
        if getattr(self, "enabled", False):
669
 
            self.disable_initiator_tag = gobject.timeout_add(
670
 
                int(timeout.total_seconds() * 1000), self.disable)
671
 
            self.expires = datetime.datetime.utcnow() + timeout
 
466
        self.last_checked_ok = datetime.datetime.utcnow()
 
467
        gobject.source_remove(self.disable_initiator_tag)
 
468
        self.disable_initiator_tag = (gobject.timeout_add
 
469
                                      (_timedelta_to_milliseconds
 
470
                                       (timeout), self.disable))
 
471
        self.expires = datetime.datetime.utcnow() + timeout
672
472
    
673
473
    def need_approval(self):
674
474
        self.last_approval_request = datetime.datetime.utcnow()
679
479
        If a checker already exists, leave it running and do
680
480
        nothing."""
681
481
        # 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
 
482
        # did that, then if a checker (for some reason) started
 
483
        # running slowly and taking more than 'interval' time, the
 
484
        # client would inevitably timeout, since no checker would get
 
485
        # a chance to run to completion.  If we instead leave running
686
486
        # checkers alone, the checker would have to take more time
687
487
        # than 'timeout' for the client to be disabled, which is as it
688
488
        # should be.
690
490
        # If a checker exists, make sure it is not a zombie
691
491
        try:
692
492
            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
 
493
        except (AttributeError, OSError) as error:
 
494
            if (isinstance(error, OSError)
 
495
                and error.errno != errno.ECHILD):
 
496
                raise error
698
497
        else:
699
498
            if pid:
700
499
                logger.warning("Checker was a zombie")
703
502
                                      self.current_checker_command)
704
503
        # Start a new checker if needed
705
504
        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
505
            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
 
506
                # In case checker_command has exactly one % operator
 
507
                command = self.checker_command % self.host
 
508
            except TypeError:
 
509
                # Escape attributes for the shell
 
510
                escaped_attrs = dict(
 
511
                    (attr,
 
512
                     re.escape(unicode(str(getattr(self, attr, "")),
 
513
                                       errors=
 
514
                                       'replace')))
 
515
                    for attr in
 
516
                    self.runtime_expansions)
 
517
                
 
518
                try:
 
519
                    command = self.checker_command % escaped_attrs
 
520
                except TypeError as error:
 
521
                    logger.error('Could not format string "%s":'
 
522
                                 ' %s', self.checker_command, error)
 
523
                    return True # Try again later
717
524
            self.current_checker_command = command
718
525
            try:
719
 
                logger.info("Starting checker %r for %s", command,
720
 
                            self.name)
 
526
                logger.info("Starting checker %r for %s",
 
527
                            command, self.name)
721
528
                # We don't need to redirect stdout and stderr, since
722
529
                # in normal mode, that is already done by daemon(),
723
530
                # and in debug mode we don't want to.  (Stdin is
724
531
                # 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
532
                self.checker = subprocess.Popen(command,
734
533
                                                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:
 
534
                                                shell=True, cwd="/")
 
535
                self.checker_callback_tag = (gobject.child_watch_add
 
536
                                             (self.checker.pid,
 
537
                                              self.checker_callback,
 
538
                                              data=command))
 
539
                # The checker may have completed before the gobject
 
540
                # watch was added.  Check for this.
747
541
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
542
                if pid:
 
543
                    gobject.source_remove(self.checker_callback_tag)
 
544
                    self.checker_callback(pid, status, command)
748
545
            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)
 
546
                logger.error("Failed to start subprocess: %s",
 
547
                             error)
758
548
        # Re-run this periodically if run by gobject.timeout_add
759
549
        return True
760
550
    
767
557
            return
768
558
        logger.debug("Stopping checker for %(name)s", vars(self))
769
559
        try:
770
 
            self.checker.terminate()
 
560
            os.kill(self.checker.pid, signal.SIGTERM)
771
561
            #time.sleep(0.5)
772
562
            #if self.checker.poll() is None:
773
 
            #    self.checker.kill()
 
563
            #    os.kill(self.checker.pid, signal.SIGKILL)
774
564
        except OSError as error:
775
565
            if error.errno != errno.ESRCH: # No such process
776
566
                raise
777
567
        self.checker = None
778
568
 
779
569
 
780
 
def dbus_service_property(dbus_interface,
781
 
                          signature="v",
782
 
                          access="readwrite",
783
 
                          byte_arrays=False):
 
570
def dbus_service_property(dbus_interface, signature="v",
 
571
                          access="readwrite", byte_arrays=False):
784
572
    """Decorators for marking methods of a DBusObjectWithProperties to
785
573
    become properties on the D-Bus.
786
574
    
795
583
    # "Set" method, so we fail early here:
796
584
    if byte_arrays and signature != "ay":
797
585
        raise ValueError("Byte arrays not supported for non-'ay'"
798
 
                         " signature {!r}".format(signature))
799
 
    
 
586
                         " signature %r" % signature)
800
587
    def decorator(func):
801
588
        func._dbus_is_property = True
802
589
        func._dbus_interface = dbus_interface
807
594
            func._dbus_name = func._dbus_name[:-14]
808
595
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
809
596
        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
597
    return decorator
853
598
 
854
599
 
855
600
class DBusPropertyException(dbus.exceptions.DBusException):
856
601
    """A base class for D-Bus property-related exceptions
857
602
    """
858
 
    pass
 
603
    def __unicode__(self):
 
604
        return unicode(str(self))
859
605
 
860
606
 
861
607
class DBusPropertyAccessException(DBusPropertyException):
879
625
    """
880
626
    
881
627
    @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)
 
628
    def _is_dbus_property(obj):
 
629
        return getattr(obj, "_dbus_is_property", False)
890
630
    
891
 
    def _get_all_dbus_things(self, thing):
 
631
    def _get_all_dbus_properties(self):
892
632
        """Returns a generator of (name, attribute) pairs
893
633
        """
894
 
        return ((getattr(athing.__get__(self), "_dbus_name", name),
895
 
                 athing.__get__(self))
 
634
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
896
635
                for cls in self.__class__.__mro__
897
 
                for name, athing in
898
 
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
636
                for name, prop in
 
637
                inspect.getmembers(cls, self._is_dbus_property))
899
638
    
900
639
    def _get_dbus_property(self, interface_name, property_name):
901
640
        """Returns a bound method if one exists which is a D-Bus
902
641
        property with the specified name and interface.
903
642
        """
904
 
        for cls in self.__class__.__mro__:
905
 
            for name, value in inspect.getmembers(
906
 
                    cls, self._is_dbus_thing("property")):
 
643
        for cls in  self.__class__.__mro__:
 
644
            for name, value in (inspect.getmembers
 
645
                                (cls, self._is_dbus_property)):
907
646
                if (value._dbus_name == property_name
908
647
                    and value._dbus_interface == interface_name):
909
648
                    return value.__get__(self)
910
649
        
911
650
        # No such property
912
 
        raise DBusPropertyNotFound("{}:{}.{}".format(
913
 
            self.dbus_object_path, interface_name, property_name))
 
651
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
652
                                   + interface_name + "."
 
653
                                   + property_name)
914
654
    
915
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
916
 
                         in_signature="ss",
 
655
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
917
656
                         out_signature="v")
918
657
    def Get(self, interface_name, property_name):
919
658
        """Standard D-Bus property Get() method, see D-Bus standard.
937
676
            # The byte_arrays option is not supported yet on
938
677
            # signatures other than "ay".
939
678
            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))
 
679
                raise ValueError
 
680
            value = dbus.ByteArray(''.join(unichr(byte)
 
681
                                           for byte in value))
945
682
        prop(value)
946
683
    
947
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
948
 
                         in_signature="s",
 
684
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
949
685
                         out_signature="a{sv}")
950
686
    def GetAll(self, interface_name):
951
687
        """Standard D-Bus property GetAll() method, see D-Bus
953
689
        
954
690
        Note: Will not include properties with access="write".
955
691
        """
956
 
        properties = {}
957
 
        for name, prop in self._get_all_dbus_things("property"):
 
692
        all = {}
 
693
        for name, prop in self._get_all_dbus_properties():
958
694
            if (interface_name
959
695
                and interface_name != prop._dbus_interface):
960
696
                # Interface non-empty but did not match
964
700
                continue
965
701
            value = prop()
966
702
            if not hasattr(value, "variant_level"):
967
 
                properties[name] = value
 
703
                all[name] = value
968
704
                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
 
705
            all[name] = type(value)(value, variant_level=
 
706
                                    value.variant_level+1)
 
707
        return dbus.Dictionary(all, signature="sv")
980
708
    
981
709
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
982
710
                         out_signature="s",
983
711
                         path_keyword='object_path',
984
712
                         connection_keyword='connection')
985
713
    def Introspect(self, object_path, connection):
986
 
        """Overloading of standard D-Bus method.
987
 
        
988
 
        Inserts property tags and interface annotation tags.
 
714
        """Standard D-Bus method, overloaded to insert property tags.
989
715
        """
990
716
        xmlstring = dbus.service.Object.Introspect(self, object_path,
991
717
                                                   connection)
992
718
        try:
993
719
            document = xml.dom.minidom.parseString(xmlstring)
994
 
            
995
720
            def make_tag(document, name, prop):
996
721
                e = document.createElement("property")
997
722
                e.setAttribute("name", name)
998
723
                e.setAttribute("type", prop._dbus_signature)
999
724
                e.setAttribute("access", prop._dbus_access)
1000
725
                return e
1001
 
            
1002
726
            for if_tag in document.getElementsByTagName("interface"):
1003
 
                # Add property tags
1004
727
                for tag in (make_tag(document, name, prop)
1005
728
                            for name, prop
1006
 
                            in self._get_all_dbus_things("property")
 
729
                            in self._get_all_dbus_properties()
1007
730
                            if prop._dbus_interface
1008
731
                            == if_tag.getAttribute("name")):
1009
732
                    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
733
                # Add the names to the return values for the
1040
734
                # "org.freedesktop.DBus.Properties" methods
1041
735
                if (if_tag.getAttribute("name")
1056
750
        except (AttributeError, xml.dom.DOMException,
1057
751
                xml.parsers.expat.ExpatError) as error:
1058
752
            logger.error("Failed to override Introspection method",
1059
 
                         exc_info=error)
 
753
                         error)
1060
754
        return xmlstring
1061
755
 
1062
756
 
1063
 
def datetime_to_dbus(dt, variant_level=0):
 
757
def datetime_to_dbus (dt, variant_level=0):
1064
758
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1065
759
    if dt is None:
1066
760
        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).
 
761
    return dbus.String(dt.isoformat(),
 
762
                       variant_level=variant_level)
 
763
 
 
764
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
765
                                  .__metaclass__):
 
766
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
767
    will add additional D-Bus attributes matching a certain pattern.
1092
768
    """
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):
 
769
    def __new__(mcs, name, bases, attr):
 
770
        # Go through all the base classes which could have D-Bus
 
771
        # methods, signals, or properties in them
 
772
        for base in (b for b in bases
 
773
                     if issubclass(b, dbus.service.Object)):
 
774
            # Go though all attributes of the base class
 
775
            for attrname, attribute in inspect.getmembers(base):
1101
776
                # Ignore non-D-Bus attributes, and D-Bus attributes
1102
777
                # with the wrong interface name
1103
778
                if (not hasattr(attribute, "_dbus_interface")
1104
 
                    or not attribute._dbus_interface.startswith(
1105
 
                        orig_interface_name)):
 
779
                    or not attribute._dbus_interface
 
780
                    .startswith("se.recompile.Mandos")):
1106
781
                    continue
1107
782
                # Create an alternate D-Bus interface name based on
1108
783
                # the current name
1109
 
                alt_interface = attribute._dbus_interface.replace(
1110
 
                    orig_interface_name, alt_interface_name)
1111
 
                interface_names.add(alt_interface)
 
784
                alt_interface = (attribute._dbus_interface
 
785
                                 .replace("se.recompile.Mandos",
 
786
                                          "se.bsnet.fukt.Mandos"))
1112
787
                # Is this a D-Bus signal?
1113
788
                if getattr(attribute, "_dbus_is_signal", False):
1114
 
                    # Extract the original non-method undecorated
1115
 
                    # function by black magic
 
789
                    # Extract the original non-method function by
 
790
                    # black magic
1116
791
                    nonmethod_func = (dict(
1117
 
                        zip(attribute.func_code.co_freevars,
1118
 
                            attribute.__closure__))
1119
 
                                      ["func"].cell_contents)
 
792
                            zip(attribute.func_code.co_freevars,
 
793
                                attribute.__closure__))["func"]
 
794
                                      .cell_contents)
1120
795
                    # Create a new, but exactly alike, function
1121
796
                    # object, and decorate it to be a new D-Bus signal
1122
797
                    # with the alternate D-Bus interface name
1123
 
                    new_function = (dbus.service.signal(
1124
 
                        alt_interface, attribute._dbus_signature)
 
798
                    new_function = (dbus.service.signal
 
799
                                    (alt_interface,
 
800
                                     attribute._dbus_signature)
1125
801
                                    (types.FunctionType(
1126
 
                                        nonmethod_func.func_code,
1127
 
                                        nonmethod_func.func_globals,
1128
 
                                        nonmethod_func.func_name,
1129
 
                                        nonmethod_func.func_defaults,
1130
 
                                        nonmethod_func.func_closure)))
1131
 
                    # Copy annotations, if any
1132
 
                    try:
1133
 
                        new_function._dbus_annotations = dict(
1134
 
                            attribute._dbus_annotations)
1135
 
                    except AttributeError:
1136
 
                        pass
 
802
                                nonmethod_func.func_code,
 
803
                                nonmethod_func.func_globals,
 
804
                                nonmethod_func.func_name,
 
805
                                nonmethod_func.func_defaults,
 
806
                                nonmethod_func.func_closure)))
1137
807
                    # Define a creator of a function to call both the
1138
 
                    # original and alternate functions, so both the
1139
 
                    # original and alternate signals gets sent when
1140
 
                    # the function is called
 
808
                    # old and new functions, so both the old and new
 
809
                    # signals gets sent when the function is called
1141
810
                    def fixscope(func1, func2):
1142
811
                        """This function is a scope container to pass
1143
812
                        func1 and func2 to the "call_both" function
1144
813
                        outside of its arguments"""
1145
 
                        
1146
814
                        def call_both(*args, **kwargs):
1147
815
                            """This function will emit two D-Bus
1148
816
                            signals by calling func1 and func2"""
1149
817
                            func1(*args, **kwargs)
1150
818
                            func2(*args, **kwargs)
1151
 
                        
1152
819
                        return call_both
1153
820
                    # Create the "call_both" function and add it to
1154
821
                    # the class
1155
 
                    attr[attrname] = fixscope(attribute, new_function)
 
822
                    attr[attrname] = fixscope(attribute,
 
823
                                              new_function)
1156
824
                # Is this a D-Bus method?
1157
825
                elif getattr(attribute, "_dbus_is_method", False):
1158
826
                    # Create a new, but exactly alike, function
1159
827
                    # object.  Decorate it to be a new D-Bus method
1160
828
                    # with the alternate D-Bus interface name.  Add it
1161
829
                    # to the class.
1162
 
                    attr[attrname] = (
1163
 
                        dbus.service.method(
1164
 
                            alt_interface,
1165
 
                            attribute._dbus_in_signature,
1166
 
                            attribute._dbus_out_signature)
1167
 
                        (types.FunctionType(attribute.func_code,
1168
 
                                            attribute.func_globals,
1169
 
                                            attribute.func_name,
1170
 
                                            attribute.func_defaults,
1171
 
                                            attribute.func_closure)))
1172
 
                    # Copy annotations, if any
1173
 
                    try:
1174
 
                        attr[attrname]._dbus_annotations = dict(
1175
 
                            attribute._dbus_annotations)
1176
 
                    except AttributeError:
1177
 
                        pass
 
830
                    attr[attrname] = (dbus.service.method
 
831
                                      (alt_interface,
 
832
                                       attribute._dbus_in_signature,
 
833
                                       attribute._dbus_out_signature)
 
834
                                      (types.FunctionType
 
835
                                       (attribute.func_code,
 
836
                                        attribute.func_globals,
 
837
                                        attribute.func_name,
 
838
                                        attribute.func_defaults,
 
839
                                        attribute.func_closure)))
1178
840
                # Is this a D-Bus property?
1179
841
                elif getattr(attribute, "_dbus_is_property", False):
1180
842
                    # Create a new, but exactly alike, function
1181
843
                    # object, and decorate it to be a new D-Bus
1182
844
                    # property with the alternate D-Bus interface
1183
845
                    # name.  Add it to the class.
1184
 
                    attr[attrname] = (dbus_service_property(
1185
 
                        alt_interface, attribute._dbus_signature,
1186
 
                        attribute._dbus_access,
1187
 
                        attribute._dbus_get_args_options
1188
 
                        ["byte_arrays"])
1189
 
                                      (types.FunctionType(
1190
 
                                          attribute.func_code,
1191
 
                                          attribute.func_globals,
1192
 
                                          attribute.func_name,
1193
 
                                          attribute.func_defaults,
1194
 
                                          attribute.func_closure)))
1195
 
                    # Copy annotations, if any
1196
 
                    try:
1197
 
                        attr[attrname]._dbus_annotations = dict(
1198
 
                            attribute._dbus_annotations)
1199
 
                    except AttributeError:
1200
 
                        pass
1201
 
                # Is this a D-Bus interface?
1202
 
                elif getattr(attribute, "_dbus_is_interface", False):
1203
 
                    # Create a new, but exactly alike, function
1204
 
                    # object.  Decorate it to be a new D-Bus interface
1205
 
                    # with the alternate D-Bus interface name.  Add it
1206
 
                    # to the class.
1207
 
                    attr[attrname] = (
1208
 
                        dbus_interface_annotations(alt_interface)
1209
 
                        (types.FunctionType(attribute.func_code,
1210
 
                                            attribute.func_globals,
1211
 
                                            attribute.func_name,
1212
 
                                            attribute.func_defaults,
1213
 
                                            attribute.func_closure)))
1214
 
            if deprecate:
1215
 
                # Deprecate all alternate interfaces
1216
 
                iname="_AlternateDBusNames_interface_annotation{}"
1217
 
                for interface_name in interface_names:
1218
 
                    
1219
 
                    @dbus_interface_annotations(interface_name)
1220
 
                    def func(self):
1221
 
                        return { "org.freedesktop.DBus.Deprecated":
1222
 
                                 "true" }
1223
 
                    # Find an unused name
1224
 
                    for aname in (iname.format(i)
1225
 
                                  for i in itertools.count()):
1226
 
                        if aname not in attr:
1227
 
                            attr[aname] = func
1228
 
                            break
1229
 
            if interface_names:
1230
 
                # Replace the class with a new subclass of it with
1231
 
                # methods, signals, etc. as created above.
1232
 
                cls = type(b"{}Alternate".format(cls.__name__),
1233
 
                           (cls, ), attr)
1234
 
        return cls
1235
 
    
1236
 
    return wrapper
1237
 
 
1238
 
 
1239
 
@alternate_dbus_interfaces({"se.recompile.Mandos":
1240
 
                            "se.bsnet.fukt.Mandos"})
 
846
                    attr[attrname] = (dbus_service_property
 
847
                                      (alt_interface,
 
848
                                       attribute._dbus_signature,
 
849
                                       attribute._dbus_access,
 
850
                                       attribute
 
851
                                       ._dbus_get_args_options
 
852
                                       ["byte_arrays"])
 
853
                                      (types.FunctionType
 
854
                                       (attribute.func_code,
 
855
                                        attribute.func_globals,
 
856
                                        attribute.func_name,
 
857
                                        attribute.func_defaults,
 
858
                                        attribute.func_closure)))
 
859
        return type.__new__(mcs, name, bases, attr)
 
860
 
1241
861
class ClientDBus(Client, DBusObjectWithProperties):
1242
862
    """A Client class using D-Bus
1243
863
    
1247
867
    """
1248
868
    
1249
869
    runtime_expansions = (Client.runtime_expansions
1250
 
                          + ("dbus_object_path", ))
1251
 
    
1252
 
    _interface = "se.recompile.Mandos.Client"
 
870
                          + ("dbus_object_path",))
1253
871
    
1254
872
    # dbus.service.Object doesn't use super(), so we can't either.
1255
873
    
1256
874
    def __init__(self, bus = None, *args, **kwargs):
 
875
        self._approvals_pending = 0
1257
876
        self.bus = bus
1258
877
        Client.__init__(self, *args, **kwargs)
1259
878
        # Only now, when this client is initialized, can it show up on
1260
879
        # the D-Bus
1261
 
        client_object_name = str(self.name).translate(
 
880
        client_object_name = unicode(self.name).translate(
1262
881
            {ord("."): ord("_"),
1263
882
             ord("-"): ord("_")})
1264
 
        self.dbus_object_path = dbus.ObjectPath(
1265
 
            "/clients/" + client_object_name)
 
883
        self.dbus_object_path = (dbus.ObjectPath
 
884
                                 ("/clients/" + client_object_name))
1266
885
        DBusObjectWithProperties.__init__(self, self.bus,
1267
886
                                          self.dbus_object_path)
1268
 
    
1269
 
    def notifychangeproperty(transform_func, dbus_name,
1270
 
                             type_func=lambda x: x,
1271
 
                             variant_level=1,
1272
 
                             invalidate_only=False,
1273
 
                             _interface=_interface):
 
887
        
 
888
    def notifychangeproperty(transform_func,
 
889
                             dbus_name, type_func=lambda x: x,
 
890
                             variant_level=1):
1274
891
        """ Modify a variable so that it's a property which announces
1275
892
        its changes to DBus.
1276
 
        
1277
 
        transform_fun: Function that takes a value and a variant_level
1278
 
                       and transforms it to a D-Bus type.
 
893
 
 
894
        transform_fun: Function that takes a value and transforms it
 
895
                       to a D-Bus type.
1279
896
        dbus_name: D-Bus name of the variable
1280
897
        type_func: Function that transform the value before sending it
1281
898
                   to the D-Bus.  Default: no transform
1282
899
        variant_level: D-Bus variant level.  Default: 1
1283
900
        """
1284
 
        attrname = "_{}".format(dbus_name)
1285
 
        
 
901
        attrname = "_{0}".format(dbus_name)
1286
902
        def setter(self, value):
1287
903
            if hasattr(self, "dbus_object_path"):
1288
904
                if (not hasattr(self, attrname) or
1289
905
                    type_func(getattr(self, attrname, None))
1290
906
                    != type_func(value)):
1291
 
                    if invalidate_only:
1292
 
                        self.PropertiesChanged(
1293
 
                            _interface, dbus.Dictionary(),
1294
 
                            dbus.Array((dbus_name, )))
1295
 
                    else:
1296
 
                        dbus_value = transform_func(
1297
 
                            type_func(value),
1298
 
                            variant_level = variant_level)
1299
 
                        self.PropertyChanged(dbus.String(dbus_name),
1300
 
                                             dbus_value)
1301
 
                        self.PropertiesChanged(
1302
 
                            _interface,
1303
 
                            dbus.Dictionary({ dbus.String(dbus_name):
1304
 
                                              dbus_value }),
1305
 
                            dbus.Array())
 
907
                    dbus_value = transform_func(type_func(value),
 
908
                                                variant_level)
 
909
                    self.PropertyChanged(dbus.String(dbus_name),
 
910
                                         dbus_value)
1306
911
            setattr(self, attrname, value)
1307
912
        
1308
913
        return property(lambda self: getattr(self, attrname), setter)
1309
914
    
 
915
    
1310
916
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1311
917
    approvals_pending = notifychangeproperty(dbus.Boolean,
1312
918
                                             "ApprovalPending",
1314
920
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1315
921
    last_enabled = notifychangeproperty(datetime_to_dbus,
1316
922
                                        "LastEnabled")
1317
 
    checker = notifychangeproperty(
1318
 
        dbus.Boolean, "CheckerRunning",
1319
 
        type_func = lambda checker: checker is not None)
 
923
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
924
                                   type_func = lambda checker:
 
925
                                       checker is not None)
1320
926
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1321
927
                                           "LastCheckedOK")
1322
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1323
 
                                               "LastCheckerStatus")
1324
928
    last_approval_request = notifychangeproperty(
1325
929
        datetime_to_dbus, "LastApprovalRequest")
1326
930
    approved_by_default = notifychangeproperty(dbus.Boolean,
1327
931
                                               "ApprovedByDefault")
1328
 
    approval_delay = notifychangeproperty(
1329
 
        dbus.UInt64, "ApprovalDelay",
1330
 
        type_func = lambda td: td.total_seconds() * 1000)
 
932
    approval_delay = notifychangeproperty(dbus.UInt16,
 
933
                                          "ApprovalDelay",
 
934
                                          type_func =
 
935
                                          _timedelta_to_milliseconds)
1331
936
    approval_duration = notifychangeproperty(
1332
 
        dbus.UInt64, "ApprovalDuration",
1333
 
        type_func = lambda td: td.total_seconds() * 1000)
 
937
        dbus.UInt16, "ApprovalDuration",
 
938
        type_func = _timedelta_to_milliseconds)
1334
939
    host = notifychangeproperty(dbus.String, "Host")
1335
 
    timeout = notifychangeproperty(
1336
 
        dbus.UInt64, "Timeout",
1337
 
        type_func = lambda td: td.total_seconds() * 1000)
 
940
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
 
941
                                   type_func =
 
942
                                   _timedelta_to_milliseconds)
1338
943
    extended_timeout = notifychangeproperty(
1339
 
        dbus.UInt64, "ExtendedTimeout",
1340
 
        type_func = lambda td: td.total_seconds() * 1000)
1341
 
    interval = notifychangeproperty(
1342
 
        dbus.UInt64, "Interval",
1343
 
        type_func = lambda td: td.total_seconds() * 1000)
 
944
        dbus.UInt16, "ExtendedTimeout",
 
945
        type_func = _timedelta_to_milliseconds)
 
946
    interval = notifychangeproperty(dbus.UInt16,
 
947
                                    "Interval",
 
948
                                    type_func =
 
949
                                    _timedelta_to_milliseconds)
1344
950
    checker_command = notifychangeproperty(dbus.String, "Checker")
1345
 
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1346
 
                                  invalidate_only=True)
1347
951
    
1348
952
    del notifychangeproperty
1349
953
    
1376
980
                                       *args, **kwargs)
1377
981
    
1378
982
    def start_checker(self, *args, **kwargs):
1379
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
983
        old_checker = self.checker
 
984
        if self.checker is not None:
 
985
            old_checker_pid = self.checker.pid
 
986
        else:
 
987
            old_checker_pid = None
1380
988
        r = Client.start_checker(self, *args, **kwargs)
1381
989
        # Only if new checker process was started
1382
990
        if (self.checker is not None
1386
994
        return r
1387
995
    
1388
996
    def _reset_approved(self):
1389
 
        self.approved = None
 
997
        self._approved = None
1390
998
        return False
1391
999
    
1392
1000
    def approve(self, value=True):
1393
 
        self.approved = value
1394
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1395
 
                                * 1000), self._reset_approved)
1396
1001
        self.send_changedstate()
 
1002
        self._approved = value
 
1003
        gobject.timeout_add(_timedelta_to_milliseconds
 
1004
                            (self.approval_duration),
 
1005
                            self._reset_approved)
 
1006
    
1397
1007
    
1398
1008
    ## D-Bus methods, signals & properties
1399
 
    
1400
 
    ## Interfaces
 
1009
    _interface = "se.recompile.Mandos.Client"
1401
1010
    
1402
1011
    ## Signals
1403
1012
    
1414
1023
        pass
1415
1024
    
1416
1025
    # PropertyChanged - signal
1417
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1418
1026
    @dbus.service.signal(_interface, signature="sv")
1419
1027
    def PropertyChanged(self, property, value):
1420
1028
        "D-Bus signal"
1484
1092
        return dbus.Boolean(bool(self.approvals_pending))
1485
1093
    
1486
1094
    # ApprovedByDefault - property
1487
 
    @dbus_service_property(_interface,
1488
 
                           signature="b",
 
1095
    @dbus_service_property(_interface, signature="b",
1489
1096
                           access="readwrite")
1490
1097
    def ApprovedByDefault_dbus_property(self, value=None):
1491
1098
        if value is None:       # get
1493
1100
        self.approved_by_default = bool(value)
1494
1101
    
1495
1102
    # ApprovalDelay - property
1496
 
    @dbus_service_property(_interface,
1497
 
                           signature="t",
 
1103
    @dbus_service_property(_interface, signature="t",
1498
1104
                           access="readwrite")
1499
1105
    def ApprovalDelay_dbus_property(self, value=None):
1500
1106
        if value is None:       # get
1501
 
            return dbus.UInt64(self.approval_delay.total_seconds()
1502
 
                               * 1000)
 
1107
            return dbus.UInt64(self.approval_delay_milliseconds())
1503
1108
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1504
1109
    
1505
1110
    # ApprovalDuration - property
1506
 
    @dbus_service_property(_interface,
1507
 
                           signature="t",
 
1111
    @dbus_service_property(_interface, signature="t",
1508
1112
                           access="readwrite")
1509
1113
    def ApprovalDuration_dbus_property(self, value=None):
1510
1114
        if value is None:       # get
1511
 
            return dbus.UInt64(self.approval_duration.total_seconds()
1512
 
                               * 1000)
 
1115
            return dbus.UInt64(_timedelta_to_milliseconds(
 
1116
                    self.approval_duration))
1513
1117
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1514
1118
    
1515
1119
    # Name - property
1523
1127
        return dbus.String(self.fingerprint)
1524
1128
    
1525
1129
    # Host - property
1526
 
    @dbus_service_property(_interface,
1527
 
                           signature="s",
 
1130
    @dbus_service_property(_interface, signature="s",
1528
1131
                           access="readwrite")
1529
1132
    def Host_dbus_property(self, value=None):
1530
1133
        if value is None:       # get
1531
1134
            return dbus.String(self.host)
1532
 
        self.host = str(value)
 
1135
        self.host = value
1533
1136
    
1534
1137
    # Created - property
1535
1138
    @dbus_service_property(_interface, signature="s", access="read")
1536
1139
    def Created_dbus_property(self):
1537
 
        return datetime_to_dbus(self.created)
 
1140
        return dbus.String(datetime_to_dbus(self.created))
1538
1141
    
1539
1142
    # LastEnabled - property
1540
1143
    @dbus_service_property(_interface, signature="s", access="read")
1542
1145
        return datetime_to_dbus(self.last_enabled)
1543
1146
    
1544
1147
    # Enabled - property
1545
 
    @dbus_service_property(_interface,
1546
 
                           signature="b",
 
1148
    @dbus_service_property(_interface, signature="b",
1547
1149
                           access="readwrite")
1548
1150
    def Enabled_dbus_property(self, value=None):
1549
1151
        if value is None:       # get
1554
1156
            self.disable()
1555
1157
    
1556
1158
    # LastCheckedOK - property
1557
 
    @dbus_service_property(_interface,
1558
 
                           signature="s",
 
1159
    @dbus_service_property(_interface, signature="s",
1559
1160
                           access="readwrite")
1560
1161
    def LastCheckedOK_dbus_property(self, value=None):
1561
1162
        if value is not None:
1563
1164
            return
1564
1165
        return datetime_to_dbus(self.last_checked_ok)
1565
1166
    
1566
 
    # LastCheckerStatus - property
1567
 
    @dbus_service_property(_interface, signature="n", access="read")
1568
 
    def LastCheckerStatus_dbus_property(self):
1569
 
        return dbus.Int16(self.last_checker_status)
1570
 
    
1571
1167
    # Expires - property
1572
1168
    @dbus_service_property(_interface, signature="s", access="read")
1573
1169
    def Expires_dbus_property(self):
1579
1175
        return datetime_to_dbus(self.last_approval_request)
1580
1176
    
1581
1177
    # Timeout - property
1582
 
    @dbus_service_property(_interface,
1583
 
                           signature="t",
 
1178
    @dbus_service_property(_interface, signature="t",
1584
1179
                           access="readwrite")
1585
1180
    def Timeout_dbus_property(self, value=None):
1586
1181
        if value is None:       # get
1587
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1588
 
        old_timeout = self.timeout
 
1182
            return dbus.UInt64(self.timeout_milliseconds())
1589
1183
        self.timeout = datetime.timedelta(0, 0, 0, value)
1590
 
        # Reschedule disabling
1591
 
        if self.enabled:
1592
 
            now = datetime.datetime.utcnow()
1593
 
            self.expires += self.timeout - old_timeout
1594
 
            if self.expires <= now:
1595
 
                # The timeout has passed
1596
 
                self.disable()
1597
 
            else:
1598
 
                if (getattr(self, "disable_initiator_tag", None)
1599
 
                    is None):
1600
 
                    return
1601
 
                gobject.source_remove(self.disable_initiator_tag)
1602
 
                self.disable_initiator_tag = gobject.timeout_add(
1603
 
                    int((self.expires - now).total_seconds() * 1000),
1604
 
                    self.disable)
 
1184
        if getattr(self, "disable_initiator_tag", None) is None:
 
1185
            return
 
1186
        # Reschedule timeout
 
1187
        gobject.source_remove(self.disable_initiator_tag)
 
1188
        self.disable_initiator_tag = None
 
1189
        self.expires = None
 
1190
        time_to_die = (self.
 
1191
                       _timedelta_to_milliseconds((self
 
1192
                                                   .last_checked_ok
 
1193
                                                   + self.timeout)
 
1194
                                                  - datetime.datetime
 
1195
                                                  .utcnow()))
 
1196
        if time_to_die <= 0:
 
1197
            # The timeout has passed
 
1198
            self.disable()
 
1199
        else:
 
1200
            self.expires = (datetime.datetime.utcnow()
 
1201
                            + datetime.timedelta(milliseconds =
 
1202
                                                 time_to_die))
 
1203
            self.disable_initiator_tag = (gobject.timeout_add
 
1204
                                          (time_to_die, self.disable))
1605
1205
    
1606
1206
    # ExtendedTimeout - property
1607
 
    @dbus_service_property(_interface,
1608
 
                           signature="t",
 
1207
    @dbus_service_property(_interface, signature="t",
1609
1208
                           access="readwrite")
1610
1209
    def ExtendedTimeout_dbus_property(self, value=None):
1611
1210
        if value is None:       # get
1612
 
            return dbus.UInt64(self.extended_timeout.total_seconds()
1613
 
                               * 1000)
 
1211
            return dbus.UInt64(self.extended_timeout_milliseconds())
1614
1212
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1615
1213
    
1616
1214
    # Interval - property
1617
 
    @dbus_service_property(_interface,
1618
 
                           signature="t",
 
1215
    @dbus_service_property(_interface, signature="t",
1619
1216
                           access="readwrite")
1620
1217
    def Interval_dbus_property(self, value=None):
1621
1218
        if value is None:       # get
1622
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1219
            return dbus.UInt64(self.interval_milliseconds())
1623
1220
        self.interval = datetime.timedelta(0, 0, 0, value)
1624
1221
        if getattr(self, "checker_initiator_tag", None) is None:
1625
1222
            return
1626
 
        if self.enabled:
1627
 
            # Reschedule checker run
1628
 
            gobject.source_remove(self.checker_initiator_tag)
1629
 
            self.checker_initiator_tag = gobject.timeout_add(
1630
 
                value, self.start_checker)
1631
 
            self.start_checker() # Start one now, too
 
1223
        # Reschedule checker run
 
1224
        gobject.source_remove(self.checker_initiator_tag)
 
1225
        self.checker_initiator_tag = (gobject.timeout_add
 
1226
                                      (value, self.start_checker))
 
1227
        self.start_checker()    # Start one now, too
1632
1228
    
1633
1229
    # Checker - property
1634
 
    @dbus_service_property(_interface,
1635
 
                           signature="s",
 
1230
    @dbus_service_property(_interface, signature="s",
1636
1231
                           access="readwrite")
1637
1232
    def Checker_dbus_property(self, value=None):
1638
1233
        if value is None:       # get
1639
1234
            return dbus.String(self.checker_command)
1640
 
        self.checker_command = str(value)
 
1235
        self.checker_command = value
1641
1236
    
1642
1237
    # CheckerRunning - property
1643
 
    @dbus_service_property(_interface,
1644
 
                           signature="b",
 
1238
    @dbus_service_property(_interface, signature="b",
1645
1239
                           access="readwrite")
1646
1240
    def CheckerRunning_dbus_property(self, value=None):
1647
1241
        if value is None:       # get
1657
1251
        return self.dbus_object_path # is already a dbus.ObjectPath
1658
1252
    
1659
1253
    # Secret = property
1660
 
    @dbus_service_property(_interface,
1661
 
                           signature="ay",
1662
 
                           access="write",
1663
 
                           byte_arrays=True)
 
1254
    @dbus_service_property(_interface, signature="ay",
 
1255
                           access="write", byte_arrays=True)
1664
1256
    def Secret_dbus_property(self, value):
1665
 
        self.secret = bytes(value)
 
1257
        self.secret = str(value)
1666
1258
    
1667
1259
    del _interface
1668
1260
 
1672
1264
        self._pipe = child_pipe
1673
1265
        self._pipe.send(('init', fpr, address))
1674
1266
        if not self._pipe.recv():
1675
 
            raise KeyError(fpr)
 
1267
            raise KeyError()
1676
1268
    
1677
1269
    def __getattribute__(self, name):
1678
 
        if name == '_pipe':
 
1270
        if(name == '_pipe'):
1679
1271
            return super(ProxyClient, self).__getattribute__(name)
1680
1272
        self._pipe.send(('getattr', name))
1681
1273
        data = self._pipe.recv()
1682
1274
        if data[0] == 'data':
1683
1275
            return data[1]
1684
1276
        if data[0] == 'function':
1685
 
            
1686
1277
            def func(*args, **kwargs):
1687
1278
                self._pipe.send(('funcall', name, args, kwargs))
1688
1279
                return self._pipe.recv()[1]
1689
 
            
1690
1280
            return func
1691
1281
    
1692
1282
    def __setattr__(self, name, value):
1693
 
        if name == '_pipe':
 
1283
        if(name == '_pipe'):
1694
1284
            return super(ProxyClient, self).__setattr__(name, value)
1695
1285
        self._pipe.send(('setattr', name, value))
1696
1286
 
 
1287
class ClientDBusTransitional(ClientDBus):
 
1288
    __metaclass__ = AlternateDBusNamesMetaclass
1697
1289
 
1698
1290
class ClientHandler(socketserver.BaseRequestHandler, object):
1699
1291
    """A class to handle client connections.
1704
1296
    def handle(self):
1705
1297
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1706
1298
            logger.info("TCP connection from: %s",
1707
 
                        str(self.client_address))
 
1299
                        unicode(self.client_address))
1708
1300
            logger.debug("Pipe FD: %d",
1709
1301
                         self.server.child_pipe.fileno())
1710
1302
            
1711
 
            session = gnutls.connection.ClientSession(
1712
 
                self.request, gnutls.connection .X509Credentials())
 
1303
            session = (gnutls.connection
 
1304
                       .ClientSession(self.request,
 
1305
                                      gnutls.connection
 
1306
                                      .X509Credentials()))
1713
1307
            
1714
1308
            # Note: gnutls.connection.X509Credentials is really a
1715
1309
            # generic GnuTLS certificate credentials object so long as
1724
1318
            priority = self.server.gnutls_priority
1725
1319
            if priority is None:
1726
1320
                priority = "NORMAL"
1727
 
            gnutls.library.functions.gnutls_priority_set_direct(
1728
 
                session._c_object, priority, None)
 
1321
            (gnutls.library.functions
 
1322
             .gnutls_priority_set_direct(session._c_object,
 
1323
                                         priority, None))
1729
1324
            
1730
1325
            # Start communication using the Mandos protocol
1731
1326
            # Get protocol number
1733
1328
            logger.debug("Protocol version: %r", line)
1734
1329
            try:
1735
1330
                if int(line.strip().split()[0]) > 1:
1736
 
                    raise RuntimeError(line)
 
1331
                    raise RuntimeError
1737
1332
            except (ValueError, IndexError, RuntimeError) as error:
1738
1333
                logger.error("Unknown protocol version: %s", error)
1739
1334
                return
1751
1346
            approval_required = False
1752
1347
            try:
1753
1348
                try:
1754
 
                    fpr = self.fingerprint(
1755
 
                        self.peer_certificate(session))
 
1349
                    fpr = self.fingerprint(self.peer_certificate
 
1350
                                           (session))
1756
1351
                except (TypeError,
1757
1352
                        gnutls.errors.GNUTLSError) as error:
1758
1353
                    logger.warning("Bad certificate: %s", error)
1773
1368
                while True:
1774
1369
                    if not client.enabled:
1775
1370
                        logger.info("Client %s is disabled",
1776
 
                                    client.name)
 
1371
                                       client.name)
1777
1372
                        if self.server.use_dbus:
1778
1373
                            # Emit D-Bus signal
1779
1374
                            client.Rejected("Disabled")
1780
1375
                        return
1781
1376
                    
1782
 
                    if client.approved or not client.approval_delay:
 
1377
                    if client._approved or not client.approval_delay:
1783
1378
                        #We are approved or approval is disabled
1784
1379
                        break
1785
 
                    elif client.approved is None:
 
1380
                    elif client._approved is None:
1786
1381
                        logger.info("Client %s needs approval",
1787
1382
                                    client.name)
1788
1383
                        if self.server.use_dbus:
1789
1384
                            # Emit D-Bus signal
1790
1385
                            client.NeedApproval(
1791
 
                                client.approval_delay.total_seconds()
1792
 
                                * 1000, client.approved_by_default)
 
1386
                                client.approval_delay_milliseconds(),
 
1387
                                client.approved_by_default)
1793
1388
                    else:
1794
1389
                        logger.warning("Client %s was not approved",
1795
1390
                                       client.name)
1801
1396
                    #wait until timeout or approved
1802
1397
                    time = datetime.datetime.now()
1803
1398
                    client.changedstate.acquire()
1804
 
                    client.changedstate.wait(delay.total_seconds())
 
1399
                    (client.changedstate.wait
 
1400
                     (float(client._timedelta_to_milliseconds(delay)
 
1401
                            / 1000)))
1805
1402
                    client.changedstate.release()
1806
1403
                    time2 = datetime.datetime.now()
1807
1404
                    if (time2 - time) >= delay:
1823
1420
                    try:
1824
1421
                        sent = session.send(client.secret[sent_size:])
1825
1422
                    except gnutls.errors.GNUTLSError as error:
1826
 
                        logger.warning("gnutls send failed",
1827
 
                                       exc_info=error)
 
1423
                        logger.warning("gnutls send failed")
1828
1424
                        return
1829
 
                    logger.debug("Sent: %d, remaining: %d", sent,
1830
 
                                 len(client.secret) - (sent_size
1831
 
                                                       + sent))
 
1425
                    logger.debug("Sent: %d, remaining: %d",
 
1426
                                 sent, len(client.secret)
 
1427
                                 - (sent_size + sent))
1832
1428
                    sent_size += sent
1833
1429
                
1834
1430
                logger.info("Sending secret to %s", client.name)
1835
1431
                # bump the timeout using extended_timeout
1836
 
                client.bump_timeout(client.extended_timeout)
 
1432
                client.checked_ok(client.extended_timeout)
1837
1433
                if self.server.use_dbus:
1838
1434
                    # Emit D-Bus signal
1839
1435
                    client.GotSecret()
1844
1440
                try:
1845
1441
                    session.bye()
1846
1442
                except gnutls.errors.GNUTLSError as error:
1847
 
                    logger.warning("GnuTLS bye failed",
1848
 
                                   exc_info=error)
 
1443
                    logger.warning("GnuTLS bye failed")
1849
1444
    
1850
1445
    @staticmethod
1851
1446
    def peer_certificate(session):
1852
1447
        "Return the peer's OpenPGP certificate as a bytestring"
1853
1448
        # If not an OpenPGP certificate...
1854
 
        if (gnutls.library.functions.gnutls_certificate_type_get(
1855
 
                session._c_object)
 
1449
        if (gnutls.library.functions
 
1450
            .gnutls_certificate_type_get(session._c_object)
1856
1451
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1857
1452
            # ...do the normal thing
1858
1453
            return session.peer_certificate
1872
1467
    def fingerprint(openpgp):
1873
1468
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1874
1469
        # New GnuTLS "datum" with the OpenPGP public key
1875
 
        datum = gnutls.library.types.gnutls_datum_t(
1876
 
            ctypes.cast(ctypes.c_char_p(openpgp),
1877
 
                        ctypes.POINTER(ctypes.c_ubyte)),
1878
 
            ctypes.c_uint(len(openpgp)))
 
1470
        datum = (gnutls.library.types
 
1471
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1472
                                             ctypes.POINTER
 
1473
                                             (ctypes.c_ubyte)),
 
1474
                                 ctypes.c_uint(len(openpgp))))
1879
1475
        # New empty GnuTLS certificate
1880
1476
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1881
 
        gnutls.library.functions.gnutls_openpgp_crt_init(
1882
 
            ctypes.byref(crt))
 
1477
        (gnutls.library.functions
 
1478
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
1883
1479
        # Import the OpenPGP public key into the certificate
1884
 
        gnutls.library.functions.gnutls_openpgp_crt_import(
1885
 
            crt, ctypes.byref(datum),
1886
 
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
1480
        (gnutls.library.functions
 
1481
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1482
                                    gnutls.library.constants
 
1483
                                    .GNUTLS_OPENPGP_FMT_RAW))
1887
1484
        # Verify the self signature in the key
1888
1485
        crtverify = ctypes.c_uint()
1889
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1890
 
            crt, 0, ctypes.byref(crtverify))
 
1486
        (gnutls.library.functions
 
1487
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1488
                                         ctypes.byref(crtverify)))
1891
1489
        if crtverify.value != 0:
1892
1490
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1893
 
            raise gnutls.errors.CertificateSecurityError(
1894
 
                "Verify failed")
 
1491
            raise (gnutls.errors.CertificateSecurityError
 
1492
                   ("Verify failed"))
1895
1493
        # New buffer for the fingerprint
1896
1494
        buf = ctypes.create_string_buffer(20)
1897
1495
        buf_len = ctypes.c_size_t()
1898
1496
        # Get the fingerprint from the certificate into the buffer
1899
 
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1900
 
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
1497
        (gnutls.library.functions
 
1498
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1499
                                             ctypes.byref(buf_len)))
1901
1500
        # Deinit the certificate
1902
1501
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1903
1502
        # Convert the buffer to a Python bytestring
1904
1503
        fpr = ctypes.string_at(buf, buf_len.value)
1905
1504
        # Convert the bytestring to hexadecimal notation
1906
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1505
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1907
1506
        return hex_fpr
1908
1507
 
1909
1508
 
1910
1509
class MultiprocessingMixIn(object):
1911
1510
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
1912
 
    
1913
1511
    def sub_process_main(self, request, address):
1914
1512
        try:
1915
1513
            self.finish_request(request, address)
1916
 
        except Exception:
 
1514
        except:
1917
1515
            self.handle_error(request, address)
1918
1516
        self.close_request(request)
1919
1517
    
1920
1518
    def process_request(self, request, address):
1921
1519
        """Start a new process to process the request."""
1922
1520
        proc = multiprocessing.Process(target = self.sub_process_main,
1923
 
                                       args = (request, address))
 
1521
                                       args = (request,
 
1522
                                               address))
1924
1523
        proc.start()
1925
1524
        return proc
1926
1525
 
1927
1526
 
1928
1527
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1929
1528
    """ adds a pipe to the MixIn """
1930
 
    
1931
1529
    def process_request(self, request, client_address):
1932
1530
        """Overrides and wraps the original process_request().
1933
1531
        
1942
1540
    
1943
1541
    def add_pipe(self, parent_pipe, proc):
1944
1542
        """Dummy function; override as necessary"""
1945
 
        raise NotImplementedError()
 
1543
        raise NotImplementedError
1946
1544
 
1947
1545
 
1948
1546
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1954
1552
        interface:      None or a network interface name (string)
1955
1553
        use_ipv6:       Boolean; to use IPv6 or not
1956
1554
    """
1957
 
    
1958
1555
    def __init__(self, server_address, RequestHandlerClass,
1959
 
                 interface=None,
1960
 
                 use_ipv6=True,
1961
 
                 socketfd=None):
1962
 
        """If socketfd is set, use that file descriptor instead of
1963
 
        creating a new one with socket.socket().
1964
 
        """
 
1556
                 interface=None, use_ipv6=True):
1965
1557
        self.interface = interface
1966
1558
        if use_ipv6:
1967
1559
            self.address_family = socket.AF_INET6
1968
 
        if socketfd is not None:
1969
 
            # Save the file descriptor
1970
 
            self.socketfd = socketfd
1971
 
            # Save the original socket.socket() function
1972
 
            self.socket_socket = socket.socket
1973
 
            # To implement --socket, we monkey patch socket.socket.
1974
 
            # 
1975
 
            # (When socketserver.TCPServer is a new-style class, we
1976
 
            # could make self.socket into a property instead of monkey
1977
 
            # patching socket.socket.)
1978
 
            # 
1979
 
            # Create a one-time-only replacement for socket.socket()
1980
 
            @functools.wraps(socket.socket)
1981
 
            def socket_wrapper(*args, **kwargs):
1982
 
                # Restore original function so subsequent calls are
1983
 
                # not affected.
1984
 
                socket.socket = self.socket_socket
1985
 
                del self.socket_socket
1986
 
                # This time only, return a new socket object from the
1987
 
                # saved file descriptor.
1988
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
1989
 
            # Replace socket.socket() function with wrapper
1990
 
            socket.socket = socket_wrapper
1991
 
        # The socketserver.TCPServer.__init__ will call
1992
 
        # socket.socket(), which might be our replacement,
1993
 
        # socket_wrapper(), if socketfd was set.
1994
1560
        socketserver.TCPServer.__init__(self, server_address,
1995
1561
                                        RequestHandlerClass)
1996
 
    
1997
1562
    def server_bind(self):
1998
1563
        """This overrides the normal server_bind() function
1999
1564
        to bind to an interface if one was specified, and also NOT to
2005
1570
                             self.interface)
2006
1571
            else:
2007
1572
                try:
2008
 
                    self.socket.setsockopt(
2009
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
2010
 
                        (self.interface + "\0").encode("utf-8"))
 
1573
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1574
                                           SO_BINDTODEVICE,
 
1575
                                           str(self.interface
 
1576
                                               + '\0'))
2011
1577
                except socket.error as error:
2012
 
                    if error.errno == errno.EPERM:
2013
 
                        logger.error("No permission to bind to"
2014
 
                                     " interface %s", self.interface)
2015
 
                    elif error.errno == errno.ENOPROTOOPT:
 
1578
                    if error[0] == errno.EPERM:
 
1579
                        logger.error("No permission to"
 
1580
                                     " bind to interface %s",
 
1581
                                     self.interface)
 
1582
                    elif error[0] == errno.ENOPROTOOPT:
2016
1583
                        logger.error("SO_BINDTODEVICE not available;"
2017
1584
                                     " cannot bind to interface %s",
2018
1585
                                     self.interface)
2019
 
                    elif error.errno == errno.ENODEV:
2020
 
                        logger.error("Interface %s does not exist,"
2021
 
                                     " cannot bind", self.interface)
2022
1586
                    else:
2023
1587
                        raise
2024
1588
        # Only bind(2) the socket if we really need to.
2027
1591
                if self.address_family == socket.AF_INET6:
2028
1592
                    any_address = "::" # in6addr_any
2029
1593
                else:
2030
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1594
                    any_address = socket.INADDR_ANY
2031
1595
                self.server_address = (any_address,
2032
1596
                                       self.server_address[1])
2033
1597
            elif not self.server_address[1]:
2034
 
                self.server_address = (self.server_address[0], 0)
 
1598
                self.server_address = (self.server_address[0],
 
1599
                                       0)
2035
1600
#                 if self.interface:
2036
1601
#                     self.server_address = (self.server_address[0],
2037
1602
#                                            0, # port
2051
1616
    
2052
1617
    Assumes a gobject.MainLoop event loop.
2053
1618
    """
2054
 
    
2055
1619
    def __init__(self, server_address, RequestHandlerClass,
2056
 
                 interface=None,
2057
 
                 use_ipv6=True,
2058
 
                 clients=None,
2059
 
                 gnutls_priority=None,
2060
 
                 use_dbus=True,
2061
 
                 socketfd=None):
 
1620
                 interface=None, use_ipv6=True, clients=None,
 
1621
                 gnutls_priority=None, use_dbus=True):
2062
1622
        self.enabled = False
2063
1623
        self.clients = clients
2064
1624
        if self.clients is None:
2065
 
            self.clients = {}
 
1625
            self.clients = set()
2066
1626
        self.use_dbus = use_dbus
2067
1627
        self.gnutls_priority = gnutls_priority
2068
1628
        IPv6_TCPServer.__init__(self, server_address,
2069
1629
                                RequestHandlerClass,
2070
1630
                                interface = interface,
2071
 
                                use_ipv6 = use_ipv6,
2072
 
                                socketfd = socketfd)
2073
 
    
 
1631
                                use_ipv6 = use_ipv6)
2074
1632
    def server_activate(self):
2075
1633
        if self.enabled:
2076
1634
            return socketserver.TCPServer.server_activate(self)
2080
1638
    
2081
1639
    def add_pipe(self, parent_pipe, proc):
2082
1640
        # Call "handle_ipc" for both data and EOF events
2083
 
        gobject.io_add_watch(
2084
 
            parent_pipe.fileno(),
2085
 
            gobject.IO_IN | gobject.IO_HUP,
2086
 
            functools.partial(self.handle_ipc,
2087
 
                              parent_pipe = parent_pipe,
2088
 
                              proc = proc))
 
1641
        gobject.io_add_watch(parent_pipe.fileno(),
 
1642
                             gobject.IO_IN | gobject.IO_HUP,
 
1643
                             functools.partial(self.handle_ipc,
 
1644
                                               parent_pipe =
 
1645
                                               parent_pipe,
 
1646
                                               proc = proc))
2089
1647
    
2090
 
    def handle_ipc(self, source, condition,
2091
 
                   parent_pipe=None,
2092
 
                   proc = None,
2093
 
                   client_object=None):
 
1648
    def handle_ipc(self, source, condition, parent_pipe=None,
 
1649
                   proc = None, client_object=None):
 
1650
        condition_names = {
 
1651
            gobject.IO_IN: "IN",   # There is data to read.
 
1652
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1653
                                    # blocking).
 
1654
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1655
            gobject.IO_ERR: "ERR", # Error condition.
 
1656
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1657
                                    # broken, usually for pipes and
 
1658
                                    # sockets).
 
1659
            }
 
1660
        conditions_string = ' | '.join(name
 
1661
                                       for cond, name in
 
1662
                                       condition_names.iteritems()
 
1663
                                       if cond & condition)
2094
1664
        # error, or the other end of multiprocessing.Pipe has closed
2095
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
1665
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2096
1666
            # Wait for other process to exit
2097
1667
            proc.join()
2098
1668
            return False
2105
1675
            fpr = request[1]
2106
1676
            address = request[2]
2107
1677
            
2108
 
            for c in self.clients.itervalues():
 
1678
            for c in self.clients:
2109
1679
                if c.fingerprint == fpr:
2110
1680
                    client = c
2111
1681
                    break
2119
1689
                parent_pipe.send(False)
2120
1690
                return False
2121
1691
            
2122
 
            gobject.io_add_watch(
2123
 
                parent_pipe.fileno(),
2124
 
                gobject.IO_IN | gobject.IO_HUP,
2125
 
                functools.partial(self.handle_ipc,
2126
 
                                  parent_pipe = parent_pipe,
2127
 
                                  proc = proc,
2128
 
                                  client_object = client))
 
1692
            gobject.io_add_watch(parent_pipe.fileno(),
 
1693
                                 gobject.IO_IN | gobject.IO_HUP,
 
1694
                                 functools.partial(self.handle_ipc,
 
1695
                                                   parent_pipe =
 
1696
                                                   parent_pipe,
 
1697
                                                   proc = proc,
 
1698
                                                   client_object =
 
1699
                                                   client))
2129
1700
            parent_pipe.send(True)
2130
1701
            # remove the old hook in favor of the new above hook on
2131
1702
            # same fileno
2137
1708
            
2138
1709
            parent_pipe.send(('data', getattr(client_object,
2139
1710
                                              funcname)(*args,
2140
 
                                                        **kwargs)))
 
1711
                                                         **kwargs)))
2141
1712
        
2142
1713
        if command == 'getattr':
2143
1714
            attrname = request[1]
2144
1715
            if callable(client_object.__getattribute__(attrname)):
2145
 
                parent_pipe.send(('function', ))
 
1716
                parent_pipe.send(('function',))
2146
1717
            else:
2147
 
                parent_pipe.send((
2148
 
                    'data', client_object.__getattribute__(attrname)))
 
1718
                parent_pipe.send(('data', client_object
 
1719
                                  .__getattribute__(attrname)))
2149
1720
        
2150
1721
        if command == 'setattr':
2151
1722
            attrname = request[1]
2155
1726
        return True
2156
1727
 
2157
1728
 
2158
 
def rfc3339_duration_to_delta(duration):
2159
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2160
 
    
2161
 
    >>> rfc3339_duration_to_delta("P7D")
2162
 
    datetime.timedelta(7)
2163
 
    >>> rfc3339_duration_to_delta("PT60S")
2164
 
    datetime.timedelta(0, 60)
2165
 
    >>> rfc3339_duration_to_delta("PT60M")
2166
 
    datetime.timedelta(0, 3600)
2167
 
    >>> rfc3339_duration_to_delta("PT24H")
2168
 
    datetime.timedelta(1)
2169
 
    >>> rfc3339_duration_to_delta("P1W")
2170
 
    datetime.timedelta(7)
2171
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2172
 
    datetime.timedelta(0, 330)
2173
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2174
 
    datetime.timedelta(1, 200)
2175
 
    """
2176
 
    
2177
 
    # Parsing an RFC 3339 duration with regular expressions is not
2178
 
    # possible - there would have to be multiple places for the same
2179
 
    # values, like seconds.  The current code, while more esoteric, is
2180
 
    # cleaner without depending on a parsing library.  If Python had a
2181
 
    # built-in library for parsing we would use it, but we'd like to
2182
 
    # avoid excessive use of external libraries.
2183
 
    
2184
 
    # New type for defining tokens, syntax, and semantics all-in-one
2185
 
    Token = collections.namedtuple("Token",
2186
 
                                   ("regexp", # To match token; if
2187
 
                                              # "value" is not None,
2188
 
                                              # must have a "group"
2189
 
                                              # containing digits
2190
 
                                    "value",  # datetime.timedelta or
2191
 
                                              # None
2192
 
                                    "followers")) # Tokens valid after
2193
 
                                                  # this token
2194
 
    Token = collections.namedtuple("Token", (
2195
 
        "regexp",  # To match token; if "value" is not None, must have
2196
 
                   # a "group" containing digits
2197
 
        "value",   # datetime.timedelta or None
2198
 
        "followers"))           # Tokens valid after this token
2199
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2200
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2201
 
    token_end = Token(re.compile(r"$"), None, frozenset())
2202
 
    token_second = Token(re.compile(r"(\d+)S"),
2203
 
                         datetime.timedelta(seconds=1),
2204
 
                         frozenset((token_end, )))
2205
 
    token_minute = Token(re.compile(r"(\d+)M"),
2206
 
                         datetime.timedelta(minutes=1),
2207
 
                         frozenset((token_second, token_end)))
2208
 
    token_hour = Token(re.compile(r"(\d+)H"),
2209
 
                       datetime.timedelta(hours=1),
2210
 
                       frozenset((token_minute, token_end)))
2211
 
    token_time = Token(re.compile(r"T"),
2212
 
                       None,
2213
 
                       frozenset((token_hour, token_minute,
2214
 
                                  token_second)))
2215
 
    token_day = Token(re.compile(r"(\d+)D"),
2216
 
                      datetime.timedelta(days=1),
2217
 
                      frozenset((token_time, token_end)))
2218
 
    token_month = Token(re.compile(r"(\d+)M"),
2219
 
                        datetime.timedelta(weeks=4),
2220
 
                        frozenset((token_day, token_end)))
2221
 
    token_year = Token(re.compile(r"(\d+)Y"),
2222
 
                       datetime.timedelta(weeks=52),
2223
 
                       frozenset((token_month, token_end)))
2224
 
    token_week = Token(re.compile(r"(\d+)W"),
2225
 
                       datetime.timedelta(weeks=1),
2226
 
                       frozenset((token_end, )))
2227
 
    token_duration = Token(re.compile(r"P"), None,
2228
 
                           frozenset((token_year, token_month,
2229
 
                                      token_day, token_time,
2230
 
                                      token_week)))
2231
 
    # Define starting values
2232
 
    value = datetime.timedelta() # Value so far
2233
 
    found_token = None
2234
 
    followers = frozenset((token_duration,)) # Following valid tokens
2235
 
    s = duration                # String left to parse
2236
 
    # Loop until end token is found
2237
 
    while found_token is not token_end:
2238
 
        # Search for any currently valid tokens
2239
 
        for token in followers:
2240
 
            match = token.regexp.match(s)
2241
 
            if match is not None:
2242
 
                # Token found
2243
 
                if token.value is not None:
2244
 
                    # Value found, parse digits
2245
 
                    factor = int(match.group(1), 10)
2246
 
                    # Add to value so far
2247
 
                    value += factor * token.value
2248
 
                # Strip token from string
2249
 
                s = token.regexp.sub("", s, 1)
2250
 
                # Go to found token
2251
 
                found_token = token
2252
 
                # Set valid next tokens
2253
 
                followers = found_token.followers
2254
 
                break
2255
 
        else:
2256
 
            # No currently valid tokens were found
2257
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
2258
 
                             .format(duration))
2259
 
    # End token found
2260
 
    return value
2261
 
 
2262
 
 
2263
1729
def string_to_delta(interval):
2264
1730
    """Parse a string and return a datetime.timedelta
2265
1731
    
2276
1742
    >>> string_to_delta('5m 30s')
2277
1743
    datetime.timedelta(0, 330)
2278
1744
    """
2279
 
    
2280
 
    try:
2281
 
        return rfc3339_duration_to_delta(interval)
2282
 
    except ValueError:
2283
 
        pass
2284
 
    
2285
1745
    timevalue = datetime.timedelta(0)
2286
1746
    for s in interval.split():
2287
1747
        try:
2288
 
            suffix = s[-1]
 
1748
            suffix = unicode(s[-1])
2289
1749
            value = int(s[:-1])
2290
1750
            if suffix == "d":
2291
1751
                delta = datetime.timedelta(value)
2298
1758
            elif suffix == "w":
2299
1759
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2300
1760
            else:
2301
 
                raise ValueError("Unknown suffix {!r}".format(suffix))
2302
 
        except IndexError as e:
 
1761
                raise ValueError("Unknown suffix %r" % suffix)
 
1762
        except (ValueError, IndexError) as e:
2303
1763
            raise ValueError(*(e.args))
2304
1764
        timevalue += delta
2305
1765
    return timevalue
2306
1766
 
2307
1767
 
 
1768
def if_nametoindex(interface):
 
1769
    """Call the C function if_nametoindex(), or equivalent
 
1770
    
 
1771
    Note: This function cannot accept a unicode string."""
 
1772
    global if_nametoindex
 
1773
    try:
 
1774
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
1775
                          (ctypes.util.find_library("c"))
 
1776
                          .if_nametoindex)
 
1777
    except (OSError, AttributeError):
 
1778
        logger.warning("Doing if_nametoindex the hard way")
 
1779
        def if_nametoindex(interface):
 
1780
            "Get an interface index the hard way, i.e. using fcntl()"
 
1781
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
1782
            with contextlib.closing(socket.socket()) as s:
 
1783
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
1784
                                    struct.pack(str("16s16x"),
 
1785
                                                interface))
 
1786
            interface_index = struct.unpack(str("I"),
 
1787
                                            ifreq[16:20])[0]
 
1788
            return interface_index
 
1789
    return if_nametoindex(interface)
 
1790
 
 
1791
 
2308
1792
def daemon(nochdir = False, noclose = False):
2309
1793
    """See daemon(3).  Standard BSD Unix function.
2310
1794
    
2318
1802
        sys.exit()
2319
1803
    if not noclose:
2320
1804
        # Close all standard open file descriptors
2321
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1805
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2322
1806
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2323
1807
            raise OSError(errno.ENODEV,
2324
 
                          "{} not a character device"
2325
 
                          .format(os.devnull))
 
1808
                          "%s not a character device"
 
1809
                          % os.path.devnull)
2326
1810
        os.dup2(null, sys.stdin.fileno())
2327
1811
        os.dup2(null, sys.stdout.fileno())
2328
1812
        os.dup2(null, sys.stderr.fileno())
2337
1821
    
2338
1822
    parser = argparse.ArgumentParser()
2339
1823
    parser.add_argument("-v", "--version", action="version",
2340
 
                        version = "%(prog)s {}".format(version),
 
1824
                        version = "%%(prog)s %s" % version,
2341
1825
                        help="show version number and exit")
2342
1826
    parser.add_argument("-i", "--interface", metavar="IF",
2343
1827
                        help="Bind to interface IF")
2349
1833
                        help="Run self-test")
2350
1834
    parser.add_argument("--debug", action="store_true",
2351
1835
                        help="Debug mode; run in foreground and log"
2352
 
                        " to terminal", default=None)
 
1836
                        " to terminal")
2353
1837
    parser.add_argument("--debuglevel", metavar="LEVEL",
2354
1838
                        help="Debug level for stdout output")
2355
1839
    parser.add_argument("--priority", help="GnuTLS"
2362
1846
                        " files")
2363
1847
    parser.add_argument("--no-dbus", action="store_false",
2364
1848
                        dest="use_dbus", help="Do not provide D-Bus"
2365
 
                        " system bus interface", default=None)
 
1849
                        " system bus interface")
2366
1850
    parser.add_argument("--no-ipv6", action="store_false",
2367
 
                        dest="use_ipv6", help="Do not use IPv6",
2368
 
                        default=None)
2369
 
    parser.add_argument("--no-restore", action="store_false",
2370
 
                        dest="restore", help="Do not restore stored"
2371
 
                        " state", default=None)
2372
 
    parser.add_argument("--socket", type=int,
2373
 
                        help="Specify a file descriptor to a network"
2374
 
                        " socket to use instead of creating one")
2375
 
    parser.add_argument("--statedir", metavar="DIR",
2376
 
                        help="Directory to save/restore state in")
2377
 
    parser.add_argument("--foreground", action="store_true",
2378
 
                        help="Run in foreground", default=None)
2379
 
    parser.add_argument("--no-zeroconf", action="store_false",
2380
 
                        dest="zeroconf", help="Do not use Zeroconf",
2381
 
                        default=None)
2382
 
    
 
1851
                        dest="use_ipv6", help="Do not use IPv6")
2383
1852
    options = parser.parse_args()
2384
1853
    
2385
1854
    if options.check:
2386
1855
        import doctest
2387
 
        fail_count, test_count = doctest.testmod()
2388
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
1856
        doctest.testmod()
 
1857
        sys.exit()
2389
1858
    
2390
1859
    # Default values for config file for server-global settings
2391
1860
    server_defaults = { "interface": "",
2393
1862
                        "port": "",
2394
1863
                        "debug": "False",
2395
1864
                        "priority":
2396
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2397
 
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
1865
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2398
1866
                        "servicename": "Mandos",
2399
1867
                        "use_dbus": "True",
2400
1868
                        "use_ipv6": "True",
2401
1869
                        "debuglevel": "",
2402
 
                        "restore": "True",
2403
 
                        "socket": "",
2404
 
                        "statedir": "/var/lib/mandos",
2405
 
                        "foreground": "False",
2406
 
                        "zeroconf": "True",
2407
 
                    }
 
1870
                        }
2408
1871
    
2409
1872
    # Parse config file for server-global settings
2410
1873
    server_config = configparser.SafeConfigParser(server_defaults)
2411
1874
    del server_defaults
2412
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
1875
    server_config.read(os.path.join(options.configdir,
 
1876
                                    "mandos.conf"))
2413
1877
    # Convert the SafeConfigParser object to a dict
2414
1878
    server_settings = server_config.defaults()
2415
1879
    # Use the appropriate methods on the non-string config options
2416
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
1880
    for option in ("debug", "use_dbus", "use_ipv6"):
2417
1881
        server_settings[option] = server_config.getboolean("DEFAULT",
2418
1882
                                                           option)
2419
1883
    if server_settings["port"]:
2420
1884
        server_settings["port"] = server_config.getint("DEFAULT",
2421
1885
                                                       "port")
2422
 
    if server_settings["socket"]:
2423
 
        server_settings["socket"] = server_config.getint("DEFAULT",
2424
 
                                                         "socket")
2425
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
2426
 
        # over with an opened os.devnull.  But we don't want this to
2427
 
        # happen with a supplied network socket.
2428
 
        if 0 <= server_settings["socket"] <= 2:
2429
 
            server_settings["socket"] = os.dup(server_settings
2430
 
                                               ["socket"])
2431
1886
    del server_config
2432
1887
    
2433
1888
    # Override the settings from the config file with command line
2434
1889
    # options, if set.
2435
1890
    for option in ("interface", "address", "port", "debug",
2436
 
                   "priority", "servicename", "configdir", "use_dbus",
2437
 
                   "use_ipv6", "debuglevel", "restore", "statedir",
2438
 
                   "socket", "foreground", "zeroconf"):
 
1891
                   "priority", "servicename", "configdir",
 
1892
                   "use_dbus", "use_ipv6", "debuglevel"):
2439
1893
        value = getattr(options, option)
2440
1894
        if value is not None:
2441
1895
            server_settings[option] = value
2442
1896
    del options
2443
1897
    # Force all strings to be unicode
2444
1898
    for option in server_settings.keys():
2445
 
        if isinstance(server_settings[option], bytes):
2446
 
            server_settings[option] = (server_settings[option]
2447
 
                                       .decode("utf-8"))
2448
 
    # Force all boolean options to be boolean
2449
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2450
 
                   "foreground", "zeroconf"):
2451
 
        server_settings[option] = bool(server_settings[option])
2452
 
    # Debug implies foreground
2453
 
    if server_settings["debug"]:
2454
 
        server_settings["foreground"] = True
 
1899
        if type(server_settings[option]) is str:
 
1900
            server_settings[option] = unicode(server_settings[option])
2455
1901
    # Now we have our good server settings in "server_settings"
2456
1902
    
2457
1903
    ##################################################################
2458
1904
    
2459
 
    if (not server_settings["zeroconf"]
2460
 
        and not (server_settings["port"]
2461
 
                 or server_settings["socket"] != "")):
2462
 
        parser.error("Needs port or socket to work without Zeroconf")
2463
 
    
2464
1905
    # For convenience
2465
1906
    debug = server_settings["debug"]
2466
1907
    debuglevel = server_settings["debuglevel"]
2467
1908
    use_dbus = server_settings["use_dbus"]
2468
1909
    use_ipv6 = server_settings["use_ipv6"]
2469
 
    stored_state_path = os.path.join(server_settings["statedir"],
2470
 
                                     stored_state_file)
2471
 
    foreground = server_settings["foreground"]
2472
 
    zeroconf = server_settings["zeroconf"]
2473
 
    
2474
 
    if debug:
2475
 
        initlogger(debug, logging.DEBUG)
2476
 
    else:
2477
 
        if not debuglevel:
2478
 
            initlogger(debug)
2479
 
        else:
2480
 
            level = getattr(logging, debuglevel.upper())
2481
 
            initlogger(debug, level)
2482
1910
    
2483
1911
    if server_settings["servicename"] != "Mandos":
2484
 
        syslogger.setFormatter(
2485
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
2486
 
                              ' %(levelname)s: %(message)s'.format(
2487
 
                                  server_settings["servicename"])))
 
1912
        syslogger.setFormatter(logging.Formatter
 
1913
                               ('Mandos (%s) [%%(process)d]:'
 
1914
                                ' %%(levelname)s: %%(message)s'
 
1915
                                % server_settings["servicename"]))
2488
1916
    
2489
1917
    # Parse config file with clients
2490
 
    client_config = configparser.SafeConfigParser(Client
2491
 
                                                  .client_defaults)
 
1918
    client_defaults = { "timeout": "5m",
 
1919
                        "extended_timeout": "15m",
 
1920
                        "interval": "2m",
 
1921
                        "checker": "fping -q -- %%(host)s",
 
1922
                        "host": "",
 
1923
                        "approval_delay": "0s",
 
1924
                        "approval_duration": "1s",
 
1925
                        }
 
1926
    client_config = configparser.SafeConfigParser(client_defaults)
2492
1927
    client_config.read(os.path.join(server_settings["configdir"],
2493
1928
                                    "clients.conf"))
2494
1929
    
2495
1930
    global mandos_dbus_service
2496
1931
    mandos_dbus_service = None
2497
1932
    
2498
 
    socketfd = None
2499
 
    if server_settings["socket"] != "":
2500
 
        socketfd = server_settings["socket"]
2501
 
    tcp_server = MandosServer(
2502
 
        (server_settings["address"], server_settings["port"]),
2503
 
        ClientHandler,
2504
 
        interface=(server_settings["interface"] or None),
2505
 
        use_ipv6=use_ipv6,
2506
 
        gnutls_priority=server_settings["priority"],
2507
 
        use_dbus=use_dbus,
2508
 
        socketfd=socketfd)
2509
 
    if not foreground:
2510
 
        pidfilename = "/run/mandos.pid"
2511
 
        if not os.path.isdir("/run/."):
2512
 
            pidfilename = "/var/run/mandos.pid"
2513
 
        pidfile = None
 
1933
    tcp_server = MandosServer((server_settings["address"],
 
1934
                               server_settings["port"]),
 
1935
                              ClientHandler,
 
1936
                              interface=(server_settings["interface"]
 
1937
                                         or None),
 
1938
                              use_ipv6=use_ipv6,
 
1939
                              gnutls_priority=
 
1940
                              server_settings["priority"],
 
1941
                              use_dbus=use_dbus)
 
1942
    if not debug:
 
1943
        pidfilename = "/var/run/mandos.pid"
2514
1944
        try:
2515
 
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2516
 
        except IOError as e:
2517
 
            logger.error("Could not open file %r", pidfilename,
2518
 
                         exc_info=e)
 
1945
            pidfile = open(pidfilename, "w")
 
1946
        except IOError:
 
1947
            logger.error("Could not open file %r", pidfilename)
2519
1948
    
2520
 
    for name in ("_mandos", "mandos", "nobody"):
 
1949
    try:
 
1950
        uid = pwd.getpwnam("_mandos").pw_uid
 
1951
        gid = pwd.getpwnam("_mandos").pw_gid
 
1952
    except KeyError:
2521
1953
        try:
2522
 
            uid = pwd.getpwnam(name).pw_uid
2523
 
            gid = pwd.getpwnam(name).pw_gid
2524
 
            break
 
1954
            uid = pwd.getpwnam("mandos").pw_uid
 
1955
            gid = pwd.getpwnam("mandos").pw_gid
2525
1956
        except KeyError:
2526
 
            continue
2527
 
    else:
2528
 
        uid = 65534
2529
 
        gid = 65534
 
1957
            try:
 
1958
                uid = pwd.getpwnam("nobody").pw_uid
 
1959
                gid = pwd.getpwnam("nobody").pw_gid
 
1960
            except KeyError:
 
1961
                uid = 65534
 
1962
                gid = 65534
2530
1963
    try:
2531
1964
        os.setgid(gid)
2532
1965
        os.setuid(uid)
2533
1966
    except OSError as error:
2534
 
        if error.errno != errno.EPERM:
2535
 
            raise
 
1967
        if error[0] != errno.EPERM:
 
1968
            raise error
 
1969
    
 
1970
    if not debug and not debuglevel:
 
1971
        syslogger.setLevel(logging.WARNING)
 
1972
        console.setLevel(logging.WARNING)
 
1973
    if debuglevel:
 
1974
        level = getattr(logging, debuglevel.upper())
 
1975
        syslogger.setLevel(level)
 
1976
        console.setLevel(level)
2536
1977
    
2537
1978
    if debug:
2538
1979
        # Enable all possible GnuTLS debugging
2545
1986
        def debug_gnutls(level, string):
2546
1987
            logger.debug("GnuTLS: %s", string[:-1])
2547
1988
        
2548
 
        gnutls.library.functions.gnutls_global_set_log_function(
2549
 
            debug_gnutls)
 
1989
        (gnutls.library.functions
 
1990
         .gnutls_global_set_log_function(debug_gnutls))
2550
1991
        
2551
1992
        # Redirect stdin so all checkers get /dev/null
2552
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1993
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2553
1994
        os.dup2(null, sys.stdin.fileno())
2554
1995
        if null > 2:
2555
1996
            os.close(null)
 
1997
    else:
 
1998
        # No console logging
 
1999
        logger.removeHandler(console)
2556
2000
    
2557
2001
    # Need to fork before connecting to D-Bus
2558
 
    if not foreground:
 
2002
    if not debug:
2559
2003
        # Close all input and output, do double fork, etc.
2560
2004
        daemon()
2561
2005
    
2562
 
    # multiprocessing will use threads, so before we use gobject we
2563
 
    # need to inform gobject that threads will be used.
2564
 
    gobject.threads_init()
2565
 
    
2566
2006
    global main_loop
2567
2007
    # From the Avahi example code
2568
 
    DBusGMainLoop(set_as_default=True)
 
2008
    DBusGMainLoop(set_as_default=True )
2569
2009
    main_loop = gobject.MainLoop()
2570
2010
    bus = dbus.SystemBus()
2571
2011
    # End of Avahi example code
2572
2012
    if use_dbus:
2573
2013
        try:
2574
2014
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2575
 
                                            bus,
2576
 
                                            do_not_queue=True)
2577
 
            old_bus_name = dbus.service.BusName(
2578
 
                "se.bsnet.fukt.Mandos", bus,
2579
 
                do_not_queue=True)
2580
 
        except dbus.exceptions.DBusException as e:
2581
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
2015
                                            bus, do_not_queue=True)
 
2016
            old_bus_name = (dbus.service.BusName
 
2017
                            ("se.bsnet.fukt.Mandos", bus,
 
2018
                             do_not_queue=True))
 
2019
        except dbus.exceptions.NameExistsException as e:
 
2020
            logger.error(unicode(e) + ", disabling D-Bus")
2582
2021
            use_dbus = False
2583
2022
            server_settings["use_dbus"] = False
2584
2023
            tcp_server.use_dbus = False
2585
 
    if zeroconf:
2586
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2587
 
        service = AvahiServiceToSyslog(
2588
 
            name = server_settings["servicename"],
2589
 
            servicetype = "_mandos._tcp",
2590
 
            protocol = protocol,
2591
 
            bus = bus)
2592
 
        if server_settings["interface"]:
2593
 
            service.interface = if_nametoindex(
2594
 
                server_settings["interface"].encode("utf-8"))
 
2024
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2025
    service = AvahiService(name = server_settings["servicename"],
 
2026
                           servicetype = "_mandos._tcp",
 
2027
                           protocol = protocol, bus = bus)
 
2028
    if server_settings["interface"]:
 
2029
        service.interface = (if_nametoindex
 
2030
                             (str(server_settings["interface"])))
2595
2031
    
2596
2032
    global multiprocessing_manager
2597
2033
    multiprocessing_manager = multiprocessing.Manager()
2598
2034
    
2599
2035
    client_class = Client
2600
2036
    if use_dbus:
2601
 
        client_class = functools.partial(ClientDBus, bus = bus)
2602
 
    
2603
 
    client_settings = Client.config_parser(client_config)
2604
 
    old_client_settings = {}
2605
 
    clients_data = {}
2606
 
    
2607
 
    # This is used to redirect stdout and stderr for checker processes
2608
 
    global wnull
2609
 
    wnull = open(os.devnull, "w") # A writable /dev/null
2610
 
    # Only used if server is running in foreground but not in debug
2611
 
    # mode
2612
 
    if debug or not foreground:
2613
 
        wnull.close()
2614
 
    
2615
 
    # Get client data and settings from last running state.
2616
 
    if server_settings["restore"]:
2617
 
        try:
2618
 
            with open(stored_state_path, "rb") as stored_state:
2619
 
                clients_data, old_client_settings = pickle.load(
2620
 
                    stored_state)
2621
 
            os.remove(stored_state_path)
2622
 
        except IOError as e:
2623
 
            if e.errno == errno.ENOENT:
2624
 
                logger.warning("Could not load persistent state:"
2625
 
                               " {}".format(os.strerror(e.errno)))
2626
 
            else:
2627
 
                logger.critical("Could not load persistent state:",
2628
 
                                exc_info=e)
2629
 
                raise
2630
 
        except EOFError as e:
2631
 
            logger.warning("Could not load persistent state: "
2632
 
                           "EOFError:",
2633
 
                           exc_info=e)
2634
 
    
2635
 
    with PGPEngine() as pgp:
2636
 
        for client_name, client in clients_data.items():
2637
 
            # Skip removed clients
2638
 
            if client_name not in client_settings:
2639
 
                continue
2640
 
            
2641
 
            # Decide which value to use after restoring saved state.
2642
 
            # We have three different values: Old config file,
2643
 
            # new config file, and saved state.
2644
 
            # New config value takes precedence if it differs from old
2645
 
            # config value, otherwise use saved state.
2646
 
            for name, value in client_settings[client_name].items():
2647
 
                try:
2648
 
                    # For each value in new config, check if it
2649
 
                    # differs from the old config value (Except for
2650
 
                    # the "secret" attribute)
2651
 
                    if (name != "secret"
2652
 
                        and (value !=
2653
 
                             old_client_settings[client_name][name])):
2654
 
                        client[name] = value
2655
 
                except KeyError:
2656
 
                    pass
2657
 
            
2658
 
            # Clients who has passed its expire date can still be
2659
 
            # enabled if its last checker was successful.  Clients
2660
 
            # whose checker succeeded before we stored its state is
2661
 
            # assumed to have successfully run all checkers during
2662
 
            # downtime.
2663
 
            if client["enabled"]:
2664
 
                if datetime.datetime.utcnow() >= client["expires"]:
2665
 
                    if not client["last_checked_ok"]:
2666
 
                        logger.warning(
2667
 
                            "disabling client {} - Client never "
2668
 
                            "performed a successful checker".format(
2669
 
                                client_name))
2670
 
                        client["enabled"] = False
2671
 
                    elif client["last_checker_status"] != 0:
2672
 
                        logger.warning(
2673
 
                            "disabling client {} - Client last"
2674
 
                            " checker failed with error code"
2675
 
                            " {}".format(
2676
 
                                client_name,
2677
 
                                client["last_checker_status"]))
2678
 
                        client["enabled"] = False
2679
 
                    else:
2680
 
                        client["expires"] = (
2681
 
                            datetime.datetime.utcnow()
2682
 
                            + client["timeout"])
2683
 
                        logger.debug("Last checker succeeded,"
2684
 
                                     " keeping {} enabled".format(
2685
 
                                         client_name))
 
2037
        client_class = functools.partial(ClientDBusTransitional,
 
2038
                                         bus = bus)
 
2039
    def client_config_items(config, section):
 
2040
        special_settings = {
 
2041
            "approved_by_default":
 
2042
                lambda: config.getboolean(section,
 
2043
                                          "approved_by_default"),
 
2044
            }
 
2045
        for name, value in config.items(section):
2686
2046
            try:
2687
 
                client["secret"] = pgp.decrypt(
2688
 
                    client["encrypted_secret"],
2689
 
                    client_settings[client_name]["secret"])
2690
 
            except PGPError:
2691
 
                # If decryption fails, we use secret from new settings
2692
 
                logger.debug("Failed to decrypt {} old secret".format(
2693
 
                    client_name))
2694
 
                client["secret"] = (client_settings[client_name]
2695
 
                                    ["secret"])
2696
 
    
2697
 
    # Add/remove clients based on new changes made to config
2698
 
    for client_name in (set(old_client_settings)
2699
 
                        - set(client_settings)):
2700
 
        del clients_data[client_name]
2701
 
    for client_name in (set(client_settings)
2702
 
                        - set(old_client_settings)):
2703
 
        clients_data[client_name] = client_settings[client_name]
2704
 
    
2705
 
    # Create all client objects
2706
 
    for client_name, client in clients_data.items():
2707
 
        tcp_server.clients[client_name] = client_class(
2708
 
            name = client_name,
2709
 
            settings = client,
2710
 
            server_settings = server_settings)
2711
 
    
 
2047
                yield (name, special_settings[name]())
 
2048
            except KeyError:
 
2049
                yield (name, value)
 
2050
    
 
2051
    tcp_server.clients.update(set(
 
2052
            client_class(name = section,
 
2053
                         config= dict(client_config_items(
 
2054
                        client_config, section)))
 
2055
            for section in client_config.sections()))
2712
2056
    if not tcp_server.clients:
2713
2057
        logger.warning("No clients defined")
2714
 
    
2715
 
    if not foreground:
2716
 
        if pidfile is not None:
2717
 
            pid = os.getpid()
2718
 
            try:
2719
 
                with pidfile:
2720
 
                    print(pid, file=pidfile)
2721
 
            except IOError:
2722
 
                logger.error("Could not write to file %r with PID %d",
2723
 
                             pidfilename, pid)
2724
 
        del pidfile
 
2058
        
 
2059
    if not debug:
 
2060
        try:
 
2061
            with pidfile:
 
2062
                pid = os.getpid()
 
2063
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2064
            del pidfile
 
2065
        except IOError:
 
2066
            logger.error("Could not write to file %r with PID %d",
 
2067
                         pidfilename, pid)
 
2068
        except NameError:
 
2069
            # "pidfile" was never created
 
2070
            pass
2725
2071
        del pidfilename
 
2072
        
 
2073
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2726
2074
    
2727
2075
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2728
2076
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2729
2077
    
2730
2078
    if use_dbus:
2731
 
        
2732
 
        @alternate_dbus_interfaces(
2733
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2734
 
        class MandosDBusService(DBusObjectWithProperties):
 
2079
        class MandosDBusService(dbus.service.Object):
2735
2080
            """A D-Bus proxy object"""
2736
 
            
2737
2081
            def __init__(self):
2738
2082
                dbus.service.Object.__init__(self, bus, "/")
2739
 
            
2740
2083
            _interface = "se.recompile.Mandos"
2741
2084
            
2742
 
            @dbus_interface_annotations(_interface)
2743
 
            def _foo(self):
2744
 
                return {
2745
 
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
2746
 
                    "false" }
2747
 
            
2748
2085
            @dbus.service.signal(_interface, signature="o")
2749
2086
            def ClientAdded(self, objpath):
2750
2087
                "D-Bus signal"
2763
2100
            @dbus.service.method(_interface, out_signature="ao")
2764
2101
            def GetAllClients(self):
2765
2102
                "D-Bus method"
2766
 
                return dbus.Array(c.dbus_object_path for c in
2767
 
                                  tcp_server.clients.itervalues())
 
2103
                return dbus.Array(c.dbus_object_path
 
2104
                                  for c in tcp_server.clients)
2768
2105
            
2769
2106
            @dbus.service.method(_interface,
2770
2107
                                 out_signature="a{oa{sv}}")
2771
2108
            def GetAllClientsWithProperties(self):
2772
2109
                "D-Bus method"
2773
2110
                return dbus.Dictionary(
2774
 
                    { c.dbus_object_path: c.GetAll("")
2775
 
                      for c in tcp_server.clients.itervalues() },
 
2111
                    ((c.dbus_object_path, c.GetAll(""))
 
2112
                     for c in tcp_server.clients),
2776
2113
                    signature="oa{sv}")
2777
2114
            
2778
2115
            @dbus.service.method(_interface, in_signature="o")
2779
2116
            def RemoveClient(self, object_path):
2780
2117
                "D-Bus method"
2781
 
                for c in tcp_server.clients.itervalues():
 
2118
                for c in tcp_server.clients:
2782
2119
                    if c.dbus_object_path == object_path:
2783
 
                        del tcp_server.clients[c.name]
 
2120
                        tcp_server.clients.remove(c)
2784
2121
                        c.remove_from_connection()
2785
2122
                        # Don't signal anything except ClientRemoved
2786
2123
                        c.disable(quiet=True)
2791
2128
            
2792
2129
            del _interface
2793
2130
        
2794
 
        mandos_dbus_service = MandosDBusService()
 
2131
        class MandosDBusServiceTransitional(MandosDBusService):
 
2132
            __metaclass__ = AlternateDBusNamesMetaclass
 
2133
        mandos_dbus_service = MandosDBusServiceTransitional()
2795
2134
    
2796
2135
    def cleanup():
2797
2136
        "Cleanup function; run on exit"
2798
 
        if zeroconf:
2799
 
            service.cleanup()
 
2137
        service.cleanup()
2800
2138
        
2801
2139
        multiprocessing.active_children()
2802
 
        wnull.close()
2803
 
        if not (tcp_server.clients or client_settings):
2804
 
            return
2805
 
        
2806
 
        # Store client before exiting. Secrets are encrypted with key
2807
 
        # based on what config file has. If config file is
2808
 
        # removed/edited, old secret will thus be unrecovable.
2809
 
        clients = {}
2810
 
        with PGPEngine() as pgp:
2811
 
            for client in tcp_server.clients.itervalues():
2812
 
                key = client_settings[client.name]["secret"]
2813
 
                client.encrypted_secret = pgp.encrypt(client.secret,
2814
 
                                                      key)
2815
 
                client_dict = {}
2816
 
                
2817
 
                # A list of attributes that can not be pickled
2818
 
                # + secret.
2819
 
                exclude = { "bus", "changedstate", "secret",
2820
 
                            "checker", "server_settings" }
2821
 
                for name, typ in inspect.getmembers(dbus.service
2822
 
                                                    .Object):
2823
 
                    exclude.add(name)
2824
 
                
2825
 
                client_dict["encrypted_secret"] = (client
2826
 
                                                   .encrypted_secret)
2827
 
                for attr in client.client_structure:
2828
 
                    if attr not in exclude:
2829
 
                        client_dict[attr] = getattr(client, attr)
2830
 
                
2831
 
                clients[client.name] = client_dict
2832
 
                del client_settings[client.name]["secret"]
2833
 
        
2834
 
        try:
2835
 
            with tempfile.NamedTemporaryFile(
2836
 
                    mode='wb',
2837
 
                    suffix=".pickle",
2838
 
                    prefix='clients-',
2839
 
                    dir=os.path.dirname(stored_state_path),
2840
 
                    delete=False) as stored_state:
2841
 
                pickle.dump((clients, client_settings), stored_state)
2842
 
                tempname = stored_state.name
2843
 
            os.rename(tempname, stored_state_path)
2844
 
        except (IOError, OSError) as e:
2845
 
            if not debug:
2846
 
                try:
2847
 
                    os.remove(tempname)
2848
 
                except NameError:
2849
 
                    pass
2850
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2851
 
                logger.warning("Could not save persistent state: {}"
2852
 
                               .format(os.strerror(e.errno)))
2853
 
            else:
2854
 
                logger.warning("Could not save persistent state:",
2855
 
                               exc_info=e)
2856
 
                raise
2857
 
        
2858
 
        # Delete all clients, and settings from config
2859
2140
        while tcp_server.clients:
2860
 
            name, client = tcp_server.clients.popitem()
 
2141
            client = tcp_server.clients.pop()
2861
2142
            if use_dbus:
2862
2143
                client.remove_from_connection()
 
2144
            client.disable_hook = None
2863
2145
            # Don't signal anything except ClientRemoved
2864
2146
            client.disable(quiet=True)
2865
2147
            if use_dbus:
2866
2148
                # Emit D-Bus signal
2867
 
                mandos_dbus_service.ClientRemoved(
2868
 
                    client.dbus_object_path, client.name)
2869
 
        client_settings.clear()
 
2149
                mandos_dbus_service.ClientRemoved(client
 
2150
                                                  .dbus_object_path,
 
2151
                                                  client.name)
2870
2152
    
2871
2153
    atexit.register(cleanup)
2872
2154
    
2873
 
    for client in tcp_server.clients.itervalues():
 
2155
    for client in tcp_server.clients:
2874
2156
        if use_dbus:
2875
2157
            # Emit D-Bus signal
2876
2158
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2877
 
        # Need to initiate checking of clients
2878
 
        if client.enabled:
2879
 
            client.init_checker()
 
2159
        client.enable()
2880
2160
    
2881
2161
    tcp_server.enable()
2882
2162
    tcp_server.server_activate()
2883
2163
    
2884
2164
    # Find out what port we got
2885
 
    if zeroconf:
2886
 
        service.port = tcp_server.socket.getsockname()[1]
 
2165
    service.port = tcp_server.socket.getsockname()[1]
2887
2166
    if use_ipv6:
2888
2167
        logger.info("Now listening on address %r, port %d,"
2889
 
                    " flowinfo %d, scope_id %d",
2890
 
                    *tcp_server.socket.getsockname())
 
2168
                    " flowinfo %d, scope_id %d"
 
2169
                    % tcp_server.socket.getsockname())
2891
2170
    else:                       # IPv4
2892
 
        logger.info("Now listening on address %r, port %d",
2893
 
                    *tcp_server.socket.getsockname())
 
2171
        logger.info("Now listening on address %r, port %d"
 
2172
                    % tcp_server.socket.getsockname())
2894
2173
    
2895
2174
    #service.interface = tcp_server.socket.getsockname()[3]
2896
2175
    
2897
2176
    try:
2898
 
        if zeroconf:
2899
 
            # From the Avahi example code
2900
 
            try:
2901
 
                service.activate()
2902
 
            except dbus.exceptions.DBusException as error:
2903
 
                logger.critical("D-Bus Exception", exc_info=error)
2904
 
                cleanup()
2905
 
                sys.exit(1)
2906
 
            # End of Avahi example code
 
2177
        # From the Avahi example code
 
2178
        try:
 
2179
            service.activate()
 
2180
        except dbus.exceptions.DBusException as error:
 
2181
            logger.critical("DBusException: %s", error)
 
2182
            cleanup()
 
2183
            sys.exit(1)
 
2184
        # End of Avahi example code
2907
2185
        
2908
2186
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2909
2187
                             lambda *args, **kwargs:
2913
2191
        logger.debug("Starting main loop")
2914
2192
        main_loop.run()
2915
2193
    except AvahiError as error:
2916
 
        logger.critical("Avahi Error", exc_info=error)
 
2194
        logger.critical("AvahiError: %s", error)
2917
2195
        cleanup()
2918
2196
        sys.exit(1)
2919
2197
    except KeyboardInterrupt: