/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

todo

Show diffs side-by-side

added added

removed removed

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