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
 
# following functions: "add_service", "remove_service",
 
 
9
# following functions: "AvahiService.add", "AvahiService.remove",
 
10
10
# "server_state_changed", "entry_group_state_changed", and some lines
 
13
 
# Everything else is Copyright © 2007-2008 Teddy Hogeborn and Björn
 
 
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
16
16
# This program is free software: you can redistribute it and/or modify
 
17
17
# it under the terms of the GNU General Public License as published by
 
 
82
81
logger.addHandler(syslogger)
 
85
 
# This variable is used to optionally bind to a specified interface.
 
86
 
# It is a global variable to fit in with the other variables from the
 
88
 
serviceInterface = avahi.IF_UNSPEC
 
 
85
class AvahiError(Exception):
 
 
86
    def __init__(self, value):
 
 
89
        return repr(self.value)
 
 
91
class AvahiServiceError(AvahiError):
 
 
94
class AvahiGroupError(AvahiError):
 
 
98
class AvahiService(object):
 
 
100
    interface: integer; avahi.IF_UNSPEC or an interface index.
 
 
101
               Used to optionally bind to the specified interface.
 
 
102
    name = string; Example: "Mandos"
 
 
103
    type = string; Example: "_mandos._tcp".
 
 
104
                   See <http://www.dns-sd.org/ServiceTypes.html>
 
 
105
    port = integer; what port to announce
 
 
106
    TXT = list of strings; TXT record for the service
 
 
107
    domain = string; Domain to publish on, default to .local if empty.
 
 
108
    host = string; Host to publish records for, default to localhost
 
 
110
    max_renames = integer; maximum number of renames
 
 
111
    rename_count = integer; counter so we only rename after collisions
 
 
112
                   a sensible number of times
 
 
114
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
 
 
115
                 type = None, port = None, TXT = None, domain = "",
 
 
116
                 host = "", max_renames = 12):
 
 
117
        """An Avahi (Zeroconf) service. """
 
 
118
        self.interface = interface
 
 
128
        self.rename_count = 0
 
 
130
        """Derived from the Avahi example code"""
 
 
131
        if self.rename_count >= self.max_renames:
 
 
132
            logger.critical(u"No suitable service name found after %i"
 
 
133
                            u" retries, exiting.", rename_count)
 
 
134
            raise AvahiServiceError("Too many renames")
 
 
135
        name = server.GetAlternativeServiceName(name)
 
 
136
        logger.notice(u"Changing name to %r ...", name)
 
 
139
        self.rename_count += 1
 
 
141
        """Derived from the Avahi example code"""
 
 
142
        if group is not None:
 
 
145
        """Derived from the Avahi example code"""
 
 
148
            group = dbus.Interface\
 
 
149
                    (bus.get_object(avahi.DBUS_NAME,
 
 
150
                                    server.EntryGroupNew()),
 
 
151
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
 
152
            group.connect_to_signal('StateChanged',
 
 
153
                                    entry_group_state_changed)
 
 
154
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
 
155
                     service.name, service.type)
 
 
157
                self.interface,         # interface
 
 
158
                avahi.PROTO_INET6,      # protocol
 
 
159
                dbus.UInt32(0),         # flags
 
 
160
                self.name, self.type,
 
 
161
                self.domain, self.host,
 
 
162
                dbus.UInt16(self.port),
 
 
163
                avahi.string_array_to_txt_array(self.TXT))
 
89
166
# From the Avahi example code:
 
91
 
serviceType = "_mandos._tcp" # http://www.dns-sd.org/ServiceTypes.html
 
92
 
servicePort = None                      # Not known at startup
 
93
 
serviceTXT = []                         # TXT record for the service
 
94
 
domain = ""                  # Domain to publish on, default to .local
 
95
 
host = ""          # Host to publish records for, default to localhost
 
96
 
group = None #our entry group
 
97
 
rename_count = 12       # Counter so we only rename after collisions a
 
98
 
                        # sensible number of times
 
 
167
group = None                            # our entry group
 
99
168
# End of Avahi example code
 
 
107
176
                 uniquely identify the client
 
108
177
    secret:    bytestring; sent verbatim (over TLS) to client
 
109
178
    fqdn:      string (FQDN); available for use by the checker command
 
110
 
    created:   datetime.datetime()
 
111
 
    last_seen: datetime.datetime() or None if not yet seen
 
112
 
    timeout:   datetime.timedelta(); How long from last_seen until
 
113
 
                                     this client is invalid
 
 
179
    created:   datetime.datetime(); object creation, not client host
 
 
180
    last_checked_ok: datetime.datetime() or None if not yet checked OK
 
 
181
    timeout:   datetime.timedelta(); How long from last_checked_ok
 
 
182
                                     until this client is invalid
 
114
183
    interval:  datetime.timedelta(); How often to start a new checker
 
115
184
    stop_hook: If set, called by stop() as stop_hook(self)
 
116
185
    checker:   subprocess.Popen(); a running checker process used
 
117
186
                                   to see if the client lives.
 
118
 
                                   Is None if no process is running.
 
 
187
                                   'None' if no process is running.
 
119
188
    checker_initiator_tag: a gobject event source tag, or None
 
120
189
    stop_initiator_tag:    - '' -
 
121
190
    checker_callback_tag:  - '' -
 
122
191
    checker_command: string; External command which is run to check if
 
123
 
                     client lives.  %()s expansions are done at
 
 
192
                     client lives.  %() expansions are done at
 
124
193
                     runtime with vars(self) as dict, so that for
 
125
194
                     instance %(name)s can be used in the command.
 
126
195
    Private attibutes:
 
127
196
    _timeout: Real variable for 'timeout'
 
128
197
    _interval: Real variable for 'interval'
 
129
 
    _timeout_milliseconds: Used by gobject.timeout_add()
 
 
198
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
130
199
    _interval_milliseconds: - '' -
 
132
201
    def _set_timeout(self, timeout):
 
 
201
270
        """Stop this client.
 
202
 
        The possibility that this client might be restarted is left
 
203
 
        open, but not currently used."""
 
 
271
        The possibility that a client might be restarted is left open,
 
 
272
        but not currently used."""
 
204
273
        # If this client doesn't have a secret, it is already stopped.
 
206
275
            logger.debug(u"Stopping client %s", self.name)
 
207
276
            self.secret = None
 
210
 
        if hasattr(self, "stop_initiator_tag") \
 
211
 
               and self.stop_initiator_tag:
 
 
279
        if getattr(self, "stop_initiator_tag", False):
 
212
280
            gobject.source_remove(self.stop_initiator_tag)
 
213
281
            self.stop_initiator_tag = None
 
214
 
        if hasattr(self, "checker_initiator_tag") \
 
215
 
               and self.checker_initiator_tag:
 
 
282
        if getattr(self, "checker_initiator_tag", False):
 
216
283
            gobject.source_remove(self.checker_initiator_tag)
 
217
284
            self.checker_initiator_tag = None
 
218
285
        self.stop_checker()
 
 
257
324
        # is as it should be.
 
258
325
        if self.checker is None:
 
 
327
                # In case check_command has exactly one % operator
 
260
328
                command = self.check_command % self.fqdn
 
261
329
            except TypeError:
 
 
330
                # Escape attributes for the shell
 
262
331
                escaped_attrs = dict((key, re.escape(str(val)))
 
264
333
                                     vars(self).iteritems())
 
266
335
                    command = self.check_command % escaped_attrs
 
267
336
                except TypeError, error:
 
268
 
                    logger.critical(u'Could not format string "%s":'
 
269
 
                                    u' %s', self.check_command, error)
 
 
337
                    logger.error(u'Could not format string "%s":'
 
 
338
                                 u' %s', self.check_command, error)
 
270
339
                    return True # Try again later
 
272
341
                logger.debug(u"Starting checker %r for %s",
 
273
342
                             command, self.name)
 
274
 
                self.checker = subprocess.\
 
276
 
                                     close_fds=True, shell=True,
 
 
343
                self.checker = subprocess.Popen(command,
 
278
346
                self.checker_callback_tag = gobject.child_watch_add\
 
279
347
                                            (self.checker.pid,
 
280
348
                                             self.checker_callback)
 
 
297
365
            #if self.checker.poll() is None:
 
298
366
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
299
367
        except OSError, error:
 
300
 
            if error.errno != errno.ESRCH:
 
 
368
            if error.errno != errno.ESRCH: # No such process
 
302
370
        self.checker = None
 
303
 
    def still_valid(self, now=None):
 
 
371
    def still_valid(self):
 
304
372
        """Has the timeout not yet passed for this client?"""
 
306
 
            now = datetime.datetime.now()
 
307
 
        if self.last_seen is None:
 
 
373
        now = datetime.datetime.now()
 
 
374
        if self.last_checked_ok is None:
 
308
375
            return now < (self.created + self.timeout)
 
310
 
            return now < (self.last_seen + self.timeout)
 
 
377
            return now < (self.last_checked_ok + self.timeout)
 
313
380
def peer_certificate(session):
 
 
366
433
    def handle(self):
 
367
434
        logger.debug(u"TCP connection from: %s",
 
368
435
                     unicode(self.client_address))
 
369
 
        session = gnutls.connection.ClientSession(self.request,
 
 
436
        session = gnutls.connection.ClientSession\
 
 
437
                  (self.request, gnutls.connection.X509Credentials())
 
 
438
        # Note: gnutls.connection.X509Credentials is really a generic
 
 
439
        # GnuTLS certificate credentials object so long as no X.509
 
 
440
        # keys are added to it.  Therefore, we can use it here despite
 
 
441
        # using OpenPGP certificates.
 
373
443
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
 
374
444
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
377
 
        if self.server.options.priority:
 
378
 
            priority = self.server.options.priority
 
 
446
        priority = "NORMAL"             # Fallback default, since this
 
 
448
        if self.server.settings["priority"]:
 
 
449
            priority = self.server.settings["priority"]
 
379
450
        gnutls.library.functions.gnutls_priority_set_direct\
 
380
451
            (session._c_object, priority, None);
 
 
439
509
        """This overrides the normal server_bind() function
 
440
510
        to bind to an interface if one was specified, and also NOT to
 
441
511
        bind to an address or port if they were not specified."""
 
442
 
        if self.options.interface:
 
443
 
            if not hasattr(socket, "SO_BINDTODEVICE"):
 
444
 
                # From /usr/include/asm-i486/socket.h
 
445
 
                socket.SO_BINDTODEVICE = 25
 
 
512
        if self.settings["interface"] != avahi.IF_UNSPEC:
 
 
513
            # 25 is from /usr/include/asm-i486/socket.h
 
 
514
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
447
516
                self.socket.setsockopt(socket.SOL_SOCKET,
 
448
 
                                       socket.SO_BINDTODEVICE,
 
449
 
                                       self.options.interface)
 
 
518
                                       self.settings["interface"])
 
450
519
            except socket.error, error:
 
451
520
                if error[0] == errno.EPERM:
 
452
521
                    logger.warning(u"No permission to"
 
453
522
                                   u" bind to interface %s",
 
454
 
                                   self.options.interface)
 
 
523
                                   self.settings["interface"])
 
457
526
        # Only bind(2) the socket if we really need to.
 
 
504
 
    """Derived from the Avahi example code"""
 
505
 
    global group, serviceName, serviceType, servicePort, serviceTXT, \
 
508
 
        group = dbus.Interface(
 
509
 
                bus.get_object( avahi.DBUS_NAME,
 
510
 
                                server.EntryGroupNew()),
 
511
 
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
512
 
        group.connect_to_signal('StateChanged',
 
513
 
                                entry_group_state_changed)
 
514
 
    logger.debug(u"Adding service '%s' of type '%s' ...",
 
515
 
                 serviceName, serviceType)
 
518
 
            serviceInterface,           # interface
 
519
 
            avahi.PROTO_INET6,          # protocol
 
520
 
            dbus.UInt32(0),             # flags
 
521
 
            serviceName, serviceType,
 
523
 
            dbus.UInt16(servicePort),
 
524
 
            avahi.string_array_to_txt_array(serviceTXT))
 
528
 
def remove_service():
 
529
 
    """From the Avahi example code"""
 
532
 
    if not group is None:
 
536
572
def server_state_changed(state):
 
537
573
    """Derived from the Avahi example code"""
 
538
574
    if state == avahi.SERVER_COLLISION:
 
539
575
        logger.warning(u"Server name collision")
 
541
577
    elif state == avahi.SERVER_RUNNING:
 
545
581
def entry_group_state_changed(state, error):
 
546
582
    """Derived from the Avahi example code"""
 
547
 
    global serviceName, server, rename_count
 
549
583
    logger.debug(u"state change: %i", state)
 
551
585
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
552
586
        logger.debug(u"Service established.")
 
553
587
    elif state == avahi.ENTRY_GROUP_COLLISION:
 
555
 
        rename_count = rename_count - 1
 
557
 
            name = server.GetAlternativeServiceName(name)
 
558
 
            logger.warning(u"Service name collision, "
 
559
 
                           u"changing name to '%s' ...", name)
 
564
 
            logger.error(u"No suitable service name found after %i"
 
565
 
                         u" retries, exiting.", n_rename)
 
 
588
        logger.warning(u"Service name collision.")
 
567
590
    elif state == avahi.ENTRY_GROUP_FAILURE:
 
568
 
        logger.error(u"Error in group state changed %s",
 
573
 
def if_nametoindex(interface):
 
574
 
    """Call the C function if_nametoindex()"""
 
 
591
        logger.critical(u"Error in group state changed %s",
 
 
593
        raise AvahiGroupError("State changed: %s", str(error))
 
 
595
def if_nametoindex(interface, _func=[None]):
 
 
596
    """Call the C function if_nametoindex(), or equivalent"""
 
 
597
    if _func[0] is not None:
 
 
598
        return _func[0](interface)
 
576
 
        libc = ctypes.cdll.LoadLibrary("libc.so.6")
 
577
 
        return libc.if_nametoindex(interface)
 
 
600
        if "ctypes.util" not in sys.modules:
 
 
604
                libc = ctypes.cdll.LoadLibrary\
 
 
605
                       (ctypes.util.find_library("c"))
 
 
606
                func[0] = libc.if_nametoindex
 
 
607
                return _func[0](interface)
 
578
611
    except (OSError, AttributeError):
 
579
612
        if "struct" not in sys.modules:
 
581
614
        if "fcntl" not in sys.modules:
 
583
 
        SIOCGIFINDEX = 0x8933      # From /usr/include/linux/sockios.h
 
585
 
        ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
586
 
                            struct.pack("16s16x", interface))
 
588
 
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
589
 
        return interface_index
 
 
616
        def the_hard_way(interface):
 
 
617
            "Get an interface index the hard way, i.e. using fcntl()"
 
 
618
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
 
620
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
 
621
                                struct.pack("16s16x", interface))
 
 
623
            interface_index = struct.unpack("I", ifreq[16:20])[0]
 
 
624
            return interface_index
 
 
625
        _func[0] = the_hard_way
 
 
626
        return _func[0](interface)
 
592
629
def daemon(nochdir, noclose):
 
 
613
 
def killme(status = 0):
 
614
 
    logger.debug("Stopping server with exit status %d", status)
 
616
 
    if main_loop_started:
 
625
651
    global main_loop_started
 
626
652
    main_loop_started = False
 
628
654
    parser = OptionParser()
 
629
655
    parser.add_option("-i", "--interface", type="string",
 
630
 
                      default=None, metavar="IF",
 
631
 
                      help="Bind to interface IF")
 
632
 
    parser.add_option("-a", "--address", type="string", default=None,
 
 
656
                      metavar="IF", help="Bind to interface IF")
 
 
657
    parser.add_option("-a", "--address", type="string",
 
633
658
                      help="Address to listen for requests on")
 
634
 
    parser.add_option("-p", "--port", type="int", default=None,
 
 
659
    parser.add_option("-p", "--port", type="int",
 
635
660
                      help="Port number to receive requests on")
 
636
661
    parser.add_option("--check", action="store_true", default=False,
 
637
662
                      help="Run self-test")
 
638
663
    parser.add_option("--debug", action="store_true", default=False,
 
640
 
    parser.add_option("--priority", type="string",
 
642
 
                      help="GnuTLS priority string"
 
643
 
                      " (see GnuTLS documentation)")
 
644
 
    parser.add_option("--servicename", type="string",
 
645
 
                      default="Mandos", help="Zeroconf service name")
 
 
664
                      help="Debug mode; run in foreground and log to"
 
 
666
    parser.add_option("--priority", type="string", help="GnuTLS"
 
 
667
                      " priority string (see GnuTLS documentation)")
 
 
668
    parser.add_option("--servicename", type="string", metavar="NAME",
 
 
669
                      help="Zeroconf service name")
 
 
670
    parser.add_option("--configdir", type="string",
 
 
671
                      default="/etc/mandos", metavar="DIR",
 
 
672
                      help="Directory to search for configuration"
 
646
674
    (options, args) = parser.parse_args()
 
648
676
    if options.check:
 
 
650
678
        doctest.testmod()
 
654
 
    defaults = { "timeout": "1h",
 
656
 
                 "checker": "fping -q -- %%(fqdn)s",
 
658
 
    client_config = ConfigParser.SafeConfigParser(defaults)
 
659
 
    #client_config.readfp(open("global.conf"), "global.conf")
 
660
 
    client_config.read("mandos-clients.conf")
 
663
 
    serviceName = options.servicename;
 
 
681
    # Default values for config file for server-global settings
 
 
682
    server_defaults = { "interface": "",
 
 
687
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
 
688
                        "servicename": "Mandos",
 
 
691
    # Parse config file for server-global settings
 
 
692
    server_config = ConfigParser.SafeConfigParser(server_defaults)
 
 
694
    server_config.read(os.path.join(options.configdir, "server.conf"))
 
 
695
    server_section = "server"
 
 
696
    # Convert the SafeConfigParser object to a dict
 
 
697
    server_settings = dict(server_config.items(server_section))
 
 
698
    # Use getboolean on the boolean config option
 
 
699
    server_settings["debug"] = server_config.getboolean\
 
 
700
                               (server_section, "debug")
 
 
702
    if not server_settings["interface"]:
 
 
703
        server_settings["interface"] = avahi.IF_UNSPEC
 
 
705
    # Override the settings from the config file with command line
 
 
707
    for option in ("interface", "address", "port", "debug",
 
 
708
                   "priority", "servicename", "configdir"):
 
 
709
        value = getattr(options, option)
 
 
710
        if value is not None:
 
 
711
            server_settings[option] = value
 
 
713
    # Now we have our good server settings in "server_settings"
 
 
715
    # Parse config file with clients
 
 
716
    client_defaults = { "timeout": "1h",
 
 
718
                        "checker": "fping -q -- %%(fqdn)s",
 
 
720
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
 
721
    client_config.read(os.path.join(server_settings["configdir"],
 
 
725
    service = AvahiService(name = server_settings["servicename"],
 
 
726
                           type = "_mandos._tcp", );
 
 
720
783
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
721
 
    signal.signal(signal.SIGHUP, lambda signum, frame: killme())
 
722
 
    signal.signal(signal.SIGTERM, lambda signum, frame: killme())
 
 
784
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
 
785
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
724
787
    for client in clients:
 
727
 
    tcp_server = IPv6_TCPServer((options.address, options.port),
 
 
790
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
 
791
                                 server_settings["port"]),
 
 
793
                                settings=server_settings,
 
731
 
    # Find out what random port we got
 
733
 
    servicePort = tcp_server.socket.getsockname()[1]
 
734
 
    logger.debug(u"Now listening on port %d", servicePort)
 
736
 
    if options.interface is not None:
 
737
 
        global serviceInterface
 
738
 
        serviceInterface = if_nametoindex(options.interface)
 
740
 
    # From the Avahi example code
 
741
 
    server.connect_to_signal("StateChanged", server_state_changed)
 
743
 
        server_state_changed(server.GetState())
 
744
 
    except dbus.exceptions.DBusException, error:
 
745
 
        logger.critical(u"DBusException: %s", error)
 
747
 
    # End of Avahi example code
 
749
 
    gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
750
 
                         lambda *args, **kwargs:
 
751
 
                         tcp_server.handle_request(*args[2:],
 
 
795
    # Find out what port we got
 
 
796
    service.port = tcp_server.socket.getsockname()[1]
 
 
797
    logger.debug(u"Now listening on port %d", service.port)
 
 
799
    if not server_settings["interface"]:
 
 
800
        service.interface = if_nametoindex\
 
 
801
                            (server_settings["interface"])
 
 
804
        # From the Avahi example code
 
 
805
        server.connect_to_signal("StateChanged", server_state_changed)
 
 
807
            server_state_changed(server.GetState())
 
 
808
        except dbus.exceptions.DBusException, error:
 
 
809
            logger.critical(u"DBusException: %s", error)
 
 
811
        # End of Avahi example code
 
 
813
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
 
814
                             lambda *args, **kwargs:
 
 
815
                             tcp_server.handle_request\
 
 
816
                             (*args[2:], **kwargs) or True)
 
754
818
        logger.debug("Starting main loop")
 
755
819
        main_loop_started = True
 
 
821
    except AvahiError, error:
 
 
822
        logger.critical(u"AvahiError: %s" + unicode(error))
 
757
824
    except KeyboardInterrupt:
 
763
828
if __name__ == '__main__':