/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-07-12 01:41:14 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150712014114-qbala4mutkixxct3
Handle local Zeroconf service name collisions on startup, too.

* mandos (AvahiService.server_state_changed): Catch name collision
                                              error when adding
                                              server.

Show diffs side-by-side

added added

removed removed

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