/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-09-30 03:19:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930031939-t72se4dhr632o9ct
* Makefile: Add HTML rules for manual pages.
  (DOCBOOKTOHTML, HTMLPOST): New commands.
  (htmldocs): New file list.
  (html, install-html): New targets.
  (.PHONY, clean): Added "html".

* README (The Plugin System): New section; describe plugin system.

* debian/control (Uploaders): New field.

* mandos-options.xml (servicename): Improve wording.

* plugins.d/mandos-client.xml (SECURITY): Improve wording.

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
 
 
66
version = "1.0"
64
67
 
65
68
logger = logging.Logger('mandos')
66
69
syslogger = logging.handlers.SysLogHandler\
67
 
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
 
70
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
71
             address = "/dev/log")
68
72
syslogger.setFormatter(logging.Formatter\
69
 
                        ('%(levelname)s: %(message)s'))
 
73
                        ('Mandos: %(levelname)s: %(message)s'))
70
74
logger.addHandler(syslogger)
71
 
del syslogger
72
75
 
 
76
console = logging.StreamHandler()
 
77
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
 
78
                                       ' %(message)s'))
 
79
logger.addHandler(console)
73
80
 
74
81
class AvahiError(Exception):
75
82
    def __init__(self, value):
76
83
        self.value = value
 
84
        super(AvahiError, self).__init__()
77
85
    def __str__(self):
78
86
        return repr(self.value)
79
87
 
101
109
                  a sensible number of times
102
110
    """
103
111
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
104
 
                 type = None, port = None, TXT = None, domain = "",
105
 
                 host = "", max_renames = 12):
 
112
                 servicetype = None, port = None, TXT = None, domain = "",
 
113
                 host = "", max_renames = 32768):
106
114
        self.interface = interface
107
115
        self.name = name
108
 
        self.type = type
 
116
        self.type = servicetype
109
117
        self.port = port
110
118
        if TXT is None:
111
119
            self.TXT = []
114
122
        self.domain = domain
115
123
        self.host = host
116
124
        self.rename_count = 0
 
125
        self.max_renames = max_renames
117
126
    def rename(self):
118
127
        """Derived from the Avahi example code"""
119
128
        if self.rename_count >= self.max_renames:
120
 
            logger.critical(u"No suitable service name found after %i"
121
 
                            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)
122
132
            raise AvahiServiceError("Too many renames")
123
 
        name = server.GetAlternativeServiceName(name)
124
 
        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))
 
136
        syslogger.setFormatter(logging.Formatter\
 
137
                               ('Mandos (%s): %%(levelname)s:'
 
138
                               ' %%(message)s' % self.name))
125
139
        self.remove()
126
140
        self.add()
127
141
        self.rename_count += 1
139
153
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
140
154
            group.connect_to_signal('StateChanged',
141
155
                                    entry_group_state_changed)
142
 
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
156
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
143
157
                     service.name, service.type)
144
158
        group.AddService(
145
159
                self.interface,         # interface
163
177
    fingerprint: string (40 or 32 hexadecimal digits); used to
164
178
                 uniquely identify the client
165
179
    secret:    bytestring; sent verbatim (over TLS) to client
166
 
    fqdn:      string (FQDN); available for use by the checker command
 
180
    host:      string; available for use by the checker command
167
181
    created:   datetime.datetime(); object creation, not client host
168
182
    last_checked_ok: datetime.datetime() or None if not yet checked OK
169
183
    timeout:   datetime.timedelta(); How long from last_checked_ok
209
223
    interval = property(lambda self: self._interval,
210
224
                        _set_interval)
211
225
    del _set_interval
212
 
    def __init__(self, name = None, stop_hook=None, config={}):
 
226
    def __init__(self, name = None, stop_hook=None, config=None):
213
227
        """Note: the 'checker' key in 'config' sets the
214
228
        'checker_command' attribute and *not* the 'checker'
215
229
        attribute."""
 
230
        if config is None:
 
231
            config = {}
216
232
        self.name = name
217
233
        logger.debug(u"Creating client %r", self.name)
218
234
        # Uppercase and remove spaces from fingerprint for later
224
240
        if "secret" in config:
225
241
            self.secret = config["secret"].decode(u"base64")
226
242
        elif "secfile" in config:
227
 
            sf = open(config["secfile"])
228
 
            self.secret = sf.read()
229
 
            sf.close()
 
243
            secfile = open(config["secfile"])
 
244
            self.secret = secfile.read()
 
245
            secfile.close()
230
246
        else:
231
247
            raise TypeError(u"No secret or secfile for client %s"
232
248
                            % self.name)
233
 
        self.fqdn = config.get("fqdn", "")
 
249
        self.host = config.get("host", "")
234
250
        self.created = datetime.datetime.now()
235
251
        self.last_checked_ok = None
236
252
        self.timeout = string_to_delta(config["timeout"])
259
275
        The possibility that a client might be restarted is left open,
260
276
        but not currently used."""
261
277
        # If this client doesn't have a secret, it is already stopped.
262
 
        if self.secret:
 
278
        if hasattr(self, "secret") and self.secret:
263
279
            logger.info(u"Stopping client %s", self.name)
264
280
            self.secret = None
265
281
        else:
313
329
        if self.checker is None:
314
330
            try:
315
331
                # In case check_command has exactly one % operator
316
 
                command = self.check_command % self.fqdn
 
332
                command = self.check_command % self.host
317
333
            except TypeError:
318
334
                # Escape attributes for the shell
319
335
                escaped_attrs = dict((key, re.escape(str(val)))
328
344
            try:
329
345
                logger.info(u"Starting checker %r for %s",
330
346
                            command, self.name)
 
347
                # We don't need to redirect stdout and stderr, since
 
348
                # in normal mode, that is already done by daemon(),
 
349
                # and in debug mode we don't want to.  (Stdin is
 
350
                # always replaced by /dev/null.)
331
351
                self.checker = subprocess.Popen(command,
332
352
                                                close_fds=True,
333
353
                                                shell=True, cwd="/")
334
354
                self.checker_callback_tag = gobject.child_watch_add\
335
355
                                            (self.checker.pid,
336
356
                                             self.checker_callback)
337
 
            except subprocess.OSError, error:
 
357
            except OSError, error:
338
358
                logger.error(u"Failed to start subprocess: %s",
339
359
                             error)
340
360
        # Re-run this periodically if run by gobject.timeout_add
346
366
            self.checker_callback_tag = None
347
367
        if getattr(self, "checker", None) is None:
348
368
            return
349
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
369
        logger.debug(u"Stopping checker for %(name)s", vars(self))
350
370
        try:
351
371
            os.kill(self.checker.pid, signal.SIGTERM)
352
372
            #os.sleep(0.5)
397
417
    gnutls.library.functions.gnutls_openpgp_crt_import\
398
418
                    (crt, ctypes.byref(datum),
399
419
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
420
    # Verify the self signature in the key
 
421
    crtverify = ctypes.c_uint()
 
422
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
 
423
        (crt, 0, ctypes.byref(crtverify))
 
424
    if crtverify.value != 0:
 
425
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
426
        raise gnutls.errors.CertificateSecurityError("Verify failed")
400
427
    # New buffer for the fingerprint
401
 
    buffer = ctypes.create_string_buffer(20)
402
 
    buffer_length = ctypes.c_size_t()
 
428
    buf = ctypes.create_string_buffer(20)
 
429
    buf_len = ctypes.c_size_t()
403
430
    # Get the fingerprint from the certificate into the buffer
404
431
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
405
 
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
432
        (crt, ctypes.byref(buf), ctypes.byref(buf_len))
406
433
    # Deinit the certificate
407
434
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
408
435
    # Convert the buffer to a Python bytestring
409
 
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
436
    fpr = ctypes.string_at(buf, buf_len.value)
410
437
    # Convert the bytestring to hexadecimal notation
411
438
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
412
439
    return hex_fpr
413
440
 
414
441
 
415
 
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
442
class TCP_handler(SocketServer.BaseRequestHandler, object):
416
443
    """A TCP request handler class.
417
444
    Instantiated by IPv6_TCPServer for each request to handle it.
418
445
    Note: This will run in its own forked process."""
445
472
        if self.server.settings["priority"]:
446
473
            priority = self.server.settings["priority"]
447
474
        gnutls.library.functions.gnutls_priority_set_direct\
448
 
            (session._c_object, priority, None);
 
475
            (session._c_object, priority, None)
449
476
        
450
477
        try:
451
478
            session.handshake()
494
521
    Attributes:
495
522
        settings:       Server settings
496
523
        clients:        Set() of Client objects
 
524
        enabled:        Boolean; whether this server is activated yet
497
525
    """
498
526
    address_family = socket.AF_INET6
499
527
    def __init__(self, *args, **kwargs):
503
531
        if "clients" in kwargs:
504
532
            self.clients = kwargs["clients"]
505
533
            del kwargs["clients"]
506
 
        return super(type(self), self).__init__(*args, **kwargs)
 
534
        self.enabled = False
 
535
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
507
536
    def server_bind(self):
508
537
        """This overrides the normal server_bind() function
509
538
        to bind to an interface if one was specified, and also NOT to
538
567
#                                            if_nametoindex
539
568
#                                            (self.settings
540
569
#                                             ["interface"]))
541
 
            return super(type(self), self).server_bind()
 
570
            return super(IPv6_TCPServer, self).server_bind()
 
571
    def server_activate(self):
 
572
        if self.enabled:
 
573
            return super(IPv6_TCPServer, self).server_activate()
 
574
    def enable(self):
 
575
        self.enabled = True
542
576
 
543
577
 
544
578
def string_to_delta(interval):
554
588
    datetime.timedelta(1)
555
589
    >>> string_to_delta(u'1w')
556
590
    datetime.timedelta(7)
 
591
    >>> string_to_delta('5m 30s')
 
592
    datetime.timedelta(0, 330)
557
593
    """
558
 
    try:
559
 
        suffix=unicode(interval[-1])
560
 
        value=int(interval[:-1])
561
 
        if suffix == u"d":
562
 
            delta = datetime.timedelta(value)
563
 
        elif suffix == u"s":
564
 
            delta = datetime.timedelta(0, value)
565
 
        elif suffix == u"m":
566
 
            delta = datetime.timedelta(0, 0, 0, 0, value)
567
 
        elif suffix == u"h":
568
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
569
 
        elif suffix == u"w":
570
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
571
 
        else:
 
594
    timevalue = datetime.timedelta(0)
 
595
    for s in interval.split():
 
596
        try:
 
597
            suffix = unicode(s[-1])
 
598
            value = int(s[:-1])
 
599
            if suffix == u"d":
 
600
                delta = datetime.timedelta(value)
 
601
            elif suffix == u"s":
 
602
                delta = datetime.timedelta(0, value)
 
603
            elif suffix == u"m":
 
604
                delta = datetime.timedelta(0, 0, 0, 0, value)
 
605
            elif suffix == u"h":
 
606
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
607
            elif suffix == u"w":
 
608
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
609
            else:
 
610
                raise ValueError
 
611
        except (ValueError, IndexError):
572
612
            raise ValueError
573
 
    except (ValueError, IndexError):
574
 
        raise ValueError
575
 
    return delta
 
613
        timevalue += delta
 
614
    return timevalue
576
615
 
577
616
 
578
617
def server_state_changed(state):
579
618
    """Derived from the Avahi example code"""
580
619
    if state == avahi.SERVER_COLLISION:
581
 
        logger.error(u"Server name collision")
 
620
        logger.error(u"Zeroconf server name collision")
582
621
        service.remove()
583
622
    elif state == avahi.SERVER_RUNNING:
584
623
        service.add()
586
625
 
587
626
def entry_group_state_changed(state, error):
588
627
    """Derived from the Avahi example code"""
589
 
    logger.debug(u"state change: %i", state)
 
628
    logger.debug(u"Avahi state change: %i", state)
590
629
    
591
630
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
592
 
        logger.debug(u"Service established.")
 
631
        logger.debug(u"Zeroconf service established.")
593
632
    elif state == avahi.ENTRY_GROUP_COLLISION:
594
 
        logger.warning(u"Service name collision.")
 
633
        logger.warning(u"Zeroconf service name collision.")
595
634
        service.rename()
596
635
    elif state == avahi.ENTRY_GROUP_FAILURE:
597
 
        logger.critical(u"Error in group state changed %s",
 
636
        logger.critical(u"Avahi: Error in group state changed %s",
598
637
                        unicode(error))
599
638
        raise AvahiGroupError("State changed: %s", str(error))
600
639
 
602
641
    """Call the C function if_nametoindex(), or equivalent"""
603
642
    global if_nametoindex
604
643
    try:
605
 
        if "ctypes.util" not in sys.modules:
606
 
            import ctypes.util
607
644
        if_nametoindex = ctypes.cdll.LoadLibrary\
608
645
            (ctypes.util.find_library("c")).if_nametoindex
609
646
    except (OSError, AttributeError):
647
684
 
648
685
 
649
686
def main():
650
 
    global main_loop_started
651
 
    main_loop_started = False
652
 
    
653
 
    parser = OptionParser()
 
687
    parser = OptionParser(version = "%%prog %s" % version)
654
688
    parser.add_option("-i", "--interface", type="string",
655
689
                      metavar="IF", help="Bind to interface IF")
656
690
    parser.add_option("-a", "--address", type="string",
670
704
                      default="/etc/mandos", metavar="DIR",
671
705
                      help="Directory to search for configuration"
672
706
                      " files")
673
 
    (options, args) = parser.parse_args()
 
707
    options = parser.parse_args()[0]
674
708
    
675
709
    if options.check:
676
710
        import doctest
691
725
    server_config = ConfigParser.SafeConfigParser(server_defaults)
692
726
    del server_defaults
693
727
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
694
 
    server_section = "server"
695
728
    # Convert the SafeConfigParser object to a dict
696
 
    server_settings = dict(server_config.items(server_section))
 
729
    server_settings = server_config.defaults()
697
730
    # Use getboolean on the boolean config option
698
731
    server_settings["debug"] = server_config.getboolean\
699
 
                               (server_section, "debug")
 
732
                               ("DEFAULT", "debug")
700
733
    del server_config
701
734
    
702
735
    # Override the settings from the config file with command line
709
742
    del options
710
743
    # Now we have our good server settings in "server_settings"
711
744
    
 
745
    debug = server_settings["debug"]
 
746
    
 
747
    if not debug:
 
748
        syslogger.setLevel(logging.WARNING)
 
749
        console.setLevel(logging.WARNING)
 
750
    
 
751
    if server_settings["servicename"] != "Mandos":
 
752
        syslogger.setFormatter(logging.Formatter\
 
753
                               ('Mandos (%s): %%(levelname)s:'
 
754
                                ' %%(message)s'
 
755
                                % server_settings["servicename"]))
 
756
    
712
757
    # Parse config file with clients
713
758
    client_defaults = { "timeout": "1h",
714
759
                        "interval": "5m",
715
 
                        "checker": "fping -q -- %%(fqdn)s",
 
760
                        "checker": "fping -q -- %(host)s",
 
761
                        "host": "",
716
762
                        }
717
763
    client_config = ConfigParser.SafeConfigParser(client_defaults)
718
764
    client_config.read(os.path.join(server_settings["configdir"],
719
765
                                    "clients.conf"))
720
766
    
 
767
    clients = Set()
 
768
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
769
                                 server_settings["port"]),
 
770
                                TCP_handler,
 
771
                                settings=server_settings,
 
772
                                clients=clients)
 
773
    pidfilename = "/var/run/mandos.pid"
 
774
    try:
 
775
        pidfile = open(pidfilename, "w")
 
776
    except IOError, error:
 
777
        logger.error("Could not open file %r", pidfilename)
 
778
    
 
779
    uid = 65534
 
780
    gid = 65534
 
781
    try:
 
782
        uid = pwd.getpwnam("mandos").pw_uid
 
783
    except KeyError:
 
784
        try:
 
785
            uid = pwd.getpwnam("nobody").pw_uid
 
786
        except KeyError:
 
787
            pass
 
788
    try:
 
789
        gid = pwd.getpwnam("mandos").pw_gid
 
790
    except KeyError:
 
791
        try:
 
792
            gid = pwd.getpwnam("nogroup").pw_gid
 
793
        except KeyError:
 
794
            pass
 
795
    try:
 
796
        os.setuid(uid)
 
797
        os.setgid(gid)
 
798
    except OSError, error:
 
799
        if error[0] != errno.EPERM:
 
800
            raise error
 
801
    
721
802
    global service
722
803
    service = AvahiService(name = server_settings["servicename"],
723
 
                           type = "_mandos._tcp", );
 
804
                           servicetype = "_mandos._tcp", )
724
805
    if server_settings["interface"]:
725
 
        service.interface = if_nametoindex(server_settings["interface"])
 
806
        service.interface = if_nametoindex\
 
807
                            (server_settings["interface"])
726
808
    
727
809
    global main_loop
728
810
    global bus
731
813
    DBusGMainLoop(set_as_default=True )
732
814
    main_loop = gobject.MainLoop()
733
815
    bus = dbus.SystemBus()
734
 
    server = dbus.Interface(
735
 
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
736
 
            avahi.DBUS_INTERFACE_SERVER )
 
816
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
 
817
                                           avahi.DBUS_PATH_SERVER),
 
818
                            avahi.DBUS_INTERFACE_SERVER)
737
819
    # End of Avahi example code
738
820
    
739
 
    debug = server_settings["debug"]
740
 
    
741
 
    if debug:
742
 
        console = logging.StreamHandler()
743
 
        # console.setLevel(logging.DEBUG)
744
 
        console.setFormatter(logging.Formatter\
745
 
                             ('%(levelname)s: %(message)s'))
746
 
        logger.addHandler(console)
747
 
        del console
748
 
    
749
 
    clients = Set()
750
821
    def remove_from_clients(client):
751
822
        clients.remove(client)
752
823
        if not clients:
758
829
                              config
759
830
                              = dict(client_config.items(section)))
760
831
                       for section in client_config.sections()))
 
832
    if not clients:
 
833
        logger.critical(u"No clients defined")
 
834
        sys.exit(1)
761
835
    
762
 
    if not debug:
 
836
    if debug:
 
837
        # Redirect stdin so all checkers get /dev/null
 
838
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
839
        os.dup2(null, sys.stdin.fileno())
 
840
        if null > 2:
 
841
            os.close(null)
 
842
    else:
 
843
        # No console logging
 
844
        logger.removeHandler(console)
 
845
        # Close all input and output, do double fork, etc.
763
846
        daemon()
764
847
    
 
848
    try:
 
849
        pid = os.getpid()
 
850
        pidfile.write(str(pid) + "\n")
 
851
        pidfile.close()
 
852
        del pidfile
 
853
    except IOError:
 
854
        logger.error(u"Could not write to file %r with PID %d",
 
855
                     pidfilename, pid)
 
856
    except NameError:
 
857
        # "pidfile" was never created
 
858
        pass
 
859
    del pidfilename
 
860
    
765
861
    def cleanup():
766
862
        "Cleanup function; run on exit"
767
863
        global group
786
882
    for client in clients:
787
883
        client.start()
788
884
    
789
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
790
 
                                 server_settings["port"]),
791
 
                                tcp_handler,
792
 
                                settings=server_settings,
793
 
                                clients=clients)
 
885
    tcp_server.enable()
 
886
    tcp_server.server_activate()
 
887
    
794
888
    # Find out what port we got
795
889
    service.port = tcp_server.socket.getsockname()[1]
796
890
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
813
907
                             tcp_server.handle_request\
814
908
                             (*args[2:], **kwargs) or True)
815
909
        
816
 
        logger.debug("Starting main loop")
817
 
        main_loop_started = True
 
910
        logger.debug(u"Starting main loop")
818
911
        main_loop.run()
819
912
    except AvahiError, error:
820
913
        logger.critical(u"AvahiError: %s" + unicode(error))