/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

version 1.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008 Teddy Hogeborn & Björn Påhlsson
 
14
# Copyright © 2007-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
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
34
33
 
35
34
import SocketServer
36
35
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
58
57
 
59
58
import dbus
60
59
import gobject
61
60
import avahi
62
61
from dbus.mainloop.glib import DBusGMainLoop
63
62
import ctypes
64
 
import ctypes.util
65
63
 
66
 
version = "1.0.1"
 
64
version = "1.0"
67
65
 
68
66
logger = logging.Logger('mandos')
69
67
syslogger = logging.handlers.SysLogHandler\
73
71
                        ('Mandos: %(levelname)s: %(message)s'))
74
72
logger.addHandler(syslogger)
75
73
 
76
 
console = logging.StreamHandler()
77
 
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
78
 
                                       ' %(message)s'))
79
 
logger.addHandler(console)
80
74
 
81
75
class AvahiError(Exception):
82
76
    def __init__(self, value):
83
77
        self.value = value
84
 
        super(AvahiError, self).__init__()
85
78
    def __str__(self):
86
79
        return repr(self.value)
87
80
 
109
102
                  a sensible number of times
110
103
    """
111
104
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
112
 
                 servicetype = None, port = None, TXT = None, domain = "",
 
105
                 type = None, port = None, TXT = None, domain = "",
113
106
                 host = "", max_renames = 32768):
114
107
        self.interface = interface
115
108
        self.name = name
116
 
        self.type = servicetype
 
109
        self.type = type
117
110
        self.port = port
118
111
        if TXT is None:
119
112
            self.TXT = []
122
115
        self.domain = domain
123
116
        self.host = host
124
117
        self.rename_count = 0
125
 
        self.max_renames = max_renames
126
118
    def rename(self):
127
119
        """Derived from the Avahi example code"""
128
120
        if self.rename_count >= self.max_renames:
129
 
            logger.critical(u"No suitable Zeroconf service name found"
130
 
                            u" after %i retries, exiting.",
131
 
                            self.rename_count)
 
121
            logger.critical(u"No suitable service name found after %i"
 
122
                            u" retries, exiting.", rename_count)
132
123
            raise AvahiServiceError("Too many renames")
133
 
        self.name = server.GetAlternativeServiceName(self.name)
134
 
        logger.info(u"Changing Zeroconf service name to %r ...",
135
 
                    str(self.name))
 
124
        name = server.GetAlternativeServiceName(name)
 
125
        logger.error(u"Changing name to %r ...", name)
136
126
        syslogger.setFormatter(logging.Formatter\
137
127
                               ('Mandos (%s): %%(levelname)s:'
138
 
                               ' %%(message)s' % self.name))
 
128
                               ' %%(message)s' % name))
139
129
        self.remove()
140
130
        self.add()
141
131
        self.rename_count += 1
153
143
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
144
            group.connect_to_signal('StateChanged',
155
145
                                    entry_group_state_changed)
156
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
 
146
        logger.debug(u"Adding service '%s' of type '%s' ...",
157
147
                     service.name, service.type)
158
148
        group.AddService(
159
149
                self.interface,         # interface
223
213
    interval = property(lambda self: self._interval,
224
214
                        _set_interval)
225
215
    del _set_interval
226
 
    def __init__(self, name = None, stop_hook=None, config=None):
 
216
    def __init__(self, name = None, stop_hook=None, config={}):
227
217
        """Note: the 'checker' key in 'config' sets the
228
218
        'checker_command' attribute and *not* the 'checker'
229
219
        attribute."""
230
 
        if config is None:
231
 
            config = {}
232
220
        self.name = name
233
221
        logger.debug(u"Creating client %r", self.name)
234
222
        # Uppercase and remove spaces from fingerprint for later
240
228
        if "secret" in config:
241
229
            self.secret = config["secret"].decode(u"base64")
242
230
        elif "secfile" in config:
243
 
            secfile = open(os.path.expanduser(os.path.expandvars
244
 
                                              (config["secfile"])))
245
 
            self.secret = secfile.read()
246
 
            secfile.close()
 
231
            sf = open(config["secfile"])
 
232
            self.secret = sf.read()
 
233
            sf.close()
247
234
        else:
248
235
            raise TypeError(u"No secret or secfile for client %s"
249
236
                            % self.name)
345
332
            try:
346
333
                logger.info(u"Starting checker %r for %s",
347
334
                            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.)
352
335
                self.checker = subprocess.Popen(command,
353
336
                                                close_fds=True,
354
337
                                                shell=True, cwd="/")
355
338
                self.checker_callback_tag = gobject.child_watch_add\
356
339
                                            (self.checker.pid,
357
340
                                             self.checker_callback)
358
 
            except OSError, error:
 
341
            except subprocess.OSError, error:
359
342
                logger.error(u"Failed to start subprocess: %s",
360
343
                             error)
361
344
        # Re-run this periodically if run by gobject.timeout_add
418
401
    gnutls.library.functions.gnutls_openpgp_crt_import\
419
402
                    (crt, ctypes.byref(datum),
420
403
                     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")
428
404
    # New buffer for the fingerprint
429
 
    buf = ctypes.create_string_buffer(20)
430
 
    buf_len = ctypes.c_size_t()
 
405
    buffer = ctypes.create_string_buffer(20)
 
406
    buffer_length = ctypes.c_size_t()
431
407
    # Get the fingerprint from the certificate into the buffer
432
408
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
433
 
        (crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
409
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
434
410
    # Deinit the certificate
435
411
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
436
412
    # Convert the buffer to a Python bytestring
437
 
    fpr = ctypes.string_at(buf, buf_len.value)
 
413
    fpr = ctypes.string_at(buffer, buffer_length.value)
438
414
    # Convert the bytestring to hexadecimal notation
439
415
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
440
416
    return hex_fpr
441
417
 
442
418
 
443
 
class TCP_handler(SocketServer.BaseRequestHandler, object):
 
419
class tcp_handler(SocketServer.BaseRequestHandler, object):
444
420
    """A TCP request handler class.
445
421
    Instantiated by IPv6_TCPServer for each request to handle it.
446
422
    Note: This will run in its own forked process."""
473
449
        if self.server.settings["priority"]:
474
450
            priority = self.server.settings["priority"]
475
451
        gnutls.library.functions.gnutls_priority_set_direct\
476
 
            (session._c_object, priority, None)
 
452
            (session._c_object, priority, None);
477
453
        
478
454
        try:
479
455
            session.handshake()
522
498
    Attributes:
523
499
        settings:       Server settings
524
500
        clients:        Set() of Client objects
525
 
        enabled:        Boolean; whether this server is activated yet
526
501
    """
527
502
    address_family = socket.AF_INET6
528
503
    def __init__(self, *args, **kwargs):
532
507
        if "clients" in kwargs:
533
508
            self.clients = kwargs["clients"]
534
509
            del kwargs["clients"]
535
 
        self.enabled = False
536
 
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
 
510
        return super(type(self), self).__init__(*args, **kwargs)
537
511
    def server_bind(self):
538
512
        """This overrides the normal server_bind() function
539
513
        to bind to an interface if one was specified, and also NOT to
568
542
#                                            if_nametoindex
569
543
#                                            (self.settings
570
544
#                                             ["interface"]))
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
 
545
            return super(type(self), self).server_bind()
577
546
 
578
547
 
579
548
def string_to_delta(interval):
589
558
    datetime.timedelta(1)
590
559
    >>> string_to_delta(u'1w')
591
560
    datetime.timedelta(7)
592
 
    >>> string_to_delta('5m 30s')
593
 
    datetime.timedelta(0, 330)
594
561
    """
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):
 
562
    try:
 
563
        suffix=unicode(interval[-1])
 
564
        value=int(interval[:-1])
 
565
        if suffix == u"d":
 
566
            delta = datetime.timedelta(value)
 
567
        elif suffix == u"s":
 
568
            delta = datetime.timedelta(0, value)
 
569
        elif suffix == u"m":
 
570
            delta = datetime.timedelta(0, 0, 0, 0, value)
 
571
        elif suffix == u"h":
 
572
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
573
        elif suffix == u"w":
 
574
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
575
        else:
613
576
            raise ValueError
614
 
        timevalue += delta
615
 
    return timevalue
 
577
    except (ValueError, IndexError):
 
578
        raise ValueError
 
579
    return delta
616
580
 
617
581
 
618
582
def server_state_changed(state):
619
583
    """Derived from the Avahi example code"""
620
584
    if state == avahi.SERVER_COLLISION:
621
 
        logger.error(u"Zeroconf server name collision")
 
585
        logger.error(u"Server name collision")
622
586
        service.remove()
623
587
    elif state == avahi.SERVER_RUNNING:
624
588
        service.add()
626
590
 
627
591
def entry_group_state_changed(state, error):
628
592
    """Derived from the Avahi example code"""
629
 
    logger.debug(u"Avahi state change: %i", state)
 
593
    logger.debug(u"state change: %i", state)
630
594
    
631
595
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
632
 
        logger.debug(u"Zeroconf service established.")
 
596
        logger.debug(u"Service established.")
633
597
    elif state == avahi.ENTRY_GROUP_COLLISION:
634
 
        logger.warning(u"Zeroconf service name collision.")
 
598
        logger.warning(u"Service name collision.")
635
599
        service.rename()
636
600
    elif state == avahi.ENTRY_GROUP_FAILURE:
637
 
        logger.critical(u"Avahi: Error in group state changed %s",
 
601
        logger.critical(u"Error in group state changed %s",
638
602
                        unicode(error))
639
603
        raise AvahiGroupError("State changed: %s", str(error))
640
604
 
642
606
    """Call the C function if_nametoindex(), or equivalent"""
643
607
    global if_nametoindex
644
608
    try:
 
609
        if "ctypes.util" not in sys.modules:
 
610
            import ctypes.util
645
611
        if_nametoindex = ctypes.cdll.LoadLibrary\
646
612
            (ctypes.util.find_library("c")).if_nametoindex
647
613
    except (OSError, AttributeError):
685
651
 
686
652
 
687
653
def main():
688
 
    parser = OptionParser(version = "%%prog %s" % version)
 
654
    global main_loop_started
 
655
    main_loop_started = False
 
656
    
 
657
    parser = OptionParser(version = "Mandos server %s" % version)
689
658
    parser.add_option("-i", "--interface", type="string",
690
659
                      metavar="IF", help="Bind to interface IF")
691
660
    parser.add_option("-a", "--address", type="string",
705
674
                      default="/etc/mandos", metavar="DIR",
706
675
                      help="Directory to search for configuration"
707
676
                      " files")
708
 
    options = parser.parse_args()[0]
 
677
    (options, args) = parser.parse_args()
709
678
    
710
679
    if options.check:
711
680
        import doctest
726
695
    server_config = ConfigParser.SafeConfigParser(server_defaults)
727
696
    del server_defaults
728
697
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
698
    server_section = "server"
729
699
    # Convert the SafeConfigParser object to a dict
730
 
    server_settings = server_config.defaults()
 
700
    server_settings = dict(server_config.items(server_section))
731
701
    # Use getboolean on the boolean config option
732
702
    server_settings["debug"] = server_config.getboolean\
733
 
                               ("DEFAULT", "debug")
 
703
                               (server_section, "debug")
734
704
    del server_config
735
705
    
736
706
    # Override the settings from the config file with command line
747
717
    
748
718
    if not debug:
749
719
        syslogger.setLevel(logging.WARNING)
750
 
        console.setLevel(logging.WARNING)
751
720
    
752
721
    if server_settings["servicename"] != "Mandos":
753
722
        syslogger.setFormatter(logging.Formatter\
758
727
    # Parse config file with clients
759
728
    client_defaults = { "timeout": "1h",
760
729
                        "interval": "5m",
761
 
                        "checker": "fping -q -- %(host)s",
762
 
                        "host": "",
 
730
                        "checker": "fping -q -- %%(host)s",
763
731
                        }
764
732
    client_config = ConfigParser.SafeConfigParser(client_defaults)
765
733
    client_config.read(os.path.join(server_settings["configdir"],
766
734
                                    "clients.conf"))
767
735
    
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
 
    
803
736
    global service
804
737
    service = AvahiService(name = server_settings["servicename"],
805
 
                           servicetype = "_mandos._tcp", )
 
738
                           type = "_mandos._tcp", );
806
739
    if server_settings["interface"]:
807
 
        service.interface = if_nametoindex\
808
 
                            (server_settings["interface"])
 
740
        service.interface = if_nametoindex(server_settings["interface"])
809
741
    
810
742
    global main_loop
811
743
    global bus
814
746
    DBusGMainLoop(set_as_default=True )
815
747
    main_loop = gobject.MainLoop()
816
748
    bus = dbus.SystemBus()
817
 
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
818
 
                                           avahi.DBUS_PATH_SERVER),
819
 
                            avahi.DBUS_INTERFACE_SERVER)
 
749
    server = dbus.Interface(
 
750
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
751
            avahi.DBUS_INTERFACE_SERVER )
820
752
    # End of Avahi example code
821
753
    
 
754
    if debug:
 
755
        console = logging.StreamHandler()
 
756
        # console.setLevel(logging.DEBUG)
 
757
        console.setFormatter(logging.Formatter\
 
758
                             ('%(levelname)s: %(message)s'))
 
759
        logger.addHandler(console)
 
760
        del console
 
761
    
 
762
    clients = Set()
822
763
    def remove_from_clients(client):
823
764
        clients.remove(client)
824
765
        if not clients:
834
775
        logger.critical(u"No clients defined")
835
776
        sys.exit(1)
836
777
    
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
845
 
        logger.removeHandler(console)
846
 
        # Close all input and output, do double fork, etc.
 
778
    if not debug:
847
779
        daemon()
848
780
    
 
781
    pidfilename = "/var/run/mandos/mandos.pid"
 
782
    pid = os.getpid()
849
783
    try:
850
 
        pid = os.getpid()
 
784
        pidfile = open(pidfilename, "w")
851
785
        pidfile.write(str(pid) + "\n")
852
786
        pidfile.close()
853
787
        del pidfile
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
 
788
    except IOError, err:
 
789
        logger.error(u"Could not write %s file with PID %d",
 
790
                     pidfilename, os.getpid())
861
791
    
862
792
    def cleanup():
863
793
        "Cleanup function; run on exit"
883
813
    for client in clients:
884
814
        client.start()
885
815
    
886
 
    tcp_server.enable()
887
 
    tcp_server.server_activate()
888
 
    
 
816
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
817
                                 server_settings["port"]),
 
818
                                tcp_handler,
 
819
                                settings=server_settings,
 
820
                                clients=clients)
889
821
    # Find out what port we got
890
822
    service.port = tcp_server.socket.getsockname()[1]
891
823
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
909
841
                             (*args[2:], **kwargs) or True)
910
842
        
911
843
        logger.debug(u"Starting main loop")
 
844
        main_loop_started = True
912
845
        main_loop.run()
913
846
    except AvahiError, error:
914
847
        logger.critical(u"AvahiError: %s" + unicode(error))