/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-05-06 16:54:24 UTC
  • Revision ID: teddy@recompile.se-20120506165424-6bqcnlr33ih657tj
* mandos (DBusObjectWithProperties.Introspect): Use
  itertools.chain.from_iterable(foo) instead of itertools.chain(*foo).

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