/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

Merge "mandos-list" from belorn.

* Makefile (PROGS): Added "mandos-list".
  (mandos-list): New.

* mandos-list: New; from merge.  Added unicode support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
11
11
# and some lines in "main".
12
12
# 
13
13
# Everything else is
14
 
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
14
# Copyright © 2008 Teddy Hogeborn
 
15
# Copyright © 2008 Björn Påhlsson
15
16
# 
16
17
# This program is free software: you can redistribute it and/or modify
17
18
# it under the terms of the GNU General Public License as published by
30
31
# Contact the authors at <mandos@fukt.bsnet.se>.
31
32
# 
32
33
 
33
 
from __future__ import division
 
34
from __future__ import division, with_statement, absolute_import
34
35
 
35
36
import SocketServer
36
37
import socket
37
 
import select
38
38
from optparse import OptionParser
39
39
import datetime
40
40
import errno
56
56
import logging
57
57
import logging.handlers
58
58
import pwd
 
59
from contextlib import closing
59
60
 
60
61
import dbus
 
62
import dbus.service
61
63
import gobject
62
64
import avahi
63
65
from dbus.mainloop.glib import DBusGMainLoop
64
66
import ctypes
 
67
import ctypes.util
65
68
 
66
 
version = "1.0"
 
69
version = "1.0.2"
67
70
 
68
71
logger = logging.Logger('mandos')
69
 
syslogger = logging.handlers.SysLogHandler\
70
 
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
71
 
             address = "/dev/log")
72
 
syslogger.setFormatter(logging.Formatter\
73
 
                        ('Mandos: %(levelname)s: %(message)s'))
 
72
syslogger = (logging.handlers.SysLogHandler
 
73
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
74
              address = "/dev/log"))
 
75
syslogger.setFormatter(logging.Formatter
 
76
                       ('Mandos: %(levelname)s: %(message)s'))
74
77
logger.addHandler(syslogger)
75
78
 
76
79
console = logging.StreamHandler()
81
84
class AvahiError(Exception):
82
85
    def __init__(self, value):
83
86
        self.value = value
 
87
        super(AvahiError, self).__init__()
84
88
    def __str__(self):
85
89
        return repr(self.value)
86
90
 
108
112
                  a sensible number of times
109
113
    """
110
114
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
111
 
                 type = None, port = None, TXT = None, domain = "",
112
 
                 host = "", max_renames = 32768):
 
115
                 servicetype = None, port = None, TXT = None,
 
116
                 domain = "", host = "", max_renames = 32768):
113
117
        self.interface = interface
114
118
        self.name = name
115
 
        self.type = type
 
119
        self.type = servicetype
116
120
        self.port = port
117
 
        if TXT is None:
118
 
            self.TXT = []
119
 
        else:
120
 
            self.TXT = TXT
 
121
        self.TXT = TXT if TXT is not None else []
121
122
        self.domain = domain
122
123
        self.host = host
123
124
        self.rename_count = 0
127
128
        if self.rename_count >= self.max_renames:
128
129
            logger.critical(u"No suitable Zeroconf service name found"
129
130
                            u" after %i retries, exiting.",
130
 
                            rename_count)
 
131
                            self.rename_count)
131
132
            raise AvahiServiceError("Too many renames")
132
133
        self.name = server.GetAlternativeServiceName(self.name)
133
134
        logger.info(u"Changing Zeroconf service name to %r ...",
134
135
                    str(self.name))
135
 
        syslogger.setFormatter(logging.Formatter\
 
136
        syslogger.setFormatter(logging.Formatter
136
137
                               ('Mandos (%s): %%(levelname)s:'
137
 
                               ' %%(message)s' % self.name))
 
138
                                ' %%(message)s' % self.name))
138
139
        self.remove()
139
140
        self.add()
140
141
        self.rename_count += 1
146
147
        """Derived from the Avahi example code"""
147
148
        global group
148
149
        if group is None:
149
 
            group = dbus.Interface\
150
 
                    (bus.get_object(avahi.DBUS_NAME,
 
150
            group = dbus.Interface(bus.get_object
 
151
                                   (avahi.DBUS_NAME,
151
152
                                    server.EntryGroupNew()),
152
 
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
153
                                   avahi.DBUS_INTERFACE_ENTRY_GROUP)
153
154
            group.connect_to_signal('StateChanged',
154
155
                                    entry_group_state_changed)
155
156
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
169
170
# End of Avahi example code
170
171
 
171
172
 
172
 
class Client(object):
 
173
def _datetime_to_dbus(dt, variant_level=0):
 
174
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
175
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
176
 
 
177
 
 
178
class Client(dbus.service.Object):
173
179
    """A representation of a client host served by this server.
174
180
    Attributes:
175
 
    name:      string; from the config file, used in log messages
 
181
    name:       string; from the config file, used in log messages
176
182
    fingerprint: string (40 or 32 hexadecimal digits); used to
177
183
                 uniquely identify the client
178
 
    secret:    bytestring; sent verbatim (over TLS) to client
179
 
    host:      string; available for use by the checker command
180
 
    created:   datetime.datetime(); object creation, not client host
181
 
    last_checked_ok: datetime.datetime() or None if not yet checked OK
182
 
    timeout:   datetime.timedelta(); How long from last_checked_ok
183
 
                                     until this client is invalid
184
 
    interval:  datetime.timedelta(); How often to start a new checker
185
 
    stop_hook: If set, called by stop() as stop_hook(self)
186
 
    checker:   subprocess.Popen(); a running checker process used
187
 
                                   to see if the client lives.
188
 
                                   'None' if no process is running.
 
184
    secret:     bytestring; sent verbatim (over TLS) to client
 
185
    host:       string; available for use by the checker command
 
186
    created:    datetime.datetime(); (UTC) object creation
 
187
    last_enabled: datetime.datetime(); (UTC)
 
188
    enabled:    bool()
 
189
    last_checked_ok: datetime.datetime(); (UTC) or None
 
190
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
191
                                      until this client is invalid
 
192
    interval:   datetime.timedelta(); How often to start a new checker
 
193
    disable_hook:  If set, called by disable() as disable_hook(self)
 
194
    checker:    subprocess.Popen(); a running checker process used
 
195
                                    to see if the client lives.
 
196
                                    'None' if no process is running.
189
197
    checker_initiator_tag: a gobject event source tag, or None
190
 
    stop_initiator_tag:    - '' -
 
198
    disable_initiator_tag:    - '' -
191
199
    checker_callback_tag:  - '' -
192
200
    checker_command: string; External command which is run to check if
193
201
                     client lives.  %() expansions are done at
194
202
                     runtime with vars(self) as dict, so that for
195
203
                     instance %(name)s can be used in the command.
 
204
    dbus_object_path: dbus.ObjectPath
196
205
    Private attibutes:
197
206
    _timeout: Real variable for 'timeout'
198
207
    _interval: Real variable for 'interval'
200
209
    _interval_milliseconds: - '' -
201
210
    """
202
211
    def _set_timeout(self, timeout):
203
 
        "Setter function for 'timeout' attribute"
 
212
        "Setter function for the 'timeout' attribute"
204
213
        self._timeout = timeout
205
214
        self._timeout_milliseconds = ((self.timeout.days
206
215
                                       * 24 * 60 * 60 * 1000)
207
216
                                      + (self.timeout.seconds * 1000)
208
217
                                      + (self.timeout.microseconds
209
218
                                         // 1000))
210
 
    timeout = property(lambda self: self._timeout,
211
 
                       _set_timeout)
 
219
        # Emit D-Bus signal
 
220
        self.PropertyChanged(dbus.String(u"timeout"),
 
221
                             (dbus.UInt64(self._timeout_milliseconds,
 
222
                                          variant_level=1)))
 
223
    timeout = property(lambda self: self._timeout, _set_timeout)
212
224
    del _set_timeout
 
225
    
213
226
    def _set_interval(self, interval):
214
 
        "Setter function for 'interval' attribute"
 
227
        "Setter function for the 'interval' attribute"
215
228
        self._interval = interval
216
229
        self._interval_milliseconds = ((self.interval.days
217
230
                                        * 24 * 60 * 60 * 1000)
219
232
                                          * 1000)
220
233
                                       + (self.interval.microseconds
221
234
                                          // 1000))
222
 
    interval = property(lambda self: self._interval,
223
 
                        _set_interval)
 
235
        # Emit D-Bus signal
 
236
        self.PropertyChanged(dbus.String(u"interval"),
 
237
                             (dbus.UInt64(self._interval_milliseconds,
 
238
                                          variant_level=1)))
 
239
    interval = property(lambda self: self._interval, _set_interval)
224
240
    del _set_interval
225
 
    def __init__(self, name = None, stop_hook=None, config={}):
 
241
    
 
242
    def __init__(self, name = None, disable_hook=None, config=None):
226
243
        """Note: the 'checker' key in 'config' sets the
227
244
        'checker_command' attribute and *not* the 'checker'
228
245
        attribute."""
 
246
        self.dbus_object_path = (dbus.ObjectPath
 
247
                                 ("/Mandos/clients/"
 
248
                                  + name.replace(".", "_")))
 
249
        dbus.service.Object.__init__(self, bus,
 
250
                                     self.dbus_object_path)
 
251
        if config is None:
 
252
            config = {}
229
253
        self.name = name
230
254
        logger.debug(u"Creating client %r", self.name)
231
255
        # Uppercase and remove spaces from fingerprint for later
232
256
        # comparison purposes with return value from the fingerprint()
233
257
        # function
234
 
        self.fingerprint = config["fingerprint"].upper()\
235
 
                           .replace(u" ", u"")
 
258
        self.fingerprint = (config["fingerprint"].upper()
 
259
                            .replace(u" ", u""))
236
260
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
237
261
        if "secret" in config:
238
262
            self.secret = config["secret"].decode(u"base64")
239
263
        elif "secfile" in config:
240
 
            sf = open(config["secfile"])
241
 
            self.secret = sf.read()
242
 
            sf.close()
 
264
            with closing(open(os.path.expanduser
 
265
                              (os.path.expandvars
 
266
                               (config["secfile"])))) as secfile:
 
267
                self.secret = secfile.read()
243
268
        else:
244
269
            raise TypeError(u"No secret or secfile for client %s"
245
270
                            % self.name)
246
271
        self.host = config.get("host", "")
247
 
        self.created = datetime.datetime.now()
 
272
        self.created = datetime.datetime.utcnow()
 
273
        self.enabled = False
 
274
        self.last_enabled = None
248
275
        self.last_checked_ok = None
249
276
        self.timeout = string_to_delta(config["timeout"])
250
277
        self.interval = string_to_delta(config["interval"])
251
 
        self.stop_hook = stop_hook
 
278
        self.disable_hook = disable_hook
252
279
        self.checker = None
253
280
        self.checker_initiator_tag = None
254
 
        self.stop_initiator_tag = None
 
281
        self.disable_initiator_tag = None
255
282
        self.checker_callback_tag = None
256
 
        self.check_command = config["checker"]
257
 
    def start(self):
 
283
        self.checker_command = config["checker"]
 
284
    
 
285
    def enable(self):
258
286
        """Start this client's checker and timeout hooks"""
 
287
        self.last_enabled = datetime.datetime.utcnow()
259
288
        # Schedule a new checker to be started an 'interval' from now,
260
289
        # and every interval from then on.
261
 
        self.checker_initiator_tag = gobject.timeout_add\
262
 
                                     (self._interval_milliseconds,
263
 
                                      self.start_checker)
 
290
        self.checker_initiator_tag = (gobject.timeout_add
 
291
                                      (self._interval_milliseconds,
 
292
                                       self.start_checker))
264
293
        # Also start a new checker *right now*.
265
294
        self.start_checker()
266
 
        # Schedule a stop() when 'timeout' has passed
267
 
        self.stop_initiator_tag = gobject.timeout_add\
268
 
                                  (self._timeout_milliseconds,
269
 
                                   self.stop)
270
 
    def stop(self):
271
 
        """Stop this client.
272
 
        The possibility that a client might be restarted is left open,
273
 
        but not currently used."""
274
 
        # If this client doesn't have a secret, it is already stopped.
275
 
        if hasattr(self, "secret") and self.secret:
276
 
            logger.info(u"Stopping client %s", self.name)
277
 
            self.secret = None
278
 
        else:
 
295
        # Schedule a disable() when 'timeout' has passed
 
296
        self.disable_initiator_tag = (gobject.timeout_add
 
297
                                   (self._timeout_milliseconds,
 
298
                                    self.disable))
 
299
        self.enabled = True
 
300
        # Emit D-Bus signal
 
301
        self.PropertyChanged(dbus.String(u"enabled"),
 
302
                             dbus.Boolean(True, variant_level=1))
 
303
        self.PropertyChanged(dbus.String(u"last_enabled"),
 
304
                             (_datetime_to_dbus(self.last_enabled,
 
305
                                                variant_level=1)))
 
306
    
 
307
    def disable(self):
 
308
        """Disable this client."""
 
309
        if not getattr(self, "enabled", False):
279
310
            return False
280
 
        if getattr(self, "stop_initiator_tag", False):
281
 
            gobject.source_remove(self.stop_initiator_tag)
282
 
            self.stop_initiator_tag = None
 
311
        logger.info(u"Disabling client %s", self.name)
 
312
        if getattr(self, "disable_initiator_tag", False):
 
313
            gobject.source_remove(self.disable_initiator_tag)
 
314
            self.disable_initiator_tag = None
283
315
        if getattr(self, "checker_initiator_tag", False):
284
316
            gobject.source_remove(self.checker_initiator_tag)
285
317
            self.checker_initiator_tag = None
286
318
        self.stop_checker()
287
 
        if self.stop_hook:
288
 
            self.stop_hook(self)
 
319
        if self.disable_hook:
 
320
            self.disable_hook(self)
 
321
        self.enabled = False
 
322
        # Emit D-Bus signal
 
323
        self.PropertyChanged(dbus.String(u"enabled"),
 
324
                             dbus.Boolean(False, variant_level=1))
289
325
        # Do not run this again if called by a gobject.timeout_add
290
326
        return False
 
327
    
291
328
    def __del__(self):
292
 
        self.stop_hook = None
293
 
        self.stop()
294
 
    def checker_callback(self, pid, condition):
 
329
        self.disable_hook = None
 
330
        self.disable()
 
331
    
 
332
    def checker_callback(self, pid, condition, command):
295
333
        """The checker has completed, so take appropriate actions."""
296
 
        now = datetime.datetime.now()
297
334
        self.checker_callback_tag = None
298
335
        self.checker = None
299
 
        if os.WIFEXITED(condition) \
300
 
               and (os.WEXITSTATUS(condition) == 0):
 
336
        # Emit D-Bus signal
 
337
        self.PropertyChanged(dbus.String(u"checker_running"),
 
338
                             dbus.Boolean(False, variant_level=1))
 
339
        if (os.WIFEXITED(condition)
 
340
            and (os.WEXITSTATUS(condition) == 0)):
301
341
            logger.info(u"Checker for %(name)s succeeded",
302
342
                        vars(self))
303
 
            self.last_checked_ok = now
304
 
            gobject.source_remove(self.stop_initiator_tag)
305
 
            self.stop_initiator_tag = gobject.timeout_add\
306
 
                                      (self._timeout_milliseconds,
307
 
                                       self.stop)
 
343
            # Emit D-Bus signal
 
344
            self.CheckerCompleted(dbus.Boolean(True),
 
345
                                  dbus.UInt16(condition),
 
346
                                  dbus.String(command))
 
347
            self.bump_timeout()
308
348
        elif not os.WIFEXITED(condition):
309
349
            logger.warning(u"Checker for %(name)s crashed?",
310
350
                           vars(self))
 
351
            # Emit D-Bus signal
 
352
            self.CheckerCompleted(dbus.Boolean(False),
 
353
                                  dbus.UInt16(condition),
 
354
                                  dbus.String(command))
311
355
        else:
312
356
            logger.info(u"Checker for %(name)s failed",
313
357
                        vars(self))
 
358
            # Emit D-Bus signal
 
359
            self.CheckerCompleted(dbus.Boolean(False),
 
360
                                  dbus.UInt16(condition),
 
361
                                  dbus.String(command))
 
362
    
 
363
    def bump_timeout(self):
 
364
        """Bump up the timeout for this client.
 
365
        This should only be called when the client has been seen,
 
366
        alive and well.
 
367
        """
 
368
        self.last_checked_ok = datetime.datetime.utcnow()
 
369
        gobject.source_remove(self.disable_initiator_tag)
 
370
        self.disable_initiator_tag = (gobject.timeout_add
 
371
                                      (self._timeout_milliseconds,
 
372
                                       self.disable))
 
373
        self.PropertyChanged(dbus.String(u"last_checked_ok"),
 
374
                             (_datetime_to_dbus(self.last_checked_ok,
 
375
                                                variant_level=1)))
 
376
    
314
377
    def start_checker(self):
315
378
        """Start a new checker subprocess if one is not running.
316
379
        If a checker already exists, leave it running and do
325
388
        # is as it should be.
326
389
        if self.checker is None:
327
390
            try:
328
 
                # In case check_command has exactly one % operator
329
 
                command = self.check_command % self.host
 
391
                # In case checker_command has exactly one % operator
 
392
                command = self.checker_command % self.host
330
393
            except TypeError:
331
394
                # Escape attributes for the shell
332
395
                escaped_attrs = dict((key, re.escape(str(val)))
333
396
                                     for key, val in
334
397
                                     vars(self).iteritems())
335
398
                try:
336
 
                    command = self.check_command % escaped_attrs
 
399
                    command = self.checker_command % escaped_attrs
337
400
                except TypeError, error:
338
401
                    logger.error(u'Could not format string "%s":'
339
 
                                 u' %s', self.check_command, error)
 
402
                                 u' %s', self.checker_command, error)
340
403
                    return True # Try again later
341
404
            try:
342
405
                logger.info(u"Starting checker %r for %s",
348
411
                self.checker = subprocess.Popen(command,
349
412
                                                close_fds=True,
350
413
                                                shell=True, cwd="/")
351
 
                self.checker_callback_tag = gobject.child_watch_add\
352
 
                                            (self.checker.pid,
353
 
                                             self.checker_callback)
 
414
                # Emit D-Bus signal
 
415
                self.CheckerStarted(command)
 
416
                self.PropertyChanged(dbus.String("checker_running"),
 
417
                                     dbus.Boolean(True, variant_level=1))
 
418
                self.checker_callback_tag = (gobject.child_watch_add
 
419
                                             (self.checker.pid,
 
420
                                              self.checker_callback,
 
421
                                              data=command))
354
422
            except OSError, error:
355
423
                logger.error(u"Failed to start subprocess: %s",
356
424
                             error)
357
425
        # Re-run this periodically if run by gobject.timeout_add
358
426
        return True
 
427
    
359
428
    def stop_checker(self):
360
429
        """Force the checker process, if any, to stop."""
361
430
        if self.checker_callback_tag:
373
442
            if error.errno != errno.ESRCH: # No such process
374
443
                raise
375
444
        self.checker = None
 
445
        self.PropertyChanged(dbus.String(u"checker_running"),
 
446
                             dbus.Boolean(False, variant_level=1))
 
447
    
376
448
    def still_valid(self):
377
449
        """Has the timeout not yet passed for this client?"""
378
 
        now = datetime.datetime.now()
 
450
        if not getattr(self, "enabled", False):
 
451
            return False
 
452
        now = datetime.datetime.utcnow()
379
453
        if self.last_checked_ok is None:
380
454
            return now < (self.created + self.timeout)
381
455
        else:
382
456
            return now < (self.last_checked_ok + self.timeout)
 
457
    
 
458
    ## D-Bus methods & signals
 
459
    _interface = u"org.mandos_system.Mandos.Client"
 
460
    
 
461
    # BumpTimeout - method
 
462
    BumpTimeout = dbus.service.method(_interface)(bump_timeout)
 
463
    BumpTimeout.__name__ = "BumpTimeout"
 
464
    
 
465
    # CheckerCompleted - signal
 
466
    @dbus.service.signal(_interface, signature="bqs")
 
467
    def CheckerCompleted(self, success, condition, command):
 
468
        "D-Bus signal"
 
469
        pass
 
470
    
 
471
    # CheckerStarted - signal
 
472
    @dbus.service.signal(_interface, signature="s")
 
473
    def CheckerStarted(self, command):
 
474
        "D-Bus signal"
 
475
        pass
 
476
    
 
477
    # GetAllProperties - method
 
478
    @dbus.service.method(_interface, out_signature="a{sv}")
 
479
    def GetAllProperties(self):
 
480
        "D-Bus method"
 
481
        return dbus.Dictionary({
 
482
                dbus.String("name"):
 
483
                    dbus.String(self.name, variant_level=1),
 
484
                dbus.String("fingerprint"):
 
485
                    dbus.String(self.fingerprint, variant_level=1),
 
486
                dbus.String("host"):
 
487
                    dbus.String(self.host, variant_level=1),
 
488
                dbus.String("created"):
 
489
                    _datetime_to_dbus(self.created, variant_level=1),
 
490
                dbus.String("last_enabled"):
 
491
                    (_datetime_to_dbus(self.last_enabled,
 
492
                                       variant_level=1)
 
493
                     if self.last_enabled is not None
 
494
                     else dbus.Boolean(False, variant_level=1)),
 
495
                dbus.String("enabled"):
 
496
                    dbus.Boolean(self.enabled, variant_level=1),
 
497
                dbus.String("last_checked_ok"):
 
498
                    (_datetime_to_dbus(self.last_checked_ok,
 
499
                                       variant_level=1)
 
500
                     if self.last_checked_ok is not None
 
501
                     else dbus.Boolean (False, variant_level=1)),
 
502
                dbus.String("timeout"):
 
503
                    dbus.UInt64(self._timeout_milliseconds,
 
504
                                variant_level=1),
 
505
                dbus.String("interval"):
 
506
                    dbus.UInt64(self._interval_milliseconds,
 
507
                                variant_level=1),
 
508
                dbus.String("checker"):
 
509
                    dbus.String(self.checker_command,
 
510
                                variant_level=1),
 
511
                dbus.String("checker_running"):
 
512
                    dbus.Boolean(self.checker is not None,
 
513
                                 variant_level=1),
 
514
                }, signature="sv")
 
515
    
 
516
    # IsStillValid - method
 
517
    IsStillValid = (dbus.service.method(_interface, out_signature="b")
 
518
                    (still_valid))
 
519
    IsStillValid.__name__ = "IsStillValid"
 
520
    
 
521
    # PropertyChanged - signal
 
522
    @dbus.service.signal(_interface, signature="sv")
 
523
    def PropertyChanged(self, property, value):
 
524
        "D-Bus signal"
 
525
        pass
 
526
    
 
527
    # SetChecker - method
 
528
    @dbus.service.method(_interface, in_signature="s")
 
529
    def SetChecker(self, checker):
 
530
        "D-Bus setter method"
 
531
        self.checker_command = checker
 
532
    
 
533
    # SetHost - method
 
534
    @dbus.service.method(_interface, in_signature="s")
 
535
    def SetHost(self, host):
 
536
        "D-Bus setter method"
 
537
        self.host = host
 
538
    
 
539
    # SetInterval - method
 
540
    @dbus.service.method(_interface, in_signature="t")
 
541
    def SetInterval(self, milliseconds):
 
542
        self.interval = datetime.timdeelta(0, 0, 0, milliseconds)
 
543
    
 
544
    # SetSecret - method
 
545
    @dbus.service.method(_interface, in_signature="ay",
 
546
                         byte_arrays=True)
 
547
    def SetSecret(self, secret):
 
548
        "D-Bus setter method"
 
549
        self.secret = str(secret)
 
550
    
 
551
    # SetTimeout - method
 
552
    @dbus.service.method(_interface, in_signature="t")
 
553
    def SetTimeout(self, milliseconds):
 
554
        self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
 
555
    
 
556
    # Enable - method
 
557
    Enable = dbus.service.method(_interface)(enable)
 
558
    Enable.__name__ = "Enable"
 
559
    
 
560
    # StartChecker - method
 
561
    @dbus.service.method(_interface)
 
562
    def StartChecker(self):
 
563
        "D-Bus method"
 
564
        self.start_checker()
 
565
    
 
566
    # Disable - method
 
567
    @dbus.service.method(_interface)
 
568
    def Disable(self):
 
569
        "D-Bus method"
 
570
        self.disable()
 
571
    
 
572
    # StopChecker - method
 
573
    StopChecker = dbus.service.method(_interface)(stop_checker)
 
574
    StopChecker.__name__ = "StopChecker"
 
575
    
 
576
    del _interface
383
577
 
384
578
 
385
579
def peer_certificate(session):
386
580
    "Return the peer's OpenPGP certificate as a bytestring"
387
581
    # If not an OpenPGP certificate...
388
 
    if gnutls.library.functions.gnutls_certificate_type_get\
389
 
            (session._c_object) \
390
 
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
 
582
    if (gnutls.library.functions
 
583
        .gnutls_certificate_type_get(session._c_object)
 
584
        != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
391
585
        # ...do the normal thing
392
586
        return session.peer_certificate
393
587
    list_size = ctypes.c_uint()
394
 
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
395
 
        (session._c_object, ctypes.byref(list_size))
 
588
    cert_list = (gnutls.library.functions
 
589
                 .gnutls_certificate_get_peers
 
590
                 (session._c_object, ctypes.byref(list_size)))
396
591
    if list_size.value == 0:
397
592
        return None
398
593
    cert = cert_list[0]
402
597
def fingerprint(openpgp):
403
598
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
404
599
    # New GnuTLS "datum" with the OpenPGP public key
405
 
    datum = gnutls.library.types.gnutls_datum_t\
406
 
        (ctypes.cast(ctypes.c_char_p(openpgp),
407
 
                     ctypes.POINTER(ctypes.c_ubyte)),
408
 
         ctypes.c_uint(len(openpgp)))
 
600
    datum = (gnutls.library.types
 
601
             .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
602
                                         ctypes.POINTER
 
603
                                         (ctypes.c_ubyte)),
 
604
                             ctypes.c_uint(len(openpgp))))
409
605
    # New empty GnuTLS certificate
410
606
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
411
 
    gnutls.library.functions.gnutls_openpgp_crt_init\
412
 
        (ctypes.byref(crt))
 
607
    (gnutls.library.functions
 
608
     .gnutls_openpgp_crt_init(ctypes.byref(crt)))
413
609
    # Import the OpenPGP public key into the certificate
414
 
    gnutls.library.functions.gnutls_openpgp_crt_import\
415
 
                    (crt, ctypes.byref(datum),
416
 
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
610
    (gnutls.library.functions
 
611
     .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
612
                                gnutls.library.constants
 
613
                                .GNUTLS_OPENPGP_FMT_RAW))
417
614
    # Verify the self signature in the key
418
 
    crtverify = ctypes.c_uint();
419
 
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
420
 
        (crt, 0, ctypes.byref(crtverify))
 
615
    crtverify = ctypes.c_uint()
 
616
    (gnutls.library.functions
 
617
     .gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
421
618
    if crtverify.value != 0:
422
619
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
423
620
        raise gnutls.errors.CertificateSecurityError("Verify failed")
424
621
    # New buffer for the fingerprint
425
 
    buffer = ctypes.create_string_buffer(20)
426
 
    buffer_length = ctypes.c_size_t()
 
622
    buf = ctypes.create_string_buffer(20)
 
623
    buf_len = ctypes.c_size_t()
427
624
    # Get the fingerprint from the certificate into the buffer
428
 
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
429
 
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
625
    (gnutls.library.functions
 
626
     .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
627
                                         ctypes.byref(buf_len)))
430
628
    # Deinit the certificate
431
629
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
432
630
    # Convert the buffer to a Python bytestring
433
 
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
631
    fpr = ctypes.string_at(buf, buf_len.value)
434
632
    # Convert the bytestring to hexadecimal notation
435
633
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
436
634
    return hex_fpr
437
635
 
438
636
 
439
 
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
637
class TCP_handler(SocketServer.BaseRequestHandler, object):
440
638
    """A TCP request handler class.
441
639
    Instantiated by IPv6_TCPServer for each request to handle it.
442
640
    Note: This will run in its own forked process."""
443
641
    
444
642
    def handle(self):
445
643
        logger.info(u"TCP connection from: %s",
446
 
                     unicode(self.client_address))
447
 
        session = gnutls.connection.ClientSession\
448
 
                  (self.request, gnutls.connection.X509Credentials())
 
644
                    unicode(self.client_address))
 
645
        session = (gnutls.connection
 
646
                   .ClientSession(self.request,
 
647
                                  gnutls.connection
 
648
                                  .X509Credentials()))
449
649
        
450
650
        line = self.request.makefile().readline()
451
651
        logger.debug(u"Protocol version: %r", line)
464
664
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
465
665
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
466
666
        #                "+DHE-DSS"))
467
 
        priority = "NORMAL"             # Fallback default, since this
468
 
                                        # MUST be set.
469
 
        if self.server.settings["priority"]:
470
 
            priority = self.server.settings["priority"]
471
 
        gnutls.library.functions.gnutls_priority_set_direct\
472
 
            (session._c_object, priority, None);
 
667
        # Use a fallback default, since this MUST be set.
 
668
        priority = self.server.settings.get("priority", "NORMAL")
 
669
        (gnutls.library.functions
 
670
         .gnutls_priority_set_direct(session._c_object,
 
671
                                     priority, None))
473
672
        
474
673
        try:
475
674
            session.handshake()
485
684
            session.bye()
486
685
            return
487
686
        logger.debug(u"Fingerprint: %s", fpr)
488
 
        client = None
489
687
        for c in self.server.clients:
490
688
            if c.fingerprint == fpr:
491
689
                client = c
492
690
                break
493
 
        if not client:
 
691
        else:
494
692
            logger.warning(u"Client not found for fingerprint: %s",
495
693
                           fpr)
496
694
            session.bye()
503
701
                           vars(client))
504
702
            session.bye()
505
703
            return
 
704
        ## This won't work here, since we're in a fork.
 
705
        # client.bump_timeout()
506
706
        sent_size = 0
507
707
        while sent_size < len(client.secret):
508
708
            sent = session.send(client.secret[sent_size:])
513
713
        session.bye()
514
714
 
515
715
 
516
 
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
716
class IPv6_TCPServer(SocketServer.ForkingMixIn,
 
717
                     SocketServer.TCPServer, object):
517
718
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
518
719
    Attributes:
519
720
        settings:       Server settings
529
730
            self.clients = kwargs["clients"]
530
731
            del kwargs["clients"]
531
732
        self.enabled = False
532
 
        return super(type(self), self).__init__(*args, **kwargs)
 
733
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
533
734
    def server_bind(self):
534
735
        """This overrides the normal server_bind() function
535
736
        to bind to an interface if one was specified, and also NOT to
564
765
#                                            if_nametoindex
565
766
#                                            (self.settings
566
767
#                                             ["interface"]))
567
 
            return super(type(self), self).server_bind()
 
768
            return super(IPv6_TCPServer, self).server_bind()
568
769
    def server_activate(self):
569
770
        if self.enabled:
570
 
            return super(type(self), self).server_activate()
 
771
            return super(IPv6_TCPServer, self).server_activate()
571
772
    def enable(self):
572
773
        self.enabled = True
573
774
 
591
792
    timevalue = datetime.timedelta(0)
592
793
    for s in interval.split():
593
794
        try:
594
 
            suffix=unicode(s[-1])
595
 
            value=int(s[:-1])
 
795
            suffix = unicode(s[-1])
 
796
            value = int(s[:-1])
596
797
            if suffix == u"d":
597
798
                delta = datetime.timedelta(value)
598
799
            elif suffix == u"s":
638
839
    """Call the C function if_nametoindex(), or equivalent"""
639
840
    global if_nametoindex
640
841
    try:
641
 
        if "ctypes.util" not in sys.modules:
642
 
            import ctypes.util
643
 
        if_nametoindex = ctypes.cdll.LoadLibrary\
644
 
            (ctypes.util.find_library("c")).if_nametoindex
 
842
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
843
                          (ctypes.util.find_library("c"))
 
844
                          .if_nametoindex)
645
845
    except (OSError, AttributeError):
646
846
        if "struct" not in sys.modules:
647
847
            import struct
650
850
        def if_nametoindex(interface):
651
851
            "Get an interface index the hard way, i.e. using fcntl()"
652
852
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
653
 
            s = socket.socket()
654
 
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
655
 
                                struct.pack("16s16x", interface))
656
 
            s.close()
 
853
            with closing(socket.socket()) as s:
 
854
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
855
                                    struct.pack("16s16x", interface))
657
856
            interface_index = struct.unpack("I", ifreq[16:20])[0]
658
857
            return interface_index
659
858
    return if_nametoindex(interface)
683
882
 
684
883
 
685
884
def main():
686
 
    global main_loop_started
687
 
    main_loop_started = False
688
 
    
689
885
    parser = OptionParser(version = "%%prog %s" % version)
690
886
    parser.add_option("-i", "--interface", type="string",
691
887
                      metavar="IF", help="Bind to interface IF")
706
902
                      default="/etc/mandos", metavar="DIR",
707
903
                      help="Directory to search for configuration"
708
904
                      " files")
709
 
    (options, args) = parser.parse_args()
 
905
    options = parser.parse_args()[0]
710
906
    
711
907
    if options.check:
712
908
        import doctest
730
926
    # Convert the SafeConfigParser object to a dict
731
927
    server_settings = server_config.defaults()
732
928
    # Use getboolean on the boolean config option
733
 
    server_settings["debug"] = server_config.getboolean\
734
 
                               ("DEFAULT", "debug")
 
929
    server_settings["debug"] = (server_config.getboolean
 
930
                                ("DEFAULT", "debug"))
735
931
    del server_config
736
932
    
737
933
    # Override the settings from the config file with command line
751
947
        console.setLevel(logging.WARNING)
752
948
    
753
949
    if server_settings["servicename"] != "Mandos":
754
 
        syslogger.setFormatter(logging.Formatter\
 
950
        syslogger.setFormatter(logging.Formatter
755
951
                               ('Mandos (%s): %%(levelname)s:'
756
952
                                ' %%(message)s'
757
953
                                % server_settings["servicename"]))
769
965
    clients = Set()
770
966
    tcp_server = IPv6_TCPServer((server_settings["address"],
771
967
                                 server_settings["port"]),
772
 
                                tcp_handler,
 
968
                                TCP_handler,
773
969
                                settings=server_settings,
774
970
                                clients=clients)
775
971
    pidfilename = "/var/run/mandos.pid"
778
974
    except IOError, error:
779
975
        logger.error("Could not open file %r", pidfilename)
780
976
    
781
 
    uid = 65534
782
 
    gid = 65534
783
 
    try:
784
 
        uid = pwd.getpwnam("mandos").pw_uid
785
 
    except KeyError:
786
 
        try:
787
 
            uid = pwd.getpwnam("nobody").pw_uid
788
 
        except KeyError:
789
 
            pass
790
 
    try:
791
 
        gid = pwd.getpwnam("mandos").pw_gid
792
 
    except KeyError:
793
 
        try:
794
 
            gid = pwd.getpwnam("nogroup").pw_gid
795
 
        except KeyError:
796
 
            pass
 
977
    try:
 
978
        uid = pwd.getpwnam("_mandos").pw_uid
 
979
    except KeyError:
 
980
        try:
 
981
            uid = pwd.getpwnam("mandos").pw_uid
 
982
        except KeyError:
 
983
            try:
 
984
                uid = pwd.getpwnam("nobody").pw_uid
 
985
            except KeyError:
 
986
                uid = 65534
 
987
    try:
 
988
        gid = pwd.getpwnam("_mandos").pw_gid
 
989
    except KeyError:
 
990
        try:
 
991
            gid = pwd.getpwnam("mandos").pw_gid
 
992
        except KeyError:
 
993
            try:
 
994
                gid = pwd.getpwnam("nogroup").pw_gid
 
995
            except KeyError:
 
996
                gid = 65534
797
997
    try:
798
998
        os.setuid(uid)
799
999
        os.setgid(gid)
803
1003
    
804
1004
    global service
805
1005
    service = AvahiService(name = server_settings["servicename"],
806
 
                           type = "_mandos._tcp", );
 
1006
                           servicetype = "_mandos._tcp", )
807
1007
    if server_settings["interface"]:
808
 
        service.interface = if_nametoindex\
809
 
                            (server_settings["interface"])
 
1008
        service.interface = (if_nametoindex
 
1009
                             (server_settings["interface"]))
810
1010
    
811
1011
    global main_loop
812
1012
    global bus
819
1019
                                           avahi.DBUS_PATH_SERVER),
820
1020
                            avahi.DBUS_INTERFACE_SERVER)
821
1021
    # End of Avahi example code
822
 
    
823
 
    def remove_from_clients(client):
824
 
        clients.remove(client)
825
 
        if not clients:
826
 
            logger.critical(u"No clients left, exiting")
827
 
            sys.exit()
 
1022
    bus_name = dbus.service.BusName(u"org.mandos-system.Mandos", bus)
828
1023
    
829
1024
    clients.update(Set(Client(name = section,
830
 
                              stop_hook = remove_from_clients,
831
1025
                              config
832
1026
                              = dict(client_config.items(section)))
833
1027
                       for section in client_config.sections()))
852
1046
        pidfile.write(str(pid) + "\n")
853
1047
        pidfile.close()
854
1048
        del pidfile
855
 
    except IOError, err:
 
1049
    except IOError:
856
1050
        logger.error(u"Could not write to file %r with PID %d",
857
1051
                     pidfilename, pid)
858
1052
    except NameError:
871
1065
        
872
1066
        while clients:
873
1067
            client = clients.pop()
874
 
            client.stop_hook = None
875
 
            client.stop()
 
1068
            client.disable_hook = None
 
1069
            client.disable()
876
1070
    
877
1071
    atexit.register(cleanup)
878
1072
    
881
1075
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
882
1076
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
883
1077
    
 
1078
    class MandosServer(dbus.service.Object):
 
1079
        """A D-Bus proxy object"""
 
1080
        def __init__(self):
 
1081
            dbus.service.Object.__init__(self, bus,
 
1082
                                         "/Mandos")
 
1083
        _interface = u"org.mandos_system.Mandos"
 
1084
        
 
1085
        @dbus.service.signal(_interface, signature="oa{sv}")
 
1086
        def ClientAdded(self, objpath, properties):
 
1087
            "D-Bus signal"
 
1088
            pass
 
1089
        
 
1090
        @dbus.service.signal(_interface, signature="o")
 
1091
        def ClientRemoved(self, objpath):
 
1092
            "D-Bus signal"
 
1093
            pass
 
1094
        
 
1095
        @dbus.service.method(_interface, out_signature="ao")
 
1096
        def GetAllClients(self):
 
1097
            return dbus.Array(c.dbus_object_path for c in clients)
 
1098
        
 
1099
        @dbus.service.method(_interface, out_signature="a{oa{sv}}")
 
1100
        def GetAllClientsWithProperties(self):
 
1101
            return dbus.Dictionary(
 
1102
                ((c.dbus_object_path, c.GetAllProperties())
 
1103
                 for c in clients),
 
1104
                signature="oa{sv}")
 
1105
        
 
1106
        @dbus.service.method(_interface, in_signature="o")
 
1107
        def RemoveClient(self, object_path):
 
1108
            for c in clients:
 
1109
                if c.dbus_object_path == object_path:
 
1110
                    c.disable()
 
1111
                    clients.remove(c)
 
1112
                    return
 
1113
            raise KeyError
 
1114
        
 
1115
        del _interface
 
1116
    
 
1117
    mandos_server = MandosServer()
 
1118
    
884
1119
    for client in clients:
885
 
        client.start()
 
1120
        # Emit D-Bus signal
 
1121
        mandos_server.ClientAdded(client.dbus_object_path,
 
1122
                                  client.GetAllProperties())
 
1123
        client.enable()
886
1124
    
887
1125
    tcp_server.enable()
888
1126
    tcp_server.server_activate()
906
1144
        
907
1145
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
908
1146
                             lambda *args, **kwargs:
909
 
                             tcp_server.handle_request\
910
 
                             (*args[2:], **kwargs) or True)
 
1147
                             (tcp_server.handle_request
 
1148
                              (*args[2:], **kwargs) or True))
911
1149
        
912
1150
        logger.debug(u"Starting main loop")
913
 
        main_loop_started = True
914
1151
        main_loop.run()
915
1152
    except AvahiError, error:
916
1153
        logger.critical(u"AvahiError: %s" + unicode(error))