/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

working new feature: network-hooks - Enables user-scripts to take up
                     interfaces during bootup

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