/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Björn Påhlsson
  • Date: 2011-12-31 22:44:06 UTC
  • Revision ID: belorn@recompile.se-20111231224406-b1w5a1p3639aymxe
fixed bug with bad stored config state for expires and last_checked_ok.

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