/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-09-17 01:21:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090917012127-4kwzquwuvudwucuv
* debian/control (Standards-Version): Updated to "2.8.3".

* mandos-client.conf.xml (OPTIONS/timeout): Add that a successful
                                            client request will also
                                            reset the timeout.
* mandos.xml (CHECKING): - '' -

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