/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2008-10-04 01:55:56 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081004015556-hp0374bc62khen0z
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
* mandos.xml (FILES): - '' -
  (CLIENTS, SERVER): Changed id attribute to lower case.  All
                     referrers changed.
* plugins.d/mandos-client.xml (FILES): Fixed id to be "files", not
                                       "file".

* plugins.d/password-prompt.xml (DESCRIPTION): Improved wording.

Show diffs side-by-side

added added

removed removed

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