/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-02-16 12:54:34 UTC
  • mfrom: (655 trunk)
  • mto: This revision was merged to the branch mainline in revision 656.
  • Revision ID: teddy@recompile.se-20140216125434-zll46tlbgvvl5wda
Merge from trunk.

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