/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-08-10 08:25:01 UTC
  • Revision ID: teddy@recompile.se-20150810082501-rb7w2dre1flqiqe2
Refactor D-Bus annotation class out from D-Bus properties class.

* mandos (DBusObjectWithAnnotations): New; factored out D-Bus
                                      annotations code from
                                      DBusObjectWithProperties class.
  (DBusObjectWithProperties): Inherit from DBusObjectWithAnnotations.
  (main/MandosDBusService): - '' -
  (main/MandosDBusService._foo): Removed interface annotation for
                                 "o.f.D.Property.EmitsChangedSignal";
                                 this object has no properties.

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