/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

* mandos (Client.start_checker): Bug fix: Fix race condition with
                                 short intervals.

Show diffs side-by-side

added added

removed removed

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