/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 server.py

merge

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
# following functions: "AvahiService.add", "AvahiService.remove",
 
10
# "server_state_changed", "entry_group_state_changed", and some lines
 
11
# in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008,2009 Teddy Hogeborn
15
 
# Copyright © 2008,2009 Björn Påhlsson
 
14
# Copyright © 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
25
24
#     GNU General Public License for more details.
26
25
27
26
# You should have received a copy of the GNU General Public License
28
 
# along with this program.  If not, see
29
 
# <http://www.gnu.org/licenses/>.
 
27
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
30
28
31
29
# Contact the authors at <mandos@fukt.bsnet.se>.
32
30
33
31
 
34
 
from __future__ import division, with_statement, absolute_import
 
32
from __future__ import division
35
33
 
36
 
import SocketServer as socketserver
 
34
import SocketServer
37
35
import socket
38
 
import optparse
 
36
import select
 
37
from optparse import OptionParser
39
38
import datetime
40
39
import errno
41
40
import gnutls.crypto
44
43
import gnutls.library.functions
45
44
import gnutls.library.constants
46
45
import gnutls.library.types
47
 
import ConfigParser as configparser
 
46
import ConfigParser
48
47
import sys
49
48
import re
50
49
import os
51
50
import signal
 
51
from sets import Set
52
52
import subprocess
53
53
import atexit
54
54
import stat
55
55
import logging
56
56
import logging.handlers
57
 
import pwd
58
 
from contextlib import closing
59
 
import struct
60
 
import fcntl
61
 
import functools
62
57
 
63
58
import dbus
64
 
import dbus.service
65
59
import gobject
66
60
import avahi
67
61
from dbus.mainloop.glib import DBusGMainLoop
68
62
import ctypes
69
 
import ctypes.util
70
 
import xml.dom.minidom
71
 
import inspect
72
 
 
73
 
try:
74
 
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
75
 
except AttributeError:
76
 
    try:
77
 
        from IN import SO_BINDTODEVICE
78
 
    except ImportError:
79
 
        SO_BINDTODEVICE = None
80
 
 
81
 
 
82
 
version = "1.0.12"
83
 
 
84
 
logger = logging.Logger(u'mandos')
85
 
syslogger = (logging.handlers.SysLogHandler
86
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
87
 
              address = "/dev/log"))
88
 
syslogger.setFormatter(logging.Formatter
89
 
                       (u'Mandos [%(process)d]: %(levelname)s:'
90
 
                        u' %(message)s'))
 
63
 
 
64
# Brief description of the operation of this program:
 
65
 
66
# This server announces itself as a Zeroconf service.  Connecting
 
67
# clients use the TLS protocol, with the unusual quirk that this
 
68
# server program acts as a TLS "client" while a connecting client acts
 
69
# as a TLS "server".  The client (acting as a TLS "server") must
 
70
# supply an OpenPGP certificate, and the fingerprint of this
 
71
# certificate is used by this server to look up (in a list read from a
 
72
# file at start time) which binary blob to give the client.  No other
 
73
# authentication or authorization is done by this server.
 
74
 
 
75
 
 
76
logger = logging.Logger('mandos')
 
77
syslogger = logging.handlers.SysLogHandler\
 
78
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
 
79
syslogger.setFormatter(logging.Formatter\
 
80
                        ('%(levelname)s: %(message)s'))
91
81
logger.addHandler(syslogger)
 
82
del syslogger
92
83
 
93
 
console = logging.StreamHandler()
94
 
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
95
 
                                       u' %(levelname)s:'
96
 
                                       u' %(message)s'))
97
 
logger.addHandler(console)
98
84
 
99
85
class AvahiError(Exception):
100
 
    def __init__(self, value, *args, **kwargs):
 
86
    def __init__(self, value):
101
87
        self.value = value
102
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
103
 
    def __unicode__(self):
104
 
        return unicode(repr(self.value))
 
88
    def __str__(self):
 
89
        return repr(self.value)
105
90
 
106
91
class AvahiServiceError(AvahiError):
107
92
    pass
112
97
 
113
98
class AvahiService(object):
114
99
    """An Avahi (Zeroconf) service.
115
 
    
116
100
    Attributes:
117
101
    interface: integer; avahi.IF_UNSPEC or an interface index.
118
102
               Used to optionally bind to the specified interface.
119
 
    name: string; Example: u'Mandos'
120
 
    type: string; Example: u'_mandos._tcp'.
 
103
    name: string; Example: 'Mandos'
 
104
    type: string; Example: '_mandos._tcp'.
121
105
                  See <http://www.dns-sd.org/ServiceTypes.html>
122
106
    port: integer; what port to announce
123
107
    TXT: list of strings; TXT record for the service
126
110
    max_renames: integer; maximum number of renames
127
111
    rename_count: integer; counter so we only rename after collisions
128
112
                  a sensible number of times
129
 
    group: D-Bus Entry Group
130
 
    server: D-Bus Server
131
 
    bus: dbus.SystemBus()
132
113
    """
133
114
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
134
 
                 servicetype = None, port = None, TXT = None,
135
 
                 domain = u"", host = u"", max_renames = 32768,
136
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
115
                 type = None, port = None, TXT = None, domain = "",
 
116
                 host = "", max_renames = 12):
137
117
        self.interface = interface
138
118
        self.name = name
139
 
        self.type = servicetype
 
119
        self.type = type
140
120
        self.port = port
141
 
        self.TXT = TXT if TXT is not None else []
 
121
        if TXT is None:
 
122
            self.TXT = []
 
123
        else:
 
124
            self.TXT = TXT
142
125
        self.domain = domain
143
126
        self.host = host
144
127
        self.rename_count = 0
145
 
        self.max_renames = max_renames
146
 
        self.protocol = protocol
147
 
        self.group = None       # our entry group
148
 
        self.server = None
149
 
        self.bus = bus
150
128
    def rename(self):
151
129
        """Derived from the Avahi example code"""
152
130
        if self.rename_count >= self.max_renames:
153
 
            logger.critical(u"No suitable Zeroconf service name found"
154
 
                            u" after %i retries, exiting.",
155
 
                            self.rename_count)
156
 
            raise AvahiServiceError(u"Too many renames")
157
 
        self.name = self.server.GetAlternativeServiceName(self.name)
158
 
        logger.info(u"Changing Zeroconf service name to %r ...",
159
 
                    unicode(self.name))
160
 
        syslogger.setFormatter(logging.Formatter
161
 
                               (u'Mandos (%s) [%%(process)d]:'
162
 
                                u' %%(levelname)s: %%(message)s'
163
 
                                % self.name))
 
131
            logger.critical(u"No suitable service name found after %i"
 
132
                            u" retries, exiting.", rename_count)
 
133
            raise AvahiServiceError("Too many renames")
 
134
        name = server.GetAlternativeServiceName(name)
 
135
        logger.error(u"Changing name to %r ...", name)
164
136
        self.remove()
165
137
        self.add()
166
138
        self.rename_count += 1
167
139
    def remove(self):
168
140
        """Derived from the Avahi example code"""
169
 
        if self.group is not None:
170
 
            self.group.Reset()
 
141
        if group is not None:
 
142
            group.Reset()
171
143
    def add(self):
172
144
        """Derived from the Avahi example code"""
173
 
        if self.group is None:
174
 
            self.group = dbus.Interface(
175
 
                self.bus.get_object(avahi.DBUS_NAME,
176
 
                                    self.server.EntryGroupNew()),
177
 
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
178
 
            self.group.connect_to_signal('StateChanged',
179
 
                                         self
180
 
                                         .entry_group_state_changed)
181
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
182
 
                     self.name, self.type)
183
 
        self.group.AddService(
184
 
            self.interface,
185
 
            self.protocol,
186
 
            dbus.UInt32(0),     # flags
187
 
            self.name, self.type,
188
 
            self.domain, self.host,
189
 
            dbus.UInt16(self.port),
190
 
            avahi.string_array_to_txt_array(self.TXT))
191
 
        self.group.Commit()
192
 
    def entry_group_state_changed(self, state, error):
193
 
        """Derived from the Avahi example code"""
194
 
        logger.debug(u"Avahi state change: %i", state)
195
 
        
196
 
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
197
 
            logger.debug(u"Zeroconf service established.")
198
 
        elif state == avahi.ENTRY_GROUP_COLLISION:
199
 
            logger.warning(u"Zeroconf service name collision.")
200
 
            self.rename()
201
 
        elif state == avahi.ENTRY_GROUP_FAILURE:
202
 
            logger.critical(u"Avahi: Error in group state changed %s",
203
 
                            unicode(error))
204
 
            raise AvahiGroupError(u"State changed: %s"
205
 
                                  % unicode(error))
206
 
    def cleanup(self):
207
 
        """Derived from the Avahi example code"""
208
 
        if self.group is not None:
209
 
            self.group.Free()
210
 
            self.group = None
211
 
    def server_state_changed(self, state):
212
 
        """Derived from the Avahi example code"""
213
 
        if state == avahi.SERVER_COLLISION:
214
 
            logger.error(u"Zeroconf server name collision")
215
 
            self.remove()
216
 
        elif state == avahi.SERVER_RUNNING:
217
 
            self.add()
218
 
    def activate(self):
219
 
        """Derived from the Avahi example code"""
220
 
        if self.server is None:
221
 
            self.server = dbus.Interface(
222
 
                self.bus.get_object(avahi.DBUS_NAME,
223
 
                                    avahi.DBUS_PATH_SERVER),
224
 
                avahi.DBUS_INTERFACE_SERVER)
225
 
        self.server.connect_to_signal(u"StateChanged",
226
 
                                 self.server_state_changed)
227
 
        self.server_state_changed(self.server.GetState())
 
145
        global group
 
146
        if group is None:
 
147
            group = dbus.Interface\
 
148
                    (bus.get_object(avahi.DBUS_NAME,
 
149
                                    server.EntryGroupNew()),
 
150
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
151
            group.connect_to_signal('StateChanged',
 
152
                                    entry_group_state_changed)
 
153
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
154
                     service.name, service.type)
 
155
        group.AddService(
 
156
                self.interface,         # interface
 
157
                avahi.PROTO_INET6,      # protocol
 
158
                dbus.UInt32(0),         # flags
 
159
                self.name, self.type,
 
160
                self.domain, self.host,
 
161
                dbus.UInt16(self.port),
 
162
                avahi.string_array_to_txt_array(self.TXT))
 
163
        group.Commit()
 
164
 
 
165
# From the Avahi example code:
 
166
group = None                            # our entry group
 
167
# End of Avahi example code
228
168
 
229
169
 
230
170
class Client(object):
231
171
    """A representation of a client host served by this server.
232
 
    
233
172
    Attributes:
234
 
    name:       string; from the config file, used in log messages and
235
 
                        D-Bus identifiers
 
173
    name:      string; from the config file, used in log messages
236
174
    fingerprint: string (40 or 32 hexadecimal digits); used to
237
175
                 uniquely identify the client
238
 
    secret:     bytestring; sent verbatim (over TLS) to client
239
 
    host:       string; available for use by the checker command
240
 
    created:    datetime.datetime(); (UTC) object creation
241
 
    last_enabled: datetime.datetime(); (UTC)
242
 
    enabled:    bool()
243
 
    last_checked_ok: datetime.datetime(); (UTC) or None
244
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
245
 
                                      until this client is invalid
246
 
    interval:   datetime.timedelta(); How often to start a new checker
247
 
    disable_hook:  If set, called by disable() as disable_hook(self)
248
 
    checker:    subprocess.Popen(); a running checker process used
249
 
                                    to see if the client lives.
250
 
                                    'None' if no process is running.
 
176
    secret:    bytestring; sent verbatim (over TLS) to client
 
177
    fqdn:      string (FQDN); available for use by the checker command
 
178
    created:   datetime.datetime(); object creation, not client host
 
179
    last_checked_ok: datetime.datetime() or None if not yet checked OK
 
180
    timeout:   datetime.timedelta(); How long from last_checked_ok
 
181
                                     until this client is invalid
 
182
    interval:  datetime.timedelta(); How often to start a new checker
 
183
    stop_hook: If set, called by stop() as stop_hook(self)
 
184
    checker:   subprocess.Popen(); a running checker process used
 
185
                                   to see if the client lives.
 
186
                                   'None' if no process is running.
251
187
    checker_initiator_tag: a gobject event source tag, or None
252
 
    disable_initiator_tag: - '' -
 
188
    stop_initiator_tag:    - '' -
253
189
    checker_callback_tag:  - '' -
254
190
    checker_command: string; External command which is run to check if
255
191
                     client lives.  %() expansions are done at
256
192
                     runtime with vars(self) as dict, so that for
257
193
                     instance %(name)s can be used in the command.
258
 
    current_checker_command: string; current running checker_command
 
194
    Private attibutes:
 
195
    _timeout: Real variable for 'timeout'
 
196
    _interval: Real variable for 'interval'
 
197
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
198
    _interval_milliseconds: - '' -
259
199
    """
260
 
    
261
 
    @staticmethod
262
 
    def _timedelta_to_milliseconds(td):
263
 
        "Convert a datetime.timedelta() to milliseconds"
264
 
        return ((td.days * 24 * 60 * 60 * 1000)
265
 
                + (td.seconds * 1000)
266
 
                + (td.microseconds // 1000))
267
 
    
268
 
    def timeout_milliseconds(self):
269
 
        "Return the 'timeout' attribute in milliseconds"
270
 
        return self._timedelta_to_milliseconds(self.timeout)
271
 
    
272
 
    def interval_milliseconds(self):
273
 
        "Return the 'interval' attribute in milliseconds"
274
 
        return self._timedelta_to_milliseconds(self.interval)
275
 
    
276
 
    def __init__(self, name = None, disable_hook=None, config=None):
 
200
    def _set_timeout(self, timeout):
 
201
        "Setter function for 'timeout' attribute"
 
202
        self._timeout = timeout
 
203
        self._timeout_milliseconds = ((self.timeout.days
 
204
                                       * 24 * 60 * 60 * 1000)
 
205
                                      + (self.timeout.seconds * 1000)
 
206
                                      + (self.timeout.microseconds
 
207
                                         // 1000))
 
208
    timeout = property(lambda self: self._timeout,
 
209
                       _set_timeout)
 
210
    del _set_timeout
 
211
    def _set_interval(self, interval):
 
212
        "Setter function for 'interval' attribute"
 
213
        self._interval = interval
 
214
        self._interval_milliseconds = ((self.interval.days
 
215
                                        * 24 * 60 * 60 * 1000)
 
216
                                       + (self.interval.seconds
 
217
                                          * 1000)
 
218
                                       + (self.interval.microseconds
 
219
                                          // 1000))
 
220
    interval = property(lambda self: self._interval,
 
221
                        _set_interval)
 
222
    del _set_interval
 
223
    def __init__(self, name = None, stop_hook=None, config={}):
277
224
        """Note: the 'checker' key in 'config' sets the
278
225
        'checker_command' attribute and *not* the 'checker'
279
226
        attribute."""
280
227
        self.name = name
281
 
        if config is None:
282
 
            config = {}
283
228
        logger.debug(u"Creating client %r", self.name)
284
229
        # Uppercase and remove spaces from fingerprint for later
285
230
        # comparison purposes with return value from the fingerprint()
286
231
        # function
287
 
        self.fingerprint = (config[u"fingerprint"].upper()
288
 
                            .replace(u" ", u""))
 
232
        self.fingerprint = config["fingerprint"].upper()\
 
233
                           .replace(u" ", u"")
289
234
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
290
 
        if u"secret" in config:
291
 
            self.secret = config[u"secret"].decode(u"base64")
292
 
        elif u"secfile" in config:
293
 
            with closing(open(os.path.expanduser
294
 
                              (os.path.expandvars
295
 
                               (config[u"secfile"])))) as secfile:
296
 
                self.secret = secfile.read()
 
235
        if "secret" in config:
 
236
            self.secret = config["secret"].decode(u"base64")
 
237
        elif "secfile" in config:
 
238
            sf = open(config["secfile"])
 
239
            self.secret = sf.read()
 
240
            sf.close()
297
241
        else:
298
242
            raise TypeError(u"No secret or secfile for client %s"
299
243
                            % self.name)
300
 
        self.host = config.get(u"host", u"")
301
 
        self.created = datetime.datetime.utcnow()
302
 
        self.enabled = False
303
 
        self.last_enabled = None
 
244
        self.fqdn = config.get("fqdn", "")
 
245
        self.created = datetime.datetime.now()
304
246
        self.last_checked_ok = None
305
 
        self.timeout = string_to_delta(config[u"timeout"])
306
 
        self.interval = string_to_delta(config[u"interval"])
307
 
        self.disable_hook = disable_hook
 
247
        self.timeout = string_to_delta(config["timeout"])
 
248
        self.interval = string_to_delta(config["interval"])
 
249
        self.stop_hook = stop_hook
308
250
        self.checker = None
309
251
        self.checker_initiator_tag = None
310
 
        self.disable_initiator_tag = None
 
252
        self.stop_initiator_tag = None
311
253
        self.checker_callback_tag = None
312
 
        self.checker_command = config[u"checker"]
313
 
        self.current_checker_command = None
314
 
        self.last_connect = None
315
 
    
316
 
    def enable(self):
 
254
        self.check_command = config["checker"]
 
255
    def start(self):
317
256
        """Start this client's checker and timeout hooks"""
318
 
        if getattr(self, u"enabled", False):
319
 
            # Already enabled
320
 
            return
321
 
        self.last_enabled = datetime.datetime.utcnow()
322
257
        # Schedule a new checker to be started an 'interval' from now,
323
258
        # and every interval from then on.
324
 
        self.checker_initiator_tag = (gobject.timeout_add
325
 
                                      (self.interval_milliseconds(),
326
 
                                       self.start_checker))
 
259
        self.checker_initiator_tag = gobject.timeout_add\
 
260
                                     (self._interval_milliseconds,
 
261
                                      self.start_checker)
327
262
        # Also start a new checker *right now*.
328
263
        self.start_checker()
329
 
        # Schedule a disable() when 'timeout' has passed
330
 
        self.disable_initiator_tag = (gobject.timeout_add
331
 
                                   (self.timeout_milliseconds(),
332
 
                                    self.disable))
333
 
        self.enabled = True
334
 
    
335
 
    def disable(self):
336
 
        """Disable this client."""
337
 
        if not getattr(self, "enabled", False):
 
264
        # Schedule a stop() when 'timeout' has passed
 
265
        self.stop_initiator_tag = gobject.timeout_add\
 
266
                                  (self._timeout_milliseconds,
 
267
                                   self.stop)
 
268
    def stop(self):
 
269
        """Stop this client.
 
270
        The possibility that a client might be restarted is left open,
 
271
        but not currently used."""
 
272
        # If this client doesn't have a secret, it is already stopped.
 
273
        if self.secret:
 
274
            logger.info(u"Stopping client %s", self.name)
 
275
            self.secret = None
 
276
        else:
338
277
            return False
339
 
        logger.info(u"Disabling client %s", self.name)
340
 
        if getattr(self, u"disable_initiator_tag", False):
341
 
            gobject.source_remove(self.disable_initiator_tag)
342
 
            self.disable_initiator_tag = None
343
 
        if getattr(self, u"checker_initiator_tag", False):
 
278
        if getattr(self, "stop_initiator_tag", False):
 
279
            gobject.source_remove(self.stop_initiator_tag)
 
280
            self.stop_initiator_tag = None
 
281
        if getattr(self, "checker_initiator_tag", False):
344
282
            gobject.source_remove(self.checker_initiator_tag)
345
283
            self.checker_initiator_tag = None
346
284
        self.stop_checker()
347
 
        if self.disable_hook:
348
 
            self.disable_hook(self)
349
 
        self.enabled = False
 
285
        if self.stop_hook:
 
286
            self.stop_hook(self)
350
287
        # Do not run this again if called by a gobject.timeout_add
351
288
        return False
352
 
    
353
289
    def __del__(self):
354
 
        self.disable_hook = None
355
 
        self.disable()
356
 
    
357
 
    def checker_callback(self, pid, condition, command):
 
290
        self.stop_hook = None
 
291
        self.stop()
 
292
    def checker_callback(self, pid, condition):
358
293
        """The checker has completed, so take appropriate actions."""
 
294
        now = datetime.datetime.now()
359
295
        self.checker_callback_tag = None
360
296
        self.checker = None
361
 
        if os.WIFEXITED(condition):
362
 
            exitstatus = os.WEXITSTATUS(condition)
363
 
            if exitstatus == 0:
364
 
                logger.info(u"Checker for %(name)s succeeded",
365
 
                            vars(self))
366
 
                self.checked_ok()
367
 
            else:
368
 
                logger.info(u"Checker for %(name)s failed",
369
 
                            vars(self))
370
 
        else:
 
297
        if os.WIFEXITED(condition) \
 
298
               and (os.WEXITSTATUS(condition) == 0):
 
299
            logger.info(u"Checker for %(name)s succeeded",
 
300
                        vars(self))
 
301
            self.last_checked_ok = now
 
302
            gobject.source_remove(self.stop_initiator_tag)
 
303
            self.stop_initiator_tag = gobject.timeout_add\
 
304
                                      (self._timeout_milliseconds,
 
305
                                       self.stop)
 
306
        elif not os.WIFEXITED(condition):
371
307
            logger.warning(u"Checker for %(name)s crashed?",
372
308
                           vars(self))
373
 
    
374
 
    def checked_ok(self):
375
 
        """Bump up the timeout for this client.
376
 
        
377
 
        This should only be called when the client has been seen,
378
 
        alive and well.
379
 
        """
380
 
        self.last_checked_ok = datetime.datetime.utcnow()
381
 
        gobject.source_remove(self.disable_initiator_tag)
382
 
        self.disable_initiator_tag = (gobject.timeout_add
383
 
                                      (self.timeout_milliseconds(),
384
 
                                       self.disable))
385
 
    
 
309
        else:
 
310
            logger.info(u"Checker for %(name)s failed",
 
311
                        vars(self))
386
312
    def start_checker(self):
387
313
        """Start a new checker subprocess if one is not running.
388
 
        
389
314
        If a checker already exists, leave it running and do
390
315
        nothing."""
391
316
        # The reason for not killing a running checker is that if we
396
321
        # checkers alone, the checker would have to take more time
397
322
        # than 'timeout' for the client to be declared invalid, which
398
323
        # is as it should be.
399
 
        
400
 
        # If a checker exists, make sure it is not a zombie
401
 
        try:
402
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
403
 
        except (AttributeError, OSError), error:
404
 
            if (isinstance(error, OSError)
405
 
                and error.errno != errno.ECHILD):
406
 
                raise error
407
 
        else:
408
 
            if pid:
409
 
                logger.warning(u"Checker was a zombie")
410
 
                gobject.source_remove(self.checker_callback_tag)
411
 
                self.checker_callback(pid, status,
412
 
                                      self.current_checker_command)
413
 
        # Start a new checker if needed
414
324
        if self.checker is None:
415
325
            try:
416
 
                # In case checker_command has exactly one % operator
417
 
                command = self.checker_command % self.host
 
326
                # In case check_command has exactly one % operator
 
327
                command = self.check_command % self.fqdn
418
328
            except TypeError:
419
329
                # Escape attributes for the shell
420
 
                escaped_attrs = dict((key,
421
 
                                      re.escape(unicode(str(val),
422
 
                                                        errors=
423
 
                                                        u'replace')))
 
330
                escaped_attrs = dict((key, re.escape(str(val)))
424
331
                                     for key, val in
425
332
                                     vars(self).iteritems())
426
333
                try:
427
 
                    command = self.checker_command % escaped_attrs
 
334
                    command = self.check_command % escaped_attrs
428
335
                except TypeError, error:
429
336
                    logger.error(u'Could not format string "%s":'
430
 
                                 u' %s', self.checker_command, error)
 
337
                                 u' %s', self.check_command, error)
431
338
                    return True # Try again later
432
 
            self.current_checker_command = command
433
339
            try:
434
340
                logger.info(u"Starting checker %r for %s",
435
341
                            command, self.name)
436
 
                # We don't need to redirect stdout and stderr, since
437
 
                # in normal mode, that is already done by daemon(),
438
 
                # and in debug mode we don't want to.  (Stdin is
439
 
                # always replaced by /dev/null.)
440
342
                self.checker = subprocess.Popen(command,
441
343
                                                close_fds=True,
442
 
                                                shell=True, cwd=u"/")
443
 
                self.checker_callback_tag = (gobject.child_watch_add
444
 
                                             (self.checker.pid,
445
 
                                              self.checker_callback,
446
 
                                              data=command))
447
 
                # The checker may have completed before the gobject
448
 
                # watch was added.  Check for this.
449
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
450
 
                if pid:
451
 
                    gobject.source_remove(self.checker_callback_tag)
452
 
                    self.checker_callback(pid, status, command)
453
 
            except OSError, error:
 
344
                                                shell=True, cwd="/")
 
345
                self.checker_callback_tag = gobject.child_watch_add\
 
346
                                            (self.checker.pid,
 
347
                                             self.checker_callback)
 
348
            except subprocess.OSError, error:
454
349
                logger.error(u"Failed to start subprocess: %s",
455
350
                             error)
456
351
        # Re-run this periodically if run by gobject.timeout_add
457
352
        return True
458
 
    
459
353
    def stop_checker(self):
460
354
        """Force the checker process, if any, to stop."""
461
355
        if self.checker_callback_tag:
462
356
            gobject.source_remove(self.checker_callback_tag)
463
357
            self.checker_callback_tag = None
464
 
        if getattr(self, u"checker", None) is None:
 
358
        if getattr(self, "checker", None) is None:
465
359
            return
466
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
360
        logger.debug("Stopping checker for %(name)s", vars(self))
467
361
        try:
468
362
            os.kill(self.checker.pid, signal.SIGTERM)
469
363
            #os.sleep(0.5)
473
367
            if error.errno != errno.ESRCH: # No such process
474
368
                raise
475
369
        self.checker = None
476
 
    
477
370
    def still_valid(self):
478
371
        """Has the timeout not yet passed for this client?"""
479
 
        if not getattr(self, u"enabled", False):
480
 
            return False
481
 
        now = datetime.datetime.utcnow()
 
372
        now = datetime.datetime.now()
482
373
        if self.last_checked_ok is None:
483
374
            return now < (self.created + self.timeout)
484
375
        else:
485
376
            return now < (self.last_checked_ok + self.timeout)
486
377
 
487
378
 
488
 
def dbus_service_property(dbus_interface, signature=u"v",
489
 
                          access=u"readwrite", byte_arrays=False):
490
 
    """Decorators for marking methods of a DBusObjectWithProperties to
491
 
    become properties on the D-Bus.
492
 
    
493
 
    The decorated method will be called with no arguments by "Get"
494
 
    and with one argument by "Set".
495
 
    
496
 
    The parameters, where they are supported, are the same as
497
 
    dbus.service.method, except there is only "signature", since the
498
 
    type from Get() and the type sent to Set() is the same.
499
 
    """
500
 
    def decorator(func):
501
 
        func._dbus_is_property = True
502
 
        func._dbus_interface = dbus_interface
503
 
        func._dbus_signature = signature
504
 
        func._dbus_access = access
505
 
        func._dbus_name = func.__name__
506
 
        if func._dbus_name.endswith(u"_dbus_property"):
507
 
            func._dbus_name = func._dbus_name[:-14]
508
 
        func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
509
 
        return func
510
 
    return decorator
511
 
 
512
 
 
513
 
class DBusPropertyException(dbus.exceptions.DBusException):
514
 
    """A base class for D-Bus property-related exceptions
515
 
    """
516
 
    def __unicode__(self):
517
 
        return unicode(str(self))
518
 
 
519
 
 
520
 
class DBusPropertyAccessException(DBusPropertyException):
521
 
    """A property's access permissions disallows an operation.
522
 
    """
523
 
    pass
524
 
 
525
 
 
526
 
class DBusPropertyNotFound(DBusPropertyException):
527
 
    """An attempt was made to access a non-existing property.
528
 
    """
529
 
    pass
530
 
 
531
 
 
532
 
class DBusObjectWithProperties(dbus.service.Object):
533
 
    """A D-Bus object with properties.
534
 
 
535
 
    Classes inheriting from this can use the dbus_service_property
536
 
    decorator to expose methods as D-Bus properties.  It exposes the
537
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
538
 
    """
539
 
    
540
 
    @staticmethod
541
 
    def _is_dbus_property(obj):
542
 
        return getattr(obj, u"_dbus_is_property", False)
543
 
    
544
 
    def _get_all_dbus_properties(self):
545
 
        """Returns a generator of (name, attribute) pairs
546
 
        """
547
 
        return ((prop._dbus_name, prop)
548
 
                for name, prop in
549
 
                inspect.getmembers(self, self._is_dbus_property))
550
 
    
551
 
    def _get_dbus_property(self, interface_name, property_name):
552
 
        """Returns a bound method if one exists which is a D-Bus
553
 
        property with the specified name and interface.
554
 
        """
555
 
        for name in (property_name,
556
 
                     property_name + u"_dbus_property"):
557
 
            prop = getattr(self, name, None)
558
 
            if (prop is None
559
 
                or not self._is_dbus_property(prop)
560
 
                or prop._dbus_name != property_name
561
 
                or (interface_name and prop._dbus_interface
562
 
                    and interface_name != prop._dbus_interface)):
563
 
                continue
564
 
            return prop
565
 
        # No such property
566
 
        raise DBusPropertyNotFound(self.dbus_object_path + u":"
567
 
                                   + interface_name + u"."
568
 
                                   + property_name)
569
 
    
570
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
571
 
                         out_signature=u"v")
572
 
    def Get(self, interface_name, property_name):
573
 
        """Standard D-Bus property Get() method, see D-Bus standard.
574
 
        """
575
 
        prop = self._get_dbus_property(interface_name, property_name)
576
 
        if prop._dbus_access == u"write":
577
 
            raise DBusPropertyAccessException(property_name)
578
 
        value = prop()
579
 
        if not hasattr(value, u"variant_level"):
580
 
            return value
581
 
        return type(value)(value, variant_level=value.variant_level+1)
582
 
    
583
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
584
 
    def Set(self, interface_name, property_name, value):
585
 
        """Standard D-Bus property Set() method, see D-Bus standard.
586
 
        """
587
 
        prop = self._get_dbus_property(interface_name, property_name)
588
 
        if prop._dbus_access == u"read":
589
 
            raise DBusPropertyAccessException(property_name)
590
 
        if prop._dbus_get_args_options[u"byte_arrays"]:
591
 
            value = dbus.ByteArray(''.join(unichr(byte)
592
 
                                           for byte in value))
593
 
        prop(value)
594
 
    
595
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
596
 
                         out_signature=u"a{sv}")
597
 
    def GetAll(self, interface_name):
598
 
        """Standard D-Bus property GetAll() method, see D-Bus
599
 
        standard.
600
 
 
601
 
        Note: Will not include properties with access="write".
602
 
        """
603
 
        all = {}
604
 
        for name, prop in self._get_all_dbus_properties():
605
 
            if (interface_name
606
 
                and interface_name != prop._dbus_interface):
607
 
                # Interface non-empty but did not match
608
 
                continue
609
 
            # Ignore write-only properties
610
 
            if prop._dbus_access == u"write":
611
 
                continue
612
 
            value = prop()
613
 
            if not hasattr(value, u"variant_level"):
614
 
                all[name] = value
615
 
                continue
616
 
            all[name] = type(value)(value, variant_level=
617
 
                                    value.variant_level+1)
618
 
        return dbus.Dictionary(all, signature=u"sv")
619
 
    
620
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
621
 
                         out_signature=u"s",
622
 
                         path_keyword='object_path',
623
 
                         connection_keyword='connection')
624
 
    def Introspect(self, object_path, connection):
625
 
        """Standard D-Bus method, overloaded to insert property tags.
626
 
        """
627
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
628
 
                                           connection)
629
 
        document = xml.dom.minidom.parseString(xmlstring)
630
 
        del xmlstring
631
 
        def make_tag(document, name, prop):
632
 
            e = document.createElement(u"property")
633
 
            e.setAttribute(u"name", name)
634
 
            e.setAttribute(u"type", prop._dbus_signature)
635
 
            e.setAttribute(u"access", prop._dbus_access)
636
 
            return e
637
 
        for if_tag in document.getElementsByTagName(u"interface"):
638
 
            for tag in (make_tag(document, name, prop)
639
 
                        for name, prop
640
 
                        in self._get_all_dbus_properties()
641
 
                        if prop._dbus_interface
642
 
                        == if_tag.getAttribute(u"name")):
643
 
                if_tag.appendChild(tag)
644
 
        xmlstring = document.toxml(u"utf-8")
645
 
        document.unlink()
646
 
        return xmlstring
647
 
 
648
 
 
649
 
class ClientDBus(Client, DBusObjectWithProperties):
650
 
    """A Client class using D-Bus
651
 
    
652
 
    Attributes:
653
 
    dbus_object_path: dbus.ObjectPath
654
 
    bus: dbus.SystemBus()
655
 
    """
656
 
    # dbus.service.Object doesn't use super(), so we can't either.
657
 
    
658
 
    def __init__(self, bus = None, *args, **kwargs):
659
 
        self.bus = bus
660
 
        Client.__init__(self, *args, **kwargs)
661
 
        # Only now, when this client is initialized, can it show up on
662
 
        # the D-Bus
663
 
        self.dbus_object_path = (dbus.ObjectPath
664
 
                                 (u"/clients/"
665
 
                                  + self.name.replace(u".", u"_")))
666
 
        DBusObjectWithProperties.__init__(self, self.bus,
667
 
                                          self.dbus_object_path)
668
 
    
669
 
    @staticmethod
670
 
    def _datetime_to_dbus(dt, variant_level=0):
671
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
672
 
        return dbus.String(dt.isoformat(),
673
 
                           variant_level=variant_level)
674
 
    
675
 
    def enable(self):
676
 
        oldstate = getattr(self, u"enabled", False)
677
 
        r = Client.enable(self)
678
 
        if oldstate != self.enabled:
679
 
            # Emit D-Bus signals
680
 
            self.PropertyChanged(dbus.String(u"enabled"),
681
 
                                 dbus.Boolean(True, variant_level=1))
682
 
            self.PropertyChanged(
683
 
                dbus.String(u"last_enabled"),
684
 
                self._datetime_to_dbus(self.last_enabled,
685
 
                                       variant_level=1))
686
 
        return r
687
 
    
688
 
    def disable(self, signal = True):
689
 
        oldstate = getattr(self, u"enabled", False)
690
 
        r = Client.disable(self)
691
 
        if signal and oldstate != self.enabled:
692
 
            # Emit D-Bus signal
693
 
            self.PropertyChanged(dbus.String(u"enabled"),
694
 
                                 dbus.Boolean(False, variant_level=1))
695
 
        return r
696
 
    
697
 
    def __del__(self, *args, **kwargs):
698
 
        try:
699
 
            self.remove_from_connection()
700
 
        except LookupError:
701
 
            pass
702
 
        if hasattr(DBusObjectWithProperties, u"__del__"):
703
 
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
704
 
        Client.__del__(self, *args, **kwargs)
705
 
    
706
 
    def checker_callback(self, pid, condition, command,
707
 
                         *args, **kwargs):
708
 
        self.checker_callback_tag = None
709
 
        self.checker = None
710
 
        # Emit D-Bus signal
711
 
        self.PropertyChanged(dbus.String(u"checker_running"),
712
 
                             dbus.Boolean(False, variant_level=1))
713
 
        if os.WIFEXITED(condition):
714
 
            exitstatus = os.WEXITSTATUS(condition)
715
 
            # Emit D-Bus signal
716
 
            self.CheckerCompleted(dbus.Int16(exitstatus),
717
 
                                  dbus.Int64(condition),
718
 
                                  dbus.String(command))
719
 
        else:
720
 
            # Emit D-Bus signal
721
 
            self.CheckerCompleted(dbus.Int16(-1),
722
 
                                  dbus.Int64(condition),
723
 
                                  dbus.String(command))
724
 
        
725
 
        return Client.checker_callback(self, pid, condition, command,
726
 
                                       *args, **kwargs)
727
 
    
728
 
    def checked_ok(self, *args, **kwargs):
729
 
        r = Client.checked_ok(self, *args, **kwargs)
730
 
        # Emit D-Bus signal
731
 
        self.PropertyChanged(
732
 
            dbus.String(u"last_checked_ok"),
733
 
            (self._datetime_to_dbus(self.last_checked_ok,
734
 
                                    variant_level=1)))
735
 
        return r
736
 
    
737
 
    def start_checker(self, *args, **kwargs):
738
 
        old_checker = self.checker
739
 
        if self.checker is not None:
740
 
            old_checker_pid = self.checker.pid
741
 
        else:
742
 
            old_checker_pid = None
743
 
        r = Client.start_checker(self, *args, **kwargs)
744
 
        # Only if new checker process was started
745
 
        if (self.checker is not None
746
 
            and old_checker_pid != self.checker.pid):
747
 
            # Emit D-Bus signal
748
 
            self.CheckerStarted(self.current_checker_command)
749
 
            self.PropertyChanged(
750
 
                dbus.String(u"checker_running"),
751
 
                dbus.Boolean(True, variant_level=1))
752
 
        return r
753
 
    
754
 
    def stop_checker(self, *args, **kwargs):
755
 
        old_checker = getattr(self, u"checker", None)
756
 
        r = Client.stop_checker(self, *args, **kwargs)
757
 
        if (old_checker is not None
758
 
            and getattr(self, u"checker", None) is None):
759
 
            self.PropertyChanged(dbus.String(u"checker_running"),
760
 
                                 dbus.Boolean(False, variant_level=1))
761
 
        return r
762
 
    
763
 
    ## D-Bus methods & signals
764
 
    _interface = u"se.bsnet.fukt.Mandos.Client"
765
 
    
766
 
    # CheckedOK - method
767
 
    @dbus.service.method(_interface)
768
 
    def CheckedOK(self):
769
 
        return self.checked_ok()
770
 
    
771
 
    # CheckerCompleted - signal
772
 
    @dbus.service.signal(_interface, signature=u"nxs")
773
 
    def CheckerCompleted(self, exitcode, waitstatus, command):
774
 
        "D-Bus signal"
775
 
        pass
776
 
    
777
 
    # CheckerStarted - signal
778
 
    @dbus.service.signal(_interface, signature=u"s")
779
 
    def CheckerStarted(self, command):
780
 
        "D-Bus signal"
781
 
        pass
782
 
    
783
 
    # PropertyChanged - signal
784
 
    @dbus.service.signal(_interface, signature=u"sv")
785
 
    def PropertyChanged(self, property, value):
786
 
        "D-Bus signal"
787
 
        pass
788
 
    
789
 
    # ReceivedSecret - signal
790
 
    @dbus.service.signal(_interface)
791
 
    def ReceivedSecret(self):
792
 
        "D-Bus signal"
793
 
        pass
794
 
    
795
 
    # Rejected - signal
796
 
    @dbus.service.signal(_interface)
797
 
    def Rejected(self):
798
 
        "D-Bus signal"
799
 
        pass
800
 
    
801
 
    # Enable - method
802
 
    @dbus.service.method(_interface)
803
 
    def Enable(self):
804
 
        "D-Bus method"
805
 
        self.enable()
806
 
    
807
 
    # StartChecker - method
808
 
    @dbus.service.method(_interface)
809
 
    def StartChecker(self):
810
 
        "D-Bus method"
811
 
        self.start_checker()
812
 
    
813
 
    # Disable - method
814
 
    @dbus.service.method(_interface)
815
 
    def Disable(self):
816
 
        "D-Bus method"
817
 
        self.disable()
818
 
    
819
 
    # StopChecker - method
820
 
    @dbus.service.method(_interface)
821
 
    def StopChecker(self):
822
 
        self.stop_checker()
823
 
    
824
 
    # name - property
825
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
826
 
    def name_dbus_property(self):
827
 
        return dbus.String(self.name)
828
 
    
829
 
    # fingerprint - property
830
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
831
 
    def fingerprint_dbus_property(self):
832
 
        return dbus.String(self.fingerprint)
833
 
    
834
 
    # host - property
835
 
    @dbus_service_property(_interface, signature=u"s",
836
 
                           access=u"readwrite")
837
 
    def host_dbus_property(self, value=None):
838
 
        if value is None:       # get
839
 
            return dbus.String(self.host)
840
 
        self.host = value
841
 
        # Emit D-Bus signal
842
 
        self.PropertyChanged(dbus.String(u"host"),
843
 
                             dbus.String(value, variant_level=1))
844
 
    
845
 
    # created - property
846
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
847
 
    def created_dbus_property(self):
848
 
        return dbus.String(self._datetime_to_dbus(self.created))
849
 
    
850
 
    # last_enabled - property
851
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
852
 
    def last_enabled_dbus_property(self):
853
 
        if self.last_enabled is None:
854
 
            return dbus.String(u"")
855
 
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
856
 
    
857
 
    # enabled - property
858
 
    @dbus_service_property(_interface, signature=u"b",
859
 
                           access=u"readwrite")
860
 
    def enabled_dbus_property(self, value=None):
861
 
        if value is None:       # get
862
 
            return dbus.Boolean(self.enabled)
863
 
        if value:
864
 
            self.enable()
865
 
        else:
866
 
            self.disable()
867
 
    
868
 
    # last_checked_ok - property
869
 
    @dbus_service_property(_interface, signature=u"s",
870
 
                           access=u"readwrite")
871
 
    def last_checked_ok_dbus_property(self, value=None):
872
 
        if value is not None:
873
 
            self.checked_ok()
874
 
            return
875
 
        if self.last_checked_ok is None:
876
 
            return dbus.String(u"")
877
 
        return dbus.String(self._datetime_to_dbus(self
878
 
                                                  .last_checked_ok))
879
 
    
880
 
    # timeout - property
881
 
    @dbus_service_property(_interface, signature=u"t",
882
 
                           access=u"readwrite")
883
 
    def timeout_dbus_property(self, value=None):
884
 
        if value is None:       # get
885
 
            return dbus.UInt64(self.timeout_milliseconds())
886
 
        self.timeout = datetime.timedelta(0, 0, 0, value)
887
 
        # Emit D-Bus signal
888
 
        self.PropertyChanged(dbus.String(u"timeout"),
889
 
                             dbus.UInt64(value, variant_level=1))
890
 
        if getattr(self, u"disable_initiator_tag", None) is None:
891
 
            return
892
 
        # Reschedule timeout
893
 
        gobject.source_remove(self.disable_initiator_tag)
894
 
        self.disable_initiator_tag = None
895
 
        time_to_die = (self.
896
 
                       _timedelta_to_milliseconds((self
897
 
                                                   .last_checked_ok
898
 
                                                   + self.timeout)
899
 
                                                  - datetime.datetime
900
 
                                                  .utcnow()))
901
 
        if time_to_die <= 0:
902
 
            # The timeout has passed
903
 
            self.disable()
904
 
        else:
905
 
            self.disable_initiator_tag = (gobject.timeout_add
906
 
                                          (time_to_die, self.disable))
907
 
    
908
 
    # interval - property
909
 
    @dbus_service_property(_interface, signature=u"t",
910
 
                           access=u"readwrite")
911
 
    def interval_dbus_property(self, value=None):
912
 
        if value is None:       # get
913
 
            return dbus.UInt64(self.interval_milliseconds())
914
 
        self.interval = datetime.timedelta(0, 0, 0, value)
915
 
        # Emit D-Bus signal
916
 
        self.PropertyChanged(dbus.String(u"interval"),
917
 
                             dbus.UInt64(value, variant_level=1))
918
 
        if getattr(self, u"checker_initiator_tag", None) is None:
919
 
            return
920
 
        # Reschedule checker run
921
 
        gobject.source_remove(self.checker_initiator_tag)
922
 
        self.checker_initiator_tag = (gobject.timeout_add
923
 
                                      (value, self.start_checker))
924
 
        self.start_checker()    # Start one now, too
925
 
 
926
 
    # checker - property
927
 
    @dbus_service_property(_interface, signature=u"s",
928
 
                           access=u"readwrite")
929
 
    def checker_dbus_property(self, value=None):
930
 
        if value is None:       # get
931
 
            return dbus.String(self.checker_command)
932
 
        self.checker_command = value
933
 
        # Emit D-Bus signal
934
 
        self.PropertyChanged(dbus.String(u"checker"),
935
 
                             dbus.String(self.checker_command,
936
 
                                         variant_level=1))
937
 
    
938
 
    # checker_running - property
939
 
    @dbus_service_property(_interface, signature=u"b",
940
 
                           access=u"readwrite")
941
 
    def checker_running_dbus_property(self, value=None):
942
 
        if value is None:       # get
943
 
            return dbus.Boolean(self.checker is not None)
944
 
        if value:
945
 
            self.start_checker()
946
 
        else:
947
 
            self.stop_checker()
948
 
    
949
 
    # object_path - property
950
 
    @dbus_service_property(_interface, signature=u"o", access=u"read")
951
 
    def object_path_dbus_property(self):
952
 
        return self.dbus_object_path # is already a dbus.ObjectPath
953
 
    
954
 
    # secret = property
955
 
    @dbus_service_property(_interface, signature=u"ay",
956
 
                           access=u"write", byte_arrays=True)
957
 
    def secret_dbus_property(self, value):
958
 
        self.secret = str(value)
959
 
    
960
 
    del _interface
961
 
 
962
 
 
963
 
class ClientHandler(socketserver.BaseRequestHandler, object):
964
 
    """A class to handle client connections.
965
 
    
966
 
    Instantiated once for each connection to handle it.
 
379
def peer_certificate(session):
 
380
    "Return the peer's OpenPGP certificate as a bytestring"
 
381
    # If not an OpenPGP certificate...
 
382
    if gnutls.library.functions.gnutls_certificate_type_get\
 
383
            (session._c_object) \
 
384
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
 
385
        # ...do the normal thing
 
386
        return session.peer_certificate
 
387
    list_size = ctypes.c_uint()
 
388
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
389
        (session._c_object, ctypes.byref(list_size))
 
390
    if list_size.value == 0:
 
391
        return None
 
392
    cert = cert_list[0]
 
393
    return ctypes.string_at(cert.data, cert.size)
 
394
 
 
395
 
 
396
def fingerprint(openpgp):
 
397
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
398
    # New GnuTLS "datum" with the OpenPGP public key
 
399
    datum = gnutls.library.types.gnutls_datum_t\
 
400
        (ctypes.cast(ctypes.c_char_p(openpgp),
 
401
                     ctypes.POINTER(ctypes.c_ubyte)),
 
402
         ctypes.c_uint(len(openpgp)))
 
403
    # New empty GnuTLS certificate
 
404
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
405
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
406
        (ctypes.byref(crt))
 
407
    # Import the OpenPGP public key into the certificate
 
408
    gnutls.library.functions.gnutls_openpgp_crt_import\
 
409
                    (crt, ctypes.byref(datum),
 
410
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
411
    # New buffer for the fingerprint
 
412
    buffer = ctypes.create_string_buffer(20)
 
413
    buffer_length = ctypes.c_size_t()
 
414
    # Get the fingerprint from the certificate into the buffer
 
415
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
416
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
417
    # Deinit the certificate
 
418
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
419
    # Convert the buffer to a Python bytestring
 
420
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
421
    # Convert the bytestring to hexadecimal notation
 
422
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
423
    return hex_fpr
 
424
 
 
425
 
 
426
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
427
    """A TCP request handler class.
 
428
    Instantiated by IPv6_TCPServer for each request to handle it.
967
429
    Note: This will run in its own forked process."""
968
430
    
969
431
    def handle(self):
970
432
        logger.info(u"TCP connection from: %s",
971
 
                    unicode(self.client_address))
972
 
        logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
973
 
        # Open IPC pipe to parent process
974
 
        with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
975
 
            session = (gnutls.connection
976
 
                       .ClientSession(self.request,
977
 
                                      gnutls.connection
978
 
                                      .X509Credentials()))
979
 
            
980
 
            line = self.request.makefile().readline()
981
 
            logger.debug(u"Protocol version: %r", line)
982
 
            try:
983
 
                if int(line.strip().split()[0]) > 1:
984
 
                    raise RuntimeError
985
 
            except (ValueError, IndexError, RuntimeError), error:
986
 
                logger.error(u"Unknown protocol version: %s", error)
987
 
                return
988
 
            
989
 
            # Note: gnutls.connection.X509Credentials is really a
990
 
            # generic GnuTLS certificate credentials object so long as
991
 
            # no X.509 keys are added to it.  Therefore, we can use it
992
 
            # here despite using OpenPGP certificates.
993
 
            
994
 
            #priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
995
 
            #                      u"+AES-256-CBC", u"+SHA1",
996
 
            #                      u"+COMP-NULL", u"+CTYPE-OPENPGP",
997
 
            #                      u"+DHE-DSS"))
998
 
            # Use a fallback default, since this MUST be set.
999
 
            priority = self.server.gnutls_priority
1000
 
            if priority is None:
1001
 
                priority = u"NORMAL"
1002
 
            (gnutls.library.functions
1003
 
             .gnutls_priority_set_direct(session._c_object,
1004
 
                                         priority, None))
1005
 
            
1006
 
            try:
1007
 
                session.handshake()
1008
 
            except gnutls.errors.GNUTLSError, error:
1009
 
                logger.warning(u"Handshake failed: %s", error)
1010
 
                # Do not run session.bye() here: the session is not
1011
 
                # established.  Just abandon the request.
1012
 
                return
1013
 
            logger.debug(u"Handshake succeeded")
1014
 
            try:
1015
 
                fpr = self.fingerprint(self.peer_certificate(session))
1016
 
            except (TypeError, gnutls.errors.GNUTLSError), error:
1017
 
                logger.warning(u"Bad certificate: %s", error)
1018
 
                session.bye()
1019
 
                return
1020
 
            logger.debug(u"Fingerprint: %s", fpr)
1021
 
            
1022
 
            for c in self.server.clients:
1023
 
                if c.fingerprint == fpr:
1024
 
                    client = c
1025
 
                    break
1026
 
            else:
1027
 
                ipc.write(u"NOTFOUND %s %s\n"
1028
 
                          % (fpr, unicode(self.client_address)))
1029
 
                session.bye()
1030
 
                return
1031
 
            # Have to check if client.still_valid(), since it is
1032
 
            # possible that the client timed out while establishing
1033
 
            # the GnuTLS session.
1034
 
            if not client.still_valid():
1035
 
                ipc.write(u"INVALID %s\n" % client.name)
1036
 
                session.bye()
1037
 
                return
1038
 
            ipc.write(u"SENDING %s\n" % client.name)
1039
 
            sent_size = 0
1040
 
            while sent_size < len(client.secret):
1041
 
                sent = session.send(client.secret[sent_size:])
1042
 
                logger.debug(u"Sent: %d, remaining: %d",
1043
 
                             sent, len(client.secret)
1044
 
                             - (sent_size + sent))
1045
 
                sent_size += sent
1046
 
            session.bye()
1047
 
    
1048
 
    @staticmethod
1049
 
    def peer_certificate(session):
1050
 
        "Return the peer's OpenPGP certificate as a bytestring"
1051
 
        # If not an OpenPGP certificate...
1052
 
        if (gnutls.library.functions
1053
 
            .gnutls_certificate_type_get(session._c_object)
1054
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1055
 
            # ...do the normal thing
1056
 
            return session.peer_certificate
1057
 
        list_size = ctypes.c_uint(1)
1058
 
        cert_list = (gnutls.library.functions
1059
 
                     .gnutls_certificate_get_peers
1060
 
                     (session._c_object, ctypes.byref(list_size)))
1061
 
        if not bool(cert_list) and list_size.value != 0:
1062
 
            raise gnutls.errors.GNUTLSError(u"error getting peer"
1063
 
                                            u" certificate")
1064
 
        if list_size.value == 0:
1065
 
            return None
1066
 
        cert = cert_list[0]
1067
 
        return ctypes.string_at(cert.data, cert.size)
1068
 
    
1069
 
    @staticmethod
1070
 
    def fingerprint(openpgp):
1071
 
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1072
 
        # New GnuTLS "datum" with the OpenPGP public key
1073
 
        datum = (gnutls.library.types
1074
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1075
 
                                             ctypes.POINTER
1076
 
                                             (ctypes.c_ubyte)),
1077
 
                                 ctypes.c_uint(len(openpgp))))
1078
 
        # New empty GnuTLS certificate
1079
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1080
 
        (gnutls.library.functions
1081
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
1082
 
        # Import the OpenPGP public key into the certificate
1083
 
        (gnutls.library.functions
1084
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1085
 
                                    gnutls.library.constants
1086
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
1087
 
        # Verify the self signature in the key
1088
 
        crtverify = ctypes.c_uint()
1089
 
        (gnutls.library.functions
1090
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1091
 
                                         ctypes.byref(crtverify)))
1092
 
        if crtverify.value != 0:
1093
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1094
 
            raise (gnutls.errors.CertificateSecurityError
1095
 
                   (u"Verify failed"))
1096
 
        # New buffer for the fingerprint
1097
 
        buf = ctypes.create_string_buffer(20)
1098
 
        buf_len = ctypes.c_size_t()
1099
 
        # Get the fingerprint from the certificate into the buffer
1100
 
        (gnutls.library.functions
1101
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1102
 
                                             ctypes.byref(buf_len)))
1103
 
        # Deinit the certificate
1104
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1105
 
        # Convert the buffer to a Python bytestring
1106
 
        fpr = ctypes.string_at(buf, buf_len.value)
1107
 
        # Convert the bytestring to hexadecimal notation
1108
 
        hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1109
 
        return hex_fpr
1110
 
 
1111
 
 
1112
 
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
1113
 
    """Like socketserver.ForkingMixIn, but also pass a pipe."""
1114
 
    def process_request(self, request, client_address):
1115
 
        """Overrides and wraps the original process_request().
1116
 
        
1117
 
        This function creates a new pipe in self.pipe
1118
 
        """
1119
 
        self.pipe = os.pipe()
1120
 
        super(ForkingMixInWithPipe,
1121
 
              self).process_request(request, client_address)
1122
 
        os.close(self.pipe[1])  # close write end
1123
 
        self.add_pipe(self.pipe[0])
1124
 
    def add_pipe(self, pipe):
1125
 
        """Dummy function; override as necessary"""
1126
 
        os.close(pipe)
1127
 
 
1128
 
 
1129
 
class IPv6_TCPServer(ForkingMixInWithPipe,
1130
 
                     socketserver.TCPServer, object):
1131
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1132
 
    
 
433
                     unicode(self.client_address))
 
434
        session = gnutls.connection.ClientSession\
 
435
                  (self.request, gnutls.connection.X509Credentials())
 
436
        
 
437
        line = self.request.makefile().readline()
 
438
        logger.debug(u"Protocol version: %r", line)
 
439
        try:
 
440
            if int(line.strip().split()[0]) > 1:
 
441
                raise RuntimeError
 
442
        except (ValueError, IndexError, RuntimeError), error:
 
443
            logger.error(u"Unknown protocol version: %s", error)
 
444
            return
 
445
        
 
446
        # Note: gnutls.connection.X509Credentials is really a generic
 
447
        # GnuTLS certificate credentials object so long as no X.509
 
448
        # keys are added to it.  Therefore, we can use it here despite
 
449
        # using OpenPGP certificates.
 
450
        
 
451
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
 
452
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
453
        #                "+DHE-DSS"))
 
454
        priority = "NORMAL"             # Fallback default, since this
 
455
                                        # MUST be set.
 
456
        if self.server.settings["priority"]:
 
457
            priority = self.server.settings["priority"]
 
458
        gnutls.library.functions.gnutls_priority_set_direct\
 
459
            (session._c_object, priority, None);
 
460
        
 
461
        try:
 
462
            session.handshake()
 
463
        except gnutls.errors.GNUTLSError, error:
 
464
            logger.warning(u"Handshake failed: %s", error)
 
465
            # Do not run session.bye() here: the session is not
 
466
            # established.  Just abandon the request.
 
467
            return
 
468
        try:
 
469
            fpr = fingerprint(peer_certificate(session))
 
470
        except (TypeError, gnutls.errors.GNUTLSError), error:
 
471
            logger.warning(u"Bad certificate: %s", error)
 
472
            session.bye()
 
473
            return
 
474
        logger.debug(u"Fingerprint: %s", fpr)
 
475
        client = None
 
476
        for c in self.server.clients:
 
477
            if c.fingerprint == fpr:
 
478
                client = c
 
479
                break
 
480
        if not client:
 
481
            logger.warning(u"Client not found for fingerprint: %s",
 
482
                           fpr)
 
483
            session.bye()
 
484
            return
 
485
        # Have to check if client.still_valid(), since it is possible
 
486
        # that the client timed out while establishing the GnuTLS
 
487
        # session.
 
488
        if not client.still_valid():
 
489
            logger.warning(u"Client %(name)s is invalid",
 
490
                           vars(client))
 
491
            session.bye()
 
492
            return
 
493
        sent_size = 0
 
494
        while sent_size < len(client.secret):
 
495
            sent = session.send(client.secret[sent_size:])
 
496
            logger.debug(u"Sent: %d, remaining: %d",
 
497
                         sent, len(client.secret)
 
498
                         - (sent_size + sent))
 
499
            sent_size += sent
 
500
        session.bye()
 
501
 
 
502
 
 
503
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
504
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
1133
505
    Attributes:
1134
 
        enabled:        Boolean; whether this server is activated yet
1135
 
        interface:      None or a network interface name (string)
1136
 
        use_ipv6:       Boolean; to use IPv6 or not
 
506
        settings:       Server settings
 
507
        clients:        Set() of Client objects
1137
508
    """
1138
 
    def __init__(self, server_address, RequestHandlerClass,
1139
 
                 interface=None, use_ipv6=True):
1140
 
        self.interface = interface
1141
 
        if use_ipv6:
1142
 
            self.address_family = socket.AF_INET6
1143
 
        socketserver.TCPServer.__init__(self, server_address,
1144
 
                                        RequestHandlerClass)
 
509
    address_family = socket.AF_INET6
 
510
    def __init__(self, *args, **kwargs):
 
511
        if "settings" in kwargs:
 
512
            self.settings = kwargs["settings"]
 
513
            del kwargs["settings"]
 
514
        if "clients" in kwargs:
 
515
            self.clients = kwargs["clients"]
 
516
            del kwargs["clients"]
 
517
        return super(type(self), self).__init__(*args, **kwargs)
1145
518
    def server_bind(self):
1146
519
        """This overrides the normal server_bind() function
1147
520
        to bind to an interface if one was specified, and also NOT to
1148
521
        bind to an address or port if they were not specified."""
1149
 
        if self.interface is not None:
1150
 
            if SO_BINDTODEVICE is None:
1151
 
                logger.error(u"SO_BINDTODEVICE does not exist;"
1152
 
                             u" cannot bind to interface %s",
1153
 
                             self.interface)
1154
 
            else:
1155
 
                try:
1156
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1157
 
                                           SO_BINDTODEVICE,
1158
 
                                           str(self.interface
1159
 
                                               + u'\0'))
1160
 
                except socket.error, error:
1161
 
                    if error[0] == errno.EPERM:
1162
 
                        logger.error(u"No permission to"
1163
 
                                     u" bind to interface %s",
1164
 
                                     self.interface)
1165
 
                    elif error[0] == errno.ENOPROTOOPT:
1166
 
                        logger.error(u"SO_BINDTODEVICE not available;"
1167
 
                                     u" cannot bind to interface %s",
1168
 
                                     self.interface)
1169
 
                    else:
1170
 
                        raise
 
522
        if self.settings["interface"]:
 
523
            # 25 is from /usr/include/asm-i486/socket.h
 
524
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
525
            try:
 
526
                self.socket.setsockopt(socket.SOL_SOCKET,
 
527
                                       SO_BINDTODEVICE,
 
528
                                       self.settings["interface"])
 
529
            except socket.error, error:
 
530
                if error[0] == errno.EPERM:
 
531
                    logger.error(u"No permission to"
 
532
                                 u" bind to interface %s",
 
533
                                 self.settings["interface"])
 
534
                else:
 
535
                    raise error
1171
536
        # Only bind(2) the socket if we really need to.
1172
537
        if self.server_address[0] or self.server_address[1]:
1173
538
            if not self.server_address[0]:
1174
 
                if self.address_family == socket.AF_INET6:
1175
 
                    any_address = u"::" # in6addr_any
1176
 
                else:
1177
 
                    any_address = socket.INADDR_ANY
1178
 
                self.server_address = (any_address,
 
539
                in6addr_any = "::"
 
540
                self.server_address = (in6addr_any,
1179
541
                                       self.server_address[1])
1180
 
            elif not self.server_address[1]:
 
542
            elif self.server_address[1] is None:
1181
543
                self.server_address = (self.server_address[0],
1182
544
                                       0)
1183
 
#                 if self.interface:
1184
 
#                     self.server_address = (self.server_address[0],
1185
 
#                                            0, # port
1186
 
#                                            0, # flowinfo
1187
 
#                                            if_nametoindex
1188
 
#                                            (self.interface))
1189
 
            return socketserver.TCPServer.server_bind(self)
1190
 
 
1191
 
 
1192
 
class MandosServer(IPv6_TCPServer):
1193
 
    """Mandos server.
1194
 
    
1195
 
    Attributes:
1196
 
        clients:        set of Client objects
1197
 
        gnutls_priority GnuTLS priority string
1198
 
        use_dbus:       Boolean; to emit D-Bus signals or not
1199
 
    
1200
 
    Assumes a gobject.MainLoop event loop.
1201
 
    """
1202
 
    def __init__(self, server_address, RequestHandlerClass,
1203
 
                 interface=None, use_ipv6=True, clients=None,
1204
 
                 gnutls_priority=None, use_dbus=True):
1205
 
        self.enabled = False
1206
 
        self.clients = clients
1207
 
        if self.clients is None:
1208
 
            self.clients = set()
1209
 
        self.use_dbus = use_dbus
1210
 
        self.gnutls_priority = gnutls_priority
1211
 
        IPv6_TCPServer.__init__(self, server_address,
1212
 
                                RequestHandlerClass,
1213
 
                                interface = interface,
1214
 
                                use_ipv6 = use_ipv6)
1215
 
    def server_activate(self):
1216
 
        if self.enabled:
1217
 
            return socketserver.TCPServer.server_activate(self)
1218
 
    def enable(self):
1219
 
        self.enabled = True
1220
 
    def add_pipe(self, pipe):
1221
 
        # Call "handle_ipc" for both data and EOF events
1222
 
        gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1223
 
                             self.handle_ipc)
1224
 
    def handle_ipc(self, source, condition, file_objects={}):
1225
 
        condition_names = {
1226
 
            gobject.IO_IN: u"IN",   # There is data to read.
1227
 
            gobject.IO_OUT: u"OUT", # Data can be written (without
1228
 
                                    # blocking).
1229
 
            gobject.IO_PRI: u"PRI", # There is urgent data to read.
1230
 
            gobject.IO_ERR: u"ERR", # Error condition.
1231
 
            gobject.IO_HUP: u"HUP"  # Hung up (the connection has been
1232
 
                                    # broken, usually for pipes and
1233
 
                                    # sockets).
1234
 
            }
1235
 
        conditions_string = ' | '.join(name
1236
 
                                       for cond, name in
1237
 
                                       condition_names.iteritems()
1238
 
                                       if cond & condition)
1239
 
        logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1240
 
                     conditions_string)
1241
 
        
1242
 
        # Turn the pipe file descriptor into a Python file object
1243
 
        if source not in file_objects:
1244
 
            file_objects[source] = os.fdopen(source, u"r", 1)
1245
 
        
1246
 
        # Read a line from the file object
1247
 
        cmdline = file_objects[source].readline()
1248
 
        if not cmdline:             # Empty line means end of file
1249
 
            # close the IPC pipe
1250
 
            file_objects[source].close()
1251
 
            del file_objects[source]
1252
 
            
1253
 
            # Stop calling this function
1254
 
            return False
1255
 
        
1256
 
        logger.debug(u"IPC command: %r", cmdline)
1257
 
        
1258
 
        # Parse and act on command
1259
 
        cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1260
 
        
1261
 
        if cmd == u"NOTFOUND":
1262
 
            logger.warning(u"Client not found for fingerprint: %s",
1263
 
                           args)
1264
 
            if self.use_dbus:
1265
 
                # Emit D-Bus signal
1266
 
                mandos_dbus_service.ClientNotFound(args)
1267
 
        elif cmd == u"INVALID":
1268
 
            for client in self.clients:
1269
 
                if client.name == args:
1270
 
                    logger.warning(u"Client %s is invalid", args)
1271
 
                    if self.use_dbus:
1272
 
                        # Emit D-Bus signal
1273
 
                        client.Rejected()
1274
 
                    break
1275
 
            else:
1276
 
                logger.error(u"Unknown client %s is invalid", args)
1277
 
        elif cmd == u"SENDING":
1278
 
            for client in self.clients:
1279
 
                if client.name == args:
1280
 
                    logger.info(u"Sending secret to %s", client.name)
1281
 
                    client.checked_ok()
1282
 
                    if self.use_dbus:
1283
 
                        # Emit D-Bus signal
1284
 
                        client.ReceivedSecret()
1285
 
                    break
1286
 
            else:
1287
 
                logger.error(u"Sending secret to unknown client %s",
1288
 
                             args)
1289
 
        else:
1290
 
            logger.error(u"Unknown IPC command: %r", cmdline)
1291
 
        
1292
 
        # Keep calling this function
1293
 
        return True
 
545
            return super(type(self), self).server_bind()
1294
546
 
1295
547
 
1296
548
def string_to_delta(interval):
1297
549
    """Parse a string and return a datetime.timedelta
1298
 
    
1299
 
    >>> string_to_delta(u'7d')
 
550
 
 
551
    >>> string_to_delta('7d')
1300
552
    datetime.timedelta(7)
1301
 
    >>> string_to_delta(u'60s')
 
553
    >>> string_to_delta('60s')
1302
554
    datetime.timedelta(0, 60)
1303
 
    >>> string_to_delta(u'60m')
 
555
    >>> string_to_delta('60m')
1304
556
    datetime.timedelta(0, 3600)
1305
 
    >>> string_to_delta(u'24h')
 
557
    >>> string_to_delta('24h')
1306
558
    datetime.timedelta(1)
1307
559
    >>> string_to_delta(u'1w')
1308
560
    datetime.timedelta(7)
1309
 
    >>> string_to_delta(u'5m 30s')
1310
 
    datetime.timedelta(0, 330)
1311
561
    """
1312
 
    timevalue = datetime.timedelta(0)
1313
 
    for s in interval.split():
1314
 
        try:
1315
 
            suffix = unicode(s[-1])
1316
 
            value = int(s[:-1])
1317
 
            if suffix == u"d":
1318
 
                delta = datetime.timedelta(value)
1319
 
            elif suffix == u"s":
1320
 
                delta = datetime.timedelta(0, value)
1321
 
            elif suffix == u"m":
1322
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
1323
 
            elif suffix == u"h":
1324
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1325
 
            elif suffix == u"w":
1326
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1327
 
            else:
1328
 
                raise ValueError
1329
 
        except (ValueError, IndexError):
 
562
    try:
 
563
        suffix=unicode(interval[-1])
 
564
        value=int(interval[:-1])
 
565
        if suffix == u"d":
 
566
            delta = datetime.timedelta(value)
 
567
        elif suffix == u"s":
 
568
            delta = datetime.timedelta(0, value)
 
569
        elif suffix == u"m":
 
570
            delta = datetime.timedelta(0, 0, 0, 0, value)
 
571
        elif suffix == u"h":
 
572
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
573
        elif suffix == u"w":
 
574
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
575
        else:
1330
576
            raise ValueError
1331
 
        timevalue += delta
1332
 
    return timevalue
1333
 
 
 
577
    except (ValueError, IndexError):
 
578
        raise ValueError
 
579
    return delta
 
580
 
 
581
 
 
582
def server_state_changed(state):
 
583
    """Derived from the Avahi example code"""
 
584
    if state == avahi.SERVER_COLLISION:
 
585
        logger.error(u"Server name collision")
 
586
        service.remove()
 
587
    elif state == avahi.SERVER_RUNNING:
 
588
        service.add()
 
589
 
 
590
 
 
591
def entry_group_state_changed(state, error):
 
592
    """Derived from the Avahi example code"""
 
593
    logger.debug(u"state change: %i", state)
 
594
    
 
595
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
596
        logger.debug(u"Service established.")
 
597
    elif state == avahi.ENTRY_GROUP_COLLISION:
 
598
        logger.warning(u"Service name collision.")
 
599
        service.rename()
 
600
    elif state == avahi.ENTRY_GROUP_FAILURE:
 
601
        logger.critical(u"Error in group state changed %s",
 
602
                        unicode(error))
 
603
        raise AvahiGroupError("State changed: %s", str(error))
1334
604
 
1335
605
def if_nametoindex(interface):
1336
 
    """Call the C function if_nametoindex(), or equivalent
1337
 
    
1338
 
    Note: This function cannot accept a unicode string."""
 
606
    """Call the C function if_nametoindex(), or equivalent"""
1339
607
    global if_nametoindex
1340
608
    try:
1341
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1342
 
                          (ctypes.util.find_library(u"c"))
1343
 
                          .if_nametoindex)
 
609
        if "ctypes.util" not in sys.modules:
 
610
            import ctypes.util
 
611
        if_nametoindex = ctypes.cdll.LoadLibrary\
 
612
            (ctypes.util.find_library("c")).if_nametoindex
1344
613
    except (OSError, AttributeError):
1345
 
        logger.warning(u"Doing if_nametoindex the hard way")
 
614
        if "struct" not in sys.modules:
 
615
            import struct
 
616
        if "fcntl" not in sys.modules:
 
617
            import fcntl
1346
618
        def if_nametoindex(interface):
1347
619
            "Get an interface index the hard way, i.e. using fcntl()"
1348
620
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1349
 
            with closing(socket.socket()) as s:
1350
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1351
 
                                    struct.pack(str(u"16s16x"),
1352
 
                                                interface))
1353
 
            interface_index = struct.unpack(str(u"I"),
1354
 
                                            ifreq[16:20])[0]
 
621
            s = socket.socket()
 
622
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
623
                                struct.pack("16s16x", interface))
 
624
            s.close()
 
625
            interface_index = struct.unpack("I", ifreq[16:20])[0]
1355
626
            return interface_index
1356
627
    return if_nametoindex(interface)
1357
628
 
1358
629
 
1359
 
def daemon(nochdir = False, noclose = False):
 
630
def daemon(nochdir, noclose):
1360
631
    """See daemon(3).  Standard BSD Unix function.
1361
 
    
1362
632
    This should really exist as os.daemon, but it doesn't (yet)."""
1363
633
    if os.fork():
1364
634
        sys.exit()
1365
635
    os.setsid()
1366
636
    if not nochdir:
1367
 
        os.chdir(u"/")
1368
 
    if os.fork():
1369
 
        sys.exit()
 
637
        os.chdir("/")
1370
638
    if not noclose:
1371
639
        # Close all standard open file descriptors
1372
640
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1373
641
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1374
642
            raise OSError(errno.ENODEV,
1375
 
                          u"/dev/null not a character device")
 
643
                          "/dev/null not a character device")
1376
644
        os.dup2(null, sys.stdin.fileno())
1377
645
        os.dup2(null, sys.stdout.fileno())
1378
646
        os.dup2(null, sys.stderr.fileno())
1381
649
 
1382
650
 
1383
651
def main():
1384
 
    
1385
 
    ##################################################################
1386
 
    # Parsing of options, both command line and config file
1387
 
    
1388
 
    parser = optparse.OptionParser(version = "%%prog %s" % version)
1389
 
    parser.add_option("-i", u"--interface", type=u"string",
1390
 
                      metavar="IF", help=u"Bind to interface IF")
1391
 
    parser.add_option("-a", u"--address", type=u"string",
1392
 
                      help=u"Address to listen for requests on")
1393
 
    parser.add_option("-p", u"--port", type=u"int",
1394
 
                      help=u"Port number to receive requests on")
1395
 
    parser.add_option("--check", action=u"store_true",
1396
 
                      help=u"Run self-test")
1397
 
    parser.add_option("--debug", action=u"store_true",
1398
 
                      help=u"Debug mode; run in foreground and log to"
1399
 
                      u" terminal")
1400
 
    parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1401
 
                      u" priority string (see GnuTLS documentation)")
1402
 
    parser.add_option("--servicename", type=u"string",
1403
 
                      metavar=u"NAME", help=u"Zeroconf service name")
1404
 
    parser.add_option("--configdir", type=u"string",
1405
 
                      default=u"/etc/mandos", metavar=u"DIR",
1406
 
                      help=u"Directory to search for configuration"
1407
 
                      u" files")
1408
 
    parser.add_option("--no-dbus", action=u"store_false",
1409
 
                      dest=u"use_dbus", help=u"Do not provide D-Bus"
1410
 
                      u" system bus interface")
1411
 
    parser.add_option("--no-ipv6", action=u"store_false",
1412
 
                      dest=u"use_ipv6", help=u"Do not use IPv6")
1413
 
    options = parser.parse_args()[0]
 
652
    global main_loop_started
 
653
    main_loop_started = False
 
654
    
 
655
    parser = OptionParser()
 
656
    parser.add_option("-i", "--interface", type="string",
 
657
                      metavar="IF", help="Bind to interface IF")
 
658
    parser.add_option("-a", "--address", type="string",
 
659
                      help="Address to listen for requests on")
 
660
    parser.add_option("-p", "--port", type="int",
 
661
                      help="Port number to receive requests on")
 
662
    parser.add_option("--check", action="store_true", default=False,
 
663
                      help="Run self-test")
 
664
    parser.add_option("--debug", action="store_true", default=False,
 
665
                      help="Debug mode; run in foreground and log to"
 
666
                      " terminal")
 
667
    parser.add_option("--priority", type="string", help="GnuTLS"
 
668
                      " priority string (see GnuTLS documentation)")
 
669
    parser.add_option("--servicename", type="string", metavar="NAME",
 
670
                      help="Zeroconf service name")
 
671
    parser.add_option("--configdir", type="string",
 
672
                      default="/etc/mandos", metavar="DIR",
 
673
                      help="Directory to search for configuration"
 
674
                      " files")
 
675
    (options, args) = parser.parse_args()
1414
676
    
1415
677
    if options.check:
1416
678
        import doctest
1418
680
        sys.exit()
1419
681
    
1420
682
    # Default values for config file for server-global settings
1421
 
    server_defaults = { u"interface": u"",
1422
 
                        u"address": u"",
1423
 
                        u"port": u"",
1424
 
                        u"debug": u"False",
1425
 
                        u"priority":
1426
 
                        u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1427
 
                        u"servicename": u"Mandos",
1428
 
                        u"use_dbus": u"True",
1429
 
                        u"use_ipv6": u"True",
 
683
    server_defaults = { "interface": "",
 
684
                        "address": "",
 
685
                        "port": "",
 
686
                        "debug": "False",
 
687
                        "priority":
 
688
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
689
                        "servicename": "Mandos",
1430
690
                        }
1431
691
    
1432
692
    # Parse config file for server-global settings
1433
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
693
    server_config = ConfigParser.SafeConfigParser(server_defaults)
1434
694
    del server_defaults
1435
 
    server_config.read(os.path.join(options.configdir,
1436
 
                                    u"mandos.conf"))
 
695
    server_config.read(os.path.join(options.configdir, "server.conf"))
 
696
    server_section = "server"
1437
697
    # Convert the SafeConfigParser object to a dict
1438
 
    server_settings = server_config.defaults()
1439
 
    # Use the appropriate methods on the non-string config options
1440
 
    for option in (u"debug", u"use_dbus", u"use_ipv6"):
1441
 
        server_settings[option] = server_config.getboolean(u"DEFAULT",
1442
 
                                                           option)
1443
 
    if server_settings["port"]:
1444
 
        server_settings["port"] = server_config.getint(u"DEFAULT",
1445
 
                                                       u"port")
 
698
    server_settings = dict(server_config.items(server_section))
 
699
    # Use getboolean on the boolean config option
 
700
    server_settings["debug"] = server_config.getboolean\
 
701
                               (server_section, "debug")
1446
702
    del server_config
1447
703
    
1448
704
    # Override the settings from the config file with command line
1449
705
    # options, if set.
1450
 
    for option in (u"interface", u"address", u"port", u"debug",
1451
 
                   u"priority", u"servicename", u"configdir",
1452
 
                   u"use_dbus", u"use_ipv6"):
 
706
    for option in ("interface", "address", "port", "debug",
 
707
                   "priority", "servicename", "configdir"):
1453
708
        value = getattr(options, option)
1454
709
        if value is not None:
1455
710
            server_settings[option] = value
1456
711
    del options
1457
 
    # Force all strings to be unicode
1458
 
    for option in server_settings.keys():
1459
 
        if type(server_settings[option]) is str:
1460
 
            server_settings[option] = unicode(server_settings[option])
1461
712
    # Now we have our good server settings in "server_settings"
1462
713
    
1463
 
    ##################################################################
1464
 
    
1465
 
    # For convenience
1466
 
    debug = server_settings[u"debug"]
1467
 
    use_dbus = server_settings[u"use_dbus"]
1468
 
    use_ipv6 = server_settings[u"use_ipv6"]
1469
 
    
1470
 
    if not debug:
1471
 
        syslogger.setLevel(logging.WARNING)
1472
 
        console.setLevel(logging.WARNING)
1473
 
    
1474
 
    if server_settings[u"servicename"] != u"Mandos":
1475
 
        syslogger.setFormatter(logging.Formatter
1476
 
                               (u'Mandos (%s) [%%(process)d]:'
1477
 
                                u' %%(levelname)s: %%(message)s'
1478
 
                                % server_settings[u"servicename"]))
1479
 
    
1480
714
    # Parse config file with clients
1481
 
    client_defaults = { u"timeout": u"1h",
1482
 
                        u"interval": u"5m",
1483
 
                        u"checker": u"fping -q -- %%(host)s",
1484
 
                        u"host": u"",
 
715
    client_defaults = { "timeout": "1h",
 
716
                        "interval": "5m",
 
717
                        "checker": "fping -q -- %%(fqdn)s",
1485
718
                        }
1486
 
    client_config = configparser.SafeConfigParser(client_defaults)
1487
 
    client_config.read(os.path.join(server_settings[u"configdir"],
1488
 
                                    u"clients.conf"))
1489
 
    
1490
 
    global mandos_dbus_service
1491
 
    mandos_dbus_service = None
1492
 
    
1493
 
    tcp_server = MandosServer((server_settings[u"address"],
1494
 
                               server_settings[u"port"]),
1495
 
                              ClientHandler,
1496
 
                              interface=server_settings[u"interface"],
1497
 
                              use_ipv6=use_ipv6,
1498
 
                              gnutls_priority=
1499
 
                              server_settings[u"priority"],
1500
 
                              use_dbus=use_dbus)
1501
 
    pidfilename = u"/var/run/mandos.pid"
1502
 
    try:
1503
 
        pidfile = open(pidfilename, u"w")
1504
 
    except IOError:
1505
 
        logger.error(u"Could not open file %r", pidfilename)
1506
 
    
1507
 
    try:
1508
 
        uid = pwd.getpwnam(u"_mandos").pw_uid
1509
 
        gid = pwd.getpwnam(u"_mandos").pw_gid
1510
 
    except KeyError:
1511
 
        try:
1512
 
            uid = pwd.getpwnam(u"mandos").pw_uid
1513
 
            gid = pwd.getpwnam(u"mandos").pw_gid
1514
 
        except KeyError:
1515
 
            try:
1516
 
                uid = pwd.getpwnam(u"nobody").pw_uid
1517
 
                gid = pwd.getpwnam(u"nobody").pw_gid
1518
 
            except KeyError:
1519
 
                uid = 65534
1520
 
                gid = 65534
1521
 
    try:
1522
 
        os.setgid(gid)
1523
 
        os.setuid(uid)
1524
 
    except OSError, error:
1525
 
        if error[0] != errno.EPERM:
1526
 
            raise error
1527
 
    
1528
 
    # Enable all possible GnuTLS debugging
1529
 
    if debug:
1530
 
        # "Use a log level over 10 to enable all debugging options."
1531
 
        # - GnuTLS manual
1532
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
1533
 
        
1534
 
        @gnutls.library.types.gnutls_log_func
1535
 
        def debug_gnutls(level, string):
1536
 
            logger.debug(u"GnuTLS: %s", string[:-1])
1537
 
        
1538
 
        (gnutls.library.functions
1539
 
         .gnutls_global_set_log_function(debug_gnutls))
 
719
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
720
    client_config.read(os.path.join(server_settings["configdir"],
 
721
                                    "clients.conf"))
 
722
    
 
723
    global service
 
724
    service = AvahiService(name = server_settings["servicename"],
 
725
                           type = "_mandos._tcp", );
 
726
    if server_settings["interface"]:
 
727
        service.interface = if_nametoindex(server_settings["interface"])
1540
728
    
1541
729
    global main_loop
 
730
    global bus
 
731
    global server
1542
732
    # From the Avahi example code
1543
733
    DBusGMainLoop(set_as_default=True )
1544
734
    main_loop = gobject.MainLoop()
1545
735
    bus = dbus.SystemBus()
 
736
    server = dbus.Interface(
 
737
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
738
            avahi.DBUS_INTERFACE_SERVER )
1546
739
    # End of Avahi example code
1547
 
    if use_dbus:
1548
 
        bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1549
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1550
 
    service = AvahiService(name = server_settings[u"servicename"],
1551
 
                           servicetype = u"_mandos._tcp",
1552
 
                           protocol = protocol, bus = bus)
1553
 
    if server_settings["interface"]:
1554
 
        service.interface = (if_nametoindex
1555
 
                             (str(server_settings[u"interface"])))
1556
740
    
1557
 
    client_class = Client
1558
 
    if use_dbus:
1559
 
        client_class = functools.partial(ClientDBus, bus = bus)
1560
 
    tcp_server.clients.update(set(
1561
 
            client_class(name = section,
1562
 
                         config= dict(client_config.items(section)))
1563
 
            for section in client_config.sections()))
1564
 
    if not tcp_server.clients:
1565
 
        logger.warning(u"No clients defined")
 
741
    debug = server_settings["debug"]
1566
742
    
1567
743
    if debug:
1568
 
        # Redirect stdin so all checkers get /dev/null
1569
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1570
 
        os.dup2(null, sys.stdin.fileno())
1571
 
        if null > 2:
1572
 
            os.close(null)
1573
 
    else:
1574
 
        # No console logging
1575
 
        logger.removeHandler(console)
1576
 
        # Close all input and output, do double fork, etc.
1577
 
        daemon()
1578
 
    
1579
 
    try:
1580
 
        with closing(pidfile):
1581
 
            pid = os.getpid()
1582
 
            pidfile.write(str(pid) + "\n")
1583
 
        del pidfile
1584
 
    except IOError:
1585
 
        logger.error(u"Could not write to file %r with PID %d",
1586
 
                     pidfilename, pid)
1587
 
    except NameError:
1588
 
        # "pidfile" was never created
1589
 
        pass
1590
 
    del pidfilename
 
744
        console = logging.StreamHandler()
 
745
        # console.setLevel(logging.DEBUG)
 
746
        console.setFormatter(logging.Formatter\
 
747
                             ('%(levelname)s: %(message)s'))
 
748
        logger.addHandler(console)
 
749
        del console
 
750
    
 
751
    clients = Set()
 
752
    def remove_from_clients(client):
 
753
        clients.remove(client)
 
754
        if not clients:
 
755
            logger.critical(u"No clients left, exiting")
 
756
            sys.exit()
 
757
    
 
758
    clients.update(Set(Client(name = section,
 
759
                              stop_hook = remove_from_clients,
 
760
                              config
 
761
                              = dict(client_config.items(section)))
 
762
                       for section in client_config.sections()))
 
763
    
 
764
    if not debug:
 
765
        daemon(False, False)
1591
766
    
1592
767
    def cleanup():
1593
768
        "Cleanup function; run on exit"
1594
 
        service.cleanup()
 
769
        global group
 
770
        # From the Avahi example code
 
771
        if not group is None:
 
772
            group.Free()
 
773
            group = None
 
774
        # End of Avahi example code
1595
775
        
1596
 
        while tcp_server.clients:
1597
 
            client = tcp_server.clients.pop()
1598
 
            client.disable_hook = None
1599
 
            client.disable()
 
776
        while clients:
 
777
            client = clients.pop()
 
778
            client.stop_hook = None
 
779
            client.stop()
1600
780
    
1601
781
    atexit.register(cleanup)
1602
782
    
1605
785
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1606
786
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1607
787
    
1608
 
    if use_dbus:
1609
 
        class MandosDBusService(dbus.service.Object):
1610
 
            """A D-Bus proxy object"""
1611
 
            def __init__(self):
1612
 
                dbus.service.Object.__init__(self, bus, u"/")
1613
 
            _interface = u"se.bsnet.fukt.Mandos"
1614
 
            
1615
 
            @dbus.service.signal(_interface, signature=u"oa{sv}")
1616
 
            def ClientAdded(self, objpath, properties):
1617
 
                "D-Bus signal"
1618
 
                pass
1619
 
            
1620
 
            @dbus.service.signal(_interface, signature=u"s")
1621
 
            def ClientNotFound(self, fingerprint):
1622
 
                "D-Bus signal"
1623
 
                pass
1624
 
            
1625
 
            @dbus.service.signal(_interface, signature=u"os")
1626
 
            def ClientRemoved(self, objpath, name):
1627
 
                "D-Bus signal"
1628
 
                pass
1629
 
            
1630
 
            @dbus.service.method(_interface, out_signature=u"ao")
1631
 
            def GetAllClients(self):
1632
 
                "D-Bus method"
1633
 
                return dbus.Array(c.dbus_object_path
1634
 
                                  for c in tcp_server.clients)
1635
 
            
1636
 
            @dbus.service.method(_interface,
1637
 
                                 out_signature=u"a{oa{sv}}")
1638
 
            def GetAllClientsWithProperties(self):
1639
 
                "D-Bus method"
1640
 
                return dbus.Dictionary(
1641
 
                    ((c.dbus_object_path, c.GetAll(u""))
1642
 
                     for c in tcp_server.clients),
1643
 
                    signature=u"oa{sv}")
1644
 
            
1645
 
            @dbus.service.method(_interface, in_signature=u"o")
1646
 
            def RemoveClient(self, object_path):
1647
 
                "D-Bus method"
1648
 
                for c in tcp_server.clients:
1649
 
                    if c.dbus_object_path == object_path:
1650
 
                        tcp_server.clients.remove(c)
1651
 
                        c.remove_from_connection()
1652
 
                        # Don't signal anything except ClientRemoved
1653
 
                        c.disable(signal=False)
1654
 
                        # Emit D-Bus signal
1655
 
                        self.ClientRemoved(object_path, c.name)
1656
 
                        return
1657
 
                raise KeyError
1658
 
            
1659
 
            del _interface
1660
 
        
1661
 
        mandos_dbus_service = MandosDBusService()
1662
 
    
1663
 
    for client in tcp_server.clients:
1664
 
        if use_dbus:
1665
 
            # Emit D-Bus signal
1666
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path,
1667
 
                                            client.GetAll(u""))
1668
 
        client.enable()
1669
 
    
1670
 
    tcp_server.enable()
1671
 
    tcp_server.server_activate()
1672
 
    
 
788
    for client in clients:
 
789
        client.start()
 
790
    
 
791
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
792
                                 server_settings["port"]),
 
793
                                tcp_handler,
 
794
                                settings=server_settings,
 
795
                                clients=clients)
1673
796
    # Find out what port we got
1674
797
    service.port = tcp_server.socket.getsockname()[1]
1675
 
    if use_ipv6:
1676
 
        logger.info(u"Now listening on address %r, port %d,"
1677
 
                    " flowinfo %d, scope_id %d"
1678
 
                    % tcp_server.socket.getsockname())
1679
 
    else:                       # IPv4
1680
 
        logger.info(u"Now listening on address %r, port %d"
1681
 
                    % tcp_server.socket.getsockname())
 
798
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
 
799
                u" scope_id %d" % tcp_server.socket.getsockname())
1682
800
    
1683
801
    #service.interface = tcp_server.socket.getsockname()[3]
1684
802
    
1685
803
    try:
1686
804
        # From the Avahi example code
 
805
        server.connect_to_signal("StateChanged", server_state_changed)
1687
806
        try:
1688
 
            service.activate()
 
807
            server_state_changed(server.GetState())
1689
808
        except dbus.exceptions.DBusException, error:
1690
809
            logger.critical(u"DBusException: %s", error)
1691
810
            sys.exit(1)
1693
812
        
1694
813
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1695
814
                             lambda *args, **kwargs:
1696
 
                             (tcp_server.handle_request
1697
 
                              (*args[2:], **kwargs) or True))
 
815
                             tcp_server.handle_request\
 
816
                             (*args[2:], **kwargs) or True)
1698
817
        
1699
 
        logger.debug(u"Starting main loop")
 
818
        logger.debug("Starting main loop")
 
819
        main_loop_started = True
1700
820
        main_loop.run()
1701
821
    except AvahiError, error:
1702
 
        logger.critical(u"AvahiError: %s", error)
 
822
        logger.critical(u"AvahiError: %s" + unicode(error))
1703
823
        sys.exit(1)
1704
824
    except KeyboardInterrupt:
1705
825
        if debug:
1706
 
            print >> sys.stderr
1707
 
        logger.debug(u"Server received KeyboardInterrupt")
1708
 
    logger.debug(u"Server exiting")
 
826
            print
1709
827
 
1710
828
if __name__ == '__main__':
1711
829
    main()