/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-07-20 03:03:33 UTC
  • Revision ID: teddy@recompile.se-20150720030333-203m2aeblypcsfte
Bug fix for GnuTLS 3: be compatible with old 2048-bit DSA keys.

The mandos-keygen program in Mandos version 1.6.0 and older generated
2048-bit DSA keys, and when GnuTLS uses these it has trouble
connecting using the Mandos default priority string.  This was
previously fixed in Mandos 1.6.2, but the bug reappeared when using
GnuTLS 3, so the default priority string has to change again; this
time also the Mandos client has to change its default, so now the
server and the client should use the same default priority string:

SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA:+SIGN-DSA-SHA256

* mandos (main/server_defaults): Changed default priority string.
* mandos-options.xml (/section/para[id="priority_compat"]): Removed.
  (/section/para[id="priority"]): Changed default priority string.
* mandos.conf ([DEFAULT]/priority): - '' -
* mandos.conf.xml (OPTIONS/priority): Refer to the id "priority"
                                      instead of "priority_compat".
* mandos.xml (OPTIONS/--priority): - '' -
* plugins.d/mandos-client.c (main): Changed default priority string.

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
 
            self.checker_callback_tag = (gobject.child_watch_add
721
 
                                         (self.checker.pid,
722
 
                                          self.checker_callback,
723
 
                                          data=command))
724
 
            # The checker may have completed before the gobject
725
 
            # watch was added.  Check for this.
726
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
727
 
            if pid:
728
 
                gobject.source_remove(self.checker_callback_tag)
729
 
                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)
730
764
        # Re-run this periodically if run by gobject.timeout_add
731
765
        return True
732
766
    
738
772
        if getattr(self, "checker", None) is None:
739
773
            return
740
774
        logger.debug("Stopping checker for %(name)s", vars(self))
741
 
        try:
742
 
            self.checker.terminate()
743
 
            #time.sleep(0.5)
744
 
            #if self.checker.poll() is None:
745
 
            #    self.checker.kill()
746
 
        except OSError as error:
747
 
            if error.errno != errno.ESRCH: # No such process
748
 
                raise
 
775
        self.checker.terminate()
749
776
        self.checker = None
750
777
 
751
778
 
752
 
def dbus_service_property(dbus_interface, signature="v",
753
 
                          access="readwrite", byte_arrays=False):
 
779
def dbus_service_property(dbus_interface,
 
780
                          signature="v",
 
781
                          access="readwrite",
 
782
                          byte_arrays=False):
754
783
    """Decorators for marking methods of a DBusObjectWithProperties to
755
784
    become properties on the D-Bus.
756
785
    
765
794
    # "Set" method, so we fail early here:
766
795
    if byte_arrays and signature != "ay":
767
796
        raise ValueError("Byte arrays not supported for non-'ay'"
768
 
                         " signature {0!r}".format(signature))
 
797
                         " signature {!r}".format(signature))
 
798
    
769
799
    def decorator(func):
770
800
        func._dbus_is_property = True
771
801
        func._dbus_interface = dbus_interface
776
806
            func._dbus_name = func._dbus_name[:-14]
777
807
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
778
808
        return func
 
809
    
779
810
    return decorator
780
811
 
781
812
 
790
821
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
791
822
                    "false"}
792
823
    """
 
824
    
793
825
    def decorator(func):
794
826
        func._dbus_is_interface = True
795
827
        func._dbus_interface = dbus_interface
796
828
        func._dbus_name = dbus_interface
797
829
        return func
 
830
    
798
831
    return decorator
799
832
 
800
833
 
802
835
    """Decorator to annotate D-Bus methods, signals or properties
803
836
    Usage:
804
837
    
 
838
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
839
                       "org.freedesktop.DBus.Property."
 
840
                       "EmitsChangedSignal": "false"})
805
841
    @dbus_service_property("org.example.Interface", signature="b",
806
842
                           access="r")
807
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
808
 
                        "org.freedesktop.DBus.Property."
809
 
                        "EmitsChangedSignal": "false"})
810
843
    def Property_dbus_property(self):
811
844
        return dbus.Boolean(False)
812
845
    """
 
846
    
813
847
    def decorator(func):
814
848
        func._dbus_annotations = annotations
815
849
        return func
 
850
    
816
851
    return decorator
817
852
 
818
853
 
819
854
class DBusPropertyException(dbus.exceptions.DBusException):
820
855
    """A base class for D-Bus property-related exceptions
821
856
    """
822
 
    def __unicode__(self):
823
 
        return unicode(str(self))
 
857
    pass
824
858
 
825
859
 
826
860
class DBusPropertyAccessException(DBusPropertyException):
850
884
        If called like _is_dbus_thing("method") it returns a function
851
885
        suitable for use as predicate to inspect.getmembers().
852
886
        """
853
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
887
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
854
888
                                   False)
855
889
    
856
890
    def _get_all_dbus_things(self, thing):
857
891
        """Returns a generator of (name, attribute) pairs
858
892
        """
859
 
        return ((getattr(athing.__get__(self), "_dbus_name",
860
 
                         name),
 
893
        return ((getattr(athing.__get__(self), "_dbus_name", name),
861
894
                 athing.__get__(self))
862
895
                for cls in self.__class__.__mro__
863
896
                for name, athing in
864
 
                inspect.getmembers(cls,
865
 
                                   self._is_dbus_thing(thing)))
 
897
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
866
898
    
867
899
    def _get_dbus_property(self, interface_name, property_name):
868
900
        """Returns a bound method if one exists which is a D-Bus
869
901
        property with the specified name and interface.
870
902
        """
871
 
        for cls in  self.__class__.__mro__:
872
 
            for name, value in (inspect.getmembers
873
 
                                (cls,
874
 
                                 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")):
875
906
                if (value._dbus_name == property_name
876
907
                    and value._dbus_interface == interface_name):
877
908
                    return value.__get__(self)
878
909
        
879
910
        # No such property
880
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
881
 
                                   + interface_name + "."
882
 
                                   + property_name)
 
911
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
912
            self.dbus_object_path, interface_name, property_name))
883
913
    
884
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
914
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
915
                         in_signature="ss",
885
916
                         out_signature="v")
886
917
    def Get(self, interface_name, property_name):
887
918
        """Standard D-Bus property Get() method, see D-Bus standard.
905
936
            # The byte_arrays option is not supported yet on
906
937
            # signatures other than "ay".
907
938
            if prop._dbus_signature != "ay":
908
 
                raise ValueError
 
939
                raise ValueError("Byte arrays not supported for non-"
 
940
                                 "'ay' signature {!r}"
 
941
                                 .format(prop._dbus_signature))
909
942
            value = dbus.ByteArray(b''.join(chr(byte)
910
943
                                            for byte in value))
911
944
        prop(value)
912
945
    
913
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
946
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
947
                         in_signature="s",
914
948
                         out_signature="a{sv}")
915
949
    def GetAll(self, interface_name):
916
950
        """Standard D-Bus property GetAll() method, see D-Bus
931
965
            if not hasattr(value, "variant_level"):
932
966
                properties[name] = value
933
967
                continue
934
 
            properties[name] = type(value)(value, variant_level=
935
 
                                           value.variant_level+1)
 
968
            properties[name] = type(value)(
 
969
                value, variant_level = value.variant_level + 1)
936
970
        return dbus.Dictionary(properties, signature="sv")
937
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
    
938
980
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
939
981
                         out_signature="s",
940
982
                         path_keyword='object_path',
948
990
                                                   connection)
949
991
        try:
950
992
            document = xml.dom.minidom.parseString(xmlstring)
 
993
            
951
994
            def make_tag(document, name, prop):
952
995
                e = document.createElement("property")
953
996
                e.setAttribute("name", name)
954
997
                e.setAttribute("type", prop._dbus_signature)
955
998
                e.setAttribute("access", prop._dbus_access)
956
999
                return e
 
1000
            
957
1001
            for if_tag in document.getElementsByTagName("interface"):
958
1002
                # Add property tags
959
1003
                for tag in (make_tag(document, name, prop)
971
1015
                            if (name == tag.getAttribute("name")
972
1016
                                and prop._dbus_interface
973
1017
                                == if_tag.getAttribute("name")):
974
 
                                annots.update(getattr
975
 
                                              (prop,
976
 
                                               "_dbus_annotations",
977
 
                                               {}))
978
 
                        for name, value in annots.iteritems():
 
1018
                                annots.update(getattr(
 
1019
                                    prop, "_dbus_annotations", {}))
 
1020
                        for name, value in annots.items():
979
1021
                            ann_tag = document.createElement(
980
1022
                                "annotation")
981
1023
                            ann_tag.setAttribute("name", name)
984
1026
                # Add interface annotation tags
985
1027
                for annotation, value in dict(
986
1028
                    itertools.chain.from_iterable(
987
 
                        annotations().iteritems()
988
 
                        for name, annotations in
989
 
                        self._get_all_dbus_things("interface")
 
1029
                        annotations().items()
 
1030
                        for name, annotations
 
1031
                        in self._get_all_dbus_things("interface")
990
1032
                        if name == if_tag.getAttribute("name")
991
 
                        )).iteritems():
 
1033
                        )).items():
992
1034
                    ann_tag = document.createElement("annotation")
993
1035
                    ann_tag.setAttribute("name", annotation)
994
1036
                    ann_tag.setAttribute("value", value)
1021
1063
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1022
1064
    if dt is None:
1023
1065
        return dbus.String("", variant_level = variant_level)
1024
 
    return dbus.String(dt.isoformat(),
1025
 
                       variant_level=variant_level)
 
1066
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1026
1067
 
1027
1068
 
1028
1069
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1048
1089
    (from DBusObjectWithProperties) and interfaces (from the
1049
1090
    dbus_interface_annotations decorator).
1050
1091
    """
 
1092
    
1051
1093
    def wrapper(cls):
1052
1094
        for orig_interface_name, alt_interface_name in (
1053
 
            alt_interface_names.iteritems()):
 
1095
                alt_interface_names.items()):
1054
1096
            attr = {}
1055
1097
            interface_names = set()
1056
1098
            # Go though all attributes of the class
1058
1100
                # Ignore non-D-Bus attributes, and D-Bus attributes
1059
1101
                # with the wrong interface name
1060
1102
                if (not hasattr(attribute, "_dbus_interface")
1061
 
                    or not attribute._dbus_interface
1062
 
                    .startswith(orig_interface_name)):
 
1103
                    or not attribute._dbus_interface.startswith(
 
1104
                        orig_interface_name)):
1063
1105
                    continue
1064
1106
                # Create an alternate D-Bus interface name based on
1065
1107
                # the current name
1066
 
                alt_interface = (attribute._dbus_interface
1067
 
                                 .replace(orig_interface_name,
1068
 
                                          alt_interface_name))
 
1108
                alt_interface = attribute._dbus_interface.replace(
 
1109
                    orig_interface_name, alt_interface_name)
1069
1110
                interface_names.add(alt_interface)
1070
1111
                # Is this a D-Bus signal?
1071
1112
                if getattr(attribute, "_dbus_is_signal", False):
1072
 
                    # Extract the original non-method function by
1073
 
                    # black magic
1074
 
                    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(
1075
1117
                            zip(attribute.func_code.co_freevars,
1076
 
                                attribute.__closure__))["func"]
1077
 
                                      .cell_contents)
 
1118
                                attribute.__closure__))
 
1119
                                          ["func"].cell_contents)
 
1120
                    else:
 
1121
                        nonmethod_func = attribute
1078
1122
                    # Create a new, but exactly alike, function
1079
1123
                    # object, and decorate it to be a new D-Bus signal
1080
1124
                    # with the alternate D-Bus interface name
1081
 
                    new_function = (dbus.service.signal
1082
 
                                    (alt_interface,
1083
 
                                     attribute._dbus_signature)
1084
 
                                    (types.FunctionType(
1085
 
                                nonmethod_func.func_code,
1086
 
                                nonmethod_func.func_globals,
1087
 
                                nonmethod_func.func_name,
1088
 
                                nonmethod_func.func_defaults,
1089
 
                                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))
1090
1142
                    # Copy annotations, if any
1091
1143
                    try:
1092
 
                        new_function._dbus_annotations = (
1093
 
                            dict(attribute._dbus_annotations))
 
1144
                        new_function._dbus_annotations = dict(
 
1145
                            attribute._dbus_annotations)
1094
1146
                    except AttributeError:
1095
1147
                        pass
1096
1148
                    # Define a creator of a function to call both the
1101
1153
                        """This function is a scope container to pass
1102
1154
                        func1 and func2 to the "call_both" function
1103
1155
                        outside of its arguments"""
 
1156
                        
1104
1157
                        def call_both(*args, **kwargs):
1105
1158
                            """This function will emit two D-Bus
1106
1159
                            signals by calling func1 and func2"""
1107
1160
                            func1(*args, **kwargs)
1108
1161
                            func2(*args, **kwargs)
 
1162
                        
1109
1163
                        return call_both
1110
1164
                    # Create the "call_both" function and add it to
1111
1165
                    # the class
1116
1170
                    # object.  Decorate it to be a new D-Bus method
1117
1171
                    # with the alternate D-Bus interface name.  Add it
1118
1172
                    # to the class.
1119
 
                    attr[attrname] = (dbus.service.method
1120
 
                                      (alt_interface,
1121
 
                                       attribute._dbus_in_signature,
1122
 
                                       attribute._dbus_out_signature)
1123
 
                                      (types.FunctionType
1124
 
                                       (attribute.func_code,
1125
 
                                        attribute.func_globals,
1126
 
                                        attribute.func_name,
1127
 
                                        attribute.func_defaults,
1128
 
                                        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)))
1129
1183
                    # Copy annotations, if any
1130
1184
                    try:
1131
 
                        attr[attrname]._dbus_annotations = (
1132
 
                            dict(attribute._dbus_annotations))
 
1185
                        attr[attrname]._dbus_annotations = dict(
 
1186
                            attribute._dbus_annotations)
1133
1187
                    except AttributeError:
1134
1188
                        pass
1135
1189
                # Is this a D-Bus property?
1138
1192
                    # object, and decorate it to be a new D-Bus
1139
1193
                    # property with the alternate D-Bus interface
1140
1194
                    # name.  Add it to the class.
1141
 
                    attr[attrname] = (dbus_service_property
1142
 
                                      (alt_interface,
1143
 
                                       attribute._dbus_signature,
1144
 
                                       attribute._dbus_access,
1145
 
                                       attribute
1146
 
                                       ._dbus_get_args_options
1147
 
                                       ["byte_arrays"])
1148
 
                                      (types.FunctionType
1149
 
                                       (attribute.func_code,
1150
 
                                        attribute.func_globals,
1151
 
                                        attribute.func_name,
1152
 
                                        attribute.func_defaults,
1153
 
                                        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)))
1154
1206
                    # Copy annotations, if any
1155
1207
                    try:
1156
 
                        attr[attrname]._dbus_annotations = (
1157
 
                            dict(attribute._dbus_annotations))
 
1208
                        attr[attrname]._dbus_annotations = dict(
 
1209
                            attribute._dbus_annotations)
1158
1210
                    except AttributeError:
1159
1211
                        pass
1160
1212
                # Is this a D-Bus interface?
1163
1215
                    # object.  Decorate it to be a new D-Bus interface
1164
1216
                    # with the alternate D-Bus interface name.  Add it
1165
1217
                    # to the class.
1166
 
                    attr[attrname] = (dbus_interface_annotations
1167
 
                                      (alt_interface)
1168
 
                                      (types.FunctionType
1169
 
                                       (attribute.func_code,
1170
 
                                        attribute.func_globals,
1171
 
                                        attribute.func_name,
1172
 
                                        attribute.func_defaults,
1173
 
                                        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)))
1174
1225
            if deprecate:
1175
1226
                # Deprecate all alternate interfaces
1176
 
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1227
                iname="_AlternateDBusNames_interface_annotation{}"
1177
1228
                for interface_name in interface_names:
 
1229
                    
1178
1230
                    @dbus_interface_annotations(interface_name)
1179
1231
                    def func(self):
1180
1232
                        return { "org.freedesktop.DBus.Deprecated":
1181
 
                                     "true" }
 
1233
                                 "true" }
1182
1234
                    # Find an unused name
1183
1235
                    for aname in (iname.format(i)
1184
1236
                                  for i in itertools.count()):
1188
1240
            if interface_names:
1189
1241
                # Replace the class with a new subclass of it with
1190
1242
                # methods, signals, etc. as created above.
1191
 
                cls = type(b"{0}Alternate".format(cls.__name__),
1192
 
                           (cls,), attr)
 
1243
                cls = type(b"{}Alternate".format(cls.__name__),
 
1244
                           (cls, ), attr)
1193
1245
        return cls
 
1246
    
1194
1247
    return wrapper
1195
1248
 
1196
1249
 
1197
1250
@alternate_dbus_interfaces({"se.recompile.Mandos":
1198
 
                                "se.bsnet.fukt.Mandos"})
 
1251
                            "se.bsnet.fukt.Mandos"})
1199
1252
class ClientDBus(Client, DBusObjectWithProperties):
1200
1253
    """A Client class using D-Bus
1201
1254
    
1205
1258
    """
1206
1259
    
1207
1260
    runtime_expansions = (Client.runtime_expansions
1208
 
                          + ("dbus_object_path",))
 
1261
                          + ("dbus_object_path", ))
 
1262
    
 
1263
    _interface = "se.recompile.Mandos.Client"
1209
1264
    
1210
1265
    # dbus.service.Object doesn't use super(), so we can't either.
1211
1266
    
1214
1269
        Client.__init__(self, *args, **kwargs)
1215
1270
        # Only now, when this client is initialized, can it show up on
1216
1271
        # the D-Bus
1217
 
        client_object_name = unicode(self.name).translate(
 
1272
        client_object_name = str(self.name).translate(
1218
1273
            {ord("."): ord("_"),
1219
1274
             ord("-"): ord("_")})
1220
 
        self.dbus_object_path = (dbus.ObjectPath
1221
 
                                 ("/clients/" + client_object_name))
 
1275
        self.dbus_object_path = dbus.ObjectPath(
 
1276
            "/clients/" + client_object_name)
1222
1277
        DBusObjectWithProperties.__init__(self, self.bus,
1223
1278
                                          self.dbus_object_path)
1224
1279
    
1225
 
    def notifychangeproperty(transform_func,
1226
 
                             dbus_name, type_func=lambda x: x,
1227
 
                             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):
1228
1285
        """ Modify a variable so that it's a property which announces
1229
1286
        its changes to DBus.
1230
1287
        
1235
1292
                   to the D-Bus.  Default: no transform
1236
1293
        variant_level: D-Bus variant level.  Default: 1
1237
1294
        """
1238
 
        attrname = "_{0}".format(dbus_name)
 
1295
        attrname = "_{}".format(dbus_name)
 
1296
        
1239
1297
        def setter(self, value):
1240
1298
            if hasattr(self, "dbus_object_path"):
1241
1299
                if (not hasattr(self, attrname) or
1242
1300
                    type_func(getattr(self, attrname, None))
1243
1301
                    != type_func(value)):
1244
 
                    dbus_value = transform_func(type_func(value),
1245
 
                                                variant_level
1246
 
                                                =variant_level)
1247
 
                    self.PropertyChanged(dbus.String(dbus_name),
1248
 
                                         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())
1249
1317
            setattr(self, attrname, value)
1250
1318
        
1251
1319
        return property(lambda self: getattr(self, attrname), setter)
1257
1325
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1258
1326
    last_enabled = notifychangeproperty(datetime_to_dbus,
1259
1327
                                        "LastEnabled")
1260
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1261
 
                                   type_func = lambda checker:
1262
 
                                       checker is not None)
 
1328
    checker = notifychangeproperty(
 
1329
        dbus.Boolean, "CheckerRunning",
 
1330
        type_func = lambda checker: checker is not None)
1263
1331
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1264
1332
                                           "LastCheckedOK")
1265
1333
    last_checker_status = notifychangeproperty(dbus.Int16,
1268
1336
        datetime_to_dbus, "LastApprovalRequest")
1269
1337
    approved_by_default = notifychangeproperty(dbus.Boolean,
1270
1338
                                               "ApprovedByDefault")
1271
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1272
 
                                          "ApprovalDelay",
1273
 
                                          type_func =
1274
 
                                          timedelta_to_milliseconds)
 
1339
    approval_delay = notifychangeproperty(
 
1340
        dbus.UInt64, "ApprovalDelay",
 
1341
        type_func = lambda td: td.total_seconds() * 1000)
1275
1342
    approval_duration = notifychangeproperty(
1276
1343
        dbus.UInt64, "ApprovalDuration",
1277
 
        type_func = timedelta_to_milliseconds)
 
1344
        type_func = lambda td: td.total_seconds() * 1000)
1278
1345
    host = notifychangeproperty(dbus.String, "Host")
1279
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1280
 
                                   type_func =
1281
 
                                   timedelta_to_milliseconds)
 
1346
    timeout = notifychangeproperty(
 
1347
        dbus.UInt64, "Timeout",
 
1348
        type_func = lambda td: td.total_seconds() * 1000)
1282
1349
    extended_timeout = notifychangeproperty(
1283
1350
        dbus.UInt64, "ExtendedTimeout",
1284
 
        type_func = timedelta_to_milliseconds)
1285
 
    interval = notifychangeproperty(dbus.UInt64,
1286
 
                                    "Interval",
1287
 
                                    type_func =
1288
 
                                    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)
1289
1355
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1356
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1357
                                  invalidate_only=True)
1290
1358
    
1291
1359
    del notifychangeproperty
1292
1360
    
1299
1367
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1300
1368
        Client.__del__(self, *args, **kwargs)
1301
1369
    
1302
 
    def checker_callback(self, pid, condition, command,
1303
 
                         *args, **kwargs):
1304
 
        self.checker_callback_tag = None
1305
 
        self.checker = None
1306
 
        if os.WIFEXITED(condition):
1307
 
            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:
1308
1377
            # Emit D-Bus signal
1309
1378
            self.CheckerCompleted(dbus.Int16(exitstatus),
1310
 
                                  dbus.Int64(condition),
 
1379
                                  dbus.Int64(0),
1311
1380
                                  dbus.String(command))
1312
1381
        else:
1313
1382
            # Emit D-Bus signal
1314
1383
            self.CheckerCompleted(dbus.Int16(-1),
1315
 
                                  dbus.Int64(condition),
 
1384
                                  dbus.Int64(
 
1385
                                      self.last_checker_signal),
1316
1386
                                  dbus.String(command))
1317
 
        
1318
 
        return Client.checker_callback(self, pid, condition, command,
1319
 
                                       *args, **kwargs)
 
1387
        return ret
1320
1388
    
1321
1389
    def start_checker(self, *args, **kwargs):
1322
 
        old_checker = self.checker
1323
 
        if self.checker is not None:
1324
 
            old_checker_pid = self.checker.pid
1325
 
        else:
1326
 
            old_checker_pid = None
 
1390
        old_checker_pid = getattr(self.checker, "pid", None)
1327
1391
        r = Client.start_checker(self, *args, **kwargs)
1328
1392
        # Only if new checker process was started
1329
1393
        if (self.checker is not None
1338
1402
    
1339
1403
    def approve(self, value=True):
1340
1404
        self.approved = value
1341
 
        gobject.timeout_add(timedelta_to_milliseconds
1342
 
                            (self.approval_duration),
1343
 
                            self._reset_approved)
 
1405
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1406
                                * 1000), self._reset_approved)
1344
1407
        self.send_changedstate()
1345
1408
    
1346
1409
    ## D-Bus methods, signals & properties
1347
 
    _interface = "se.recompile.Mandos.Client"
1348
1410
    
1349
1411
    ## Interfaces
1350
1412
    
1351
 
    @dbus_interface_annotations(_interface)
1352
 
    def _foo(self):
1353
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1354
 
                     "false"}
1355
 
    
1356
1413
    ## Signals
1357
1414
    
1358
1415
    # CheckerCompleted - signal
1368
1425
        pass
1369
1426
    
1370
1427
    # PropertyChanged - signal
 
1428
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1371
1429
    @dbus.service.signal(_interface, signature="sv")
1372
1430
    def PropertyChanged(self, property, value):
1373
1431
        "D-Bus signal"
1437
1495
        return dbus.Boolean(bool(self.approvals_pending))
1438
1496
    
1439
1497
    # ApprovedByDefault - property
1440
 
    @dbus_service_property(_interface, signature="b",
 
1498
    @dbus_service_property(_interface,
 
1499
                           signature="b",
1441
1500
                           access="readwrite")
1442
1501
    def ApprovedByDefault_dbus_property(self, value=None):
1443
1502
        if value is None:       # get
1445
1504
        self.approved_by_default = bool(value)
1446
1505
    
1447
1506
    # ApprovalDelay - property
1448
 
    @dbus_service_property(_interface, signature="t",
 
1507
    @dbus_service_property(_interface,
 
1508
                           signature="t",
1449
1509
                           access="readwrite")
1450
1510
    def ApprovalDelay_dbus_property(self, value=None):
1451
1511
        if value is None:       # get
1452
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1512
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1513
                               * 1000)
1453
1514
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1454
1515
    
1455
1516
    # ApprovalDuration - property
1456
 
    @dbus_service_property(_interface, signature="t",
 
1517
    @dbus_service_property(_interface,
 
1518
                           signature="t",
1457
1519
                           access="readwrite")
1458
1520
    def ApprovalDuration_dbus_property(self, value=None):
1459
1521
        if value is None:       # get
1460
 
            return dbus.UInt64(timedelta_to_milliseconds(
1461
 
                    self.approval_duration))
 
1522
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1523
                               * 1000)
1462
1524
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1463
1525
    
1464
1526
    # Name - property
1472
1534
        return dbus.String(self.fingerprint)
1473
1535
    
1474
1536
    # Host - property
1475
 
    @dbus_service_property(_interface, signature="s",
 
1537
    @dbus_service_property(_interface,
 
1538
                           signature="s",
1476
1539
                           access="readwrite")
1477
1540
    def Host_dbus_property(self, value=None):
1478
1541
        if value is None:       # get
1479
1542
            return dbus.String(self.host)
1480
 
        self.host = unicode(value)
 
1543
        self.host = str(value)
1481
1544
    
1482
1545
    # Created - property
1483
1546
    @dbus_service_property(_interface, signature="s", access="read")
1490
1553
        return datetime_to_dbus(self.last_enabled)
1491
1554
    
1492
1555
    # Enabled - property
1493
 
    @dbus_service_property(_interface, signature="b",
 
1556
    @dbus_service_property(_interface,
 
1557
                           signature="b",
1494
1558
                           access="readwrite")
1495
1559
    def Enabled_dbus_property(self, value=None):
1496
1560
        if value is None:       # get
1501
1565
            self.disable()
1502
1566
    
1503
1567
    # LastCheckedOK - property
1504
 
    @dbus_service_property(_interface, signature="s",
 
1568
    @dbus_service_property(_interface,
 
1569
                           signature="s",
1505
1570
                           access="readwrite")
1506
1571
    def LastCheckedOK_dbus_property(self, value=None):
1507
1572
        if value is not None:
1510
1575
        return datetime_to_dbus(self.last_checked_ok)
1511
1576
    
1512
1577
    # LastCheckerStatus - property
1513
 
    @dbus_service_property(_interface, signature="n",
1514
 
                           access="read")
 
1578
    @dbus_service_property(_interface, signature="n", access="read")
1515
1579
    def LastCheckerStatus_dbus_property(self):
1516
1580
        return dbus.Int16(self.last_checker_status)
1517
1581
    
1526
1590
        return datetime_to_dbus(self.last_approval_request)
1527
1591
    
1528
1592
    # Timeout - property
1529
 
    @dbus_service_property(_interface, signature="t",
 
1593
    @dbus_service_property(_interface,
 
1594
                           signature="t",
1530
1595
                           access="readwrite")
1531
1596
    def Timeout_dbus_property(self, value=None):
1532
1597
        if value is None:       # get
1533
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1598
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1534
1599
        old_timeout = self.timeout
1535
1600
        self.timeout = datetime.timedelta(0, 0, 0, value)
1536
1601
        # Reschedule disabling
1545
1610
                    is None):
1546
1611
                    return
1547
1612
                gobject.source_remove(self.disable_initiator_tag)
1548
 
                self.disable_initiator_tag = (
1549
 
                    gobject.timeout_add(
1550
 
                        timedelta_to_milliseconds(self.expires - now),
1551
 
                        self.disable))
 
1613
                self.disable_initiator_tag = gobject.timeout_add(
 
1614
                    int((self.expires - now).total_seconds() * 1000),
 
1615
                    self.disable)
1552
1616
    
1553
1617
    # ExtendedTimeout - property
1554
 
    @dbus_service_property(_interface, signature="t",
 
1618
    @dbus_service_property(_interface,
 
1619
                           signature="t",
1555
1620
                           access="readwrite")
1556
1621
    def ExtendedTimeout_dbus_property(self, value=None):
1557
1622
        if value is None:       # get
1558
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1623
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1624
                               * 1000)
1559
1625
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1560
1626
    
1561
1627
    # Interval - property
1562
 
    @dbus_service_property(_interface, signature="t",
 
1628
    @dbus_service_property(_interface,
 
1629
                           signature="t",
1563
1630
                           access="readwrite")
1564
1631
    def Interval_dbus_property(self, value=None):
1565
1632
        if value is None:       # get
1566
 
            return dbus.UInt64(self.interval_milliseconds())
 
1633
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1567
1634
        self.interval = datetime.timedelta(0, 0, 0, value)
1568
1635
        if getattr(self, "checker_initiator_tag", None) is None:
1569
1636
            return
1570
1637
        if self.enabled:
1571
1638
            # Reschedule checker run
1572
1639
            gobject.source_remove(self.checker_initiator_tag)
1573
 
            self.checker_initiator_tag = (gobject.timeout_add
1574
 
                                          (value, self.start_checker))
1575
 
            self.start_checker()    # Start one now, too
 
1640
            self.checker_initiator_tag = gobject.timeout_add(
 
1641
                value, self.start_checker)
 
1642
            self.start_checker() # Start one now, too
1576
1643
    
1577
1644
    # Checker - property
1578
 
    @dbus_service_property(_interface, signature="s",
 
1645
    @dbus_service_property(_interface,
 
1646
                           signature="s",
1579
1647
                           access="readwrite")
1580
1648
    def Checker_dbus_property(self, value=None):
1581
1649
        if value is None:       # get
1582
1650
            return dbus.String(self.checker_command)
1583
 
        self.checker_command = unicode(value)
 
1651
        self.checker_command = str(value)
1584
1652
    
1585
1653
    # CheckerRunning - property
1586
 
    @dbus_service_property(_interface, signature="b",
 
1654
    @dbus_service_property(_interface,
 
1655
                           signature="b",
1587
1656
                           access="readwrite")
1588
1657
    def CheckerRunning_dbus_property(self, value=None):
1589
1658
        if value is None:       # get
1599
1668
        return self.dbus_object_path # is already a dbus.ObjectPath
1600
1669
    
1601
1670
    # Secret = property
1602
 
    @dbus_service_property(_interface, signature="ay",
1603
 
                           access="write", byte_arrays=True)
 
1671
    @dbus_service_property(_interface,
 
1672
                           signature="ay",
 
1673
                           access="write",
 
1674
                           byte_arrays=True)
1604
1675
    def Secret_dbus_property(self, value):
1605
 
        self.secret = str(value)
 
1676
        self.secret = bytes(value)
1606
1677
    
1607
1678
    del _interface
1608
1679
 
1612
1683
        self._pipe = child_pipe
1613
1684
        self._pipe.send(('init', fpr, address))
1614
1685
        if not self._pipe.recv():
1615
 
            raise KeyError()
 
1686
            raise KeyError(fpr)
1616
1687
    
1617
1688
    def __getattribute__(self, name):
1618
1689
        if name == '_pipe':
1622
1693
        if data[0] == 'data':
1623
1694
            return data[1]
1624
1695
        if data[0] == 'function':
 
1696
            
1625
1697
            def func(*args, **kwargs):
1626
1698
                self._pipe.send(('funcall', name, args, kwargs))
1627
1699
                return self._pipe.recv()[1]
 
1700
            
1628
1701
            return func
1629
1702
    
1630
1703
    def __setattr__(self, name, value):
1642
1715
    def handle(self):
1643
1716
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1644
1717
            logger.info("TCP connection from: %s",
1645
 
                        unicode(self.client_address))
 
1718
                        str(self.client_address))
1646
1719
            logger.debug("Pipe FD: %d",
1647
1720
                         self.server.child_pipe.fileno())
1648
1721
            
1649
 
            session = (gnutls.connection
1650
 
                       .ClientSession(self.request,
1651
 
                                      gnutls.connection
1652
 
                                      .X509Credentials()))
 
1722
            session = gnutls.connection.ClientSession(
 
1723
                self.request, gnutls.connection .X509Credentials())
1653
1724
            
1654
1725
            # Note: gnutls.connection.X509Credentials is really a
1655
1726
            # generic GnuTLS certificate credentials object so long as
1664
1735
            priority = self.server.gnutls_priority
1665
1736
            if priority is None:
1666
1737
                priority = "NORMAL"
1667
 
            (gnutls.library.functions
1668
 
             .gnutls_priority_set_direct(session._c_object,
1669
 
                                         priority, None))
 
1738
            gnutls.library.functions.gnutls_priority_set_direct(
 
1739
                session._c_object, priority, None)
1670
1740
            
1671
1741
            # Start communication using the Mandos protocol
1672
1742
            # Get protocol number
1674
1744
            logger.debug("Protocol version: %r", line)
1675
1745
            try:
1676
1746
                if int(line.strip().split()[0]) > 1:
1677
 
                    raise RuntimeError
 
1747
                    raise RuntimeError(line)
1678
1748
            except (ValueError, IndexError, RuntimeError) as error:
1679
1749
                logger.error("Unknown protocol version: %s", error)
1680
1750
                return
1692
1762
            approval_required = False
1693
1763
            try:
1694
1764
                try:
1695
 
                    fpr = self.fingerprint(self.peer_certificate
1696
 
                                           (session))
 
1765
                    fpr = self.fingerprint(
 
1766
                        self.peer_certificate(session))
1697
1767
                except (TypeError,
1698
1768
                        gnutls.errors.GNUTLSError) as error:
1699
1769
                    logger.warning("Bad certificate: %s", error)
1714
1784
                while True:
1715
1785
                    if not client.enabled:
1716
1786
                        logger.info("Client %s is disabled",
1717
 
                                       client.name)
 
1787
                                    client.name)
1718
1788
                        if self.server.use_dbus:
1719
1789
                            # Emit D-Bus signal
1720
1790
                            client.Rejected("Disabled")
1729
1799
                        if self.server.use_dbus:
1730
1800
                            # Emit D-Bus signal
1731
1801
                            client.NeedApproval(
1732
 
                                client.approval_delay_milliseconds(),
1733
 
                                client.approved_by_default)
 
1802
                                client.approval_delay.total_seconds()
 
1803
                                * 1000, client.approved_by_default)
1734
1804
                    else:
1735
1805
                        logger.warning("Client %s was not approved",
1736
1806
                                       client.name)
1742
1812
                    #wait until timeout or approved
1743
1813
                    time = datetime.datetime.now()
1744
1814
                    client.changedstate.acquire()
1745
 
                    client.changedstate.wait(
1746
 
                        float(timedelta_to_milliseconds(delay)
1747
 
                              / 1000))
 
1815
                    client.changedstate.wait(delay.total_seconds())
1748
1816
                    client.changedstate.release()
1749
1817
                    time2 = datetime.datetime.now()
1750
1818
                    if (time2 - time) >= delay:
1769
1837
                        logger.warning("gnutls send failed",
1770
1838
                                       exc_info=error)
1771
1839
                        return
1772
 
                    logger.debug("Sent: %d, remaining: %d",
1773
 
                                 sent, len(client.secret)
1774
 
                                 - (sent_size + sent))
 
1840
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1841
                                 len(client.secret) - (sent_size
 
1842
                                                       + sent))
1775
1843
                    sent_size += sent
1776
1844
                
1777
1845
                logger.info("Sending secret to %s", client.name)
1794
1862
    def peer_certificate(session):
1795
1863
        "Return the peer's OpenPGP certificate as a bytestring"
1796
1864
        # If not an OpenPGP certificate...
1797
 
        if (gnutls.library.functions
1798
 
            .gnutls_certificate_type_get(session._c_object)
 
1865
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
1866
                session._c_object)
1799
1867
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1800
1868
            # ...do the normal thing
1801
1869
            return session.peer_certificate
1815
1883
    def fingerprint(openpgp):
1816
1884
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1817
1885
        # New GnuTLS "datum" with the OpenPGP public key
1818
 
        datum = (gnutls.library.types
1819
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1820
 
                                             ctypes.POINTER
1821
 
                                             (ctypes.c_ubyte)),
1822
 
                                 ctypes.c_uint(len(openpgp))))
 
1886
        datum = gnutls.library.types.gnutls_datum_t(
 
1887
            ctypes.cast(ctypes.c_char_p(openpgp),
 
1888
                        ctypes.POINTER(ctypes.c_ubyte)),
 
1889
            ctypes.c_uint(len(openpgp)))
1823
1890
        # New empty GnuTLS certificate
1824
1891
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1825
 
        (gnutls.library.functions
1826
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
1892
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
1893
            ctypes.byref(crt))
1827
1894
        # Import the OpenPGP public key into the certificate
1828
 
        (gnutls.library.functions
1829
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1830
 
                                    gnutls.library.constants
1831
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
1895
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
1896
            crt, ctypes.byref(datum),
 
1897
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1832
1898
        # Verify the self signature in the key
1833
1899
        crtverify = ctypes.c_uint()
1834
 
        (gnutls.library.functions
1835
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1836
 
                                         ctypes.byref(crtverify)))
 
1900
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
1901
            crt, 0, ctypes.byref(crtverify))
1837
1902
        if crtverify.value != 0:
1838
1903
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1839
 
            raise (gnutls.errors.CertificateSecurityError
1840
 
                   ("Verify failed"))
 
1904
            raise gnutls.errors.CertificateSecurityError(
 
1905
                "Verify failed")
1841
1906
        # New buffer for the fingerprint
1842
1907
        buf = ctypes.create_string_buffer(20)
1843
1908
        buf_len = ctypes.c_size_t()
1844
1909
        # Get the fingerprint from the certificate into the buffer
1845
 
        (gnutls.library.functions
1846
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1847
 
                                             ctypes.byref(buf_len)))
 
1910
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
1911
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1848
1912
        # Deinit the certificate
1849
1913
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1850
1914
        # Convert the buffer to a Python bytestring
1856
1920
 
1857
1921
class MultiprocessingMixIn(object):
1858
1922
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1923
    
1859
1924
    def sub_process_main(self, request, address):
1860
1925
        try:
1861
1926
            self.finish_request(request, address)
1873
1938
 
1874
1939
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1875
1940
    """ adds a pipe to the MixIn """
 
1941
    
1876
1942
    def process_request(self, request, client_address):
1877
1943
        """Overrides and wraps the original process_request().
1878
1944
        
1887
1953
    
1888
1954
    def add_pipe(self, parent_pipe, proc):
1889
1955
        """Dummy function; override as necessary"""
1890
 
        raise NotImplementedError
 
1956
        raise NotImplementedError()
1891
1957
 
1892
1958
 
1893
1959
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1899
1965
        interface:      None or a network interface name (string)
1900
1966
        use_ipv6:       Boolean; to use IPv6 or not
1901
1967
    """
 
1968
    
1902
1969
    def __init__(self, server_address, RequestHandlerClass,
1903
 
                 interface=None, use_ipv6=True, socketfd=None):
 
1970
                 interface=None,
 
1971
                 use_ipv6=True,
 
1972
                 socketfd=None):
1904
1973
        """If socketfd is set, use that file descriptor instead of
1905
1974
        creating a new one with socket.socket().
1906
1975
        """
1947
2016
                             self.interface)
1948
2017
            else:
1949
2018
                try:
1950
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1951
 
                                           SO_BINDTODEVICE,
1952
 
                                           str(self.interface + '\0'))
 
2019
                    self.socket.setsockopt(
 
2020
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2021
                        (self.interface + "\0").encode("utf-8"))
1953
2022
                except socket.error as error:
1954
2023
                    if error.errno == errno.EPERM:
1955
2024
                        logger.error("No permission to bind to"
1969
2038
                if self.address_family == socket.AF_INET6:
1970
2039
                    any_address = "::" # in6addr_any
1971
2040
                else:
1972
 
                    any_address = socket.INADDR_ANY
 
2041
                    any_address = "0.0.0.0" # INADDR_ANY
1973
2042
                self.server_address = (any_address,
1974
2043
                                       self.server_address[1])
1975
2044
            elif not self.server_address[1]:
1976
 
                self.server_address = (self.server_address[0],
1977
 
                                       0)
 
2045
                self.server_address = (self.server_address[0], 0)
1978
2046
#                 if self.interface:
1979
2047
#                     self.server_address = (self.server_address[0],
1980
2048
#                                            0, # port
1994
2062
    
1995
2063
    Assumes a gobject.MainLoop event loop.
1996
2064
    """
 
2065
    
1997
2066
    def __init__(self, server_address, RequestHandlerClass,
1998
 
                 interface=None, use_ipv6=True, clients=None,
1999
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
2067
                 interface=None,
 
2068
                 use_ipv6=True,
 
2069
                 clients=None,
 
2070
                 gnutls_priority=None,
 
2071
                 use_dbus=True,
 
2072
                 socketfd=None):
2000
2073
        self.enabled = False
2001
2074
        self.clients = clients
2002
2075
        if self.clients is None:
2008
2081
                                interface = interface,
2009
2082
                                use_ipv6 = use_ipv6,
2010
2083
                                socketfd = socketfd)
 
2084
    
2011
2085
    def server_activate(self):
2012
2086
        if self.enabled:
2013
2087
            return socketserver.TCPServer.server_activate(self)
2017
2091
    
2018
2092
    def add_pipe(self, parent_pipe, proc):
2019
2093
        # Call "handle_ipc" for both data and EOF events
2020
 
        gobject.io_add_watch(parent_pipe.fileno(),
2021
 
                             gobject.IO_IN | gobject.IO_HUP,
2022
 
                             functools.partial(self.handle_ipc,
2023
 
                                               parent_pipe =
2024
 
                                               parent_pipe,
2025
 
                                               proc = proc))
 
2094
        gobject.io_add_watch(
 
2095
            parent_pipe.fileno(),
 
2096
            gobject.IO_IN | gobject.IO_HUP,
 
2097
            functools.partial(self.handle_ipc,
 
2098
                              parent_pipe = parent_pipe,
 
2099
                              proc = proc))
2026
2100
    
2027
 
    def handle_ipc(self, source, condition, parent_pipe=None,
2028
 
                   proc = None, client_object=None):
 
2101
    def handle_ipc(self, source, condition,
 
2102
                   parent_pipe=None,
 
2103
                   proc = None,
 
2104
                   client_object=None):
2029
2105
        # error, or the other end of multiprocessing.Pipe has closed
2030
2106
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2031
2107
            # Wait for other process to exit
2054
2130
                parent_pipe.send(False)
2055
2131
                return False
2056
2132
            
2057
 
            gobject.io_add_watch(parent_pipe.fileno(),
2058
 
                                 gobject.IO_IN | gobject.IO_HUP,
2059
 
                                 functools.partial(self.handle_ipc,
2060
 
                                                   parent_pipe =
2061
 
                                                   parent_pipe,
2062
 
                                                   proc = proc,
2063
 
                                                   client_object =
2064
 
                                                   client))
 
2133
            gobject.io_add_watch(
 
2134
                parent_pipe.fileno(),
 
2135
                gobject.IO_IN | gobject.IO_HUP,
 
2136
                functools.partial(self.handle_ipc,
 
2137
                                  parent_pipe = parent_pipe,
 
2138
                                  proc = proc,
 
2139
                                  client_object = client))
2065
2140
            parent_pipe.send(True)
2066
2141
            # remove the old hook in favor of the new above hook on
2067
2142
            # same fileno
2073
2148
            
2074
2149
            parent_pipe.send(('data', getattr(client_object,
2075
2150
                                              funcname)(*args,
2076
 
                                                         **kwargs)))
 
2151
                                                        **kwargs)))
2077
2152
        
2078
2153
        if command == 'getattr':
2079
2154
            attrname = request[1]
2080
 
            if callable(client_object.__getattribute__(attrname)):
2081
 
                parent_pipe.send(('function',))
 
2155
            if isinstance(client_object.__getattribute__(attrname),
 
2156
                          collections.Callable):
 
2157
                parent_pipe.send(('function', ))
2082
2158
            else:
2083
 
                parent_pipe.send(('data', client_object
2084
 
                                  .__getattribute__(attrname)))
 
2159
                parent_pipe.send((
 
2160
                    'data', client_object.__getattribute__(attrname)))
2085
2161
        
2086
2162
        if command == 'setattr':
2087
2163
            attrname = request[1]
2118
2194
    # avoid excessive use of external libraries.
2119
2195
    
2120
2196
    # New type for defining tokens, syntax, and semantics all-in-one
2121
 
    Token = collections.namedtuple("Token",
2122
 
                                   ("regexp", # To match token; if
2123
 
                                              # "value" is not None,
2124
 
                                              # must have a "group"
2125
 
                                              # containing digits
2126
 
                                    "value",  # datetime.timedelta or
2127
 
                                              # None
2128
 
                                    "followers")) # Tokens valid after
2129
 
                                                  # this token
 
2197
    Token = collections.namedtuple("Token", (
 
2198
        "regexp",  # To match token; if "value" is not None, must have
 
2199
                   # a "group" containing digits
 
2200
        "value",   # datetime.timedelta or None
 
2201
        "followers"))           # Tokens valid after this token
2130
2202
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2131
2203
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2132
2204
    token_end = Token(re.compile(r"$"), None, frozenset())
2133
2205
    token_second = Token(re.compile(r"(\d+)S"),
2134
2206
                         datetime.timedelta(seconds=1),
2135
 
                         frozenset((token_end,)))
 
2207
                         frozenset((token_end, )))
2136
2208
    token_minute = Token(re.compile(r"(\d+)M"),
2137
2209
                         datetime.timedelta(minutes=1),
2138
2210
                         frozenset((token_second, token_end)))
2154
2226
                       frozenset((token_month, token_end)))
2155
2227
    token_week = Token(re.compile(r"(\d+)W"),
2156
2228
                       datetime.timedelta(weeks=1),
2157
 
                       frozenset((token_end,)))
 
2229
                       frozenset((token_end, )))
2158
2230
    token_duration = Token(re.compile(r"P"), None,
2159
2231
                           frozenset((token_year, token_month,
2160
2232
                                      token_day, token_time,
2161
 
                                      token_week))),
 
2233
                                      token_week)))
2162
2234
    # Define starting values
2163
2235
    value = datetime.timedelta() # Value so far
2164
2236
    found_token = None
2165
 
    followers = frozenset(token_duration,) # Following valid tokens
 
2237
    followers = frozenset((token_duration, )) # Following valid tokens
2166
2238
    s = duration                # String left to parse
2167
2239
    # Loop until end token is found
2168
2240
    while found_token is not token_end:
2185
2257
                break
2186
2258
        else:
2187
2259
            # No currently valid tokens were found
2188
 
            raise ValueError("Invalid RFC 3339 duration")
 
2260
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2261
                             .format(duration))
2189
2262
    # End token found
2190
2263
    return value
2191
2264
 
2215
2288
    timevalue = datetime.timedelta(0)
2216
2289
    for s in interval.split():
2217
2290
        try:
2218
 
            suffix = unicode(s[-1])
 
2291
            suffix = s[-1]
2219
2292
            value = int(s[:-1])
2220
2293
            if suffix == "d":
2221
2294
                delta = datetime.timedelta(value)
2228
2301
            elif suffix == "w":
2229
2302
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2230
2303
            else:
2231
 
                raise ValueError("Unknown suffix {0!r}"
2232
 
                                 .format(suffix))
2233
 
        except (ValueError, IndexError) as e:
 
2304
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2305
        except IndexError as e:
2234
2306
            raise ValueError(*(e.args))
2235
2307
        timevalue += delta
2236
2308
    return timevalue
2252
2324
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2253
2325
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2254
2326
            raise OSError(errno.ENODEV,
2255
 
                          "{0} not a character device"
 
2327
                          "{} not a character device"
2256
2328
                          .format(os.devnull))
2257
2329
        os.dup2(null, sys.stdin.fileno())
2258
2330
        os.dup2(null, sys.stdout.fileno())
2268
2340
    
2269
2341
    parser = argparse.ArgumentParser()
2270
2342
    parser.add_argument("-v", "--version", action="version",
2271
 
                        version = "%(prog)s {0}".format(version),
 
2343
                        version = "%(prog)s {}".format(version),
2272
2344
                        help="show version number and exit")
2273
2345
    parser.add_argument("-i", "--interface", metavar="IF",
2274
2346
                        help="Bind to interface IF")
2280
2352
                        help="Run self-test")
2281
2353
    parser.add_argument("--debug", action="store_true",
2282
2354
                        help="Debug mode; run in foreground and log"
2283
 
                        " to terminal")
 
2355
                        " to terminal", default=None)
2284
2356
    parser.add_argument("--debuglevel", metavar="LEVEL",
2285
2357
                        help="Debug level for stdout output")
2286
2358
    parser.add_argument("--priority", help="GnuTLS"
2293
2365
                        " files")
2294
2366
    parser.add_argument("--no-dbus", action="store_false",
2295
2367
                        dest="use_dbus", help="Do not provide D-Bus"
2296
 
                        " system bus interface")
 
2368
                        " system bus interface", default=None)
2297
2369
    parser.add_argument("--no-ipv6", action="store_false",
2298
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2370
                        dest="use_ipv6", help="Do not use IPv6",
 
2371
                        default=None)
2299
2372
    parser.add_argument("--no-restore", action="store_false",
2300
2373
                        dest="restore", help="Do not restore stored"
2301
 
                        " state")
 
2374
                        " state", default=None)
2302
2375
    parser.add_argument("--socket", type=int,
2303
2376
                        help="Specify a file descriptor to a network"
2304
2377
                        " socket to use instead of creating one")
2305
2378
    parser.add_argument("--statedir", metavar="DIR",
2306
2379
                        help="Directory to save/restore state in")
2307
2380
    parser.add_argument("--foreground", action="store_true",
2308
 
                        help="Run in foreground")
 
2381
                        help="Run in foreground", default=None)
 
2382
    parser.add_argument("--no-zeroconf", action="store_false",
 
2383
                        dest="zeroconf", help="Do not use Zeroconf",
 
2384
                        default=None)
2309
2385
    
2310
2386
    options = parser.parse_args()
2311
2387
    
2312
2388
    if options.check:
2313
2389
        import doctest
2314
 
        doctest.testmod()
2315
 
        sys.exit()
 
2390
        fail_count, test_count = doctest.testmod()
 
2391
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2316
2392
    
2317
2393
    # Default values for config file for server-global settings
2318
2394
    server_defaults = { "interface": "",
2320
2396
                        "port": "",
2321
2397
                        "debug": "False",
2322
2398
                        "priority":
2323
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2399
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2400
                        ":+SIGN-DSA-SHA256",
2324
2401
                        "servicename": "Mandos",
2325
2402
                        "use_dbus": "True",
2326
2403
                        "use_ipv6": "True",
2329
2406
                        "socket": "",
2330
2407
                        "statedir": "/var/lib/mandos",
2331
2408
                        "foreground": "False",
2332
 
                        }
 
2409
                        "zeroconf": "True",
 
2410
                    }
2333
2411
    
2334
2412
    # Parse config file for server-global settings
2335
2413
    server_config = configparser.SafeConfigParser(server_defaults)
2336
2414
    del server_defaults
2337
 
    server_config.read(os.path.join(options.configdir,
2338
 
                                    "mandos.conf"))
 
2415
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2339
2416
    # Convert the SafeConfigParser object to a dict
2340
2417
    server_settings = server_config.defaults()
2341
2418
    # Use the appropriate methods on the non-string config options
2359
2436
    # Override the settings from the config file with command line
2360
2437
    # options, if set.
2361
2438
    for option in ("interface", "address", "port", "debug",
2362
 
                   "priority", "servicename", "configdir",
2363
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2364
 
                   "statedir", "socket", "foreground"):
 
2439
                   "priority", "servicename", "configdir", "use_dbus",
 
2440
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2441
                   "socket", "foreground", "zeroconf"):
2365
2442
        value = getattr(options, option)
2366
2443
        if value is not None:
2367
2444
            server_settings[option] = value
2368
2445
    del options
2369
2446
    # Force all strings to be unicode
2370
2447
    for option in server_settings.keys():
2371
 
        if type(server_settings[option]) is str:
2372
 
            server_settings[option] = unicode(server_settings[option])
 
2448
        if isinstance(server_settings[option], bytes):
 
2449
            server_settings[option] = (server_settings[option]
 
2450
                                       .decode("utf-8"))
 
2451
    # Force all boolean options to be boolean
 
2452
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2453
                   "foreground", "zeroconf"):
 
2454
        server_settings[option] = bool(server_settings[option])
2373
2455
    # Debug implies foreground
2374
2456
    if server_settings["debug"]:
2375
2457
        server_settings["foreground"] = True
2377
2459
    
2378
2460
    ##################################################################
2379
2461
    
 
2462
    if (not server_settings["zeroconf"]
 
2463
        and not (server_settings["port"]
 
2464
                 or server_settings["socket"] != "")):
 
2465
        parser.error("Needs port or socket to work without Zeroconf")
 
2466
    
2380
2467
    # For convenience
2381
2468
    debug = server_settings["debug"]
2382
2469
    debuglevel = server_settings["debuglevel"]
2385
2472
    stored_state_path = os.path.join(server_settings["statedir"],
2386
2473
                                     stored_state_file)
2387
2474
    foreground = server_settings["foreground"]
 
2475
    zeroconf = server_settings["zeroconf"]
2388
2476
    
2389
2477
    if debug:
2390
2478
        initlogger(debug, logging.DEBUG)
2396
2484
            initlogger(debug, level)
2397
2485
    
2398
2486
    if server_settings["servicename"] != "Mandos":
2399
 
        syslogger.setFormatter(logging.Formatter
2400
 
                               ('Mandos ({0}) [%(process)d]:'
2401
 
                                ' %(levelname)s: %(message)s'
2402
 
                                .format(server_settings
2403
 
                                        ["servicename"])))
 
2487
        syslogger.setFormatter(
 
2488
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2489
                              ' %(levelname)s: %(message)s'.format(
 
2490
                                  server_settings["servicename"])))
2404
2491
    
2405
2492
    # Parse config file with clients
2406
2493
    client_config = configparser.SafeConfigParser(Client
2411
2498
    global mandos_dbus_service
2412
2499
    mandos_dbus_service = None
2413
2500
    
2414
 
    tcp_server = MandosServer((server_settings["address"],
2415
 
                               server_settings["port"]),
2416
 
                              ClientHandler,
2417
 
                              interface=(server_settings["interface"]
2418
 
                                         or None),
2419
 
                              use_ipv6=use_ipv6,
2420
 
                              gnutls_priority=
2421
 
                              server_settings["priority"],
2422
 
                              use_dbus=use_dbus,
2423
 
                              socketfd=(server_settings["socket"]
2424
 
                                        or None))
 
2501
    socketfd = None
 
2502
    if server_settings["socket"] != "":
 
2503
        socketfd = server_settings["socket"]
 
2504
    tcp_server = MandosServer(
 
2505
        (server_settings["address"], server_settings["port"]),
 
2506
        ClientHandler,
 
2507
        interface=(server_settings["interface"] or None),
 
2508
        use_ipv6=use_ipv6,
 
2509
        gnutls_priority=server_settings["priority"],
 
2510
        use_dbus=use_dbus,
 
2511
        socketfd=socketfd)
2425
2512
    if not foreground:
2426
 
        pidfilename = "/var/run/mandos.pid"
 
2513
        pidfilename = "/run/mandos.pid"
 
2514
        if not os.path.isdir("/run/."):
 
2515
            pidfilename = "/var/run/mandos.pid"
2427
2516
        pidfile = None
2428
2517
        try:
2429
 
            pidfile = open(pidfilename, "w")
 
2518
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2430
2519
        except IOError as e:
2431
2520
            logger.error("Could not open file %r", pidfilename,
2432
2521
                         exc_info=e)
2446
2535
        os.setuid(uid)
2447
2536
    except OSError as error:
2448
2537
        if error.errno != errno.EPERM:
2449
 
            raise error
 
2538
            raise
2450
2539
    
2451
2540
    if debug:
2452
2541
        # Enable all possible GnuTLS debugging
2459
2548
        def debug_gnutls(level, string):
2460
2549
            logger.debug("GnuTLS: %s", string[:-1])
2461
2550
        
2462
 
        (gnutls.library.functions
2463
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2551
        gnutls.library.functions.gnutls_global_set_log_function(
 
2552
            debug_gnutls)
2464
2553
        
2465
2554
        # Redirect stdin so all checkers get /dev/null
2466
2555
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2486
2575
    if use_dbus:
2487
2576
        try:
2488
2577
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2489
 
                                            bus, do_not_queue=True)
2490
 
            old_bus_name = (dbus.service.BusName
2491
 
                            ("se.bsnet.fukt.Mandos", bus,
2492
 
                             do_not_queue=True))
2493
 
        except dbus.exceptions.NameExistsException as e:
 
2578
                                            bus,
 
2579
                                            do_not_queue=True)
 
2580
            old_bus_name = dbus.service.BusName(
 
2581
                "se.bsnet.fukt.Mandos", bus,
 
2582
                do_not_queue=True)
 
2583
        except dbus.exceptions.DBusException as e:
2494
2584
            logger.error("Disabling D-Bus:", exc_info=e)
2495
2585
            use_dbus = False
2496
2586
            server_settings["use_dbus"] = False
2497
2587
            tcp_server.use_dbus = False
2498
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2499
 
    service = AvahiServiceToSyslog(name =
2500
 
                                   server_settings["servicename"],
2501
 
                                   servicetype = "_mandos._tcp",
2502
 
                                   protocol = protocol, bus = bus)
2503
 
    if server_settings["interface"]:
2504
 
        service.interface = (if_nametoindex
2505
 
                             (str(server_settings["interface"])))
 
2588
    if zeroconf:
 
2589
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2590
        service = AvahiServiceToSyslog(
 
2591
            name = server_settings["servicename"],
 
2592
            servicetype = "_mandos._tcp",
 
2593
            protocol = protocol,
 
2594
            bus = bus)
 
2595
        if server_settings["interface"]:
 
2596
            service.interface = if_nametoindex(
 
2597
                server_settings["interface"].encode("utf-8"))
2506
2598
    
2507
2599
    global multiprocessing_manager
2508
2600
    multiprocessing_manager = multiprocessing.Manager()
2515
2607
    old_client_settings = {}
2516
2608
    clients_data = {}
2517
2609
    
 
2610
    # This is used to redirect stdout and stderr for checker processes
 
2611
    global wnull
 
2612
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2613
    # Only used if server is running in foreground but not in debug
 
2614
    # mode
 
2615
    if debug or not foreground:
 
2616
        wnull.close()
 
2617
    
2518
2618
    # Get client data and settings from last running state.
2519
2619
    if server_settings["restore"]:
2520
2620
        try:
2521
2621
            with open(stored_state_path, "rb") as stored_state:
2522
 
                clients_data, old_client_settings = (pickle.load
2523
 
                                                     (stored_state))
 
2622
                clients_data, old_client_settings = pickle.load(
 
2623
                    stored_state)
2524
2624
            os.remove(stored_state_path)
2525
2625
        except IOError as e:
2526
2626
            if e.errno == errno.ENOENT:
2527
 
                logger.warning("Could not load persistent state: {0}"
2528
 
                                .format(os.strerror(e.errno)))
 
2627
                logger.warning("Could not load persistent state:"
 
2628
                               " {}".format(os.strerror(e.errno)))
2529
2629
            else:
2530
2630
                logger.critical("Could not load persistent state:",
2531
2631
                                exc_info=e)
2532
2632
                raise
2533
2633
        except EOFError as e:
2534
2634
            logger.warning("Could not load persistent state: "
2535
 
                           "EOFError:", exc_info=e)
 
2635
                           "EOFError:",
 
2636
                           exc_info=e)
2536
2637
    
2537
2638
    with PGPEngine() as pgp:
2538
 
        for client_name, client in clients_data.iteritems():
 
2639
        for client_name, client in clients_data.items():
 
2640
            # Skip removed clients
 
2641
            if client_name not in client_settings:
 
2642
                continue
 
2643
            
2539
2644
            # Decide which value to use after restoring saved state.
2540
2645
            # We have three different values: Old config file,
2541
2646
            # new config file, and saved state.
2546
2651
                    # For each value in new config, check if it
2547
2652
                    # differs from the old config value (Except for
2548
2653
                    # the "secret" attribute)
2549
 
                    if (name != "secret" and
2550
 
                        value != old_client_settings[client_name]
2551
 
                        [name]):
 
2654
                    if (name != "secret"
 
2655
                        and (value !=
 
2656
                             old_client_settings[client_name][name])):
2552
2657
                        client[name] = value
2553
2658
                except KeyError:
2554
2659
                    pass
2555
2660
            
2556
2661
            # Clients who has passed its expire date can still be
2557
 
            # enabled if its last checker was successful.  Clients
 
2662
            # enabled if its last checker was successful.  A Client
2558
2663
            # whose checker succeeded before we stored its state is
2559
2664
            # assumed to have successfully run all checkers during
2560
2665
            # downtime.
2562
2667
                if datetime.datetime.utcnow() >= client["expires"]:
2563
2668
                    if not client["last_checked_ok"]:
2564
2669
                        logger.warning(
2565
 
                            "disabling client {0} - Client never "
2566
 
                            "performed a successful checker"
2567
 
                            .format(client_name))
 
2670
                            "disabling client {} - Client never "
 
2671
                            "performed a successful checker".format(
 
2672
                                client_name))
2568
2673
                        client["enabled"] = False
2569
2674
                    elif client["last_checker_status"] != 0:
2570
2675
                        logger.warning(
2571
 
                            "disabling client {0} - Client "
2572
 
                            "last checker failed with error code {1}"
2573
 
                            .format(client_name,
2574
 
                                    client["last_checker_status"]))
 
2676
                            "disabling client {} - Client last"
 
2677
                            " checker failed with error code"
 
2678
                            " {}".format(
 
2679
                                client_name,
 
2680
                                client["last_checker_status"]))
2575
2681
                        client["enabled"] = False
2576
2682
                    else:
2577
 
                        client["expires"] = (datetime.datetime
2578
 
                                             .utcnow()
2579
 
                                             + client["timeout"])
 
2683
                        client["expires"] = (
 
2684
                            datetime.datetime.utcnow()
 
2685
                            + client["timeout"])
2580
2686
                        logger.debug("Last checker succeeded,"
2581
 
                                     " keeping {0} enabled"
2582
 
                                     .format(client_name))
 
2687
                                     " keeping {} enabled".format(
 
2688
                                         client_name))
2583
2689
            try:
2584
 
                client["secret"] = (
2585
 
                    pgp.decrypt(client["encrypted_secret"],
2586
 
                                client_settings[client_name]
2587
 
                                ["secret"]))
 
2690
                client["secret"] = pgp.decrypt(
 
2691
                    client["encrypted_secret"],
 
2692
                    client_settings[client_name]["secret"])
2588
2693
            except PGPError:
2589
2694
                # If decryption fails, we use secret from new settings
2590
 
                logger.debug("Failed to decrypt {0} old secret"
2591
 
                             .format(client_name))
2592
 
                client["secret"] = (
2593
 
                    client_settings[client_name]["secret"])
 
2695
                logger.debug("Failed to decrypt {} old secret".format(
 
2696
                    client_name))
 
2697
                client["secret"] = (client_settings[client_name]
 
2698
                                    ["secret"])
2594
2699
    
2595
2700
    # Add/remove clients based on new changes made to config
2596
2701
    for client_name in (set(old_client_settings)
2601
2706
        clients_data[client_name] = client_settings[client_name]
2602
2707
    
2603
2708
    # Create all client objects
2604
 
    for client_name, client in clients_data.iteritems():
 
2709
    for client_name, client in clients_data.items():
2605
2710
        tcp_server.clients[client_name] = client_class(
2606
 
            name = client_name, settings = client)
 
2711
            name = client_name,
 
2712
            settings = client,
 
2713
            server_settings = server_settings)
2607
2714
    
2608
2715
    if not tcp_server.clients:
2609
2716
        logger.warning("No clients defined")
2610
2717
    
2611
2718
    if not foreground:
2612
2719
        if pidfile is not None:
 
2720
            pid = os.getpid()
2613
2721
            try:
2614
2722
                with pidfile:
2615
 
                    pid = os.getpid()
2616
 
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2723
                    print(pid, file=pidfile)
2617
2724
            except IOError:
2618
2725
                logger.error("Could not write to file %r with PID %d",
2619
2726
                             pidfilename, pid)
2624
2731
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2625
2732
    
2626
2733
    if use_dbus:
2627
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2628
 
                                        "se.bsnet.fukt.Mandos"})
 
2734
        
 
2735
        @alternate_dbus_interfaces(
 
2736
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2629
2737
        class MandosDBusService(DBusObjectWithProperties):
2630
2738
            """A D-Bus proxy object"""
 
2739
            
2631
2740
            def __init__(self):
2632
2741
                dbus.service.Object.__init__(self, bus, "/")
 
2742
            
2633
2743
            _interface = "se.recompile.Mandos"
2634
2744
            
2635
2745
            @dbus_interface_annotations(_interface)
2636
2746
            def _foo(self):
2637
 
                return { "org.freedesktop.DBus.Property"
2638
 
                         ".EmitsChangedSignal":
2639
 
                             "false"}
 
2747
                return {
 
2748
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2749
                    "false" }
2640
2750
            
2641
2751
            @dbus.service.signal(_interface, signature="o")
2642
2752
            def ClientAdded(self, objpath):
2656
2766
            @dbus.service.method(_interface, out_signature="ao")
2657
2767
            def GetAllClients(self):
2658
2768
                "D-Bus method"
2659
 
                return dbus.Array(c.dbus_object_path
2660
 
                                  for c in
 
2769
                return dbus.Array(c.dbus_object_path for c in
2661
2770
                                  tcp_server.clients.itervalues())
2662
2771
            
2663
2772
            @dbus.service.method(_interface,
2665
2774
            def GetAllClientsWithProperties(self):
2666
2775
                "D-Bus method"
2667
2776
                return dbus.Dictionary(
2668
 
                    ((c.dbus_object_path, c.GetAll(""))
2669
 
                     for c in tcp_server.clients.itervalues()),
 
2777
                    { c.dbus_object_path: c.GetAll("")
 
2778
                      for c in tcp_server.clients.itervalues() },
2670
2779
                    signature="oa{sv}")
2671
2780
            
2672
2781
            @dbus.service.method(_interface, in_signature="o")
2689
2798
    
2690
2799
    def cleanup():
2691
2800
        "Cleanup function; run on exit"
2692
 
        service.cleanup()
 
2801
        if zeroconf:
 
2802
            service.cleanup()
2693
2803
        
2694
2804
        multiprocessing.active_children()
 
2805
        wnull.close()
2695
2806
        if not (tcp_server.clients or client_settings):
2696
2807
            return
2697
2808
        
2708
2819
                
2709
2820
                # A list of attributes that can not be pickled
2710
2821
                # + secret.
2711
 
                exclude = set(("bus", "changedstate", "secret",
2712
 
                               "checker"))
2713
 
                for name, typ in (inspect.getmembers
2714
 
                                  (dbus.service.Object)):
 
2822
                exclude = { "bus", "changedstate", "secret",
 
2823
                            "checker", "server_settings" }
 
2824
                for name, typ in inspect.getmembers(dbus.service
 
2825
                                                    .Object):
2715
2826
                    exclude.add(name)
2716
2827
                
2717
2828
                client_dict["encrypted_secret"] = (client
2724
2835
                del client_settings[client.name]["secret"]
2725
2836
        
2726
2837
        try:
2727
 
            with (tempfile.NamedTemporaryFile
2728
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2729
 
                   dir=os.path.dirname(stored_state_path),
2730
 
                   delete=False)) as stored_state:
 
2838
            with tempfile.NamedTemporaryFile(
 
2839
                    mode='wb',
 
2840
                    suffix=".pickle",
 
2841
                    prefix='clients-',
 
2842
                    dir=os.path.dirname(stored_state_path),
 
2843
                    delete=False) as stored_state:
2731
2844
                pickle.dump((clients, client_settings), stored_state)
2732
 
                tempname=stored_state.name
 
2845
                tempname = stored_state.name
2733
2846
            os.rename(tempname, stored_state_path)
2734
2847
        except (IOError, OSError) as e:
2735
2848
            if not debug:
2738
2851
                except NameError:
2739
2852
                    pass
2740
2853
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2741
 
                logger.warning("Could not save persistent state: {0}"
 
2854
                logger.warning("Could not save persistent state: {}"
2742
2855
                               .format(os.strerror(e.errno)))
2743
2856
            else:
2744
2857
                logger.warning("Could not save persistent state:",
2745
2858
                               exc_info=e)
2746
 
                raise e
 
2859
                raise
2747
2860
        
2748
2861
        # Delete all clients, and settings from config
2749
2862
        while tcp_server.clients:
2754
2867
            client.disable(quiet=True)
2755
2868
            if use_dbus:
2756
2869
                # Emit D-Bus signal
2757
 
                mandos_dbus_service.ClientRemoved(client
2758
 
                                                  .dbus_object_path,
2759
 
                                                  client.name)
 
2870
                mandos_dbus_service.ClientRemoved(
 
2871
                    client.dbus_object_path, client.name)
2760
2872
        client_settings.clear()
2761
2873
    
2762
2874
    atexit.register(cleanup)
2773
2885
    tcp_server.server_activate()
2774
2886
    
2775
2887
    # Find out what port we got
2776
 
    service.port = tcp_server.socket.getsockname()[1]
 
2888
    if zeroconf:
 
2889
        service.port = tcp_server.socket.getsockname()[1]
2777
2890
    if use_ipv6:
2778
2891
        logger.info("Now listening on address %r, port %d,"
2779
2892
                    " flowinfo %d, scope_id %d",
2785
2898
    #service.interface = tcp_server.socket.getsockname()[3]
2786
2899
    
2787
2900
    try:
2788
 
        # From the Avahi example code
2789
 
        try:
2790
 
            service.activate()
2791
 
        except dbus.exceptions.DBusException as error:
2792
 
            logger.critical("D-Bus Exception", exc_info=error)
2793
 
            cleanup()
2794
 
            sys.exit(1)
2795
 
        # End of Avahi example code
 
2901
        if zeroconf:
 
2902
            # From the Avahi example code
 
2903
            try:
 
2904
                service.activate()
 
2905
            except dbus.exceptions.DBusException as error:
 
2906
                logger.critical("D-Bus Exception", exc_info=error)
 
2907
                cleanup()
 
2908
                sys.exit(1)
 
2909
            # End of Avahi example code
2796
2910
        
2797
2911
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2798
2912
                             lambda *args, **kwargs:
2813
2927
    # Must run before the D-Bus bus name gets deregistered
2814
2928
    cleanup()
2815
2929
 
 
2930
 
2816
2931
if __name__ == '__main__':
2817
2932
    main()