/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2008-09-06 16:11:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906161150-1umb8yz6a29zxg28
* Makefile (install-client): Add "/etc/plugins.d/README".
  (uninstall-client): Remove "/etc/plugins.d/README".

* etc-plugins.d-README: New file.

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