/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-06-14 02:55:24 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 317.
  • Revision ID: teddy@recompile.se-20140614025524-k03150tjp4t89w1d
plugin-runner: Restore resources correctly if fork() fails.

* plugin-runner.c (main): If fork() fails, close pipe FD's and restore
                          signal mask for SIGCHLD.

Show diffs side-by-side

added added

removed removed

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