/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-08-10 09:00:23 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150810090023-fz6vjqr7zf33e2tf
Support the standard org.freedesktop.DBus.ObjectManager interface.

Now that the D-Bus standard has an interface to keep track of new and
removed objects, use that instead of our own methods.  This deprecates
our D-Bus methods "GetAllClients" and "GetAllClientsWithProperties"
and the signals "ClientAdded" and "ClientRemoved", all on the server
interface "se.recompile.Mandos".

* DBUS-API: Removed references to deprecated methods and signals;
  insert reference to the org.freedesktop.DBus.ObjectManager
  interface.
* mandos (DBusObjectWithProperties._get_all_interface_names): New.
  (dbus.OBJECT_MANAGER_IFACE): If not present, monkey patch.
  (DBusObjectWithObjectManager): New.
  (main/MandosDBusService): Inherit from DBusObjectWithObjectManager.
  (main/MandosDBusService.ClientRemoved): Annotate as deprecated.
  (main/MandosDBusService.GetAllClients): - '' -
  (main/MandosDBusService.GetAllClientsWithProperties): Annotate as
                                                        deprecated.
                                                        Also only
                                                        return
                                                        properties on
                                                        client
                                                        interface.
  (main/MandosDBusService.RemoveClient): Call client_removed_signal
                                         instead of ClientRemoved.
  (main/MandosDBusService.GetManagedObjects): New.
  (main/MandosDBusService.client_added_signal): New.
  (main/MandosDBusService.client_removed_signal): - '' -
  (main/cleanup): Call "client_removed_signal" instead of sending
                  "ClientRemoved" signal directly.
  (main): Call "client_added_signal" instead of sending "ClientAdded"
          signal directly.
* mandos-ctl: Use GetManagedObjects instead of
              GetAllClientsWithProperties.  Also, show better error
              message in case of failure to connect to the D-Bus

* mandos-monitor (MandosClientPropertyCache.properties_changed):
  Bug fix; only update properties on client interface.
  (UserInterface.find_and_remove_client): Change to accept arguments
                                          from InterfacesRemoved
                                          signal.  Also, bug fix:
                                          working error message when
                                          removing unknown client.
  (UserInterface.add_new_client): Change to accept arguments from
                                  InterfacesRemoved signal.  Pass
                                  properties to MandosClientWidget
                                  constructor.
  (UserInterface.run): Connect find_and_remove_client method to
                       InterfacesRemoved signal and the add_new_client
                       method to the InterfacesAdded signal.

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
    See also the DBusObjectWithAnnotations class.
 
847
    """
 
848
    
 
849
    def decorator(func):
 
850
        func._dbus_annotations = annotations
 
851
        return func
 
852
    
760
853
    return decorator
761
854
 
762
855
 
763
856
class DBusPropertyException(dbus.exceptions.DBusException):
764
857
    """A base class for D-Bus property-related exceptions
765
858
    """
766
 
    def __unicode__(self):
767
 
        return unicode(str(self))
 
859
    pass
768
860
 
769
861
 
770
862
class DBusPropertyAccessException(DBusPropertyException):
779
871
    pass
780
872
 
781
873
 
782
 
class DBusObjectWithProperties(dbus.service.Object):
 
874
class DBusObjectWithAnnotations(dbus.service.Object):
 
875
    """A D-Bus object with annotations.
 
876
    
 
877
    Classes inheriting from this can use the dbus_annotations
 
878
    decorator to add annotations to methods or signals.
 
879
    """
 
880
    
 
881
    @staticmethod
 
882
    def _is_dbus_thing(thing):
 
883
        """Returns a function testing if an attribute is a D-Bus thing
 
884
        
 
885
        If called like _is_dbus_thing("method") it returns a function
 
886
        suitable for use as predicate to inspect.getmembers().
 
887
        """
 
888
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
889
                                   False)
 
890
    
 
891
    def _get_all_dbus_things(self, thing):
 
892
        """Returns a generator of (name, attribute) pairs
 
893
        """
 
894
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
895
                 athing.__get__(self))
 
896
                for cls in self.__class__.__mro__
 
897
                for name, athing in
 
898
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
899
    
 
900
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
901
                         out_signature = "s",
 
902
                         path_keyword = 'object_path',
 
903
                         connection_keyword = 'connection')
 
904
    def Introspect(self, object_path, connection):
 
905
        """Overloading of standard D-Bus method.
 
906
        
 
907
        Inserts annotation tags on methods and signals.
 
908
        """
 
909
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
910
                                                   connection)
 
911
        try:
 
912
            document = xml.dom.minidom.parseString(xmlstring)
 
913
            
 
914
            for if_tag in document.getElementsByTagName("interface"):
 
915
                # Add annotation tags
 
916
                for typ in ("method", "signal"):
 
917
                    for tag in if_tag.getElementsByTagName(typ):
 
918
                        annots = dict()
 
919
                        for name, prop in (self.
 
920
                                           _get_all_dbus_things(typ)):
 
921
                            if (name == tag.getAttribute("name")
 
922
                                and prop._dbus_interface
 
923
                                == if_tag.getAttribute("name")):
 
924
                                annots.update(getattr(
 
925
                                    prop, "_dbus_annotations", {}))
 
926
                        for name, value in annots.items():
 
927
                            ann_tag = document.createElement(
 
928
                                "annotation")
 
929
                            ann_tag.setAttribute("name", name)
 
930
                            ann_tag.setAttribute("value", value)
 
931
                            tag.appendChild(ann_tag)
 
932
                # Add interface annotation tags
 
933
                for annotation, value in dict(
 
934
                    itertools.chain.from_iterable(
 
935
                        annotations().items()
 
936
                        for name, annotations
 
937
                        in self._get_all_dbus_things("interface")
 
938
                        if name == if_tag.getAttribute("name")
 
939
                        )).items():
 
940
                    ann_tag = document.createElement("annotation")
 
941
                    ann_tag.setAttribute("name", annotation)
 
942
                    ann_tag.setAttribute("value", value)
 
943
                    if_tag.appendChild(ann_tag)
 
944
                # Fix argument name for the Introspect method itself
 
945
                if (if_tag.getAttribute("name")
 
946
                                == dbus.INTROSPECTABLE_IFACE):
 
947
                    for cn in if_tag.getElementsByTagName("method"):
 
948
                        if cn.getAttribute("name") == "Introspect":
 
949
                            for arg in cn.getElementsByTagName("arg"):
 
950
                                if (arg.getAttribute("direction")
 
951
                                    == "out"):
 
952
                                    arg.setAttribute("name",
 
953
                                                     "xml_data")
 
954
            xmlstring = document.toxml("utf-8")
 
955
            document.unlink()
 
956
        except (AttributeError, xml.dom.DOMException,
 
957
                xml.parsers.expat.ExpatError) as error:
 
958
            logger.error("Failed to override Introspection method",
 
959
                         exc_info=error)
 
960
        return xmlstring
 
961
 
 
962
 
 
963
class DBusObjectWithProperties(DBusObjectWithAnnotations):
783
964
    """A D-Bus object with properties.
784
965
    
785
966
    Classes inheriting from this can use the dbus_service_property
787
968
    standard Get(), Set(), and GetAll() methods on the D-Bus.
788
969
    """
789
970
    
790
 
    @staticmethod
791
 
    def _is_dbus_property(obj):
792
 
        return getattr(obj, "_dbus_is_property", False)
793
 
    
794
 
    def _get_all_dbus_properties(self):
795
 
        """Returns a generator of (name, attribute) pairs
796
 
        """
797
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
798
 
                for cls in self.__class__.__mro__
799
 
                for name, prop in
800
 
                inspect.getmembers(cls, self._is_dbus_property))
801
 
    
802
971
    def _get_dbus_property(self, interface_name, property_name):
803
972
        """Returns a bound method if one exists which is a D-Bus
804
973
        property with the specified name and interface.
805
974
        """
806
 
        for cls in  self.__class__.__mro__:
807
 
            for name, value in (inspect.getmembers
808
 
                                (cls, self._is_dbus_property)):
 
975
        for cls in self.__class__.__mro__:
 
976
            for name, value in inspect.getmembers(
 
977
                    cls, self._is_dbus_thing("property")):
809
978
                if (value._dbus_name == property_name
810
979
                    and value._dbus_interface == interface_name):
811
980
                    return value.__get__(self)
812
981
        
813
982
        # No such property
814
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
815
 
                                   + interface_name + "."
816
 
                                   + property_name)
817
 
    
818
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
983
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
984
            self.dbus_object_path, interface_name, property_name))
 
985
    
 
986
    @classmethod
 
987
    def _get_all_interface_names(cls):
 
988
        """Get a sequence of all interfaces supported by an object"""
 
989
        return (name for name in set(getattr(getattr(x, attr),
 
990
                                             "_dbus_interface", None)
 
991
                                     for x in (inspect.getmro(cls))
 
992
                                     for attr in dir(x))
 
993
                if name is not None)
 
994
    
 
995
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
996
                         in_signature="ss",
819
997
                         out_signature="v")
820
998
    def Get(self, interface_name, property_name):
821
999
        """Standard D-Bus property Get() method, see D-Bus standard.
839
1017
            # The byte_arrays option is not supported yet on
840
1018
            # signatures other than "ay".
841
1019
            if prop._dbus_signature != "ay":
842
 
                raise ValueError
843
 
            value = dbus.ByteArray(''.join(unichr(byte)
844
 
                                           for byte in value))
 
1020
                raise ValueError("Byte arrays not supported for non-"
 
1021
                                 "'ay' signature {!r}"
 
1022
                                 .format(prop._dbus_signature))
 
1023
            value = dbus.ByteArray(b''.join(chr(byte)
 
1024
                                            for byte in value))
845
1025
        prop(value)
846
1026
    
847
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1027
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1028
                         in_signature="s",
848
1029
                         out_signature="a{sv}")
849
1030
    def GetAll(self, interface_name):
850
1031
        """Standard D-Bus property GetAll() method, see D-Bus
853
1034
        Note: Will not include properties with access="write".
854
1035
        """
855
1036
        properties = {}
856
 
        for name, prop in self._get_all_dbus_properties():
 
1037
        for name, prop in self._get_all_dbus_things("property"):
857
1038
            if (interface_name
858
1039
                and interface_name != prop._dbus_interface):
859
1040
                # Interface non-empty but did not match
865
1046
            if not hasattr(value, "variant_level"):
866
1047
                properties[name] = value
867
1048
                continue
868
 
            properties[name] = type(value)(value, variant_level=
869
 
                                           value.variant_level+1)
 
1049
            properties[name] = type(value)(
 
1050
                value, variant_level = value.variant_level + 1)
870
1051
        return dbus.Dictionary(properties, signature="sv")
871
1052
    
 
1053
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
1054
    def PropertiesChanged(self, interface_name, changed_properties,
 
1055
                          invalidated_properties):
 
1056
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
1057
        standard.
 
1058
        """
 
1059
        pass
 
1060
    
872
1061
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
873
1062
                         out_signature="s",
874
1063
                         path_keyword='object_path',
875
1064
                         connection_keyword='connection')
876
1065
    def Introspect(self, object_path, connection):
877
 
        """Standard D-Bus method, overloaded to insert property tags.
 
1066
        """Overloading of standard D-Bus method.
 
1067
        
 
1068
        Inserts property tags and interface annotation tags.
878
1069
        """
879
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
880
 
                                                   connection)
 
1070
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1071
                                                         object_path,
 
1072
                                                         connection)
881
1073
        try:
882
1074
            document = xml.dom.minidom.parseString(xmlstring)
 
1075
            
883
1076
            def make_tag(document, name, prop):
884
1077
                e = document.createElement("property")
885
1078
                e.setAttribute("name", name)
886
1079
                e.setAttribute("type", prop._dbus_signature)
887
1080
                e.setAttribute("access", prop._dbus_access)
888
1081
                return e
 
1082
            
889
1083
            for if_tag in document.getElementsByTagName("interface"):
 
1084
                # Add property tags
890
1085
                for tag in (make_tag(document, name, prop)
891
1086
                            for name, prop
892
 
                            in self._get_all_dbus_properties()
 
1087
                            in self._get_all_dbus_things("property")
893
1088
                            if prop._dbus_interface
894
1089
                            == if_tag.getAttribute("name")):
895
1090
                    if_tag.appendChild(tag)
 
1091
                # Add annotation tags for properties
 
1092
                for tag in if_tag.getElementsByTagName("property"):
 
1093
                    annots = dict()
 
1094
                    for name, prop in self._get_all_dbus_things(
 
1095
                            "property"):
 
1096
                        if (name == tag.getAttribute("name")
 
1097
                            and prop._dbus_interface
 
1098
                            == if_tag.getAttribute("name")):
 
1099
                            annots.update(getattr(
 
1100
                                prop, "_dbus_annotations", {}))
 
1101
                    for name, value in annots.items():
 
1102
                        ann_tag = document.createElement(
 
1103
                            "annotation")
 
1104
                        ann_tag.setAttribute("name", name)
 
1105
                        ann_tag.setAttribute("value", value)
 
1106
                        tag.appendChild(ann_tag)
896
1107
                # Add the names to the return values for the
897
1108
                # "org.freedesktop.DBus.Properties" methods
898
1109
                if (if_tag.getAttribute("name")
913
1124
        except (AttributeError, xml.dom.DOMException,
914
1125
                xml.parsers.expat.ExpatError) as error:
915
1126
            logger.error("Failed to override Introspection method",
916
 
                         error)
917
 
        return xmlstring
918
 
 
919
 
 
920
 
def datetime_to_dbus (dt, variant_level=0):
 
1127
                         exc_info=error)
 
1128
        return xmlstring
 
1129
 
 
1130
try:
 
1131
    dbus.OBJECT_MANAGER_IFACE
 
1132
except AttributeError:
 
1133
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1134
 
 
1135
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1136
    """A D-Bus object with an ObjectManager.
 
1137
    
 
1138
    Classes inheriting from this exposes the standard
 
1139
    GetManagedObjects call and the InterfacesAdded and
 
1140
    InterfacesRemoved signals on the standard
 
1141
    "org.freedesktop.DBus.ObjectManager" interface.
 
1142
    
 
1143
    Note: No signals are sent automatically; they must be sent
 
1144
    manually.
 
1145
    """
 
1146
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1147
                         out_signature = "a{oa{sa{sv}}}")
 
1148
    def GetManagedObjects(self):
 
1149
        """This function must be overridden"""
 
1150
        raise NotImplementedError()
 
1151
    
 
1152
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1153
                         signature = "oa{sa{sv}}")
 
1154
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1155
        pass
 
1156
    
 
1157
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1158
                         signature = "oas")
 
1159
    def InterfacesRemoved(self, object_path, interfaces):
 
1160
        pass
 
1161
    
 
1162
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1163
                         out_signature = "s",
 
1164
                         path_keyword = 'object_path',
 
1165
                         connection_keyword = 'connection')
 
1166
    def Introspect(self, object_path, connection):
 
1167
        """Overloading of standard D-Bus method.
 
1168
        
 
1169
        Override return argument name of GetManagedObjects to be
 
1170
        "objpath_interfaces_and_properties"
 
1171
        """
 
1172
        xmlstring = DBusObjectWithAnnotations(self, object_path,
 
1173
                                              connection)
 
1174
        try:
 
1175
            document = xml.dom.minidom.parseString(xmlstring)
 
1176
            
 
1177
            for if_tag in document.getElementsByTagName("interface"):
 
1178
                # Fix argument name for the GetManagedObjects method
 
1179
                if (if_tag.getAttribute("name")
 
1180
                                == dbus.OBJECT_MANAGER_IFACE):
 
1181
                    for cn in if_tag.getElementsByTagName("method"):
 
1182
                        if (cn.getAttribute("name")
 
1183
                            == "GetManagedObjects"):
 
1184
                            for arg in cn.getElementsByTagName("arg"):
 
1185
                                if (arg.getAttribute("direction")
 
1186
                                    == "out"):
 
1187
                                    arg.setAttribute(
 
1188
                                        "name",
 
1189
                                        "objpath_interfaces"
 
1190
                                        "_and_properties")
 
1191
            xmlstring = document.toxml("utf-8")
 
1192
            document.unlink()
 
1193
        except (AttributeError, xml.dom.DOMException,
 
1194
                xml.parsers.expat.ExpatError) as error:
 
1195
            logger.error("Failed to override Introspection method",
 
1196
                         exc_info = error)
 
1197
        return xmlstring
 
1198
 
 
1199
def datetime_to_dbus(dt, variant_level=0):
921
1200
    """Convert a UTC datetime.datetime() to a D-Bus type."""
922
1201
    if dt is None:
923
1202
        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.
 
1203
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
1204
 
 
1205
 
 
1206
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1207
    """A class decorator; applied to a subclass of
 
1208
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1209
    interface names according to the "alt_interface_names" mapping.
 
1210
    Usage:
 
1211
    
 
1212
    @alternate_dbus_interfaces({"org.example.Interface":
 
1213
                                    "net.example.AlternateInterface"})
 
1214
    class SampleDBusObject(dbus.service.Object):
 
1215
        @dbus.service.method("org.example.Interface")
 
1216
        def SampleDBusMethod():
 
1217
            pass
 
1218
    
 
1219
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1220
    reachable via two interfaces: "org.example.Interface" and
 
1221
    "net.example.AlternateInterface", the latter of which will have
 
1222
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1223
    "true", unless "deprecate" is passed with a False value.
 
1224
    
 
1225
    This works for methods and signals, and also for D-Bus properties
 
1226
    (from DBusObjectWithProperties) and interfaces (from the
 
1227
    dbus_interface_annotations decorator).
932
1228
    """
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):
 
1229
    
 
1230
    def wrapper(cls):
 
1231
        for orig_interface_name, alt_interface_name in (
 
1232
                alt_interface_names.items()):
 
1233
            attr = {}
 
1234
            interface_names = set()
 
1235
            # Go though all attributes of the class
 
1236
            for attrname, attribute in inspect.getmembers(cls):
940
1237
                # Ignore non-D-Bus attributes, and D-Bus attributes
941
1238
                # with the wrong interface name
942
1239
                if (not hasattr(attribute, "_dbus_interface")
943
 
                    or not attribute._dbus_interface
944
 
                    .startswith("se.recompile.Mandos")):
 
1240
                    or not attribute._dbus_interface.startswith(
 
1241
                        orig_interface_name)):
945
1242
                    continue
946
1243
                # Create an alternate D-Bus interface name based on
947
1244
                # the current name
948
 
                alt_interface = (attribute._dbus_interface
949
 
                                 .replace("se.recompile.Mandos",
950
 
                                          "se.bsnet.fukt.Mandos"))
 
1245
                alt_interface = attribute._dbus_interface.replace(
 
1246
                    orig_interface_name, alt_interface_name)
 
1247
                interface_names.add(alt_interface)
951
1248
                # Is this a D-Bus signal?
952
1249
                if getattr(attribute, "_dbus_is_signal", False):
953
 
                    # Extract the original non-method function by
954
 
                    # black magic
955
 
                    nonmethod_func = (dict(
 
1250
                    if sys.version_info.major == 2:
 
1251
                        # Extract the original non-method undecorated
 
1252
                        # function by black magic
 
1253
                        nonmethod_func = (dict(
956
1254
                            zip(attribute.func_code.co_freevars,
957
 
                                attribute.__closure__))["func"]
958
 
                                      .cell_contents)
 
1255
                                attribute.__closure__))
 
1256
                                          ["func"].cell_contents)
 
1257
                    else:
 
1258
                        nonmethod_func = attribute
959
1259
                    # Create a new, but exactly alike, function
960
1260
                    # object, and decorate it to be a new D-Bus signal
961
1261
                    # 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)))
 
1262
                    if sys.version_info.major == 2:
 
1263
                        new_function = types.FunctionType(
 
1264
                            nonmethod_func.func_code,
 
1265
                            nonmethod_func.func_globals,
 
1266
                            nonmethod_func.func_name,
 
1267
                            nonmethod_func.func_defaults,
 
1268
                            nonmethod_func.func_closure)
 
1269
                    else:
 
1270
                        new_function = types.FunctionType(
 
1271
                            nonmethod_func.__code__,
 
1272
                            nonmethod_func.__globals__,
 
1273
                            nonmethod_func.__name__,
 
1274
                            nonmethod_func.__defaults__,
 
1275
                            nonmethod_func.__closure__)
 
1276
                    new_function = (dbus.service.signal(
 
1277
                        alt_interface,
 
1278
                        attribute._dbus_signature)(new_function))
 
1279
                    # Copy annotations, if any
 
1280
                    try:
 
1281
                        new_function._dbus_annotations = dict(
 
1282
                            attribute._dbus_annotations)
 
1283
                    except AttributeError:
 
1284
                        pass
971
1285
                    # 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
 
1286
                    # original and alternate functions, so both the
 
1287
                    # original and alternate signals gets sent when
 
1288
                    # the function is called
974
1289
                    def fixscope(func1, func2):
975
1290
                        """This function is a scope container to pass
976
1291
                        func1 and func2 to the "call_both" function
977
1292
                        outside of its arguments"""
 
1293
                        
978
1294
                        def call_both(*args, **kwargs):
979
1295
                            """This function will emit two D-Bus
980
1296
                            signals by calling func1 and func2"""
981
1297
                            func1(*args, **kwargs)
982
1298
                            func2(*args, **kwargs)
 
1299
                        
983
1300
                        return call_both
984
1301
                    # Create the "call_both" function and add it to
985
1302
                    # the class
986
 
                    attr[attrname] = fixscope(attribute,
987
 
                                              new_function)
 
1303
                    attr[attrname] = fixscope(attribute, new_function)
988
1304
                # Is this a D-Bus method?
989
1305
                elif getattr(attribute, "_dbus_is_method", False):
990
1306
                    # Create a new, but exactly alike, function
991
1307
                    # object.  Decorate it to be a new D-Bus method
992
1308
                    # with the alternate D-Bus interface name.  Add it
993
1309
                    # 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)))
 
1310
                    attr[attrname] = (
 
1311
                        dbus.service.method(
 
1312
                            alt_interface,
 
1313
                            attribute._dbus_in_signature,
 
1314
                            attribute._dbus_out_signature)
 
1315
                        (types.FunctionType(attribute.func_code,
 
1316
                                            attribute.func_globals,
 
1317
                                            attribute.func_name,
 
1318
                                            attribute.func_defaults,
 
1319
                                            attribute.func_closure)))
 
1320
                    # Copy annotations, if any
 
1321
                    try:
 
1322
                        attr[attrname]._dbus_annotations = dict(
 
1323
                            attribute._dbus_annotations)
 
1324
                    except AttributeError:
 
1325
                        pass
1004
1326
                # Is this a D-Bus property?
1005
1327
                elif getattr(attribute, "_dbus_is_property", False):
1006
1328
                    # Create a new, but exactly alike, function
1007
1329
                    # object, and decorate it to be a new D-Bus
1008
1330
                    # property with the alternate D-Bus interface
1009
1331
                    # 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
 
 
 
1332
                    attr[attrname] = (dbus_service_property(
 
1333
                        alt_interface, attribute._dbus_signature,
 
1334
                        attribute._dbus_access,
 
1335
                        attribute._dbus_get_args_options
 
1336
                        ["byte_arrays"])
 
1337
                                      (types.FunctionType(
 
1338
                                          attribute.func_code,
 
1339
                                          attribute.func_globals,
 
1340
                                          attribute.func_name,
 
1341
                                          attribute.func_defaults,
 
1342
                                          attribute.func_closure)))
 
1343
                    # Copy annotations, if any
 
1344
                    try:
 
1345
                        attr[attrname]._dbus_annotations = dict(
 
1346
                            attribute._dbus_annotations)
 
1347
                    except AttributeError:
 
1348
                        pass
 
1349
                # Is this a D-Bus interface?
 
1350
                elif getattr(attribute, "_dbus_is_interface", False):
 
1351
                    # Create a new, but exactly alike, function
 
1352
                    # object.  Decorate it to be a new D-Bus interface
 
1353
                    # with the alternate D-Bus interface name.  Add it
 
1354
                    # to the class.
 
1355
                    attr[attrname] = (
 
1356
                        dbus_interface_annotations(alt_interface)
 
1357
                        (types.FunctionType(attribute.func_code,
 
1358
                                            attribute.func_globals,
 
1359
                                            attribute.func_name,
 
1360
                                            attribute.func_defaults,
 
1361
                                            attribute.func_closure)))
 
1362
            if deprecate:
 
1363
                # Deprecate all alternate interfaces
 
1364
                iname="_AlternateDBusNames_interface_annotation{}"
 
1365
                for interface_name in interface_names:
 
1366
                    
 
1367
                    @dbus_interface_annotations(interface_name)
 
1368
                    def func(self):
 
1369
                        return { "org.freedesktop.DBus.Deprecated":
 
1370
                                 "true" }
 
1371
                    # Find an unused name
 
1372
                    for aname in (iname.format(i)
 
1373
                                  for i in itertools.count()):
 
1374
                        if aname not in attr:
 
1375
                            attr[aname] = func
 
1376
                            break
 
1377
            if interface_names:
 
1378
                # Replace the class with a new subclass of it with
 
1379
                # methods, signals, etc. as created above.
 
1380
                cls = type(b"{}Alternate".format(cls.__name__),
 
1381
                           (cls, ), attr)
 
1382
        return cls
 
1383
    
 
1384
    return wrapper
 
1385
 
 
1386
 
 
1387
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1388
                            "se.bsnet.fukt.Mandos"})
1026
1389
class ClientDBus(Client, DBusObjectWithProperties):
1027
1390
    """A Client class using D-Bus
1028
1391
    
1032
1395
    """
1033
1396
    
1034
1397
    runtime_expansions = (Client.runtime_expansions
1035
 
                          + ("dbus_object_path",))
 
1398
                          + ("dbus_object_path", ))
 
1399
    
 
1400
    _interface = "se.recompile.Mandos.Client"
1036
1401
    
1037
1402
    # dbus.service.Object doesn't use super(), so we can't either.
1038
1403
    
1039
1404
    def __init__(self, bus = None, *args, **kwargs):
1040
1405
        self.bus = bus
1041
1406
        Client.__init__(self, *args, **kwargs)
1042
 
        self._approvals_pending = 0
1043
 
        
1044
 
        self._approvals_pending = 0
1045
1407
        # Only now, when this client is initialized, can it show up on
1046
1408
        # the D-Bus
1047
 
        client_object_name = unicode(self.name).translate(
 
1409
        client_object_name = str(self.name).translate(
1048
1410
            {ord("."): ord("_"),
1049
1411
             ord("-"): ord("_")})
1050
 
        self.dbus_object_path = (dbus.ObjectPath
1051
 
                                 ("/clients/" + client_object_name))
 
1412
        self.dbus_object_path = dbus.ObjectPath(
 
1413
            "/clients/" + client_object_name)
1052
1414
        DBusObjectWithProperties.__init__(self, self.bus,
1053
1415
                                          self.dbus_object_path)
1054
 
        
1055
 
    def notifychangeproperty(transform_func,
1056
 
                             dbus_name, type_func=lambda x: x,
1057
 
                             variant_level=1):
 
1416
    
 
1417
    def notifychangeproperty(transform_func, dbus_name,
 
1418
                             type_func=lambda x: x,
 
1419
                             variant_level=1,
 
1420
                             invalidate_only=False,
 
1421
                             _interface=_interface):
1058
1422
        """ Modify a variable so that it's a property which announces
1059
1423
        its changes to DBus.
1060
1424
        
1065
1429
                   to the D-Bus.  Default: no transform
1066
1430
        variant_level: D-Bus variant level.  Default: 1
1067
1431
        """
1068
 
        attrname = "_{0}".format(dbus_name)
 
1432
        attrname = "_{}".format(dbus_name)
 
1433
        
1069
1434
        def setter(self, value):
1070
1435
            if hasattr(self, "dbus_object_path"):
1071
1436
                if (not hasattr(self, attrname) or
1072
1437
                    type_func(getattr(self, attrname, None))
1073
1438
                    != 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)
 
1439
                    if invalidate_only:
 
1440
                        self.PropertiesChanged(
 
1441
                            _interface, dbus.Dictionary(),
 
1442
                            dbus.Array((dbus_name, )))
 
1443
                    else:
 
1444
                        dbus_value = transform_func(
 
1445
                            type_func(value),
 
1446
                            variant_level = variant_level)
 
1447
                        self.PropertyChanged(dbus.String(dbus_name),
 
1448
                                             dbus_value)
 
1449
                        self.PropertiesChanged(
 
1450
                            _interface,
 
1451
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1452
                                              dbus_value }),
 
1453
                            dbus.Array())
1079
1454
            setattr(self, attrname, value)
1080
1455
        
1081
1456
        return property(lambda self: getattr(self, attrname), setter)
1082
1457
    
1083
 
    
1084
1458
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1085
1459
    approvals_pending = notifychangeproperty(dbus.Boolean,
1086
1460
                                             "ApprovalPending",
1088
1462
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1089
1463
    last_enabled = notifychangeproperty(datetime_to_dbus,
1090
1464
                                        "LastEnabled")
1091
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1092
 
                                   type_func = lambda checker:
1093
 
                                       checker is not None)
 
1465
    checker = notifychangeproperty(
 
1466
        dbus.Boolean, "CheckerRunning",
 
1467
        type_func = lambda checker: checker is not None)
1094
1468
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1095
1469
                                           "LastCheckedOK")
 
1470
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1471
                                               "LastCheckerStatus")
1096
1472
    last_approval_request = notifychangeproperty(
1097
1473
        datetime_to_dbus, "LastApprovalRequest")
1098
1474
    approved_by_default = notifychangeproperty(dbus.Boolean,
1099
1475
                                               "ApprovedByDefault")
1100
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1101
 
                                          "ApprovalDelay",
1102
 
                                          type_func =
1103
 
                                          timedelta_to_milliseconds)
 
1476
    approval_delay = notifychangeproperty(
 
1477
        dbus.UInt64, "ApprovalDelay",
 
1478
        type_func = lambda td: td.total_seconds() * 1000)
1104
1479
    approval_duration = notifychangeproperty(
1105
1480
        dbus.UInt64, "ApprovalDuration",
1106
 
        type_func = timedelta_to_milliseconds)
 
1481
        type_func = lambda td: td.total_seconds() * 1000)
1107
1482
    host = notifychangeproperty(dbus.String, "Host")
1108
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1109
 
                                   type_func =
1110
 
                                   timedelta_to_milliseconds)
 
1483
    timeout = notifychangeproperty(
 
1484
        dbus.UInt64, "Timeout",
 
1485
        type_func = lambda td: td.total_seconds() * 1000)
1111
1486
    extended_timeout = notifychangeproperty(
1112
1487
        dbus.UInt64, "ExtendedTimeout",
1113
 
        type_func = timedelta_to_milliseconds)
1114
 
    interval = notifychangeproperty(dbus.UInt64,
1115
 
                                    "Interval",
1116
 
                                    type_func =
1117
 
                                    timedelta_to_milliseconds)
 
1488
        type_func = lambda td: td.total_seconds() * 1000)
 
1489
    interval = notifychangeproperty(
 
1490
        dbus.UInt64, "Interval",
 
1491
        type_func = lambda td: td.total_seconds() * 1000)
1118
1492
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1493
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1494
                                  invalidate_only=True)
1119
1495
    
1120
1496
    del notifychangeproperty
1121
1497
    
1128
1504
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1129
1505
        Client.__del__(self, *args, **kwargs)
1130
1506
    
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)
 
1507
    def checker_callback(self, source, condition,
 
1508
                         connection, command, *args, **kwargs):
 
1509
        ret = Client.checker_callback(self, source, condition,
 
1510
                                      connection, command, *args,
 
1511
                                      **kwargs)
 
1512
        exitstatus = self.last_checker_status
 
1513
        if exitstatus >= 0:
1137
1514
            # Emit D-Bus signal
1138
1515
            self.CheckerCompleted(dbus.Int16(exitstatus),
1139
 
                                  dbus.Int64(condition),
 
1516
                                  # This is specific to GNU libC
 
1517
                                  dbus.Int64(exitstatus << 8),
1140
1518
                                  dbus.String(command))
1141
1519
        else:
1142
1520
            # Emit D-Bus signal
1143
1521
            self.CheckerCompleted(dbus.Int16(-1),
1144
 
                                  dbus.Int64(condition),
 
1522
                                  dbus.Int64(
 
1523
                                      # This is specific to GNU libC
 
1524
                                      (exitstatus << 8)
 
1525
                                      | self.last_checker_signal),
1145
1526
                                  dbus.String(command))
1146
 
        
1147
 
        return Client.checker_callback(self, pid, condition, command,
1148
 
                                       *args, **kwargs)
 
1527
        return ret
1149
1528
    
1150
1529
    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
 
1530
        old_checker_pid = getattr(self.checker, "pid", None)
1156
1531
        r = Client.start_checker(self, *args, **kwargs)
1157
1532
        # Only if new checker process was started
1158
1533
        if (self.checker is not None
1166
1541
        return False
1167
1542
    
1168
1543
    def approve(self, value=True):
1169
 
        self.send_changedstate()
1170
1544
        self.approved = value
1171
 
        gobject.timeout_add(timedelta_to_milliseconds
1172
 
                            (self.approval_duration),
1173
 
                            self._reset_approved)
1174
 
    
 
1545
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1546
                                * 1000), self._reset_approved)
 
1547
        self.send_changedstate()
1175
1548
    
1176
1549
    ## D-Bus methods, signals & properties
1177
 
    _interface = "se.recompile.Mandos.Client"
 
1550
    
 
1551
    ## Interfaces
1178
1552
    
1179
1553
    ## Signals
1180
1554
    
1191
1565
        pass
1192
1566
    
1193
1567
    # PropertyChanged - signal
 
1568
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1194
1569
    @dbus.service.signal(_interface, signature="sv")
1195
1570
    def PropertyChanged(self, property, value):
1196
1571
        "D-Bus signal"
1217
1592
        "D-Bus signal"
1218
1593
        return self.need_approval()
1219
1594
    
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
1595
    ## Methods
1229
1596
    
1230
1597
    # Approve - method
1238
1605
        self.checked_ok()
1239
1606
    
1240
1607
    # Enable - method
 
1608
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1241
1609
    @dbus.service.method(_interface)
1242
1610
    def Enable(self):
1243
1611
        "D-Bus method"
1244
1612
        self.enable()
1245
1613
    
1246
1614
    # StartChecker - method
 
1615
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1247
1616
    @dbus.service.method(_interface)
1248
1617
    def StartChecker(self):
1249
1618
        "D-Bus method"
1250
1619
        self.start_checker()
1251
1620
    
1252
1621
    # Disable - method
 
1622
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1253
1623
    @dbus.service.method(_interface)
1254
1624
    def Disable(self):
1255
1625
        "D-Bus method"
1256
1626
        self.disable()
1257
1627
    
1258
1628
    # StopChecker - method
 
1629
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1259
1630
    @dbus.service.method(_interface)
1260
1631
    def StopChecker(self):
1261
1632
        self.stop_checker()
1268
1639
        return dbus.Boolean(bool(self.approvals_pending))
1269
1640
    
1270
1641
    # ApprovedByDefault - property
1271
 
    @dbus_service_property(_interface, signature="b",
 
1642
    @dbus_service_property(_interface,
 
1643
                           signature="b",
1272
1644
                           access="readwrite")
1273
1645
    def ApprovedByDefault_dbus_property(self, value=None):
1274
1646
        if value is None:       # get
1276
1648
        self.approved_by_default = bool(value)
1277
1649
    
1278
1650
    # ApprovalDelay - property
1279
 
    @dbus_service_property(_interface, signature="t",
 
1651
    @dbus_service_property(_interface,
 
1652
                           signature="t",
1280
1653
                           access="readwrite")
1281
1654
    def ApprovalDelay_dbus_property(self, value=None):
1282
1655
        if value is None:       # get
1283
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1656
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1657
                               * 1000)
1284
1658
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1285
1659
    
1286
1660
    # ApprovalDuration - property
1287
 
    @dbus_service_property(_interface, signature="t",
 
1661
    @dbus_service_property(_interface,
 
1662
                           signature="t",
1288
1663
                           access="readwrite")
1289
1664
    def ApprovalDuration_dbus_property(self, value=None):
1290
1665
        if value is None:       # get
1291
 
            return dbus.UInt64(timedelta_to_milliseconds(
1292
 
                    self.approval_duration))
 
1666
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1667
                               * 1000)
1293
1668
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1294
1669
    
1295
1670
    # Name - property
 
1671
    @dbus_annotations(
 
1672
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1296
1673
    @dbus_service_property(_interface, signature="s", access="read")
1297
1674
    def Name_dbus_property(self):
1298
1675
        return dbus.String(self.name)
1299
1676
    
1300
1677
    # Fingerprint - property
 
1678
    @dbus_annotations(
 
1679
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1301
1680
    @dbus_service_property(_interface, signature="s", access="read")
1302
1681
    def Fingerprint_dbus_property(self):
1303
1682
        return dbus.String(self.fingerprint)
1304
1683
    
1305
1684
    # Host - property
1306
 
    @dbus_service_property(_interface, signature="s",
 
1685
    @dbus_service_property(_interface,
 
1686
                           signature="s",
1307
1687
                           access="readwrite")
1308
1688
    def Host_dbus_property(self, value=None):
1309
1689
        if value is None:       # get
1310
1690
            return dbus.String(self.host)
1311
 
        self.host = unicode(value)
 
1691
        self.host = str(value)
1312
1692
    
1313
1693
    # Created - property
 
1694
    @dbus_annotations(
 
1695
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1314
1696
    @dbus_service_property(_interface, signature="s", access="read")
1315
1697
    def Created_dbus_property(self):
1316
1698
        return datetime_to_dbus(self.created)
1321
1703
        return datetime_to_dbus(self.last_enabled)
1322
1704
    
1323
1705
    # Enabled - property
1324
 
    @dbus_service_property(_interface, signature="b",
 
1706
    @dbus_service_property(_interface,
 
1707
                           signature="b",
1325
1708
                           access="readwrite")
1326
1709
    def Enabled_dbus_property(self, value=None):
1327
1710
        if value is None:       # get
1332
1715
            self.disable()
1333
1716
    
1334
1717
    # LastCheckedOK - property
1335
 
    @dbus_service_property(_interface, signature="s",
 
1718
    @dbus_service_property(_interface,
 
1719
                           signature="s",
1336
1720
                           access="readwrite")
1337
1721
    def LastCheckedOK_dbus_property(self, value=None):
1338
1722
        if value is not None:
1340
1724
            return
1341
1725
        return datetime_to_dbus(self.last_checked_ok)
1342
1726
    
 
1727
    # LastCheckerStatus - property
 
1728
    @dbus_service_property(_interface, signature="n", access="read")
 
1729
    def LastCheckerStatus_dbus_property(self):
 
1730
        return dbus.Int16(self.last_checker_status)
 
1731
    
1343
1732
    # Expires - property
1344
1733
    @dbus_service_property(_interface, signature="s", access="read")
1345
1734
    def Expires_dbus_property(self):
1351
1740
        return datetime_to_dbus(self.last_approval_request)
1352
1741
    
1353
1742
    # Timeout - property
1354
 
    @dbus_service_property(_interface, signature="t",
 
1743
    @dbus_service_property(_interface,
 
1744
                           signature="t",
1355
1745
                           access="readwrite")
1356
1746
    def Timeout_dbus_property(self, value=None):
1357
1747
        if value is None:       # get
1358
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1748
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1749
        old_timeout = self.timeout
1359
1750
        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))
 
1751
        # Reschedule disabling
 
1752
        if self.enabled:
 
1753
            now = datetime.datetime.utcnow()
 
1754
            self.expires += self.timeout - old_timeout
 
1755
            if self.expires <= now:
 
1756
                # The timeout has passed
 
1757
                self.disable()
 
1758
            else:
 
1759
                if (getattr(self, "disable_initiator_tag", None)
 
1760
                    is None):
 
1761
                    return
 
1762
                gobject.source_remove(self.disable_initiator_tag)
 
1763
                self.disable_initiator_tag = gobject.timeout_add(
 
1764
                    int((self.expires - now).total_seconds() * 1000),
 
1765
                    self.disable)
1380
1766
    
1381
1767
    # ExtendedTimeout - property
1382
 
    @dbus_service_property(_interface, signature="t",
 
1768
    @dbus_service_property(_interface,
 
1769
                           signature="t",
1383
1770
                           access="readwrite")
1384
1771
    def ExtendedTimeout_dbus_property(self, value=None):
1385
1772
        if value is None:       # get
1386
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1773
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1774
                               * 1000)
1387
1775
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1388
1776
    
1389
1777
    # Interval - property
1390
 
    @dbus_service_property(_interface, signature="t",
 
1778
    @dbus_service_property(_interface,
 
1779
                           signature="t",
1391
1780
                           access="readwrite")
1392
1781
    def Interval_dbus_property(self, value=None):
1393
1782
        if value is None:       # get
1394
 
            return dbus.UInt64(self.interval_milliseconds())
 
1783
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1395
1784
        self.interval = datetime.timedelta(0, 0, 0, value)
1396
1785
        if getattr(self, "checker_initiator_tag", None) is None:
1397
1786
            return
1398
1787
        if self.enabled:
1399
1788
            # Reschedule checker run
1400
1789
            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
 
1790
            self.checker_initiator_tag = gobject.timeout_add(
 
1791
                value, self.start_checker)
 
1792
            self.start_checker() # Start one now, too
1404
1793
    
1405
1794
    # Checker - property
1406
 
    @dbus_service_property(_interface, signature="s",
 
1795
    @dbus_service_property(_interface,
 
1796
                           signature="s",
1407
1797
                           access="readwrite")
1408
1798
    def Checker_dbus_property(self, value=None):
1409
1799
        if value is None:       # get
1410
1800
            return dbus.String(self.checker_command)
1411
 
        self.checker_command = unicode(value)
 
1801
        self.checker_command = str(value)
1412
1802
    
1413
1803
    # CheckerRunning - property
1414
 
    @dbus_service_property(_interface, signature="b",
 
1804
    @dbus_service_property(_interface,
 
1805
                           signature="b",
1415
1806
                           access="readwrite")
1416
1807
    def CheckerRunning_dbus_property(self, value=None):
1417
1808
        if value is None:       # get
1422
1813
            self.stop_checker()
1423
1814
    
1424
1815
    # ObjectPath - property
 
1816
    @dbus_annotations(
 
1817
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
1818
         "org.freedesktop.DBus.Deprecated": "true"})
1425
1819
    @dbus_service_property(_interface, signature="o", access="read")
1426
1820
    def ObjectPath_dbus_property(self):
1427
1821
        return self.dbus_object_path # is already a dbus.ObjectPath
1428
1822
    
1429
1823
    # Secret = property
1430
 
    @dbus_service_property(_interface, signature="ay",
1431
 
                           access="write", byte_arrays=True)
 
1824
    @dbus_annotations(
 
1825
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1826
         "invalidates"})
 
1827
    @dbus_service_property(_interface,
 
1828
                           signature="ay",
 
1829
                           access="write",
 
1830
                           byte_arrays=True)
1432
1831
    def Secret_dbus_property(self, value):
1433
 
        self.secret = str(value)
 
1832
        self.secret = bytes(value)
1434
1833
    
1435
1834
    del _interface
1436
1835
 
1440
1839
        self._pipe = child_pipe
1441
1840
        self._pipe.send(('init', fpr, address))
1442
1841
        if not self._pipe.recv():
1443
 
            raise KeyError()
 
1842
            raise KeyError(fpr)
1444
1843
    
1445
1844
    def __getattribute__(self, name):
1446
1845
        if name == '_pipe':
1450
1849
        if data[0] == 'data':
1451
1850
            return data[1]
1452
1851
        if data[0] == 'function':
 
1852
            
1453
1853
            def func(*args, **kwargs):
1454
1854
                self._pipe.send(('funcall', name, args, kwargs))
1455
1855
                return self._pipe.recv()[1]
 
1856
            
1456
1857
            return func
1457
1858
    
1458
1859
    def __setattr__(self, name, value):
1461
1862
        self._pipe.send(('setattr', name, value))
1462
1863
 
1463
1864
 
1464
 
class ClientDBusTransitional(ClientDBus):
1465
 
    __metaclass__ = AlternateDBusNamesMetaclass
1466
 
 
1467
 
 
1468
1865
class ClientHandler(socketserver.BaseRequestHandler, object):
1469
1866
    """A class to handle client connections.
1470
1867
    
1474
1871
    def handle(self):
1475
1872
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1476
1873
            logger.info("TCP connection from: %s",
1477
 
                        unicode(self.client_address))
 
1874
                        str(self.client_address))
1478
1875
            logger.debug("Pipe FD: %d",
1479
1876
                         self.server.child_pipe.fileno())
1480
1877
            
1481
 
            session = (gnutls.connection
1482
 
                       .ClientSession(self.request,
1483
 
                                      gnutls.connection
1484
 
                                      .X509Credentials()))
 
1878
            session = gnutls.connection.ClientSession(
 
1879
                self.request, gnutls.connection .X509Credentials())
1485
1880
            
1486
1881
            # Note: gnutls.connection.X509Credentials is really a
1487
1882
            # generic GnuTLS certificate credentials object so long as
1496
1891
            priority = self.server.gnutls_priority
1497
1892
            if priority is None:
1498
1893
                priority = "NORMAL"
1499
 
            (gnutls.library.functions
1500
 
             .gnutls_priority_set_direct(session._c_object,
1501
 
                                         priority, None))
 
1894
            gnutls.library.functions.gnutls_priority_set_direct(
 
1895
                session._c_object, priority, None)
1502
1896
            
1503
1897
            # Start communication using the Mandos protocol
1504
1898
            # Get protocol number
1506
1900
            logger.debug("Protocol version: %r", line)
1507
1901
            try:
1508
1902
                if int(line.strip().split()[0]) > 1:
1509
 
                    raise RuntimeError
 
1903
                    raise RuntimeError(line)
1510
1904
            except (ValueError, IndexError, RuntimeError) as error:
1511
1905
                logger.error("Unknown protocol version: %s", error)
1512
1906
                return
1524
1918
            approval_required = False
1525
1919
            try:
1526
1920
                try:
1527
 
                    fpr = self.fingerprint(self.peer_certificate
1528
 
                                           (session))
 
1921
                    fpr = self.fingerprint(
 
1922
                        self.peer_certificate(session))
1529
1923
                except (TypeError,
1530
1924
                        gnutls.errors.GNUTLSError) as error:
1531
1925
                    logger.warning("Bad certificate: %s", error)
1538
1932
                except KeyError:
1539
1933
                    return
1540
1934
                
1541
 
                if self.server.use_dbus:
1542
 
                    # Emit D-Bus signal
1543
 
                    client.NewRequest(str(self.client_address))
1544
 
                
1545
1935
                if client.approval_delay:
1546
1936
                    delay = client.approval_delay
1547
1937
                    client.approvals_pending += 1
1550
1940
                while True:
1551
1941
                    if not client.enabled:
1552
1942
                        logger.info("Client %s is disabled",
1553
 
                                       client.name)
 
1943
                                    client.name)
1554
1944
                        if self.server.use_dbus:
1555
1945
                            # Emit D-Bus signal
1556
1946
                            client.Rejected("Disabled")
1565
1955
                        if self.server.use_dbus:
1566
1956
                            # Emit D-Bus signal
1567
1957
                            client.NeedApproval(
1568
 
                                client.approval_delay_milliseconds(),
1569
 
                                client.approved_by_default)
 
1958
                                client.approval_delay.total_seconds()
 
1959
                                * 1000, client.approved_by_default)
1570
1960
                    else:
1571
1961
                        logger.warning("Client %s was not approved",
1572
1962
                                       client.name)
1578
1968
                    #wait until timeout or approved
1579
1969
                    time = datetime.datetime.now()
1580
1970
                    client.changedstate.acquire()
1581
 
                    (client.changedstate.wait
1582
 
                     (float(client.timedelta_to_milliseconds(delay)
1583
 
                            / 1000)))
 
1971
                    client.changedstate.wait(delay.total_seconds())
1584
1972
                    client.changedstate.release()
1585
1973
                    time2 = datetime.datetime.now()
1586
1974
                    if (time2 - time) >= delay:
1602
1990
                    try:
1603
1991
                        sent = session.send(client.secret[sent_size:])
1604
1992
                    except gnutls.errors.GNUTLSError as error:
1605
 
                        logger.warning("gnutls send failed")
 
1993
                        logger.warning("gnutls send failed",
 
1994
                                       exc_info=error)
1606
1995
                        return
1607
 
                    logger.debug("Sent: %d, remaining: %d",
1608
 
                                 sent, len(client.secret)
1609
 
                                 - (sent_size + sent))
 
1996
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1997
                                 len(client.secret) - (sent_size
 
1998
                                                       + sent))
1610
1999
                    sent_size += sent
1611
2000
                
1612
2001
                logger.info("Sending secret to %s", client.name)
1613
2002
                # bump the timeout using extended_timeout
1614
 
                client.checked_ok(client.extended_timeout)
 
2003
                client.bump_timeout(client.extended_timeout)
1615
2004
                if self.server.use_dbus:
1616
2005
                    # Emit D-Bus signal
1617
2006
                    client.GotSecret()
1622
2011
                try:
1623
2012
                    session.bye()
1624
2013
                except gnutls.errors.GNUTLSError as error:
1625
 
                    logger.warning("GnuTLS bye failed")
 
2014
                    logger.warning("GnuTLS bye failed",
 
2015
                                   exc_info=error)
1626
2016
    
1627
2017
    @staticmethod
1628
2018
    def peer_certificate(session):
1629
2019
        "Return the peer's OpenPGP certificate as a bytestring"
1630
2020
        # If not an OpenPGP certificate...
1631
 
        if (gnutls.library.functions
1632
 
            .gnutls_certificate_type_get(session._c_object)
 
2021
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
2022
                session._c_object)
1633
2023
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1634
2024
            # ...do the normal thing
1635
2025
            return session.peer_certificate
1649
2039
    def fingerprint(openpgp):
1650
2040
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1651
2041
        # 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))))
 
2042
        datum = gnutls.library.types.gnutls_datum_t(
 
2043
            ctypes.cast(ctypes.c_char_p(openpgp),
 
2044
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2045
            ctypes.c_uint(len(openpgp)))
1657
2046
        # New empty GnuTLS certificate
1658
2047
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1659
 
        (gnutls.library.functions
1660
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2048
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
2049
            ctypes.byref(crt))
1661
2050
        # 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))
 
2051
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
2052
            crt, ctypes.byref(datum),
 
2053
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1666
2054
        # Verify the self signature in the key
1667
2055
        crtverify = ctypes.c_uint()
1668
 
        (gnutls.library.functions
1669
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1670
 
                                         ctypes.byref(crtverify)))
 
2056
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
2057
            crt, 0, ctypes.byref(crtverify))
1671
2058
        if crtverify.value != 0:
1672
2059
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1673
 
            raise (gnutls.errors.CertificateSecurityError
1674
 
                   ("Verify failed"))
 
2060
            raise gnutls.errors.CertificateSecurityError(
 
2061
                "Verify failed")
1675
2062
        # New buffer for the fingerprint
1676
2063
        buf = ctypes.create_string_buffer(20)
1677
2064
        buf_len = ctypes.c_size_t()
1678
2065
        # 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)))
 
2066
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
2067
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1682
2068
        # Deinit the certificate
1683
2069
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1684
2070
        # Convert the buffer to a Python bytestring
1690
2076
 
1691
2077
class MultiprocessingMixIn(object):
1692
2078
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2079
    
1693
2080
    def sub_process_main(self, request, address):
1694
2081
        try:
1695
2082
            self.finish_request(request, address)
1700
2087
    def process_request(self, request, address):
1701
2088
        """Start a new process to process the request."""
1702
2089
        proc = multiprocessing.Process(target = self.sub_process_main,
1703
 
                                       args = (request,
1704
 
                                               address))
 
2090
                                       args = (request, address))
1705
2091
        proc.start()
1706
2092
        return proc
1707
2093
 
1708
2094
 
1709
2095
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1710
2096
    """ adds a pipe to the MixIn """
 
2097
    
1711
2098
    def process_request(self, request, client_address):
1712
2099
        """Overrides and wraps the original process_request().
1713
2100
        
1722
2109
    
1723
2110
    def add_pipe(self, parent_pipe, proc):
1724
2111
        """Dummy function; override as necessary"""
1725
 
        raise NotImplementedError
 
2112
        raise NotImplementedError()
1726
2113
 
1727
2114
 
1728
2115
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1734
2121
        interface:      None or a network interface name (string)
1735
2122
        use_ipv6:       Boolean; to use IPv6 or not
1736
2123
    """
 
2124
    
1737
2125
    def __init__(self, server_address, RequestHandlerClass,
1738
 
                 interface=None, use_ipv6=True):
 
2126
                 interface=None,
 
2127
                 use_ipv6=True,
 
2128
                 socketfd=None):
 
2129
        """If socketfd is set, use that file descriptor instead of
 
2130
        creating a new one with socket.socket().
 
2131
        """
1739
2132
        self.interface = interface
1740
2133
        if use_ipv6:
1741
2134
            self.address_family = socket.AF_INET6
 
2135
        if socketfd is not None:
 
2136
            # Save the file descriptor
 
2137
            self.socketfd = socketfd
 
2138
            # Save the original socket.socket() function
 
2139
            self.socket_socket = socket.socket
 
2140
            # To implement --socket, we monkey patch socket.socket.
 
2141
            # 
 
2142
            # (When socketserver.TCPServer is a new-style class, we
 
2143
            # could make self.socket into a property instead of monkey
 
2144
            # patching socket.socket.)
 
2145
            # 
 
2146
            # Create a one-time-only replacement for socket.socket()
 
2147
            @functools.wraps(socket.socket)
 
2148
            def socket_wrapper(*args, **kwargs):
 
2149
                # Restore original function so subsequent calls are
 
2150
                # not affected.
 
2151
                socket.socket = self.socket_socket
 
2152
                del self.socket_socket
 
2153
                # This time only, return a new socket object from the
 
2154
                # saved file descriptor.
 
2155
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
2156
            # Replace socket.socket() function with wrapper
 
2157
            socket.socket = socket_wrapper
 
2158
        # The socketserver.TCPServer.__init__ will call
 
2159
        # socket.socket(), which might be our replacement,
 
2160
        # socket_wrapper(), if socketfd was set.
1742
2161
        socketserver.TCPServer.__init__(self, server_address,
1743
2162
                                        RequestHandlerClass)
 
2163
    
1744
2164
    def server_bind(self):
1745
2165
        """This overrides the normal server_bind() function
1746
2166
        to bind to an interface if one was specified, and also NOT to
1752
2172
                             self.interface)
1753
2173
            else:
1754
2174
                try:
1755
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1756
 
                                           SO_BINDTODEVICE,
1757
 
                                           str(self.interface
1758
 
                                               + '\0'))
 
2175
                    self.socket.setsockopt(
 
2176
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2177
                        (self.interface + "\0").encode("utf-8"))
1759
2178
                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:
 
2179
                    if error.errno == errno.EPERM:
 
2180
                        logger.error("No permission to bind to"
 
2181
                                     " interface %s", self.interface)
 
2182
                    elif error.errno == errno.ENOPROTOOPT:
1765
2183
                        logger.error("SO_BINDTODEVICE not available;"
1766
2184
                                     " cannot bind to interface %s",
1767
2185
                                     self.interface)
 
2186
                    elif error.errno == errno.ENODEV:
 
2187
                        logger.error("Interface %s does not exist,"
 
2188
                                     " cannot bind", self.interface)
1768
2189
                    else:
1769
2190
                        raise
1770
2191
        # Only bind(2) the socket if we really need to.
1773
2194
                if self.address_family == socket.AF_INET6:
1774
2195
                    any_address = "::" # in6addr_any
1775
2196
                else:
1776
 
                    any_address = socket.INADDR_ANY
 
2197
                    any_address = "0.0.0.0" # INADDR_ANY
1777
2198
                self.server_address = (any_address,
1778
2199
                                       self.server_address[1])
1779
2200
            elif not self.server_address[1]:
1780
 
                self.server_address = (self.server_address[0],
1781
 
                                       0)
 
2201
                self.server_address = (self.server_address[0], 0)
1782
2202
#                 if self.interface:
1783
2203
#                     self.server_address = (self.server_address[0],
1784
2204
#                                            0, # port
1798
2218
    
1799
2219
    Assumes a gobject.MainLoop event loop.
1800
2220
    """
 
2221
    
1801
2222
    def __init__(self, server_address, RequestHandlerClass,
1802
 
                 interface=None, use_ipv6=True, clients=None,
1803
 
                 gnutls_priority=None, use_dbus=True):
 
2223
                 interface=None,
 
2224
                 use_ipv6=True,
 
2225
                 clients=None,
 
2226
                 gnutls_priority=None,
 
2227
                 use_dbus=True,
 
2228
                 socketfd=None):
1804
2229
        self.enabled = False
1805
2230
        self.clients = clients
1806
2231
        if self.clients is None:
1810
2235
        IPv6_TCPServer.__init__(self, server_address,
1811
2236
                                RequestHandlerClass,
1812
2237
                                interface = interface,
1813
 
                                use_ipv6 = use_ipv6)
 
2238
                                use_ipv6 = use_ipv6,
 
2239
                                socketfd = socketfd)
 
2240
    
1814
2241
    def server_activate(self):
1815
2242
        if self.enabled:
1816
2243
            return socketserver.TCPServer.server_activate(self)
1820
2247
    
1821
2248
    def add_pipe(self, parent_pipe, proc):
1822
2249
        # 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))
 
2250
        gobject.io_add_watch(
 
2251
            parent_pipe.fileno(),
 
2252
            gobject.IO_IN | gobject.IO_HUP,
 
2253
            functools.partial(self.handle_ipc,
 
2254
                              parent_pipe = parent_pipe,
 
2255
                              proc = proc))
1829
2256
    
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)
 
2257
    def handle_ipc(self, source, condition,
 
2258
                   parent_pipe=None,
 
2259
                   proc = None,
 
2260
                   client_object=None):
1846
2261
        # error, or the other end of multiprocessing.Pipe has closed
1847
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2262
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1848
2263
            # Wait for other process to exit
1849
2264
            proc.join()
1850
2265
            return False
1871
2286
                parent_pipe.send(False)
1872
2287
                return False
1873
2288
            
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))
 
2289
            gobject.io_add_watch(
 
2290
                parent_pipe.fileno(),
 
2291
                gobject.IO_IN | gobject.IO_HUP,
 
2292
                functools.partial(self.handle_ipc,
 
2293
                                  parent_pipe = parent_pipe,
 
2294
                                  proc = proc,
 
2295
                                  client_object = client))
1882
2296
            parent_pipe.send(True)
1883
2297
            # remove the old hook in favor of the new above hook on
1884
2298
            # same fileno
1890
2304
            
1891
2305
            parent_pipe.send(('data', getattr(client_object,
1892
2306
                                              funcname)(*args,
1893
 
                                                         **kwargs)))
 
2307
                                                        **kwargs)))
1894
2308
        
1895
2309
        if command == 'getattr':
1896
2310
            attrname = request[1]
1897
 
            if callable(client_object.__getattribute__(attrname)):
1898
 
                parent_pipe.send(('function',))
 
2311
            if isinstance(client_object.__getattribute__(attrname),
 
2312
                          collections.Callable):
 
2313
                parent_pipe.send(('function', ))
1899
2314
            else:
1900
 
                parent_pipe.send(('data', client_object
1901
 
                                  .__getattribute__(attrname)))
 
2315
                parent_pipe.send((
 
2316
                    'data', client_object.__getattribute__(attrname)))
1902
2317
        
1903
2318
        if command == 'setattr':
1904
2319
            attrname = request[1]
1908
2323
        return True
1909
2324
 
1910
2325
 
 
2326
def rfc3339_duration_to_delta(duration):
 
2327
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2328
    
 
2329
    >>> rfc3339_duration_to_delta("P7D")
 
2330
    datetime.timedelta(7)
 
2331
    >>> rfc3339_duration_to_delta("PT60S")
 
2332
    datetime.timedelta(0, 60)
 
2333
    >>> rfc3339_duration_to_delta("PT60M")
 
2334
    datetime.timedelta(0, 3600)
 
2335
    >>> rfc3339_duration_to_delta("PT24H")
 
2336
    datetime.timedelta(1)
 
2337
    >>> rfc3339_duration_to_delta("P1W")
 
2338
    datetime.timedelta(7)
 
2339
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2340
    datetime.timedelta(0, 330)
 
2341
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2342
    datetime.timedelta(1, 200)
 
2343
    """
 
2344
    
 
2345
    # Parsing an RFC 3339 duration with regular expressions is not
 
2346
    # possible - there would have to be multiple places for the same
 
2347
    # values, like seconds.  The current code, while more esoteric, is
 
2348
    # cleaner without depending on a parsing library.  If Python had a
 
2349
    # built-in library for parsing we would use it, but we'd like to
 
2350
    # avoid excessive use of external libraries.
 
2351
    
 
2352
    # New type for defining tokens, syntax, and semantics all-in-one
 
2353
    Token = collections.namedtuple("Token", (
 
2354
        "regexp",  # To match token; if "value" is not None, must have
 
2355
                   # a "group" containing digits
 
2356
        "value",   # datetime.timedelta or None
 
2357
        "followers"))           # Tokens valid after this token
 
2358
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2359
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2360
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2361
    token_second = Token(re.compile(r"(\d+)S"),
 
2362
                         datetime.timedelta(seconds=1),
 
2363
                         frozenset((token_end, )))
 
2364
    token_minute = Token(re.compile(r"(\d+)M"),
 
2365
                         datetime.timedelta(minutes=1),
 
2366
                         frozenset((token_second, token_end)))
 
2367
    token_hour = Token(re.compile(r"(\d+)H"),
 
2368
                       datetime.timedelta(hours=1),
 
2369
                       frozenset((token_minute, token_end)))
 
2370
    token_time = Token(re.compile(r"T"),
 
2371
                       None,
 
2372
                       frozenset((token_hour, token_minute,
 
2373
                                  token_second)))
 
2374
    token_day = Token(re.compile(r"(\d+)D"),
 
2375
                      datetime.timedelta(days=1),
 
2376
                      frozenset((token_time, token_end)))
 
2377
    token_month = Token(re.compile(r"(\d+)M"),
 
2378
                        datetime.timedelta(weeks=4),
 
2379
                        frozenset((token_day, token_end)))
 
2380
    token_year = Token(re.compile(r"(\d+)Y"),
 
2381
                       datetime.timedelta(weeks=52),
 
2382
                       frozenset((token_month, token_end)))
 
2383
    token_week = Token(re.compile(r"(\d+)W"),
 
2384
                       datetime.timedelta(weeks=1),
 
2385
                       frozenset((token_end, )))
 
2386
    token_duration = Token(re.compile(r"P"), None,
 
2387
                           frozenset((token_year, token_month,
 
2388
                                      token_day, token_time,
 
2389
                                      token_week)))
 
2390
    # Define starting values
 
2391
    value = datetime.timedelta() # Value so far
 
2392
    found_token = None
 
2393
    followers = frozenset((token_duration, )) # Following valid tokens
 
2394
    s = duration                # String left to parse
 
2395
    # Loop until end token is found
 
2396
    while found_token is not token_end:
 
2397
        # Search for any currently valid tokens
 
2398
        for token in followers:
 
2399
            match = token.regexp.match(s)
 
2400
            if match is not None:
 
2401
                # Token found
 
2402
                if token.value is not None:
 
2403
                    # Value found, parse digits
 
2404
                    factor = int(match.group(1), 10)
 
2405
                    # Add to value so far
 
2406
                    value += factor * token.value
 
2407
                # Strip token from string
 
2408
                s = token.regexp.sub("", s, 1)
 
2409
                # Go to found token
 
2410
                found_token = token
 
2411
                # Set valid next tokens
 
2412
                followers = found_token.followers
 
2413
                break
 
2414
        else:
 
2415
            # No currently valid tokens were found
 
2416
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2417
                             .format(duration))
 
2418
    # End token found
 
2419
    return value
 
2420
 
 
2421
 
1911
2422
def string_to_delta(interval):
1912
2423
    """Parse a string and return a datetime.timedelta
1913
2424
    
1924
2435
    >>> string_to_delta('5m 30s')
1925
2436
    datetime.timedelta(0, 330)
1926
2437
    """
 
2438
    
 
2439
    try:
 
2440
        return rfc3339_duration_to_delta(interval)
 
2441
    except ValueError:
 
2442
        pass
 
2443
    
1927
2444
    timevalue = datetime.timedelta(0)
1928
2445
    for s in interval.split():
1929
2446
        try:
1930
 
            suffix = unicode(s[-1])
 
2447
            suffix = s[-1]
1931
2448
            value = int(s[:-1])
1932
2449
            if suffix == "d":
1933
2450
                delta = datetime.timedelta(value)
1940
2457
            elif suffix == "w":
1941
2458
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1942
2459
            else:
1943
 
                raise ValueError("Unknown suffix %r" % suffix)
1944
 
        except (ValueError, IndexError) as e:
 
2460
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2461
        except IndexError as e:
1945
2462
            raise ValueError(*(e.args))
1946
2463
        timevalue += delta
1947
2464
    return timevalue
1960
2477
        sys.exit()
1961
2478
    if not noclose:
1962
2479
        # Close all standard open file descriptors
1963
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2480
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1964
2481
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1965
2482
            raise OSError(errno.ENODEV,
1966
 
                          "%s not a character device"
1967
 
                          % os.path.devnull)
 
2483
                          "{} not a character device"
 
2484
                          .format(os.devnull))
1968
2485
        os.dup2(null, sys.stdin.fileno())
1969
2486
        os.dup2(null, sys.stdout.fileno())
1970
2487
        os.dup2(null, sys.stderr.fileno())
1979
2496
    
1980
2497
    parser = argparse.ArgumentParser()
1981
2498
    parser.add_argument("-v", "--version", action="version",
1982
 
                        version = "%%(prog)s %s" % version,
 
2499
                        version = "%(prog)s {}".format(version),
1983
2500
                        help="show version number and exit")
1984
2501
    parser.add_argument("-i", "--interface", metavar="IF",
1985
2502
                        help="Bind to interface IF")
1991
2508
                        help="Run self-test")
1992
2509
    parser.add_argument("--debug", action="store_true",
1993
2510
                        help="Debug mode; run in foreground and log"
1994
 
                        " to terminal")
 
2511
                        " to terminal", default=None)
1995
2512
    parser.add_argument("--debuglevel", metavar="LEVEL",
1996
2513
                        help="Debug level for stdout output")
1997
2514
    parser.add_argument("--priority", help="GnuTLS"
2004
2521
                        " files")
2005
2522
    parser.add_argument("--no-dbus", action="store_false",
2006
2523
                        dest="use_dbus", help="Do not provide D-Bus"
2007
 
                        " system bus interface")
 
2524
                        " system bus interface", default=None)
2008
2525
    parser.add_argument("--no-ipv6", action="store_false",
2009
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2526
                        dest="use_ipv6", help="Do not use IPv6",
 
2527
                        default=None)
2010
2528
    parser.add_argument("--no-restore", action="store_false",
2011
2529
                        dest="restore", help="Do not restore stored"
2012
 
                        " state")
 
2530
                        " state", default=None)
 
2531
    parser.add_argument("--socket", type=int,
 
2532
                        help="Specify a file descriptor to a network"
 
2533
                        " socket to use instead of creating one")
2013
2534
    parser.add_argument("--statedir", metavar="DIR",
2014
2535
                        help="Directory to save/restore state in")
 
2536
    parser.add_argument("--foreground", action="store_true",
 
2537
                        help="Run in foreground", default=None)
 
2538
    parser.add_argument("--no-zeroconf", action="store_false",
 
2539
                        dest="zeroconf", help="Do not use Zeroconf",
 
2540
                        default=None)
2015
2541
    
2016
2542
    options = parser.parse_args()
2017
2543
    
2018
2544
    if options.check:
2019
2545
        import doctest
2020
 
        doctest.testmod()
2021
 
        sys.exit()
 
2546
        fail_count, test_count = doctest.testmod()
 
2547
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2022
2548
    
2023
2549
    # Default values for config file for server-global settings
2024
2550
    server_defaults = { "interface": "",
2026
2552
                        "port": "",
2027
2553
                        "debug": "False",
2028
2554
                        "priority":
2029
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2555
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2556
                        ":+SIGN-DSA-SHA256",
2030
2557
                        "servicename": "Mandos",
2031
2558
                        "use_dbus": "True",
2032
2559
                        "use_ipv6": "True",
2033
2560
                        "debuglevel": "",
2034
2561
                        "restore": "True",
2035
 
                        "statedir": "/var/lib/mandos"
2036
 
                        }
 
2562
                        "socket": "",
 
2563
                        "statedir": "/var/lib/mandos",
 
2564
                        "foreground": "False",
 
2565
                        "zeroconf": "True",
 
2566
                    }
2037
2567
    
2038
2568
    # Parse config file for server-global settings
2039
2569
    server_config = configparser.SafeConfigParser(server_defaults)
2040
2570
    del server_defaults
2041
 
    server_config.read(os.path.join(options.configdir,
2042
 
                                    "mandos.conf"))
 
2571
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2043
2572
    # Convert the SafeConfigParser object to a dict
2044
2573
    server_settings = server_config.defaults()
2045
2574
    # Use the appropriate methods on the non-string config options
2046
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2575
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2047
2576
        server_settings[option] = server_config.getboolean("DEFAULT",
2048
2577
                                                           option)
2049
2578
    if server_settings["port"]:
2050
2579
        server_settings["port"] = server_config.getint("DEFAULT",
2051
2580
                                                       "port")
 
2581
    if server_settings["socket"]:
 
2582
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2583
                                                         "socket")
 
2584
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2585
        # over with an opened os.devnull.  But we don't want this to
 
2586
        # happen with a supplied network socket.
 
2587
        if 0 <= server_settings["socket"] <= 2:
 
2588
            server_settings["socket"] = os.dup(server_settings
 
2589
                                               ["socket"])
2052
2590
    del server_config
2053
2591
    
2054
2592
    # Override the settings from the config file with command line
2055
2593
    # options, if set.
2056
2594
    for option in ("interface", "address", "port", "debug",
2057
 
                   "priority", "servicename", "configdir",
2058
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2059
 
                   "statedir"):
 
2595
                   "priority", "servicename", "configdir", "use_dbus",
 
2596
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2597
                   "socket", "foreground", "zeroconf"):
2060
2598
        value = getattr(options, option)
2061
2599
        if value is not None:
2062
2600
            server_settings[option] = value
2063
2601
    del options
2064
2602
    # Force all strings to be unicode
2065
2603
    for option in server_settings.keys():
2066
 
        if type(server_settings[option]) is str:
2067
 
            server_settings[option] = unicode(server_settings[option])
 
2604
        if isinstance(server_settings[option], bytes):
 
2605
            server_settings[option] = (server_settings[option]
 
2606
                                       .decode("utf-8"))
 
2607
    # Force all boolean options to be boolean
 
2608
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2609
                   "foreground", "zeroconf"):
 
2610
        server_settings[option] = bool(server_settings[option])
 
2611
    # Debug implies foreground
 
2612
    if server_settings["debug"]:
 
2613
        server_settings["foreground"] = True
2068
2614
    # Now we have our good server settings in "server_settings"
2069
2615
    
2070
2616
    ##################################################################
2071
2617
    
 
2618
    if (not server_settings["zeroconf"]
 
2619
        and not (server_settings["port"]
 
2620
                 or server_settings["socket"] != "")):
 
2621
        parser.error("Needs port or socket to work without Zeroconf")
 
2622
    
2072
2623
    # For convenience
2073
2624
    debug = server_settings["debug"]
2074
2625
    debuglevel = server_settings["debuglevel"]
2076
2627
    use_ipv6 = server_settings["use_ipv6"]
2077
2628
    stored_state_path = os.path.join(server_settings["statedir"],
2078
2629
                                     stored_state_file)
 
2630
    foreground = server_settings["foreground"]
 
2631
    zeroconf = server_settings["zeroconf"]
2079
2632
    
2080
2633
    if debug:
2081
 
        initlogger(logging.DEBUG)
 
2634
        initlogger(debug, logging.DEBUG)
2082
2635
    else:
2083
2636
        if not debuglevel:
2084
 
            initlogger()
 
2637
            initlogger(debug)
2085
2638
        else:
2086
2639
            level = getattr(logging, debuglevel.upper())
2087
 
            initlogger(level)
 
2640
            initlogger(debug, level)
2088
2641
    
2089
2642
    if server_settings["servicename"] != "Mandos":
2090
 
        syslogger.setFormatter(logging.Formatter
2091
 
                               ('Mandos (%s) [%%(process)d]:'
2092
 
                                ' %%(levelname)s: %%(message)s'
2093
 
                                % server_settings["servicename"]))
 
2643
        syslogger.setFormatter(
 
2644
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2645
                              ' %(levelname)s: %(message)s'.format(
 
2646
                                  server_settings["servicename"])))
2094
2647
    
2095
2648
    # Parse config file with clients
2096
 
    client_config = configparser.SafeConfigParser(Client.client_defaults)
 
2649
    client_config = configparser.SafeConfigParser(Client
 
2650
                                                  .client_defaults)
2097
2651
    client_config.read(os.path.join(server_settings["configdir"],
2098
2652
                                    "clients.conf"))
2099
2653
    
2100
2654
    global mandos_dbus_service
2101
2655
    mandos_dbus_service = None
2102
2656
    
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"
 
2657
    socketfd = None
 
2658
    if server_settings["socket"] != "":
 
2659
        socketfd = server_settings["socket"]
 
2660
    tcp_server = MandosServer(
 
2661
        (server_settings["address"], server_settings["port"]),
 
2662
        ClientHandler,
 
2663
        interface=(server_settings["interface"] or None),
 
2664
        use_ipv6=use_ipv6,
 
2665
        gnutls_priority=server_settings["priority"],
 
2666
        use_dbus=use_dbus,
 
2667
        socketfd=socketfd)
 
2668
    if not foreground:
 
2669
        pidfilename = "/run/mandos.pid"
 
2670
        if not os.path.isdir("/run/."):
 
2671
            pidfilename = "/var/run/mandos.pid"
 
2672
        pidfile = None
2114
2673
        try:
2115
 
            pidfile = open(pidfilename, "w")
2116
 
        except IOError:
2117
 
            logger.error("Could not open file %r", pidfilename)
 
2674
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2675
        except IOError as e:
 
2676
            logger.error("Could not open file %r", pidfilename,
 
2677
                         exc_info=e)
2118
2678
    
2119
 
    try:
2120
 
        uid = pwd.getpwnam("_mandos").pw_uid
2121
 
        gid = pwd.getpwnam("_mandos").pw_gid
2122
 
    except KeyError:
 
2679
    for name in ("_mandos", "mandos", "nobody"):
2123
2680
        try:
2124
 
            uid = pwd.getpwnam("mandos").pw_uid
2125
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2681
            uid = pwd.getpwnam(name).pw_uid
 
2682
            gid = pwd.getpwnam(name).pw_gid
 
2683
            break
2126
2684
        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
 
2685
            continue
 
2686
    else:
 
2687
        uid = 65534
 
2688
        gid = 65534
2133
2689
    try:
2134
2690
        os.setgid(gid)
2135
2691
        os.setuid(uid)
2136
2692
    except OSError as error:
2137
 
        if error[0] != errno.EPERM:
2138
 
            raise error
 
2693
        if error.errno != errno.EPERM:
 
2694
            raise
2139
2695
    
2140
2696
    if debug:
2141
2697
        # Enable all possible GnuTLS debugging
2148
2704
        def debug_gnutls(level, string):
2149
2705
            logger.debug("GnuTLS: %s", string[:-1])
2150
2706
        
2151
 
        (gnutls.library.functions
2152
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2707
        gnutls.library.functions.gnutls_global_set_log_function(
 
2708
            debug_gnutls)
2153
2709
        
2154
2710
        # Redirect stdin so all checkers get /dev/null
2155
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2711
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
2712
        os.dup2(null, sys.stdin.fileno())
2157
2713
        if null > 2:
2158
2714
            os.close(null)
2159
 
    else:
2160
 
        # No console logging
2161
 
        logger.removeHandler(console)
2162
2715
    
2163
2716
    # Need to fork before connecting to D-Bus
2164
 
    if not debug:
 
2717
    if not foreground:
2165
2718
        # Close all input and output, do double fork, etc.
2166
2719
        daemon()
2167
2720
    
 
2721
    # multiprocessing will use threads, so before we use gobject we
 
2722
    # need to inform gobject that threads will be used.
2168
2723
    gobject.threads_init()
2169
2724
    
2170
2725
    global main_loop
2171
2726
    # From the Avahi example code
2172
 
    DBusGMainLoop(set_as_default=True )
 
2727
    DBusGMainLoop(set_as_default=True)
2173
2728
    main_loop = gobject.MainLoop()
2174
2729
    bus = dbus.SystemBus()
2175
2730
    # End of Avahi example code
2176
2731
    if use_dbus:
2177
2732
        try:
2178
2733
            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")
 
2734
                                            bus,
 
2735
                                            do_not_queue=True)
 
2736
            old_bus_name = dbus.service.BusName(
 
2737
                "se.bsnet.fukt.Mandos", bus,
 
2738
                do_not_queue=True)
 
2739
        except dbus.exceptions.DBusException as e:
 
2740
            logger.error("Disabling D-Bus:", exc_info=e)
2185
2741
            use_dbus = False
2186
2742
            server_settings["use_dbus"] = False
2187
2743
            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"])))
 
2744
    if zeroconf:
 
2745
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2746
        service = AvahiServiceToSyslog(
 
2747
            name = server_settings["servicename"],
 
2748
            servicetype = "_mandos._tcp",
 
2749
            protocol = protocol,
 
2750
            bus = bus)
 
2751
        if server_settings["interface"]:
 
2752
            service.interface = if_nametoindex(
 
2753
                server_settings["interface"].encode("utf-8"))
2196
2754
    
2197
2755
    global multiprocessing_manager
2198
2756
    multiprocessing_manager = multiprocessing.Manager()
2199
2757
    
2200
2758
    client_class = Client
2201
2759
    if use_dbus:
2202
 
        client_class = functools.partial(ClientDBusTransitional,
2203
 
                                         bus = bus)
 
2760
        client_class = functools.partial(ClientDBus, bus = bus)
2204
2761
    
2205
2762
    client_settings = Client.config_parser(client_config)
2206
2763
    old_client_settings = {}
2207
2764
    clients_data = {}
2208
2765
    
 
2766
    # This is used to redirect stdout and stderr for checker processes
 
2767
    global wnull
 
2768
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2769
    # Only used if server is running in foreground but not in debug
 
2770
    # mode
 
2771
    if debug or not foreground:
 
2772
        wnull.close()
 
2773
    
2209
2774
    # Get client data and settings from last running state.
2210
2775
    if server_settings["restore"]:
2211
2776
        try:
2212
2777
            with open(stored_state_path, "rb") as stored_state:
2213
 
                clients_data, old_client_settings = (pickle.load
2214
 
                                                     (stored_state))
 
2778
                clients_data, old_client_settings = pickle.load(
 
2779
                    stored_state)
2215
2780
            os.remove(stored_state_path)
2216
2781
        except IOError as e:
2217
 
            logger.warning("Could not load persistent state: {0}"
2218
 
                           .format(e))
2219
 
            if e.errno != errno.ENOENT:
 
2782
            if e.errno == errno.ENOENT:
 
2783
                logger.warning("Could not load persistent state:"
 
2784
                               " {}".format(os.strerror(e.errno)))
 
2785
            else:
 
2786
                logger.critical("Could not load persistent state:",
 
2787
                                exc_info=e)
2220
2788
                raise
2221
2789
        except EOFError as e:
2222
2790
            logger.warning("Could not load persistent state: "
2223
 
                           "EOFError: {0}".format(e))
 
2791
                           "EOFError:",
 
2792
                           exc_info=e)
2224
2793
    
2225
2794
    with PGPEngine() as pgp:
2226
 
        for client_name, client in clients_data.iteritems():
 
2795
        for client_name, client in clients_data.items():
 
2796
            # Skip removed clients
 
2797
            if client_name not in client_settings:
 
2798
                continue
 
2799
            
2227
2800
            # Decide which value to use after restoring saved state.
2228
2801
            # We have three different values: Old config file,
2229
2802
            # new config file, and saved state.
2234
2807
                    # For each value in new config, check if it
2235
2808
                    # differs from the old config value (Except for
2236
2809
                    # the "secret" attribute)
2237
 
                    if (name != "secret" and
2238
 
                        value != old_client_settings[client_name]
2239
 
                        [name]):
 
2810
                    if (name != "secret"
 
2811
                        and (value !=
 
2812
                             old_client_settings[client_name][name])):
2240
2813
                        client[name] = value
2241
2814
                except KeyError:
2242
2815
                    pass
2243
2816
            
2244
2817
            # 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.
 
2818
            # enabled if its last checker was successful.  A Client
 
2819
            # whose checker succeeded before we stored its state is
 
2820
            # assumed to have successfully run all checkers during
 
2821
            # downtime.
2248
2822
            if client["enabled"]:
2249
2823
                if datetime.datetime.utcnow() >= client["expires"]:
2250
2824
                    if not client["last_checked_ok"]:
2251
2825
                        logger.warning(
2252
 
                            "disabling client {0} - Client never "
2253
 
                            "performed a successfull checker"
2254
 
                            .format(client["name"]))
 
2826
                            "disabling client {} - Client never "
 
2827
                            "performed a successful checker".format(
 
2828
                                client_name))
2255
2829
                        client["enabled"] = False
2256
2830
                    elif client["last_checker_status"] != 0:
2257
2831
                        logger.warning(
2258
 
                            "disabling client {0} - Client "
2259
 
                            "last checker failed with error code {1}"
2260
 
                            .format(client["name"],
2261
 
                                    client["last_checker_status"]))
 
2832
                            "disabling client {} - Client last"
 
2833
                            " checker failed with error code"
 
2834
                            " {}".format(
 
2835
                                client_name,
 
2836
                                client["last_checker_status"]))
2262
2837
                        client["enabled"] = False
2263
2838
                    else:
2264
 
                        client["expires"] = (datetime.datetime
2265
 
                                             .utcnow()
2266
 
                                             + client["timeout"])
2267
 
                    
 
2839
                        client["expires"] = (
 
2840
                            datetime.datetime.utcnow()
 
2841
                            + client["timeout"])
 
2842
                        logger.debug("Last checker succeeded,"
 
2843
                                     " keeping {} enabled".format(
 
2844
                                         client_name))
2268
2845
            try:
2269
 
                client["secret"] = (
2270
 
                    pgp.decrypt(client["encrypted_secret"],
2271
 
                                client_settings[client_name]
2272
 
                                ["secret"]))
 
2846
                client["secret"] = pgp.decrypt(
 
2847
                    client["encrypted_secret"],
 
2848
                    client_settings[client_name]["secret"])
2273
2849
            except PGPError:
2274
2850
                # 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
 
 
 
2851
                logger.debug("Failed to decrypt {} old secret".format(
 
2852
                    client_name))
 
2853
                client["secret"] = (client_settings[client_name]
 
2854
                                    ["secret"])
2280
2855
    
2281
2856
    # Add/remove clients based on new changes made to config
2282
 
    for client_name in set(old_client_settings) - set(client_settings):
 
2857
    for client_name in (set(old_client_settings)
 
2858
                        - set(client_settings)):
2283
2859
        del clients_data[client_name]
2284
 
    for client_name in set(client_settings) - set(old_client_settings):
 
2860
    for client_name in (set(client_settings)
 
2861
                        - set(old_client_settings)):
2285
2862
        clients_data[client_name] = client_settings[client_name]
2286
 
 
2287
 
    # Create clients all clients
2288
 
    for client_name, client in clients_data.iteritems():
 
2863
    
 
2864
    # Create all client objects
 
2865
    for client_name, client in clients_data.items():
2289
2866
        tcp_server.clients[client_name] = client_class(
2290
 
            name = client_name, settings = client)
 
2867
            name = client_name,
 
2868
            settings = client,
 
2869
            server_settings = server_settings)
2291
2870
    
2292
2871
    if not tcp_server.clients:
2293
2872
        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
 
2873
    
 
2874
    if not foreground:
 
2875
        if pidfile is not None:
 
2876
            pid = os.getpid()
 
2877
            try:
 
2878
                with pidfile:
 
2879
                    print(pid, file=pidfile)
 
2880
            except IOError:
 
2881
                logger.error("Could not write to file %r with PID %d",
 
2882
                             pidfilename, pid)
 
2883
        del pidfile
2307
2884
        del pidfilename
2308
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2309
2885
    
2310
2886
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2311
2887
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2312
2888
    
2313
2889
    if use_dbus:
2314
 
        class MandosDBusService(dbus.service.Object):
 
2890
        
 
2891
        @alternate_dbus_interfaces(
 
2892
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2893
        class MandosDBusService(DBusObjectWithObjectManager):
2315
2894
            """A D-Bus proxy object"""
 
2895
            
2316
2896
            def __init__(self):
2317
2897
                dbus.service.Object.__init__(self, bus, "/")
 
2898
            
2318
2899
            _interface = "se.recompile.Mandos"
2319
2900
            
2320
2901
            @dbus.service.signal(_interface, signature="o")
2327
2908
                "D-Bus signal"
2328
2909
                pass
2329
2910
            
 
2911
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2912
                               "true"})
2330
2913
            @dbus.service.signal(_interface, signature="os")
2331
2914
            def ClientRemoved(self, objpath, name):
2332
2915
                "D-Bus signal"
2333
2916
                pass
2334
2917
            
 
2918
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2919
                               "true"})
2335
2920
            @dbus.service.method(_interface, out_signature="ao")
2336
2921
            def GetAllClients(self):
2337
2922
                "D-Bus method"
2338
 
                return dbus.Array(c.dbus_object_path
2339
 
                                  for c in
 
2923
                return dbus.Array(c.dbus_object_path for c in
2340
2924
                                  tcp_server.clients.itervalues())
2341
2925
            
 
2926
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2927
                               "true"})
2342
2928
            @dbus.service.method(_interface,
2343
2929
                                 out_signature="a{oa{sv}}")
2344
2930
            def GetAllClientsWithProperties(self):
2345
2931
                "D-Bus method"
2346
2932
                return dbus.Dictionary(
2347
 
                    ((c.dbus_object_path, c.GetAll(""))
2348
 
                     for c in tcp_server.clients.itervalues()),
 
2933
                    { c.dbus_object_path: c.GetAll(
 
2934
                        "se.recompile.Mandos.Client")
 
2935
                      for c in tcp_server.clients.itervalues() },
2349
2936
                    signature="oa{sv}")
2350
2937
            
2351
2938
            @dbus.service.method(_interface, in_signature="o")
2355
2942
                    if c.dbus_object_path == object_path:
2356
2943
                        del tcp_server.clients[c.name]
2357
2944
                        c.remove_from_connection()
2358
 
                        # Don't signal anything except ClientRemoved
 
2945
                        # Don't signal the disabling
2359
2946
                        c.disable(quiet=True)
2360
 
                        # Emit D-Bus signal
2361
 
                        self.ClientRemoved(object_path, c.name)
 
2947
                        # Emit D-Bus signal for removal
 
2948
                        self.client_removed_signal(c)
2362
2949
                        return
2363
2950
                raise KeyError(object_path)
2364
2951
            
2365
2952
            del _interface
 
2953
            
 
2954
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
2955
                                 out_signature = "a{oa{sa{sv}}}")
 
2956
            def GetManagedObjects(self):
 
2957
                """D-Bus method"""
 
2958
                return dbus.Dictionary(
 
2959
                    { client.dbus_object_path:
 
2960
                      dbus.Dictionary(
 
2961
                          { interface: client.GetAll(interface)
 
2962
                            for interface in
 
2963
                                 client._get_all_interface_names()})
 
2964
                      for client in tcp_server.clients.values()})
 
2965
            
 
2966
            def client_added_signal(self, client):
 
2967
                """Send the new standard signal and the old signal"""
 
2968
                if use_dbus:
 
2969
                    # New standard signal
 
2970
                    self.InterfacesAdded(
 
2971
                        client.dbus_object_path,
 
2972
                        dbus.Dictionary(
 
2973
                            { interface: client.GetAll(interface)
 
2974
                              for interface in
 
2975
                              client._get_all_interface_names()}))
 
2976
                    # Old signal
 
2977
                    self.ClientAdded(client.dbus_object_path)
 
2978
            
 
2979
            def client_removed_signal(self, client):
 
2980
                """Send the new standard signal and the old signal"""
 
2981
                if use_dbus:
 
2982
                    # New standard signal
 
2983
                    self.InterfacesRemoved(
 
2984
                        client.dbus_object_path,
 
2985
                        client._get_all_interface_names())
 
2986
                    # Old signal
 
2987
                    self.ClientRemoved(client.dbus_object_path,
 
2988
                                       client.name)
2366
2989
        
2367
 
        class MandosDBusServiceTransitional(MandosDBusService):
2368
 
            __metaclass__ = AlternateDBusNamesMetaclass
2369
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2990
        mandos_dbus_service = MandosDBusService()
2370
2991
    
2371
2992
    def cleanup():
2372
2993
        "Cleanup function; run on exit"
2373
 
        service.cleanup()
 
2994
        if zeroconf:
 
2995
            service.cleanup()
2374
2996
        
2375
2997
        multiprocessing.active_children()
 
2998
        wnull.close()
2376
2999
        if not (tcp_server.clients or client_settings):
2377
3000
            return
2378
3001
        
2389
3012
                
2390
3013
                # A list of attributes that can not be pickled
2391
3014
                # + secret.
2392
 
                exclude = set(("bus", "changedstate", "secret",
2393
 
                               "checker"))
2394
 
                for name, typ in (inspect.getmembers
2395
 
                                  (dbus.service.Object)):
 
3015
                exclude = { "bus", "changedstate", "secret",
 
3016
                            "checker", "server_settings" }
 
3017
                for name, typ in inspect.getmembers(dbus.service
 
3018
                                                    .Object):
2396
3019
                    exclude.add(name)
2397
3020
                
2398
3021
                client_dict["encrypted_secret"] = (client
2405
3028
                del client_settings[client.name]["secret"]
2406
3029
        
2407
3030
        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:
 
3031
            with tempfile.NamedTemporaryFile(
 
3032
                    mode='wb',
 
3033
                    suffix=".pickle",
 
3034
                    prefix='clients-',
 
3035
                    dir=os.path.dirname(stored_state_path),
 
3036
                    delete=False) as stored_state:
2413
3037
                pickle.dump((clients, client_settings), stored_state)
 
3038
                tempname = stored_state.name
 
3039
            os.rename(tempname, stored_state_path)
2414
3040
        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)):
 
3041
            if not debug:
 
3042
                try:
 
3043
                    os.remove(tempname)
 
3044
                except NameError:
 
3045
                    pass
 
3046
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
3047
                logger.warning("Could not save persistent state: {}"
 
3048
                               .format(os.strerror(e.errno)))
 
3049
            else:
 
3050
                logger.warning("Could not save persistent state:",
 
3051
                               exc_info=e)
2419
3052
                raise
2420
3053
        
2421
3054
        # Delete all clients, and settings from config
2423
3056
            name, client = tcp_server.clients.popitem()
2424
3057
            if use_dbus:
2425
3058
                client.remove_from_connection()
2426
 
            # Don't signal anything except ClientRemoved
 
3059
            # Don't signal the disabling
2427
3060
            client.disable(quiet=True)
2428
 
            if use_dbus:
2429
 
                # Emit D-Bus signal
2430
 
                mandos_dbus_service.ClientRemoved(client
2431
 
                                                  .dbus_object_path,
2432
 
                                                  client.name)
 
3061
            # Emit D-Bus signal for removal
 
3062
            mandos_dbus_service.client_removed_signal(client)
2433
3063
        client_settings.clear()
2434
3064
    
2435
3065
    atexit.register(cleanup)
2436
3066
    
2437
3067
    for client in tcp_server.clients.itervalues():
2438
3068
        if use_dbus:
2439
 
            # Emit D-Bus signal
2440
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3069
            # Emit D-Bus signal for adding
 
3070
            mandos_dbus_service.client_added_signal(client)
2441
3071
        # Need to initiate checking of clients
2442
3072
        if client.enabled:
2443
3073
            client.init_checker()
2446
3076
    tcp_server.server_activate()
2447
3077
    
2448
3078
    # Find out what port we got
2449
 
    service.port = tcp_server.socket.getsockname()[1]
 
3079
    if zeroconf:
 
3080
        service.port = tcp_server.socket.getsockname()[1]
2450
3081
    if use_ipv6:
2451
3082
        logger.info("Now listening on address %r, port %d,"
2452
 
                    " flowinfo %d, scope_id %d"
2453
 
                    % tcp_server.socket.getsockname())
 
3083
                    " flowinfo %d, scope_id %d",
 
3084
                    *tcp_server.socket.getsockname())
2454
3085
    else:                       # IPv4
2455
 
        logger.info("Now listening on address %r, port %d"
2456
 
                    % tcp_server.socket.getsockname())
 
3086
        logger.info("Now listening on address %r, port %d",
 
3087
                    *tcp_server.socket.getsockname())
2457
3088
    
2458
3089
    #service.interface = tcp_server.socket.getsockname()[3]
2459
3090
    
2460
3091
    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
 
3092
        if zeroconf:
 
3093
            # From the Avahi example code
 
3094
            try:
 
3095
                service.activate()
 
3096
            except dbus.exceptions.DBusException as error:
 
3097
                logger.critical("D-Bus Exception", exc_info=error)
 
3098
                cleanup()
 
3099
                sys.exit(1)
 
3100
            # End of Avahi example code
2469
3101
        
2470
3102
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2471
3103
                             lambda *args, **kwargs:
2475
3107
        logger.debug("Starting main loop")
2476
3108
        main_loop.run()
2477
3109
    except AvahiError as error:
2478
 
        logger.critical("AvahiError: %s", error)
 
3110
        logger.critical("Avahi Error", exc_info=error)
2479
3111
        cleanup()
2480
3112
        sys.exit(1)
2481
3113
    except KeyboardInterrupt:
2486
3118
    # Must run before the D-Bus bus name gets deregistered
2487
3119
    cleanup()
2488
3120
 
 
3121
 
2489
3122
if __name__ == '__main__':
2490
3123
    main()