/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-01-31 10:33:17 UTC
  • mfrom: (24.1.129 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20090131103317-wzqvyr532sjcjt7u
Merge from Björn:

* mandos-ctl: New option "--remove-client".  Only default to listing
              clients if no clients were given on the command line.
* plugins.d/mandos-client.c: Lower kernel log level while bringing up
                             network interface.  New option "--delay"
                             to control the maximum delay to wait for
                             running interface.
* plugins.d/mandos-client.xml (SYNOPSIS, OPTIONS): New option
                                                   "--delay".

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