/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-02-25 01:14:29 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090225011429-dwz2bj41zqn0w8eo
* initramfs-tools-hook: Add missing terminating `" when setting
                        mandos_user and mandos_group.

* mandos.conf.xml (SEE ALSO): Improved grammar.

Show diffs side-by-side

added added

removed removed

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