/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: 2011-12-31 20:07:11 UTC
  • mfrom: (535.1.9 wireless-network-hook)
  • Revision ID: teddy@recompile.se-20111231200711-6dli3r8drftem57r
Merge new wireless network hook.  Fix bridge network hook to use
hardware addresses instead of interface names.  Implement and document
new "CONNECT" environment variable for network hooks.

Show diffs side-by-side

added added

removed removed

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