/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-18 11:17:22 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081018111722-jtbz35c031lxuuc9
* debian/mandos-client.docs (NEWS): Added.
* debian/mandos.docs (NEWS): - '' -

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 = []
123
126
    def rename(self):
124
127
        """Derived from the Avahi example code"""
125
128
        if self.rename_count >= self.max_renames:
126
 
            logger.critical(u"No suitable service name found after %i"
127
 
                            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)
128
132
            raise AvahiServiceError("Too many renames")
129
133
        self.name = server.GetAlternativeServiceName(self.name)
130
 
        logger.info(u"Changing name to %r ...", str(self.name))
 
134
        logger.info(u"Changing Zeroconf service name to %r ...",
 
135
                    str(self.name))
131
136
        syslogger.setFormatter(logging.Formatter\
132
137
                               ('Mandos (%s): %%(levelname)s:'
133
138
                               ' %%(message)s' % self.name))
148
153
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
149
154
            group.connect_to_signal('StateChanged',
150
155
                                    entry_group_state_changed)
151
 
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
156
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
152
157
                     service.name, service.type)
153
158
        group.AddService(
154
159
                self.interface,         # interface
218
223
    interval = property(lambda self: self._interval,
219
224
                        _set_interval)
220
225
    del _set_interval
221
 
    def __init__(self, name = None, stop_hook=None, config={}):
 
226
    def __init__(self, name = None, stop_hook=None, config=None):
222
227
        """Note: the 'checker' key in 'config' sets the
223
228
        'checker_command' attribute and *not* the 'checker'
224
229
        attribute."""
 
230
        if config is None:
 
231
            config = {}
225
232
        self.name = name
226
233
        logger.debug(u"Creating client %r", self.name)
227
234
        # Uppercase and remove spaces from fingerprint for later
233
240
        if "secret" in config:
234
241
            self.secret = config["secret"].decode(u"base64")
235
242
        elif "secfile" in config:
236
 
            sf = open(config["secfile"])
237
 
            self.secret = sf.read()
238
 
            sf.close()
 
243
            secfile = open(os.path.expanduser(os.path.expandvars
 
244
                                              (config["secfile"])))
 
245
            self.secret = secfile.read()
 
246
            secfile.close()
239
247
        else:
240
248
            raise TypeError(u"No secret or secfile for client %s"
241
249
                            % self.name)
337
345
            try:
338
346
                logger.info(u"Starting checker %r for %s",
339
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.)
340
352
                self.checker = subprocess.Popen(command,
341
353
                                                close_fds=True,
342
354
                                                shell=True, cwd="/")
343
355
                self.checker_callback_tag = gobject.child_watch_add\
344
356
                                            (self.checker.pid,
345
357
                                             self.checker_callback)
346
 
            except subprocess.OSError, error:
 
358
            except OSError, error:
347
359
                logger.error(u"Failed to start subprocess: %s",
348
360
                             error)
349
361
        # Re-run this periodically if run by gobject.timeout_add
406
418
    gnutls.library.functions.gnutls_openpgp_crt_import\
407
419
                    (crt, ctypes.byref(datum),
408
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")
409
428
    # New buffer for the fingerprint
410
 
    buffer = ctypes.create_string_buffer(20)
411
 
    buffer_length = ctypes.c_size_t()
 
429
    buf = ctypes.create_string_buffer(20)
 
430
    buf_len = ctypes.c_size_t()
412
431
    # Get the fingerprint from the certificate into the buffer
413
432
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
414
 
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
433
        (crt, ctypes.byref(buf), ctypes.byref(buf_len))
415
434
    # Deinit the certificate
416
435
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
417
436
    # Convert the buffer to a Python bytestring
418
 
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
437
    fpr = ctypes.string_at(buf, buf_len.value)
419
438
    # Convert the bytestring to hexadecimal notation
420
439
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
421
440
    return hex_fpr
422
441
 
423
442
 
424
 
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
443
class TCP_handler(SocketServer.BaseRequestHandler, object):
425
444
    """A TCP request handler class.
426
445
    Instantiated by IPv6_TCPServer for each request to handle it.
427
446
    Note: This will run in its own forked process."""
454
473
        if self.server.settings["priority"]:
455
474
            priority = self.server.settings["priority"]
456
475
        gnutls.library.functions.gnutls_priority_set_direct\
457
 
            (session._c_object, priority, None);
 
476
            (session._c_object, priority, None)
458
477
        
459
478
        try:
460
479
            session.handshake()
503
522
    Attributes:
504
523
        settings:       Server settings
505
524
        clients:        Set() of Client objects
 
525
        enabled:        Boolean; whether this server is activated yet
506
526
    """
507
527
    address_family = socket.AF_INET6
508
528
    def __init__(self, *args, **kwargs):
512
532
        if "clients" in kwargs:
513
533
            self.clients = kwargs["clients"]
514
534
            del kwargs["clients"]
515
 
        return super(type(self), self).__init__(*args, **kwargs)
 
535
        self.enabled = False
 
536
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
516
537
    def server_bind(self):
517
538
        """This overrides the normal server_bind() function
518
539
        to bind to an interface if one was specified, and also NOT to
547
568
#                                            if_nametoindex
548
569
#                                            (self.settings
549
570
#                                             ["interface"]))
550
 
            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
551
577
 
552
578
 
553
579
def string_to_delta(interval):
563
589
    datetime.timedelta(1)
564
590
    >>> string_to_delta(u'1w')
565
591
    datetime.timedelta(7)
 
592
    >>> string_to_delta('5m 30s')
 
593
    datetime.timedelta(0, 330)
566
594
    """
567
 
    try:
568
 
        suffix=unicode(interval[-1])
569
 
        value=int(interval[:-1])
570
 
        if suffix == u"d":
571
 
            delta = datetime.timedelta(value)
572
 
        elif suffix == u"s":
573
 
            delta = datetime.timedelta(0, value)
574
 
        elif suffix == u"m":
575
 
            delta = datetime.timedelta(0, 0, 0, 0, value)
576
 
        elif suffix == u"h":
577
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
578
 
        elif suffix == u"w":
579
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
580
 
        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):
581
613
            raise ValueError
582
 
    except (ValueError, IndexError):
583
 
        raise ValueError
584
 
    return delta
 
614
        timevalue += delta
 
615
    return timevalue
585
616
 
586
617
 
587
618
def server_state_changed(state):
588
619
    """Derived from the Avahi example code"""
589
620
    if state == avahi.SERVER_COLLISION:
590
 
        logger.error(u"Server name collision")
 
621
        logger.error(u"Zeroconf server name collision")
591
622
        service.remove()
592
623
    elif state == avahi.SERVER_RUNNING:
593
624
        service.add()
595
626
 
596
627
def entry_group_state_changed(state, error):
597
628
    """Derived from the Avahi example code"""
598
 
    logger.debug(u"state change: %i", state)
 
629
    logger.debug(u"Avahi state change: %i", state)
599
630
    
600
631
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
601
 
        logger.debug(u"Service established.")
 
632
        logger.debug(u"Zeroconf service established.")
602
633
    elif state == avahi.ENTRY_GROUP_COLLISION:
603
 
        logger.warning(u"Service name collision.")
 
634
        logger.warning(u"Zeroconf service name collision.")
604
635
        service.rename()
605
636
    elif state == avahi.ENTRY_GROUP_FAILURE:
606
 
        logger.critical(u"Error in group state changed %s",
 
637
        logger.critical(u"Avahi: Error in group state changed %s",
607
638
                        unicode(error))
608
639
        raise AvahiGroupError("State changed: %s", str(error))
609
640
 
611
642
    """Call the C function if_nametoindex(), or equivalent"""
612
643
    global if_nametoindex
613
644
    try:
614
 
        if "ctypes.util" not in sys.modules:
615
 
            import ctypes.util
616
645
        if_nametoindex = ctypes.cdll.LoadLibrary\
617
646
            (ctypes.util.find_library("c")).if_nametoindex
618
647
    except (OSError, AttributeError):
656
685
 
657
686
 
658
687
def main():
659
 
    global main_loop_started
660
 
    main_loop_started = False
661
 
    
662
688
    parser = OptionParser(version = "%%prog %s" % version)
663
689
    parser.add_option("-i", "--interface", type="string",
664
690
                      metavar="IF", help="Bind to interface IF")
679
705
                      default="/etc/mandos", metavar="DIR",
680
706
                      help="Directory to search for configuration"
681
707
                      " files")
682
 
    (options, args) = parser.parse_args()
 
708
    options = parser.parse_args()[0]
683
709
    
684
710
    if options.check:
685
711
        import doctest
700
726
    server_config = ConfigParser.SafeConfigParser(server_defaults)
701
727
    del server_defaults
702
728
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
703
 
    server_section = "server"
704
729
    # Convert the SafeConfigParser object to a dict
705
 
    server_settings = dict(server_config.items(server_section))
 
730
    server_settings = server_config.defaults()
706
731
    # Use getboolean on the boolean config option
707
732
    server_settings["debug"] = server_config.getboolean\
708
 
                               (server_section, "debug")
 
733
                               ("DEFAULT", "debug")
709
734
    del server_config
710
735
    
711
736
    # Override the settings from the config file with command line
733
758
    # Parse config file with clients
734
759
    client_defaults = { "timeout": "1h",
735
760
                        "interval": "5m",
736
 
                        "checker": "fping -q -- %%(host)s",
 
761
                        "checker": "fping -q -- %(host)s",
 
762
                        "host": "",
737
763
                        }
738
764
    client_config = ConfigParser.SafeConfigParser(client_defaults)
739
765
    client_config.read(os.path.join(server_settings["configdir"],
740
766
                                    "clients.conf"))
741
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
    
742
803
    global service
743
804
    service = AvahiService(name = server_settings["servicename"],
744
 
                           type = "_mandos._tcp", );
 
805
                           servicetype = "_mandos._tcp", )
745
806
    if server_settings["interface"]:
746
 
        service.interface = if_nametoindex(server_settings["interface"])
 
807
        service.interface = if_nametoindex\
 
808
                            (server_settings["interface"])
747
809
    
748
810
    global main_loop
749
811
    global bus
752
814
    DBusGMainLoop(set_as_default=True )
753
815
    main_loop = gobject.MainLoop()
754
816
    bus = dbus.SystemBus()
755
 
    server = dbus.Interface(
756
 
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
757
 
            avahi.DBUS_INTERFACE_SERVER )
 
817
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
 
818
                                           avahi.DBUS_PATH_SERVER),
 
819
                            avahi.DBUS_INTERFACE_SERVER)
758
820
    # End of Avahi example code
759
821
    
760
 
    clients = Set()
761
822
    def remove_from_clients(client):
762
823
        clients.remove(client)
763
824
        if not clients:
773
834
        logger.critical(u"No clients defined")
774
835
        sys.exit(1)
775
836
    
776
 
    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
777
845
        logger.removeHandler(console)
 
846
        # Close all input and output, do double fork, etc.
778
847
        daemon()
779
848
    
780
 
    pidfilename = "/var/run/mandos/mandos.pid"
781
 
    pid = os.getpid()
782
849
    try:
783
 
        pidfile = open(pidfilename, "w")
 
850
        pid = os.getpid()
784
851
        pidfile.write(str(pid) + "\n")
785
852
        pidfile.close()
786
853
        del pidfile
787
 
    except IOError, err:
788
 
        logger.error(u"Could not write %s file with PID %d",
789
 
                     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
790
861
    
791
862
    def cleanup():
792
863
        "Cleanup function; run on exit"
812
883
    for client in clients:
813
884
        client.start()
814
885
    
815
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
816
 
                                 server_settings["port"]),
817
 
                                tcp_handler,
818
 
                                settings=server_settings,
819
 
                                clients=clients)
 
886
    tcp_server.enable()
 
887
    tcp_server.server_activate()
 
888
    
820
889
    # Find out what port we got
821
890
    service.port = tcp_server.socket.getsockname()[1]
822
891
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
840
909
                             (*args[2:], **kwargs) or True)
841
910
        
842
911
        logger.debug(u"Starting main loop")
843
 
        main_loop_started = True
844
912
        main_loop.run()
845
913
    except AvahiError, error:
846
914
        logger.critical(u"AvahiError: %s" + unicode(error))