/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-08-02 09:36:40 UTC
  • Revision ID: teddy@recompile.se-20150802093640-nc0n17rbmqlbaxuf
Add D-Bus annotations on a few properties on the Client object.

The D-Bus property "Secret" on the interface
"se.recompile.Mandos.Client" should have the annotation
"org.freedesktop.DBus.Property.EmitsChangedSignal" set to
"invalidates".  Also, the properties "Created", "Fingerprint", "Name",
and "ObjectPath" should have the same annotation set to "const".

* mandos (ClientDBus.Name_dbus_property): Set annotation
                    "org.freedesktop.DBus.Property.EmitsChangedSignal"
                    to "const".
  (ClientDBus.Fingerprint_dbus_property): - '' -
  (ClientDBus.Created_dbus_property): - '' -
  (ClientDBus.ObjectPath_dbus_property): - '' -
  (ClientDBus.Secret_dbus_property): Set annotation
                    "org.freedesktop.DBus.Property.EmitsChangedSignal"
                    to "invalidates".

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