/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2008-08-08 01:17:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080808011717-h1vzp4vs7oyzkgx3
* mandos (IPv6_TCPServer.server_bind): Bug fix: allow port to be empty
                                       as well as None.
  (main): Bug fix: Let debug option default to 'None' to allow
          override from config file.

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