/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-14 18:07:05 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090214180705-vu6b7j4i2v2hibgg
Use "getconf" to get correct LFS compile and link flags.

* Makefile (GPGME_CFLAGS): Added output of "getconf LFS_CFLAGS".
  (GPGME_LIBS): Added output of "getconf LFS_LIBS" and
                "getconf LFS_LDFLAGS".
* plugins.d/mandos-client.c: Only define "_LARGEFILE_SOURCE" and
                             "_FILE_OFFSET_BITS" if they are not
                             already defined.

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