/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 server.py

  • Committer: Teddy Hogeborn
  • Date: 2008-08-04 23:38:26 UTC
  • mfrom: (24.1.20 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080804233826-idy7v8x36llseue0
* network-protocol.txt: New.

* server.py (daemon): Do the double fork thing.

Show diffs side-by-side

added added

removed removed

Lines of Context:
server.py
24
24
#     GNU General Public License for more details.
25
25
# 
26
26
# You should have received a copy of the GNU General Public License
27
 
# along with this program.  If not, see
28
 
# <http://www.gnu.org/licenses/>.
 
27
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
29
28
# 
30
29
# Contact the authors at <mandos@fukt.bsnet.se>.
31
30
# 
62
61
from dbus.mainloop.glib import DBusGMainLoop
63
62
import ctypes
64
63
 
65
 
version = "1.0"
66
64
 
67
65
logger = logging.Logger('mandos')
68
66
syslogger = logging.handlers.SysLogHandler\
69
 
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
70
 
             address = "/dev/log")
 
67
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
71
68
syslogger.setFormatter(logging.Formatter\
72
 
                        ('Mandos: %(levelname)s: %(message)s'))
 
69
                        ('%(levelname)s: %(message)s'))
73
70
logger.addHandler(syslogger)
 
71
del syslogger
74
72
 
75
 
console = logging.StreamHandler()
76
 
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
77
 
                                       ' %(message)s'))
78
 
logger.addHandler(console)
79
73
 
80
74
class AvahiError(Exception):
81
75
    def __init__(self, value):
108
102
    """
109
103
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
110
104
                 type = None, port = None, TXT = None, domain = "",
111
 
                 host = "", max_renames = 32768):
 
105
                 host = "", max_renames = 12):
112
106
        self.interface = interface
113
107
        self.name = name
114
108
        self.type = type
120
114
        self.domain = domain
121
115
        self.host = host
122
116
        self.rename_count = 0
123
 
        self.max_renames = max_renames
124
117
    def rename(self):
125
118
        """Derived from the Avahi example code"""
126
119
        if self.rename_count >= self.max_renames:
127
 
            logger.critical(u"No suitable Zeroconf service name found"
128
 
                            u" after %i retries, exiting.",
129
 
                            rename_count)
 
120
            logger.critical(u"No suitable service name found after %i"
 
121
                            u" retries, exiting.", rename_count)
130
122
            raise AvahiServiceError("Too many renames")
131
 
        self.name = server.GetAlternativeServiceName(self.name)
132
 
        logger.info(u"Changing Zeroconf service name to %r ...",
133
 
                    str(self.name))
134
 
        syslogger.setFormatter(logging.Formatter\
135
 
                               ('Mandos (%s): %%(levelname)s:'
136
 
                               ' %%(message)s' % self.name))
 
123
        name = server.GetAlternativeServiceName(name)
 
124
        logger.error(u"Changing name to %r ...", name)
137
125
        self.remove()
138
126
        self.add()
139
127
        self.rename_count += 1
151
139
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
152
140
            group.connect_to_signal('StateChanged',
153
141
                                    entry_group_state_changed)
154
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
 
142
        logger.debug(u"Adding service '%s' of type '%s' ...",
155
143
                     service.name, service.type)
156
144
        group.AddService(
157
145
                self.interface,         # interface
175
163
    fingerprint: string (40 or 32 hexadecimal digits); used to
176
164
                 uniquely identify the client
177
165
    secret:    bytestring; sent verbatim (over TLS) to client
178
 
    host:      string; available for use by the checker command
 
166
    fqdn:      string (FQDN); available for use by the checker command
179
167
    created:   datetime.datetime(); object creation, not client host
180
168
    last_checked_ok: datetime.datetime() or None if not yet checked OK
181
169
    timeout:   datetime.timedelta(); How long from last_checked_ok
242
230
        else:
243
231
            raise TypeError(u"No secret or secfile for client %s"
244
232
                            % self.name)
245
 
        self.host = config.get("host", "")
 
233
        self.fqdn = config.get("fqdn", "")
246
234
        self.created = datetime.datetime.now()
247
235
        self.last_checked_ok = None
248
236
        self.timeout = string_to_delta(config["timeout"])
271
259
        The possibility that a client might be restarted is left open,
272
260
        but not currently used."""
273
261
        # If this client doesn't have a secret, it is already stopped.
274
 
        if hasattr(self, "secret") and self.secret:
 
262
        if self.secret:
275
263
            logger.info(u"Stopping client %s", self.name)
276
264
            self.secret = None
277
265
        else:
325
313
        if self.checker is None:
326
314
            try:
327
315
                # In case check_command has exactly one % operator
328
 
                command = self.check_command % self.host
 
316
                command = self.check_command % self.fqdn
329
317
            except TypeError:
330
318
                # Escape attributes for the shell
331
319
                escaped_attrs = dict((key, re.escape(str(val)))
340
328
            try:
341
329
                logger.info(u"Starting checker %r for %s",
342
330
                            command, self.name)
343
 
                # We don't need to redirect stdout and stderr, since
344
 
                # in normal mode, that is already done by daemon(),
345
 
                # and in debug mode we don't want to.  (Stdin is
346
 
                # always replaced by /dev/null.)
347
331
                self.checker = subprocess.Popen(command,
348
332
                                                close_fds=True,
349
333
                                                shell=True, cwd="/")
350
334
                self.checker_callback_tag = gobject.child_watch_add\
351
335
                                            (self.checker.pid,
352
336
                                             self.checker_callback)
353
 
            except OSError, error:
 
337
            except subprocess.OSError, error:
354
338
                logger.error(u"Failed to start subprocess: %s",
355
339
                             error)
356
340
        # Re-run this periodically if run by gobject.timeout_add
362
346
            self.checker_callback_tag = None
363
347
        if getattr(self, "checker", None) is None:
364
348
            return
365
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
349
        logger.debug("Stopping checker for %(name)s", vars(self))
366
350
        try:
367
351
            os.kill(self.checker.pid, signal.SIGTERM)
368
352
            #os.sleep(0.5)
413
397
    gnutls.library.functions.gnutls_openpgp_crt_import\
414
398
                    (crt, ctypes.byref(datum),
415
399
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
416
 
    # Verify the self signature in the key
417
 
    crtverify = ctypes.c_uint();
418
 
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
419
 
        (crt, 0, ctypes.byref(crtverify))
420
 
    if crtverify.value != 0:
421
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
422
 
        raise gnutls.errors.CertificateSecurityError("Verify failed")
423
400
    # New buffer for the fingerprint
424
401
    buffer = ctypes.create_string_buffer(20)
425
402
    buffer_length = ctypes.c_size_t()
551
528
                in6addr_any = "::"
552
529
                self.server_address = (in6addr_any,
553
530
                                       self.server_address[1])
554
 
            elif not self.server_address[1]:
 
531
            elif self.server_address[1] is None:
555
532
                self.server_address = (self.server_address[0],
556
533
                                       0)
557
 
#                 if self.settings["interface"]:
558
 
#                     self.server_address = (self.server_address[0],
559
 
#                                            0, # port
560
 
#                                            0, # flowinfo
561
 
#                                            if_nametoindex
562
 
#                                            (self.settings
563
 
#                                             ["interface"]))
564
534
            return super(type(self), self).server_bind()
565
535
 
566
536
 
577
547
    datetime.timedelta(1)
578
548
    >>> string_to_delta(u'1w')
579
549
    datetime.timedelta(7)
580
 
    >>> string_to_delta('5m 30s')
581
 
    datetime.timedelta(0, 330)
582
550
    """
583
 
    timevalue = datetime.timedelta(0)
584
 
    for s in interval.split():
585
 
        try:
586
 
            suffix=unicode(s[-1])
587
 
            value=int(s[:-1])
588
 
            if suffix == u"d":
589
 
                delta = datetime.timedelta(value)
590
 
            elif suffix == u"s":
591
 
                delta = datetime.timedelta(0, value)
592
 
            elif suffix == u"m":
593
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
594
 
            elif suffix == u"h":
595
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
596
 
            elif suffix == u"w":
597
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
598
 
            else:
599
 
                raise ValueError
600
 
        except (ValueError, IndexError):
 
551
    try:
 
552
        suffix=unicode(interval[-1])
 
553
        value=int(interval[:-1])
 
554
        if suffix == u"d":
 
555
            delta = datetime.timedelta(value)
 
556
        elif suffix == u"s":
 
557
            delta = datetime.timedelta(0, value)
 
558
        elif suffix == u"m":
 
559
            delta = datetime.timedelta(0, 0, 0, 0, value)
 
560
        elif suffix == u"h":
 
561
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
562
        elif suffix == u"w":
 
563
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
564
        else:
601
565
            raise ValueError
602
 
        timevalue += delta
603
 
    return timevalue
 
566
    except (ValueError, IndexError):
 
567
        raise ValueError
 
568
    return delta
604
569
 
605
570
 
606
571
def server_state_changed(state):
607
572
    """Derived from the Avahi example code"""
608
573
    if state == avahi.SERVER_COLLISION:
609
 
        logger.error(u"Zeroconf server name collision")
 
574
        logger.error(u"Server name collision")
610
575
        service.remove()
611
576
    elif state == avahi.SERVER_RUNNING:
612
577
        service.add()
614
579
 
615
580
def entry_group_state_changed(state, error):
616
581
    """Derived from the Avahi example code"""
617
 
    logger.debug(u"Avahi state change: %i", state)
 
582
    logger.debug(u"state change: %i", state)
618
583
    
619
584
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
620
 
        logger.debug(u"Zeroconf service established.")
 
585
        logger.debug(u"Service established.")
621
586
    elif state == avahi.ENTRY_GROUP_COLLISION:
622
 
        logger.warning(u"Zeroconf service name collision.")
 
587
        logger.warning(u"Service name collision.")
623
588
        service.rename()
624
589
    elif state == avahi.ENTRY_GROUP_FAILURE:
625
 
        logger.critical(u"Avahi: Error in group state changed %s",
 
590
        logger.critical(u"Error in group state changed %s",
626
591
                        unicode(error))
627
592
        raise AvahiGroupError("State changed: %s", str(error))
628
593
 
651
616
    return if_nametoindex(interface)
652
617
 
653
618
 
654
 
def daemon(nochdir = False, noclose = False):
 
619
def daemon(nochdir, noclose):
655
620
    """See daemon(3).  Standard BSD Unix function.
656
621
    This should really exist as os.daemon, but it doesn't (yet)."""
657
622
    if os.fork():
678
643
    global main_loop_started
679
644
    main_loop_started = False
680
645
    
681
 
    parser = OptionParser(version = "%%prog %s" % version)
 
646
    parser = OptionParser()
682
647
    parser.add_option("-i", "--interface", type="string",
683
648
                      metavar="IF", help="Bind to interface IF")
684
649
    parser.add_option("-a", "--address", type="string",
687
652
                      help="Port number to receive requests on")
688
653
    parser.add_option("--check", action="store_true", default=False,
689
654
                      help="Run self-test")
690
 
    parser.add_option("--debug", action="store_true",
 
655
    parser.add_option("--debug", action="store_true", default=False,
691
656
                      help="Debug mode; run in foreground and log to"
692
657
                      " terminal")
693
658
    parser.add_option("--priority", type="string", help="GnuTLS"
718
683
    # Parse config file for server-global settings
719
684
    server_config = ConfigParser.SafeConfigParser(server_defaults)
720
685
    del server_defaults
721
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
686
    server_config.read(os.path.join(options.configdir, "server.conf"))
 
687
    server_section = "server"
722
688
    # Convert the SafeConfigParser object to a dict
723
 
    server_settings = server_config.defaults()
 
689
    server_settings = dict(server_config.items(server_section))
724
690
    # Use getboolean on the boolean config option
725
691
    server_settings["debug"] = server_config.getboolean\
726
 
                               ("DEFAULT", "debug")
 
692
                               (server_section, "debug")
727
693
    del server_config
728
694
    
729
695
    # Override the settings from the config file with command line
736
702
    del options
737
703
    # Now we have our good server settings in "server_settings"
738
704
    
739
 
    debug = server_settings["debug"]
740
 
    
741
 
    if not debug:
742
 
        syslogger.setLevel(logging.WARNING)
743
 
        console.setLevel(logging.WARNING)
744
 
    
745
 
    if server_settings["servicename"] != "Mandos":
746
 
        syslogger.setFormatter(logging.Formatter\
747
 
                               ('Mandos (%s): %%(levelname)s:'
748
 
                                ' %%(message)s'
749
 
                                % server_settings["servicename"]))
750
 
    
751
705
    # Parse config file with clients
752
706
    client_defaults = { "timeout": "1h",
753
707
                        "interval": "5m",
754
 
                        "checker": "fping -q -- %(host)s",
755
 
                        "host": "",
 
708
                        "checker": "fping -q -- %%(fqdn)s",
756
709
                        }
757
710
    client_config = ConfigParser.SafeConfigParser(client_defaults)
758
711
    client_config.read(os.path.join(server_settings["configdir"],
762
715
    service = AvahiService(name = server_settings["servicename"],
763
716
                           type = "_mandos._tcp", );
764
717
    if server_settings["interface"]:
765
 
        service.interface = if_nametoindex\
766
 
                            (server_settings["interface"])
 
718
        service.interface = if_nametoindex(server_settings["interface"])
767
719
    
768
720
    global main_loop
769
721
    global bus
772
724
    DBusGMainLoop(set_as_default=True )
773
725
    main_loop = gobject.MainLoop()
774
726
    bus = dbus.SystemBus()
775
 
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
776
 
                                           avahi.DBUS_PATH_SERVER),
777
 
                            avahi.DBUS_INTERFACE_SERVER)
 
727
    server = dbus.Interface(
 
728
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
729
            avahi.DBUS_INTERFACE_SERVER )
778
730
    # End of Avahi example code
779
731
    
 
732
    debug = server_settings["debug"]
 
733
    
 
734
    if debug:
 
735
        console = logging.StreamHandler()
 
736
        # console.setLevel(logging.DEBUG)
 
737
        console.setFormatter(logging.Formatter\
 
738
                             ('%(levelname)s: %(message)s'))
 
739
        logger.addHandler(console)
 
740
        del console
 
741
    
780
742
    clients = Set()
781
743
    def remove_from_clients(client):
782
744
        clients.remove(client)
789
751
                              config
790
752
                              = dict(client_config.items(section)))
791
753
                       for section in client_config.sections()))
792
 
    if not clients:
793
 
        logger.critical(u"No clients defined")
794
 
        sys.exit(1)
795
 
    
796
 
    if debug:
797
 
        # Redirect stdin so all checkers get /dev/null
798
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
799
 
        os.dup2(null, sys.stdin.fileno())
800
 
        if null > 2:
801
 
            os.close(null)
802
 
    else:
803
 
        # No console logging
804
 
        logger.removeHandler(console)
805
 
        # Close all input and output, do double fork, etc.
806
 
        daemon()
807
 
    
808
 
    pidfilename = "/var/run/mandos/mandos.pid"
809
 
    pid = os.getpid()
810
 
    try:
811
 
        pidfile = open(pidfilename, "w")
812
 
        pidfile.write(str(pid) + "\n")
813
 
        pidfile.close()
814
 
        del pidfile
815
 
    except IOError, err:
816
 
        logger.error(u"Could not write %s file with PID %d",
817
 
                     pidfilename, os.getpid())
 
754
    
 
755
    if not debug:
 
756
        daemon(False, False)
818
757
    
819
758
    def cleanup():
820
759
        "Cleanup function; run on exit"
867
806
                             tcp_server.handle_request\
868
807
                             (*args[2:], **kwargs) or True)
869
808
        
870
 
        logger.debug(u"Starting main loop")
 
809
        logger.debug("Starting main loop")
871
810
        main_loop_started = True
872
811
        main_loop.run()
873
812
    except AvahiError, error: