/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 19:10:26 UTC
  • mfrom: (237.7.335 trunk)
  • Revision ID: teddy@recompile.se-20150810191026-0jss9yy8t6o6pl39
Merge from trunk.

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-2010 Teddy Hogeborn
15
 
# Copyright © 2008-2010 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
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
31
# Contact the authors at <mandos@recompile.se>.
32
32
33
33
 
34
 
from __future__ import division, with_statement, absolute_import
35
 
 
36
 
import SocketServer as socketserver
 
34
from __future__ import (division, absolute_import, print_function,
 
35
                        unicode_literals)
 
36
 
 
37
from future_builtins import *
 
38
 
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
37
43
import socket
38
 
import optparse
 
44
import argparse
39
45
import datetime
40
46
import errno
41
47
import gnutls.crypto
44
50
import gnutls.library.functions
45
51
import gnutls.library.constants
46
52
import gnutls.library.types
47
 
import ConfigParser as configparser
 
53
try:
 
54
    import ConfigParser as configparser
 
55
except ImportError:
 
56
    import configparser
48
57
import sys
49
58
import re
50
59
import os
59
68
import struct
60
69
import fcntl
61
70
import functools
62
 
import cPickle as pickle
 
71
try:
 
72
    import cPickle as pickle
 
73
except ImportError:
 
74
    import pickle
63
75
import multiprocessing
 
76
import types
 
77
import binascii
 
78
import tempfile
 
79
import itertools
 
80
import collections
 
81
import codecs
64
82
 
65
83
import dbus
66
84
import dbus.service
67
 
import gobject
 
85
try:
 
86
    import gobject
 
87
except ImportError:
 
88
    from gi.repository import GObject as gobject
68
89
import avahi
69
90
from dbus.mainloop.glib import DBusGMainLoop
70
91
import ctypes
80
101
    except ImportError:
81
102
        SO_BINDTODEVICE = None
82
103
 
83
 
 
84
 
version = "1.0.14"
85
 
 
86
 
#logger = logging.getLogger(u'mandos')
87
 
logger = logging.Logger(u'mandos')
88
 
syslogger = (logging.handlers.SysLogHandler
89
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
 
              address = "/dev/log"))
91
 
syslogger.setFormatter(logging.Formatter
92
 
                       (u'Mandos [%(process)d]: %(levelname)s:'
93
 
                        u' %(message)s'))
94
 
logger.addHandler(syslogger)
95
 
 
96
 
console = logging.StreamHandler()
97
 
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
 
                                       u' %(levelname)s:'
99
 
                                       u' %(message)s'))
100
 
logger.addHandler(console)
 
104
if sys.version_info.major == 2:
 
105
    str = unicode
 
106
 
 
107
version = "1.6.9"
 
108
stored_state_file = "clients.pickle"
 
109
 
 
110
logger = logging.getLogger()
 
111
syslogger = None
 
112
 
 
113
try:
 
114
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
115
        ctypes.util.find_library("c")).if_nametoindex
 
116
except (OSError, AttributeError):
 
117
    
 
118
    def if_nametoindex(interface):
 
119
        "Get an interface index the hard way, i.e. using fcntl()"
 
120
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
121
        with contextlib.closing(socket.socket()) as s:
 
122
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
123
                                struct.pack(b"16s16x", interface))
 
124
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
125
        return interface_index
 
126
 
 
127
 
 
128
def initlogger(debug, level=logging.WARNING):
 
129
    """init logger and add loglevel"""
 
130
    
 
131
    global syslogger
 
132
    syslogger = (logging.handlers.SysLogHandler(
 
133
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
134
        address = "/dev/log"))
 
135
    syslogger.setFormatter(logging.Formatter
 
136
                           ('Mandos [%(process)d]: %(levelname)s:'
 
137
                            ' %(message)s'))
 
138
    logger.addHandler(syslogger)
 
139
    
 
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)
 
147
    logger.setLevel(level)
 
148
 
 
149
 
 
150
class PGPError(Exception):
 
151
    """Exception if encryption/decryption fails"""
 
152
    pass
 
153
 
 
154
 
 
155
class PGPEngine(object):
 
156
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
157
    
 
158
    def __init__(self):
 
159
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
160
        self.gnupgargs = ['--batch',
 
161
                          '--home', self.tempdir,
 
162
                          '--force-mdc',
 
163
                          '--quiet',
 
164
                          '--no-use-agent']
 
165
    
 
166
    def __enter__(self):
 
167
        return self
 
168
    
 
169
    def __exit__(self, exc_type, exc_value, traceback):
 
170
        self._cleanup()
 
171
        return False
 
172
    
 
173
    def __del__(self):
 
174
        self._cleanup()
 
175
    
 
176
    def _cleanup(self):
 
177
        if self.tempdir is not None:
 
178
            # Delete contents of tempdir
 
179
            for root, dirs, files in os.walk(self.tempdir,
 
180
                                             topdown = False):
 
181
                for filename in files:
 
182
                    os.remove(os.path.join(root, filename))
 
183
                for dirname in dirs:
 
184
                    os.rmdir(os.path.join(root, dirname))
 
185
            # Remove tempdir
 
186
            os.rmdir(self.tempdir)
 
187
            self.tempdir = None
 
188
    
 
189
    def password_encode(self, password):
 
190
        # Passphrase can not be empty and can not contain newlines or
 
191
        # NUL bytes.  So we prefix it and hex encode it.
 
192
        encoded = b"mandos" + binascii.hexlify(password)
 
193
        if len(encoded) > 2048:
 
194
            # GnuPG can't handle long passwords, so encode differently
 
195
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
196
                       .replace(b"\n", b"\\n")
 
197
                       .replace(b"\0", b"\\x00"))
 
198
        return encoded
 
199
    
 
200
    def encrypt(self, data, password):
 
201
        passphrase = self.password_encode(password)
 
202
        with tempfile.NamedTemporaryFile(
 
203
                dir=self.tempdir) as passfile:
 
204
            passfile.write(passphrase)
 
205
            passfile.flush()
 
206
            proc = subprocess.Popen(['gpg', '--symmetric',
 
207
                                     '--passphrase-file',
 
208
                                     passfile.name]
 
209
                                    + self.gnupgargs,
 
210
                                    stdin = subprocess.PIPE,
 
211
                                    stdout = subprocess.PIPE,
 
212
                                    stderr = subprocess.PIPE)
 
213
            ciphertext, err = proc.communicate(input = data)
 
214
        if proc.returncode != 0:
 
215
            raise PGPError(err)
 
216
        return ciphertext
 
217
    
 
218
    def decrypt(self, data, password):
 
219
        passphrase = self.password_encode(password)
 
220
        with tempfile.NamedTemporaryFile(
 
221
                dir = self.tempdir) as passfile:
 
222
            passfile.write(passphrase)
 
223
            passfile.flush()
 
224
            proc = subprocess.Popen(['gpg', '--decrypt',
 
225
                                     '--passphrase-file',
 
226
                                     passfile.name]
 
227
                                    + self.gnupgargs,
 
228
                                    stdin = subprocess.PIPE,
 
229
                                    stdout = subprocess.PIPE,
 
230
                                    stderr = subprocess.PIPE)
 
231
            decrypted_plaintext, err = proc.communicate(input = data)
 
232
        if proc.returncode != 0:
 
233
            raise PGPError(err)
 
234
        return decrypted_plaintext
 
235
 
101
236
 
102
237
class AvahiError(Exception):
103
238
    def __init__(self, value, *args, **kwargs):
104
239
        self.value = value
105
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
106
 
    def __unicode__(self):
107
 
        return unicode(repr(self.value))
 
240
        return super(AvahiError, self).__init__(value, *args,
 
241
                                                **kwargs)
 
242
 
108
243
 
109
244
class AvahiServiceError(AvahiError):
110
245
    pass
111
246
 
 
247
 
112
248
class AvahiGroupError(AvahiError):
113
249
    pass
114
250
 
119
255
    Attributes:
120
256
    interface: integer; avahi.IF_UNSPEC or an interface index.
121
257
               Used to optionally bind to the specified interface.
122
 
    name: string; Example: u'Mandos'
123
 
    type: string; Example: u'_mandos._tcp'.
124
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
258
    name: string; Example: 'Mandos'
 
259
    type: string; Example: '_mandos._tcp'.
 
260
     See <https://www.iana.org/assignments/service-names-port-numbers>
125
261
    port: integer; what port to announce
126
262
    TXT: list of strings; TXT record for the service
127
263
    domain: string; Domain to publish on, default to .local if empty.
133
269
    server: D-Bus Server
134
270
    bus: dbus.SystemBus()
135
271
    """
136
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
137
 
                 servicetype = None, port = None, TXT = None,
138
 
                 domain = u"", host = u"", max_renames = 32768,
139
 
                 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):
140
284
        self.interface = interface
141
285
        self.name = name
142
286
        self.type = servicetype
150
294
        self.group = None       # our entry group
151
295
        self.server = None
152
296
        self.bus = bus
153
 
    def rename(self):
 
297
        self.entry_group_state_changed_match = None
 
298
    
 
299
    def rename(self, remove=True):
154
300
        """Derived from the Avahi example code"""
155
301
        if self.rename_count >= self.max_renames:
156
 
            logger.critical(u"No suitable Zeroconf service name found"
157
 
                            u" after %i retries, exiting.",
 
302
            logger.critical("No suitable Zeroconf service name found"
 
303
                            " after %i retries, exiting.",
158
304
                            self.rename_count)
159
 
            raise AvahiServiceError(u"Too many renames")
160
 
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
161
 
        logger.info(u"Changing Zeroconf service name to %r ...",
 
305
            raise AvahiServiceError("Too many renames")
 
306
        self.name = str(
 
307
            self.server.GetAlternativeServiceName(self.name))
 
308
        self.rename_count += 1
 
309
        logger.info("Changing Zeroconf service name to %r ...",
162
310
                    self.name)
163
 
        syslogger.setFormatter(logging.Formatter
164
 
                               (u'Mandos (%s) [%%(process)d]:'
165
 
                                u' %%(levelname)s: %%(message)s'
166
 
                                % self.name))
167
 
        self.remove()
 
311
        if remove:
 
312
            self.remove()
168
313
        try:
169
314
            self.add()
170
 
        except dbus.exceptions.DBusException, error:
171
 
            logger.critical(u"DBusException: %s", error)
172
 
            self.cleanup()
173
 
            os._exit(1)
174
 
        self.rename_count += 1
 
315
        except dbus.exceptions.DBusException as error:
 
316
            if (error.get_dbus_name()
 
317
                == "org.freedesktop.Avahi.CollisionError"):
 
318
                logger.info("Local Zeroconf service name collision.")
 
319
                return self.rename(remove=False)
 
320
            else:
 
321
                logger.critical("D-Bus Exception", exc_info=error)
 
322
                self.cleanup()
 
323
                os._exit(1)
 
324
    
175
325
    def remove(self):
176
326
        """Derived from the Avahi example code"""
 
327
        if self.entry_group_state_changed_match is not None:
 
328
            self.entry_group_state_changed_match.remove()
 
329
            self.entry_group_state_changed_match = None
177
330
        if self.group is not None:
178
331
            self.group.Reset()
 
332
    
179
333
    def add(self):
180
334
        """Derived from the Avahi example code"""
 
335
        self.remove()
181
336
        if self.group is None:
182
337
            self.group = dbus.Interface(
183
338
                self.bus.get_object(avahi.DBUS_NAME,
184
339
                                    self.server.EntryGroupNew()),
185
340
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
186
 
            self.group.connect_to_signal('StateChanged',
187
 
                                         self
188
 
                                         .entry_group_state_changed)
189
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
 
341
        self.entry_group_state_changed_match = (
 
342
            self.group.connect_to_signal(
 
343
                'StateChanged', self.entry_group_state_changed))
 
344
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
190
345
                     self.name, self.type)
191
346
        self.group.AddService(
192
347
            self.interface,
197
352
            dbus.UInt16(self.port),
198
353
            avahi.string_array_to_txt_array(self.TXT))
199
354
        self.group.Commit()
 
355
    
200
356
    def entry_group_state_changed(self, state, error):
201
357
        """Derived from the Avahi example code"""
202
 
        logger.debug(u"Avahi entry group state change: %i", state)
 
358
        logger.debug("Avahi entry group state change: %i", state)
203
359
        
204
360
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
205
 
            logger.debug(u"Zeroconf service established.")
 
361
            logger.debug("Zeroconf service established.")
206
362
        elif state == avahi.ENTRY_GROUP_COLLISION:
207
 
            logger.warning(u"Zeroconf service name collision.")
 
363
            logger.info("Zeroconf service name collision.")
208
364
            self.rename()
209
365
        elif state == avahi.ENTRY_GROUP_FAILURE:
210
 
            logger.critical(u"Avahi: Error in group state changed %s",
211
 
                            unicode(error))
212
 
            raise AvahiGroupError(u"State changed: %s"
213
 
                                  % unicode(error))
 
366
            logger.critical("Avahi: Error in group state changed %s",
 
367
                            str(error))
 
368
            raise AvahiGroupError("State changed: {!s}".format(error))
 
369
    
214
370
    def cleanup(self):
215
371
        """Derived from the Avahi example code"""
216
372
        if self.group is not None:
217
 
            self.group.Free()
 
373
            try:
 
374
                self.group.Free()
 
375
            except (dbus.exceptions.UnknownMethodException,
 
376
                    dbus.exceptions.DBusException):
 
377
                pass
218
378
            self.group = None
219
 
    def server_state_changed(self, state):
 
379
        self.remove()
 
380
    
 
381
    def server_state_changed(self, state, error=None):
220
382
        """Derived from the Avahi example code"""
221
 
        logger.debug(u"Avahi server state change: %i", state)
222
 
        if state == avahi.SERVER_COLLISION:
223
 
            logger.error(u"Zeroconf server name collision")
224
 
            self.remove()
 
383
        logger.debug("Avahi server state change: %i", state)
 
384
        bad_states = {
 
385
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
386
            avahi.SERVER_REGISTERING: None,
 
387
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
388
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
389
        }
 
390
        if state in bad_states:
 
391
            if bad_states[state] is not None:
 
392
                if error is None:
 
393
                    logger.error(bad_states[state])
 
394
                else:
 
395
                    logger.error(bad_states[state] + ": %r", error)
 
396
            self.cleanup()
225
397
        elif state == avahi.SERVER_RUNNING:
226
 
            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)
 
410
        else:
 
411
            if error is None:
 
412
                logger.debug("Unknown state: %r", state)
 
413
            else:
 
414
                logger.debug("Unknown state: %r: %r", state, error)
 
415
    
227
416
    def activate(self):
228
417
        """Derived from the Avahi example code"""
229
418
        if self.server is None:
230
419
            self.server = dbus.Interface(
231
420
                self.bus.get_object(avahi.DBUS_NAME,
232
 
                                    avahi.DBUS_PATH_SERVER),
 
421
                                    avahi.DBUS_PATH_SERVER,
 
422
                                    follow_name_owner_changes=True),
233
423
                avahi.DBUS_INTERFACE_SERVER)
234
 
        self.server.connect_to_signal(u"StateChanged",
235
 
                                 self.server_state_changed)
 
424
        self.server.connect_to_signal("StateChanged",
 
425
                                      self.server_state_changed)
236
426
        self.server_state_changed(self.server.GetState())
237
427
 
238
428
 
 
429
class AvahiServiceToSyslog(AvahiService):
 
430
    def rename(self, *args, **kwargs):
 
431
        """Add the new name to the syslog messages"""
 
432
        ret = AvahiService.rename(self, *args, **kwargs)
 
433
        syslogger.setFormatter(logging.Formatter(
 
434
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
435
            .format(self.name)))
 
436
        return ret
 
437
 
 
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
 
239
448
class Client(object):
240
449
    """A representation of a client host served by this server.
241
450
    
242
451
    Attributes:
243
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
452
    approved:   bool(); 'None' if not yet approved/disapproved
244
453
    approval_delay: datetime.timedelta(); Time to wait for approval
245
454
    approval_duration: datetime.timedelta(); Duration of one approval
246
455
    checker:    subprocess.Popen(); a running checker process used
253
462
                     instance %(name)s can be used in the command.
254
463
    checker_initiator_tag: a gobject event source tag, or None
255
464
    created:    datetime.datetime(); (UTC) object creation
 
465
    client_structure: Object describing what attributes a client has
 
466
                      and is used for storing the client at exit
256
467
    current_checker_command: string; current running checker_command
257
 
    disable_hook:  If set, called by disable() as disable_hook(self)
258
468
    disable_initiator_tag: a gobject event source tag, or None
259
469
    enabled:    bool()
260
470
    fingerprint: string (40 or 32 hexadecimal digits); used to
263
473
    interval:   datetime.timedelta(); How often to start a new checker
264
474
    last_approval_request: datetime.datetime(); (UTC) or None
265
475
    last_checked_ok: datetime.datetime(); (UTC) or None
266
 
    last_enabled: datetime.datetime(); (UTC)
 
476
    last_checker_status: integer between 0 and 255 reflecting exit
 
477
                         status of last checker. -1 reflects crashed
 
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
 
481
    last_enabled: datetime.datetime(); (UTC) or None
267
482
    name:       string; from the config file, used in log messages and
268
483
                        D-Bus identifiers
269
484
    secret:     bytestring; sent verbatim (over TLS) to client
270
485
    timeout:    datetime.timedelta(); How long from last_checked_ok
271
486
                                      until this client is disabled
 
487
    extended_timeout:   extra long timeout when secret has been sent
272
488
    runtime_expansions: Allowed attributes for runtime expansion.
 
489
    expires:    datetime.datetime(); time (UTC) when a client will be
 
490
                disabled, or None
 
491
    server_settings: The server_settings dict from main()
273
492
    """
274
493
    
275
 
    runtime_expansions = (u"approval_delay", u"approval_duration",
276
 
                          u"created", u"enabled", u"fingerprint",
277
 
                          u"host", u"interval", u"last_checked_ok",
278
 
                          u"last_enabled", u"name", u"timeout")
 
494
    runtime_expansions = ("approval_delay", "approval_duration",
 
495
                          "created", "enabled", "expires",
 
496
                          "fingerprint", "host", "interval",
 
497
                          "last_approval_request", "last_checked_ok",
 
498
                          "last_enabled", "name", "timeout")
 
499
    client_defaults = {
 
500
        "timeout": "PT5M",
 
501
        "extended_timeout": "PT15M",
 
502
        "interval": "PT2M",
 
503
        "checker": "fping -q -- %%(host)s",
 
504
        "host": "",
 
505
        "approval_delay": "PT0S",
 
506
        "approval_duration": "PT1S",
 
507
        "approved_by_default": "True",
 
508
        "enabled": "True",
 
509
    }
279
510
    
280
511
    @staticmethod
281
 
    def _timedelta_to_milliseconds(td):
282
 
        "Convert a datetime.timedelta() to milliseconds"
283
 
        return ((td.days * 24 * 60 * 60 * 1000)
284
 
                + (td.seconds * 1000)
285
 
                + (td.microseconds // 1000))
286
 
    
287
 
    def timeout_milliseconds(self):
288
 
        "Return the 'timeout' attribute in milliseconds"
289
 
        return self._timedelta_to_milliseconds(self.timeout)
290
 
    
291
 
    def interval_milliseconds(self):
292
 
        "Return the 'interval' attribute in milliseconds"
293
 
        return self._timedelta_to_milliseconds(self.interval)
294
 
 
295
 
    def approval_delay_milliseconds(self):
296
 
        return self._timedelta_to_milliseconds(self.approval_delay)
297
 
    
298
 
    def __init__(self, name = None, disable_hook=None, config=None):
299
 
        """Note: the 'checker' key in 'config' sets the
300
 
        'checker_command' attribute and *not* the 'checker'
301
 
        attribute."""
 
512
    def config_parser(config):
 
513
        """Construct a new dict of client settings of this form:
 
514
        { client_name: {setting_name: value, ...}, ...}
 
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
        """
 
519
        settings = {}
 
520
        for client_name in config.sections():
 
521
            section = dict(config.items(client_name))
 
522
            client = settings[client_name] = {}
 
523
            
 
524
            client["host"] = section["host"]
 
525
            # Reformat values from string types to Python types
 
526
            client["approved_by_default"] = config.getboolean(
 
527
                client_name, "approved_by_default")
 
528
            client["enabled"] = config.getboolean(client_name,
 
529
                                                  "enabled")
 
530
            
 
531
            # Uppercase and remove spaces from fingerprint for later
 
532
            # comparison purposes with return value from the
 
533
            # fingerprint() function
 
534
            client["fingerprint"] = (section["fingerprint"].upper()
 
535
                                     .replace(" ", ""))
 
536
            if "secret" in section:
 
537
                client["secret"] = section["secret"].decode("base64")
 
538
            elif "secfile" in section:
 
539
                with open(os.path.expanduser(os.path.expandvars
 
540
                                             (section["secfile"])),
 
541
                          "rb") as secfile:
 
542
                    client["secret"] = secfile.read()
 
543
            else:
 
544
                raise TypeError("No secret or secfile for section {}"
 
545
                                .format(section))
 
546
            client["timeout"] = string_to_delta(section["timeout"])
 
547
            client["extended_timeout"] = string_to_delta(
 
548
                section["extended_timeout"])
 
549
            client["interval"] = string_to_delta(section["interval"])
 
550
            client["approval_delay"] = string_to_delta(
 
551
                section["approval_delay"])
 
552
            client["approval_duration"] = string_to_delta(
 
553
                section["approval_duration"])
 
554
            client["checker_command"] = section["checker"]
 
555
            client["last_approval_request"] = None
 
556
            client["last_checked_ok"] = None
 
557
            client["last_checker_status"] = -2
 
558
        
 
559
        return settings
 
560
    
 
561
    def __init__(self, settings, name = None, server_settings=None):
302
562
        self.name = name
303
 
        if config is None:
304
 
            config = {}
305
 
        logger.debug(u"Creating client %r", self.name)
306
 
        # Uppercase and remove spaces from fingerprint for later
307
 
        # comparison purposes with return value from the fingerprint()
308
 
        # function
309
 
        self.fingerprint = (config[u"fingerprint"].upper()
310
 
                            .replace(u" ", u""))
311
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
312
 
        if u"secret" in config:
313
 
            self.secret = config[u"secret"].decode(u"base64")
314
 
        elif u"secfile" in config:
315
 
            with open(os.path.expanduser(os.path.expandvars
316
 
                                         (config[u"secfile"])),
317
 
                      "rb") as secfile:
318
 
                self.secret = secfile.read()
 
563
        if server_settings is None:
 
564
            server_settings = {}
 
565
        self.server_settings = server_settings
 
566
        # adding all client settings
 
567
        for setting, value in settings.items():
 
568
            setattr(self, setting, value)
 
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)
319
576
        else:
320
 
            raise TypeError(u"No secret or secfile for client %s"
321
 
                            % self.name)
322
 
        self.host = config.get(u"host", u"")
323
 
        self.created = datetime.datetime.utcnow()
324
 
        self.enabled = False
325
 
        self.last_approval_request = None
326
 
        self.last_enabled = None
327
 
        self.last_checked_ok = None
328
 
        self.timeout = string_to_delta(config[u"timeout"])
329
 
        self.interval = string_to_delta(config[u"interval"])
330
 
        self.disable_hook = disable_hook
 
577
            self.last_enabled = None
 
578
            self.expires = None
 
579
        
 
580
        logger.debug("Creating client %r", self.name)
 
581
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
582
        self.created = settings.get("created",
 
583
                                    datetime.datetime.utcnow())
 
584
        
 
585
        # attributes specific for this server instance
331
586
        self.checker = None
332
587
        self.checker_initiator_tag = None
333
588
        self.disable_initiator_tag = None
334
589
        self.checker_callback_tag = None
335
 
        self.checker_command = config[u"checker"]
336
590
        self.current_checker_command = None
337
 
        self.last_connect = None
338
 
        self._approved = None
339
 
        self.approved_by_default = config.get(u"approved_by_default",
340
 
                                              True)
 
591
        self.approved = None
341
592
        self.approvals_pending = 0
342
 
        self.approval_delay = string_to_delta(
343
 
            config[u"approval_delay"])
344
 
        self.approval_duration = string_to_delta(
345
 
            config[u"approval_duration"])
346
 
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
 
593
        self.changedstate = multiprocessing_manager.Condition(
 
594
            multiprocessing_manager.Lock())
 
595
        self.client_structure = [attr
 
596
                                 for attr in self.__dict__.iterkeys()
 
597
                                 if not attr.startswith("_")]
 
598
        self.client_structure.append("client_structure")
 
599
        
 
600
        for name, t in inspect.getmembers(
 
601
                type(self), lambda obj: isinstance(obj, property)):
 
602
            if not name.startswith("_"):
 
603
                self.client_structure.append(name)
347
604
    
 
605
    # Send notice to process children that client state has changed
348
606
    def send_changedstate(self):
349
 
        self.changedstate.acquire()
350
 
        self.changedstate.notify_all()
351
 
        self.changedstate.release()
352
 
        
 
607
        with self.changedstate:
 
608
            self.changedstate.notify_all()
 
609
    
353
610
    def enable(self):
354
611
        """Start this client's checker and timeout hooks"""
355
 
        if getattr(self, u"enabled", False):
 
612
        if getattr(self, "enabled", False):
356
613
            # Already enabled
357
614
            return
358
 
        self.send_changedstate()
 
615
        self.expires = datetime.datetime.utcnow() + self.timeout
 
616
        self.enabled = True
359
617
        self.last_enabled = datetime.datetime.utcnow()
360
 
        # Schedule a new checker to be started an 'interval' from now,
361
 
        # and every interval from then on.
362
 
        self.checker_initiator_tag = (gobject.timeout_add
363
 
                                      (self.interval_milliseconds(),
364
 
                                       self.start_checker))
365
 
        # Schedule a disable() when 'timeout' has passed
366
 
        self.disable_initiator_tag = (gobject.timeout_add
367
 
                                   (self.timeout_milliseconds(),
368
 
                                    self.disable))
369
 
        self.enabled = True
370
 
        # Also start a new checker *right now*.
371
 
        self.start_checker()
 
618
        self.init_checker()
 
619
        self.send_changedstate()
372
620
    
373
621
    def disable(self, quiet=True):
374
622
        """Disable this client."""
375
623
        if not getattr(self, "enabled", False):
376
624
            return False
377
625
        if not quiet:
 
626
            logger.info("Disabling client %s", self.name)
 
627
        if getattr(self, "disable_initiator_tag", None) is not None:
 
628
            gobject.source_remove(self.disable_initiator_tag)
 
629
            self.disable_initiator_tag = None
 
630
        self.expires = None
 
631
        if getattr(self, "checker_initiator_tag", None) is not None:
 
632
            gobject.source_remove(self.checker_initiator_tag)
 
633
            self.checker_initiator_tag = None
 
634
        self.stop_checker()
 
635
        self.enabled = False
 
636
        if not quiet:
378
637
            self.send_changedstate()
379
 
        if not quiet:
380
 
            logger.info(u"Disabling client %s", self.name)
381
 
        if getattr(self, u"disable_initiator_tag", False):
382
 
            gobject.source_remove(self.disable_initiator_tag)
383
 
            self.disable_initiator_tag = None
384
 
        if getattr(self, u"checker_initiator_tag", False):
385
 
            gobject.source_remove(self.checker_initiator_tag)
386
 
            self.checker_initiator_tag = None
387
 
        self.stop_checker()
388
 
        if self.disable_hook:
389
 
            self.disable_hook(self)
390
 
        self.enabled = False
391
638
        # Do not run this again if called by a gobject.timeout_add
392
639
        return False
393
640
    
394
641
    def __del__(self):
395
 
        self.disable_hook = None
396
642
        self.disable()
397
643
    
398
 
    def checker_callback(self, pid, condition, command):
 
644
    def init_checker(self):
 
645
        # Schedule a new checker to be started an 'interval' from now,
 
646
        # and every interval from then on.
 
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)
 
652
        # Schedule a disable() when 'timeout' has passed
 
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)
 
657
        # Also start a new checker *right now*.
 
658
        self.start_checker()
 
659
    
 
660
    def checker_callback(self, source, condition, connection,
 
661
                         command):
399
662
        """The checker has completed, so take appropriate actions."""
400
663
        self.checker_callback_tag = None
401
664
        self.checker = None
402
 
        if os.WIFEXITED(condition):
403
 
            exitstatus = os.WEXITSTATUS(condition)
404
 
            if exitstatus == 0:
405
 
                logger.info(u"Checker for %(name)s succeeded",
 
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
 
672
            if self.last_checker_status == 0:
 
673
                logger.info("Checker for %(name)s succeeded",
406
674
                            vars(self))
407
675
                self.checked_ok()
408
676
            else:
409
 
                logger.info(u"Checker for %(name)s failed",
410
 
                            vars(self))
 
677
                logger.info("Checker for %(name)s failed", vars(self))
411
678
        else:
412
 
            logger.warning(u"Checker for %(name)s crashed?",
 
679
            self.last_checker_status = -1
 
680
            self.last_checker_signal = -returncode
 
681
            logger.warning("Checker for %(name)s crashed?",
413
682
                           vars(self))
 
683
        return False
414
684
    
415
685
    def checked_ok(self):
416
 
        """Bump up the timeout for this client.
417
 
        
418
 
        This should only be called when the client has been seen,
419
 
        alive and well.
420
 
        """
 
686
        """Assert that the client has been seen, alive and well."""
421
687
        self.last_checked_ok = datetime.datetime.utcnow()
422
 
        gobject.source_remove(self.disable_initiator_tag)
423
 
        self.disable_initiator_tag = (gobject.timeout_add
424
 
                                      (self.timeout_milliseconds(),
425
 
                                       self.disable))
 
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."""
 
694
        if timeout is None:
 
695
            timeout = self.timeout
 
696
        if self.disable_initiator_tag is not None:
 
697
            gobject.source_remove(self.disable_initiator_tag)
 
698
            self.disable_initiator_tag = None
 
699
        if getattr(self, "enabled", False):
 
700
            self.disable_initiator_tag = gobject.timeout_add(
 
701
                int(timeout.total_seconds() * 1000), self.disable)
 
702
            self.expires = datetime.datetime.utcnow() + timeout
426
703
    
427
704
    def need_approval(self):
428
705
        self.last_approval_request = datetime.datetime.utcnow()
433
710
        If a checker already exists, leave it running and do
434
711
        nothing."""
435
712
        # The reason for not killing a running checker is that if we
436
 
        # did that, then if a checker (for some reason) started
437
 
        # running slowly and taking more than 'interval' time, the
438
 
        # client would inevitably timeout, since no checker would get
439
 
        # 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
440
717
        # checkers alone, the checker would have to take more time
441
718
        # than 'timeout' for the client to be disabled, which is as it
442
719
        # should be.
443
720
        
444
 
        # If a checker exists, make sure it is not a zombie
445
 
        try:
446
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
447
 
        except (AttributeError, OSError), error:
448
 
            if (isinstance(error, OSError)
449
 
                and error.errno != errno.ECHILD):
450
 
                raise error
451
 
        else:
452
 
            if pid:
453
 
                logger.warning(u"Checker was a zombie")
454
 
                gobject.source_remove(self.checker_callback_tag)
455
 
                self.checker_callback(pid, status,
456
 
                                      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
457
725
        # Start a new checker if needed
458
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 }
459
731
            try:
460
 
                # In case checker_command has exactly one % operator
461
 
                command = self.checker_command % self.host
462
 
            except TypeError:
463
 
                # Escape attributes for the shell
464
 
                escaped_attrs = dict(
465
 
                    (attr,
466
 
                     re.escape(unicode(str(getattr(self, attr, u"")),
467
 
                                       errors=
468
 
                                       u'replace')))
469
 
                    for attr in
470
 
                    self.runtime_expansions)
471
 
 
472
 
                try:
473
 
                    command = self.checker_command % escaped_attrs
474
 
                except TypeError, error:
475
 
                    logger.error(u'Could not format string "%s":'
476
 
                                 u' %s', self.checker_command, error)
477
 
                    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
478
738
            self.current_checker_command = command
479
 
            try:
480
 
                logger.info(u"Starting checker %r for %s",
481
 
                            command, self.name)
482
 
                # We don't need to redirect stdout and stderr, since
483
 
                # in normal mode, that is already done by daemon(),
484
 
                # and in debug mode we don't want to.  (Stdin is
485
 
                # always replaced by /dev/null.)
486
 
                self.checker = subprocess.Popen(command,
487
 
                                                close_fds=True,
488
 
                                                shell=True, cwd=u"/")
489
 
                self.checker_callback_tag = (gobject.child_watch_add
490
 
                                             (self.checker.pid,
491
 
                                              self.checker_callback,
492
 
                                              data=command))
493
 
                # The checker may have completed before the gobject
494
 
                # watch was added.  Check for this.
495
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
496
 
                if pid:
497
 
                    gobject.source_remove(self.checker_callback_tag)
498
 
                    self.checker_callback(pid, status, command)
499
 
            except OSError, error:
500
 
                logger.error(u"Failed to start subprocess: %s",
501
 
                             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)
502
764
        # Re-run this periodically if run by gobject.timeout_add
503
765
        return True
504
766
    
507
769
        if self.checker_callback_tag:
508
770
            gobject.source_remove(self.checker_callback_tag)
509
771
            self.checker_callback_tag = None
510
 
        if getattr(self, u"checker", None) is None:
 
772
        if getattr(self, "checker", None) is None:
511
773
            return
512
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
513
 
        try:
514
 
            os.kill(self.checker.pid, signal.SIGTERM)
515
 
            #time.sleep(0.5)
516
 
            #if self.checker.poll() is None:
517
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
518
 
        except OSError, error:
519
 
            if error.errno != errno.ESRCH: # No such process
520
 
                raise
 
774
        logger.debug("Stopping checker for %(name)s", vars(self))
 
775
        self.checker.terminate()
521
776
        self.checker = None
522
777
 
523
 
def dbus_service_property(dbus_interface, signature=u"v",
524
 
                          access=u"readwrite", byte_arrays=False):
 
778
 
 
779
def dbus_service_property(dbus_interface,
 
780
                          signature="v",
 
781
                          access="readwrite",
 
782
                          byte_arrays=False):
525
783
    """Decorators for marking methods of a DBusObjectWithProperties to
526
784
    become properties on the D-Bus.
527
785
    
534
792
    """
535
793
    # Encoding deeply encoded byte arrays is not supported yet by the
536
794
    # "Set" method, so we fail early here:
537
 
    if byte_arrays and signature != u"ay":
538
 
        raise ValueError(u"Byte arrays not supported for non-'ay'"
539
 
                         u" signature %r" % signature)
 
795
    if byte_arrays and signature != "ay":
 
796
        raise ValueError("Byte arrays not supported for non-'ay'"
 
797
                         " signature {!r}".format(signature))
 
798
    
540
799
    def decorator(func):
541
800
        func._dbus_is_property = True
542
801
        func._dbus_interface = dbus_interface
543
802
        func._dbus_signature = signature
544
803
        func._dbus_access = access
545
804
        func._dbus_name = func.__name__
546
 
        if func._dbus_name.endswith(u"_dbus_property"):
 
805
        if func._dbus_name.endswith("_dbus_property"):
547
806
            func._dbus_name = func._dbus_name[:-14]
548
 
        func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
549
 
        return func
 
807
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
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
    
550
853
    return decorator
551
854
 
552
855
 
553
856
class DBusPropertyException(dbus.exceptions.DBusException):
554
857
    """A base class for D-Bus property-related exceptions
555
858
    """
556
 
    def __unicode__(self):
557
 
        return unicode(str(self))
 
859
    pass
558
860
 
559
861
 
560
862
class DBusPropertyAccessException(DBusPropertyException):
569
871
    pass
570
872
 
571
873
 
572
 
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):
573
964
    """A D-Bus object with properties.
574
 
 
 
965
    
575
966
    Classes inheriting from this can use the dbus_service_property
576
967
    decorator to expose methods as D-Bus properties.  It exposes the
577
968
    standard Get(), Set(), and GetAll() methods on the D-Bus.
578
969
    """
579
970
    
580
 
    @staticmethod
581
 
    def _is_dbus_property(obj):
582
 
        return getattr(obj, u"_dbus_is_property", False)
583
 
    
584
 
    def _get_all_dbus_properties(self):
585
 
        """Returns a generator of (name, attribute) pairs
586
 
        """
587
 
        return ((prop._dbus_name, prop)
588
 
                for name, prop in
589
 
                inspect.getmembers(self, self._is_dbus_property))
590
 
    
591
971
    def _get_dbus_property(self, interface_name, property_name):
592
972
        """Returns a bound method if one exists which is a D-Bus
593
973
        property with the specified name and interface.
594
974
        """
595
 
        for name in (property_name,
596
 
                     property_name + u"_dbus_property"):
597
 
            prop = getattr(self, name, None)
598
 
            if (prop is None
599
 
                or not self._is_dbus_property(prop)
600
 
                or prop._dbus_name != property_name
601
 
                or (interface_name and prop._dbus_interface
602
 
                    and interface_name != prop._dbus_interface)):
603
 
                continue
604
 
            return prop
 
975
        for cls in self.__class__.__mro__:
 
976
            for name, value in inspect.getmembers(
 
977
                    cls, self._is_dbus_thing("property")):
 
978
                if (value._dbus_name == property_name
 
979
                    and value._dbus_interface == interface_name):
 
980
                    return value.__get__(self)
 
981
        
605
982
        # No such property
606
 
        raise DBusPropertyNotFound(self.dbus_object_path + u":"
607
 
                                   + interface_name + u"."
608
 
                                   + property_name)
609
 
    
610
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
611
 
                         out_signature=u"v")
 
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",
 
997
                         out_signature="v")
612
998
    def Get(self, interface_name, property_name):
613
999
        """Standard D-Bus property Get() method, see D-Bus standard.
614
1000
        """
615
1001
        prop = self._get_dbus_property(interface_name, property_name)
616
 
        if prop._dbus_access == u"write":
 
1002
        if prop._dbus_access == "write":
617
1003
            raise DBusPropertyAccessException(property_name)
618
1004
        value = prop()
619
 
        if not hasattr(value, u"variant_level"):
 
1005
        if not hasattr(value, "variant_level"):
620
1006
            return value
621
1007
        return type(value)(value, variant_level=value.variant_level+1)
622
1008
    
623
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
 
1009
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
624
1010
    def Set(self, interface_name, property_name, value):
625
1011
        """Standard D-Bus property Set() method, see D-Bus standard.
626
1012
        """
627
1013
        prop = self._get_dbus_property(interface_name, property_name)
628
 
        if prop._dbus_access == u"read":
 
1014
        if prop._dbus_access == "read":
629
1015
            raise DBusPropertyAccessException(property_name)
630
 
        if prop._dbus_get_args_options[u"byte_arrays"]:
 
1016
        if prop._dbus_get_args_options["byte_arrays"]:
631
1017
            # The byte_arrays option is not supported yet on
632
1018
            # signatures other than "ay".
633
 
            if prop._dbus_signature != u"ay":
634
 
                raise ValueError
635
 
            value = dbus.ByteArray(''.join(unichr(byte)
636
 
                                           for byte in value))
 
1019
            if prop._dbus_signature != "ay":
 
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))
637
1025
        prop(value)
638
1026
    
639
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
640
 
                         out_signature=u"a{sv}")
 
1027
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1028
                         in_signature="s",
 
1029
                         out_signature="a{sv}")
641
1030
    def GetAll(self, interface_name):
642
1031
        """Standard D-Bus property GetAll() method, see D-Bus
643
1032
        standard.
644
 
 
 
1033
        
645
1034
        Note: Will not include properties with access="write".
646
1035
        """
647
 
        all = {}
648
 
        for name, prop in self._get_all_dbus_properties():
 
1036
        properties = {}
 
1037
        for name, prop in self._get_all_dbus_things("property"):
649
1038
            if (interface_name
650
1039
                and interface_name != prop._dbus_interface):
651
1040
                # Interface non-empty but did not match
652
1041
                continue
653
1042
            # Ignore write-only properties
654
 
            if prop._dbus_access == u"write":
 
1043
            if prop._dbus_access == "write":
655
1044
                continue
656
1045
            value = prop()
657
 
            if not hasattr(value, u"variant_level"):
658
 
                all[name] = value
 
1046
            if not hasattr(value, "variant_level"):
 
1047
                properties[name] = value
659
1048
                continue
660
 
            all[name] = type(value)(value, variant_level=
661
 
                                    value.variant_level+1)
662
 
        return dbus.Dictionary(all, signature=u"sv")
 
1049
            properties[name] = type(value)(
 
1050
                value, variant_level = value.variant_level + 1)
 
1051
        return dbus.Dictionary(properties, signature="sv")
 
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
663
1060
    
664
1061
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
665
 
                         out_signature=u"s",
 
1062
                         out_signature="s",
666
1063
                         path_keyword='object_path',
667
1064
                         connection_keyword='connection')
668
1065
    def Introspect(self, object_path, connection):
669
 
        """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.
670
1069
        """
671
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
672
 
                                                   connection)
 
1070
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1071
                                                         object_path,
 
1072
                                                         connection)
673
1073
        try:
674
1074
            document = xml.dom.minidom.parseString(xmlstring)
 
1075
            
675
1076
            def make_tag(document, name, prop):
676
 
                e = document.createElement(u"property")
677
 
                e.setAttribute(u"name", name)
678
 
                e.setAttribute(u"type", prop._dbus_signature)
679
 
                e.setAttribute(u"access", prop._dbus_access)
 
1077
                e = document.createElement("property")
 
1078
                e.setAttribute("name", name)
 
1079
                e.setAttribute("type", prop._dbus_signature)
 
1080
                e.setAttribute("access", prop._dbus_access)
680
1081
                return e
681
 
            for if_tag in document.getElementsByTagName(u"interface"):
 
1082
            
 
1083
            for if_tag in document.getElementsByTagName("interface"):
 
1084
                # Add property tags
682
1085
                for tag in (make_tag(document, name, prop)
683
1086
                            for name, prop
684
 
                            in self._get_all_dbus_properties()
 
1087
                            in self._get_all_dbus_things("property")
685
1088
                            if prop._dbus_interface
686
 
                            == if_tag.getAttribute(u"name")):
 
1089
                            == if_tag.getAttribute("name")):
687
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)
688
1107
                # Add the names to the return values for the
689
1108
                # "org.freedesktop.DBus.Properties" methods
690
 
                if (if_tag.getAttribute(u"name")
691
 
                    == u"org.freedesktop.DBus.Properties"):
692
 
                    for cn in if_tag.getElementsByTagName(u"method"):
693
 
                        if cn.getAttribute(u"name") == u"Get":
694
 
                            for arg in cn.getElementsByTagName(u"arg"):
695
 
                                if (arg.getAttribute(u"direction")
696
 
                                    == u"out"):
697
 
                                    arg.setAttribute(u"name", u"value")
698
 
                        elif cn.getAttribute(u"name") == u"GetAll":
699
 
                            for arg in cn.getElementsByTagName(u"arg"):
700
 
                                if (arg.getAttribute(u"direction")
701
 
                                    == u"out"):
702
 
                                    arg.setAttribute(u"name", u"props")
703
 
            xmlstring = document.toxml(u"utf-8")
704
 
            document.unlink()
705
 
        except (AttributeError, xml.dom.DOMException,
706
 
                xml.parsers.expat.ExpatError), error:
707
 
            logger.error(u"Failed to override Introspection method",
708
 
                         error)
709
 
        return xmlstring
710
 
 
711
 
 
 
1109
                if (if_tag.getAttribute("name")
 
1110
                    == "org.freedesktop.DBus.Properties"):
 
1111
                    for cn in if_tag.getElementsByTagName("method"):
 
1112
                        if cn.getAttribute("name") == "Get":
 
1113
                            for arg in cn.getElementsByTagName("arg"):
 
1114
                                if (arg.getAttribute("direction")
 
1115
                                    == "out"):
 
1116
                                    arg.setAttribute("name", "value")
 
1117
                        elif cn.getAttribute("name") == "GetAll":
 
1118
                            for arg in cn.getElementsByTagName("arg"):
 
1119
                                if (arg.getAttribute("direction")
 
1120
                                    == "out"):
 
1121
                                    arg.setAttribute("name", "props")
 
1122
            xmlstring = document.toxml("utf-8")
 
1123
            document.unlink()
 
1124
        except (AttributeError, xml.dom.DOMException,
 
1125
                xml.parsers.expat.ExpatError) as error:
 
1126
            logger.error("Failed to override Introspection method",
 
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, signature = "oas")
 
1158
    def InterfacesRemoved(self, object_path, interfaces):
 
1159
        pass
 
1160
    
 
1161
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1162
                         out_signature = "s",
 
1163
                         path_keyword = 'object_path',
 
1164
                         connection_keyword = 'connection')
 
1165
    def Introspect(self, object_path, connection):
 
1166
        """Overloading of standard D-Bus method.
 
1167
        
 
1168
        Override return argument name of GetManagedObjects to be
 
1169
        "objpath_interfaces_and_properties"
 
1170
        """
 
1171
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1172
                                                         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):
 
1200
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
1201
    if dt is None:
 
1202
        return dbus.String("", variant_level = variant_level)
 
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).
 
1228
    """
 
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):
 
1237
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1238
                # with the wrong interface name
 
1239
                if (not hasattr(attribute, "_dbus_interface")
 
1240
                    or not attribute._dbus_interface.startswith(
 
1241
                        orig_interface_name)):
 
1242
                    continue
 
1243
                # Create an alternate D-Bus interface name based on
 
1244
                # the current name
 
1245
                alt_interface = attribute._dbus_interface.replace(
 
1246
                    orig_interface_name, alt_interface_name)
 
1247
                interface_names.add(alt_interface)
 
1248
                # Is this a D-Bus signal?
 
1249
                if getattr(attribute, "_dbus_is_signal", False):
 
1250
                    if sys.version_info.major == 2:
 
1251
                        # Extract the original non-method undecorated
 
1252
                        # function by black magic
 
1253
                        nonmethod_func = (dict(
 
1254
                            zip(attribute.func_code.co_freevars,
 
1255
                                attribute.__closure__))
 
1256
                                          ["func"].cell_contents)
 
1257
                    else:
 
1258
                        nonmethod_func = attribute
 
1259
                    # Create a new, but exactly alike, function
 
1260
                    # object, and decorate it to be a new D-Bus signal
 
1261
                    # with the alternate D-Bus interface name
 
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
 
1285
                    # Define a creator of a function to call both the
 
1286
                    # original and alternate functions, so both the
 
1287
                    # original and alternate signals gets sent when
 
1288
                    # the function is called
 
1289
                    def fixscope(func1, func2):
 
1290
                        """This function is a scope container to pass
 
1291
                        func1 and func2 to the "call_both" function
 
1292
                        outside of its arguments"""
 
1293
                        
 
1294
                        @functools.wraps(func2)
 
1295
                        def call_both(*args, **kwargs):
 
1296
                            """This function will emit two D-Bus
 
1297
                            signals by calling func1 and func2"""
 
1298
                            func1(*args, **kwargs)
 
1299
                            func2(*args, **kwargs)
 
1300
                        # Make wrapper function look like a D-Bus signal
 
1301
                        for name, attr in inspect.getmembers(func2):
 
1302
                            if name.startswith("_dbus_"):
 
1303
                                setattr(call_both, name, attr)
 
1304
                        
 
1305
                        return call_both
 
1306
                    # Create the "call_both" function and add it to
 
1307
                    # the class
 
1308
                    attr[attrname] = fixscope(attribute, new_function)
 
1309
                # Is this a D-Bus method?
 
1310
                elif getattr(attribute, "_dbus_is_method", False):
 
1311
                    # Create a new, but exactly alike, function
 
1312
                    # object.  Decorate it to be a new D-Bus method
 
1313
                    # with the alternate D-Bus interface name.  Add it
 
1314
                    # to the class.
 
1315
                    attr[attrname] = (
 
1316
                        dbus.service.method(
 
1317
                            alt_interface,
 
1318
                            attribute._dbus_in_signature,
 
1319
                            attribute._dbus_out_signature)
 
1320
                        (types.FunctionType(attribute.func_code,
 
1321
                                            attribute.func_globals,
 
1322
                                            attribute.func_name,
 
1323
                                            attribute.func_defaults,
 
1324
                                            attribute.func_closure)))
 
1325
                    # Copy annotations, if any
 
1326
                    try:
 
1327
                        attr[attrname]._dbus_annotations = dict(
 
1328
                            attribute._dbus_annotations)
 
1329
                    except AttributeError:
 
1330
                        pass
 
1331
                # Is this a D-Bus property?
 
1332
                elif getattr(attribute, "_dbus_is_property", False):
 
1333
                    # Create a new, but exactly alike, function
 
1334
                    # object, and decorate it to be a new D-Bus
 
1335
                    # property with the alternate D-Bus interface
 
1336
                    # name.  Add it to the class.
 
1337
                    attr[attrname] = (dbus_service_property(
 
1338
                        alt_interface, attribute._dbus_signature,
 
1339
                        attribute._dbus_access,
 
1340
                        attribute._dbus_get_args_options
 
1341
                        ["byte_arrays"])
 
1342
                                      (types.FunctionType(
 
1343
                                          attribute.func_code,
 
1344
                                          attribute.func_globals,
 
1345
                                          attribute.func_name,
 
1346
                                          attribute.func_defaults,
 
1347
                                          attribute.func_closure)))
 
1348
                    # Copy annotations, if any
 
1349
                    try:
 
1350
                        attr[attrname]._dbus_annotations = dict(
 
1351
                            attribute._dbus_annotations)
 
1352
                    except AttributeError:
 
1353
                        pass
 
1354
                # Is this a D-Bus interface?
 
1355
                elif getattr(attribute, "_dbus_is_interface", False):
 
1356
                    # Create a new, but exactly alike, function
 
1357
                    # object.  Decorate it to be a new D-Bus interface
 
1358
                    # with the alternate D-Bus interface name.  Add it
 
1359
                    # to the class.
 
1360
                    attr[attrname] = (
 
1361
                        dbus_interface_annotations(alt_interface)
 
1362
                        (types.FunctionType(attribute.func_code,
 
1363
                                            attribute.func_globals,
 
1364
                                            attribute.func_name,
 
1365
                                            attribute.func_defaults,
 
1366
                                            attribute.func_closure)))
 
1367
            if deprecate:
 
1368
                # Deprecate all alternate interfaces
 
1369
                iname="_AlternateDBusNames_interface_annotation{}"
 
1370
                for interface_name in interface_names:
 
1371
                    
 
1372
                    @dbus_interface_annotations(interface_name)
 
1373
                    def func(self):
 
1374
                        return { "org.freedesktop.DBus.Deprecated":
 
1375
                                 "true" }
 
1376
                    # Find an unused name
 
1377
                    for aname in (iname.format(i)
 
1378
                                  for i in itertools.count()):
 
1379
                        if aname not in attr:
 
1380
                            attr[aname] = func
 
1381
                            break
 
1382
            if interface_names:
 
1383
                # Replace the class with a new subclass of it with
 
1384
                # methods, signals, etc. as created above.
 
1385
                cls = type(b"{}Alternate".format(cls.__name__),
 
1386
                           (cls, ), attr)
 
1387
        return cls
 
1388
    
 
1389
    return wrapper
 
1390
 
 
1391
 
 
1392
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1393
                            "se.bsnet.fukt.Mandos"})
712
1394
class ClientDBus(Client, DBusObjectWithProperties):
713
1395
    """A Client class using D-Bus
714
1396
    
718
1400
    """
719
1401
    
720
1402
    runtime_expansions = (Client.runtime_expansions
721
 
                          + (u"dbus_object_path",))
 
1403
                          + ("dbus_object_path", ))
 
1404
    
 
1405
    _interface = "se.recompile.Mandos.Client"
722
1406
    
723
1407
    # dbus.service.Object doesn't use super(), so we can't either.
724
1408
    
725
1409
    def __init__(self, bus = None, *args, **kwargs):
726
 
        self._approvals_pending = 0
727
1410
        self.bus = bus
728
1411
        Client.__init__(self, *args, **kwargs)
729
1412
        # Only now, when this client is initialized, can it show up on
730
1413
        # the D-Bus
731
 
        client_object_name = unicode(self.name).translate(
732
 
            {ord(u"."): ord(u"_"),
733
 
             ord(u"-"): ord(u"_")})
734
 
        self.dbus_object_path = (dbus.ObjectPath
735
 
                                 (u"/clients/" + client_object_name))
 
1414
        client_object_name = str(self.name).translate(
 
1415
            {ord("."): ord("_"),
 
1416
             ord("-"): ord("_")})
 
1417
        self.dbus_object_path = dbus.ObjectPath(
 
1418
            "/clients/" + client_object_name)
736
1419
        DBusObjectWithProperties.__init__(self, self.bus,
737
1420
                                          self.dbus_object_path)
738
 
        
739
 
    def _get_approvals_pending(self):
740
 
        return self._approvals_pending
741
 
    def _set_approvals_pending(self, value):
742
 
        old_value = self._approvals_pending
743
 
        self._approvals_pending = value
744
 
        bval = bool(value)
745
 
        if (hasattr(self, "dbus_object_path")
746
 
            and bval is not bool(old_value)):
747
 
            dbus_bool = dbus.Boolean(bval, variant_level=1)
748
 
            self.PropertyChanged(dbus.String(u"ApprovalPending"),
749
 
                                 dbus_bool)
750
 
 
751
 
    approvals_pending = property(_get_approvals_pending,
752
 
                                 _set_approvals_pending)
753
 
    del _get_approvals_pending, _set_approvals_pending
754
 
    
755
 
    @staticmethod
756
 
    def _datetime_to_dbus(dt, variant_level=0):
757
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
758
 
        return dbus.String(dt.isoformat(),
759
 
                           variant_level=variant_level)
760
 
    
761
 
    def enable(self):
762
 
        oldstate = getattr(self, u"enabled", False)
763
 
        r = Client.enable(self)
764
 
        if oldstate != self.enabled:
765
 
            # Emit D-Bus signals
766
 
            self.PropertyChanged(dbus.String(u"Enabled"),
767
 
                                 dbus.Boolean(True, variant_level=1))
768
 
            self.PropertyChanged(
769
 
                dbus.String(u"LastEnabled"),
770
 
                self._datetime_to_dbus(self.last_enabled,
771
 
                                       variant_level=1))
772
 
        return r
773
 
    
774
 
    def disable(self, quiet = False):
775
 
        oldstate = getattr(self, u"enabled", False)
776
 
        r = Client.disable(self, quiet=quiet)
777
 
        if not quiet and oldstate != self.enabled:
778
 
            # Emit D-Bus signal
779
 
            self.PropertyChanged(dbus.String(u"Enabled"),
780
 
                                 dbus.Boolean(False, variant_level=1))
781
 
        return r
 
1421
    
 
1422
    def notifychangeproperty(transform_func, dbus_name,
 
1423
                             type_func=lambda x: x,
 
1424
                             variant_level=1,
 
1425
                             invalidate_only=False,
 
1426
                             _interface=_interface):
 
1427
        """ Modify a variable so that it's a property which announces
 
1428
        its changes to DBus.
 
1429
        
 
1430
        transform_fun: Function that takes a value and a variant_level
 
1431
                       and transforms it to a D-Bus type.
 
1432
        dbus_name: D-Bus name of the variable
 
1433
        type_func: Function that transform the value before sending it
 
1434
                   to the D-Bus.  Default: no transform
 
1435
        variant_level: D-Bus variant level.  Default: 1
 
1436
        """
 
1437
        attrname = "_{}".format(dbus_name)
 
1438
        
 
1439
        def setter(self, value):
 
1440
            if hasattr(self, "dbus_object_path"):
 
1441
                if (not hasattr(self, attrname) or
 
1442
                    type_func(getattr(self, attrname, None))
 
1443
                    != type_func(value)):
 
1444
                    if invalidate_only:
 
1445
                        self.PropertiesChanged(
 
1446
                            _interface, dbus.Dictionary(),
 
1447
                            dbus.Array((dbus_name, )))
 
1448
                    else:
 
1449
                        dbus_value = transform_func(
 
1450
                            type_func(value),
 
1451
                            variant_level = variant_level)
 
1452
                        self.PropertyChanged(dbus.String(dbus_name),
 
1453
                                             dbus_value)
 
1454
                        self.PropertiesChanged(
 
1455
                            _interface,
 
1456
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1457
                                              dbus_value }),
 
1458
                            dbus.Array())
 
1459
            setattr(self, attrname, value)
 
1460
        
 
1461
        return property(lambda self: getattr(self, attrname), setter)
 
1462
    
 
1463
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1464
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1465
                                             "ApprovalPending",
 
1466
                                             type_func = bool)
 
1467
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1468
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1469
                                        "LastEnabled")
 
1470
    checker = notifychangeproperty(
 
1471
        dbus.Boolean, "CheckerRunning",
 
1472
        type_func = lambda checker: checker is not None)
 
1473
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1474
                                           "LastCheckedOK")
 
1475
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1476
                                               "LastCheckerStatus")
 
1477
    last_approval_request = notifychangeproperty(
 
1478
        datetime_to_dbus, "LastApprovalRequest")
 
1479
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1480
                                               "ApprovedByDefault")
 
1481
    approval_delay = notifychangeproperty(
 
1482
        dbus.UInt64, "ApprovalDelay",
 
1483
        type_func = lambda td: td.total_seconds() * 1000)
 
1484
    approval_duration = notifychangeproperty(
 
1485
        dbus.UInt64, "ApprovalDuration",
 
1486
        type_func = lambda td: td.total_seconds() * 1000)
 
1487
    host = notifychangeproperty(dbus.String, "Host")
 
1488
    timeout = notifychangeproperty(
 
1489
        dbus.UInt64, "Timeout",
 
1490
        type_func = lambda td: td.total_seconds() * 1000)
 
1491
    extended_timeout = notifychangeproperty(
 
1492
        dbus.UInt64, "ExtendedTimeout",
 
1493
        type_func = lambda td: td.total_seconds() * 1000)
 
1494
    interval = notifychangeproperty(
 
1495
        dbus.UInt64, "Interval",
 
1496
        type_func = lambda td: td.total_seconds() * 1000)
 
1497
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1498
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1499
                                  invalidate_only=True)
 
1500
    
 
1501
    del notifychangeproperty
782
1502
    
783
1503
    def __del__(self, *args, **kwargs):
784
1504
        try:
785
1505
            self.remove_from_connection()
786
1506
        except LookupError:
787
1507
            pass
788
 
        if hasattr(DBusObjectWithProperties, u"__del__"):
 
1508
        if hasattr(DBusObjectWithProperties, "__del__"):
789
1509
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
790
1510
        Client.__del__(self, *args, **kwargs)
791
1511
    
792
 
    def checker_callback(self, pid, condition, command,
793
 
                         *args, **kwargs):
794
 
        self.checker_callback_tag = None
795
 
        self.checker = None
796
 
        # Emit D-Bus signal
797
 
        self.PropertyChanged(dbus.String(u"CheckerRunning"),
798
 
                             dbus.Boolean(False, variant_level=1))
799
 
        if os.WIFEXITED(condition):
800
 
            exitstatus = os.WEXITSTATUS(condition)
 
1512
    def checker_callback(self, source, condition,
 
1513
                         connection, command, *args, **kwargs):
 
1514
        ret = Client.checker_callback(self, source, condition,
 
1515
                                      connection, command, *args,
 
1516
                                      **kwargs)
 
1517
        exitstatus = self.last_checker_status
 
1518
        if exitstatus >= 0:
801
1519
            # Emit D-Bus signal
802
1520
            self.CheckerCompleted(dbus.Int16(exitstatus),
803
 
                                  dbus.Int64(condition),
 
1521
                                  # This is specific to GNU libC
 
1522
                                  dbus.Int64(exitstatus << 8),
804
1523
                                  dbus.String(command))
805
1524
        else:
806
1525
            # Emit D-Bus signal
807
1526
            self.CheckerCompleted(dbus.Int16(-1),
808
 
                                  dbus.Int64(condition),
 
1527
                                  dbus.Int64(
 
1528
                                      # This is specific to GNU libC
 
1529
                                      (exitstatus << 8)
 
1530
                                      | self.last_checker_signal),
809
1531
                                  dbus.String(command))
810
 
        
811
 
        return Client.checker_callback(self, pid, condition, command,
812
 
                                       *args, **kwargs)
813
 
    
814
 
    def checked_ok(self, *args, **kwargs):
815
 
        r = Client.checked_ok(self, *args, **kwargs)
816
 
        # Emit D-Bus signal
817
 
        self.PropertyChanged(
818
 
            dbus.String(u"LastCheckedOK"),
819
 
            (self._datetime_to_dbus(self.last_checked_ok,
820
 
                                    variant_level=1)))
821
 
        return r
822
 
    
823
 
    def need_approval(self, *args, **kwargs):
824
 
        r = Client.need_approval(self, *args, **kwargs)
825
 
        # Emit D-Bus signal
826
 
        self.PropertyChanged(
827
 
            dbus.String(u"LastApprovalRequest"),
828
 
            (self._datetime_to_dbus(self.last_approval_request,
829
 
                                    variant_level=1)))
830
 
        return r
 
1532
        return ret
831
1533
    
832
1534
    def start_checker(self, *args, **kwargs):
833
 
        old_checker = self.checker
834
 
        if self.checker is not None:
835
 
            old_checker_pid = self.checker.pid
836
 
        else:
837
 
            old_checker_pid = None
 
1535
        old_checker_pid = getattr(self.checker, "pid", None)
838
1536
        r = Client.start_checker(self, *args, **kwargs)
839
1537
        # Only if new checker process was started
840
1538
        if (self.checker is not None
841
1539
            and old_checker_pid != self.checker.pid):
842
1540
            # Emit D-Bus signal
843
1541
            self.CheckerStarted(self.current_checker_command)
844
 
            self.PropertyChanged(
845
 
                dbus.String(u"CheckerRunning"),
846
 
                dbus.Boolean(True, variant_level=1))
847
1542
        return r
848
1543
    
849
 
    def stop_checker(self, *args, **kwargs):
850
 
        old_checker = getattr(self, u"checker", None)
851
 
        r = Client.stop_checker(self, *args, **kwargs)
852
 
        if (old_checker is not None
853
 
            and getattr(self, u"checker", None) is None):
854
 
            self.PropertyChanged(dbus.String(u"CheckerRunning"),
855
 
                                 dbus.Boolean(False, variant_level=1))
856
 
        return r
857
 
 
858
1544
    def _reset_approved(self):
859
 
        self._approved = None
 
1545
        self.approved = None
860
1546
        return False
861
1547
    
862
1548
    def approve(self, value=True):
 
1549
        self.approved = value
 
1550
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1551
                                * 1000), self._reset_approved)
863
1552
        self.send_changedstate()
864
 
        self._approved = value
865
 
        gobject.timeout_add(self._timedelta_to_milliseconds
866
 
                            (self.approval_duration),
867
 
                            self._reset_approved)
868
 
    
869
1553
    
870
1554
    ## D-Bus methods, signals & properties
871
 
    _interface = u"se.bsnet.fukt.Mandos.Client"
 
1555
    
 
1556
    ## Interfaces
872
1557
    
873
1558
    ## Signals
874
1559
    
875
1560
    # CheckerCompleted - signal
876
 
    @dbus.service.signal(_interface, signature=u"nxs")
 
1561
    @dbus.service.signal(_interface, signature="nxs")
877
1562
    def CheckerCompleted(self, exitcode, waitstatus, command):
878
1563
        "D-Bus signal"
879
1564
        pass
880
1565
    
881
1566
    # CheckerStarted - signal
882
 
    @dbus.service.signal(_interface, signature=u"s")
 
1567
    @dbus.service.signal(_interface, signature="s")
883
1568
    def CheckerStarted(self, command):
884
1569
        "D-Bus signal"
885
1570
        pass
886
1571
    
887
1572
    # PropertyChanged - signal
888
 
    @dbus.service.signal(_interface, signature=u"sv")
 
1573
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
1574
    @dbus.service.signal(_interface, signature="sv")
889
1575
    def PropertyChanged(self, property, value):
890
1576
        "D-Bus signal"
891
1577
        pass
900
1586
        pass
901
1587
    
902
1588
    # Rejected - signal
903
 
    @dbus.service.signal(_interface, signature=u"s")
 
1589
    @dbus.service.signal(_interface, signature="s")
904
1590
    def Rejected(self, reason):
905
1591
        "D-Bus signal"
906
1592
        pass
907
1593
    
908
1594
    # NeedApproval - signal
909
 
    @dbus.service.signal(_interface, signature=u"tb")
 
1595
    @dbus.service.signal(_interface, signature="tb")
910
1596
    def NeedApproval(self, timeout, default):
911
1597
        "D-Bus signal"
912
1598
        return self.need_approval()
914
1600
    ## Methods
915
1601
    
916
1602
    # Approve - method
917
 
    @dbus.service.method(_interface, in_signature=u"b")
 
1603
    @dbus.service.method(_interface, in_signature="b")
918
1604
    def Approve(self, value):
919
1605
        self.approve(value)
920
1606
    
921
1607
    # CheckedOK - method
922
1608
    @dbus.service.method(_interface)
923
1609
    def CheckedOK(self):
924
 
        return self.checked_ok()
 
1610
        self.checked_ok()
925
1611
    
926
1612
    # Enable - method
 
1613
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
927
1614
    @dbus.service.method(_interface)
928
1615
    def Enable(self):
929
1616
        "D-Bus method"
930
1617
        self.enable()
931
1618
    
932
1619
    # StartChecker - method
 
1620
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
933
1621
    @dbus.service.method(_interface)
934
1622
    def StartChecker(self):
935
1623
        "D-Bus method"
936
1624
        self.start_checker()
937
1625
    
938
1626
    # Disable - method
 
1627
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
939
1628
    @dbus.service.method(_interface)
940
1629
    def Disable(self):
941
1630
        "D-Bus method"
942
1631
        self.disable()
943
1632
    
944
1633
    # StopChecker - method
 
1634
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
945
1635
    @dbus.service.method(_interface)
946
1636
    def StopChecker(self):
947
1637
        self.stop_checker()
949
1639
    ## Properties
950
1640
    
951
1641
    # ApprovalPending - property
952
 
    @dbus_service_property(_interface, signature=u"b", access=u"read")
 
1642
    @dbus_service_property(_interface, signature="b", access="read")
953
1643
    def ApprovalPending_dbus_property(self):
954
1644
        return dbus.Boolean(bool(self.approvals_pending))
955
1645
    
956
1646
    # ApprovedByDefault - property
957
 
    @dbus_service_property(_interface, signature=u"b",
958
 
                           access=u"readwrite")
 
1647
    @dbus_service_property(_interface,
 
1648
                           signature="b",
 
1649
                           access="readwrite")
959
1650
    def ApprovedByDefault_dbus_property(self, value=None):
960
1651
        if value is None:       # get
961
1652
            return dbus.Boolean(self.approved_by_default)
962
1653
        self.approved_by_default = bool(value)
963
 
        # Emit D-Bus signal
964
 
        self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
965
 
                             dbus.Boolean(value, variant_level=1))
966
1654
    
967
1655
    # ApprovalDelay - property
968
 
    @dbus_service_property(_interface, signature=u"t",
969
 
                           access=u"readwrite")
 
1656
    @dbus_service_property(_interface,
 
1657
                           signature="t",
 
1658
                           access="readwrite")
970
1659
    def ApprovalDelay_dbus_property(self, value=None):
971
1660
        if value is None:       # get
972
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1661
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1662
                               * 1000)
973
1663
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
974
 
        # Emit D-Bus signal
975
 
        self.PropertyChanged(dbus.String(u"ApprovalDelay"),
976
 
                             dbus.UInt64(value, variant_level=1))
977
1664
    
978
1665
    # ApprovalDuration - property
979
 
    @dbus_service_property(_interface, signature=u"t",
980
 
                           access=u"readwrite")
 
1666
    @dbus_service_property(_interface,
 
1667
                           signature="t",
 
1668
                           access="readwrite")
981
1669
    def ApprovalDuration_dbus_property(self, value=None):
982
1670
        if value is None:       # get
983
 
            return dbus.UInt64(self._timedelta_to_milliseconds(
984
 
                    self.approval_duration))
 
1671
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1672
                               * 1000)
985
1673
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
986
 
        # Emit D-Bus signal
987
 
        self.PropertyChanged(dbus.String(u"ApprovalDuration"),
988
 
                             dbus.UInt64(value, variant_level=1))
989
1674
    
990
1675
    # Name - property
991
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
1676
    @dbus_annotations(
 
1677
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
1678
    @dbus_service_property(_interface, signature="s", access="read")
992
1679
    def Name_dbus_property(self):
993
1680
        return dbus.String(self.name)
994
1681
    
995
1682
    # Fingerprint - property
996
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
1683
    @dbus_annotations(
 
1684
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
1685
    @dbus_service_property(_interface, signature="s", access="read")
997
1686
    def Fingerprint_dbus_property(self):
998
1687
        return dbus.String(self.fingerprint)
999
1688
    
1000
1689
    # Host - property
1001
 
    @dbus_service_property(_interface, signature=u"s",
1002
 
                           access=u"readwrite")
 
1690
    @dbus_service_property(_interface,
 
1691
                           signature="s",
 
1692
                           access="readwrite")
1003
1693
    def Host_dbus_property(self, value=None):
1004
1694
        if value is None:       # get
1005
1695
            return dbus.String(self.host)
1006
 
        self.host = value
1007
 
        # Emit D-Bus signal
1008
 
        self.PropertyChanged(dbus.String(u"Host"),
1009
 
                             dbus.String(value, variant_level=1))
 
1696
        self.host = str(value)
1010
1697
    
1011
1698
    # Created - property
1012
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
1699
    @dbus_annotations(
 
1700
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
1701
    @dbus_service_property(_interface, signature="s", access="read")
1013
1702
    def Created_dbus_property(self):
1014
 
        return dbus.String(self._datetime_to_dbus(self.created))
 
1703
        return datetime_to_dbus(self.created)
1015
1704
    
1016
1705
    # LastEnabled - property
1017
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
1706
    @dbus_service_property(_interface, signature="s", access="read")
1018
1707
    def LastEnabled_dbus_property(self):
1019
 
        if self.last_enabled is None:
1020
 
            return dbus.String(u"")
1021
 
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
 
1708
        return datetime_to_dbus(self.last_enabled)
1022
1709
    
1023
1710
    # Enabled - property
1024
 
    @dbus_service_property(_interface, signature=u"b",
1025
 
                           access=u"readwrite")
 
1711
    @dbus_service_property(_interface,
 
1712
                           signature="b",
 
1713
                           access="readwrite")
1026
1714
    def Enabled_dbus_property(self, value=None):
1027
1715
        if value is None:       # get
1028
1716
            return dbus.Boolean(self.enabled)
1032
1720
            self.disable()
1033
1721
    
1034
1722
    # LastCheckedOK - property
1035
 
    @dbus_service_property(_interface, signature=u"s",
1036
 
                           access=u"readwrite")
 
1723
    @dbus_service_property(_interface,
 
1724
                           signature="s",
 
1725
                           access="readwrite")
1037
1726
    def LastCheckedOK_dbus_property(self, value=None):
1038
1727
        if value is not None:
1039
1728
            self.checked_ok()
1040
1729
            return
1041
 
        if self.last_checked_ok is None:
1042
 
            return dbus.String(u"")
1043
 
        return dbus.String(self._datetime_to_dbus(self
1044
 
                                                  .last_checked_ok))
 
1730
        return datetime_to_dbus(self.last_checked_ok)
 
1731
    
 
1732
    # LastCheckerStatus - property
 
1733
    @dbus_service_property(_interface, signature="n", access="read")
 
1734
    def LastCheckerStatus_dbus_property(self):
 
1735
        return dbus.Int16(self.last_checker_status)
 
1736
    
 
1737
    # Expires - property
 
1738
    @dbus_service_property(_interface, signature="s", access="read")
 
1739
    def Expires_dbus_property(self):
 
1740
        return datetime_to_dbus(self.expires)
1045
1741
    
1046
1742
    # LastApprovalRequest - property
1047
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
1743
    @dbus_service_property(_interface, signature="s", access="read")
1048
1744
    def LastApprovalRequest_dbus_property(self):
1049
 
        if self.last_approval_request is None:
1050
 
            return dbus.String(u"")
1051
 
        return dbus.String(self.
1052
 
                           _datetime_to_dbus(self
1053
 
                                             .last_approval_request))
 
1745
        return datetime_to_dbus(self.last_approval_request)
1054
1746
    
1055
1747
    # Timeout - property
1056
 
    @dbus_service_property(_interface, signature=u"t",
1057
 
                           access=u"readwrite")
 
1748
    @dbus_service_property(_interface,
 
1749
                           signature="t",
 
1750
                           access="readwrite")
1058
1751
    def Timeout_dbus_property(self, value=None):
1059
1752
        if value is None:       # get
1060
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1753
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1754
        old_timeout = self.timeout
1061
1755
        self.timeout = datetime.timedelta(0, 0, 0, value)
1062
 
        # Emit D-Bus signal
1063
 
        self.PropertyChanged(dbus.String(u"Timeout"),
1064
 
                             dbus.UInt64(value, variant_level=1))
1065
 
        if getattr(self, u"disable_initiator_tag", None) is None:
1066
 
            return
1067
 
        # Reschedule timeout
1068
 
        gobject.source_remove(self.disable_initiator_tag)
1069
 
        self.disable_initiator_tag = None
1070
 
        time_to_die = (self.
1071
 
                       _timedelta_to_milliseconds((self
1072
 
                                                   .last_checked_ok
1073
 
                                                   + self.timeout)
1074
 
                                                  - datetime.datetime
1075
 
                                                  .utcnow()))
1076
 
        if time_to_die <= 0:
1077
 
            # The timeout has passed
1078
 
            self.disable()
1079
 
        else:
1080
 
            self.disable_initiator_tag = (gobject.timeout_add
1081
 
                                          (time_to_die, self.disable))
 
1756
        # Reschedule disabling
 
1757
        if self.enabled:
 
1758
            now = datetime.datetime.utcnow()
 
1759
            self.expires += self.timeout - old_timeout
 
1760
            if self.expires <= now:
 
1761
                # The timeout has passed
 
1762
                self.disable()
 
1763
            else:
 
1764
                if (getattr(self, "disable_initiator_tag", None)
 
1765
                    is None):
 
1766
                    return
 
1767
                gobject.source_remove(self.disable_initiator_tag)
 
1768
                self.disable_initiator_tag = gobject.timeout_add(
 
1769
                    int((self.expires - now).total_seconds() * 1000),
 
1770
                    self.disable)
 
1771
    
 
1772
    # ExtendedTimeout - property
 
1773
    @dbus_service_property(_interface,
 
1774
                           signature="t",
 
1775
                           access="readwrite")
 
1776
    def ExtendedTimeout_dbus_property(self, value=None):
 
1777
        if value is None:       # get
 
1778
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1779
                               * 1000)
 
1780
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1082
1781
    
1083
1782
    # Interval - property
1084
 
    @dbus_service_property(_interface, signature=u"t",
1085
 
                           access=u"readwrite")
 
1783
    @dbus_service_property(_interface,
 
1784
                           signature="t",
 
1785
                           access="readwrite")
1086
1786
    def Interval_dbus_property(self, value=None):
1087
1787
        if value is None:       # get
1088
 
            return dbus.UInt64(self.interval_milliseconds())
 
1788
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1089
1789
        self.interval = datetime.timedelta(0, 0, 0, value)
1090
 
        # Emit D-Bus signal
1091
 
        self.PropertyChanged(dbus.String(u"Interval"),
1092
 
                             dbus.UInt64(value, variant_level=1))
1093
 
        if getattr(self, u"checker_initiator_tag", None) is None:
 
1790
        if getattr(self, "checker_initiator_tag", None) is None:
1094
1791
            return
1095
 
        # Reschedule checker run
1096
 
        gobject.source_remove(self.checker_initiator_tag)
1097
 
        self.checker_initiator_tag = (gobject.timeout_add
1098
 
                                      (value, self.start_checker))
1099
 
        self.start_checker()    # Start one now, too
1100
 
 
 
1792
        if self.enabled:
 
1793
            # Reschedule checker run
 
1794
            gobject.source_remove(self.checker_initiator_tag)
 
1795
            self.checker_initiator_tag = gobject.timeout_add(
 
1796
                value, self.start_checker)
 
1797
            self.start_checker() # Start one now, too
 
1798
    
1101
1799
    # Checker - property
1102
 
    @dbus_service_property(_interface, signature=u"s",
1103
 
                           access=u"readwrite")
 
1800
    @dbus_service_property(_interface,
 
1801
                           signature="s",
 
1802
                           access="readwrite")
1104
1803
    def Checker_dbus_property(self, value=None):
1105
1804
        if value is None:       # get
1106
1805
            return dbus.String(self.checker_command)
1107
 
        self.checker_command = value
1108
 
        # Emit D-Bus signal
1109
 
        self.PropertyChanged(dbus.String(u"Checker"),
1110
 
                             dbus.String(self.checker_command,
1111
 
                                         variant_level=1))
 
1806
        self.checker_command = str(value)
1112
1807
    
1113
1808
    # CheckerRunning - property
1114
 
    @dbus_service_property(_interface, signature=u"b",
1115
 
                           access=u"readwrite")
 
1809
    @dbus_service_property(_interface,
 
1810
                           signature="b",
 
1811
                           access="readwrite")
1116
1812
    def CheckerRunning_dbus_property(self, value=None):
1117
1813
        if value is None:       # get
1118
1814
            return dbus.Boolean(self.checker is not None)
1122
1818
            self.stop_checker()
1123
1819
    
1124
1820
    # ObjectPath - property
1125
 
    @dbus_service_property(_interface, signature=u"o", access=u"read")
 
1821
    @dbus_annotations(
 
1822
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
1823
         "org.freedesktop.DBus.Deprecated": "true"})
 
1824
    @dbus_service_property(_interface, signature="o", access="read")
1126
1825
    def ObjectPath_dbus_property(self):
1127
1826
        return self.dbus_object_path # is already a dbus.ObjectPath
1128
1827
    
1129
1828
    # Secret = property
1130
 
    @dbus_service_property(_interface, signature=u"ay",
1131
 
                           access=u"write", byte_arrays=True)
 
1829
    @dbus_annotations(
 
1830
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1831
         "invalidates"})
 
1832
    @dbus_service_property(_interface,
 
1833
                           signature="ay",
 
1834
                           access="write",
 
1835
                           byte_arrays=True)
1132
1836
    def Secret_dbus_property(self, value):
1133
 
        self.secret = str(value)
 
1837
        self.secret = bytes(value)
1134
1838
    
1135
1839
    del _interface
1136
1840
 
1140
1844
        self._pipe = child_pipe
1141
1845
        self._pipe.send(('init', fpr, address))
1142
1846
        if not self._pipe.recv():
1143
 
            raise KeyError()
1144
 
 
 
1847
            raise KeyError(fpr)
 
1848
    
1145
1849
    def __getattribute__(self, name):
1146
 
        if(name == '_pipe'):
 
1850
        if name == '_pipe':
1147
1851
            return super(ProxyClient, self).__getattribute__(name)
1148
1852
        self._pipe.send(('getattr', name))
1149
1853
        data = self._pipe.recv()
1150
1854
        if data[0] == 'data':
1151
1855
            return data[1]
1152
1856
        if data[0] == 'function':
 
1857
            
1153
1858
            def func(*args, **kwargs):
1154
1859
                self._pipe.send(('funcall', name, args, kwargs))
1155
1860
                return self._pipe.recv()[1]
 
1861
            
1156
1862
            return func
1157
 
 
 
1863
    
1158
1864
    def __setattr__(self, name, value):
1159
 
        if(name == '_pipe'):
 
1865
        if name == '_pipe':
1160
1866
            return super(ProxyClient, self).__setattr__(name, value)
1161
1867
        self._pipe.send(('setattr', name, value))
1162
1868
 
1169
1875
    
1170
1876
    def handle(self):
1171
1877
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1172
 
            logger.info(u"TCP connection from: %s",
1173
 
                        unicode(self.client_address))
1174
 
            logger.debug(u"Pipe FD: %d",
 
1878
            logger.info("TCP connection from: %s",
 
1879
                        str(self.client_address))
 
1880
            logger.debug("Pipe FD: %d",
1175
1881
                         self.server.child_pipe.fileno())
1176
 
 
1177
 
            session = (gnutls.connection
1178
 
                       .ClientSession(self.request,
1179
 
                                      gnutls.connection
1180
 
                                      .X509Credentials()))
1181
 
 
 
1882
            
 
1883
            session = gnutls.connection.ClientSession(
 
1884
                self.request, gnutls.connection .X509Credentials())
 
1885
            
1182
1886
            # Note: gnutls.connection.X509Credentials is really a
1183
1887
            # generic GnuTLS certificate credentials object so long as
1184
1888
            # no X.509 keys are added to it.  Therefore, we can use it
1185
1889
            # here despite using OpenPGP certificates.
1186
 
 
1187
 
            #priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1188
 
            #                      u"+AES-256-CBC", u"+SHA1",
1189
 
            #                      u"+COMP-NULL", u"+CTYPE-OPENPGP",
1190
 
            #                      u"+DHE-DSS"))
 
1890
            
 
1891
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
1892
            #                      "+AES-256-CBC", "+SHA1",
 
1893
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
1894
            #                      "+DHE-DSS"))
1191
1895
            # Use a fallback default, since this MUST be set.
1192
1896
            priority = self.server.gnutls_priority
1193
1897
            if priority is None:
1194
 
                priority = u"NORMAL"
1195
 
            (gnutls.library.functions
1196
 
             .gnutls_priority_set_direct(session._c_object,
1197
 
                                         priority, None))
1198
 
 
 
1898
                priority = "NORMAL"
 
1899
            gnutls.library.functions.gnutls_priority_set_direct(
 
1900
                session._c_object, priority, None)
 
1901
            
1199
1902
            # Start communication using the Mandos protocol
1200
1903
            # Get protocol number
1201
1904
            line = self.request.makefile().readline()
1202
 
            logger.debug(u"Protocol version: %r", line)
 
1905
            logger.debug("Protocol version: %r", line)
1203
1906
            try:
1204
1907
                if int(line.strip().split()[0]) > 1:
1205
 
                    raise RuntimeError
1206
 
            except (ValueError, IndexError, RuntimeError), error:
1207
 
                logger.error(u"Unknown protocol version: %s", error)
 
1908
                    raise RuntimeError(line)
 
1909
            except (ValueError, IndexError, RuntimeError) as error:
 
1910
                logger.error("Unknown protocol version: %s", error)
1208
1911
                return
1209
 
 
 
1912
            
1210
1913
            # Start GnuTLS connection
1211
1914
            try:
1212
1915
                session.handshake()
1213
 
            except gnutls.errors.GNUTLSError, error:
1214
 
                logger.warning(u"Handshake failed: %s", error)
 
1916
            except gnutls.errors.GNUTLSError as error:
 
1917
                logger.warning("Handshake failed: %s", error)
1215
1918
                # Do not run session.bye() here: the session is not
1216
1919
                # established.  Just abandon the request.
1217
1920
                return
1218
 
            logger.debug(u"Handshake succeeded")
1219
 
 
 
1921
            logger.debug("Handshake succeeded")
 
1922
            
1220
1923
            approval_required = False
1221
1924
            try:
1222
1925
                try:
1223
 
                    fpr = self.fingerprint(self.peer_certificate
1224
 
                                           (session))
1225
 
                except (TypeError, gnutls.errors.GNUTLSError), error:
1226
 
                    logger.warning(u"Bad certificate: %s", error)
 
1926
                    fpr = self.fingerprint(
 
1927
                        self.peer_certificate(session))
 
1928
                except (TypeError,
 
1929
                        gnutls.errors.GNUTLSError) as error:
 
1930
                    logger.warning("Bad certificate: %s", error)
1227
1931
                    return
1228
 
                logger.debug(u"Fingerprint: %s", fpr)
1229
 
 
 
1932
                logger.debug("Fingerprint: %s", fpr)
 
1933
                
1230
1934
                try:
1231
1935
                    client = ProxyClient(child_pipe, fpr,
1232
1936
                                         self.client_address)
1240
1944
                
1241
1945
                while True:
1242
1946
                    if not client.enabled:
1243
 
                        logger.warning(u"Client %s is disabled",
1244
 
                                       client.name)
 
1947
                        logger.info("Client %s is disabled",
 
1948
                                    client.name)
1245
1949
                        if self.server.use_dbus:
1246
1950
                            # Emit D-Bus signal
1247
 
                            client.Rejected("Disabled")                    
 
1951
                            client.Rejected("Disabled")
1248
1952
                        return
1249
1953
                    
1250
 
                    if client._approved or not client.approval_delay:
 
1954
                    if client.approved or not client.approval_delay:
1251
1955
                        #We are approved or approval is disabled
1252
1956
                        break
1253
 
                    elif client._approved is None:
1254
 
                        logger.info(u"Client %s needs approval",
 
1957
                    elif client.approved is None:
 
1958
                        logger.info("Client %s needs approval",
1255
1959
                                    client.name)
1256
1960
                        if self.server.use_dbus:
1257
1961
                            # Emit D-Bus signal
1258
1962
                            client.NeedApproval(
1259
 
                                client.approval_delay_milliseconds(),
1260
 
                                client.approved_by_default)
 
1963
                                client.approval_delay.total_seconds()
 
1964
                                * 1000, client.approved_by_default)
1261
1965
                    else:
1262
 
                        logger.warning(u"Client %s was not approved",
 
1966
                        logger.warning("Client %s was not approved",
1263
1967
                                       client.name)
1264
1968
                        if self.server.use_dbus:
1265
1969
                            # Emit D-Bus signal
1267
1971
                        return
1268
1972
                    
1269
1973
                    #wait until timeout or approved
1270
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1271
1974
                    time = datetime.datetime.now()
1272
1975
                    client.changedstate.acquire()
1273
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1976
                    client.changedstate.wait(delay.total_seconds())
1274
1977
                    client.changedstate.release()
1275
1978
                    time2 = datetime.datetime.now()
1276
1979
                    if (time2 - time) >= delay:
1291
1994
                while sent_size < len(client.secret):
1292
1995
                    try:
1293
1996
                        sent = session.send(client.secret[sent_size:])
1294
 
                    except (gnutls.errors.GNUTLSError), error:
1295
 
                        logger.warning("gnutls send failed")
 
1997
                    except gnutls.errors.GNUTLSError as error:
 
1998
                        logger.warning("gnutls send failed",
 
1999
                                       exc_info=error)
1296
2000
                        return
1297
 
                    logger.debug(u"Sent: %d, remaining: %d",
1298
 
                                 sent, len(client.secret)
1299
 
                                 - (sent_size + sent))
 
2001
                    logger.debug("Sent: %d, remaining: %d", sent,
 
2002
                                 len(client.secret) - (sent_size
 
2003
                                                       + sent))
1300
2004
                    sent_size += sent
1301
 
 
1302
 
                logger.info(u"Sending secret to %s", client.name)
1303
 
                # bump the timeout as if seen
1304
 
                client.checked_ok()
 
2005
                
 
2006
                logger.info("Sending secret to %s", client.name)
 
2007
                # bump the timeout using extended_timeout
 
2008
                client.bump_timeout(client.extended_timeout)
1305
2009
                if self.server.use_dbus:
1306
2010
                    # Emit D-Bus signal
1307
2011
                    client.GotSecret()
1311
2015
                    client.approvals_pending -= 1
1312
2016
                try:
1313
2017
                    session.bye()
1314
 
                except (gnutls.errors.GNUTLSError), error:
1315
 
                    logger.warning("GnuTLS bye failed")
 
2018
                except gnutls.errors.GNUTLSError as error:
 
2019
                    logger.warning("GnuTLS bye failed",
 
2020
                                   exc_info=error)
1316
2021
    
1317
2022
    @staticmethod
1318
2023
    def peer_certificate(session):
1319
2024
        "Return the peer's OpenPGP certificate as a bytestring"
1320
2025
        # If not an OpenPGP certificate...
1321
 
        if (gnutls.library.functions
1322
 
            .gnutls_certificate_type_get(session._c_object)
 
2026
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
2027
                session._c_object)
1323
2028
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1324
2029
            # ...do the normal thing
1325
2030
            return session.peer_certificate
1328
2033
                     .gnutls_certificate_get_peers
1329
2034
                     (session._c_object, ctypes.byref(list_size)))
1330
2035
        if not bool(cert_list) and list_size.value != 0:
1331
 
            raise gnutls.errors.GNUTLSError(u"error getting peer"
1332
 
                                            u" certificate")
 
2036
            raise gnutls.errors.GNUTLSError("error getting peer"
 
2037
                                            " certificate")
1333
2038
        if list_size.value == 0:
1334
2039
            return None
1335
2040
        cert = cert_list[0]
1339
2044
    def fingerprint(openpgp):
1340
2045
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1341
2046
        # New GnuTLS "datum" with the OpenPGP public key
1342
 
        datum = (gnutls.library.types
1343
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1344
 
                                             ctypes.POINTER
1345
 
                                             (ctypes.c_ubyte)),
1346
 
                                 ctypes.c_uint(len(openpgp))))
 
2047
        datum = gnutls.library.types.gnutls_datum_t(
 
2048
            ctypes.cast(ctypes.c_char_p(openpgp),
 
2049
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2050
            ctypes.c_uint(len(openpgp)))
1347
2051
        # New empty GnuTLS certificate
1348
2052
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1349
 
        (gnutls.library.functions
1350
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2053
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
2054
            ctypes.byref(crt))
1351
2055
        # Import the OpenPGP public key into the certificate
1352
 
        (gnutls.library.functions
1353
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1354
 
                                    gnutls.library.constants
1355
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2056
        gnutls.library.functions.gnutls_openpgp_crt_import(
 
2057
            crt, ctypes.byref(datum),
 
2058
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1356
2059
        # Verify the self signature in the key
1357
2060
        crtverify = ctypes.c_uint()
1358
 
        (gnutls.library.functions
1359
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1360
 
                                         ctypes.byref(crtverify)))
 
2061
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
2062
            crt, 0, ctypes.byref(crtverify))
1361
2063
        if crtverify.value != 0:
1362
2064
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1363
 
            raise (gnutls.errors.CertificateSecurityError
1364
 
                   (u"Verify failed"))
 
2065
            raise gnutls.errors.CertificateSecurityError(
 
2066
                "Verify failed")
1365
2067
        # New buffer for the fingerprint
1366
2068
        buf = ctypes.create_string_buffer(20)
1367
2069
        buf_len = ctypes.c_size_t()
1368
2070
        # Get the fingerprint from the certificate into the buffer
1369
 
        (gnutls.library.functions
1370
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1371
 
                                             ctypes.byref(buf_len)))
 
2071
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
2072
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1372
2073
        # Deinit the certificate
1373
2074
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1374
2075
        # Convert the buffer to a Python bytestring
1375
2076
        fpr = ctypes.string_at(buf, buf_len.value)
1376
2077
        # Convert the bytestring to hexadecimal notation
1377
 
        hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
2078
        hex_fpr = binascii.hexlify(fpr).upper()
1378
2079
        return hex_fpr
1379
2080
 
1380
2081
 
1381
2082
class MultiprocessingMixIn(object):
1382
2083
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2084
    
1383
2085
    def sub_process_main(self, request, address):
1384
2086
        try:
1385
2087
            self.finish_request(request, address)
1386
 
        except:
 
2088
        except Exception:
1387
2089
            self.handle_error(request, address)
1388
2090
        self.close_request(request)
1389
 
            
 
2091
    
1390
2092
    def process_request(self, request, address):
1391
2093
        """Start a new process to process the request."""
1392
 
        multiprocessing.Process(target = self.sub_process_main,
1393
 
                                args = (request, address)).start()
 
2094
        proc = multiprocessing.Process(target = self.sub_process_main,
 
2095
                                       args = (request, address))
 
2096
        proc.start()
 
2097
        return proc
 
2098
 
1394
2099
 
1395
2100
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1396
2101
    """ adds a pipe to the MixIn """
 
2102
    
1397
2103
    def process_request(self, request, client_address):
1398
2104
        """Overrides and wraps the original process_request().
1399
2105
        
1400
2106
        This function creates a new pipe in self.pipe
1401
2107
        """
1402
2108
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1403
 
 
1404
 
        super(MultiprocessingMixInWithPipe,
1405
 
              self).process_request(request, client_address)
 
2109
        
 
2110
        proc = MultiprocessingMixIn.process_request(self, request,
 
2111
                                                    client_address)
1406
2112
        self.child_pipe.close()
1407
 
        self.add_pipe(parent_pipe)
1408
 
 
1409
 
    def add_pipe(self, parent_pipe):
 
2113
        self.add_pipe(parent_pipe, proc)
 
2114
    
 
2115
    def add_pipe(self, parent_pipe, proc):
1410
2116
        """Dummy function; override as necessary"""
1411
 
        pass
 
2117
        raise NotImplementedError()
 
2118
 
1412
2119
 
1413
2120
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1414
2121
                     socketserver.TCPServer, object):
1419
2126
        interface:      None or a network interface name (string)
1420
2127
        use_ipv6:       Boolean; to use IPv6 or not
1421
2128
    """
 
2129
    
1422
2130
    def __init__(self, server_address, RequestHandlerClass,
1423
 
                 interface=None, use_ipv6=True):
 
2131
                 interface=None,
 
2132
                 use_ipv6=True,
 
2133
                 socketfd=None):
 
2134
        """If socketfd is set, use that file descriptor instead of
 
2135
        creating a new one with socket.socket().
 
2136
        """
1424
2137
        self.interface = interface
1425
2138
        if use_ipv6:
1426
2139
            self.address_family = socket.AF_INET6
 
2140
        if socketfd is not None:
 
2141
            # Save the file descriptor
 
2142
            self.socketfd = socketfd
 
2143
            # Save the original socket.socket() function
 
2144
            self.socket_socket = socket.socket
 
2145
            # To implement --socket, we monkey patch socket.socket.
 
2146
            # 
 
2147
            # (When socketserver.TCPServer is a new-style class, we
 
2148
            # could make self.socket into a property instead of monkey
 
2149
            # patching socket.socket.)
 
2150
            # 
 
2151
            # Create a one-time-only replacement for socket.socket()
 
2152
            @functools.wraps(socket.socket)
 
2153
            def socket_wrapper(*args, **kwargs):
 
2154
                # Restore original function so subsequent calls are
 
2155
                # not affected.
 
2156
                socket.socket = self.socket_socket
 
2157
                del self.socket_socket
 
2158
                # This time only, return a new socket object from the
 
2159
                # saved file descriptor.
 
2160
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
2161
            # Replace socket.socket() function with wrapper
 
2162
            socket.socket = socket_wrapper
 
2163
        # The socketserver.TCPServer.__init__ will call
 
2164
        # socket.socket(), which might be our replacement,
 
2165
        # socket_wrapper(), if socketfd was set.
1427
2166
        socketserver.TCPServer.__init__(self, server_address,
1428
2167
                                        RequestHandlerClass)
 
2168
    
1429
2169
    def server_bind(self):
1430
2170
        """This overrides the normal server_bind() function
1431
2171
        to bind to an interface if one was specified, and also NOT to
1432
2172
        bind to an address or port if they were not specified."""
1433
2173
        if self.interface is not None:
1434
2174
            if SO_BINDTODEVICE is None:
1435
 
                logger.error(u"SO_BINDTODEVICE does not exist;"
1436
 
                             u" cannot bind to interface %s",
 
2175
                logger.error("SO_BINDTODEVICE does not exist;"
 
2176
                             " cannot bind to interface %s",
1437
2177
                             self.interface)
1438
2178
            else:
1439
2179
                try:
1440
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1441
 
                                           SO_BINDTODEVICE,
1442
 
                                           str(self.interface
1443
 
                                               + u'\0'))
1444
 
                except socket.error, error:
1445
 
                    if error[0] == errno.EPERM:
1446
 
                        logger.error(u"No permission to"
1447
 
                                     u" bind to interface %s",
1448
 
                                     self.interface)
1449
 
                    elif error[0] == errno.ENOPROTOOPT:
1450
 
                        logger.error(u"SO_BINDTODEVICE not available;"
1451
 
                                     u" cannot bind to interface %s",
1452
 
                                     self.interface)
 
2180
                    self.socket.setsockopt(
 
2181
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2182
                        (self.interface + "\0").encode("utf-8"))
 
2183
                except socket.error as error:
 
2184
                    if error.errno == errno.EPERM:
 
2185
                        logger.error("No permission to bind to"
 
2186
                                     " interface %s", self.interface)
 
2187
                    elif error.errno == errno.ENOPROTOOPT:
 
2188
                        logger.error("SO_BINDTODEVICE not available;"
 
2189
                                     " cannot bind to interface %s",
 
2190
                                     self.interface)
 
2191
                    elif error.errno == errno.ENODEV:
 
2192
                        logger.error("Interface %s does not exist,"
 
2193
                                     " cannot bind", self.interface)
1453
2194
                    else:
1454
2195
                        raise
1455
2196
        # Only bind(2) the socket if we really need to.
1456
2197
        if self.server_address[0] or self.server_address[1]:
1457
2198
            if not self.server_address[0]:
1458
2199
                if self.address_family == socket.AF_INET6:
1459
 
                    any_address = u"::" # in6addr_any
 
2200
                    any_address = "::" # in6addr_any
1460
2201
                else:
1461
 
                    any_address = socket.INADDR_ANY
 
2202
                    any_address = "0.0.0.0" # INADDR_ANY
1462
2203
                self.server_address = (any_address,
1463
2204
                                       self.server_address[1])
1464
2205
            elif not self.server_address[1]:
1465
 
                self.server_address = (self.server_address[0],
1466
 
                                       0)
 
2206
                self.server_address = (self.server_address[0], 0)
1467
2207
#                 if self.interface:
1468
2208
#                     self.server_address = (self.server_address[0],
1469
2209
#                                            0, # port
1483
2223
    
1484
2224
    Assumes a gobject.MainLoop event loop.
1485
2225
    """
 
2226
    
1486
2227
    def __init__(self, server_address, RequestHandlerClass,
1487
 
                 interface=None, use_ipv6=True, clients=None,
1488
 
                 gnutls_priority=None, use_dbus=True):
 
2228
                 interface=None,
 
2229
                 use_ipv6=True,
 
2230
                 clients=None,
 
2231
                 gnutls_priority=None,
 
2232
                 use_dbus=True,
 
2233
                 socketfd=None):
1489
2234
        self.enabled = False
1490
2235
        self.clients = clients
1491
2236
        if self.clients is None:
1492
 
            self.clients = set()
 
2237
            self.clients = {}
1493
2238
        self.use_dbus = use_dbus
1494
2239
        self.gnutls_priority = gnutls_priority
1495
2240
        IPv6_TCPServer.__init__(self, server_address,
1496
2241
                                RequestHandlerClass,
1497
2242
                                interface = interface,
1498
 
                                use_ipv6 = use_ipv6)
 
2243
                                use_ipv6 = use_ipv6,
 
2244
                                socketfd = socketfd)
 
2245
    
1499
2246
    def server_activate(self):
1500
2247
        if self.enabled:
1501
2248
            return socketserver.TCPServer.server_activate(self)
 
2249
    
1502
2250
    def enable(self):
1503
2251
        self.enabled = True
1504
 
    def add_pipe(self, parent_pipe):
 
2252
    
 
2253
    def add_pipe(self, parent_pipe, proc):
1505
2254
        # Call "handle_ipc" for both data and EOF events
1506
 
        gobject.io_add_watch(parent_pipe.fileno(),
1507
 
                             gobject.IO_IN | gobject.IO_HUP,
1508
 
                             functools.partial(self.handle_ipc,
1509
 
                                               parent_pipe = parent_pipe))
1510
 
        
1511
 
    def handle_ipc(self, source, condition, parent_pipe=None,
 
2255
        gobject.io_add_watch(
 
2256
            parent_pipe.fileno(),
 
2257
            gobject.IO_IN | gobject.IO_HUP,
 
2258
            functools.partial(self.handle_ipc,
 
2259
                              parent_pipe = parent_pipe,
 
2260
                              proc = proc))
 
2261
    
 
2262
    def handle_ipc(self, source, condition,
 
2263
                   parent_pipe=None,
 
2264
                   proc = None,
1512
2265
                   client_object=None):
1513
 
        condition_names = {
1514
 
            gobject.IO_IN: u"IN",   # There is data to read.
1515
 
            gobject.IO_OUT: u"OUT", # Data can be written (without
1516
 
                                    # blocking).
1517
 
            gobject.IO_PRI: u"PRI", # There is urgent data to read.
1518
 
            gobject.IO_ERR: u"ERR", # Error condition.
1519
 
            gobject.IO_HUP: u"HUP"  # Hung up (the connection has been
1520
 
                                    # broken, usually for pipes and
1521
 
                                    # sockets).
1522
 
            }
1523
 
        conditions_string = ' | '.join(name
1524
 
                                       for cond, name in
1525
 
                                       condition_names.iteritems()
1526
 
                                       if cond & condition)
1527
 
        # error or the other end of multiprocessing.Pipe has closed
1528
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2266
        # error, or the other end of multiprocessing.Pipe has closed
 
2267
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2268
            # Wait for other process to exit
 
2269
            proc.join()
1529
2270
            return False
1530
2271
        
1531
2272
        # Read a request from the child
1536
2277
            fpr = request[1]
1537
2278
            address = request[2]
1538
2279
            
1539
 
            for c in self.clients:
 
2280
            for c in self.clients.itervalues():
1540
2281
                if c.fingerprint == fpr:
1541
2282
                    client = c
1542
2283
                    break
1543
2284
            else:
1544
 
                logger.warning(u"Client not found for fingerprint: %s, ad"
1545
 
                               u"dress: %s", fpr, address)
 
2285
                logger.info("Client not found for fingerprint: %s, ad"
 
2286
                            "dress: %s", fpr, address)
1546
2287
                if self.use_dbus:
1547
2288
                    # Emit D-Bus signal
1548
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2289
                    mandos_dbus_service.ClientNotFound(fpr,
 
2290
                                                       address[0])
1549
2291
                parent_pipe.send(False)
1550
2292
                return False
1551
2293
            
1552
 
            gobject.io_add_watch(parent_pipe.fileno(),
1553
 
                                 gobject.IO_IN | gobject.IO_HUP,
1554
 
                                 functools.partial(self.handle_ipc,
1555
 
                                                   parent_pipe = parent_pipe,
1556
 
                                                   client_object = client))
 
2294
            gobject.io_add_watch(
 
2295
                parent_pipe.fileno(),
 
2296
                gobject.IO_IN | gobject.IO_HUP,
 
2297
                functools.partial(self.handle_ipc,
 
2298
                                  parent_pipe = parent_pipe,
 
2299
                                  proc = proc,
 
2300
                                  client_object = client))
1557
2301
            parent_pipe.send(True)
1558
 
            # remove the old hook in favor of the new above hook on same fileno
 
2302
            # remove the old hook in favor of the new above hook on
 
2303
            # same fileno
1559
2304
            return False
1560
2305
        if command == 'funcall':
1561
2306
            funcname = request[1]
1562
2307
            args = request[2]
1563
2308
            kwargs = request[3]
1564
2309
            
1565
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1566
 
 
 
2310
            parent_pipe.send(('data', getattr(client_object,
 
2311
                                              funcname)(*args,
 
2312
                                                        **kwargs)))
 
2313
        
1567
2314
        if command == 'getattr':
1568
2315
            attrname = request[1]
1569
 
            if callable(client_object.__getattribute__(attrname)):
1570
 
                parent_pipe.send(('function',))
 
2316
            if isinstance(client_object.__getattribute__(attrname),
 
2317
                          collections.Callable):
 
2318
                parent_pipe.send(('function', ))
1571
2319
            else:
1572
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2320
                parent_pipe.send((
 
2321
                    'data', client_object.__getattribute__(attrname)))
1573
2322
        
1574
2323
        if command == 'setattr':
1575
2324
            attrname = request[1]
1576
2325
            value = request[2]
1577
2326
            setattr(client_object, attrname, value)
1578
 
 
 
2327
        
1579
2328
        return True
1580
2329
 
1581
2330
 
 
2331
def rfc3339_duration_to_delta(duration):
 
2332
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2333
    
 
2334
    >>> rfc3339_duration_to_delta("P7D")
 
2335
    datetime.timedelta(7)
 
2336
    >>> rfc3339_duration_to_delta("PT60S")
 
2337
    datetime.timedelta(0, 60)
 
2338
    >>> rfc3339_duration_to_delta("PT60M")
 
2339
    datetime.timedelta(0, 3600)
 
2340
    >>> rfc3339_duration_to_delta("PT24H")
 
2341
    datetime.timedelta(1)
 
2342
    >>> rfc3339_duration_to_delta("P1W")
 
2343
    datetime.timedelta(7)
 
2344
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2345
    datetime.timedelta(0, 330)
 
2346
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2347
    datetime.timedelta(1, 200)
 
2348
    """
 
2349
    
 
2350
    # Parsing an RFC 3339 duration with regular expressions is not
 
2351
    # possible - there would have to be multiple places for the same
 
2352
    # values, like seconds.  The current code, while more esoteric, is
 
2353
    # cleaner without depending on a parsing library.  If Python had a
 
2354
    # built-in library for parsing we would use it, but we'd like to
 
2355
    # avoid excessive use of external libraries.
 
2356
    
 
2357
    # New type for defining tokens, syntax, and semantics all-in-one
 
2358
    Token = collections.namedtuple("Token", (
 
2359
        "regexp",  # To match token; if "value" is not None, must have
 
2360
                   # a "group" containing digits
 
2361
        "value",   # datetime.timedelta or None
 
2362
        "followers"))           # Tokens valid after this token
 
2363
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2364
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2365
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2366
    token_second = Token(re.compile(r"(\d+)S"),
 
2367
                         datetime.timedelta(seconds=1),
 
2368
                         frozenset((token_end, )))
 
2369
    token_minute = Token(re.compile(r"(\d+)M"),
 
2370
                         datetime.timedelta(minutes=1),
 
2371
                         frozenset((token_second, token_end)))
 
2372
    token_hour = Token(re.compile(r"(\d+)H"),
 
2373
                       datetime.timedelta(hours=1),
 
2374
                       frozenset((token_minute, token_end)))
 
2375
    token_time = Token(re.compile(r"T"),
 
2376
                       None,
 
2377
                       frozenset((token_hour, token_minute,
 
2378
                                  token_second)))
 
2379
    token_day = Token(re.compile(r"(\d+)D"),
 
2380
                      datetime.timedelta(days=1),
 
2381
                      frozenset((token_time, token_end)))
 
2382
    token_month = Token(re.compile(r"(\d+)M"),
 
2383
                        datetime.timedelta(weeks=4),
 
2384
                        frozenset((token_day, token_end)))
 
2385
    token_year = Token(re.compile(r"(\d+)Y"),
 
2386
                       datetime.timedelta(weeks=52),
 
2387
                       frozenset((token_month, token_end)))
 
2388
    token_week = Token(re.compile(r"(\d+)W"),
 
2389
                       datetime.timedelta(weeks=1),
 
2390
                       frozenset((token_end, )))
 
2391
    token_duration = Token(re.compile(r"P"), None,
 
2392
                           frozenset((token_year, token_month,
 
2393
                                      token_day, token_time,
 
2394
                                      token_week)))
 
2395
    # Define starting values
 
2396
    value = datetime.timedelta() # Value so far
 
2397
    found_token = None
 
2398
    followers = frozenset((token_duration, )) # Following valid tokens
 
2399
    s = duration                # String left to parse
 
2400
    # Loop until end token is found
 
2401
    while found_token is not token_end:
 
2402
        # Search for any currently valid tokens
 
2403
        for token in followers:
 
2404
            match = token.regexp.match(s)
 
2405
            if match is not None:
 
2406
                # Token found
 
2407
                if token.value is not None:
 
2408
                    # Value found, parse digits
 
2409
                    factor = int(match.group(1), 10)
 
2410
                    # Add to value so far
 
2411
                    value += factor * token.value
 
2412
                # Strip token from string
 
2413
                s = token.regexp.sub("", s, 1)
 
2414
                # Go to found token
 
2415
                found_token = token
 
2416
                # Set valid next tokens
 
2417
                followers = found_token.followers
 
2418
                break
 
2419
        else:
 
2420
            # No currently valid tokens were found
 
2421
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2422
                             .format(duration))
 
2423
    # End token found
 
2424
    return value
 
2425
 
 
2426
 
1582
2427
def string_to_delta(interval):
1583
2428
    """Parse a string and return a datetime.timedelta
1584
2429
    
1585
 
    >>> string_to_delta(u'7d')
 
2430
    >>> string_to_delta('7d')
1586
2431
    datetime.timedelta(7)
1587
 
    >>> string_to_delta(u'60s')
 
2432
    >>> string_to_delta('60s')
1588
2433
    datetime.timedelta(0, 60)
1589
 
    >>> string_to_delta(u'60m')
 
2434
    >>> string_to_delta('60m')
1590
2435
    datetime.timedelta(0, 3600)
1591
 
    >>> string_to_delta(u'24h')
 
2436
    >>> string_to_delta('24h')
1592
2437
    datetime.timedelta(1)
1593
 
    >>> string_to_delta(u'1w')
 
2438
    >>> string_to_delta('1w')
1594
2439
    datetime.timedelta(7)
1595
 
    >>> string_to_delta(u'5m 30s')
 
2440
    >>> string_to_delta('5m 30s')
1596
2441
    datetime.timedelta(0, 330)
1597
2442
    """
 
2443
    
 
2444
    try:
 
2445
        return rfc3339_duration_to_delta(interval)
 
2446
    except ValueError:
 
2447
        pass
 
2448
    
1598
2449
    timevalue = datetime.timedelta(0)
1599
2450
    for s in interval.split():
1600
2451
        try:
1601
 
            suffix = unicode(s[-1])
 
2452
            suffix = s[-1]
1602
2453
            value = int(s[:-1])
1603
 
            if suffix == u"d":
 
2454
            if suffix == "d":
1604
2455
                delta = datetime.timedelta(value)
1605
 
            elif suffix == u"s":
 
2456
            elif suffix == "s":
1606
2457
                delta = datetime.timedelta(0, value)
1607
 
            elif suffix == u"m":
 
2458
            elif suffix == "m":
1608
2459
                delta = datetime.timedelta(0, 0, 0, 0, value)
1609
 
            elif suffix == u"h":
 
2460
            elif suffix == "h":
1610
2461
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1611
 
            elif suffix == u"w":
 
2462
            elif suffix == "w":
1612
2463
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1613
2464
            else:
1614
 
                raise ValueError(u"Unknown suffix %r" % suffix)
1615
 
        except (ValueError, IndexError), e:
1616
 
            raise ValueError(e.message)
 
2465
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2466
        except IndexError as e:
 
2467
            raise ValueError(*(e.args))
1617
2468
        timevalue += delta
1618
2469
    return timevalue
1619
2470
 
1620
2471
 
1621
 
def if_nametoindex(interface):
1622
 
    """Call the C function if_nametoindex(), or equivalent
1623
 
    
1624
 
    Note: This function cannot accept a unicode string."""
1625
 
    global if_nametoindex
1626
 
    try:
1627
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1628
 
                          (ctypes.util.find_library(u"c"))
1629
 
                          .if_nametoindex)
1630
 
    except (OSError, AttributeError):
1631
 
        logger.warning(u"Doing if_nametoindex the hard way")
1632
 
        def if_nametoindex(interface):
1633
 
            "Get an interface index the hard way, i.e. using fcntl()"
1634
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1635
 
            with contextlib.closing(socket.socket()) as s:
1636
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1637
 
                                    struct.pack(str(u"16s16x"),
1638
 
                                                interface))
1639
 
            interface_index = struct.unpack(str(u"I"),
1640
 
                                            ifreq[16:20])[0]
1641
 
            return interface_index
1642
 
    return if_nametoindex(interface)
1643
 
 
1644
 
 
1645
2472
def daemon(nochdir = False, noclose = False):
1646
2473
    """See daemon(3).  Standard BSD Unix function.
1647
2474
    
1650
2477
        sys.exit()
1651
2478
    os.setsid()
1652
2479
    if not nochdir:
1653
 
        os.chdir(u"/")
 
2480
        os.chdir("/")
1654
2481
    if os.fork():
1655
2482
        sys.exit()
1656
2483
    if not noclose:
1657
2484
        # Close all standard open file descriptors
1658
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2485
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1659
2486
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1660
2487
            raise OSError(errno.ENODEV,
1661
 
                          u"%s not a character device"
1662
 
                          % os.path.devnull)
 
2488
                          "{} not a character device"
 
2489
                          .format(os.devnull))
1663
2490
        os.dup2(null, sys.stdin.fileno())
1664
2491
        os.dup2(null, sys.stdout.fileno())
1665
2492
        os.dup2(null, sys.stderr.fileno())
1672
2499
    ##################################################################
1673
2500
    # Parsing of options, both command line and config file
1674
2501
    
1675
 
    parser = optparse.OptionParser(version = "%%prog %s" % version)
1676
 
    parser.add_option("-i", u"--interface", type=u"string",
1677
 
                      metavar="IF", help=u"Bind to interface IF")
1678
 
    parser.add_option("-a", u"--address", type=u"string",
1679
 
                      help=u"Address to listen for requests on")
1680
 
    parser.add_option("-p", u"--port", type=u"int",
1681
 
                      help=u"Port number to receive requests on")
1682
 
    parser.add_option("--check", action=u"store_true",
1683
 
                      help=u"Run self-test")
1684
 
    parser.add_option("--debug", action=u"store_true",
1685
 
                      help=u"Debug mode; run in foreground and log to"
1686
 
                      u" terminal")
1687
 
    parser.add_option("--debuglevel", type=u"string", metavar="Level",
1688
 
                      help=u"Debug level for stdout output")
1689
 
    parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1690
 
                      u" priority string (see GnuTLS documentation)")
1691
 
    parser.add_option("--servicename", type=u"string",
1692
 
                      metavar=u"NAME", help=u"Zeroconf service name")
1693
 
    parser.add_option("--configdir", type=u"string",
1694
 
                      default=u"/etc/mandos", metavar=u"DIR",
1695
 
                      help=u"Directory to search for configuration"
1696
 
                      u" files")
1697
 
    parser.add_option("--no-dbus", action=u"store_false",
1698
 
                      dest=u"use_dbus", help=u"Do not provide D-Bus"
1699
 
                      u" system bus interface")
1700
 
    parser.add_option("--no-ipv6", action=u"store_false",
1701
 
                      dest=u"use_ipv6", help=u"Do not use IPv6")
1702
 
    options = parser.parse_args()[0]
 
2502
    parser = argparse.ArgumentParser()
 
2503
    parser.add_argument("-v", "--version", action="version",
 
2504
                        version = "%(prog)s {}".format(version),
 
2505
                        help="show version number and exit")
 
2506
    parser.add_argument("-i", "--interface", metavar="IF",
 
2507
                        help="Bind to interface IF")
 
2508
    parser.add_argument("-a", "--address",
 
2509
                        help="Address to listen for requests on")
 
2510
    parser.add_argument("-p", "--port", type=int,
 
2511
                        help="Port number to receive requests on")
 
2512
    parser.add_argument("--check", action="store_true",
 
2513
                        help="Run self-test")
 
2514
    parser.add_argument("--debug", action="store_true",
 
2515
                        help="Debug mode; run in foreground and log"
 
2516
                        " to terminal", default=None)
 
2517
    parser.add_argument("--debuglevel", metavar="LEVEL",
 
2518
                        help="Debug level for stdout output")
 
2519
    parser.add_argument("--priority", help="GnuTLS"
 
2520
                        " priority string (see GnuTLS documentation)")
 
2521
    parser.add_argument("--servicename",
 
2522
                        metavar="NAME", help="Zeroconf service name")
 
2523
    parser.add_argument("--configdir",
 
2524
                        default="/etc/mandos", metavar="DIR",
 
2525
                        help="Directory to search for configuration"
 
2526
                        " files")
 
2527
    parser.add_argument("--no-dbus", action="store_false",
 
2528
                        dest="use_dbus", help="Do not provide D-Bus"
 
2529
                        " system bus interface", default=None)
 
2530
    parser.add_argument("--no-ipv6", action="store_false",
 
2531
                        dest="use_ipv6", help="Do not use IPv6",
 
2532
                        default=None)
 
2533
    parser.add_argument("--no-restore", action="store_false",
 
2534
                        dest="restore", help="Do not restore stored"
 
2535
                        " state", default=None)
 
2536
    parser.add_argument("--socket", type=int,
 
2537
                        help="Specify a file descriptor to a network"
 
2538
                        " socket to use instead of creating one")
 
2539
    parser.add_argument("--statedir", metavar="DIR",
 
2540
                        help="Directory to save/restore state in")
 
2541
    parser.add_argument("--foreground", action="store_true",
 
2542
                        help="Run in foreground", default=None)
 
2543
    parser.add_argument("--no-zeroconf", action="store_false",
 
2544
                        dest="zeroconf", help="Do not use Zeroconf",
 
2545
                        default=None)
 
2546
    
 
2547
    options = parser.parse_args()
1703
2548
    
1704
2549
    if options.check:
1705
2550
        import doctest
1706
 
        doctest.testmod()
1707
 
        sys.exit()
 
2551
        fail_count, test_count = doctest.testmod()
 
2552
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1708
2553
    
1709
2554
    # Default values for config file for server-global settings
1710
 
    server_defaults = { u"interface": u"",
1711
 
                        u"address": u"",
1712
 
                        u"port": u"",
1713
 
                        u"debug": u"False",
1714
 
                        u"priority":
1715
 
                        u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1716
 
                        u"servicename": u"Mandos",
1717
 
                        u"use_dbus": u"True",
1718
 
                        u"use_ipv6": u"True",
1719
 
                        u"debuglevel": u"",
1720
 
                        }
 
2555
    server_defaults = { "interface": "",
 
2556
                        "address": "",
 
2557
                        "port": "",
 
2558
                        "debug": "False",
 
2559
                        "priority":
 
2560
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2561
                        ":+SIGN-DSA-SHA256",
 
2562
                        "servicename": "Mandos",
 
2563
                        "use_dbus": "True",
 
2564
                        "use_ipv6": "True",
 
2565
                        "debuglevel": "",
 
2566
                        "restore": "True",
 
2567
                        "socket": "",
 
2568
                        "statedir": "/var/lib/mandos",
 
2569
                        "foreground": "False",
 
2570
                        "zeroconf": "True",
 
2571
                    }
1721
2572
    
1722
2573
    # Parse config file for server-global settings
1723
2574
    server_config = configparser.SafeConfigParser(server_defaults)
1724
2575
    del server_defaults
1725
 
    server_config.read(os.path.join(options.configdir,
1726
 
                                    u"mandos.conf"))
 
2576
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
1727
2577
    # Convert the SafeConfigParser object to a dict
1728
2578
    server_settings = server_config.defaults()
1729
2579
    # Use the appropriate methods on the non-string config options
1730
 
    for option in (u"debug", u"use_dbus", u"use_ipv6"):
1731
 
        server_settings[option] = server_config.getboolean(u"DEFAULT",
 
2580
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
2581
        server_settings[option] = server_config.getboolean("DEFAULT",
1732
2582
                                                           option)
1733
2583
    if server_settings["port"]:
1734
 
        server_settings["port"] = server_config.getint(u"DEFAULT",
1735
 
                                                       u"port")
 
2584
        server_settings["port"] = server_config.getint("DEFAULT",
 
2585
                                                       "port")
 
2586
    if server_settings["socket"]:
 
2587
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2588
                                                         "socket")
 
2589
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2590
        # over with an opened os.devnull.  But we don't want this to
 
2591
        # happen with a supplied network socket.
 
2592
        if 0 <= server_settings["socket"] <= 2:
 
2593
            server_settings["socket"] = os.dup(server_settings
 
2594
                                               ["socket"])
1736
2595
    del server_config
1737
2596
    
1738
2597
    # Override the settings from the config file with command line
1739
2598
    # options, if set.
1740
 
    for option in (u"interface", u"address", u"port", u"debug",
1741
 
                   u"priority", u"servicename", u"configdir",
1742
 
                   u"use_dbus", u"use_ipv6", u"debuglevel"):
 
2599
    for option in ("interface", "address", "port", "debug",
 
2600
                   "priority", "servicename", "configdir", "use_dbus",
 
2601
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2602
                   "socket", "foreground", "zeroconf"):
1743
2603
        value = getattr(options, option)
1744
2604
        if value is not None:
1745
2605
            server_settings[option] = value
1746
2606
    del options
1747
2607
    # Force all strings to be unicode
1748
2608
    for option in server_settings.keys():
1749
 
        if type(server_settings[option]) is str:
1750
 
            server_settings[option] = unicode(server_settings[option])
 
2609
        if isinstance(server_settings[option], bytes):
 
2610
            server_settings[option] = (server_settings[option]
 
2611
                                       .decode("utf-8"))
 
2612
    # Force all boolean options to be boolean
 
2613
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2614
                   "foreground", "zeroconf"):
 
2615
        server_settings[option] = bool(server_settings[option])
 
2616
    # Debug implies foreground
 
2617
    if server_settings["debug"]:
 
2618
        server_settings["foreground"] = True
1751
2619
    # Now we have our good server settings in "server_settings"
1752
2620
    
1753
2621
    ##################################################################
1754
2622
    
 
2623
    if (not server_settings["zeroconf"]
 
2624
        and not (server_settings["port"]
 
2625
                 or server_settings["socket"] != "")):
 
2626
        parser.error("Needs port or socket to work without Zeroconf")
 
2627
    
1755
2628
    # For convenience
1756
 
    debug = server_settings[u"debug"]
1757
 
    debuglevel = server_settings[u"debuglevel"]
1758
 
    use_dbus = server_settings[u"use_dbus"]
1759
 
    use_ipv6 = server_settings[u"use_ipv6"]
1760
 
 
1761
 
    if server_settings[u"servicename"] != u"Mandos":
1762
 
        syslogger.setFormatter(logging.Formatter
1763
 
                               (u'Mandos (%s) [%%(process)d]:'
1764
 
                                u' %%(levelname)s: %%(message)s'
1765
 
                                % server_settings[u"servicename"]))
 
2629
    debug = server_settings["debug"]
 
2630
    debuglevel = server_settings["debuglevel"]
 
2631
    use_dbus = server_settings["use_dbus"]
 
2632
    use_ipv6 = server_settings["use_ipv6"]
 
2633
    stored_state_path = os.path.join(server_settings["statedir"],
 
2634
                                     stored_state_file)
 
2635
    foreground = server_settings["foreground"]
 
2636
    zeroconf = server_settings["zeroconf"]
 
2637
    
 
2638
    if debug:
 
2639
        initlogger(debug, logging.DEBUG)
 
2640
    else:
 
2641
        if not debuglevel:
 
2642
            initlogger(debug)
 
2643
        else:
 
2644
            level = getattr(logging, debuglevel.upper())
 
2645
            initlogger(debug, level)
 
2646
    
 
2647
    if server_settings["servicename"] != "Mandos":
 
2648
        syslogger.setFormatter(
 
2649
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2650
                              ' %(levelname)s: %(message)s'.format(
 
2651
                                  server_settings["servicename"])))
1766
2652
    
1767
2653
    # Parse config file with clients
1768
 
    client_defaults = { u"timeout": u"1h",
1769
 
                        u"interval": u"5m",
1770
 
                        u"checker": u"fping -q -- %%(host)s",
1771
 
                        u"host": u"",
1772
 
                        u"approval_delay": u"0s",
1773
 
                        u"approval_duration": u"1s",
1774
 
                        }
1775
 
    client_config = configparser.SafeConfigParser(client_defaults)
1776
 
    client_config.read(os.path.join(server_settings[u"configdir"],
1777
 
                                    u"clients.conf"))
 
2654
    client_config = configparser.SafeConfigParser(Client
 
2655
                                                  .client_defaults)
 
2656
    client_config.read(os.path.join(server_settings["configdir"],
 
2657
                                    "clients.conf"))
1778
2658
    
1779
2659
    global mandos_dbus_service
1780
2660
    mandos_dbus_service = None
1781
2661
    
1782
 
    tcp_server = MandosServer((server_settings[u"address"],
1783
 
                               server_settings[u"port"]),
1784
 
                              ClientHandler,
1785
 
                              interface=(server_settings[u"interface"]
1786
 
                                         or None),
1787
 
                              use_ipv6=use_ipv6,
1788
 
                              gnutls_priority=
1789
 
                              server_settings[u"priority"],
1790
 
                              use_dbus=use_dbus)
1791
 
    if not debug:
1792
 
        pidfilename = u"/var/run/mandos.pid"
 
2662
    socketfd = None
 
2663
    if server_settings["socket"] != "":
 
2664
        socketfd = server_settings["socket"]
 
2665
    tcp_server = MandosServer(
 
2666
        (server_settings["address"], server_settings["port"]),
 
2667
        ClientHandler,
 
2668
        interface=(server_settings["interface"] or None),
 
2669
        use_ipv6=use_ipv6,
 
2670
        gnutls_priority=server_settings["priority"],
 
2671
        use_dbus=use_dbus,
 
2672
        socketfd=socketfd)
 
2673
    if not foreground:
 
2674
        pidfilename = "/run/mandos.pid"
 
2675
        if not os.path.isdir("/run/."):
 
2676
            pidfilename = "/var/run/mandos.pid"
 
2677
        pidfile = None
1793
2678
        try:
1794
 
            pidfile = open(pidfilename, u"w")
1795
 
        except IOError:
1796
 
            logger.error(u"Could not open file %r", pidfilename)
 
2679
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2680
        except IOError as e:
 
2681
            logger.error("Could not open file %r", pidfilename,
 
2682
                         exc_info=e)
1797
2683
    
1798
 
    try:
1799
 
        uid = pwd.getpwnam(u"_mandos").pw_uid
1800
 
        gid = pwd.getpwnam(u"_mandos").pw_gid
1801
 
    except KeyError:
 
2684
    for name in ("_mandos", "mandos", "nobody"):
1802
2685
        try:
1803
 
            uid = pwd.getpwnam(u"mandos").pw_uid
1804
 
            gid = pwd.getpwnam(u"mandos").pw_gid
 
2686
            uid = pwd.getpwnam(name).pw_uid
 
2687
            gid = pwd.getpwnam(name).pw_gid
 
2688
            break
1805
2689
        except KeyError:
1806
 
            try:
1807
 
                uid = pwd.getpwnam(u"nobody").pw_uid
1808
 
                gid = pwd.getpwnam(u"nobody").pw_gid
1809
 
            except KeyError:
1810
 
                uid = 65534
1811
 
                gid = 65534
 
2690
            continue
 
2691
    else:
 
2692
        uid = 65534
 
2693
        gid = 65534
1812
2694
    try:
1813
2695
        os.setgid(gid)
1814
2696
        os.setuid(uid)
1815
 
    except OSError, error:
1816
 
        if error[0] != errno.EPERM:
1817
 
            raise error
 
2697
    except OSError as error:
 
2698
        if error.errno != errno.EPERM:
 
2699
            raise
1818
2700
    
1819
 
    if not debug and not debuglevel:
1820
 
        syslogger.setLevel(logging.WARNING)
1821
 
        console.setLevel(logging.WARNING)
1822
 
    if debuglevel:
1823
 
        level = getattr(logging, debuglevel.upper())
1824
 
        syslogger.setLevel(level)
1825
 
        console.setLevel(level)
1826
 
 
1827
2701
    if debug:
1828
2702
        # Enable all possible GnuTLS debugging
1829
2703
        
1833
2707
        
1834
2708
        @gnutls.library.types.gnutls_log_func
1835
2709
        def debug_gnutls(level, string):
1836
 
            logger.debug(u"GnuTLS: %s", string[:-1])
 
2710
            logger.debug("GnuTLS: %s", string[:-1])
1837
2711
        
1838
 
        (gnutls.library.functions
1839
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2712
        gnutls.library.functions.gnutls_global_set_log_function(
 
2713
            debug_gnutls)
1840
2714
        
1841
2715
        # Redirect stdin so all checkers get /dev/null
1842
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2716
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1843
2717
        os.dup2(null, sys.stdin.fileno())
1844
2718
        if null > 2:
1845
2719
            os.close(null)
1846
 
    else:
1847
 
        # No console logging
1848
 
        logger.removeHandler(console)
1849
 
    
 
2720
    
 
2721
    # Need to fork before connecting to D-Bus
 
2722
    if not foreground:
 
2723
        # Close all input and output, do double fork, etc.
 
2724
        daemon()
 
2725
    
 
2726
    # multiprocessing will use threads, so before we use gobject we
 
2727
    # need to inform gobject that threads will be used.
 
2728
    gobject.threads_init()
1850
2729
    
1851
2730
    global main_loop
1852
2731
    # From the Avahi example code
1853
 
    DBusGMainLoop(set_as_default=True )
 
2732
    DBusGMainLoop(set_as_default=True)
1854
2733
    main_loop = gobject.MainLoop()
1855
2734
    bus = dbus.SystemBus()
1856
2735
    # End of Avahi example code
1857
2736
    if use_dbus:
1858
2737
        try:
1859
 
            bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1860
 
                                            bus, do_not_queue=True)
1861
 
        except dbus.exceptions.NameExistsException, e:
1862
 
            logger.error(unicode(e) + u", disabling D-Bus")
 
2738
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
2739
                                            bus,
 
2740
                                            do_not_queue=True)
 
2741
            old_bus_name = dbus.service.BusName(
 
2742
                "se.bsnet.fukt.Mandos", bus,
 
2743
                do_not_queue=True)
 
2744
        except dbus.exceptions.DBusException as e:
 
2745
            logger.error("Disabling D-Bus:", exc_info=e)
1863
2746
            use_dbus = False
1864
 
            server_settings[u"use_dbus"] = False
 
2747
            server_settings["use_dbus"] = False
1865
2748
            tcp_server.use_dbus = False
1866
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1867
 
    service = AvahiService(name = server_settings[u"servicename"],
1868
 
                           servicetype = u"_mandos._tcp",
1869
 
                           protocol = protocol, bus = bus)
1870
 
    if server_settings["interface"]:
1871
 
        service.interface = (if_nametoindex
1872
 
                             (str(server_settings[u"interface"])))
1873
 
 
1874
 
    if not debug:
1875
 
        # Close all input and output, do double fork, etc.
1876
 
        daemon()
1877
 
        
 
2749
    if zeroconf:
 
2750
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2751
        service = AvahiServiceToSyslog(
 
2752
            name = server_settings["servicename"],
 
2753
            servicetype = "_mandos._tcp",
 
2754
            protocol = protocol,
 
2755
            bus = bus)
 
2756
        if server_settings["interface"]:
 
2757
            service.interface = if_nametoindex(
 
2758
                server_settings["interface"].encode("utf-8"))
 
2759
    
1878
2760
    global multiprocessing_manager
1879
2761
    multiprocessing_manager = multiprocessing.Manager()
1880
2762
    
1881
2763
    client_class = Client
1882
2764
    if use_dbus:
1883
2765
        client_class = functools.partial(ClientDBus, bus = bus)
1884
 
    def client_config_items(config, section):
1885
 
        special_settings = {
1886
 
            "approved_by_default":
1887
 
                lambda: config.getboolean(section,
1888
 
                                          "approved_by_default"),
1889
 
            }
1890
 
        for name, value in config.items(section):
 
2766
    
 
2767
    client_settings = Client.config_parser(client_config)
 
2768
    old_client_settings = {}
 
2769
    clients_data = {}
 
2770
    
 
2771
    # This is used to redirect stdout and stderr for checker processes
 
2772
    global wnull
 
2773
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2774
    # Only used if server is running in foreground but not in debug
 
2775
    # mode
 
2776
    if debug or not foreground:
 
2777
        wnull.close()
 
2778
    
 
2779
    # Get client data and settings from last running state.
 
2780
    if server_settings["restore"]:
 
2781
        try:
 
2782
            with open(stored_state_path, "rb") as stored_state:
 
2783
                clients_data, old_client_settings = pickle.load(
 
2784
                    stored_state)
 
2785
            os.remove(stored_state_path)
 
2786
        except IOError as e:
 
2787
            if e.errno == errno.ENOENT:
 
2788
                logger.warning("Could not load persistent state:"
 
2789
                               " {}".format(os.strerror(e.errno)))
 
2790
            else:
 
2791
                logger.critical("Could not load persistent state:",
 
2792
                                exc_info=e)
 
2793
                raise
 
2794
        except EOFError as e:
 
2795
            logger.warning("Could not load persistent state: "
 
2796
                           "EOFError:",
 
2797
                           exc_info=e)
 
2798
    
 
2799
    with PGPEngine() as pgp:
 
2800
        for client_name, client in clients_data.items():
 
2801
            # Skip removed clients
 
2802
            if client_name not in client_settings:
 
2803
                continue
 
2804
            
 
2805
            # Decide which value to use after restoring saved state.
 
2806
            # We have three different values: Old config file,
 
2807
            # new config file, and saved state.
 
2808
            # New config value takes precedence if it differs from old
 
2809
            # config value, otherwise use saved state.
 
2810
            for name, value in client_settings[client_name].items():
 
2811
                try:
 
2812
                    # For each value in new config, check if it
 
2813
                    # differs from the old config value (Except for
 
2814
                    # the "secret" attribute)
 
2815
                    if (name != "secret"
 
2816
                        and (value !=
 
2817
                             old_client_settings[client_name][name])):
 
2818
                        client[name] = value
 
2819
                except KeyError:
 
2820
                    pass
 
2821
            
 
2822
            # Clients who has passed its expire date can still be
 
2823
            # enabled if its last checker was successful.  A Client
 
2824
            # whose checker succeeded before we stored its state is
 
2825
            # assumed to have successfully run all checkers during
 
2826
            # downtime.
 
2827
            if client["enabled"]:
 
2828
                if datetime.datetime.utcnow() >= client["expires"]:
 
2829
                    if not client["last_checked_ok"]:
 
2830
                        logger.warning(
 
2831
                            "disabling client {} - Client never "
 
2832
                            "performed a successful checker".format(
 
2833
                                client_name))
 
2834
                        client["enabled"] = False
 
2835
                    elif client["last_checker_status"] != 0:
 
2836
                        logger.warning(
 
2837
                            "disabling client {} - Client last"
 
2838
                            " checker failed with error code"
 
2839
                            " {}".format(
 
2840
                                client_name,
 
2841
                                client["last_checker_status"]))
 
2842
                        client["enabled"] = False
 
2843
                    else:
 
2844
                        client["expires"] = (
 
2845
                            datetime.datetime.utcnow()
 
2846
                            + client["timeout"])
 
2847
                        logger.debug("Last checker succeeded,"
 
2848
                                     " keeping {} enabled".format(
 
2849
                                         client_name))
1891
2850
            try:
1892
 
                yield (name, special_settings[name]())
1893
 
            except KeyError:
1894
 
                yield (name, value)
1895
 
    
1896
 
    tcp_server.clients.update(set(
1897
 
            client_class(name = section,
1898
 
                         config= dict(client_config_items(
1899
 
                        client_config, section)))
1900
 
            for section in client_config.sections()))
 
2851
                client["secret"] = pgp.decrypt(
 
2852
                    client["encrypted_secret"],
 
2853
                    client_settings[client_name]["secret"])
 
2854
            except PGPError:
 
2855
                # If decryption fails, we use secret from new settings
 
2856
                logger.debug("Failed to decrypt {} old secret".format(
 
2857
                    client_name))
 
2858
                client["secret"] = (client_settings[client_name]
 
2859
                                    ["secret"])
 
2860
    
 
2861
    # Add/remove clients based on new changes made to config
 
2862
    for client_name in (set(old_client_settings)
 
2863
                        - set(client_settings)):
 
2864
        del clients_data[client_name]
 
2865
    for client_name in (set(client_settings)
 
2866
                        - set(old_client_settings)):
 
2867
        clients_data[client_name] = client_settings[client_name]
 
2868
    
 
2869
    # Create all client objects
 
2870
    for client_name, client in clients_data.items():
 
2871
        tcp_server.clients[client_name] = client_class(
 
2872
            name = client_name,
 
2873
            settings = client,
 
2874
            server_settings = server_settings)
 
2875
    
1901
2876
    if not tcp_server.clients:
1902
 
        logger.warning(u"No clients defined")
1903
 
        
1904
 
    if not debug:
1905
 
        try:
1906
 
            with pidfile:
1907
 
                pid = os.getpid()
1908
 
                pidfile.write(str(pid) + "\n")
1909
 
            del pidfile
1910
 
        except IOError:
1911
 
            logger.error(u"Could not write to file %r with PID %d",
1912
 
                         pidfilename, pid)
1913
 
        except NameError:
1914
 
            # "pidfile" was never created
1915
 
            pass
 
2877
        logger.warning("No clients defined")
 
2878
    
 
2879
    if not foreground:
 
2880
        if pidfile is not None:
 
2881
            pid = os.getpid()
 
2882
            try:
 
2883
                with pidfile:
 
2884
                    print(pid, file=pidfile)
 
2885
            except IOError:
 
2886
                logger.error("Could not write to file %r with PID %d",
 
2887
                             pidfilename, pid)
 
2888
        del pidfile
1916
2889
        del pidfilename
1917
 
        
1918
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1919
 
 
 
2890
    
1920
2891
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1921
2892
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1922
2893
    
1923
2894
    if use_dbus:
1924
 
        class MandosDBusService(dbus.service.Object):
 
2895
        
 
2896
        @alternate_dbus_interfaces(
 
2897
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2898
        class MandosDBusService(DBusObjectWithObjectManager):
1925
2899
            """A D-Bus proxy object"""
 
2900
            
1926
2901
            def __init__(self):
1927
 
                dbus.service.Object.__init__(self, bus, u"/")
1928
 
            _interface = u"se.bsnet.fukt.Mandos"
1929
 
            
1930
 
            @dbus.service.signal(_interface, signature=u"o")
 
2902
                dbus.service.Object.__init__(self, bus, "/")
 
2903
            
 
2904
            _interface = "se.recompile.Mandos"
 
2905
            
 
2906
            @dbus.service.signal(_interface, signature="o")
1931
2907
            def ClientAdded(self, objpath):
1932
2908
                "D-Bus signal"
1933
2909
                pass
1934
2910
            
1935
 
            @dbus.service.signal(_interface, signature=u"ss")
 
2911
            @dbus.service.signal(_interface, signature="ss")
1936
2912
            def ClientNotFound(self, fingerprint, address):
1937
2913
                "D-Bus signal"
1938
2914
                pass
1939
2915
            
1940
 
            @dbus.service.signal(_interface, signature=u"os")
 
2916
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2917
                               "true"})
 
2918
            @dbus.service.signal(_interface, signature="os")
1941
2919
            def ClientRemoved(self, objpath, name):
1942
2920
                "D-Bus signal"
1943
2921
                pass
1944
2922
            
1945
 
            @dbus.service.method(_interface, out_signature=u"ao")
 
2923
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2924
                               "true"})
 
2925
            @dbus.service.method(_interface, out_signature="ao")
1946
2926
            def GetAllClients(self):
1947
2927
                "D-Bus method"
1948
 
                return dbus.Array(c.dbus_object_path
1949
 
                                  for c in tcp_server.clients)
 
2928
                return dbus.Array(c.dbus_object_path for c in
 
2929
                                  tcp_server.clients.itervalues())
1950
2930
            
 
2931
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2932
                               "true"})
1951
2933
            @dbus.service.method(_interface,
1952
 
                                 out_signature=u"a{oa{sv}}")
 
2934
                                 out_signature="a{oa{sv}}")
1953
2935
            def GetAllClientsWithProperties(self):
1954
2936
                "D-Bus method"
1955
2937
                return dbus.Dictionary(
1956
 
                    ((c.dbus_object_path, c.GetAll(u""))
1957
 
                     for c in tcp_server.clients),
1958
 
                    signature=u"oa{sv}")
 
2938
                    { c.dbus_object_path: c.GetAll(
 
2939
                        "se.recompile.Mandos.Client")
 
2940
                      for c in tcp_server.clients.itervalues() },
 
2941
                    signature="oa{sv}")
1959
2942
            
1960
 
            @dbus.service.method(_interface, in_signature=u"o")
 
2943
            @dbus.service.method(_interface, in_signature="o")
1961
2944
            def RemoveClient(self, object_path):
1962
2945
                "D-Bus method"
1963
 
                for c in tcp_server.clients:
 
2946
                for c in tcp_server.clients.itervalues():
1964
2947
                    if c.dbus_object_path == object_path:
1965
 
                        tcp_server.clients.remove(c)
 
2948
                        del tcp_server.clients[c.name]
1966
2949
                        c.remove_from_connection()
1967
 
                        # Don't signal anything except ClientRemoved
 
2950
                        # Don't signal the disabling
1968
2951
                        c.disable(quiet=True)
1969
 
                        # Emit D-Bus signal
1970
 
                        self.ClientRemoved(object_path, c.name)
 
2952
                        # Emit D-Bus signal for removal
 
2953
                        self.client_removed_signal(c)
1971
2954
                        return
1972
2955
                raise KeyError(object_path)
1973
2956
            
1974
2957
            del _interface
 
2958
            
 
2959
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
2960
                                 out_signature = "a{oa{sa{sv}}}")
 
2961
            def GetManagedObjects(self):
 
2962
                """D-Bus method"""
 
2963
                return dbus.Dictionary(
 
2964
                    { client.dbus_object_path:
 
2965
                      dbus.Dictionary(
 
2966
                          { interface: client.GetAll(interface)
 
2967
                            for interface in
 
2968
                                 client._get_all_interface_names()})
 
2969
                      for client in tcp_server.clients.values()})
 
2970
            
 
2971
            def client_added_signal(self, client):
 
2972
                """Send the new standard signal and the old signal"""
 
2973
                if use_dbus:
 
2974
                    # New standard signal
 
2975
                    self.InterfacesAdded(
 
2976
                        client.dbus_object_path,
 
2977
                        dbus.Dictionary(
 
2978
                            { interface: client.GetAll(interface)
 
2979
                              for interface in
 
2980
                              client._get_all_interface_names()}))
 
2981
                    # Old signal
 
2982
                    self.ClientAdded(client.dbus_object_path)
 
2983
            
 
2984
            def client_removed_signal(self, client):
 
2985
                """Send the new standard signal and the old signal"""
 
2986
                if use_dbus:
 
2987
                    # New standard signal
 
2988
                    self.InterfacesRemoved(
 
2989
                        client.dbus_object_path,
 
2990
                        client._get_all_interface_names())
 
2991
                    # Old signal
 
2992
                    self.ClientRemoved(client.dbus_object_path,
 
2993
                                       client.name)
1975
2994
        
1976
2995
        mandos_dbus_service = MandosDBusService()
1977
2996
    
1978
2997
    def cleanup():
1979
2998
        "Cleanup function; run on exit"
1980
 
        service.cleanup()
1981
 
        
 
2999
        if zeroconf:
 
3000
            service.cleanup()
 
3001
        
 
3002
        multiprocessing.active_children()
 
3003
        wnull.close()
 
3004
        if not (tcp_server.clients or client_settings):
 
3005
            return
 
3006
        
 
3007
        # Store client before exiting. Secrets are encrypted with key
 
3008
        # based on what config file has. If config file is
 
3009
        # removed/edited, old secret will thus be unrecovable.
 
3010
        clients = {}
 
3011
        with PGPEngine() as pgp:
 
3012
            for client in tcp_server.clients.itervalues():
 
3013
                key = client_settings[client.name]["secret"]
 
3014
                client.encrypted_secret = pgp.encrypt(client.secret,
 
3015
                                                      key)
 
3016
                client_dict = {}
 
3017
                
 
3018
                # A list of attributes that can not be pickled
 
3019
                # + secret.
 
3020
                exclude = { "bus", "changedstate", "secret",
 
3021
                            "checker", "server_settings" }
 
3022
                for name, typ in inspect.getmembers(dbus.service
 
3023
                                                    .Object):
 
3024
                    exclude.add(name)
 
3025
                
 
3026
                client_dict["encrypted_secret"] = (client
 
3027
                                                   .encrypted_secret)
 
3028
                for attr in client.client_structure:
 
3029
                    if attr not in exclude:
 
3030
                        client_dict[attr] = getattr(client, attr)
 
3031
                
 
3032
                clients[client.name] = client_dict
 
3033
                del client_settings[client.name]["secret"]
 
3034
        
 
3035
        try:
 
3036
            with tempfile.NamedTemporaryFile(
 
3037
                    mode='wb',
 
3038
                    suffix=".pickle",
 
3039
                    prefix='clients-',
 
3040
                    dir=os.path.dirname(stored_state_path),
 
3041
                    delete=False) as stored_state:
 
3042
                pickle.dump((clients, client_settings), stored_state)
 
3043
                tempname = stored_state.name
 
3044
            os.rename(tempname, stored_state_path)
 
3045
        except (IOError, OSError) as e:
 
3046
            if not debug:
 
3047
                try:
 
3048
                    os.remove(tempname)
 
3049
                except NameError:
 
3050
                    pass
 
3051
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
3052
                logger.warning("Could not save persistent state: {}"
 
3053
                               .format(os.strerror(e.errno)))
 
3054
            else:
 
3055
                logger.warning("Could not save persistent state:",
 
3056
                               exc_info=e)
 
3057
                raise
 
3058
        
 
3059
        # Delete all clients, and settings from config
1982
3060
        while tcp_server.clients:
1983
 
            client = tcp_server.clients.pop()
 
3061
            name, client = tcp_server.clients.popitem()
1984
3062
            if use_dbus:
1985
3063
                client.remove_from_connection()
1986
 
            client.disable_hook = None
1987
 
            # Don't signal anything except ClientRemoved
 
3064
            # Don't signal the disabling
1988
3065
            client.disable(quiet=True)
1989
 
            if use_dbus:
1990
 
                # Emit D-Bus signal
1991
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
1992
 
                                                  client.name)
 
3066
            # Emit D-Bus signal for removal
 
3067
            mandos_dbus_service.client_removed_signal(client)
 
3068
        client_settings.clear()
1993
3069
    
1994
3070
    atexit.register(cleanup)
1995
3071
    
1996
 
    for client in tcp_server.clients:
 
3072
    for client in tcp_server.clients.itervalues():
1997
3073
        if use_dbus:
1998
 
            # Emit D-Bus signal
1999
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2000
 
        client.enable()
 
3074
            # Emit D-Bus signal for adding
 
3075
            mandos_dbus_service.client_added_signal(client)
 
3076
        # Need to initiate checking of clients
 
3077
        if client.enabled:
 
3078
            client.init_checker()
2001
3079
    
2002
3080
    tcp_server.enable()
2003
3081
    tcp_server.server_activate()
2004
3082
    
2005
3083
    # Find out what port we got
2006
 
    service.port = tcp_server.socket.getsockname()[1]
 
3084
    if zeroconf:
 
3085
        service.port = tcp_server.socket.getsockname()[1]
2007
3086
    if use_ipv6:
2008
 
        logger.info(u"Now listening on address %r, port %d,"
2009
 
                    " flowinfo %d, scope_id %d"
2010
 
                    % tcp_server.socket.getsockname())
 
3087
        logger.info("Now listening on address %r, port %d,"
 
3088
                    " flowinfo %d, scope_id %d",
 
3089
                    *tcp_server.socket.getsockname())
2011
3090
    else:                       # IPv4
2012
 
        logger.info(u"Now listening on address %r, port %d"
2013
 
                    % tcp_server.socket.getsockname())
 
3091
        logger.info("Now listening on address %r, port %d",
 
3092
                    *tcp_server.socket.getsockname())
2014
3093
    
2015
3094
    #service.interface = tcp_server.socket.getsockname()[3]
2016
3095
    
2017
3096
    try:
2018
 
        # From the Avahi example code
2019
 
        try:
2020
 
            service.activate()
2021
 
        except dbus.exceptions.DBusException, error:
2022
 
            logger.critical(u"DBusException: %s", error)
2023
 
            cleanup()
2024
 
            sys.exit(1)
2025
 
        # End of Avahi example code
 
3097
        if zeroconf:
 
3098
            # From the Avahi example code
 
3099
            try:
 
3100
                service.activate()
 
3101
            except dbus.exceptions.DBusException as error:
 
3102
                logger.critical("D-Bus Exception", exc_info=error)
 
3103
                cleanup()
 
3104
                sys.exit(1)
 
3105
            # End of Avahi example code
2026
3106
        
2027
3107
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2028
3108
                             lambda *args, **kwargs:
2029
3109
                             (tcp_server.handle_request
2030
3110
                              (*args[2:], **kwargs) or True))
2031
3111
        
2032
 
        logger.debug(u"Starting main loop")
 
3112
        logger.debug("Starting main loop")
2033
3113
        main_loop.run()
2034
 
    except AvahiError, error:
2035
 
        logger.critical(u"AvahiError: %s", error)
 
3114
    except AvahiError as error:
 
3115
        logger.critical("Avahi Error", exc_info=error)
2036
3116
        cleanup()
2037
3117
        sys.exit(1)
2038
3118
    except KeyboardInterrupt:
2039
3119
        if debug:
2040
 
            print >> sys.stderr
2041
 
        logger.debug(u"Server received KeyboardInterrupt")
2042
 
    logger.debug(u"Server exiting")
 
3120
            print("", file=sys.stderr)
 
3121
        logger.debug("Server received KeyboardInterrupt")
 
3122
    logger.debug("Server exiting")
2043
3123
    # Must run before the D-Bus bus name gets deregistered
2044
3124
    cleanup()
2045
3125
 
 
3126
 
2046
3127
if __name__ == '__main__':
2047
3128
    main()