/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2009-02-13 05:38:21 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090213053821-03e696gckk4nbjps
Support not using IPv6 in server:

* mandos (AvahiService.__init__): Take new "protocol" parameter.  All
                                  callers changed.
  (IPv6_TCPServer.__init__): Take new "use_ipv6" parameter.  All
                             callers changed.
  (IPv6_TCPServer.server_bind): Create IPv4 socket if not using IPv6.
  (main): New "--no-ipv6" command line option.  New "use_ipv6" config
          option.
* mandos-options.xml ([@id="address"]): Document conditional IPv4
                                        address support.
  ([@id="ipv6"]): New paragraph.
* mandos.conf (use_ipv6): New config option.
* mandos.conf.xml (OPTIONS): Document new "use_dbus" option.
  (EXAMPLE): Changed to use IPv6 link-local address.  Added "use_ipv6"
             option.
* mandos.xml (SYNOPSIS): New "--no-ipv6" option.
  (OPTIONS): Document new "--no-ipv6" option.

Show diffs side-by-side

added added

removed removed

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