/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: 2008-08-07 21:45:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080807214541-pyg8itw6kphz1dy5
* plugbasedclient.c: Renamed to "mandos-client.c".  All users changed.

* plugins.d/mandosclient.c: Renamed to "plugins.d/password-request.c".
                            All users changed.

* plugins.d/passprompt.c: Renamed to "plugins.d/password-prompt.c".
                          All users changed.

* server.conf: Renamed to "mandos.conf".  All users changed.

* server.py: Renamed to "mandos".
  (daemon): Have default values for arguments. Caller changed.

* Makefile (distclean, mostlyclean, maintainer-clean): New aliases for
                                                       "clean".
  (check, run-client, run-server): New.

* network-protocol.txt: New.

Show diffs side-by-side

added added

removed removed

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