/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2012-05-12 15:45:57 UTC
  • Revision ID: teddy@recompile.se-20120512154557-r1yzcb8su8byp4us
* mandos (Client.enable, Client.disable, ClientDBus.approve): Call
                    self.send_changedstate() after change, not before.
  (Client.disable): Bug fix: Handle disable_initiator_tag and
                    checker_initiator_tag of 0.
  (Client.init_checker): Bug fix: Remove old checker_initiator_tag and
                         disable_initiator_tag, if any.
  (Client.bump_timeout): Bug fix: Remove old disable_initiator_tag, if
                         any.
  (ClientDBus.Timeout_dbus_property): Bug fix: Use self.expires.
  (ClientHandler.handle): Bug fix: timedelta_to_milliseconds is a
                          global function, not a class method.
* mandos-monitor (MandosClientWidget._update_timer_callback_lock):
  Removed.  All users changed.
  (MandosClientWidget.last_checked_ok): Removed (unused).
  (MandosClientWidget.__init__): Don't call self.using_timer().
  (MandosClientWidget.property_changed): Removed unused version.
  (MandosClientWidget.using_timer): Stop using the counter
                                    self._update_timer_callback_lock;
                                    be strictly boolean.
  (MandosClientWidget.need_approval): Don't call self.using_timer().
  (MandosClientWidget.update): Call self.using_timer() throughout.
                               Bug fix: Never show negative timers.

Show diffs side-by-side

added added

removed removed

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