/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: 2008-10-28 18:00:20 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081028180020-qsiaedlurboi3nm4
* INSTALL: Fixed typo.

* Makefile: Split long lines.
  (install-html): Depend on "html", not "$(htmldocs)".

* README (Copyright): Modified legalese.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
11
11
# and some lines in "main".
12
12
# 
13
13
# Everything else is
14
 
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
14
# Copyright © 2008 Teddy Hogeborn & Björn Påhlsson
15
15
# 
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
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 <http://www.gnu.org/licenses/>.
 
27
# along with this program.  If not, see
 
28
# <http://www.gnu.org/licenses/>.
28
29
# 
29
30
# Contact the authors at <mandos@fukt.bsnet.se>.
30
31
# 
33
34
 
34
35
import SocketServer
35
36
import socket
36
 
import select
37
37
from optparse import OptionParser
38
38
import datetime
39
39
import errno
54
54
import stat
55
55
import logging
56
56
import logging.handlers
 
57
import pwd
57
58
 
58
59
import dbus
59
60
import gobject
60
61
import avahi
61
62
from dbus.mainloop.glib import DBusGMainLoop
62
63
import ctypes
 
64
import ctypes.util
63
65
 
64
 
version = "1.0"
 
66
version = "1.0.2"
65
67
 
66
68
logger = logging.Logger('mandos')
67
69
syslogger = logging.handlers.SysLogHandler\
79
81
class AvahiError(Exception):
80
82
    def __init__(self, value):
81
83
        self.value = value
 
84
        super(AvahiError, self).__init__()
82
85
    def __str__(self):
83
86
        return repr(self.value)
84
87
 
106
109
                  a sensible number of times
107
110
    """
108
111
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
109
 
                 type = None, port = None, TXT = None, domain = "",
 
112
                 servicetype = None, port = None, TXT = None, domain = "",
110
113
                 host = "", max_renames = 32768):
111
114
        self.interface = interface
112
115
        self.name = name
113
 
        self.type = type
 
116
        self.type = servicetype
114
117
        self.port = port
115
118
        if TXT is None:
116
119
            self.TXT = []
119
122
        self.domain = domain
120
123
        self.host = host
121
124
        self.rename_count = 0
 
125
        self.max_renames = max_renames
122
126
    def rename(self):
123
127
        """Derived from the Avahi example code"""
124
128
        if self.rename_count >= self.max_renames:
125
 
            logger.critical(u"No suitable service name found after %i"
126
 
                            u" retries, exiting.", rename_count)
 
129
            logger.critical(u"No suitable Zeroconf service name found"
 
130
                            u" after %i retries, exiting.",
 
131
                            self.rename_count)
127
132
            raise AvahiServiceError("Too many renames")
128
 
        name = server.GetAlternativeServiceName(name)
129
 
        logger.error(u"Changing name to %r ...", name)
 
133
        self.name = server.GetAlternativeServiceName(self.name)
 
134
        logger.info(u"Changing Zeroconf service name to %r ...",
 
135
                    str(self.name))
130
136
        syslogger.setFormatter(logging.Formatter\
131
137
                               ('Mandos (%s): %%(levelname)s:'
132
 
                               ' %%(message)s' % name))
 
138
                               ' %%(message)s' % self.name))
133
139
        self.remove()
134
140
        self.add()
135
141
        self.rename_count += 1
147
153
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
148
154
            group.connect_to_signal('StateChanged',
149
155
                                    entry_group_state_changed)
150
 
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
156
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
151
157
                     service.name, service.type)
152
158
        group.AddService(
153
159
                self.interface,         # interface
217
223
    interval = property(lambda self: self._interval,
218
224
                        _set_interval)
219
225
    del _set_interval
220
 
    def __init__(self, name = None, stop_hook=None, config={}):
 
226
    def __init__(self, name = None, stop_hook=None, config=None):
221
227
        """Note: the 'checker' key in 'config' sets the
222
228
        'checker_command' attribute and *not* the 'checker'
223
229
        attribute."""
 
230
        if config is None:
 
231
            config = {}
224
232
        self.name = name
225
233
        logger.debug(u"Creating client %r", self.name)
226
234
        # Uppercase and remove spaces from fingerprint for later
232
240
        if "secret" in config:
233
241
            self.secret = config["secret"].decode(u"base64")
234
242
        elif "secfile" in config:
235
 
            sf = open(config["secfile"])
236
 
            self.secret = sf.read()
237
 
            sf.close()
 
243
            secfile = open(os.path.expanduser(os.path.expandvars
 
244
                                              (config["secfile"])))
 
245
            self.secret = secfile.read()
 
246
            secfile.close()
238
247
        else:
239
248
            raise TypeError(u"No secret or secfile for client %s"
240
249
                            % self.name)
336
345
            try:
337
346
                logger.info(u"Starting checker %r for %s",
338
347
                            command, self.name)
 
348
                # We don't need to redirect stdout and stderr, since
 
349
                # in normal mode, that is already done by daemon(),
 
350
                # and in debug mode we don't want to.  (Stdin is
 
351
                # always replaced by /dev/null.)
339
352
                self.checker = subprocess.Popen(command,
340
353
                                                close_fds=True,
341
354
                                                shell=True, cwd="/")
342
355
                self.checker_callback_tag = gobject.child_watch_add\
343
356
                                            (self.checker.pid,
344
357
                                             self.checker_callback)
345
 
            except subprocess.OSError, error:
 
358
            except OSError, error:
346
359
                logger.error(u"Failed to start subprocess: %s",
347
360
                             error)
348
361
        # Re-run this periodically if run by gobject.timeout_add
405
418
    gnutls.library.functions.gnutls_openpgp_crt_import\
406
419
                    (crt, ctypes.byref(datum),
407
420
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
421
    # Verify the self signature in the key
 
422
    crtverify = ctypes.c_uint()
 
423
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
 
424
        (crt, 0, ctypes.byref(crtverify))
 
425
    if crtverify.value != 0:
 
426
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
427
        raise gnutls.errors.CertificateSecurityError("Verify failed")
408
428
    # New buffer for the fingerprint
409
 
    buffer = ctypes.create_string_buffer(20)
410
 
    buffer_length = ctypes.c_size_t()
 
429
    buf = ctypes.create_string_buffer(20)
 
430
    buf_len = ctypes.c_size_t()
411
431
    # Get the fingerprint from the certificate into the buffer
412
432
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
413
 
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
433
        (crt, ctypes.byref(buf), ctypes.byref(buf_len))
414
434
    # Deinit the certificate
415
435
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
416
436
    # Convert the buffer to a Python bytestring
417
 
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
437
    fpr = ctypes.string_at(buf, buf_len.value)
418
438
    # Convert the bytestring to hexadecimal notation
419
439
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
420
440
    return hex_fpr
421
441
 
422
442
 
423
 
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
443
class TCP_handler(SocketServer.BaseRequestHandler, object):
424
444
    """A TCP request handler class.
425
445
    Instantiated by IPv6_TCPServer for each request to handle it.
426
446
    Note: This will run in its own forked process."""
453
473
        if self.server.settings["priority"]:
454
474
            priority = self.server.settings["priority"]
455
475
        gnutls.library.functions.gnutls_priority_set_direct\
456
 
            (session._c_object, priority, None);
 
476
            (session._c_object, priority, None)
457
477
        
458
478
        try:
459
479
            session.handshake()
502
522
    Attributes:
503
523
        settings:       Server settings
504
524
        clients:        Set() of Client objects
 
525
        enabled:        Boolean; whether this server is activated yet
505
526
    """
506
527
    address_family = socket.AF_INET6
507
528
    def __init__(self, *args, **kwargs):
511
532
        if "clients" in kwargs:
512
533
            self.clients = kwargs["clients"]
513
534
            del kwargs["clients"]
514
 
        return super(type(self), self).__init__(*args, **kwargs)
 
535
        self.enabled = False
 
536
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
515
537
    def server_bind(self):
516
538
        """This overrides the normal server_bind() function
517
539
        to bind to an interface if one was specified, and also NOT to
546
568
#                                            if_nametoindex
547
569
#                                            (self.settings
548
570
#                                             ["interface"]))
549
 
            return super(type(self), self).server_bind()
 
571
            return super(IPv6_TCPServer, self).server_bind()
 
572
    def server_activate(self):
 
573
        if self.enabled:
 
574
            return super(IPv6_TCPServer, self).server_activate()
 
575
    def enable(self):
 
576
        self.enabled = True
550
577
 
551
578
 
552
579
def string_to_delta(interval):
562
589
    datetime.timedelta(1)
563
590
    >>> string_to_delta(u'1w')
564
591
    datetime.timedelta(7)
 
592
    >>> string_to_delta('5m 30s')
 
593
    datetime.timedelta(0, 330)
565
594
    """
566
 
    try:
567
 
        suffix=unicode(interval[-1])
568
 
        value=int(interval[:-1])
569
 
        if suffix == u"d":
570
 
            delta = datetime.timedelta(value)
571
 
        elif suffix == u"s":
572
 
            delta = datetime.timedelta(0, value)
573
 
        elif suffix == u"m":
574
 
            delta = datetime.timedelta(0, 0, 0, 0, value)
575
 
        elif suffix == u"h":
576
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
577
 
        elif suffix == u"w":
578
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
579
 
        else:
 
595
    timevalue = datetime.timedelta(0)
 
596
    for s in interval.split():
 
597
        try:
 
598
            suffix = unicode(s[-1])
 
599
            value = int(s[:-1])
 
600
            if suffix == u"d":
 
601
                delta = datetime.timedelta(value)
 
602
            elif suffix == u"s":
 
603
                delta = datetime.timedelta(0, value)
 
604
            elif suffix == u"m":
 
605
                delta = datetime.timedelta(0, 0, 0, 0, value)
 
606
            elif suffix == u"h":
 
607
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
608
            elif suffix == u"w":
 
609
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
610
            else:
 
611
                raise ValueError
 
612
        except (ValueError, IndexError):
580
613
            raise ValueError
581
 
    except (ValueError, IndexError):
582
 
        raise ValueError
583
 
    return delta
 
614
        timevalue += delta
 
615
    return timevalue
584
616
 
585
617
 
586
618
def server_state_changed(state):
587
619
    """Derived from the Avahi example code"""
588
620
    if state == avahi.SERVER_COLLISION:
589
 
        logger.error(u"Server name collision")
 
621
        logger.error(u"Zeroconf server name collision")
590
622
        service.remove()
591
623
    elif state == avahi.SERVER_RUNNING:
592
624
        service.add()
594
626
 
595
627
def entry_group_state_changed(state, error):
596
628
    """Derived from the Avahi example code"""
597
 
    logger.debug(u"state change: %i", state)
 
629
    logger.debug(u"Avahi state change: %i", state)
598
630
    
599
631
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
600
 
        logger.debug(u"Service established.")
 
632
        logger.debug(u"Zeroconf service established.")
601
633
    elif state == avahi.ENTRY_GROUP_COLLISION:
602
 
        logger.warning(u"Service name collision.")
 
634
        logger.warning(u"Zeroconf service name collision.")
603
635
        service.rename()
604
636
    elif state == avahi.ENTRY_GROUP_FAILURE:
605
 
        logger.critical(u"Error in group state changed %s",
 
637
        logger.critical(u"Avahi: Error in group state changed %s",
606
638
                        unicode(error))
607
639
        raise AvahiGroupError("State changed: %s", str(error))
608
640
 
610
642
    """Call the C function if_nametoindex(), or equivalent"""
611
643
    global if_nametoindex
612
644
    try:
613
 
        if "ctypes.util" not in sys.modules:
614
 
            import ctypes.util
615
645
        if_nametoindex = ctypes.cdll.LoadLibrary\
616
646
            (ctypes.util.find_library("c")).if_nametoindex
617
647
    except (OSError, AttributeError):
655
685
 
656
686
 
657
687
def main():
658
 
    global main_loop_started
659
 
    main_loop_started = False
660
 
    
661
688
    parser = OptionParser(version = "%%prog %s" % version)
662
689
    parser.add_option("-i", "--interface", type="string",
663
690
                      metavar="IF", help="Bind to interface IF")
678
705
                      default="/etc/mandos", metavar="DIR",
679
706
                      help="Directory to search for configuration"
680
707
                      " files")
681
 
    (options, args) = parser.parse_args()
 
708
    options = parser.parse_args()[0]
682
709
    
683
710
    if options.check:
684
711
        import doctest
699
726
    server_config = ConfigParser.SafeConfigParser(server_defaults)
700
727
    del server_defaults
701
728
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
702
 
    server_section = "server"
703
729
    # Convert the SafeConfigParser object to a dict
704
 
    server_settings = dict(server_config.items(server_section))
 
730
    server_settings = server_config.defaults()
705
731
    # Use getboolean on the boolean config option
706
732
    server_settings["debug"] = server_config.getboolean\
707
 
                               (server_section, "debug")
 
733
                               ("DEFAULT", "debug")
708
734
    del server_config
709
735
    
710
736
    # Override the settings from the config file with command line
732
758
    # Parse config file with clients
733
759
    client_defaults = { "timeout": "1h",
734
760
                        "interval": "5m",
735
 
                        "checker": "fping -q -- %%(host)s",
 
761
                        "checker": "fping -q -- %(host)s",
 
762
                        "host": "",
736
763
                        }
737
764
    client_config = ConfigParser.SafeConfigParser(client_defaults)
738
765
    client_config.read(os.path.join(server_settings["configdir"],
739
766
                                    "clients.conf"))
740
767
    
 
768
    clients = Set()
 
769
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
770
                                 server_settings["port"]),
 
771
                                TCP_handler,
 
772
                                settings=server_settings,
 
773
                                clients=clients)
 
774
    pidfilename = "/var/run/mandos.pid"
 
775
    try:
 
776
        pidfile = open(pidfilename, "w")
 
777
    except IOError, error:
 
778
        logger.error("Could not open file %r", pidfilename)
 
779
    
 
780
    uid = 65534
 
781
    gid = 65534
 
782
    try:
 
783
        uid = pwd.getpwnam("mandos").pw_uid
 
784
    except KeyError:
 
785
        try:
 
786
            uid = pwd.getpwnam("nobody").pw_uid
 
787
        except KeyError:
 
788
            pass
 
789
    try:
 
790
        gid = pwd.getpwnam("mandos").pw_gid
 
791
    except KeyError:
 
792
        try:
 
793
            gid = pwd.getpwnam("nogroup").pw_gid
 
794
        except KeyError:
 
795
            pass
 
796
    try:
 
797
        os.setuid(uid)
 
798
        os.setgid(gid)
 
799
    except OSError, error:
 
800
        if error[0] != errno.EPERM:
 
801
            raise error
 
802
    
741
803
    global service
742
804
    service = AvahiService(name = server_settings["servicename"],
743
 
                           type = "_mandos._tcp", );
 
805
                           servicetype = "_mandos._tcp", )
744
806
    if server_settings["interface"]:
745
 
        service.interface = if_nametoindex(server_settings["interface"])
 
807
        service.interface = if_nametoindex\
 
808
                            (server_settings["interface"])
746
809
    
747
810
    global main_loop
748
811
    global bus
751
814
    DBusGMainLoop(set_as_default=True )
752
815
    main_loop = gobject.MainLoop()
753
816
    bus = dbus.SystemBus()
754
 
    server = dbus.Interface(
755
 
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
756
 
            avahi.DBUS_INTERFACE_SERVER )
 
817
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
 
818
                                           avahi.DBUS_PATH_SERVER),
 
819
                            avahi.DBUS_INTERFACE_SERVER)
757
820
    # End of Avahi example code
758
821
    
759
 
    clients = Set()
760
822
    def remove_from_clients(client):
761
823
        clients.remove(client)
762
824
        if not clients:
772
834
        logger.critical(u"No clients defined")
773
835
        sys.exit(1)
774
836
    
775
 
    if not debug:
 
837
    if debug:
 
838
        # Redirect stdin so all checkers get /dev/null
 
839
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
840
        os.dup2(null, sys.stdin.fileno())
 
841
        if null > 2:
 
842
            os.close(null)
 
843
    else:
 
844
        # No console logging
776
845
        logger.removeHandler(console)
 
846
        # Close all input and output, do double fork, etc.
777
847
        daemon()
778
848
    
779
 
    pidfilename = "/var/run/mandos/mandos.pid"
780
 
    pid = os.getpid()
781
849
    try:
782
 
        pidfile = open(pidfilename, "w")
 
850
        pid = os.getpid()
783
851
        pidfile.write(str(pid) + "\n")
784
852
        pidfile.close()
785
853
        del pidfile
786
 
    except IOError, err:
787
 
        logger.error(u"Could not write %s file with PID %d",
788
 
                     pidfilename, os.getpid())
 
854
    except IOError:
 
855
        logger.error(u"Could not write to file %r with PID %d",
 
856
                     pidfilename, pid)
 
857
    except NameError:
 
858
        # "pidfile" was never created
 
859
        pass
 
860
    del pidfilename
789
861
    
790
862
    def cleanup():
791
863
        "Cleanup function; run on exit"
811
883
    for client in clients:
812
884
        client.start()
813
885
    
814
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
815
 
                                 server_settings["port"]),
816
 
                                tcp_handler,
817
 
                                settings=server_settings,
818
 
                                clients=clients)
 
886
    tcp_server.enable()
 
887
    tcp_server.server_activate()
 
888
    
819
889
    # Find out what port we got
820
890
    service.port = tcp_server.socket.getsockname()[1]
821
891
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
839
909
                             (*args[2:], **kwargs) or True)
840
910
        
841
911
        logger.debug(u"Starting main loop")
842
 
        main_loop_started = True
843
912
        main_loop.run()
844
913
    except AvahiError, error:
845
914
        logger.critical(u"AvahiError: %s" + unicode(error))