/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-10-24 19:34:13 UTC
  • Revision ID: teddy@recompile.se-20121024193413-yiorm0x5lj48fu7i
* mandos: Comment changes.
* mandos-keygen (--password): Fix bashism.  Thanks to Raphael Geissert
                              <atomo64@gmail.com> for the bug report.

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