/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-10-18 16:09:05 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091018160905-ep07o5cwedsegz9x
* plugins.d/askpass-fifo.c: Do close(STDOUT_FILENO) before exiting to
                            check its return code.  Use exit codes
                            from <sysexits.h>.
* plugins.d/splashy.c: Use exit codes from <sysexits.h> in the fork to
                       exec the "splashy_update" command.

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