/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

  • Committer: Teddy Hogeborn
  • Date: 2009-10-02 00:34:19 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091002003419-28cmxz7ls9h60l1m
* mandos (ClientDBus.ReceivedSecret): Renamed to "GotSecret".  All
                                      emitters changed.
  (DBusObjectWithProperties.Introspect): Catch any XML parsing errors.

Show diffs side-by-side

added added

removed removed

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