/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2012-01-15 20:27:28 UTC
  • Revision ID: teddy@recompile.se-20120115202728-185929ww2r84s8xg
* DBUS-API (se.recompile.Mandos.Client.LastCheckerStatus): New
                                                           property.
* mandos (Client.last_checker_status): Use -2 instead of None to match
                                       D-Bus property.  All users
                                       changed.
  (Client.checked_ok): Remove "timeout" argument and call
                       "self.bump_timeout()" instead.
  (Client.bump_timeout): New; separated out from "checked_ok".
  (ClientDBus.last_checker_status): Hook to a D-Bus property.
  (ClientDBus.LastCheckerStatus_dbus_property): New D-Bus property.
  (ClientHandler.handle): Call client.bump_timeout() instead of
                          client.checked_ok().

Show diffs side-by-side

added added

removed removed

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