/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2009-04-17 08:26:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090417082617-eltetak5lzjyz55o
* initramfs-tools-hook: Bug fix: Add "--userid" and "--groupid" to
                        start of "plugin-runner.conf" file instead of
                        appending, to allow any preexisting options to
                        override.
* plugin-runner.conf: Improved wording.

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