/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-04-16 06:47:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090416064728-c3d36mvgxo5q9aoh
* mandos: Import "SocketServer" as "socketserver" and "ConfigParser"
          as "configparser".  All users changed.

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
58
58
from contextlib import closing
59
59
import struct
60
60
import fcntl
61
 
import functools
62
61
 
63
62
import dbus
64
63
import dbus.service
67
66
from dbus.mainloop.glib import DBusGMainLoop
68
67
import ctypes
69
68
import ctypes.util
70
 
import xml.dom.minidom
71
 
import inspect
72
69
 
73
70
try:
74
71
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
76
73
    try:
77
74
        from IN import SO_BINDTODEVICE
78
75
    except ImportError:
79
 
        SO_BINDTODEVICE = None
80
 
 
81
 
 
82
 
version = "1.0.12"
 
76
        # From /usr/include/asm/socket.h
 
77
        SO_BINDTODEVICE = 25
 
78
 
 
79
 
 
80
version = "1.0.8"
83
81
 
84
82
logger = logging.Logger(u'mandos')
85
83
syslogger = (logging.handlers.SysLogHandler
126
124
    max_renames: integer; maximum number of renames
127
125
    rename_count: integer; counter so we only rename after collisions
128
126
                  a sensible number of times
129
 
    group: D-Bus Entry Group
130
 
    server: D-Bus Server
131
 
    bus: dbus.SystemBus()
132
127
    """
133
128
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
134
129
                 servicetype = None, port = None, TXT = None,
135
130
                 domain = u"", host = u"", max_renames = 32768,
136
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
131
                 protocol = avahi.PROTO_UNSPEC):
137
132
        self.interface = interface
138
133
        self.name = name
139
134
        self.type = servicetype
144
139
        self.rename_count = 0
145
140
        self.max_renames = max_renames
146
141
        self.protocol = protocol
147
 
        self.group = None       # our entry group
148
 
        self.server = None
149
 
        self.bus = bus
150
142
    def rename(self):
151
143
        """Derived from the Avahi example code"""
152
144
        if self.rename_count >= self.max_renames:
154
146
                            u" after %i retries, exiting.",
155
147
                            self.rename_count)
156
148
            raise AvahiServiceError(u"Too many renames")
157
 
        self.name = self.server.GetAlternativeServiceName(self.name)
 
149
        self.name = server.GetAlternativeServiceName(self.name)
158
150
        logger.info(u"Changing Zeroconf service name to %r ...",
159
 
                    unicode(self.name))
 
151
                    self.name)
160
152
        syslogger.setFormatter(logging.Formatter
161
153
                               (u'Mandos (%s) [%%(process)d]:'
162
154
                                u' %%(levelname)s: %%(message)s'
166
158
        self.rename_count += 1
167
159
    def remove(self):
168
160
        """Derived from the Avahi example code"""
169
 
        if self.group is not None:
170
 
            self.group.Reset()
 
161
        if group is not None:
 
162
            group.Reset()
171
163
    def add(self):
172
164
        """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)
 
165
        global group
 
166
        if group is None:
 
167
            group = dbus.Interface(bus.get_object
 
168
                                   (avahi.DBUS_NAME,
 
169
                                    server.EntryGroupNew()),
 
170
                                   avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
171
            group.connect_to_signal('StateChanged',
 
172
                                    entry_group_state_changed)
181
173
        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())
 
174
                     service.name, service.type)
 
175
        group.AddService(
 
176
                self.interface,         # interface
 
177
                self.protocol,          # protocol
 
178
                dbus.UInt32(0),         # flags
 
179
                self.name, self.type,
 
180
                self.domain, self.host,
 
181
                dbus.UInt16(self.port),
 
182
                avahi.string_array_to_txt_array(self.TXT))
 
183
        group.Commit()
 
184
 
 
185
# From the Avahi example code:
 
186
group = None                            # our entry group
 
187
# End of Avahi example code
 
188
 
 
189
 
 
190
def _datetime_to_dbus(dt, variant_level=0):
 
191
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
192
    return dbus.String(dt.isoformat(), variant_level=variant_level)
228
193
 
229
194
 
230
195
class Client(object):
249
214
                                    to see if the client lives.
250
215
                                    'None' if no process is running.
251
216
    checker_initiator_tag: a gobject event source tag, or None
252
 
    disable_initiator_tag: - '' -
 
217
    disable_initiator_tag:    - '' -
253
218
    checker_callback_tag:  - '' -
254
219
    checker_command: string; External command which is run to check if
255
220
                     client lives.  %() expansions are done at
259
224
    """
260
225
    
261
226
    @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))
 
227
    def _datetime_to_milliseconds(dt):
 
228
        "Convert a datetime.datetime() to milliseconds"
 
229
        return ((dt.days * 24 * 60 * 60 * 1000)
 
230
                + (dt.seconds * 1000)
 
231
                + (dt.microseconds // 1000))
267
232
    
268
233
    def timeout_milliseconds(self):
269
234
        "Return the 'timeout' attribute in milliseconds"
270
 
        return self._timedelta_to_milliseconds(self.timeout)
 
235
        return self._datetime_to_milliseconds(self.timeout)
271
236
    
272
237
    def interval_milliseconds(self):
273
238
        "Return the 'interval' attribute in milliseconds"
274
 
        return self._timedelta_to_milliseconds(self.interval)
 
239
        return self._datetime_to_milliseconds(self.interval)
275
240
    
276
241
    def __init__(self, name = None, disable_hook=None, config=None):
277
242
        """Note: the 'checker' key in 'config' sets the
292
257
        elif u"secfile" in config:
293
258
            with closing(open(os.path.expanduser
294
259
                              (os.path.expandvars
295
 
                               (config[u"secfile"])),
296
 
                              "rb")) as secfile:
 
260
                               (config[u"secfile"])))) as secfile:
297
261
                self.secret = secfile.read()
298
262
        else:
299
263
            raise TypeError(u"No secret or secfile for client %s"
316
280
    
317
281
    def enable(self):
318
282
        """Start this client's checker and timeout hooks"""
319
 
        if getattr(self, u"enabled", False):
320
 
            # Already enabled
321
 
            return
322
283
        self.last_enabled = datetime.datetime.utcnow()
323
284
        # Schedule a new checker to be started an 'interval' from now,
324
285
        # and every interval from then on.
399
360
        # is as it should be.
400
361
        
401
362
        # If a checker exists, make sure it is not a zombie
402
 
        try:
 
363
        if self.checker is not None:
403
364
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
404
 
        except (AttributeError, OSError), error:
405
 
            if (isinstance(error, OSError)
406
 
                and error.errno != errno.ECHILD):
407
 
                raise error
408
 
        else:
409
365
            if pid:
410
366
                logger.warning(u"Checker was a zombie")
411
367
                gobject.source_remove(self.checker_callback_tag)
486
442
            return now < (self.last_checked_ok + self.timeout)
487
443
 
488
444
 
489
 
def dbus_service_property(dbus_interface, signature=u"v",
490
 
                          access=u"readwrite", byte_arrays=False):
491
 
    """Decorators for marking methods of a DBusObjectWithProperties to
492
 
    become properties on the D-Bus.
493
 
    
494
 
    The decorated method will be called with no arguments by "Get"
495
 
    and with one argument by "Set".
496
 
    
497
 
    The parameters, where they are supported, are the same as
498
 
    dbus.service.method, except there is only "signature", since the
499
 
    type from Get() and the type sent to Set() is the same.
500
 
    """
501
 
    def decorator(func):
502
 
        func._dbus_is_property = True
503
 
        func._dbus_interface = dbus_interface
504
 
        func._dbus_signature = signature
505
 
        func._dbus_access = access
506
 
        func._dbus_name = func.__name__
507
 
        if func._dbus_name.endswith(u"_dbus_property"):
508
 
            func._dbus_name = func._dbus_name[:-14]
509
 
        func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
510
 
        return func
511
 
    return decorator
512
 
 
513
 
 
514
 
class DBusPropertyException(dbus.exceptions.DBusException):
515
 
    """A base class for D-Bus property-related exceptions
516
 
    """
517
 
    def __unicode__(self):
518
 
        return unicode(str(self))
519
 
 
520
 
 
521
 
class DBusPropertyAccessException(DBusPropertyException):
522
 
    """A property's access permissions disallows an operation.
523
 
    """
524
 
    pass
525
 
 
526
 
 
527
 
class DBusPropertyNotFound(DBusPropertyException):
528
 
    """An attempt was made to access a non-existing property.
529
 
    """
530
 
    pass
531
 
 
532
 
 
533
 
class DBusObjectWithProperties(dbus.service.Object):
534
 
    """A D-Bus object with properties.
535
 
 
536
 
    Classes inheriting from this can use the dbus_service_property
537
 
    decorator to expose methods as D-Bus properties.  It exposes the
538
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
539
 
    """
540
 
    
541
 
    @staticmethod
542
 
    def _is_dbus_property(obj):
543
 
        return getattr(obj, u"_dbus_is_property", False)
544
 
    
545
 
    def _get_all_dbus_properties(self):
546
 
        """Returns a generator of (name, attribute) pairs
547
 
        """
548
 
        return ((prop._dbus_name, prop)
549
 
                for name, prop in
550
 
                inspect.getmembers(self, self._is_dbus_property))
551
 
    
552
 
    def _get_dbus_property(self, interface_name, property_name):
553
 
        """Returns a bound method if one exists which is a D-Bus
554
 
        property with the specified name and interface.
555
 
        """
556
 
        for name in (property_name,
557
 
                     property_name + u"_dbus_property"):
558
 
            prop = getattr(self, name, None)
559
 
            if (prop is None
560
 
                or not self._is_dbus_property(prop)
561
 
                or prop._dbus_name != property_name
562
 
                or (interface_name and prop._dbus_interface
563
 
                    and interface_name != prop._dbus_interface)):
564
 
                continue
565
 
            return prop
566
 
        # No such property
567
 
        raise DBusPropertyNotFound(self.dbus_object_path + u":"
568
 
                                   + interface_name + u"."
569
 
                                   + property_name)
570
 
    
571
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
572
 
                         out_signature=u"v")
573
 
    def Get(self, interface_name, property_name):
574
 
        """Standard D-Bus property Get() method, see D-Bus standard.
575
 
        """
576
 
        prop = self._get_dbus_property(interface_name, property_name)
577
 
        if prop._dbus_access == u"write":
578
 
            raise DBusPropertyAccessException(property_name)
579
 
        value = prop()
580
 
        if not hasattr(value, u"variant_level"):
581
 
            return value
582
 
        return type(value)(value, variant_level=value.variant_level+1)
583
 
    
584
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
585
 
    def Set(self, interface_name, property_name, value):
586
 
        """Standard D-Bus property Set() method, see D-Bus standard.
587
 
        """
588
 
        prop = self._get_dbus_property(interface_name, property_name)
589
 
        if prop._dbus_access == u"read":
590
 
            raise DBusPropertyAccessException(property_name)
591
 
        if prop._dbus_get_args_options[u"byte_arrays"]:
592
 
            value = dbus.ByteArray(''.join(unichr(byte)
593
 
                                           for byte in value))
594
 
        prop(value)
595
 
    
596
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
597
 
                         out_signature=u"a{sv}")
598
 
    def GetAll(self, interface_name):
599
 
        """Standard D-Bus property GetAll() method, see D-Bus
600
 
        standard.
601
 
 
602
 
        Note: Will not include properties with access="write".
603
 
        """
604
 
        all = {}
605
 
        for name, prop in self._get_all_dbus_properties():
606
 
            if (interface_name
607
 
                and interface_name != prop._dbus_interface):
608
 
                # Interface non-empty but did not match
609
 
                continue
610
 
            # Ignore write-only properties
611
 
            if prop._dbus_access == u"write":
612
 
                continue
613
 
            value = prop()
614
 
            if not hasattr(value, u"variant_level"):
615
 
                all[name] = value
616
 
                continue
617
 
            all[name] = type(value)(value, variant_level=
618
 
                                    value.variant_level+1)
619
 
        return dbus.Dictionary(all, signature=u"sv")
620
 
    
621
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
622
 
                         out_signature=u"s",
623
 
                         path_keyword='object_path',
624
 
                         connection_keyword='connection')
625
 
    def Introspect(self, object_path, connection):
626
 
        """Standard D-Bus method, overloaded to insert property tags.
627
 
        """
628
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
629
 
                                                   connection)
630
 
        try:
631
 
            document = xml.dom.minidom.parseString(xmlstring)
632
 
            def make_tag(document, name, prop):
633
 
                e = document.createElement(u"property")
634
 
                e.setAttribute(u"name", name)
635
 
                e.setAttribute(u"type", prop._dbus_signature)
636
 
                e.setAttribute(u"access", prop._dbus_access)
637
 
                return e
638
 
            for if_tag in document.getElementsByTagName(u"interface"):
639
 
                for tag in (make_tag(document, name, prop)
640
 
                            for name, prop
641
 
                            in self._get_all_dbus_properties()
642
 
                            if prop._dbus_interface
643
 
                            == if_tag.getAttribute(u"name")):
644
 
                    if_tag.appendChild(tag)
645
 
                # Add the names to the return values for the
646
 
                # "org.freedesktop.DBus.Properties" methods
647
 
                if (if_tag.getAttribute(u"name")
648
 
                    == u"org.freedesktop.DBus.Properties"):
649
 
                    for cn in if_tag.getElementsByTagName(u"method"):
650
 
                        if cn.getAttribute(u"name") == u"Get":
651
 
                            for arg in cn.getElementsByTagName(u"arg"):
652
 
                                if (arg.getAttribute(u"direction")
653
 
                                    == u"out"):
654
 
                                    arg.setAttribute(u"name", u"value")
655
 
                        elif cn.getAttribute(u"name") == u"GetAll":
656
 
                            for arg in cn.getElementsByTagName(u"arg"):
657
 
                                if (arg.getAttribute(u"direction")
658
 
                                    == u"out"):
659
 
                                    arg.setAttribute(u"name", u"props")
660
 
            xmlstring = document.toxml(u"utf-8")
661
 
            document.unlink()
662
 
        except (AttributeError, xml.dom.DOMException,
663
 
                xml.parsers.expat.ExpatError), error:
664
 
            logger.error(u"Failed to override Introspection method",
665
 
                         error)
666
 
        return xmlstring
667
 
 
668
 
 
669
 
class ClientDBus(Client, DBusObjectWithProperties):
 
445
class ClientDBus(Client, dbus.service.Object):
670
446
    """A Client class using D-Bus
671
447
    
672
448
    Attributes:
673
 
    dbus_object_path: dbus.ObjectPath
674
 
    bus: dbus.SystemBus()
 
449
    dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
675
450
    """
676
451
    # dbus.service.Object doesn't use super(), so we can't either.
677
452
    
678
 
    def __init__(self, bus = None, *args, **kwargs):
679
 
        self.bus = bus
 
453
    def __init__(self, *args, **kwargs):
680
454
        Client.__init__(self, *args, **kwargs)
681
455
        # Only now, when this client is initialized, can it show up on
682
456
        # the D-Bus
683
457
        self.dbus_object_path = (dbus.ObjectPath
684
458
                                 (u"/clients/"
685
459
                                  + self.name.replace(u".", u"_")))
686
 
        DBusObjectWithProperties.__init__(self, self.bus,
687
 
                                          self.dbus_object_path)
688
 
    
689
 
    @staticmethod
690
 
    def _datetime_to_dbus(dt, variant_level=0):
691
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
692
 
        return dbus.String(dt.isoformat(),
693
 
                           variant_level=variant_level)
694
 
    
 
460
        dbus.service.Object.__init__(self, bus,
 
461
                                     self.dbus_object_path)
695
462
    def enable(self):
696
463
        oldstate = getattr(self, u"enabled", False)
697
464
        r = Client.enable(self)
699
466
            # Emit D-Bus signals
700
467
            self.PropertyChanged(dbus.String(u"enabled"),
701
468
                                 dbus.Boolean(True, variant_level=1))
702
 
            self.PropertyChanged(
703
 
                dbus.String(u"last_enabled"),
704
 
                self._datetime_to_dbus(self.last_enabled,
705
 
                                       variant_level=1))
 
469
            self.PropertyChanged(dbus.String(u"last_enabled"),
 
470
                                 (_datetime_to_dbus(self.last_enabled,
 
471
                                                    variant_level=1)))
706
472
        return r
707
473
    
708
474
    def disable(self, signal = True):
719
485
            self.remove_from_connection()
720
486
        except LookupError:
721
487
            pass
722
 
        if hasattr(DBusObjectWithProperties, u"__del__"):
723
 
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
 
488
        if hasattr(dbus.service.Object, u"__del__"):
 
489
            dbus.service.Object.__del__(self, *args, **kwargs)
724
490
        Client.__del__(self, *args, **kwargs)
725
491
    
726
492
    def checker_callback(self, pid, condition, command,
750
516
        # Emit D-Bus signal
751
517
        self.PropertyChanged(
752
518
            dbus.String(u"last_checked_ok"),
753
 
            (self._datetime_to_dbus(self.last_checked_ok,
754
 
                                    variant_level=1)))
 
519
            (_datetime_to_dbus(self.last_checked_ok,
 
520
                               variant_level=1)))
755
521
        return r
756
522
    
757
523
    def start_checker(self, *args, **kwargs):
800
566
        "D-Bus signal"
801
567
        pass
802
568
    
 
569
    # GetAllProperties - method
 
570
    @dbus.service.method(_interface, out_signature=u"a{sv}")
 
571
    def GetAllProperties(self):
 
572
        "D-Bus method"
 
573
        return dbus.Dictionary({
 
574
                dbus.String(u"name"):
 
575
                    dbus.String(self.name, variant_level=1),
 
576
                dbus.String(u"fingerprint"):
 
577
                    dbus.String(self.fingerprint, variant_level=1),
 
578
                dbus.String(u"host"):
 
579
                    dbus.String(self.host, variant_level=1),
 
580
                dbus.String(u"created"):
 
581
                    _datetime_to_dbus(self.created, variant_level=1),
 
582
                dbus.String(u"last_enabled"):
 
583
                    (_datetime_to_dbus(self.last_enabled,
 
584
                                       variant_level=1)
 
585
                     if self.last_enabled is not None
 
586
                     else dbus.Boolean(False, variant_level=1)),
 
587
                dbus.String(u"enabled"):
 
588
                    dbus.Boolean(self.enabled, variant_level=1),
 
589
                dbus.String(u"last_checked_ok"):
 
590
                    (_datetime_to_dbus(self.last_checked_ok,
 
591
                                       variant_level=1)
 
592
                     if self.last_checked_ok is not None
 
593
                     else dbus.Boolean (False, variant_level=1)),
 
594
                dbus.String(u"timeout"):
 
595
                    dbus.UInt64(self.timeout_milliseconds(),
 
596
                                variant_level=1),
 
597
                dbus.String(u"interval"):
 
598
                    dbus.UInt64(self.interval_milliseconds(),
 
599
                                variant_level=1),
 
600
                dbus.String(u"checker"):
 
601
                    dbus.String(self.checker_command,
 
602
                                variant_level=1),
 
603
                dbus.String(u"checker_running"):
 
604
                    dbus.Boolean(self.checker is not None,
 
605
                                 variant_level=1),
 
606
                dbus.String(u"object_path"):
 
607
                    dbus.ObjectPath(self.dbus_object_path,
 
608
                                    variant_level=1)
 
609
                }, signature=u"sv")
 
610
    
 
611
    # IsStillValid - method
 
612
    @dbus.service.method(_interface, out_signature=u"b")
 
613
    def IsStillValid(self):
 
614
        return self.still_valid()
 
615
    
803
616
    # PropertyChanged - signal
804
617
    @dbus.service.signal(_interface, signature=u"sv")
805
618
    def PropertyChanged(self, property, value):
806
619
        "D-Bus signal"
807
620
        pass
808
621
    
809
 
    # GotSecret - signal
 
622
    # ReceivedSecret - signal
810
623
    @dbus.service.signal(_interface)
811
 
    def GotSecret(self):
 
624
    def ReceivedSecret(self):
812
625
        "D-Bus signal"
813
626
        pass
814
627
    
818
631
        "D-Bus signal"
819
632
        pass
820
633
    
 
634
    # SetChecker - method
 
635
    @dbus.service.method(_interface, in_signature=u"s")
 
636
    def SetChecker(self, checker):
 
637
        "D-Bus setter method"
 
638
        self.checker_command = checker
 
639
        # Emit D-Bus signal
 
640
        self.PropertyChanged(dbus.String(u"checker"),
 
641
                             dbus.String(self.checker_command,
 
642
                                         variant_level=1))
 
643
    
 
644
    # SetHost - method
 
645
    @dbus.service.method(_interface, in_signature=u"s")
 
646
    def SetHost(self, host):
 
647
        "D-Bus setter method"
 
648
        self.host = host
 
649
        # Emit D-Bus signal
 
650
        self.PropertyChanged(dbus.String(u"host"),
 
651
                             dbus.String(self.host, variant_level=1))
 
652
    
 
653
    # SetInterval - method
 
654
    @dbus.service.method(_interface, in_signature=u"t")
 
655
    def SetInterval(self, milliseconds):
 
656
        self.interval = datetime.timedelta(0, 0, 0, milliseconds)
 
657
        # Emit D-Bus signal
 
658
        self.PropertyChanged(dbus.String(u"interval"),
 
659
                             (dbus.UInt64(self.interval_milliseconds(),
 
660
                                          variant_level=1)))
 
661
    
 
662
    # SetSecret - method
 
663
    @dbus.service.method(_interface, in_signature=u"ay",
 
664
                         byte_arrays=True)
 
665
    def SetSecret(self, secret):
 
666
        "D-Bus setter method"
 
667
        self.secret = str(secret)
 
668
    
 
669
    # SetTimeout - method
 
670
    @dbus.service.method(_interface, in_signature=u"t")
 
671
    def SetTimeout(self, milliseconds):
 
672
        self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
 
673
        # Emit D-Bus signal
 
674
        self.PropertyChanged(dbus.String(u"timeout"),
 
675
                             (dbus.UInt64(self.timeout_milliseconds(),
 
676
                                          variant_level=1)))
 
677
    
821
678
    # Enable - method
822
679
    @dbus.service.method(_interface)
823
680
    def Enable(self):
841
698
    def StopChecker(self):
842
699
        self.stop_checker()
843
700
    
844
 
    # name - property
845
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
846
 
    def name_dbus_property(self):
847
 
        return dbus.String(self.name)
848
 
    
849
 
    # fingerprint - property
850
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
851
 
    def fingerprint_dbus_property(self):
852
 
        return dbus.String(self.fingerprint)
853
 
    
854
 
    # host - property
855
 
    @dbus_service_property(_interface, signature=u"s",
856
 
                           access=u"readwrite")
857
 
    def host_dbus_property(self, value=None):
858
 
        if value is None:       # get
859
 
            return dbus.String(self.host)
860
 
        self.host = value
861
 
        # Emit D-Bus signal
862
 
        self.PropertyChanged(dbus.String(u"host"),
863
 
                             dbus.String(value, variant_level=1))
864
 
    
865
 
    # created - property
866
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
867
 
    def created_dbus_property(self):
868
 
        return dbus.String(self._datetime_to_dbus(self.created))
869
 
    
870
 
    # last_enabled - property
871
 
    @dbus_service_property(_interface, signature=u"s", access=u"read")
872
 
    def last_enabled_dbus_property(self):
873
 
        if self.last_enabled is None:
874
 
            return dbus.String(u"")
875
 
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
876
 
    
877
 
    # enabled - property
878
 
    @dbus_service_property(_interface, signature=u"b",
879
 
                           access=u"readwrite")
880
 
    def enabled_dbus_property(self, value=None):
881
 
        if value is None:       # get
882
 
            return dbus.Boolean(self.enabled)
883
 
        if value:
884
 
            self.enable()
885
 
        else:
886
 
            self.disable()
887
 
    
888
 
    # last_checked_ok - property
889
 
    @dbus_service_property(_interface, signature=u"s",
890
 
                           access=u"readwrite")
891
 
    def last_checked_ok_dbus_property(self, value=None):
892
 
        if value is not None:
893
 
            self.checked_ok()
894
 
            return
895
 
        if self.last_checked_ok is None:
896
 
            return dbus.String(u"")
897
 
        return dbus.String(self._datetime_to_dbus(self
898
 
                                                  .last_checked_ok))
899
 
    
900
 
    # timeout - property
901
 
    @dbus_service_property(_interface, signature=u"t",
902
 
                           access=u"readwrite")
903
 
    def timeout_dbus_property(self, value=None):
904
 
        if value is None:       # get
905
 
            return dbus.UInt64(self.timeout_milliseconds())
906
 
        self.timeout = datetime.timedelta(0, 0, 0, value)
907
 
        # Emit D-Bus signal
908
 
        self.PropertyChanged(dbus.String(u"timeout"),
909
 
                             dbus.UInt64(value, variant_level=1))
910
 
        if getattr(self, u"disable_initiator_tag", None) is None:
911
 
            return
912
 
        # Reschedule timeout
913
 
        gobject.source_remove(self.disable_initiator_tag)
914
 
        self.disable_initiator_tag = None
915
 
        time_to_die = (self.
916
 
                       _timedelta_to_milliseconds((self
917
 
                                                   .last_checked_ok
918
 
                                                   + self.timeout)
919
 
                                                  - datetime.datetime
920
 
                                                  .utcnow()))
921
 
        if time_to_die <= 0:
922
 
            # The timeout has passed
923
 
            self.disable()
924
 
        else:
925
 
            self.disable_initiator_tag = (gobject.timeout_add
926
 
                                          (time_to_die, self.disable))
927
 
    
928
 
    # interval - property
929
 
    @dbus_service_property(_interface, signature=u"t",
930
 
                           access=u"readwrite")
931
 
    def interval_dbus_property(self, value=None):
932
 
        if value is None:       # get
933
 
            return dbus.UInt64(self.interval_milliseconds())
934
 
        self.interval = datetime.timedelta(0, 0, 0, value)
935
 
        # Emit D-Bus signal
936
 
        self.PropertyChanged(dbus.String(u"interval"),
937
 
                             dbus.UInt64(value, variant_level=1))
938
 
        if getattr(self, u"checker_initiator_tag", None) is None:
939
 
            return
940
 
        # Reschedule checker run
941
 
        gobject.source_remove(self.checker_initiator_tag)
942
 
        self.checker_initiator_tag = (gobject.timeout_add
943
 
                                      (value, self.start_checker))
944
 
        self.start_checker()    # Start one now, too
945
 
 
946
 
    # checker - property
947
 
    @dbus_service_property(_interface, signature=u"s",
948
 
                           access=u"readwrite")
949
 
    def checker_dbus_property(self, value=None):
950
 
        if value is None:       # get
951
 
            return dbus.String(self.checker_command)
952
 
        self.checker_command = value
953
 
        # Emit D-Bus signal
954
 
        self.PropertyChanged(dbus.String(u"checker"),
955
 
                             dbus.String(self.checker_command,
956
 
                                         variant_level=1))
957
 
    
958
 
    # checker_running - property
959
 
    @dbus_service_property(_interface, signature=u"b",
960
 
                           access=u"readwrite")
961
 
    def checker_running_dbus_property(self, value=None):
962
 
        if value is None:       # get
963
 
            return dbus.Boolean(self.checker is not None)
964
 
        if value:
965
 
            self.start_checker()
966
 
        else:
967
 
            self.stop_checker()
968
 
    
969
 
    # object_path - property
970
 
    @dbus_service_property(_interface, signature=u"o", access=u"read")
971
 
    def object_path_dbus_property(self):
972
 
        return self.dbus_object_path # is already a dbus.ObjectPath
973
 
    
974
 
    # secret = property
975
 
    @dbus_service_property(_interface, signature=u"ay",
976
 
                           access=u"write", byte_arrays=True)
977
 
    def secret_dbus_property(self, value):
978
 
        self.secret = str(value)
979
 
    
980
701
    del _interface
981
702
 
982
703
 
1044
765
                    client = c
1045
766
                    break
1046
767
            else:
1047
 
                ipc.write(u"NOTFOUND %s %s\n"
1048
 
                          % (fpr, unicode(self.client_address)))
 
768
                ipc.write(u"NOTFOUND %s\n" % fpr)
1049
769
                session.bye()
1050
770
                return
1051
771
            # Have to check if client.still_valid(), since it is
1130
850
 
1131
851
 
1132
852
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
1133
 
    """Like socketserver.ForkingMixIn, but also pass a pipe."""
 
853
    """Like socketserver.ForkingMixIn, but also pass a pipe.
 
854
    
 
855
    Assumes a gobject.MainLoop event loop.
 
856
    """
1134
857
    def process_request(self, request, client_address):
1135
858
        """Overrides and wraps the original process_request().
1136
859
        
1137
 
        This function creates a new pipe in self.pipe
 
860
        This function creates a new pipe in self.pipe 
1138
861
        """
1139
862
        self.pipe = os.pipe()
1140
863
        super(ForkingMixInWithPipe,
1141
864
              self).process_request(request, client_address)
1142
865
        os.close(self.pipe[1])  # close write end
1143
 
        self.add_pipe(self.pipe[0])
1144
 
    def add_pipe(self, pipe):
 
866
        # Call "handle_ipc" for both data and EOF events
 
867
        gobject.io_add_watch(self.pipe[0],
 
868
                             gobject.IO_IN | gobject.IO_HUP,
 
869
                             self.handle_ipc)
 
870
    def handle_ipc(source, condition):
1145
871
        """Dummy function; override as necessary"""
1146
 
        os.close(pipe)
 
872
        os.close(source)
 
873
        return False
1147
874
 
1148
875
 
1149
876
class IPv6_TCPServer(ForkingMixInWithPipe,
1154
881
        enabled:        Boolean; whether this server is activated yet
1155
882
        interface:      None or a network interface name (string)
1156
883
        use_ipv6:       Boolean; to use IPv6 or not
 
884
        ----
 
885
        clients:        set of Client objects
 
886
        gnutls_priority GnuTLS priority string
 
887
        use_dbus:       Boolean; to emit D-Bus signals or not
1157
888
    """
1158
889
    def __init__(self, server_address, RequestHandlerClass,
1159
 
                 interface=None, use_ipv6=True):
 
890
                 interface=None, use_ipv6=True, clients=None,
 
891
                 gnutls_priority=None, use_dbus=True):
 
892
        self.enabled = False
1160
893
        self.interface = interface
1161
894
        if use_ipv6:
1162
895
            self.address_family = socket.AF_INET6
 
896
        self.clients = clients
 
897
        self.use_dbus = use_dbus
 
898
        self.gnutls_priority = gnutls_priority
1163
899
        socketserver.TCPServer.__init__(self, server_address,
1164
900
                                        RequestHandlerClass)
1165
901
    def server_bind(self):
1167
903
        to bind to an interface if one was specified, and also NOT to
1168
904
        bind to an address or port if they were not specified."""
1169
905
        if self.interface is not None:
1170
 
            if SO_BINDTODEVICE is None:
1171
 
                logger.error(u"SO_BINDTODEVICE does not exist;"
1172
 
                             u" cannot bind to interface %s",
1173
 
                             self.interface)
1174
 
            else:
1175
 
                try:
1176
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1177
 
                                           SO_BINDTODEVICE,
1178
 
                                           str(self.interface
1179
 
                                               + u'\0'))
1180
 
                except socket.error, error:
1181
 
                    if error[0] == errno.EPERM:
1182
 
                        logger.error(u"No permission to"
1183
 
                                     u" bind to interface %s",
1184
 
                                     self.interface)
1185
 
                    elif error[0] == errno.ENOPROTOOPT:
1186
 
                        logger.error(u"SO_BINDTODEVICE not available;"
1187
 
                                     u" cannot bind to interface %s",
1188
 
                                     self.interface)
1189
 
                    else:
1190
 
                        raise
 
906
            try:
 
907
                self.socket.setsockopt(socket.SOL_SOCKET,
 
908
                                       SO_BINDTODEVICE,
 
909
                                       str(self.interface + u'\0'))
 
910
            except socket.error, error:
 
911
                if error[0] == errno.EPERM:
 
912
                    logger.error(u"No permission to"
 
913
                                 u" bind to interface %s",
 
914
                                 self.interface)
 
915
                else:
 
916
                    raise
1191
917
        # Only bind(2) the socket if we really need to.
1192
918
        if self.server_address[0] or self.server_address[1]:
1193
919
            if not self.server_address[0]:
1207
933
#                                            if_nametoindex
1208
934
#                                            (self.interface))
1209
935
            return socketserver.TCPServer.server_bind(self)
1210
 
 
1211
 
 
1212
 
class MandosServer(IPv6_TCPServer):
1213
 
    """Mandos server.
1214
 
    
1215
 
    Attributes:
1216
 
        clients:        set of Client objects
1217
 
        gnutls_priority GnuTLS priority string
1218
 
        use_dbus:       Boolean; to emit D-Bus signals or not
1219
 
    
1220
 
    Assumes a gobject.MainLoop event loop.
1221
 
    """
1222
 
    def __init__(self, server_address, RequestHandlerClass,
1223
 
                 interface=None, use_ipv6=True, clients=None,
1224
 
                 gnutls_priority=None, use_dbus=True):
1225
 
        self.enabled = False
1226
 
        self.clients = clients
1227
 
        if self.clients is None:
1228
 
            self.clients = set()
1229
 
        self.use_dbus = use_dbus
1230
 
        self.gnutls_priority = gnutls_priority
1231
 
        IPv6_TCPServer.__init__(self, server_address,
1232
 
                                RequestHandlerClass,
1233
 
                                interface = interface,
1234
 
                                use_ipv6 = use_ipv6)
1235
936
    def server_activate(self):
1236
937
        if self.enabled:
1237
938
            return socketserver.TCPServer.server_activate(self)
1238
939
    def enable(self):
1239
940
        self.enabled = True
1240
 
    def add_pipe(self, pipe):
1241
 
        # Call "handle_ipc" for both data and EOF events
1242
 
        gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1243
 
                             self.handle_ipc)
1244
941
    def handle_ipc(self, source, condition, file_objects={}):
1245
942
        condition_names = {
1246
943
            gobject.IO_IN: u"IN",   # There is data to read.
1301
998
                    client.checked_ok()
1302
999
                    if self.use_dbus:
1303
1000
                        # Emit D-Bus signal
1304
 
                        client.GotSecret()
 
1001
                        client.ReceivedSecret()
1305
1002
                    break
1306
1003
            else:
1307
1004
                logger.error(u"Sending secret to unknown client %s",
1352
1049
    return timevalue
1353
1050
 
1354
1051
 
 
1052
def server_state_changed(state):
 
1053
    """Derived from the Avahi example code"""
 
1054
    if state == avahi.SERVER_COLLISION:
 
1055
        logger.error(u"Zeroconf server name collision")
 
1056
        service.remove()
 
1057
    elif state == avahi.SERVER_RUNNING:
 
1058
        service.add()
 
1059
 
 
1060
 
 
1061
def entry_group_state_changed(state, error):
 
1062
    """Derived from the Avahi example code"""
 
1063
    logger.debug(u"Avahi state change: %i", state)
 
1064
    
 
1065
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
1066
        logger.debug(u"Zeroconf service established.")
 
1067
    elif state == avahi.ENTRY_GROUP_COLLISION:
 
1068
        logger.warning(u"Zeroconf service name collision.")
 
1069
        service.rename()
 
1070
    elif state == avahi.ENTRY_GROUP_FAILURE:
 
1071
        logger.critical(u"Avahi: Error in group state changed %s",
 
1072
                        unicode(error))
 
1073
        raise AvahiGroupError(u"State changed: %s" % unicode(error))
 
1074
 
1355
1075
def if_nametoindex(interface):
1356
1076
    """Call the C function if_nametoindex(), or equivalent
1357
1077
    
1402
1122
 
1403
1123
def main():
1404
1124
    
1405
 
    ##################################################################
 
1125
    ######################################################################
1406
1126
    # Parsing of options, both command line and config file
1407
1127
    
1408
1128
    parser = optparse.OptionParser(version = "%%prog %s" % version)
1510
1230
    global mandos_dbus_service
1511
1231
    mandos_dbus_service = None
1512
1232
    
1513
 
    tcp_server = MandosServer((server_settings[u"address"],
1514
 
                               server_settings[u"port"]),
1515
 
                              ClientHandler,
1516
 
                              interface=server_settings[u"interface"],
1517
 
                              use_ipv6=use_ipv6,
1518
 
                              gnutls_priority=
1519
 
                              server_settings[u"priority"],
1520
 
                              use_dbus=use_dbus)
 
1233
    clients = set()
 
1234
    tcp_server = IPv6_TCPServer((server_settings[u"address"],
 
1235
                                 server_settings[u"port"]),
 
1236
                                ClientHandler,
 
1237
                                interface=
 
1238
                                server_settings[u"interface"],
 
1239
                                use_ipv6=use_ipv6,
 
1240
                                clients=clients,
 
1241
                                gnutls_priority=
 
1242
                                server_settings[u"priority"],
 
1243
                                use_dbus=use_dbus)
1521
1244
    pidfilename = u"/var/run/mandos.pid"
1522
1245
    try:
1523
1246
        pidfile = open(pidfilename, u"w")
1558
1281
        (gnutls.library.functions
1559
1282
         .gnutls_global_set_log_function(debug_gnutls))
1560
1283
    
 
1284
    global service
 
1285
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
1286
    service = AvahiService(name = server_settings[u"servicename"],
 
1287
                           servicetype = u"_mandos._tcp",
 
1288
                           protocol = protocol)
 
1289
    if server_settings["interface"]:
 
1290
        service.interface = (if_nametoindex
 
1291
                             (str(server_settings[u"interface"])))
 
1292
    
1561
1293
    global main_loop
 
1294
    global bus
 
1295
    global server
1562
1296
    # From the Avahi example code
1563
1297
    DBusGMainLoop(set_as_default=True )
1564
1298
    main_loop = gobject.MainLoop()
1565
1299
    bus = dbus.SystemBus()
 
1300
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
 
1301
                                           avahi.DBUS_PATH_SERVER),
 
1302
                            avahi.DBUS_INTERFACE_SERVER)
1566
1303
    # End of Avahi example code
1567
1304
    if use_dbus:
1568
1305
        bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1569
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1570
 
    service = AvahiService(name = server_settings[u"servicename"],
1571
 
                           servicetype = u"_mandos._tcp",
1572
 
                           protocol = protocol, bus = bus)
1573
 
    if server_settings["interface"]:
1574
 
        service.interface = (if_nametoindex
1575
 
                             (str(server_settings[u"interface"])))
1576
1306
    
1577
1307
    client_class = Client
1578
1308
    if use_dbus:
1579
 
        client_class = functools.partial(ClientDBus, bus = bus)
1580
 
    tcp_server.clients.update(set(
 
1309
        client_class = ClientDBus
 
1310
    clients.update(set(
1581
1311
            client_class(name = section,
1582
1312
                         config= dict(client_config.items(section)))
1583
1313
            for section in client_config.sections()))
1584
 
    if not tcp_server.clients:
 
1314
    if not clients:
1585
1315
        logger.warning(u"No clients defined")
1586
1316
    
1587
1317
    if debug:
1611
1341
    
1612
1342
    def cleanup():
1613
1343
        "Cleanup function; run on exit"
1614
 
        service.cleanup()
 
1344
        global group
 
1345
        # From the Avahi example code
 
1346
        if not group is None:
 
1347
            group.Free()
 
1348
            group = None
 
1349
        # End of Avahi example code
1615
1350
        
1616
 
        while tcp_server.clients:
1617
 
            client = tcp_server.clients.pop()
 
1351
        while clients:
 
1352
            client = clients.pop()
1618
1353
            client.disable_hook = None
1619
1354
            client.disable()
1620
1355
    
1650
1385
            @dbus.service.method(_interface, out_signature=u"ao")
1651
1386
            def GetAllClients(self):
1652
1387
                "D-Bus method"
1653
 
                return dbus.Array(c.dbus_object_path
1654
 
                                  for c in tcp_server.clients)
 
1388
                return dbus.Array(c.dbus_object_path for c in clients)
1655
1389
            
1656
1390
            @dbus.service.method(_interface,
1657
1391
                                 out_signature=u"a{oa{sv}}")
1658
1392
            def GetAllClientsWithProperties(self):
1659
1393
                "D-Bus method"
1660
1394
                return dbus.Dictionary(
1661
 
                    ((c.dbus_object_path, c.GetAll(u""))
1662
 
                     for c in tcp_server.clients),
 
1395
                    ((c.dbus_object_path, c.GetAllProperties())
 
1396
                     for c in clients),
1663
1397
                    signature=u"oa{sv}")
1664
1398
            
1665
1399
            @dbus.service.method(_interface, in_signature=u"o")
1666
1400
            def RemoveClient(self, object_path):
1667
1401
                "D-Bus method"
1668
 
                for c in tcp_server.clients:
 
1402
                for c in clients:
1669
1403
                    if c.dbus_object_path == object_path:
1670
 
                        tcp_server.clients.remove(c)
 
1404
                        clients.remove(c)
1671
1405
                        c.remove_from_connection()
1672
1406
                        # Don't signal anything except ClientRemoved
1673
1407
                        c.disable(signal=False)
1680
1414
        
1681
1415
        mandos_dbus_service = MandosDBusService()
1682
1416
    
1683
 
    for client in tcp_server.clients:
 
1417
    for client in clients:
1684
1418
        if use_dbus:
1685
1419
            # Emit D-Bus signal
1686
1420
            mandos_dbus_service.ClientAdded(client.dbus_object_path,
1687
 
                                            client.GetAll(u""))
 
1421
                                            client.GetAllProperties())
1688
1422
        client.enable()
1689
1423
    
1690
1424
    tcp_server.enable()
1704
1438
    
1705
1439
    try:
1706
1440
        # From the Avahi example code
 
1441
        server.connect_to_signal(u"StateChanged", server_state_changed)
1707
1442
        try:
1708
 
            service.activate()
 
1443
            server_state_changed(server.GetState())
1709
1444
        except dbus.exceptions.DBusException, error:
1710
1445
            logger.critical(u"DBusException: %s", error)
1711
1446
            sys.exit(1)