/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

Added configuration files support for mandos-client
Removed plus argument support for mandos-client

Show diffs side-by-side

added added

removed removed

Lines of Context:
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
 
# methods "add", "remove", "server_state_changed",
10
 
# "entry_group_state_changed", "cleanup", and "activate" in the
11
 
# "AvahiService" class, and some lines in "main".
 
9
# methods "add" and "remove" in the "AvahiService" class, the
 
10
# "server_state_changed" and "entry_group_state_changed" functions,
 
11
# and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008,2009 Teddy Hogeborn
15
 
# Copyright © 2008,2009 Björn Påhlsson
 
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
16
15
17
16
# This program is free software: you can redistribute it and/or modify
18
17
# it under the terms of the GNU General Public License as published by
25
24
#     GNU General Public License for more details.
26
25
27
26
# You should have received a copy of the GNU General Public License
28
 
# along with this program.  If not, see
29
 
# <http://www.gnu.org/licenses/>.
 
27
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
30
28
31
29
# Contact the authors at <mandos@fukt.bsnet.se>.
32
30
33
31
 
34
 
from __future__ import division, with_statement, absolute_import
 
32
from __future__ import division
35
33
 
36
 
import SocketServer as socketserver
 
34
import SocketServer
37
35
import socket
38
 
import optparse
 
36
import select
 
37
from optparse import OptionParser
39
38
import datetime
40
39
import errno
41
40
import gnutls.crypto
44
43
import gnutls.library.functions
45
44
import gnutls.library.constants
46
45
import gnutls.library.types
47
 
import ConfigParser as configparser
 
46
import ConfigParser
48
47
import sys
49
48
import re
50
49
import os
51
50
import signal
 
51
from sets import Set
52
52
import subprocess
53
53
import atexit
54
54
import stat
55
55
import logging
56
56
import logging.handlers
57
 
import pwd
58
 
from contextlib import closing
59
 
import struct
60
 
import fcntl
61
 
import functools
62
57
 
63
58
import dbus
64
 
import dbus.service
65
59
import gobject
66
60
import avahi
67
61
from dbus.mainloop.glib import DBusGMainLoop
68
62
import ctypes
69
 
import ctypes.util
70
 
import xml.dom.minidom
71
 
import inspect
72
 
 
73
 
try:
74
 
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
75
 
except AttributeError:
76
 
    try:
77
 
        from IN import SO_BINDTODEVICE
78
 
    except ImportError:
79
 
        SO_BINDTODEVICE = None
80
 
 
81
 
 
82
 
version = "1.0.12"
83
 
 
84
 
logger = logging.Logger(u'mandos')
85
 
syslogger = (logging.handlers.SysLogHandler
86
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
87
 
              address = "/dev/log"))
88
 
syslogger.setFormatter(logging.Formatter
89
 
                       (u'Mandos [%(process)d]: %(levelname)s:'
90
 
                        u' %(message)s'))
 
63
 
 
64
version = "1.0"
 
65
 
 
66
logger = logging.Logger('mandos')
 
67
syslogger = logging.handlers.SysLogHandler\
 
68
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
69
             address = "/dev/log")
 
70
syslogger.setFormatter(logging.Formatter\
 
71
                        ('Mandos: %(levelname)s: %(message)s'))
91
72
logger.addHandler(syslogger)
92
73
 
93
74
console = logging.StreamHandler()
94
 
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
95
 
                                       u' %(levelname)s:'
96
 
                                       u' %(message)s'))
 
75
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
 
76
                                       ' %(message)s'))
97
77
logger.addHandler(console)
98
78
 
99
79
class AvahiError(Exception):
100
 
    def __init__(self, value, *args, **kwargs):
 
80
    def __init__(self, value):
101
81
        self.value = value
102
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
103
 
    def __unicode__(self):
104
 
        return unicode(repr(self.value))
 
82
    def __str__(self):
 
83
        return repr(self.value)
105
84
 
106
85
class AvahiServiceError(AvahiError):
107
86
    pass
112
91
 
113
92
class AvahiService(object):
114
93
    """An Avahi (Zeroconf) service.
115
 
    
116
94
    Attributes:
117
95
    interface: integer; avahi.IF_UNSPEC or an interface index.
118
96
               Used to optionally bind to the specified interface.
119
 
    name: string; Example: u'Mandos'
120
 
    type: string; Example: u'_mandos._tcp'.
 
97
    name: string; Example: 'Mandos'
 
98
    type: string; Example: '_mandos._tcp'.
121
99
                  See <http://www.dns-sd.org/ServiceTypes.html>
122
100
    port: integer; what port to announce
123
101
    TXT: list of strings; TXT record for the service
126
104
    max_renames: integer; maximum number of renames
127
105
    rename_count: integer; counter so we only rename after collisions
128
106
                  a sensible number of times
129
 
    group: D-Bus Entry Group
130
 
    server: D-Bus Server
131
 
    bus: dbus.SystemBus()
132
107
    """
133
108
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
134
 
                 servicetype = None, port = None, TXT = None,
135
 
                 domain = u"", host = u"", max_renames = 32768,
136
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
109
                 type = None, port = None, TXT = None, domain = "",
 
110
                 host = "", max_renames = 32768):
137
111
        self.interface = interface
138
112
        self.name = name
139
 
        self.type = servicetype
 
113
        self.type = type
140
114
        self.port = port
141
 
        self.TXT = TXT if TXT is not None else []
 
115
        if TXT is None:
 
116
            self.TXT = []
 
117
        else:
 
118
            self.TXT = TXT
142
119
        self.domain = domain
143
120
        self.host = host
144
121
        self.rename_count = 0
145
 
        self.max_renames = max_renames
146
 
        self.protocol = protocol
147
 
        self.group = None       # our entry group
148
 
        self.server = None
149
 
        self.bus = bus
150
122
    def rename(self):
151
123
        """Derived from the Avahi example code"""
152
124
        if self.rename_count >= self.max_renames:
153
 
            logger.critical(u"No suitable Zeroconf service name found"
154
 
                            u" after %i retries, exiting.",
155
 
                            self.rename_count)
156
 
            raise AvahiServiceError(u"Too many renames")
157
 
        self.name = self.server.GetAlternativeServiceName(self.name)
158
 
        logger.info(u"Changing Zeroconf service name to %r ...",
159
 
                    unicode(self.name))
160
 
        syslogger.setFormatter(logging.Formatter
161
 
                               (u'Mandos (%s) [%%(process)d]:'
162
 
                                u' %%(levelname)s: %%(message)s'
163
 
                                % self.name))
 
125
            logger.critical(u"No suitable service name found after %i"
 
126
                            u" retries, exiting.", rename_count)
 
127
            raise AvahiServiceError("Too many renames")
 
128
        name = server.GetAlternativeServiceName(name)
 
129
        logger.error(u"Changing name to %r ...", name)
 
130
        syslogger.setFormatter(logging.Formatter\
 
131
                               ('Mandos (%s): %%(levelname)s:'
 
132
                               ' %%(message)s' % name))
164
133
        self.remove()
165
134
        self.add()
166
135
        self.rename_count += 1
167
136
    def remove(self):
168
137
        """Derived from the Avahi example code"""
169
 
        if self.group is not None:
170
 
            self.group.Reset()
 
138
        if group is not None:
 
139
            group.Reset()
171
140
    def add(self):
172
141
        """Derived from the Avahi example code"""
173
 
        if self.group is None:
174
 
            self.group = dbus.Interface(
175
 
                self.bus.get_object(avahi.DBUS_NAME,
176
 
                                    self.server.EntryGroupNew()),
177
 
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
178
 
            self.group.connect_to_signal('StateChanged',
179
 
                                         self
180
 
                                         .entry_group_state_changed)
181
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
182
 
                     self.name, self.type)
183
 
        self.group.AddService(
184
 
            self.interface,
185
 
            self.protocol,
186
 
            dbus.UInt32(0),     # flags
187
 
            self.name, self.type,
188
 
            self.domain, self.host,
189
 
            dbus.UInt16(self.port),
190
 
            avahi.string_array_to_txt_array(self.TXT))
191
 
        self.group.Commit()
192
 
    def entry_group_state_changed(self, state, error):
193
 
        """Derived from the Avahi example code"""
194
 
        logger.debug(u"Avahi state change: %i", state)
195
 
        
196
 
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
197
 
            logger.debug(u"Zeroconf service established.")
198
 
        elif state == avahi.ENTRY_GROUP_COLLISION:
199
 
            logger.warning(u"Zeroconf service name collision.")
200
 
            self.rename()
201
 
        elif state == avahi.ENTRY_GROUP_FAILURE:
202
 
            logger.critical(u"Avahi: Error in group state changed %s",
203
 
                            unicode(error))
204
 
            raise AvahiGroupError(u"State changed: %s"
205
 
                                  % unicode(error))
206
 
    def cleanup(self):
207
 
        """Derived from the Avahi example code"""
208
 
        if self.group is not None:
209
 
            self.group.Free()
210
 
            self.group = None
211
 
    def server_state_changed(self, state):
212
 
        """Derived from the Avahi example code"""
213
 
        if state == avahi.SERVER_COLLISION:
214
 
            logger.error(u"Zeroconf server name collision")
215
 
            self.remove()
216
 
        elif state == avahi.SERVER_RUNNING:
217
 
            self.add()
218
 
    def activate(self):
219
 
        """Derived from the Avahi example code"""
220
 
        if self.server is None:
221
 
            self.server = dbus.Interface(
222
 
                self.bus.get_object(avahi.DBUS_NAME,
223
 
                                    avahi.DBUS_PATH_SERVER),
224
 
                avahi.DBUS_INTERFACE_SERVER)
225
 
        self.server.connect_to_signal(u"StateChanged",
226
 
                                 self.server_state_changed)
227
 
        self.server_state_changed(self.server.GetState())
 
142
        global group
 
143
        if group is None:
 
144
            group = dbus.Interface\
 
145
                    (bus.get_object(avahi.DBUS_NAME,
 
146
                                    server.EntryGroupNew()),
 
147
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
148
            group.connect_to_signal('StateChanged',
 
149
                                    entry_group_state_changed)
 
150
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
151
                     service.name, service.type)
 
152
        group.AddService(
 
153
                self.interface,         # interface
 
154
                avahi.PROTO_INET6,      # protocol
 
155
                dbus.UInt32(0),         # flags
 
156
                self.name, self.type,
 
157
                self.domain, self.host,
 
158
                dbus.UInt16(self.port),
 
159
                avahi.string_array_to_txt_array(self.TXT))
 
160
        group.Commit()
 
161
 
 
162
# From the Avahi example code:
 
163
group = None                            # our entry group
 
164
# End of Avahi example code
228
165
 
229
166
 
230
167
class Client(object):
231
168
    """A representation of a client host served by this server.
232
 
    
233
169
    Attributes:
234
 
    name:       string; from the config file, used in log messages and
235
 
                        D-Bus identifiers
 
170
    name:      string; from the config file, used in log messages
236
171
    fingerprint: string (40 or 32 hexadecimal digits); used to
237
172
                 uniquely identify the client
238
 
    secret:     bytestring; sent verbatim (over TLS) to client
239
 
    host:       string; available for use by the checker command
240
 
    created:    datetime.datetime(); (UTC) object creation
241
 
    last_enabled: datetime.datetime(); (UTC)
242
 
    enabled:    bool()
243
 
    last_checked_ok: datetime.datetime(); (UTC) or None
244
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
245
 
                                      until this client is invalid
246
 
    interval:   datetime.timedelta(); How often to start a new checker
247
 
    disable_hook:  If set, called by disable() as disable_hook(self)
248
 
    checker:    subprocess.Popen(); a running checker process used
249
 
                                    to see if the client lives.
250
 
                                    'None' if no process is running.
 
173
    secret:    bytestring; sent verbatim (over TLS) to client
 
174
    host:      string; available for use by the checker command
 
175
    created:   datetime.datetime(); object creation, not client host
 
176
    last_checked_ok: datetime.datetime() or None if not yet checked OK
 
177
    timeout:   datetime.timedelta(); How long from last_checked_ok
 
178
                                     until this client is invalid
 
179
    interval:  datetime.timedelta(); How often to start a new checker
 
180
    stop_hook: If set, called by stop() as stop_hook(self)
 
181
    checker:   subprocess.Popen(); a running checker process used
 
182
                                   to see if the client lives.
 
183
                                   'None' if no process is running.
251
184
    checker_initiator_tag: a gobject event source tag, or None
252
 
    disable_initiator_tag: - '' -
 
185
    stop_initiator_tag:    - '' -
253
186
    checker_callback_tag:  - '' -
254
187
    checker_command: string; External command which is run to check if
255
188
                     client lives.  %() expansions are done at
256
189
                     runtime with vars(self) as dict, so that for
257
190
                     instance %(name)s can be used in the command.
258
 
    current_checker_command: string; current running checker_command
 
191
    Private attibutes:
 
192
    _timeout: Real variable for 'timeout'
 
193
    _interval: Real variable for 'interval'
 
194
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
195
    _interval_milliseconds: - '' -
259
196
    """
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):
 
197
    def _set_timeout(self, timeout):
 
198
        "Setter function for 'timeout' attribute"
 
199
        self._timeout = timeout
 
200
        self._timeout_milliseconds = ((self.timeout.days
 
201
                                       * 24 * 60 * 60 * 1000)
 
202
                                      + (self.timeout.seconds * 1000)
 
203
                                      + (self.timeout.microseconds
 
204
                                         // 1000))
 
205
    timeout = property(lambda self: self._timeout,
 
206
                       _set_timeout)
 
207
    del _set_timeout
 
208
    def _set_interval(self, interval):
 
209
        "Setter function for 'interval' attribute"
 
210
        self._interval = interval
 
211
        self._interval_milliseconds = ((self.interval.days
 
212
                                        * 24 * 60 * 60 * 1000)
 
213
                                       + (self.interval.seconds
 
214
                                          * 1000)
 
215
                                       + (self.interval.microseconds
 
216
                                          // 1000))
 
217
    interval = property(lambda self: self._interval,
 
218
                        _set_interval)
 
219
    del _set_interval
 
220
    def __init__(self, name = None, stop_hook=None, config={}):
277
221
        """Note: the 'checker' key in 'config' sets the
278
222
        'checker_command' attribute and *not* the 'checker'
279
223
        attribute."""
280
224
        self.name = name
281
 
        if config is None:
282
 
            config = {}
283
225
        logger.debug(u"Creating client %r", self.name)
284
226
        # Uppercase and remove spaces from fingerprint for later
285
227
        # comparison purposes with return value from the fingerprint()
286
228
        # function
287
 
        self.fingerprint = (config[u"fingerprint"].upper()
288
 
                            .replace(u" ", u""))
 
229
        self.fingerprint = config["fingerprint"].upper()\
 
230
                           .replace(u" ", u"")
289
231
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
290
 
        if u"secret" in config:
291
 
            self.secret = config[u"secret"].decode(u"base64")
292
 
        elif u"secfile" in config:
293
 
            with closing(open(os.path.expanduser
294
 
                              (os.path.expandvars
295
 
                               (config[u"secfile"])))) as secfile:
296
 
                self.secret = secfile.read()
 
232
        if "secret" in config:
 
233
            self.secret = config["secret"].decode(u"base64")
 
234
        elif "secfile" in config:
 
235
            sf = open(config["secfile"])
 
236
            self.secret = sf.read()
 
237
            sf.close()
297
238
        else:
298
239
            raise TypeError(u"No secret or secfile for client %s"
299
240
                            % self.name)
300
 
        self.host = config.get(u"host", u"")
301
 
        self.created = datetime.datetime.utcnow()
302
 
        self.enabled = False
303
 
        self.last_enabled = None
 
241
        self.host = config.get("host", "")
 
242
        self.created = datetime.datetime.now()
304
243
        self.last_checked_ok = None
305
 
        self.timeout = string_to_delta(config[u"timeout"])
306
 
        self.interval = string_to_delta(config[u"interval"])
307
 
        self.disable_hook = disable_hook
 
244
        self.timeout = string_to_delta(config["timeout"])
 
245
        self.interval = string_to_delta(config["interval"])
 
246
        self.stop_hook = stop_hook
308
247
        self.checker = None
309
248
        self.checker_initiator_tag = None
310
 
        self.disable_initiator_tag = None
 
249
        self.stop_initiator_tag = None
311
250
        self.checker_callback_tag = None
312
 
        self.checker_command = config[u"checker"]
313
 
        self.current_checker_command = None
314
 
        self.last_connect = None
315
 
    
316
 
    def enable(self):
 
251
        self.check_command = config["checker"]
 
252
    def start(self):
317
253
        """Start this client's checker and timeout hooks"""
318
 
        if getattr(self, u"enabled", False):
319
 
            # Already enabled
320
 
            return
321
 
        self.last_enabled = datetime.datetime.utcnow()
322
254
        # Schedule a new checker to be started an 'interval' from now,
323
255
        # and every interval from then on.
324
 
        self.checker_initiator_tag = (gobject.timeout_add
325
 
                                      (self.interval_milliseconds(),
326
 
                                       self.start_checker))
 
256
        self.checker_initiator_tag = gobject.timeout_add\
 
257
                                     (self._interval_milliseconds,
 
258
                                      self.start_checker)
327
259
        # Also start a new checker *right now*.
328
260
        self.start_checker()
329
 
        # Schedule a disable() when 'timeout' has passed
330
 
        self.disable_initiator_tag = (gobject.timeout_add
331
 
                                   (self.timeout_milliseconds(),
332
 
                                    self.disable))
333
 
        self.enabled = True
334
 
    
335
 
    def disable(self):
336
 
        """Disable this client."""
337
 
        if not getattr(self, "enabled", False):
 
261
        # Schedule a stop() when 'timeout' has passed
 
262
        self.stop_initiator_tag = gobject.timeout_add\
 
263
                                  (self._timeout_milliseconds,
 
264
                                   self.stop)
 
265
    def stop(self):
 
266
        """Stop this client.
 
267
        The possibility that a client might be restarted is left open,
 
268
        but not currently used."""
 
269
        # If this client doesn't have a secret, it is already stopped.
 
270
        if hasattr(self, "secret") and self.secret:
 
271
            logger.info(u"Stopping client %s", self.name)
 
272
            self.secret = None
 
273
        else:
338
274
            return False
339
 
        logger.info(u"Disabling client %s", self.name)
340
 
        if getattr(self, u"disable_initiator_tag", False):
341
 
            gobject.source_remove(self.disable_initiator_tag)
342
 
            self.disable_initiator_tag = None
343
 
        if getattr(self, u"checker_initiator_tag", False):
 
275
        if getattr(self, "stop_initiator_tag", False):
 
276
            gobject.source_remove(self.stop_initiator_tag)
 
277
            self.stop_initiator_tag = None
 
278
        if getattr(self, "checker_initiator_tag", False):
344
279
            gobject.source_remove(self.checker_initiator_tag)
345
280
            self.checker_initiator_tag = None
346
281
        self.stop_checker()
347
 
        if self.disable_hook:
348
 
            self.disable_hook(self)
349
 
        self.enabled = False
 
282
        if self.stop_hook:
 
283
            self.stop_hook(self)
350
284
        # Do not run this again if called by a gobject.timeout_add
351
285
        return False
352
 
    
353
286
    def __del__(self):
354
 
        self.disable_hook = None
355
 
        self.disable()
356
 
    
357
 
    def checker_callback(self, pid, condition, command):
 
287
        self.stop_hook = None
 
288
        self.stop()
 
289
    def checker_callback(self, pid, condition):
358
290
        """The checker has completed, so take appropriate actions."""
 
291
        now = datetime.datetime.now()
359
292
        self.checker_callback_tag = None
360
293
        self.checker = None
361
 
        if os.WIFEXITED(condition):
362
 
            exitstatus = os.WEXITSTATUS(condition)
363
 
            if exitstatus == 0:
364
 
                logger.info(u"Checker for %(name)s succeeded",
365
 
                            vars(self))
366
 
                self.checked_ok()
367
 
            else:
368
 
                logger.info(u"Checker for %(name)s failed",
369
 
                            vars(self))
370
 
        else:
 
294
        if os.WIFEXITED(condition) \
 
295
               and (os.WEXITSTATUS(condition) == 0):
 
296
            logger.info(u"Checker for %(name)s succeeded",
 
297
                        vars(self))
 
298
            self.last_checked_ok = now
 
299
            gobject.source_remove(self.stop_initiator_tag)
 
300
            self.stop_initiator_tag = gobject.timeout_add\
 
301
                                      (self._timeout_milliseconds,
 
302
                                       self.stop)
 
303
        elif not os.WIFEXITED(condition):
371
304
            logger.warning(u"Checker for %(name)s crashed?",
372
305
                           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
 
    
 
306
        else:
 
307
            logger.info(u"Checker for %(name)s failed",
 
308
                        vars(self))
386
309
    def start_checker(self):
387
310
        """Start a new checker subprocess if one is not running.
388
 
        
389
311
        If a checker already exists, leave it running and do
390
312
        nothing."""
391
313
        # The reason for not killing a running checker is that if we
396
318
        # checkers alone, the checker would have to take more time
397
319
        # than 'timeout' for the client to be declared invalid, which
398
320
        # 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
409
321
        if self.checker is None:
410
322
            try:
411
 
                # In case checker_command has exactly one % operator
412
 
                command = self.checker_command % self.host
 
323
                # In case check_command has exactly one % operator
 
324
                command = self.check_command % self.host
413
325
            except TypeError:
414
326
                # Escape attributes for the shell
415
 
                escaped_attrs = dict((key,
416
 
                                      re.escape(unicode(str(val),
417
 
                                                        errors=
418
 
                                                        u'replace')))
 
327
                escaped_attrs = dict((key, re.escape(str(val)))
419
328
                                     for key, val in
420
329
                                     vars(self).iteritems())
421
330
                try:
422
 
                    command = self.checker_command % escaped_attrs
 
331
                    command = self.check_command % escaped_attrs
423
332
                except TypeError, error:
424
333
                    logger.error(u'Could not format string "%s":'
425
 
                                 u' %s', self.checker_command, error)
 
334
                                 u' %s', self.check_command, error)
426
335
                    return True # Try again later
427
 
            self.current_checker_command = command
428
336
            try:
429
337
                logger.info(u"Starting checker %r for %s",
430
338
                            command, self.name)
431
 
                # We don't need to redirect stdout and stderr, since
432
 
                # in normal mode, that is already done by daemon(),
433
 
                # and in debug mode we don't want to.  (Stdin is
434
 
                # always replaced by /dev/null.)
435
339
                self.checker = subprocess.Popen(command,
436
340
                                                close_fds=True,
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)
448
 
            except OSError, error:
 
341
                                                shell=True, cwd="/")
 
342
                self.checker_callback_tag = gobject.child_watch_add\
 
343
                                            (self.checker.pid,
 
344
                                             self.checker_callback)
 
345
            except subprocess.OSError, error:
449
346
                logger.error(u"Failed to start subprocess: %s",
450
347
                             error)
451
348
        # Re-run this periodically if run by gobject.timeout_add
452
349
        return True
453
 
    
454
350
    def stop_checker(self):
455
351
        """Force the checker process, if any, to stop."""
456
352
        if self.checker_callback_tag:
457
353
            gobject.source_remove(self.checker_callback_tag)
458
354
            self.checker_callback_tag = None
459
 
        if getattr(self, u"checker", None) is None:
 
355
        if getattr(self, "checker", None) is None:
460
356
            return
461
357
        logger.debug(u"Stopping checker for %(name)s", vars(self))
462
358
        try:
468
364
            if error.errno != errno.ESRCH: # No such process
469
365
                raise
470
366
        self.checker = None
471
 
    
472
367
    def still_valid(self):
473
368
        """Has the timeout not yet passed for this client?"""
474
 
        if not getattr(self, u"enabled", False):
475
 
            return False
476
 
        now = datetime.datetime.utcnow()
 
369
        now = datetime.datetime.now()
477
370
        if self.last_checked_ok is None:
478
371
            return now < (self.created + self.timeout)
479
372
        else:
480
373
            return now < (self.last_checked_ok + self.timeout)
481
374
 
482
375
 
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.
 
376
def peer_certificate(session):
 
377
    "Return the peer's OpenPGP certificate as a bytestring"
 
378
    # If not an OpenPGP certificate...
 
379
    if gnutls.library.functions.gnutls_certificate_type_get\
 
380
            (session._c_object) \
 
381
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
 
382
        # ...do the normal thing
 
383
        return session.peer_certificate
 
384
    list_size = ctypes.c_uint()
 
385
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
386
        (session._c_object, ctypes.byref(list_size))
 
387
    if list_size.value == 0:
 
388
        return None
 
389
    cert = cert_list[0]
 
390
    return ctypes.string_at(cert.data, cert.size)
 
391
 
 
392
 
 
393
def fingerprint(openpgp):
 
394
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
395
    # New GnuTLS "datum" with the OpenPGP public key
 
396
    datum = gnutls.library.types.gnutls_datum_t\
 
397
        (ctypes.cast(ctypes.c_char_p(openpgp),
 
398
                     ctypes.POINTER(ctypes.c_ubyte)),
 
399
         ctypes.c_uint(len(openpgp)))
 
400
    # New empty GnuTLS certificate
 
401
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
402
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
403
        (ctypes.byref(crt))
 
404
    # Import the OpenPGP public key into the certificate
 
405
    gnutls.library.functions.gnutls_openpgp_crt_import\
 
406
                    (crt, ctypes.byref(datum),
 
407
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
408
    # New buffer for the fingerprint
 
409
    buffer = ctypes.create_string_buffer(20)
 
410
    buffer_length = ctypes.c_size_t()
 
411
    # Get the fingerprint from the certificate into the buffer
 
412
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
413
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
414
    # Deinit the certificate
 
415
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
416
    # Convert the buffer to a Python bytestring
 
417
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
418
    # Convert the bytestring to hexadecimal notation
 
419
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
420
    return hex_fpr
 
421
 
 
422
 
 
423
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
424
    """A TCP request handler class.
 
425
    Instantiated by IPv6_TCPServer for each request to handle it.
930
426
    Note: This will run in its own forked process."""
931
427
    
932
428
    def handle(self):
933
429
        logger.info(u"TCP connection from: %s",
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
 
    
 
430
                     unicode(self.client_address))
 
431
        session = gnutls.connection.ClientSession\
 
432
                  (self.request, gnutls.connection.X509Credentials())
 
433
        
 
434
        line = self.request.makefile().readline()
 
435
        logger.debug(u"Protocol version: %r", line)
 
436
        try:
 
437
            if int(line.strip().split()[0]) > 1:
 
438
                raise RuntimeError
 
439
        except (ValueError, IndexError, RuntimeError), error:
 
440
            logger.error(u"Unknown protocol version: %s", error)
 
441
            return
 
442
        
 
443
        # Note: gnutls.connection.X509Credentials is really a generic
 
444
        # GnuTLS certificate credentials object so long as no X.509
 
445
        # keys are added to it.  Therefore, we can use it here despite
 
446
        # using OpenPGP certificates.
 
447
        
 
448
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
 
449
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
450
        #                "+DHE-DSS"))
 
451
        priority = "NORMAL"             # Fallback default, since this
 
452
                                        # MUST be set.
 
453
        if self.server.settings["priority"]:
 
454
            priority = self.server.settings["priority"]
 
455
        gnutls.library.functions.gnutls_priority_set_direct\
 
456
            (session._c_object, priority, None);
 
457
        
 
458
        try:
 
459
            session.handshake()
 
460
        except gnutls.errors.GNUTLSError, error:
 
461
            logger.warning(u"Handshake failed: %s", error)
 
462
            # Do not run session.bye() here: the session is not
 
463
            # established.  Just abandon the request.
 
464
            return
 
465
        try:
 
466
            fpr = fingerprint(peer_certificate(session))
 
467
        except (TypeError, gnutls.errors.GNUTLSError), error:
 
468
            logger.warning(u"Bad certificate: %s", error)
 
469
            session.bye()
 
470
            return
 
471
        logger.debug(u"Fingerprint: %s", fpr)
 
472
        client = None
 
473
        for c in self.server.clients:
 
474
            if c.fingerprint == fpr:
 
475
                client = c
 
476
                break
 
477
        if not client:
 
478
            logger.warning(u"Client not found for fingerprint: %s",
 
479
                           fpr)
 
480
            session.bye()
 
481
            return
 
482
        # Have to check if client.still_valid(), since it is possible
 
483
        # that the client timed out while establishing the GnuTLS
 
484
        # session.
 
485
        if not client.still_valid():
 
486
            logger.warning(u"Client %(name)s is invalid",
 
487
                           vars(client))
 
488
            session.bye()
 
489
            return
 
490
        sent_size = 0
 
491
        while sent_size < len(client.secret):
 
492
            sent = session.send(client.secret[sent_size:])
 
493
            logger.debug(u"Sent: %d, remaining: %d",
 
494
                         sent, len(client.secret)
 
495
                         - (sent_size + sent))
 
496
            sent_size += sent
 
497
        session.bye()
 
498
 
 
499
 
 
500
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
501
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
1096
502
    Attributes:
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
 
503
        settings:       Server settings
 
504
        clients:        Set() of Client objects
1100
505
    """
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)
 
506
    address_family = socket.AF_INET6
 
507
    def __init__(self, *args, **kwargs):
 
508
        if "settings" in kwargs:
 
509
            self.settings = kwargs["settings"]
 
510
            del kwargs["settings"]
 
511
        if "clients" in kwargs:
 
512
            self.clients = kwargs["clients"]
 
513
            del kwargs["clients"]
 
514
        return super(type(self), self).__init__(*args, **kwargs)
1108
515
    def server_bind(self):
1109
516
        """This overrides the normal server_bind() function
1110
517
        to bind to an interface if one was specified, and also NOT to
1111
518
        bind to an address or port if they were not specified."""
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
 
519
        if self.settings["interface"]:
 
520
            # 25 is from /usr/include/asm-i486/socket.h
 
521
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
522
            try:
 
523
                self.socket.setsockopt(socket.SOL_SOCKET,
 
524
                                       SO_BINDTODEVICE,
 
525
                                       self.settings["interface"])
 
526
            except socket.error, error:
 
527
                if error[0] == errno.EPERM:
 
528
                    logger.error(u"No permission to"
 
529
                                 u" bind to interface %s",
 
530
                                 self.settings["interface"])
 
531
                else:
 
532
                    raise error
1134
533
        # Only bind(2) the socket if we really need to.
1135
534
        if self.server_address[0] or self.server_address[1]:
1136
535
            if not self.server_address[0]:
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,
 
536
                in6addr_any = "::"
 
537
                self.server_address = (in6addr_any,
1142
538
                                       self.server_address[1])
1143
539
            elif not self.server_address[1]:
1144
540
                self.server_address = (self.server_address[0],
1145
541
                                       0)
1146
 
#                 if self.interface:
 
542
#                 if self.settings["interface"]:
1147
543
#                     self.server_address = (self.server_address[0],
1148
544
#                                            0, # port
1149
545
#                                            0, # flowinfo
1150
546
#                                            if_nametoindex
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)
1178
 
    def server_activate(self):
1179
 
        if self.enabled:
1180
 
            return socketserver.TCPServer.server_activate(self)
1181
 
    def enable(self):
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
 
547
#                                            (self.settings
 
548
#                                             ["interface"]))
 
549
            return super(type(self), self).server_bind()
1257
550
 
1258
551
 
1259
552
def string_to_delta(interval):
1260
553
    """Parse a string and return a datetime.timedelta
1261
 
    
1262
 
    >>> string_to_delta(u'7d')
 
554
 
 
555
    >>> string_to_delta('7d')
1263
556
    datetime.timedelta(7)
1264
 
    >>> string_to_delta(u'60s')
 
557
    >>> string_to_delta('60s')
1265
558
    datetime.timedelta(0, 60)
1266
 
    >>> string_to_delta(u'60m')
 
559
    >>> string_to_delta('60m')
1267
560
    datetime.timedelta(0, 3600)
1268
 
    >>> string_to_delta(u'24h')
 
561
    >>> string_to_delta('24h')
1269
562
    datetime.timedelta(1)
1270
563
    >>> string_to_delta(u'1w')
1271
564
    datetime.timedelta(7)
1272
 
    >>> string_to_delta(u'5m 30s')
1273
 
    datetime.timedelta(0, 330)
1274
565
    """
1275
 
    timevalue = datetime.timedelta(0)
1276
 
    for s in interval.split():
1277
 
        try:
1278
 
            suffix = unicode(s[-1])
1279
 
            value = int(s[:-1])
1280
 
            if suffix == u"d":
1281
 
                delta = datetime.timedelta(value)
1282
 
            elif suffix == u"s":
1283
 
                delta = datetime.timedelta(0, value)
1284
 
            elif suffix == u"m":
1285
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
1286
 
            elif suffix == u"h":
1287
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1288
 
            elif suffix == u"w":
1289
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1290
 
            else:
1291
 
                raise ValueError
1292
 
        except (ValueError, IndexError):
 
566
    try:
 
567
        suffix=unicode(interval[-1])
 
568
        value=int(interval[:-1])
 
569
        if suffix == u"d":
 
570
            delta = datetime.timedelta(value)
 
571
        elif suffix == u"s":
 
572
            delta = datetime.timedelta(0, value)
 
573
        elif suffix == u"m":
 
574
            delta = datetime.timedelta(0, 0, 0, 0, value)
 
575
        elif suffix == u"h":
 
576
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
577
        elif suffix == u"w":
 
578
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
579
        else:
1293
580
            raise ValueError
1294
 
        timevalue += delta
1295
 
    return timevalue
1296
 
 
 
581
    except (ValueError, IndexError):
 
582
        raise ValueError
 
583
    return delta
 
584
 
 
585
 
 
586
def server_state_changed(state):
 
587
    """Derived from the Avahi example code"""
 
588
    if state == avahi.SERVER_COLLISION:
 
589
        logger.error(u"Server name collision")
 
590
        service.remove()
 
591
    elif state == avahi.SERVER_RUNNING:
 
592
        service.add()
 
593
 
 
594
 
 
595
def entry_group_state_changed(state, error):
 
596
    """Derived from the Avahi example code"""
 
597
    logger.debug(u"state change: %i", state)
 
598
    
 
599
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
600
        logger.debug(u"Service established.")
 
601
    elif state == avahi.ENTRY_GROUP_COLLISION:
 
602
        logger.warning(u"Service name collision.")
 
603
        service.rename()
 
604
    elif state == avahi.ENTRY_GROUP_FAILURE:
 
605
        logger.critical(u"Error in group state changed %s",
 
606
                        unicode(error))
 
607
        raise AvahiGroupError("State changed: %s", str(error))
1297
608
 
1298
609
def if_nametoindex(interface):
1299
 
    """Call the C function if_nametoindex(), or equivalent
1300
 
    
1301
 
    Note: This function cannot accept a unicode string."""
 
610
    """Call the C function if_nametoindex(), or equivalent"""
1302
611
    global if_nametoindex
1303
612
    try:
1304
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1305
 
                          (ctypes.util.find_library(u"c"))
1306
 
                          .if_nametoindex)
 
613
        if "ctypes.util" not in sys.modules:
 
614
            import ctypes.util
 
615
        if_nametoindex = ctypes.cdll.LoadLibrary\
 
616
            (ctypes.util.find_library("c")).if_nametoindex
1307
617
    except (OSError, AttributeError):
1308
 
        logger.warning(u"Doing if_nametoindex the hard way")
 
618
        if "struct" not in sys.modules:
 
619
            import struct
 
620
        if "fcntl" not in sys.modules:
 
621
            import fcntl
1309
622
        def if_nametoindex(interface):
1310
623
            "Get an interface index the hard way, i.e. using fcntl()"
1311
624
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
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]
 
625
            s = socket.socket()
 
626
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
627
                                struct.pack("16s16x", interface))
 
628
            s.close()
 
629
            interface_index = struct.unpack("I", ifreq[16:20])[0]
1318
630
            return interface_index
1319
631
    return if_nametoindex(interface)
1320
632
 
1321
633
 
1322
634
def daemon(nochdir = False, noclose = False):
1323
635
    """See daemon(3).  Standard BSD Unix function.
1324
 
    
1325
636
    This should really exist as os.daemon, but it doesn't (yet)."""
1326
637
    if os.fork():
1327
638
        sys.exit()
1328
639
    os.setsid()
1329
640
    if not nochdir:
1330
 
        os.chdir(u"/")
 
641
        os.chdir("/")
1331
642
    if os.fork():
1332
643
        sys.exit()
1333
644
    if not noclose:
1335
646
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1336
647
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1337
648
            raise OSError(errno.ENODEV,
1338
 
                          u"/dev/null not a character device")
 
649
                          "/dev/null not a character device")
1339
650
        os.dup2(null, sys.stdin.fileno())
1340
651
        os.dup2(null, sys.stdout.fileno())
1341
652
        os.dup2(null, sys.stderr.fileno())
1344
655
 
1345
656
 
1346
657
def main():
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")
1376
 
    options = parser.parse_args()[0]
 
658
    global main_loop_started
 
659
    main_loop_started = False
 
660
    
 
661
    parser = OptionParser(version = "%%prog %s" % version)
 
662
    parser.add_option("-i", "--interface", type="string",
 
663
                      metavar="IF", help="Bind to interface IF")
 
664
    parser.add_option("-a", "--address", type="string",
 
665
                      help="Address to listen for requests on")
 
666
    parser.add_option("-p", "--port", type="int",
 
667
                      help="Port number to receive requests on")
 
668
    parser.add_option("--check", action="store_true", default=False,
 
669
                      help="Run self-test")
 
670
    parser.add_option("--debug", action="store_true",
 
671
                      help="Debug mode; run in foreground and log to"
 
672
                      " terminal")
 
673
    parser.add_option("--priority", type="string", help="GnuTLS"
 
674
                      " priority string (see GnuTLS documentation)")
 
675
    parser.add_option("--servicename", type="string", metavar="NAME",
 
676
                      help="Zeroconf service name")
 
677
    parser.add_option("--configdir", type="string",
 
678
                      default="/etc/mandos", metavar="DIR",
 
679
                      help="Directory to search for configuration"
 
680
                      " files")
 
681
    (options, args) = parser.parse_args()
1377
682
    
1378
683
    if options.check:
1379
684
        import doctest
1381
686
        sys.exit()
1382
687
    
1383
688
    # Default values for config file for server-global settings
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",
 
689
    server_defaults = { "interface": "",
 
690
                        "address": "",
 
691
                        "port": "",
 
692
                        "debug": "False",
 
693
                        "priority":
 
694
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
695
                        "servicename": "Mandos",
1393
696
                        }
1394
697
    
1395
698
    # Parse config file for server-global settings
1396
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
699
    server_config = ConfigParser.SafeConfigParser(server_defaults)
1397
700
    del server_defaults
1398
 
    server_config.read(os.path.join(options.configdir,
1399
 
                                    u"mandos.conf"))
 
701
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
702
    server_section = "server"
1400
703
    # Convert the SafeConfigParser object to a dict
1401
 
    server_settings = server_config.defaults()
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")
 
704
    server_settings = dict(server_config.items(server_section))
 
705
    # Use getboolean on the boolean config option
 
706
    server_settings["debug"] = server_config.getboolean\
 
707
                               (server_section, "debug")
1409
708
    del server_config
1410
709
    
1411
710
    # Override the settings from the config file with command line
1412
711
    # options, if set.
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"):
 
712
    for option in ("interface", "address", "port", "debug",
 
713
                   "priority", "servicename", "configdir"):
1416
714
        value = getattr(options, option)
1417
715
        if value is not None:
1418
716
            server_settings[option] = value
1419
717
    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])
1424
718
    # Now we have our good server settings in "server_settings"
1425
719
    
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"]
 
720
    debug = server_settings["debug"]
1432
721
    
1433
722
    if not debug:
1434
723
        syslogger.setLevel(logging.WARNING)
1435
724
        console.setLevel(logging.WARNING)
1436
725
    
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"]))
 
726
    if server_settings["servicename"] != "Mandos":
 
727
        syslogger.setFormatter(logging.Formatter\
 
728
                               ('Mandos (%s): %%(levelname)s:'
 
729
                                ' %%(message)s'
 
730
                                % server_settings["servicename"]))
1442
731
    
1443
732
    # Parse config file with clients
1444
 
    client_defaults = { u"timeout": u"1h",
1445
 
                        u"interval": u"5m",
1446
 
                        u"checker": u"fping -q -- %%(host)s",
1447
 
                        u"host": u"",
 
733
    client_defaults = { "timeout": "1h",
 
734
                        "interval": "5m",
 
735
                        "checker": "fping -q -- %%(host)s",
1448
736
                        }
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)
1486
 
        os.setuid(uid)
1487
 
    except OSError, error:
1488
 
        if error[0] != errno.EPERM:
1489
 
            raise error
1490
 
    
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))
 
737
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
738
    client_config.read(os.path.join(server_settings["configdir"],
 
739
                                    "clients.conf"))
 
740
    
 
741
    global service
 
742
    service = AvahiService(name = server_settings["servicename"],
 
743
                           type = "_mandos._tcp", );
 
744
    if server_settings["interface"]:
 
745
        service.interface = if_nametoindex(server_settings["interface"])
1503
746
    
1504
747
    global main_loop
 
748
    global bus
 
749
    global server
1505
750
    # From the Avahi example code
1506
751
    DBusGMainLoop(set_as_default=True )
1507
752
    main_loop = gobject.MainLoop()
1508
753
    bus = dbus.SystemBus()
 
754
    server = dbus.Interface(
 
755
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
756
            avahi.DBUS_INTERFACE_SERVER )
1509
757
    # End of Avahi example code
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")
1529
 
    
1530
 
    if debug:
1531
 
        # Redirect stdin so all checkers get /dev/null
1532
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1533
 
        os.dup2(null, sys.stdin.fileno())
1534
 
        if null > 2:
1535
 
            os.close(null)
1536
 
    else:
1537
 
        # No console logging
 
758
    
 
759
    clients = Set()
 
760
    def remove_from_clients(client):
 
761
        clients.remove(client)
 
762
        if not clients:
 
763
            logger.critical(u"No clients left, exiting")
 
764
            sys.exit()
 
765
    
 
766
    clients.update(Set(Client(name = section,
 
767
                              stop_hook = remove_from_clients,
 
768
                              config
 
769
                              = dict(client_config.items(section)))
 
770
                       for section in client_config.sections()))
 
771
    if not clients:
 
772
        logger.critical(u"No clients defined")
 
773
        sys.exit(1)
 
774
    
 
775
    if not debug:
1538
776
        logger.removeHandler(console)
1539
 
        # Close all input and output, do double fork, etc.
1540
777
        daemon()
1541
778
    
 
779
    pidfilename = "/var/run/mandos/mandos.pid"
 
780
    pid = os.getpid()
1542
781
    try:
1543
 
        with closing(pidfile):
1544
 
            pid = os.getpid()
1545
 
            pidfile.write(str(pid) + "\n")
 
782
        pidfile = open(pidfilename, "w")
 
783
        pidfile.write(str(pid) + "\n")
 
784
        pidfile.close()
1546
785
        del pidfile
1547
 
    except IOError:
1548
 
        logger.error(u"Could not write to file %r with PID %d",
1549
 
                     pidfilename, pid)
1550
 
    except NameError:
1551
 
        # "pidfile" was never created
1552
 
        pass
1553
 
    del pidfilename
 
786
    except IOError, err:
 
787
        logger.error(u"Could not write %s file with PID %d",
 
788
                     pidfilename, os.getpid())
1554
789
    
1555
790
    def cleanup():
1556
791
        "Cleanup function; run on exit"
1557
 
        service.cleanup()
 
792
        global group
 
793
        # From the Avahi example code
 
794
        if not group is None:
 
795
            group.Free()
 
796
            group = None
 
797
        # End of Avahi example code
1558
798
        
1559
 
        while tcp_server.clients:
1560
 
            client = tcp_server.clients.pop()
1561
 
            client.disable_hook = None
1562
 
            client.disable()
 
799
        while clients:
 
800
            client = clients.pop()
 
801
            client.stop_hook = None
 
802
            client.stop()
1563
803
    
1564
804
    atexit.register(cleanup)
1565
805
    
1568
808
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1569
809
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1570
810
    
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()
1632
 
    
1633
 
    tcp_server.enable()
1634
 
    tcp_server.server_activate()
1635
 
    
 
811
    for client in clients:
 
812
        client.start()
 
813
    
 
814
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
815
                                 server_settings["port"]),
 
816
                                tcp_handler,
 
817
                                settings=server_settings,
 
818
                                clients=clients)
1636
819
    # Find out what port we got
1637
820
    service.port = tcp_server.socket.getsockname()[1]
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())
 
821
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
 
822
                u" scope_id %d" % tcp_server.socket.getsockname())
1645
823
    
1646
824
    #service.interface = tcp_server.socket.getsockname()[3]
1647
825
    
1648
826
    try:
1649
827
        # From the Avahi example code
 
828
        server.connect_to_signal("StateChanged", server_state_changed)
1650
829
        try:
1651
 
            service.activate()
 
830
            server_state_changed(server.GetState())
1652
831
        except dbus.exceptions.DBusException, error:
1653
832
            logger.critical(u"DBusException: %s", error)
1654
833
            sys.exit(1)
1656
835
        
1657
836
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1658
837
                             lambda *args, **kwargs:
1659
 
                             (tcp_server.handle_request
1660
 
                              (*args[2:], **kwargs) or True))
 
838
                             tcp_server.handle_request\
 
839
                             (*args[2:], **kwargs) or True)
1661
840
        
1662
841
        logger.debug(u"Starting main loop")
 
842
        main_loop_started = True
1663
843
        main_loop.run()
1664
844
    except AvahiError, error:
1665
 
        logger.critical(u"AvahiError: %s", error)
 
845
        logger.critical(u"AvahiError: %s" + unicode(error))
1666
846
        sys.exit(1)
1667
847
    except KeyboardInterrupt:
1668
848
        if debug:
1669
 
            print >> sys.stderr
1670
 
        logger.debug(u"Server received KeyboardInterrupt")
1671
 
    logger.debug(u"Server exiting")
 
849
            print
1672
850
 
1673
851
if __name__ == '__main__':
1674
852
    main()