/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(os.path.expanduser(os.path.expandvars
244
 
                                              (config["secfile"])))
245
 
            self.secret = secfile.read()
246
 
            secfile.close()
 
236
            sf = open(config["secfile"])
 
237
            self.secret = sf.read()
 
238
            sf.close()
247
239
        else:
248
240
            raise TypeError(u"No secret or secfile for client %s"
249
241
                            % self.name)
345
337
            try:
346
338
                logger.info(u"Starting checker %r for %s",
347
339
                            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
340
                self.checker = subprocess.Popen(command,
353
341
                                                close_fds=True,
354
342
                                                shell=True, cwd="/")
355
343
                self.checker_callback_tag = gobject.child_watch_add\
356
344
                                            (self.checker.pid,
357
345
                                             self.checker_callback)
358
 
            except OSError, error:
 
346
            except subprocess.OSError, error:
359
347
                logger.error(u"Failed to start subprocess: %s",
360
348
                             error)
361
349
        # Re-run this periodically if run by gobject.timeout_add
418
406
    gnutls.library.functions.gnutls_openpgp_crt_import\
419
407
                    (crt, ctypes.byref(datum),
420
408
                     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
409
    # New buffer for the fingerprint
429
 
    buf = ctypes.create_string_buffer(20)
430
 
    buf_len = ctypes.c_size_t()
 
410
    buffer = ctypes.create_string_buffer(20)
 
411
    buffer_length = ctypes.c_size_t()
431
412
    # Get the fingerprint from the certificate into the buffer
432
413
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
433
 
        (crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
414
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
434
415
    # Deinit the certificate
435
416
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
436
417
    # Convert the buffer to a Python bytestring
437
 
    fpr = ctypes.string_at(buf, buf_len.value)
 
418
    fpr = ctypes.string_at(buffer, buffer_length.value)
438
419
    # Convert the bytestring to hexadecimal notation
439
420
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
440
421
    return hex_fpr
441
422
 
442
423
 
443
 
class TCP_handler(SocketServer.BaseRequestHandler, object):
 
424
class tcp_handler(SocketServer.BaseRequestHandler, object):
444
425
    """A TCP request handler class.
445
426
    Instantiated by IPv6_TCPServer for each request to handle it.
446
427
    Note: This will run in its own forked process."""
473
454
        if self.server.settings["priority"]:
474
455
            priority = self.server.settings["priority"]
475
456
        gnutls.library.functions.gnutls_priority_set_direct\
476
 
            (session._c_object, priority, None)
 
457
            (session._c_object, priority, None);
477
458
        
478
459
        try:
479
460
            session.handshake()
522
503
    Attributes:
523
504
        settings:       Server settings
524
505
        clients:        Set() of Client objects
525
 
        enabled:        Boolean; whether this server is activated yet
526
506
    """
527
507
    address_family = socket.AF_INET6
528
508
    def __init__(self, *args, **kwargs):
532
512
        if "clients" in kwargs:
533
513
            self.clients = kwargs["clients"]
534
514
            del kwargs["clients"]
535
 
        self.enabled = False
536
 
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
 
515
        return super(type(self), self).__init__(*args, **kwargs)
537
516
    def server_bind(self):
538
517
        """This overrides the normal server_bind() function
539
518
        to bind to an interface if one was specified, and also NOT to
568
547
#                                            if_nametoindex
569
548
#                                            (self.settings
570
549
#                                             ["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
 
550
            return super(type(self), self).server_bind()
577
551
 
578
552
 
579
553
def string_to_delta(interval):
589
563
    datetime.timedelta(1)
590
564
    >>> string_to_delta(u'1w')
591
565
    datetime.timedelta(7)
592
 
    >>> string_to_delta('5m 30s')
593
 
    datetime.timedelta(0, 330)
594
566
    """
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):
 
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:
613
581
            raise ValueError
614
 
        timevalue += delta
615
 
    return timevalue
 
582
    except (ValueError, IndexError):
 
583
        raise ValueError
 
584
    return delta
616
585
 
617
586
 
618
587
def server_state_changed(state):
619
588
    """Derived from the Avahi example code"""
620
589
    if state == avahi.SERVER_COLLISION:
621
 
        logger.error(u"Zeroconf server name collision")
 
590
        logger.error(u"Server name collision")
622
591
        service.remove()
623
592
    elif state == avahi.SERVER_RUNNING:
624
593
        service.add()
626
595
 
627
596
def entry_group_state_changed(state, error):
628
597
    """Derived from the Avahi example code"""
629
 
    logger.debug(u"Avahi state change: %i", state)
 
598
    logger.debug(u"state change: %i", state)
630
599
    
631
600
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
632
 
        logger.debug(u"Zeroconf service established.")
 
601
        logger.debug(u"Service established.")
633
602
    elif state == avahi.ENTRY_GROUP_COLLISION:
634
 
        logger.warning(u"Zeroconf service name collision.")
 
603
        logger.warning(u"Service name collision.")
635
604
        service.rename()
636
605
    elif state == avahi.ENTRY_GROUP_FAILURE:
637
 
        logger.critical(u"Avahi: Error in group state changed %s",
 
606
        logger.critical(u"Error in group state changed %s",
638
607
                        unicode(error))
639
608
        raise AvahiGroupError("State changed: %s", str(error))
640
609
 
642
611
    """Call the C function if_nametoindex(), or equivalent"""
643
612
    global if_nametoindex
644
613
    try:
 
614
        if "ctypes.util" not in sys.modules:
 
615
            import ctypes.util
645
616
        if_nametoindex = ctypes.cdll.LoadLibrary\
646
617
            (ctypes.util.find_library("c")).if_nametoindex
647
618
    except (OSError, AttributeError):
685
656
 
686
657
 
687
658
def main():
 
659
    global main_loop_started
 
660
    main_loop_started = False
 
661
    
688
662
    parser = OptionParser(version = "%%prog %s" % version)
689
663
    parser.add_option("-i", "--interface", type="string",
690
664
                      metavar="IF", help="Bind to interface IF")
705
679
                      default="/etc/mandos", metavar="DIR",
706
680
                      help="Directory to search for configuration"
707
681
                      " files")
708
 
    options = parser.parse_args()[0]
 
682
    (options, args) = parser.parse_args()
709
683
    
710
684
    if options.check:
711
685
        import doctest
726
700
    server_config = ConfigParser.SafeConfigParser(server_defaults)
727
701
    del server_defaults
728
702
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
703
    server_section = "server"
729
704
    # Convert the SafeConfigParser object to a dict
730
 
    server_settings = server_config.defaults()
 
705
    server_settings = dict(server_config.items(server_section))
731
706
    # Use getboolean on the boolean config option
732
707
    server_settings["debug"] = server_config.getboolean\
733
 
                               ("DEFAULT", "debug")
 
708
                               (server_section, "debug")
734
709
    del server_config
735
710
    
736
711
    # Override the settings from the config file with command line
758
733
    # Parse config file with clients
759
734
    client_defaults = { "timeout": "1h",
760
735
                        "interval": "5m",
761
 
                        "checker": "fping -q -- %(host)s",
762
 
                        "host": "",
 
736
                        "checker": "fping -q -- %%(host)s",
763
737
                        }
764
738
    client_config = ConfigParser.SafeConfigParser(client_defaults)
765
739
    client_config.read(os.path.join(server_settings["configdir"],
766
740
                                    "clients.conf"))
767
741
    
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
742
    global service
804
743
    service = AvahiService(name = server_settings["servicename"],
805
 
                           servicetype = "_mandos._tcp", )
 
744
                           type = "_mandos._tcp", );
806
745
    if server_settings["interface"]:
807
 
        service.interface = if_nametoindex\
808
 
                            (server_settings["interface"])
 
746
        service.interface = if_nametoindex(server_settings["interface"])
809
747
    
810
748
    global main_loop
811
749
    global bus
814
752
    DBusGMainLoop(set_as_default=True )
815
753
    main_loop = gobject.MainLoop()
816
754
    bus = dbus.SystemBus()
817
 
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
818
 
                                           avahi.DBUS_PATH_SERVER),
819
 
                            avahi.DBUS_INTERFACE_SERVER)
 
755
    server = dbus.Interface(
 
756
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
757
            avahi.DBUS_INTERFACE_SERVER )
820
758
    # End of Avahi example code
821
759
    
 
760
    clients = Set()
822
761
    def remove_from_clients(client):
823
762
        clients.remove(client)
824
763
        if not clients:
834
773
        logger.critical(u"No clients defined")
835
774
        sys.exit(1)
836
775
    
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
 
776
    if not debug:
845
777
        logger.removeHandler(console)
846
 
        # Close all input and output, do double fork, etc.
847
778
        daemon()
848
779
    
 
780
    pidfilename = "/var/run/mandos/mandos.pid"
 
781
    pid = os.getpid()
849
782
    try:
850
 
        pid = os.getpid()
 
783
        pidfile = open(pidfilename, "w")
851
784
        pidfile.write(str(pid) + "\n")
852
785
        pidfile.close()
853
786
        del pidfile
854
 
    except IOError:
855
 
        logger.error(u"Could not write to file %r with PID %d",
856
 
                     pidfilename, pid)
857
 
    except NameError:
858
 
        # "pidfile" was never created
859
 
        pass
860
 
    del pidfilename
 
787
    except IOError, err:
 
788
        logger.error(u"Could not write %s file with PID %d",
 
789
                     pidfilename, os.getpid())
861
790
    
862
791
    def cleanup():
863
792
        "Cleanup function; run on exit"
883
812
    for client in clients:
884
813
        client.start()
885
814
    
886
 
    tcp_server.enable()
887
 
    tcp_server.server_activate()
888
 
    
 
815
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
816
                                 server_settings["port"]),
 
817
                                tcp_handler,
 
818
                                settings=server_settings,
 
819
                                clients=clients)
889
820
    # Find out what port we got
890
821
    service.port = tcp_server.socket.getsockname()[1]
891
822
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
909
840
                             (*args[2:], **kwargs) or True)
910
841
        
911
842
        logger.debug(u"Starting main loop")
 
843
        main_loop_started = True
912
844
        main_loop.run()
913
845
    except AvahiError, error:
914
846
        logger.critical(u"AvahiError: %s" + unicode(error))