/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-08-18 05:24:20 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818052420-ab5eurrioz8n2qy6
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".

* mandos-keygen Bug fix: make the --expire option modify
                KEYEXPIRE, not KEYCOMMENT.  Use the "--no-options"
                option to gpg when exporting keys from the temporary
                key ring files.

* mandos-keygen.xml (EXIT STATUS): Filled in.
  (ENVIRONMENT): New section, documenting use of TMPDIR.
  (FILES): Document use of key files and /tmp.
  (BUGS): Filled in.
  (EXAMPLE): Added two examples.
  (SECURITY): Added some text.

* plugins.d/password-prompt.xml (NOTES): Removed, since this is
                                         created automatically for
                                         footnotes.
  (ENVIRONMENT, FILES): Added empty sections.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* plugins.d/password-request.xml: Reordered sections.
  (ENVIRONMENT): New empty section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

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
64
version = "1.0"
67
65
 
81
79
class AvahiError(Exception):
82
80
    def __init__(self, value):
83
81
        self.value = value
84
 
        super(AvahiError, self).__init__()
85
82
    def __str__(self):
86
83
        return repr(self.value)
87
84
 
109
106
                  a sensible number of times
110
107
    """
111
108
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
112
 
                 servicetype = None, port = None, TXT = None, domain = "",
 
109
                 type = None, port = None, TXT = None, domain = "",
113
110
                 host = "", max_renames = 32768):
114
111
        self.interface = interface
115
112
        self.name = name
116
 
        self.type = servicetype
 
113
        self.type = type
117
114
        self.port = port
118
115
        if TXT is None:
119
116
            self.TXT = []
126
123
    def rename(self):
127
124
        """Derived from the Avahi example code"""
128
125
        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)
 
126
            logger.critical(u"No suitable service name found after %i"
 
127
                            u" retries, exiting.", rename_count)
132
128
            raise AvahiServiceError("Too many renames")
133
129
        self.name = server.GetAlternativeServiceName(self.name)
134
 
        logger.info(u"Changing Zeroconf service name to %r ...",
135
 
                    str(self.name))
 
130
        logger.info(u"Changing name to %r ...", str(self.name))
136
131
        syslogger.setFormatter(logging.Formatter\
137
132
                               ('Mandos (%s): %%(levelname)s:'
138
133
                               ' %%(message)s' % self.name))
153
148
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
149
            group.connect_to_signal('StateChanged',
155
150
                                    entry_group_state_changed)
156
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
 
151
        logger.debug(u"Adding service '%s' of type '%s' ...",
157
152
                     service.name, service.type)
158
153
        group.AddService(
159
154
                self.interface,         # interface
223
218
    interval = property(lambda self: self._interval,
224
219
                        _set_interval)
225
220
    del _set_interval
226
 
    def __init__(self, name = None, stop_hook=None, config=None):
 
221
    def __init__(self, name = None, stop_hook=None, config={}):
227
222
        """Note: the 'checker' key in 'config' sets the
228
223
        'checker_command' attribute and *not* the 'checker'
229
224
        attribute."""
230
 
        if config is None:
231
 
            config = {}
232
225
        self.name = name
233
226
        logger.debug(u"Creating client %r", self.name)
234
227
        # Uppercase and remove spaces from fingerprint for later
240
233
        if "secret" in config:
241
234
            self.secret = config["secret"].decode(u"base64")
242
235
        elif "secfile" in config:
243
 
            secfile = open(config["secfile"])
244
 
            self.secret = secfile.read()
245
 
            secfile.close()
 
236
            sf = open(config["secfile"])
 
237
            self.secret = sf.read()
 
238
            sf.close()
246
239
        else:
247
240
            raise TypeError(u"No secret or secfile for client %s"
248
241
                            % self.name)
344
337
            try:
345
338
                logger.info(u"Starting checker %r for %s",
346
339
                            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.)
351
340
                self.checker = subprocess.Popen(command,
352
341
                                                close_fds=True,
353
342
                                                shell=True, cwd="/")
354
343
                self.checker_callback_tag = gobject.child_watch_add\
355
344
                                            (self.checker.pid,
356
345
                                             self.checker_callback)
357
 
            except OSError, error:
 
346
            except subprocess.OSError, error:
358
347
                logger.error(u"Failed to start subprocess: %s",
359
348
                             error)
360
349
        # Re-run this periodically if run by gobject.timeout_add
417
406
    gnutls.library.functions.gnutls_openpgp_crt_import\
418
407
                    (crt, ctypes.byref(datum),
419
408
                     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")
427
409
    # New buffer for the fingerprint
428
 
    buf = ctypes.create_string_buffer(20)
429
 
    buf_len = ctypes.c_size_t()
 
410
    buffer = ctypes.create_string_buffer(20)
 
411
    buffer_length = ctypes.c_size_t()
430
412
    # Get the fingerprint from the certificate into the buffer
431
413
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
432
 
        (crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
414
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
433
415
    # Deinit the certificate
434
416
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
435
417
    # Convert the buffer to a Python bytestring
436
 
    fpr = ctypes.string_at(buf, buf_len.value)
 
418
    fpr = ctypes.string_at(buffer, buffer_length.value)
437
419
    # Convert the bytestring to hexadecimal notation
438
420
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
439
421
    return hex_fpr
440
422
 
441
423
 
442
 
class TCP_handler(SocketServer.BaseRequestHandler, object):
 
424
class tcp_handler(SocketServer.BaseRequestHandler, object):
443
425
    """A TCP request handler class.
444
426
    Instantiated by IPv6_TCPServer for each request to handle it.
445
427
    Note: This will run in its own forked process."""
472
454
        if self.server.settings["priority"]:
473
455
            priority = self.server.settings["priority"]
474
456
        gnutls.library.functions.gnutls_priority_set_direct\
475
 
            (session._c_object, priority, None)
 
457
            (session._c_object, priority, None);
476
458
        
477
459
        try:
478
460
            session.handshake()
521
503
    Attributes:
522
504
        settings:       Server settings
523
505
        clients:        Set() of Client objects
524
 
        enabled:        Boolean; whether this server is activated yet
525
506
    """
526
507
    address_family = socket.AF_INET6
527
508
    def __init__(self, *args, **kwargs):
531
512
        if "clients" in kwargs:
532
513
            self.clients = kwargs["clients"]
533
514
            del kwargs["clients"]
534
 
        self.enabled = False
535
 
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
 
515
        return super(type(self), self).__init__(*args, **kwargs)
536
516
    def server_bind(self):
537
517
        """This overrides the normal server_bind() function
538
518
        to bind to an interface if one was specified, and also NOT to
567
547
#                                            if_nametoindex
568
548
#                                            (self.settings
569
549
#                                             ["interface"]))
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
 
550
            return super(type(self), self).server_bind()
576
551
 
577
552
 
578
553
def string_to_delta(interval):
588
563
    datetime.timedelta(1)
589
564
    >>> string_to_delta(u'1w')
590
565
    datetime.timedelta(7)
591
 
    >>> string_to_delta('5m 30s')
592
 
    datetime.timedelta(0, 330)
593
566
    """
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):
 
567
    try:
 
568
        suffix=unicode(interval[-1])
 
569
        value=int(interval[:-1])
 
570
        if suffix == u"d":
 
571
            delta = datetime.timedelta(value)
 
572
        elif suffix == u"s":
 
573
            delta = datetime.timedelta(0, value)
 
574
        elif suffix == u"m":
 
575
            delta = datetime.timedelta(0, 0, 0, 0, value)
 
576
        elif suffix == u"h":
 
577
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
578
        elif suffix == u"w":
 
579
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
580
        else:
612
581
            raise ValueError
613
 
        timevalue += delta
614
 
    return timevalue
 
582
    except (ValueError, IndexError):
 
583
        raise ValueError
 
584
    return delta
615
585
 
616
586
 
617
587
def server_state_changed(state):
618
588
    """Derived from the Avahi example code"""
619
589
    if state == avahi.SERVER_COLLISION:
620
 
        logger.error(u"Zeroconf server name collision")
 
590
        logger.error(u"Server name collision")
621
591
        service.remove()
622
592
    elif state == avahi.SERVER_RUNNING:
623
593
        service.add()
625
595
 
626
596
def entry_group_state_changed(state, error):
627
597
    """Derived from the Avahi example code"""
628
 
    logger.debug(u"Avahi state change: %i", state)
 
598
    logger.debug(u"state change: %i", state)
629
599
    
630
600
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
631
 
        logger.debug(u"Zeroconf service established.")
 
601
        logger.debug(u"Service established.")
632
602
    elif state == avahi.ENTRY_GROUP_COLLISION:
633
 
        logger.warning(u"Zeroconf service name collision.")
 
603
        logger.warning(u"Service name collision.")
634
604
        service.rename()
635
605
    elif state == avahi.ENTRY_GROUP_FAILURE:
636
 
        logger.critical(u"Avahi: Error in group state changed %s",
 
606
        logger.critical(u"Error in group state changed %s",
637
607
                        unicode(error))
638
608
        raise AvahiGroupError("State changed: %s", str(error))
639
609
 
641
611
    """Call the C function if_nametoindex(), or equivalent"""
642
612
    global if_nametoindex
643
613
    try:
 
614
        if "ctypes.util" not in sys.modules:
 
615
            import ctypes.util
644
616
        if_nametoindex = ctypes.cdll.LoadLibrary\
645
617
            (ctypes.util.find_library("c")).if_nametoindex
646
618
    except (OSError, AttributeError):
684
656
 
685
657
 
686
658
def main():
 
659
    global main_loop_started
 
660
    main_loop_started = False
 
661
    
687
662
    parser = OptionParser(version = "%%prog %s" % version)
688
663
    parser.add_option("-i", "--interface", type="string",
689
664
                      metavar="IF", help="Bind to interface IF")
704
679
                      default="/etc/mandos", metavar="DIR",
705
680
                      help="Directory to search for configuration"
706
681
                      " files")
707
 
    options = parser.parse_args()[0]
 
682
    (options, args) = parser.parse_args()
708
683
    
709
684
    if options.check:
710
685
        import doctest
725
700
    server_config = ConfigParser.SafeConfigParser(server_defaults)
726
701
    del server_defaults
727
702
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
703
    server_section = "server"
728
704
    # Convert the SafeConfigParser object to a dict
729
 
    server_settings = server_config.defaults()
 
705
    server_settings = dict(server_config.items(server_section))
730
706
    # Use getboolean on the boolean config option
731
707
    server_settings["debug"] = server_config.getboolean\
732
 
                               ("DEFAULT", "debug")
 
708
                               (server_section, "debug")
733
709
    del server_config
734
710
    
735
711
    # Override the settings from the config file with command line
757
733
    # Parse config file with clients
758
734
    client_defaults = { "timeout": "1h",
759
735
                        "interval": "5m",
760
 
                        "checker": "fping -q -- %(host)s",
761
 
                        "host": "",
 
736
                        "checker": "fping -q -- %%(host)s",
762
737
                        }
763
738
    client_config = ConfigParser.SafeConfigParser(client_defaults)
764
739
    client_config.read(os.path.join(server_settings["configdir"],
765
740
                                    "clients.conf"))
766
741
    
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
 
    
802
742
    global service
803
743
    service = AvahiService(name = server_settings["servicename"],
804
 
                           servicetype = "_mandos._tcp", )
 
744
                           type = "_mandos._tcp", );
805
745
    if server_settings["interface"]:
806
 
        service.interface = if_nametoindex\
807
 
                            (server_settings["interface"])
 
746
        service.interface = if_nametoindex(server_settings["interface"])
808
747
    
809
748
    global main_loop
810
749
    global bus
813
752
    DBusGMainLoop(set_as_default=True )
814
753
    main_loop = gobject.MainLoop()
815
754
    bus = dbus.SystemBus()
816
 
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
817
 
                                           avahi.DBUS_PATH_SERVER),
818
 
                            avahi.DBUS_INTERFACE_SERVER)
 
755
    server = dbus.Interface(
 
756
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
757
            avahi.DBUS_INTERFACE_SERVER )
819
758
    # End of Avahi example code
820
759
    
 
760
    clients = Set()
821
761
    def remove_from_clients(client):
822
762
        clients.remove(client)
823
763
        if not clients:
833
773
        logger.critical(u"No clients defined")
834
774
        sys.exit(1)
835
775
    
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
 
776
    if not debug:
844
777
        logger.removeHandler(console)
845
 
        # Close all input and output, do double fork, etc.
846
778
        daemon()
847
779
    
 
780
    pidfilename = "/var/run/mandos/mandos.pid"
 
781
    pid = os.getpid()
848
782
    try:
849
 
        pid = os.getpid()
 
783
        pidfile = open(pidfilename, "w")
850
784
        pidfile.write(str(pid) + "\n")
851
785
        pidfile.close()
852
786
        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
 
787
    except IOError, err:
 
788
        logger.error(u"Could not write %s file with PID %d",
 
789
                     pidfilename, os.getpid())
860
790
    
861
791
    def cleanup():
862
792
        "Cleanup function; run on exit"
882
812
    for client in clients:
883
813
        client.start()
884
814
    
885
 
    tcp_server.enable()
886
 
    tcp_server.server_activate()
887
 
    
 
815
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
816
                                 server_settings["port"]),
 
817
                                tcp_handler,
 
818
                                settings=server_settings,
 
819
                                clients=clients)
888
820
    # Find out what port we got
889
821
    service.port = tcp_server.socket.getsockname()[1]
890
822
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
908
840
                             (*args[2:], **kwargs) or True)
909
841
        
910
842
        logger.debug(u"Starting main loop")
 
843
        main_loop_started = True
911
844
        main_loop.run()
912
845
    except AvahiError, error:
913
846
        logger.critical(u"AvahiError: %s" + unicode(error))