/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2009-04-17 01:16:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090417011637-bcqjpm7fskm4370v
Code cleanup and one bug fix.

* mandos (Client.enable): Bug fix: Do not enable if already enabled.
  (MandosServer.__init__): Create empty set of clients if none passed.
  (main): Do not create clients set; do not pass a clients set to
          MandosServer.  Use tcp_server.clients throughout.

Show diffs side-by-side

added added

removed removed

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