/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-08-10 09:00:23 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150810090023-fz6vjqr7zf33e2tf
Support the standard org.freedesktop.DBus.ObjectManager interface.

Now that the D-Bus standard has an interface to keep track of new and
removed objects, use that instead of our own methods.  This deprecates
our D-Bus methods "GetAllClients" and "GetAllClientsWithProperties"
and the signals "ClientAdded" and "ClientRemoved", all on the server
interface "se.recompile.Mandos".

* DBUS-API: Removed references to deprecated methods and signals;
  insert reference to the org.freedesktop.DBus.ObjectManager
  interface.
* mandos (DBusObjectWithProperties._get_all_interface_names): New.
  (dbus.OBJECT_MANAGER_IFACE): If not present, monkey patch.
  (DBusObjectWithObjectManager): New.
  (main/MandosDBusService): Inherit from DBusObjectWithObjectManager.
  (main/MandosDBusService.ClientRemoved): Annotate as deprecated.
  (main/MandosDBusService.GetAllClients): - '' -
  (main/MandosDBusService.GetAllClientsWithProperties): Annotate as
                                                        deprecated.
                                                        Also only
                                                        return
                                                        properties on
                                                        client
                                                        interface.
  (main/MandosDBusService.RemoveClient): Call client_removed_signal
                                         instead of ClientRemoved.
  (main/MandosDBusService.GetManagedObjects): New.
  (main/MandosDBusService.client_added_signal): New.
  (main/MandosDBusService.client_removed_signal): - '' -
  (main/cleanup): Call "client_removed_signal" instead of sending
                  "ClientRemoved" signal directly.
  (main): Call "client_added_signal" instead of sending "ClientAdded"
          signal directly.
* mandos-ctl: Use GetManagedObjects instead of
              GetAllClientsWithProperties.  Also, show better error
              message in case of failure to connect to the D-Bus

* mandos-monitor (MandosClientPropertyCache.properties_changed):
  Bug fix; only update properties on client interface.
  (UserInterface.find_and_remove_client): Change to accept arguments
                                          from InterfacesRemoved
                                          signal.  Also, bug fix:
                                          working error message when
                                          removing unknown client.
  (UserInterface.add_new_client): Change to accept arguments from
                                  InterfacesRemoved signal.  Pass
                                  properties to MandosClientWidget
                                  constructor.
  (UserInterface.run): Connect find_and_remove_client method to
                       InterfacesRemoved signal and the add_new_client
                       method to the InterfacesAdded signal.

Show diffs side-by-side

added added

removed removed

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