/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

removed * [[http://en.tldp.org/HOWTO/Software-Release-Practice-HOWTO/][Software Release Practice HOWTO]]

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