/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-08-10 08:25:01 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150810082501-rb7w2dre1flqiqe2
Refactor D-Bus annotation class out from D-Bus properties class.

* mandos (DBusObjectWithAnnotations): New; factored out D-Bus
                                      annotations code from
                                      DBusObjectWithProperties class.
  (DBusObjectWithProperties): Inherit from DBusObjectWithAnnotations.
  (main/MandosDBusService): - '' -
  (main/MandosDBusService._foo): Removed interface annotation for
                                 "o.f.D.Property.EmitsChangedSignal";
                                 this object has no properties.

Show diffs side-by-side

added added

removed removed

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