/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 at bsnet
  • Date: 2010-09-02 19:07:20 UTC
  • mto: (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 421.
  • Revision ID: teddy@fukt.bsnet.se-20100902190720-sp0pitu30isx4pvi
* mandos (ClientDBus.approvals_pending): Bug fix: Only send D-Bus
                                         signals if connected to the
                                         D-Bus.

Show diffs side-by-side

added added

removed removed

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