/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2008-09-30 07:23:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930072339-jn15gyrtfpdk2dhx
* .bzrignore: Added "man" directory (created by "make install-html").

* Makefile: Add "common.ent" dependency to all manual pages.
  (htmldir, version, SED): New variables.
  (CFLAGS): Add -D option to define VERSION to $(version).
  (MANPOST, HTMLPOST): Use $(SED).
  (PROGS): Use $(CPROGS)
  (CPROGS): New; C-only programs.
  (objects): Use $(CPROGS).
  (common.ent, mandos, mandos-keygen): New targets; update version
                                       number to $(version).
  (clean): Use $(CPROGS).
  (check): Depend on "all".
  (install-html): Install to $(htmldir).

* common.ent: New file with "version" entity.

* mandos-clients.conf.xml: Use "common.ent".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.xml: - '' -

* plugin-runner.c (argp_program_version): Use VERSION.
* plugins.d/mandos-client.c (argp_program_version): - '' -
* plugins.d/password-prompt.c (argp_program_version): - '' -

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