/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2009-11-19 18:31:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091119183128-ttstewh61xmtnil1
* Makefile (LINK_FORTIFY_LD): Bug fix: removed "-fPIE".
* mandos-keygen: Bug fix: Fix quoting for the "--password" option.

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
64
55
import logging
65
56
import logging.handlers
66
57
import pwd
67
 
import contextlib
 
58
from contextlib import closing
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
75
 
import multiprocessing
76
 
import types
77
 
import binascii
78
 
import tempfile
79
 
import itertools
80
 
import collections
81
 
import codecs
82
62
 
83
63
import dbus
84
64
import dbus.service
85
 
try:
86
 
    import gobject
87
 
except ImportError:
88
 
    from gi.repository import GObject as gobject
 
65
import gobject
89
66
import avahi
90
67
from dbus.mainloop.glib import DBusGMainLoop
91
68
import ctypes
101
78
    except ImportError:
102
79
        SO_BINDTODEVICE = None
103
80
 
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
 
 
 
81
 
 
82
version = "1.0.14"
 
83
 
 
84
logger = logging.Logger(u'mandos')
 
85
syslogger = (logging.handlers.SysLogHandler
 
86
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
87
              address = "/dev/log"))
 
88
syslogger.setFormatter(logging.Formatter
 
89
                       (u'Mandos [%(process)d]: %(levelname)s:'
 
90
                        u' %(message)s'))
 
91
logger.addHandler(syslogger)
 
92
 
 
93
console = logging.StreamHandler()
 
94
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
 
95
                                       u' %(levelname)s:'
 
96
                                       u' %(message)s'))
 
97
logger.addHandler(console)
236
98
 
237
99
class AvahiError(Exception):
238
100
    def __init__(self, value, *args, **kwargs):
239
101
        self.value = value
240
 
        return super(AvahiError, self).__init__(value, *args,
241
 
                                                **kwargs)
242
 
 
 
102
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
103
    def __unicode__(self):
 
104
        return unicode(repr(self.value))
243
105
 
244
106
class AvahiServiceError(AvahiError):
245
107
    pass
246
108
 
247
 
 
248
109
class AvahiGroupError(AvahiError):
249
110
    pass
250
111
 
255
116
    Attributes:
256
117
    interface: integer; avahi.IF_UNSPEC or an interface index.
257
118
               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>
 
119
    name: string; Example: u'Mandos'
 
120
    type: string; Example: u'_mandos._tcp'.
 
121
                  See <http://www.dns-sd.org/ServiceTypes.html>
261
122
    port: integer; what port to announce
262
123
    TXT: list of strings; TXT record for the service
263
124
    domain: string; Domain to publish on, default to .local if empty.
269
130
    server: D-Bus Server
270
131
    bus: dbus.SystemBus()
271
132
    """
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):
 
133
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
 
134
                 servicetype = None, port = None, TXT = None,
 
135
                 domain = u"", host = u"", max_renames = 32768,
 
136
                 protocol = avahi.PROTO_UNSPEC, bus = None):
284
137
        self.interface = interface
285
138
        self.name = name
286
139
        self.type = servicetype
294
147
        self.group = None       # our entry group
295
148
        self.server = None
296
149
        self.bus = bus
297
 
        self.entry_group_state_changed_match = None
298
 
    
299
 
    def rename(self, remove=True):
 
150
    def rename(self):
300
151
        """Derived from the Avahi example code"""
301
152
        if self.rename_count >= self.max_renames:
302
 
            logger.critical("No suitable Zeroconf service name found"
303
 
                            " after %i retries, exiting.",
 
153
            logger.critical(u"No suitable Zeroconf service name found"
 
154
                            u" after %i retries, exiting.",
304
155
                            self.rename_count)
305
 
            raise AvahiServiceError("Too many renames")
306
 
        self.name = str(
307
 
            self.server.GetAlternativeServiceName(self.name))
 
156
            raise AvahiServiceError(u"Too many renames")
 
157
        self.name = self.server.GetAlternativeServiceName(self.name)
 
158
        logger.info(u"Changing Zeroconf service name to %r ...",
 
159
                    unicode(self.name))
 
160
        syslogger.setFormatter(logging.Formatter
 
161
                               (u'Mandos (%s) [%%(process)d]:'
 
162
                                u' %%(levelname)s: %%(message)s'
 
163
                                % self.name))
 
164
        self.remove()
 
165
        self.add()
308
166
        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
167
    def remove(self):
326
168
        """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
169
        if self.group is not None:
331
170
            self.group.Reset()
332
 
    
333
171
    def add(self):
334
172
        """Derived from the Avahi example code"""
335
 
        self.remove()
336
173
        if self.group is None:
337
174
            self.group = dbus.Interface(
338
175
                self.bus.get_object(avahi.DBUS_NAME,
339
176
                                    self.server.EntryGroupNew()),
340
177
                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' ...",
 
178
            self.group.connect_to_signal('StateChanged',
 
179
                                         self
 
180
                                         .entry_group_state_changed)
 
181
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
345
182
                     self.name, self.type)
346
183
        self.group.AddService(
347
184
            self.interface,
352
189
            dbus.UInt16(self.port),
353
190
            avahi.string_array_to_txt_array(self.TXT))
354
191
        self.group.Commit()
355
 
    
356
192
    def entry_group_state_changed(self, state, error):
357
193
        """Derived from the Avahi example code"""
358
 
        logger.debug("Avahi entry group state change: %i", state)
 
194
        logger.debug(u"Avahi state change: %i", state)
359
195
        
360
196
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
361
 
            logger.debug("Zeroconf service established.")
 
197
            logger.debug(u"Zeroconf service established.")
362
198
        elif state == avahi.ENTRY_GROUP_COLLISION:
363
 
            logger.info("Zeroconf service name collision.")
 
199
            logger.warning(u"Zeroconf service name collision.")
364
200
            self.rename()
365
201
        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
 
    
 
202
            logger.critical(u"Avahi: Error in group state changed %s",
 
203
                            unicode(error))
 
204
            raise AvahiGroupError(u"State changed: %s"
 
205
                                  % unicode(error))
370
206
    def cleanup(self):
371
207
        """Derived from the Avahi example code"""
372
208
        if self.group is not None:
373
 
            try:
374
 
                self.group.Free()
375
 
            except (dbus.exceptions.UnknownMethodException,
376
 
                    dbus.exceptions.DBusException):
377
 
                pass
 
209
            self.group.Free()
378
210
            self.group = None
379
 
        self.remove()
380
 
    
381
 
    def server_state_changed(self, state, error=None):
 
211
    def server_state_changed(self, state):
382
212
        """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()
 
213
        if state == avahi.SERVER_COLLISION:
 
214
            logger.error(u"Zeroconf server name collision")
 
215
            self.remove()
397
216
        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
 
    
 
217
            self.add()
416
218
    def activate(self):
417
219
        """Derived from the Avahi example code"""
418
220
        if self.server is None:
419
221
            self.server = dbus.Interface(
420
222
                self.bus.get_object(avahi.DBUS_NAME,
421
 
                                    avahi.DBUS_PATH_SERVER,
422
 
                                    follow_name_owner_changes=True),
 
223
                                    avahi.DBUS_PATH_SERVER),
423
224
                avahi.DBUS_INTERFACE_SERVER)
424
 
        self.server.connect_to_signal("StateChanged",
425
 
                                      self.server_state_changed)
 
225
        self.server.connect_to_signal(u"StateChanged",
 
226
                                 self.server_state_changed)
426
227
        self.server_state_changed(self.server.GetState())
427
228
 
428
229
 
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
230
class Client(object):
449
231
    """A representation of a client host served by this server.
450
232
    
451
233
    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
 
234
    name:       string; from the config file, used in log messages and
 
235
                        D-Bus identifiers
 
236
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
237
                 uniquely identify the client
 
238
    secret:     bytestring; sent verbatim (over TLS) to client
 
239
    host:       string; available for use by the checker command
 
240
    created:    datetime.datetime(); (UTC) object creation
 
241
    last_enabled: datetime.datetime(); (UTC)
 
242
    enabled:    bool()
 
243
    last_checked_ok: datetime.datetime(); (UTC) or None
 
244
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
245
                                      until this client is invalid
 
246
    interval:   datetime.timedelta(); How often to start a new checker
 
247
    disable_hook:  If set, called by disable() as disable_hook(self)
455
248
    checker:    subprocess.Popen(); a running checker process used
456
249
                                    to see if the client lives.
457
250
                                    '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
 
251
    checker_initiator_tag: a gobject event source tag, or None
 
252
    disable_initiator_tag: - '' -
 
253
    checker_callback_tag:  - '' -
 
254
    checker_command: string; External command which is run to check if
 
255
                     client lives.  %() expansions are done at
461
256
                     runtime with vars(self) as dict, so that for
462
257
                     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
258
    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()
492
259
    """
493
260
    
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
261
    @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):
 
262
    def _timedelta_to_milliseconds(td):
 
263
        "Convert a datetime.timedelta() to milliseconds"
 
264
        return ((td.days * 24 * 60 * 60 * 1000)
 
265
                + (td.seconds * 1000)
 
266
                + (td.microseconds // 1000))
 
267
    
 
268
    def timeout_milliseconds(self):
 
269
        "Return the 'timeout' attribute in milliseconds"
 
270
        return self._timedelta_to_milliseconds(self.timeout)
 
271
    
 
272
    def interval_milliseconds(self):
 
273
        "Return the 'interval' attribute in milliseconds"
 
274
        return self._timedelta_to_milliseconds(self.interval)
 
275
    
 
276
    def __init__(self, name = None, disable_hook=None, config=None):
 
277
        """Note: the 'checker' key in 'config' sets the
 
278
        'checker_command' attribute and *not* the 'checker'
 
279
        attribute."""
562
280
        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)
 
281
        if config is None:
 
282
            config = {}
 
283
        logger.debug(u"Creating client %r", self.name)
 
284
        # Uppercase and remove spaces from fingerprint for later
 
285
        # comparison purposes with return value from the fingerprint()
 
286
        # function
 
287
        self.fingerprint = (config[u"fingerprint"].upper()
 
288
                            .replace(u" ", u""))
 
289
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
 
290
        if u"secret" in config:
 
291
            self.secret = config[u"secret"].decode(u"base64")
 
292
        elif u"secfile" in config:
 
293
            with closing(open(os.path.expanduser
 
294
                              (os.path.expandvars
 
295
                               (config[u"secfile"])),
 
296
                              "rb")) as secfile:
 
297
                self.secret = secfile.read()
576
298
        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
 
299
            raise TypeError(u"No secret or secfile for client %s"
 
300
                            % self.name)
 
301
        self.host = config.get(u"host", u"")
 
302
        self.created = datetime.datetime.utcnow()
 
303
        self.enabled = False
 
304
        self.last_enabled = None
 
305
        self.last_checked_ok = None
 
306
        self.timeout = string_to_delta(config[u"timeout"])
 
307
        self.interval = string_to_delta(config[u"interval"])
 
308
        self.disable_hook = disable_hook
586
309
        self.checker = None
587
310
        self.checker_initiator_tag = None
588
311
        self.disable_initiator_tag = None
589
312
        self.checker_callback_tag = None
 
313
        self.checker_command = config[u"checker"]
590
314
        self.current_checker_command = None
591
 
        self.approved = None
592
 
        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)
604
 
    
605
 
    # Send notice to process children that client state has changed
606
 
    def send_changedstate(self):
607
 
        with self.changedstate:
608
 
            self.changedstate.notify_all()
 
315
        self.last_connect = None
609
316
    
610
317
    def enable(self):
611
318
        """Start this client's checker and timeout hooks"""
612
 
        if getattr(self, "enabled", False):
 
319
        if getattr(self, u"enabled", False):
613
320
            # Already enabled
614
321
            return
615
 
        self.expires = datetime.datetime.utcnow() + self.timeout
616
 
        self.enabled = True
617
322
        self.last_enabled = datetime.datetime.utcnow()
618
 
        self.init_checker()
619
 
        self.send_changedstate()
 
323
        # Schedule a new checker to be started an 'interval' from now,
 
324
        # and every interval from then on.
 
325
        self.checker_initiator_tag = (gobject.timeout_add
 
326
                                      (self.interval_milliseconds(),
 
327
                                       self.start_checker))
 
328
        # Schedule a disable() when 'timeout' has passed
 
329
        self.disable_initiator_tag = (gobject.timeout_add
 
330
                                   (self.timeout_milliseconds(),
 
331
                                    self.disable))
 
332
        self.enabled = True
 
333
        # Also start a new checker *right now*.
 
334
        self.start_checker()
620
335
    
621
336
    def disable(self, quiet=True):
622
337
        """Disable this client."""
623
338
        if not getattr(self, "enabled", False):
624
339
            return False
625
340
        if not quiet:
626
 
            logger.info("Disabling client %s", self.name)
627
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
341
            logger.info(u"Disabling client %s", self.name)
 
342
        if getattr(self, u"disable_initiator_tag", False):
628
343
            gobject.source_remove(self.disable_initiator_tag)
629
344
            self.disable_initiator_tag = None
630
 
        self.expires = None
631
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
345
        if getattr(self, u"checker_initiator_tag", False):
632
346
            gobject.source_remove(self.checker_initiator_tag)
633
347
            self.checker_initiator_tag = None
634
348
        self.stop_checker()
 
349
        if self.disable_hook:
 
350
            self.disable_hook(self)
635
351
        self.enabled = False
636
 
        if not quiet:
637
 
            self.send_changedstate()
638
352
        # Do not run this again if called by a gobject.timeout_add
639
353
        return False
640
354
    
641
355
    def __del__(self):
 
356
        self.disable_hook = None
642
357
        self.disable()
643
358
    
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):
 
359
    def checker_callback(self, pid, condition, command):
662
360
        """The checker has completed, so take appropriate actions."""
663
361
        self.checker_callback_tag = None
664
362
        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",
 
363
        if os.WIFEXITED(condition):
 
364
            exitstatus = os.WEXITSTATUS(condition)
 
365
            if exitstatus == 0:
 
366
                logger.info(u"Checker for %(name)s succeeded",
674
367
                            vars(self))
675
368
                self.checked_ok()
676
369
            else:
677
 
                logger.info("Checker for %(name)s failed", vars(self))
 
370
                logger.info(u"Checker for %(name)s failed",
 
371
                            vars(self))
678
372
        else:
679
 
            self.last_checker_status = -1
680
 
            self.last_checker_signal = -returncode
681
 
            logger.warning("Checker for %(name)s crashed?",
 
373
            logger.warning(u"Checker for %(name)s crashed?",
682
374
                           vars(self))
683
 
        return False
684
375
    
685
376
    def checked_ok(self):
686
 
        """Assert that the client has been seen, alive and well."""
 
377
        """Bump up the timeout for this client.
 
378
        
 
379
        This should only be called when the client has been seen,
 
380
        alive and well.
 
381
        """
687
382
        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()
 
383
        gobject.source_remove(self.disable_initiator_tag)
 
384
        self.disable_initiator_tag = (gobject.timeout_add
 
385
                                      (self.timeout_milliseconds(),
 
386
                                       self.disable))
706
387
    
707
388
    def start_checker(self):
708
389
        """Start a new checker subprocess if one is not running.
710
391
        If a checker already exists, leave it running and do
711
392
        nothing."""
712
393
        # 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
 
394
        # did that, then if a checker (for some reason) started
 
395
        # running slowly and taking more than 'interval' time, the
 
396
        # client would inevitably timeout, since no checker would get
 
397
        # a chance to run to completion.  If we instead leave running
717
398
        # checkers alone, the checker would have to take more time
718
 
        # than 'timeout' for the client to be disabled, which is as it
719
 
        # should be.
 
399
        # than 'timeout' for the client to be declared invalid, which
 
400
        # is as it should be.
720
401
        
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
 
402
        # If a checker exists, make sure it is not a zombie
 
403
        try:
 
404
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
405
        except (AttributeError, OSError), error:
 
406
            if (isinstance(error, OSError)
 
407
                and error.errno != errno.ECHILD):
 
408
                raise error
 
409
        else:
 
410
            if pid:
 
411
                logger.warning(u"Checker was a zombie")
 
412
                gobject.source_remove(self.checker_callback_tag)
 
413
                self.checker_callback(pid, status,
 
414
                                      self.current_checker_command)
725
415
        # Start a new checker if needed
726
416
        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
417
            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
 
418
                # In case checker_command has exactly one % operator
 
419
                command = self.checker_command % self.host
 
420
            except TypeError:
 
421
                # Escape attributes for the shell
 
422
                escaped_attrs = dict((key,
 
423
                                      re.escape(unicode(str(val),
 
424
                                                        errors=
 
425
                                                        u'replace')))
 
426
                                     for key, val in
 
427
                                     vars(self).iteritems())
 
428
                try:
 
429
                    command = self.checker_command % escaped_attrs
 
430
                except TypeError, error:
 
431
                    logger.error(u'Could not format string "%s":'
 
432
                                 u' %s', self.checker_command, error)
 
433
                    return True # Try again later
738
434
            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)
 
435
            try:
 
436
                logger.info(u"Starting checker %r for %s",
 
437
                            command, self.name)
 
438
                # We don't need to redirect stdout and stderr, since
 
439
                # in normal mode, that is already done by daemon(),
 
440
                # and in debug mode we don't want to.  (Stdin is
 
441
                # always replaced by /dev/null.)
 
442
                self.checker = subprocess.Popen(command,
 
443
                                                close_fds=True,
 
444
                                                shell=True, cwd=u"/")
 
445
                self.checker_callback_tag = (gobject.child_watch_add
 
446
                                             (self.checker.pid,
 
447
                                              self.checker_callback,
 
448
                                              data=command))
 
449
                # The checker may have completed before the gobject
 
450
                # watch was added.  Check for this.
 
451
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
452
                if pid:
 
453
                    gobject.source_remove(self.checker_callback_tag)
 
454
                    self.checker_callback(pid, status, command)
 
455
            except OSError, error:
 
456
                logger.error(u"Failed to start subprocess: %s",
 
457
                             error)
764
458
        # Re-run this periodically if run by gobject.timeout_add
765
459
        return True
766
460
    
769
463
        if self.checker_callback_tag:
770
464
            gobject.source_remove(self.checker_callback_tag)
771
465
            self.checker_callback_tag = None
772
 
        if getattr(self, "checker", None) is None:
 
466
        if getattr(self, u"checker", None) is None:
773
467
            return
774
 
        logger.debug("Stopping checker for %(name)s", vars(self))
775
 
        self.checker.terminate()
 
468
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
469
        try:
 
470
            os.kill(self.checker.pid, signal.SIGTERM)
 
471
            #time.sleep(0.5)
 
472
            #if self.checker.poll() is None:
 
473
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
474
        except OSError, error:
 
475
            if error.errno != errno.ESRCH: # No such process
 
476
                raise
776
477
        self.checker = None
777
 
 
778
 
 
779
 
def dbus_service_property(dbus_interface,
780
 
                          signature="v",
781
 
                          access="readwrite",
782
 
                          byte_arrays=False):
 
478
    
 
479
    def still_valid(self):
 
480
        """Has the timeout not yet passed for this client?"""
 
481
        if not getattr(self, u"enabled", False):
 
482
            return False
 
483
        now = datetime.datetime.utcnow()
 
484
        if self.last_checked_ok is None:
 
485
            return now < (self.created + self.timeout)
 
486
        else:
 
487
            return now < (self.last_checked_ok + self.timeout)
 
488
 
 
489
 
 
490
def dbus_service_property(dbus_interface, signature=u"v",
 
491
                          access=u"readwrite", byte_arrays=False):
783
492
    """Decorators for marking methods of a DBusObjectWithProperties to
784
493
    become properties on the D-Bus.
785
494
    
790
499
    dbus.service.method, except there is only "signature", since the
791
500
    type from Get() and the type sent to Set() is the same.
792
501
    """
793
 
    # Encoding deeply encoded byte arrays is not supported yet by the
794
 
    # "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
 
    
799
502
    def decorator(func):
800
503
        func._dbus_is_property = True
801
504
        func._dbus_interface = dbus_interface
802
505
        func._dbus_signature = signature
803
506
        func._dbus_access = access
804
507
        func._dbus_name = func.__name__
805
 
        if func._dbus_name.endswith("_dbus_property"):
 
508
        if func._dbus_name.endswith(u"_dbus_property"):
806
509
            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
 
    
 
510
        func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
 
511
        return func
853
512
    return decorator
854
513
 
855
514
 
856
515
class DBusPropertyException(dbus.exceptions.DBusException):
857
516
    """A base class for D-Bus property-related exceptions
858
517
    """
859
 
    pass
 
518
    def __unicode__(self):
 
519
        return unicode(str(self))
860
520
 
861
521
 
862
522
class DBusPropertyAccessException(DBusPropertyException):
871
531
    pass
872
532
 
873
533
 
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):
 
534
class DBusObjectWithProperties(dbus.service.Object):
964
535
    """A D-Bus object with properties.
965
 
    
 
536
 
966
537
    Classes inheriting from this can use the dbus_service_property
967
538
    decorator to expose methods as D-Bus properties.  It exposes the
968
539
    standard Get(), Set(), and GetAll() methods on the D-Bus.
969
540
    """
970
541
    
 
542
    @staticmethod
 
543
    def _is_dbus_property(obj):
 
544
        return getattr(obj, u"_dbus_is_property", False)
 
545
    
 
546
    def _get_all_dbus_properties(self):
 
547
        """Returns a generator of (name, attribute) pairs
 
548
        """
 
549
        return ((prop._dbus_name, prop)
 
550
                for name, prop in
 
551
                inspect.getmembers(self, self._is_dbus_property))
 
552
    
971
553
    def _get_dbus_property(self, interface_name, property_name):
972
554
        """Returns a bound method if one exists which is a D-Bus
973
555
        property with the specified name and interface.
974
556
        """
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
 
        
 
557
        for name in (property_name,
 
558
                     property_name + u"_dbus_property"):
 
559
            prop = getattr(self, name, None)
 
560
            if (prop is None
 
561
                or not self._is_dbus_property(prop)
 
562
                or prop._dbus_name != property_name
 
563
                or (interface_name and prop._dbus_interface
 
564
                    and interface_name != prop._dbus_interface)):
 
565
                continue
 
566
            return prop
982
567
        # 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")
 
568
        raise DBusPropertyNotFound(self.dbus_object_path + u":"
 
569
                                   + interface_name + u"."
 
570
                                   + property_name)
 
571
    
 
572
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
 
573
                         out_signature=u"v")
998
574
    def Get(self, interface_name, property_name):
999
575
        """Standard D-Bus property Get() method, see D-Bus standard.
1000
576
        """
1001
577
        prop = self._get_dbus_property(interface_name, property_name)
1002
 
        if prop._dbus_access == "write":
 
578
        if prop._dbus_access == u"write":
1003
579
            raise DBusPropertyAccessException(property_name)
1004
580
        value = prop()
1005
 
        if not hasattr(value, "variant_level"):
 
581
        if not hasattr(value, u"variant_level"):
1006
582
            return value
1007
583
        return type(value)(value, variant_level=value.variant_level+1)
1008
584
    
1009
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
 
585
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1010
586
    def Set(self, interface_name, property_name, value):
1011
587
        """Standard D-Bus property Set() method, see D-Bus standard.
1012
588
        """
1013
589
        prop = self._get_dbus_property(interface_name, property_name)
1014
 
        if prop._dbus_access == "read":
 
590
        if prop._dbus_access == u"read":
1015
591
            raise DBusPropertyAccessException(property_name)
1016
 
        if prop._dbus_get_args_options["byte_arrays"]:
1017
 
            # The byte_arrays option is not supported yet on
1018
 
            # 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))
 
592
        if prop._dbus_get_args_options[u"byte_arrays"]:
 
593
            value = dbus.ByteArray(''.join(unichr(byte)
 
594
                                           for byte in value))
1025
595
        prop(value)
1026
596
    
1027
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1028
 
                         in_signature="s",
1029
 
                         out_signature="a{sv}")
 
597
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
 
598
                         out_signature=u"a{sv}")
1030
599
    def GetAll(self, interface_name):
1031
600
        """Standard D-Bus property GetAll() method, see D-Bus
1032
601
        standard.
1033
 
        
 
602
 
1034
603
        Note: Will not include properties with access="write".
1035
604
        """
1036
 
        properties = {}
1037
 
        for name, prop in self._get_all_dbus_things("property"):
 
605
        all = {}
 
606
        for name, prop in self._get_all_dbus_properties():
1038
607
            if (interface_name
1039
608
                and interface_name != prop._dbus_interface):
1040
609
                # Interface non-empty but did not match
1041
610
                continue
1042
611
            # Ignore write-only properties
1043
 
            if prop._dbus_access == "write":
 
612
            if prop._dbus_access == u"write":
1044
613
                continue
1045
614
            value = prop()
1046
 
            if not hasattr(value, "variant_level"):
1047
 
                properties[name] = value
 
615
            if not hasattr(value, u"variant_level"):
 
616
                all[name] = value
1048
617
                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
 
618
            all[name] = type(value)(value, variant_level=
 
619
                                    value.variant_level+1)
 
620
        return dbus.Dictionary(all, signature=u"sv")
1060
621
    
1061
622
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1062
 
                         out_signature="s",
 
623
                         out_signature=u"s",
1063
624
                         path_keyword='object_path',
1064
625
                         connection_keyword='connection')
1065
626
    def Introspect(self, object_path, connection):
1066
 
        """Overloading of standard D-Bus method.
1067
 
        
1068
 
        Inserts property tags and interface annotation tags.
 
627
        """Standard D-Bus method, overloaded to insert property tags.
1069
628
        """
1070
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1071
 
                                                         object_path,
1072
 
                                                         connection)
 
629
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
630
                                                   connection)
1073
631
        try:
1074
632
            document = xml.dom.minidom.parseString(xmlstring)
1075
 
            
1076
633
            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)
 
634
                e = document.createElement(u"property")
 
635
                e.setAttribute(u"name", name)
 
636
                e.setAttribute(u"type", prop._dbus_signature)
 
637
                e.setAttribute(u"access", prop._dbus_access)
1081
638
                return e
1082
 
            
1083
 
            for if_tag in document.getElementsByTagName("interface"):
1084
 
                # Add property tags
 
639
            for if_tag in document.getElementsByTagName(u"interface"):
1085
640
                for tag in (make_tag(document, name, prop)
1086
641
                            for name, prop
1087
 
                            in self._get_all_dbus_things("property")
 
642
                            in self._get_all_dbus_properties()
1088
643
                            if prop._dbus_interface
1089
 
                            == if_tag.getAttribute("name")):
 
644
                            == if_tag.getAttribute(u"name")):
1090
645
                    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
646
                # Add the names to the return values for the
1108
647
                # "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"})
 
648
                if (if_tag.getAttribute(u"name")
 
649
                    == u"org.freedesktop.DBus.Properties"):
 
650
                    for cn in if_tag.getElementsByTagName(u"method"):
 
651
                        if cn.getAttribute(u"name") == u"Get":
 
652
                            for arg in cn.getElementsByTagName(u"arg"):
 
653
                                if (arg.getAttribute(u"direction")
 
654
                                    == u"out"):
 
655
                                    arg.setAttribute(u"name", u"value")
 
656
                        elif cn.getAttribute(u"name") == u"GetAll":
 
657
                            for arg in cn.getElementsByTagName(u"arg"):
 
658
                                if (arg.getAttribute(u"direction")
 
659
                                    == u"out"):
 
660
                                    arg.setAttribute(u"name", u"props")
 
661
            xmlstring = document.toxml(u"utf-8")
 
662
            document.unlink()
 
663
        except (AttributeError, xml.dom.DOMException,
 
664
                xml.parsers.expat.ExpatError), error:
 
665
            logger.error(u"Failed to override Introspection method",
 
666
                         error)
 
667
        return xmlstring
 
668
 
 
669
 
1389
670
class ClientDBus(Client, DBusObjectWithProperties):
1390
671
    """A Client class using D-Bus
1391
672
    
1393
674
    dbus_object_path: dbus.ObjectPath
1394
675
    bus: dbus.SystemBus()
1395
676
    """
1396
 
    
1397
 
    runtime_expansions = (Client.runtime_expansions
1398
 
                          + ("dbus_object_path", ))
1399
 
    
1400
 
    _interface = "se.recompile.Mandos.Client"
1401
 
    
1402
677
    # dbus.service.Object doesn't use super(), so we can't either.
1403
678
    
1404
679
    def __init__(self, bus = None, *args, **kwargs):
1406
681
        Client.__init__(self, *args, **kwargs)
1407
682
        # Only now, when this client is initialized, can it show up on
1408
683
        # 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)
 
684
        self.dbus_object_path = (dbus.ObjectPath
 
685
                                 (u"/clients/"
 
686
                                  + self.name.replace(u".", u"_")))
1414
687
        DBusObjectWithProperties.__init__(self, self.bus,
1415
688
                                          self.dbus_object_path)
1416
689
    
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
 
690
    @staticmethod
 
691
    def _datetime_to_dbus(dt, variant_level=0):
 
692
        """Convert a UTC datetime.datetime() to a D-Bus type."""
 
693
        return dbus.String(dt.isoformat(),
 
694
                           variant_level=variant_level)
 
695
    
 
696
    def enable(self):
 
697
        oldstate = getattr(self, u"enabled", False)
 
698
        r = Client.enable(self)
 
699
        if oldstate != self.enabled:
 
700
            # Emit D-Bus signals
 
701
            self.PropertyChanged(dbus.String(u"enabled"),
 
702
                                 dbus.Boolean(True, variant_level=1))
 
703
            self.PropertyChanged(
 
704
                dbus.String(u"last_enabled"),
 
705
                self._datetime_to_dbus(self.last_enabled,
 
706
                                       variant_level=1))
 
707
        return r
 
708
    
 
709
    def disable(self, quiet = False):
 
710
        oldstate = getattr(self, u"enabled", False)
 
711
        r = Client.disable(self, quiet=quiet)
 
712
        if not quiet and oldstate != self.enabled:
 
713
            # Emit D-Bus signal
 
714
            self.PropertyChanged(dbus.String(u"enabled"),
 
715
                                 dbus.Boolean(False, variant_level=1))
 
716
        return r
1497
717
    
1498
718
    def __del__(self, *args, **kwargs):
1499
719
        try:
1500
720
            self.remove_from_connection()
1501
721
        except LookupError:
1502
722
            pass
1503
 
        if hasattr(DBusObjectWithProperties, "__del__"):
 
723
        if hasattr(DBusObjectWithProperties, u"__del__"):
1504
724
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1505
725
        Client.__del__(self, *args, **kwargs)
1506
726
    
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:
 
727
    def checker_callback(self, pid, condition, command,
 
728
                         *args, **kwargs):
 
729
        self.checker_callback_tag = None
 
730
        self.checker = None
 
731
        # Emit D-Bus signal
 
732
        self.PropertyChanged(dbus.String(u"checker_running"),
 
733
                             dbus.Boolean(False, variant_level=1))
 
734
        if os.WIFEXITED(condition):
 
735
            exitstatus = os.WEXITSTATUS(condition)
1514
736
            # Emit D-Bus signal
1515
737
            self.CheckerCompleted(dbus.Int16(exitstatus),
1516
 
                                  # This is specific to GNU libC
1517
 
                                  dbus.Int64(exitstatus << 8),
 
738
                                  dbus.Int64(condition),
1518
739
                                  dbus.String(command))
1519
740
        else:
1520
741
            # Emit D-Bus signal
1521
742
            self.CheckerCompleted(dbus.Int16(-1),
1522
 
                                  dbus.Int64(
1523
 
                                      # This is specific to GNU libC
1524
 
                                      (exitstatus << 8)
1525
 
                                      | self.last_checker_signal),
 
743
                                  dbus.Int64(condition),
1526
744
                                  dbus.String(command))
1527
 
        return ret
 
745
        
 
746
        return Client.checker_callback(self, pid, condition, command,
 
747
                                       *args, **kwargs)
 
748
    
 
749
    def checked_ok(self, *args, **kwargs):
 
750
        r = Client.checked_ok(self, *args, **kwargs)
 
751
        # Emit D-Bus signal
 
752
        self.PropertyChanged(
 
753
            dbus.String(u"last_checked_ok"),
 
754
            (self._datetime_to_dbus(self.last_checked_ok,
 
755
                                    variant_level=1)))
 
756
        return r
1528
757
    
1529
758
    def start_checker(self, *args, **kwargs):
1530
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
759
        old_checker = self.checker
 
760
        if self.checker is not None:
 
761
            old_checker_pid = self.checker.pid
 
762
        else:
 
763
            old_checker_pid = None
1531
764
        r = Client.start_checker(self, *args, **kwargs)
1532
765
        # Only if new checker process was started
1533
766
        if (self.checker is not None
1534
767
            and old_checker_pid != self.checker.pid):
1535
768
            # Emit D-Bus signal
1536
769
            self.CheckerStarted(self.current_checker_command)
1537
 
        return r
1538
 
    
1539
 
    def _reset_approved(self):
1540
 
        self.approved = None
1541
 
        return False
1542
 
    
1543
 
    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()
1548
 
    
1549
 
    ## D-Bus methods, signals & properties
1550
 
    
1551
 
    ## Interfaces
1552
 
    
1553
 
    ## Signals
 
770
            self.PropertyChanged(
 
771
                dbus.String(u"checker_running"),
 
772
                dbus.Boolean(True, variant_level=1))
 
773
        return r
 
774
    
 
775
    def stop_checker(self, *args, **kwargs):
 
776
        old_checker = getattr(self, u"checker", None)
 
777
        r = Client.stop_checker(self, *args, **kwargs)
 
778
        if (old_checker is not None
 
779
            and getattr(self, u"checker", None) is None):
 
780
            self.PropertyChanged(dbus.String(u"checker_running"),
 
781
                                 dbus.Boolean(False, variant_level=1))
 
782
        return r
 
783
    
 
784
    ## D-Bus methods & signals
 
785
    _interface = u"se.bsnet.fukt.Mandos.Client"
 
786
    
 
787
    # CheckedOK - method
 
788
    @dbus.service.method(_interface)
 
789
    def CheckedOK(self):
 
790
        return self.checked_ok()
1554
791
    
1555
792
    # CheckerCompleted - signal
1556
 
    @dbus.service.signal(_interface, signature="nxs")
 
793
    @dbus.service.signal(_interface, signature=u"nxs")
1557
794
    def CheckerCompleted(self, exitcode, waitstatus, command):
1558
795
        "D-Bus signal"
1559
796
        pass
1560
797
    
1561
798
    # CheckerStarted - signal
1562
 
    @dbus.service.signal(_interface, signature="s")
 
799
    @dbus.service.signal(_interface, signature=u"s")
1563
800
    def CheckerStarted(self, command):
1564
801
        "D-Bus signal"
1565
802
        pass
1566
803
    
1567
804
    # PropertyChanged - signal
1568
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1569
 
    @dbus.service.signal(_interface, signature="sv")
 
805
    @dbus.service.signal(_interface, signature=u"sv")
1570
806
    def PropertyChanged(self, property, value):
1571
807
        "D-Bus signal"
1572
808
        pass
1574
810
    # GotSecret - signal
1575
811
    @dbus.service.signal(_interface)
1576
812
    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
 
        """
 
813
        "D-Bus signal"
1581
814
        pass
1582
815
    
1583
816
    # Rejected - signal
1584
 
    @dbus.service.signal(_interface, signature="s")
1585
 
    def Rejected(self, reason):
 
817
    @dbus.service.signal(_interface)
 
818
    def Rejected(self):
1586
819
        "D-Bus signal"
1587
820
        pass
1588
821
    
1589
 
    # NeedApproval - signal
1590
 
    @dbus.service.signal(_interface, signature="tb")
1591
 
    def NeedApproval(self, timeout, default):
1592
 
        "D-Bus signal"
1593
 
        return self.need_approval()
1594
 
    
1595
 
    ## Methods
1596
 
    
1597
 
    # Approve - method
1598
 
    @dbus.service.method(_interface, in_signature="b")
1599
 
    def Approve(self, value):
1600
 
        self.approve(value)
1601
 
    
1602
 
    # CheckedOK - method
1603
 
    @dbus.service.method(_interface)
1604
 
    def CheckedOK(self):
1605
 
        self.checked_ok()
1606
 
    
1607
822
    # Enable - method
1608
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1609
823
    @dbus.service.method(_interface)
1610
824
    def Enable(self):
1611
825
        "D-Bus method"
1612
826
        self.enable()
1613
827
    
1614
828
    # StartChecker - method
1615
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1616
829
    @dbus.service.method(_interface)
1617
830
    def StartChecker(self):
1618
831
        "D-Bus method"
1619
832
        self.start_checker()
1620
833
    
1621
834
    # Disable - method
1622
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1623
835
    @dbus.service.method(_interface)
1624
836
    def Disable(self):
1625
837
        "D-Bus method"
1626
838
        self.disable()
1627
839
    
1628
840
    # StopChecker - method
1629
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1630
841
    @dbus.service.method(_interface)
1631
842
    def StopChecker(self):
1632
843
        self.stop_checker()
1633
844
    
1634
 
    ## Properties
1635
 
    
1636
 
    # ApprovalPending - property
1637
 
    @dbus_service_property(_interface, signature="b", access="read")
1638
 
    def ApprovalPending_dbus_property(self):
1639
 
        return dbus.Boolean(bool(self.approvals_pending))
1640
 
    
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):
 
845
    # name - property
 
846
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
847
    def name_dbus_property(self):
1675
848
        return dbus.String(self.name)
1676
849
    
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):
 
850
    # fingerprint - property
 
851
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
852
    def fingerprint_dbus_property(self):
1682
853
        return dbus.String(self.fingerprint)
1683
854
    
1684
 
    # Host - property
1685
 
    @dbus_service_property(_interface,
1686
 
                           signature="s",
1687
 
                           access="readwrite")
1688
 
    def Host_dbus_property(self, value=None):
 
855
    # host - property
 
856
    @dbus_service_property(_interface, signature=u"s",
 
857
                           access=u"readwrite")
 
858
    def host_dbus_property(self, value=None):
1689
859
        if value is None:       # get
1690
860
            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):
 
861
        self.host = value
 
862
        # Emit D-Bus signal
 
863
        self.PropertyChanged(dbus.String(u"host"),
 
864
                             dbus.String(value, variant_level=1))
 
865
    
 
866
    # created - property
 
867
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
868
    def created_dbus_property(self):
 
869
        return dbus.String(self._datetime_to_dbus(self.created))
 
870
    
 
871
    # last_enabled - property
 
872
    @dbus_service_property(_interface, signature=u"s", access=u"read")
 
873
    def last_enabled_dbus_property(self):
 
874
        if self.last_enabled is None:
 
875
            return dbus.String(u"")
 
876
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
 
877
    
 
878
    # enabled - property
 
879
    @dbus_service_property(_interface, signature=u"b",
 
880
                           access=u"readwrite")
 
881
    def enabled_dbus_property(self, value=None):
1710
882
        if value is None:       # get
1711
883
            return dbus.Boolean(self.enabled)
1712
884
        if value:
1714
886
        else:
1715
887
            self.disable()
1716
888
    
1717
 
    # LastCheckedOK - property
1718
 
    @dbus_service_property(_interface,
1719
 
                           signature="s",
1720
 
                           access="readwrite")
1721
 
    def LastCheckedOK_dbus_property(self, value=None):
 
889
    # last_checked_ok - property
 
890
    @dbus_service_property(_interface, signature=u"s",
 
891
                           access=u"readwrite")
 
892
    def last_checked_ok_dbus_property(self, value=None):
1722
893
        if value is not None:
1723
894
            self.checked_ok()
1724
895
            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):
 
896
        if self.last_checked_ok is None:
 
897
            return dbus.String(u"")
 
898
        return dbus.String(self._datetime_to_dbus(self
 
899
                                                  .last_checked_ok))
 
900
    
 
901
    # timeout - property
 
902
    @dbus_service_property(_interface, signature=u"t",
 
903
                           access=u"readwrite")
 
904
    def timeout_dbus_property(self, value=None):
1747
905
        if value is None:       # get
1748
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1749
 
        old_timeout = self.timeout
 
906
            return dbus.UInt64(self.timeout_milliseconds())
1750
907
        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)
 
908
        # Emit D-Bus signal
 
909
        self.PropertyChanged(dbus.String(u"timeout"),
 
910
                             dbus.UInt64(value, variant_level=1))
 
911
        if getattr(self, u"disable_initiator_tag", None) is None:
 
912
            return
 
913
        # Reschedule timeout
 
914
        gobject.source_remove(self.disable_initiator_tag)
 
915
        self.disable_initiator_tag = None
 
916
        time_to_die = (self.
 
917
                       _timedelta_to_milliseconds((self
 
918
                                                   .last_checked_ok
 
919
                                                   + self.timeout)
 
920
                                                  - datetime.datetime
 
921
                                                  .utcnow()))
 
922
        if time_to_die <= 0:
 
923
            # The timeout has passed
 
924
            self.disable()
 
925
        else:
 
926
            self.disable_initiator_tag = (gobject.timeout_add
 
927
                                          (time_to_die, self.disable))
 
928
    
 
929
    # interval - property
 
930
    @dbus_service_property(_interface, signature=u"t",
 
931
                           access=u"readwrite")
 
932
    def interval_dbus_property(self, value=None):
 
933
        if value is None:       # get
 
934
            return dbus.UInt64(self.interval_milliseconds())
1784
935
        self.interval = datetime.timedelta(0, 0, 0, value)
1785
 
        if getattr(self, "checker_initiator_tag", None) is None:
 
936
        # Emit D-Bus signal
 
937
        self.PropertyChanged(dbus.String(u"interval"),
 
938
                             dbus.UInt64(value, variant_level=1))
 
939
        if getattr(self, u"checker_initiator_tag", None) is None:
1786
940
            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):
 
941
        # Reschedule checker run
 
942
        gobject.source_remove(self.checker_initiator_tag)
 
943
        self.checker_initiator_tag = (gobject.timeout_add
 
944
                                      (value, self.start_checker))
 
945
        self.start_checker()    # Start one now, too
 
946
 
 
947
    # checker - property
 
948
    @dbus_service_property(_interface, signature=u"s",
 
949
                           access=u"readwrite")
 
950
    def checker_dbus_property(self, value=None):
1799
951
        if value is None:       # get
1800
952
            return dbus.String(self.checker_command)
1801
 
        self.checker_command = str(value)
 
953
        self.checker_command = value
 
954
        # Emit D-Bus signal
 
955
        self.PropertyChanged(dbus.String(u"checker"),
 
956
                             dbus.String(self.checker_command,
 
957
                                         variant_level=1))
1802
958
    
1803
 
    # CheckerRunning - property
1804
 
    @dbus_service_property(_interface,
1805
 
                           signature="b",
1806
 
                           access="readwrite")
1807
 
    def CheckerRunning_dbus_property(self, value=None):
 
959
    # checker_running - property
 
960
    @dbus_service_property(_interface, signature=u"b",
 
961
                           access=u"readwrite")
 
962
    def checker_running_dbus_property(self, value=None):
1808
963
        if value is None:       # get
1809
964
            return dbus.Boolean(self.checker is not None)
1810
965
        if value:
1812
967
        else:
1813
968
            self.stop_checker()
1814
969
    
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):
 
970
    # object_path - property
 
971
    @dbus_service_property(_interface, signature=u"o", access=u"read")
 
972
    def object_path_dbus_property(self):
1821
973
        return self.dbus_object_path # is already a dbus.ObjectPath
1822
974
    
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)
 
975
    # secret = property
 
976
    @dbus_service_property(_interface, signature=u"ay",
 
977
                           access=u"write", byte_arrays=True)
 
978
    def secret_dbus_property(self, value):
 
979
        self.secret = str(value)
1833
980
    
1834
981
    del _interface
1835
982
 
1836
983
 
1837
 
class ProxyClient(object):
1838
 
    def __init__(self, child_pipe, fpr, address):
1839
 
        self._pipe = child_pipe
1840
 
        self._pipe.send(('init', fpr, address))
1841
 
        if not self._pipe.recv():
1842
 
            raise KeyError(fpr)
1843
 
    
1844
 
    def __getattribute__(self, name):
1845
 
        if name == '_pipe':
1846
 
            return super(ProxyClient, self).__getattribute__(name)
1847
 
        self._pipe.send(('getattr', name))
1848
 
        data = self._pipe.recv()
1849
 
        if data[0] == 'data':
1850
 
            return data[1]
1851
 
        if data[0] == 'function':
1852
 
            
1853
 
            def func(*args, **kwargs):
1854
 
                self._pipe.send(('funcall', name, args, kwargs))
1855
 
                return self._pipe.recv()[1]
1856
 
            
1857
 
            return func
1858
 
    
1859
 
    def __setattr__(self, name, value):
1860
 
        if name == '_pipe':
1861
 
            return super(ProxyClient, self).__setattr__(name, value)
1862
 
        self._pipe.send(('setattr', name, value))
1863
 
 
1864
 
 
1865
984
class ClientHandler(socketserver.BaseRequestHandler, object):
1866
985
    """A class to handle client connections.
1867
986
    
1869
988
    Note: This will run in its own forked process."""
1870
989
    
1871
990
    def handle(self):
1872
 
        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",
1876
 
                         self.server.child_pipe.fileno())
 
991
        logger.info(u"TCP connection from: %s",
 
992
                    unicode(self.client_address))
 
993
        logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
 
994
        # Open IPC pipe to parent process
 
995
        with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
 
996
            session = (gnutls.connection
 
997
                       .ClientSession(self.request,
 
998
                                      gnutls.connection
 
999
                                      .X509Credentials()))
1877
1000
            
1878
 
            session = gnutls.connection.ClientSession(
1879
 
                self.request, gnutls.connection .X509Credentials())
 
1001
            line = self.request.makefile().readline()
 
1002
            logger.debug(u"Protocol version: %r", line)
 
1003
            try:
 
1004
                if int(line.strip().split()[0]) > 1:
 
1005
                    raise RuntimeError
 
1006
            except (ValueError, IndexError, RuntimeError), error:
 
1007
                logger.error(u"Unknown protocol version: %s", error)
 
1008
                return
1880
1009
            
1881
1010
            # Note: gnutls.connection.X509Credentials is really a
1882
1011
            # generic GnuTLS certificate credentials object so long as
1883
1012
            # no X.509 keys are added to it.  Therefore, we can use it
1884
1013
            # here despite using OpenPGP certificates.
1885
1014
            
1886
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1887
 
            #                      "+AES-256-CBC", "+SHA1",
1888
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1889
 
            #                      "+DHE-DSS"))
 
1015
            #priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
 
1016
            #                      u"+AES-256-CBC", u"+SHA1",
 
1017
            #                      u"+COMP-NULL", u"+CTYPE-OPENPGP",
 
1018
            #                      u"+DHE-DSS"))
1890
1019
            # Use a fallback default, since this MUST be set.
1891
1020
            priority = self.server.gnutls_priority
1892
1021
            if priority is None:
1893
 
                priority = "NORMAL"
1894
 
            gnutls.library.functions.gnutls_priority_set_direct(
1895
 
                session._c_object, priority, None)
1896
 
            
1897
 
            # Start communication using the Mandos protocol
1898
 
            # Get protocol number
1899
 
            line = self.request.makefile().readline()
1900
 
            logger.debug("Protocol version: %r", line)
1901
 
            try:
1902
 
                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)
1906
 
                return
1907
 
            
1908
 
            # Start GnuTLS connection
 
1022
                priority = u"NORMAL"
 
1023
            (gnutls.library.functions
 
1024
             .gnutls_priority_set_direct(session._c_object,
 
1025
                                         priority, None))
 
1026
            
1909
1027
            try:
1910
1028
                session.handshake()
1911
 
            except gnutls.errors.GNUTLSError as error:
1912
 
                logger.warning("Handshake failed: %s", error)
 
1029
            except gnutls.errors.GNUTLSError, error:
 
1030
                logger.warning(u"Handshake failed: %s", error)
1913
1031
                # Do not run session.bye() here: the session is not
1914
1032
                # established.  Just abandon the request.
1915
1033
                return
1916
 
            logger.debug("Handshake succeeded")
1917
 
            
1918
 
            approval_required = False
 
1034
            logger.debug(u"Handshake succeeded")
1919
1035
            try:
1920
 
                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)
1926
 
                    return
1927
 
                logger.debug("Fingerprint: %s", fpr)
1928
 
                
1929
 
                try:
1930
 
                    client = ProxyClient(child_pipe, fpr,
1931
 
                                         self.client_address)
1932
 
                except KeyError:
1933
 
                    return
1934
 
                
1935
 
                if client.approval_delay:
1936
 
                    delay = client.approval_delay
1937
 
                    client.approvals_pending += 1
1938
 
                    approval_required = True
1939
 
                
1940
 
                while True:
1941
 
                    if not client.enabled:
1942
 
                        logger.info("Client %s is disabled",
1943
 
                                    client.name)
1944
 
                        if self.server.use_dbus:
1945
 
                            # Emit D-Bus signal
1946
 
                            client.Rejected("Disabled")
1947
 
                        return
1948
 
                    
1949
 
                    if client.approved or not client.approval_delay:
1950
 
                        #We are approved or approval is disabled
1951
 
                        break
1952
 
                    elif client.approved is None:
1953
 
                        logger.info("Client %s needs approval",
1954
 
                                    client.name)
1955
 
                        if self.server.use_dbus:
1956
 
                            # Emit D-Bus signal
1957
 
                            client.NeedApproval(
1958
 
                                client.approval_delay.total_seconds()
1959
 
                                * 1000, client.approved_by_default)
1960
 
                    else:
1961
 
                        logger.warning("Client %s was not approved",
1962
 
                                       client.name)
1963
 
                        if self.server.use_dbus:
1964
 
                            # Emit D-Bus signal
1965
 
                            client.Rejected("Denied")
1966
 
                        return
1967
 
                    
1968
 
                    #wait until timeout or approved
1969
 
                    time = datetime.datetime.now()
1970
 
                    client.changedstate.acquire()
1971
 
                    client.changedstate.wait(delay.total_seconds())
1972
 
                    client.changedstate.release()
1973
 
                    time2 = datetime.datetime.now()
1974
 
                    if (time2 - time) >= delay:
1975
 
                        if not client.approved_by_default:
1976
 
                            logger.warning("Client %s timed out while"
1977
 
                                           " waiting for approval",
1978
 
                                           client.name)
1979
 
                            if self.server.use_dbus:
1980
 
                                # Emit D-Bus signal
1981
 
                                client.Rejected("Approval timed out")
1982
 
                            return
1983
 
                        else:
1984
 
                            break
1985
 
                    else:
1986
 
                        delay -= time2 - time
1987
 
                
1988
 
                sent_size = 0
1989
 
                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))
1999
 
                    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)
2004
 
                if self.server.use_dbus:
2005
 
                    # Emit D-Bus signal
2006
 
                    client.GotSecret()
 
1036
                fpr = self.fingerprint(self.peer_certificate(session))
 
1037
            except (TypeError, gnutls.errors.GNUTLSError), error:
 
1038
                logger.warning(u"Bad certificate: %s", error)
 
1039
                session.bye()
 
1040
                return
 
1041
            logger.debug(u"Fingerprint: %s", fpr)
2007
1042
            
2008
 
            finally:
2009
 
                if approval_required:
2010
 
                    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)
 
1043
            for c in self.server.clients:
 
1044
                if c.fingerprint == fpr:
 
1045
                    client = c
 
1046
                    break
 
1047
            else:
 
1048
                ipc.write(u"NOTFOUND %s %s\n"
 
1049
                          % (fpr, unicode(self.client_address)))
 
1050
                session.bye()
 
1051
                return
 
1052
            # Have to check if client.still_valid(), since it is
 
1053
            # possible that the client timed out while establishing
 
1054
            # the GnuTLS session.
 
1055
            if not client.still_valid():
 
1056
                ipc.write(u"INVALID %s\n" % client.name)
 
1057
                session.bye()
 
1058
                return
 
1059
            ipc.write(u"SENDING %s\n" % client.name)
 
1060
            sent_size = 0
 
1061
            while sent_size < len(client.secret):
 
1062
                sent = session.send(client.secret[sent_size:])
 
1063
                logger.debug(u"Sent: %d, remaining: %d",
 
1064
                             sent, len(client.secret)
 
1065
                             - (sent_size + sent))
 
1066
                sent_size += sent
 
1067
            session.bye()
2016
1068
    
2017
1069
    @staticmethod
2018
1070
    def peer_certificate(session):
2019
1071
        "Return the peer's OpenPGP certificate as a bytestring"
2020
1072
        # If not an OpenPGP certificate...
2021
 
        if (gnutls.library.functions.gnutls_certificate_type_get(
2022
 
                session._c_object)
 
1073
        if (gnutls.library.functions
 
1074
            .gnutls_certificate_type_get(session._c_object)
2023
1075
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
2024
1076
            # ...do the normal thing
2025
1077
            return session.peer_certificate
2028
1080
                     .gnutls_certificate_get_peers
2029
1081
                     (session._c_object, ctypes.byref(list_size)))
2030
1082
        if not bool(cert_list) and list_size.value != 0:
2031
 
            raise gnutls.errors.GNUTLSError("error getting peer"
2032
 
                                            " certificate")
 
1083
            raise gnutls.errors.GNUTLSError(u"error getting peer"
 
1084
                                            u" certificate")
2033
1085
        if list_size.value == 0:
2034
1086
            return None
2035
1087
        cert = cert_list[0]
2039
1091
    def fingerprint(openpgp):
2040
1092
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2041
1093
        # 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)))
 
1094
        datum = (gnutls.library.types
 
1095
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1096
                                             ctypes.POINTER
 
1097
                                             (ctypes.c_ubyte)),
 
1098
                                 ctypes.c_uint(len(openpgp))))
2046
1099
        # New empty GnuTLS certificate
2047
1100
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
2048
 
        gnutls.library.functions.gnutls_openpgp_crt_init(
2049
 
            ctypes.byref(crt))
 
1101
        (gnutls.library.functions
 
1102
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
2050
1103
        # 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)
 
1104
        (gnutls.library.functions
 
1105
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1106
                                    gnutls.library.constants
 
1107
                                    .GNUTLS_OPENPGP_FMT_RAW))
2054
1108
        # Verify the self signature in the key
2055
1109
        crtverify = ctypes.c_uint()
2056
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
2057
 
            crt, 0, ctypes.byref(crtverify))
 
1110
        (gnutls.library.functions
 
1111
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1112
                                         ctypes.byref(crtverify)))
2058
1113
        if crtverify.value != 0:
2059
1114
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2060
 
            raise gnutls.errors.CertificateSecurityError(
2061
 
                "Verify failed")
 
1115
            raise (gnutls.errors.CertificateSecurityError
 
1116
                   (u"Verify failed"))
2062
1117
        # New buffer for the fingerprint
2063
1118
        buf = ctypes.create_string_buffer(20)
2064
1119
        buf_len = ctypes.c_size_t()
2065
1120
        # 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))
 
1121
        (gnutls.library.functions
 
1122
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1123
                                             ctypes.byref(buf_len)))
2068
1124
        # Deinit the certificate
2069
1125
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2070
1126
        # Convert the buffer to a Python bytestring
2071
1127
        fpr = ctypes.string_at(buf, buf_len.value)
2072
1128
        # Convert the bytestring to hexadecimal notation
2073
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1129
        hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2074
1130
        return hex_fpr
2075
1131
 
2076
1132
 
2077
 
class MultiprocessingMixIn(object):
2078
 
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2079
 
    
2080
 
    def sub_process_main(self, request, address):
2081
 
        try:
2082
 
            self.finish_request(request, address)
2083
 
        except Exception:
2084
 
            self.handle_error(request, address)
2085
 
        self.close_request(request)
2086
 
    
2087
 
    def process_request(self, request, address):
2088
 
        """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
 
 
2094
 
 
2095
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2096
 
    """ adds a pipe to the MixIn """
2097
 
    
 
1133
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
 
1134
    """Like socketserver.ForkingMixIn, but also pass a pipe."""
2098
1135
    def process_request(self, request, client_address):
2099
1136
        """Overrides and wraps the original process_request().
2100
1137
        
2101
1138
        This function creates a new pipe in self.pipe
2102
1139
        """
2103
 
        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):
 
1140
        self.pipe = os.pipe()
 
1141
        super(ForkingMixInWithPipe,
 
1142
              self).process_request(request, client_address)
 
1143
        os.close(self.pipe[1])  # close write end
 
1144
        self.add_pipe(self.pipe[0])
 
1145
    def add_pipe(self, pipe):
2111
1146
        """Dummy function; override as necessary"""
2112
 
        raise NotImplementedError()
2113
 
 
2114
 
 
2115
 
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
 
1147
        os.close(pipe)
 
1148
 
 
1149
 
 
1150
class IPv6_TCPServer(ForkingMixInWithPipe,
2116
1151
                     socketserver.TCPServer, object):
2117
1152
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2118
1153
    
2121
1156
        interface:      None or a network interface name (string)
2122
1157
        use_ipv6:       Boolean; to use IPv6 or not
2123
1158
    """
2124
 
    
2125
1159
    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
 
        """
 
1160
                 interface=None, use_ipv6=True):
2132
1161
        self.interface = interface
2133
1162
        if use_ipv6:
2134
1163
            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
1164
        socketserver.TCPServer.__init__(self, server_address,
2162
1165
                                        RequestHandlerClass)
2163
 
    
2164
1166
    def server_bind(self):
2165
1167
        """This overrides the normal server_bind() function
2166
1168
        to bind to an interface if one was specified, and also NOT to
2167
1169
        bind to an address or port if they were not specified."""
2168
1170
        if self.interface is not None:
2169
1171
            if SO_BINDTODEVICE is None:
2170
 
                logger.error("SO_BINDTODEVICE does not exist;"
2171
 
                             " cannot bind to interface %s",
 
1172
                logger.error(u"SO_BINDTODEVICE does not exist;"
 
1173
                             u" cannot bind to interface %s",
2172
1174
                             self.interface)
2173
1175
            else:
2174
1176
                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)
 
1177
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1178
                                           SO_BINDTODEVICE,
 
1179
                                           str(self.interface
 
1180
                                               + u'\0'))
 
1181
                except socket.error, error:
 
1182
                    if error[0] == errno.EPERM:
 
1183
                        logger.error(u"No permission to"
 
1184
                                     u" bind to interface %s",
 
1185
                                     self.interface)
 
1186
                    elif error[0] == errno.ENOPROTOOPT:
 
1187
                        logger.error(u"SO_BINDTODEVICE not available;"
 
1188
                                     u" cannot bind to interface %s",
 
1189
                                     self.interface)
2189
1190
                    else:
2190
1191
                        raise
2191
1192
        # Only bind(2) the socket if we really need to.
2192
1193
        if self.server_address[0] or self.server_address[1]:
2193
1194
            if not self.server_address[0]:
2194
1195
                if self.address_family == socket.AF_INET6:
2195
 
                    any_address = "::" # in6addr_any
 
1196
                    any_address = u"::" # in6addr_any
2196
1197
                else:
2197
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1198
                    any_address = socket.INADDR_ANY
2198
1199
                self.server_address = (any_address,
2199
1200
                                       self.server_address[1])
2200
1201
            elif not self.server_address[1]:
2201
 
                self.server_address = (self.server_address[0], 0)
 
1202
                self.server_address = (self.server_address[0],
 
1203
                                       0)
2202
1204
#                 if self.interface:
2203
1205
#                     self.server_address = (self.server_address[0],
2204
1206
#                                            0, # port
2218
1220
    
2219
1221
    Assumes a gobject.MainLoop event loop.
2220
1222
    """
2221
 
    
2222
1223
    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):
 
1224
                 interface=None, use_ipv6=True, clients=None,
 
1225
                 gnutls_priority=None, use_dbus=True):
2229
1226
        self.enabled = False
2230
1227
        self.clients = clients
2231
1228
        if self.clients is None:
2232
 
            self.clients = {}
 
1229
            self.clients = set()
2233
1230
        self.use_dbus = use_dbus
2234
1231
        self.gnutls_priority = gnutls_priority
2235
1232
        IPv6_TCPServer.__init__(self, server_address,
2236
1233
                                RequestHandlerClass,
2237
1234
                                interface = interface,
2238
 
                                use_ipv6 = use_ipv6,
2239
 
                                socketfd = socketfd)
2240
 
    
 
1235
                                use_ipv6 = use_ipv6)
2241
1236
    def server_activate(self):
2242
1237
        if self.enabled:
2243
1238
            return socketserver.TCPServer.server_activate(self)
2244
 
    
2245
1239
    def enable(self):
2246
1240
        self.enabled = True
2247
 
    
2248
 
    def add_pipe(self, parent_pipe, proc):
 
1241
    def add_pipe(self, pipe):
2249
1242
        # 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,
2260
 
                   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
2266
 
        
2267
 
        # Read a request from the child
2268
 
        request = parent_pipe.recv()
2269
 
        command = request[0]
2270
 
        
2271
 
        if command == 'init':
2272
 
            fpr = request[1]
2273
 
            address = request[2]
2274
 
            
2275
 
            for c in self.clients.itervalues():
2276
 
                if c.fingerprint == fpr:
2277
 
                    client = c
2278
 
                    break
2279
 
            else:
2280
 
                logger.info("Client not found for fingerprint: %s, ad"
2281
 
                            "dress: %s", fpr, address)
2282
 
                if self.use_dbus:
2283
 
                    # Emit D-Bus signal
2284
 
                    mandos_dbus_service.ClientNotFound(fpr,
2285
 
                                                       address[0])
2286
 
                parent_pipe.send(False)
2287
 
                return False
2288
 
            
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))
2296
 
            parent_pipe.send(True)
2297
 
            # remove the old hook in favor of the new above hook on
2298
 
            # same fileno
2299
 
            return False
2300
 
        if command == 'funcall':
2301
 
            funcname = request[1]
2302
 
            args = request[2]
2303
 
            kwargs = request[3]
2304
 
            
2305
 
            parent_pipe.send(('data', getattr(client_object,
2306
 
                                              funcname)(*args,
2307
 
                                                        **kwargs)))
2308
 
        
2309
 
        if command == 'getattr':
2310
 
            attrname = request[1]
2311
 
            if isinstance(client_object.__getattribute__(attrname),
2312
 
                          collections.Callable):
2313
 
                parent_pipe.send(('function', ))
2314
 
            else:
2315
 
                parent_pipe.send((
2316
 
                    'data', client_object.__getattribute__(attrname)))
2317
 
        
2318
 
        if command == 'setattr':
2319
 
            attrname = request[1]
2320
 
            value = request[2]
2321
 
            setattr(client_object, attrname, value)
2322
 
        
 
1243
        gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
 
1244
                             self.handle_ipc)
 
1245
    def handle_ipc(self, source, condition, file_objects={}):
 
1246
        condition_names = {
 
1247
            gobject.IO_IN: u"IN",   # There is data to read.
 
1248
            gobject.IO_OUT: u"OUT", # Data can be written (without
 
1249
                                    # blocking).
 
1250
            gobject.IO_PRI: u"PRI", # There is urgent data to read.
 
1251
            gobject.IO_ERR: u"ERR", # Error condition.
 
1252
            gobject.IO_HUP: u"HUP"  # Hung up (the connection has been
 
1253
                                    # broken, usually for pipes and
 
1254
                                    # sockets).
 
1255
            }
 
1256
        conditions_string = ' | '.join(name
 
1257
                                       for cond, name in
 
1258
                                       condition_names.iteritems()
 
1259
                                       if cond & condition)
 
1260
        logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
 
1261
                     conditions_string)
 
1262
        
 
1263
        # Turn the pipe file descriptor into a Python file object
 
1264
        if source not in file_objects:
 
1265
            file_objects[source] = os.fdopen(source, u"r", 1)
 
1266
        
 
1267
        # Read a line from the file object
 
1268
        cmdline = file_objects[source].readline()
 
1269
        if not cmdline:             # Empty line means end of file
 
1270
            # close the IPC pipe
 
1271
            file_objects[source].close()
 
1272
            del file_objects[source]
 
1273
            
 
1274
            # Stop calling this function
 
1275
            return False
 
1276
        
 
1277
        logger.debug(u"IPC command: %r", cmdline)
 
1278
        
 
1279
        # Parse and act on command
 
1280
        cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
 
1281
        
 
1282
        if cmd == u"NOTFOUND":
 
1283
            fpr, address = args.split(None, 1)
 
1284
            logger.warning(u"Client not found for fingerprint: %s, ad"
 
1285
                           u"dress: %s", fpr, address)
 
1286
            if self.use_dbus:
 
1287
                # Emit D-Bus signal
 
1288
                mandos_dbus_service.ClientNotFound(fpr, address)
 
1289
        elif cmd == u"INVALID":
 
1290
            for client in self.clients:
 
1291
                if client.name == args:
 
1292
                    logger.warning(u"Client %s is invalid", args)
 
1293
                    if self.use_dbus:
 
1294
                        # Emit D-Bus signal
 
1295
                        client.Rejected()
 
1296
                    break
 
1297
            else:
 
1298
                logger.error(u"Unknown client %s is invalid", args)
 
1299
        elif cmd == u"SENDING":
 
1300
            for client in self.clients:
 
1301
                if client.name == args:
 
1302
                    logger.info(u"Sending secret to %s", client.name)
 
1303
                    client.checked_ok()
 
1304
                    if self.use_dbus:
 
1305
                        # Emit D-Bus signal
 
1306
                        client.GotSecret()
 
1307
                    break
 
1308
            else:
 
1309
                logger.error(u"Sending secret to unknown client %s",
 
1310
                             args)
 
1311
        else:
 
1312
            logger.error(u"Unknown IPC command: %r", cmdline)
 
1313
        
 
1314
        # Keep calling this function
2323
1315
        return True
2324
1316
 
2325
1317
 
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
1318
def string_to_delta(interval):
2423
1319
    """Parse a string and return a datetime.timedelta
2424
1320
    
2425
 
    >>> string_to_delta('7d')
 
1321
    >>> string_to_delta(u'7d')
2426
1322
    datetime.timedelta(7)
2427
 
    >>> string_to_delta('60s')
 
1323
    >>> string_to_delta(u'60s')
2428
1324
    datetime.timedelta(0, 60)
2429
 
    >>> string_to_delta('60m')
 
1325
    >>> string_to_delta(u'60m')
2430
1326
    datetime.timedelta(0, 3600)
2431
 
    >>> string_to_delta('24h')
 
1327
    >>> string_to_delta(u'24h')
2432
1328
    datetime.timedelta(1)
2433
 
    >>> string_to_delta('1w')
 
1329
    >>> string_to_delta(u'1w')
2434
1330
    datetime.timedelta(7)
2435
 
    >>> string_to_delta('5m 30s')
 
1331
    >>> string_to_delta(u'5m 30s')
2436
1332
    datetime.timedelta(0, 330)
2437
1333
    """
2438
 
    
2439
 
    try:
2440
 
        return rfc3339_duration_to_delta(interval)
2441
 
    except ValueError:
2442
 
        pass
2443
 
    
2444
1334
    timevalue = datetime.timedelta(0)
2445
1335
    for s in interval.split():
2446
1336
        try:
2447
 
            suffix = s[-1]
 
1337
            suffix = unicode(s[-1])
2448
1338
            value = int(s[:-1])
2449
 
            if suffix == "d":
 
1339
            if suffix == u"d":
2450
1340
                delta = datetime.timedelta(value)
2451
 
            elif suffix == "s":
 
1341
            elif suffix == u"s":
2452
1342
                delta = datetime.timedelta(0, value)
2453
 
            elif suffix == "m":
 
1343
            elif suffix == u"m":
2454
1344
                delta = datetime.timedelta(0, 0, 0, 0, value)
2455
 
            elif suffix == "h":
 
1345
            elif suffix == u"h":
2456
1346
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2457
 
            elif suffix == "w":
 
1347
            elif suffix == u"w":
2458
1348
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2459
1349
            else:
2460
 
                raise ValueError("Unknown suffix {!r}".format(suffix))
2461
 
        except IndexError as e:
2462
 
            raise ValueError(*(e.args))
 
1350
                raise ValueError(u"Unknown suffix %r" % suffix)
 
1351
        except (ValueError, IndexError), e:
 
1352
            raise ValueError(e.message)
2463
1353
        timevalue += delta
2464
1354
    return timevalue
2465
1355
 
2466
1356
 
 
1357
def if_nametoindex(interface):
 
1358
    """Call the C function if_nametoindex(), or equivalent
 
1359
    
 
1360
    Note: This function cannot accept a unicode string."""
 
1361
    global if_nametoindex
 
1362
    try:
 
1363
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
1364
                          (ctypes.util.find_library(u"c"))
 
1365
                          .if_nametoindex)
 
1366
    except (OSError, AttributeError):
 
1367
        logger.warning(u"Doing if_nametoindex the hard way")
 
1368
        def if_nametoindex(interface):
 
1369
            "Get an interface index the hard way, i.e. using fcntl()"
 
1370
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
1371
            with closing(socket.socket()) as s:
 
1372
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
1373
                                    struct.pack(str(u"16s16x"),
 
1374
                                                interface))
 
1375
            interface_index = struct.unpack(str(u"I"),
 
1376
                                            ifreq[16:20])[0]
 
1377
            return interface_index
 
1378
    return if_nametoindex(interface)
 
1379
 
 
1380
 
2467
1381
def daemon(nochdir = False, noclose = False):
2468
1382
    """See daemon(3).  Standard BSD Unix function.
2469
1383
    
2472
1386
        sys.exit()
2473
1387
    os.setsid()
2474
1388
    if not nochdir:
2475
 
        os.chdir("/")
 
1389
        os.chdir(u"/")
2476
1390
    if os.fork():
2477
1391
        sys.exit()
2478
1392
    if not noclose:
2479
1393
        # Close all standard open file descriptors
2480
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1394
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2481
1395
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2482
1396
            raise OSError(errno.ENODEV,
2483
 
                          "{} not a character device"
2484
 
                          .format(os.devnull))
 
1397
                          u"%s not a character device"
 
1398
                          % os.path.devnull)
2485
1399
        os.dup2(null, sys.stdin.fileno())
2486
1400
        os.dup2(null, sys.stdout.fileno())
2487
1401
        os.dup2(null, sys.stderr.fileno())
2494
1408
    ##################################################################
2495
1409
    # Parsing of options, both command line and config file
2496
1410
    
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()
 
1411
    parser = optparse.OptionParser(version = "%%prog %s" % version)
 
1412
    parser.add_option("-i", u"--interface", type=u"string",
 
1413
                      metavar="IF", help=u"Bind to interface IF")
 
1414
    parser.add_option("-a", u"--address", type=u"string",
 
1415
                      help=u"Address to listen for requests on")
 
1416
    parser.add_option("-p", u"--port", type=u"int",
 
1417
                      help=u"Port number to receive requests on")
 
1418
    parser.add_option("--check", action=u"store_true",
 
1419
                      help=u"Run self-test")
 
1420
    parser.add_option("--debug", action=u"store_true",
 
1421
                      help=u"Debug mode; run in foreground and log to"
 
1422
                      u" terminal")
 
1423
    parser.add_option("--priority", type=u"string", help=u"GnuTLS"
 
1424
                      u" priority string (see GnuTLS documentation)")
 
1425
    parser.add_option("--servicename", type=u"string",
 
1426
                      metavar=u"NAME", help=u"Zeroconf service name")
 
1427
    parser.add_option("--configdir", type=u"string",
 
1428
                      default=u"/etc/mandos", metavar=u"DIR",
 
1429
                      help=u"Directory to search for configuration"
 
1430
                      u" files")
 
1431
    parser.add_option("--no-dbus", action=u"store_false",
 
1432
                      dest=u"use_dbus", help=u"Do not provide D-Bus"
 
1433
                      u" system bus interface")
 
1434
    parser.add_option("--no-ipv6", action=u"store_false",
 
1435
                      dest=u"use_ipv6", help=u"Do not use IPv6")
 
1436
    options = parser.parse_args()[0]
2543
1437
    
2544
1438
    if options.check:
2545
1439
        import doctest
2546
 
        fail_count, test_count = doctest.testmod()
2547
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
1440
        doctest.testmod()
 
1441
        sys.exit()
2548
1442
    
2549
1443
    # 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
 
                    }
 
1444
    server_defaults = { u"interface": u"",
 
1445
                        u"address": u"",
 
1446
                        u"port": u"",
 
1447
                        u"debug": u"False",
 
1448
                        u"priority":
 
1449
                        u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
1450
                        u"servicename": u"Mandos",
 
1451
                        u"use_dbus": u"True",
 
1452
                        u"use_ipv6": u"True",
 
1453
                        }
2567
1454
    
2568
1455
    # Parse config file for server-global settings
2569
1456
    server_config = configparser.SafeConfigParser(server_defaults)
2570
1457
    del server_defaults
2571
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
1458
    server_config.read(os.path.join(options.configdir,
 
1459
                                    u"mandos.conf"))
2572
1460
    # Convert the SafeConfigParser object to a dict
2573
1461
    server_settings = server_config.defaults()
2574
1462
    # 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",
 
1463
    for option in (u"debug", u"use_dbus", u"use_ipv6"):
 
1464
        server_settings[option] = server_config.getboolean(u"DEFAULT",
2577
1465
                                                           option)
2578
1466
    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"])
 
1467
        server_settings["port"] = server_config.getint(u"DEFAULT",
 
1468
                                                       u"port")
2590
1469
    del server_config
2591
1470
    
2592
1471
    # Override the settings from the config file with command line
2593
1472
    # 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"):
 
1473
    for option in (u"interface", u"address", u"port", u"debug",
 
1474
                   u"priority", u"servicename", u"configdir",
 
1475
                   u"use_dbus", u"use_ipv6"):
2598
1476
        value = getattr(options, option)
2599
1477
        if value is not None:
2600
1478
            server_settings[option] = value
2601
1479
    del options
2602
1480
    # Force all strings to be unicode
2603
1481
    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
 
1482
        if type(server_settings[option]) is str:
 
1483
            server_settings[option] = unicode(server_settings[option])
2614
1484
    # Now we have our good server settings in "server_settings"
2615
1485
    
2616
1486
    ##################################################################
2617
1487
    
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
1488
    # 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"])))
 
1489
    debug = server_settings[u"debug"]
 
1490
    use_dbus = server_settings[u"use_dbus"]
 
1491
    use_ipv6 = server_settings[u"use_ipv6"]
 
1492
    
 
1493
    if not debug:
 
1494
        syslogger.setLevel(logging.WARNING)
 
1495
        console.setLevel(logging.WARNING)
 
1496
    
 
1497
    if server_settings[u"servicename"] != u"Mandos":
 
1498
        syslogger.setFormatter(logging.Formatter
 
1499
                               (u'Mandos (%s) [%%(process)d]:'
 
1500
                                u' %%(levelname)s: %%(message)s'
 
1501
                                % server_settings[u"servicename"]))
2647
1502
    
2648
1503
    # 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"))
 
1504
    client_defaults = { u"timeout": u"1h",
 
1505
                        u"interval": u"5m",
 
1506
                        u"checker": u"fping -q -- %%(host)s",
 
1507
                        u"host": u"",
 
1508
                        }
 
1509
    client_config = configparser.SafeConfigParser(client_defaults)
 
1510
    client_config.read(os.path.join(server_settings[u"configdir"],
 
1511
                                    u"clients.conf"))
2653
1512
    
2654
1513
    global mandos_dbus_service
2655
1514
    mandos_dbus_service = None
2656
1515
    
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)
 
1516
    tcp_server = MandosServer((server_settings[u"address"],
 
1517
                               server_settings[u"port"]),
 
1518
                              ClientHandler,
 
1519
                              interface=server_settings[u"interface"],
 
1520
                              use_ipv6=use_ipv6,
 
1521
                              gnutls_priority=
 
1522
                              server_settings[u"priority"],
 
1523
                              use_dbus=use_dbus)
 
1524
    pidfilename = u"/var/run/mandos.pid"
 
1525
    try:
 
1526
        pidfile = open(pidfilename, u"w")
 
1527
    except IOError:
 
1528
        logger.error(u"Could not open file %r", pidfilename)
2678
1529
    
2679
 
    for name in ("_mandos", "mandos", "nobody"):
 
1530
    try:
 
1531
        uid = pwd.getpwnam(u"_mandos").pw_uid
 
1532
        gid = pwd.getpwnam(u"_mandos").pw_gid
 
1533
    except KeyError:
2680
1534
        try:
2681
 
            uid = pwd.getpwnam(name).pw_uid
2682
 
            gid = pwd.getpwnam(name).pw_gid
2683
 
            break
 
1535
            uid = pwd.getpwnam(u"mandos").pw_uid
 
1536
            gid = pwd.getpwnam(u"mandos").pw_gid
2684
1537
        except KeyError:
2685
 
            continue
2686
 
    else:
2687
 
        uid = 65534
2688
 
        gid = 65534
 
1538
            try:
 
1539
                uid = pwd.getpwnam(u"nobody").pw_uid
 
1540
                gid = pwd.getpwnam(u"nobody").pw_gid
 
1541
            except KeyError:
 
1542
                uid = 65534
 
1543
                gid = 65534
2689
1544
    try:
2690
1545
        os.setgid(gid)
2691
1546
        os.setuid(uid)
2692
 
    except OSError as error:
2693
 
        if error.errno != errno.EPERM:
2694
 
            raise
 
1547
    except OSError, error:
 
1548
        if error[0] != errno.EPERM:
 
1549
            raise error
2695
1550
    
 
1551
    # Enable all possible GnuTLS debugging
2696
1552
    if debug:
2697
 
        # Enable all possible GnuTLS debugging
2698
 
        
2699
1553
        # "Use a log level over 10 to enable all debugging options."
2700
1554
        # - GnuTLS manual
2701
1555
        gnutls.library.functions.gnutls_global_set_log_level(11)
2702
1556
        
2703
1557
        @gnutls.library.types.gnutls_log_func
2704
1558
        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()
 
1559
            logger.debug(u"GnuTLS: %s", string[:-1])
 
1560
        
 
1561
        (gnutls.library.functions
 
1562
         .gnutls_global_set_log_function(debug_gnutls))
2724
1563
    
2725
1564
    global main_loop
2726
1565
    # From the Avahi example code
2727
 
    DBusGMainLoop(set_as_default=True)
 
1566
    DBusGMainLoop(set_as_default=True )
2728
1567
    main_loop = gobject.MainLoop()
2729
1568
    bus = dbus.SystemBus()
2730
1569
    # End of Avahi example code
2731
1570
    if use_dbus:
2732
1571
        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)
 
1572
            bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
 
1573
                                            bus, do_not_queue=True)
 
1574
        except dbus.exceptions.NameExistsException, e:
 
1575
            logger.error(unicode(e) + u", disabling D-Bus")
2741
1576
            use_dbus = False
2742
 
            server_settings["use_dbus"] = False
 
1577
            server_settings[u"use_dbus"] = False
2743
1578
            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()
 
1579
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
1580
    service = AvahiService(name = server_settings[u"servicename"],
 
1581
                           servicetype = u"_mandos._tcp",
 
1582
                           protocol = protocol, bus = bus)
 
1583
    if server_settings["interface"]:
 
1584
        service.interface = (if_nametoindex
 
1585
                             (str(server_settings[u"interface"])))
2757
1586
    
2758
1587
    client_class = Client
2759
1588
    if use_dbus:
2760
1589
        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))
2845
 
            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
 
    
 
1590
    tcp_server.clients.update(set(
 
1591
            client_class(name = section,
 
1592
                         config= dict(client_config.items(section)))
 
1593
            for section in client_config.sections()))
2871
1594
    if not tcp_server.clients:
2872
 
        logger.warning("No clients defined")
2873
 
    
2874
 
    if not foreground:
2875
 
        if pidfile is not None:
 
1595
        logger.warning(u"No clients defined")
 
1596
    
 
1597
    if debug:
 
1598
        # Redirect stdin so all checkers get /dev/null
 
1599
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
1600
        os.dup2(null, sys.stdin.fileno())
 
1601
        if null > 2:
 
1602
            os.close(null)
 
1603
    else:
 
1604
        # No console logging
 
1605
        logger.removeHandler(console)
 
1606
        # Close all input and output, do double fork, etc.
 
1607
        daemon()
 
1608
    
 
1609
    try:
 
1610
        with closing(pidfile):
2876
1611
            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)
 
1612
            pidfile.write(str(pid) + "\n")
2883
1613
        del pidfile
2884
 
        del pidfilename
 
1614
    except IOError:
 
1615
        logger.error(u"Could not write to file %r with PID %d",
 
1616
                     pidfilename, pid)
 
1617
    except NameError:
 
1618
        # "pidfile" was never created
 
1619
        pass
 
1620
    del pidfilename
2885
1621
    
 
1622
    if not debug:
 
1623
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2886
1624
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2887
1625
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2888
1626
    
2889
1627
    if use_dbus:
2890
 
        
2891
 
        @alternate_dbus_interfaces(
2892
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2893
 
        class MandosDBusService(DBusObjectWithObjectManager):
 
1628
        class MandosDBusService(dbus.service.Object):
2894
1629
            """A D-Bus proxy object"""
2895
 
            
2896
1630
            def __init__(self):
2897
 
                dbus.service.Object.__init__(self, bus, "/")
2898
 
            
2899
 
            _interface = "se.recompile.Mandos"
2900
 
            
2901
 
            @dbus.service.signal(_interface, signature="o")
2902
 
            def ClientAdded(self, objpath):
 
1631
                dbus.service.Object.__init__(self, bus, u"/")
 
1632
            _interface = u"se.bsnet.fukt.Mandos"
 
1633
            
 
1634
            @dbus.service.signal(_interface, signature=u"oa{sv}")
 
1635
            def ClientAdded(self, objpath, properties):
2903
1636
                "D-Bus signal"
2904
1637
                pass
2905
1638
            
2906
 
            @dbus.service.signal(_interface, signature="ss")
 
1639
            @dbus.service.signal(_interface, signature=u"ss")
2907
1640
            def ClientNotFound(self, fingerprint, address):
2908
1641
                "D-Bus signal"
2909
1642
                pass
2910
1643
            
2911
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
2912
 
                               "true"})
2913
 
            @dbus.service.signal(_interface, signature="os")
 
1644
            @dbus.service.signal(_interface, signature=u"os")
2914
1645
            def ClientRemoved(self, objpath, name):
2915
1646
                "D-Bus signal"
2916
1647
                pass
2917
1648
            
2918
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
2919
 
                               "true"})
2920
 
            @dbus.service.method(_interface, out_signature="ao")
 
1649
            @dbus.service.method(_interface, out_signature=u"ao")
2921
1650
            def GetAllClients(self):
2922
1651
                "D-Bus method"
2923
 
                return dbus.Array(c.dbus_object_path for c in
2924
 
                                  tcp_server.clients.itervalues())
 
1652
                return dbus.Array(c.dbus_object_path
 
1653
                                  for c in tcp_server.clients)
2925
1654
            
2926
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
2927
 
                               "true"})
2928
1655
            @dbus.service.method(_interface,
2929
 
                                 out_signature="a{oa{sv}}")
 
1656
                                 out_signature=u"a{oa{sv}}")
2930
1657
            def GetAllClientsWithProperties(self):
2931
1658
                "D-Bus method"
2932
1659
                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}")
 
1660
                    ((c.dbus_object_path, c.GetAll(u""))
 
1661
                     for c in tcp_server.clients),
 
1662
                    signature=u"oa{sv}")
2937
1663
            
2938
 
            @dbus.service.method(_interface, in_signature="o")
 
1664
            @dbus.service.method(_interface, in_signature=u"o")
2939
1665
            def RemoveClient(self, object_path):
2940
1666
                "D-Bus method"
2941
 
                for c in tcp_server.clients.itervalues():
 
1667
                for c in tcp_server.clients:
2942
1668
                    if c.dbus_object_path == object_path:
2943
 
                        del tcp_server.clients[c.name]
 
1669
                        tcp_server.clients.remove(c)
2944
1670
                        c.remove_from_connection()
2945
 
                        # Don't signal the disabling
 
1671
                        # Don't signal anything except ClientRemoved
2946
1672
                        c.disable(quiet=True)
2947
 
                        # Emit D-Bus signal for removal
2948
 
                        self.client_removed_signal(c)
 
1673
                        # Emit D-Bus signal
 
1674
                        self.ClientRemoved(object_path, c.name)
2949
1675
                        return
2950
1676
                raise KeyError(object_path)
2951
1677
            
2952
1678
            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
1679
        
2990
1680
        mandos_dbus_service = MandosDBusService()
2991
1681
    
2992
1682
    def cleanup():
2993
1683
        "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
 
1684
        service.cleanup()
 
1685
        
3055
1686
        while tcp_server.clients:
3056
 
            name, client = tcp_server.clients.popitem()
 
1687
            client = tcp_server.clients.pop()
3057
1688
            if use_dbus:
3058
1689
                client.remove_from_connection()
3059
 
            # Don't signal the disabling
 
1690
            client.disable_hook = None
 
1691
            # Don't signal anything except ClientRemoved
3060
1692
            client.disable(quiet=True)
3061
 
            # Emit D-Bus signal for removal
3062
 
            mandos_dbus_service.client_removed_signal(client)
3063
 
        client_settings.clear()
 
1693
            if use_dbus:
 
1694
                # Emit D-Bus signal
 
1695
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
1696
                                                  client.name)
3064
1697
    
3065
1698
    atexit.register(cleanup)
3066
1699
    
3067
 
    for client in tcp_server.clients.itervalues():
 
1700
    for client in tcp_server.clients:
3068
1701
        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()
 
1702
            # Emit D-Bus signal
 
1703
            mandos_dbus_service.ClientAdded(client.dbus_object_path,
 
1704
                                            client.GetAll(u""))
 
1705
        client.enable()
3074
1706
    
3075
1707
    tcp_server.enable()
3076
1708
    tcp_server.server_activate()
3077
1709
    
3078
1710
    # Find out what port we got
3079
 
    if zeroconf:
3080
 
        service.port = tcp_server.socket.getsockname()[1]
 
1711
    service.port = tcp_server.socket.getsockname()[1]
3081
1712
    if use_ipv6:
3082
 
        logger.info("Now listening on address %r, port %d,"
3083
 
                    " flowinfo %d, scope_id %d",
3084
 
                    *tcp_server.socket.getsockname())
 
1713
        logger.info(u"Now listening on address %r, port %d,"
 
1714
                    " flowinfo %d, scope_id %d"
 
1715
                    % tcp_server.socket.getsockname())
3085
1716
    else:                       # IPv4
3086
 
        logger.info("Now listening on address %r, port %d",
3087
 
                    *tcp_server.socket.getsockname())
 
1717
        logger.info(u"Now listening on address %r, port %d"
 
1718
                    % tcp_server.socket.getsockname())
3088
1719
    
3089
1720
    #service.interface = tcp_server.socket.getsockname()[3]
3090
1721
    
3091
1722
    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
 
1723
        # From the Avahi example code
 
1724
        try:
 
1725
            service.activate()
 
1726
        except dbus.exceptions.DBusException, error:
 
1727
            logger.critical(u"DBusException: %s", error)
 
1728
            cleanup()
 
1729
            sys.exit(1)
 
1730
        # End of Avahi example code
3101
1731
        
3102
1732
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3103
1733
                             lambda *args, **kwargs:
3104
1734
                             (tcp_server.handle_request
3105
1735
                              (*args[2:], **kwargs) or True))
3106
1736
        
3107
 
        logger.debug("Starting main loop")
 
1737
        logger.debug(u"Starting main loop")
3108
1738
        main_loop.run()
3109
 
    except AvahiError as error:
3110
 
        logger.critical("Avahi Error", exc_info=error)
 
1739
    except AvahiError, error:
 
1740
        logger.critical(u"AvahiError: %s", error)
3111
1741
        cleanup()
3112
1742
        sys.exit(1)
3113
1743
    except KeyboardInterrupt:
3114
1744
        if debug:
3115
 
            print("", file=sys.stderr)
3116
 
        logger.debug("Server received KeyboardInterrupt")
3117
 
    logger.debug("Server exiting")
 
1745
            print >> sys.stderr
 
1746
        logger.debug(u"Server received KeyboardInterrupt")
 
1747
    logger.debug(u"Server exiting")
3118
1748
    # Must run before the D-Bus bus name gets deregistered
3119
1749
    cleanup()
3120
1750
 
3121
 
 
3122
1751
if __name__ == '__main__':
3123
1752
    main()