/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-10-04 01:55:56 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081004015556-hp0374bc62khen0z
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
* mandos.xml (FILES): - '' -
  (CLIENTS, SERVER): Changed id attribute to lower case.  All
                     referrers changed.
* plugins.d/mandos-client.xml (FILES): Fixed id to be "files", not
                                       "file".

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