/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 07:23:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930072339-jn15gyrtfpdk2dhx
* .bzrignore: Added "man" directory (created by "make install-html").

* Makefile: Add "common.ent" dependency to all manual pages.
  (htmldir, version, SED): New variables.
  (CFLAGS): Add -D option to define VERSION to $(version).
  (MANPOST, HTMLPOST): Use $(SED).
  (PROGS): Use $(CPROGS)
  (CPROGS): New; C-only programs.
  (objects): Use $(CPROGS).
  (common.ent, mandos, mandos-keygen): New targets; update version
                                       number to $(version).
  (clean): Use $(CPROGS).
  (check): Depend on "all".
  (install-html): Install to $(htmldir).

* common.ent: New file with "version" entity.

* mandos-clients.conf.xml: Use "common.ent".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.xml: - '' -

* plugin-runner.c (argp_program_version): Use VERSION.
* plugins.d/mandos-client.c (argp_program_version): - '' -
* plugins.d/password-prompt.c (argp_program_version): - '' -

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(config["secfile"])
 
244
            self.secret = secfile.read()
 
245
            secfile.close()
233
246
        else:
234
247
            raise TypeError(u"No secret or secfile for client %s"
235
248
                            % self.name)
331
344
            try:
332
345
                logger.info(u"Starting checker %r for %s",
333
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.)
334
351
                self.checker = subprocess.Popen(command,
335
352
                                                close_fds=True,
336
353
                                                shell=True, cwd="/")
337
354
                self.checker_callback_tag = gobject.child_watch_add\
338
355
                                            (self.checker.pid,
339
356
                                             self.checker_callback)
340
 
            except subprocess.OSError, error:
 
357
            except OSError, error:
341
358
                logger.error(u"Failed to start subprocess: %s",
342
359
                             error)
343
360
        # Re-run this periodically if run by gobject.timeout_add
400
417
    gnutls.library.functions.gnutls_openpgp_crt_import\
401
418
                    (crt, ctypes.byref(datum),
402
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")
403
427
    # New buffer for the fingerprint
404
 
    buffer = ctypes.create_string_buffer(20)
405
 
    buffer_length = ctypes.c_size_t()
 
428
    buf = ctypes.create_string_buffer(20)
 
429
    buf_len = ctypes.c_size_t()
406
430
    # Get the fingerprint from the certificate into the buffer
407
431
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
408
 
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
432
        (crt, ctypes.byref(buf), ctypes.byref(buf_len))
409
433
    # Deinit the certificate
410
434
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
411
435
    # Convert the buffer to a Python bytestring
412
 
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
436
    fpr = ctypes.string_at(buf, buf_len.value)
413
437
    # Convert the bytestring to hexadecimal notation
414
438
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
415
439
    return hex_fpr
416
440
 
417
441
 
418
 
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
442
class TCP_handler(SocketServer.BaseRequestHandler, object):
419
443
    """A TCP request handler class.
420
444
    Instantiated by IPv6_TCPServer for each request to handle it.
421
445
    Note: This will run in its own forked process."""
448
472
        if self.server.settings["priority"]:
449
473
            priority = self.server.settings["priority"]
450
474
        gnutls.library.functions.gnutls_priority_set_direct\
451
 
            (session._c_object, priority, None);
 
475
            (session._c_object, priority, None)
452
476
        
453
477
        try:
454
478
            session.handshake()
497
521
    Attributes:
498
522
        settings:       Server settings
499
523
        clients:        Set() of Client objects
 
524
        enabled:        Boolean; whether this server is activated yet
500
525
    """
501
526
    address_family = socket.AF_INET6
502
527
    def __init__(self, *args, **kwargs):
506
531
        if "clients" in kwargs:
507
532
            self.clients = kwargs["clients"]
508
533
            del kwargs["clients"]
509
 
        return super(type(self), self).__init__(*args, **kwargs)
 
534
        self.enabled = False
 
535
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
510
536
    def server_bind(self):
511
537
        """This overrides the normal server_bind() function
512
538
        to bind to an interface if one was specified, and also NOT to
541
567
#                                            if_nametoindex
542
568
#                                            (self.settings
543
569
#                                             ["interface"]))
544
 
            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
545
576
 
546
577
 
547
578
def string_to_delta(interval):
557
588
    datetime.timedelta(1)
558
589
    >>> string_to_delta(u'1w')
559
590
    datetime.timedelta(7)
 
591
    >>> string_to_delta('5m 30s')
 
592
    datetime.timedelta(0, 330)
560
593
    """
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:
 
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):
575
612
            raise ValueError
576
 
    except (ValueError, IndexError):
577
 
        raise ValueError
578
 
    return delta
 
613
        timevalue += delta
 
614
    return timevalue
579
615
 
580
616
 
581
617
def server_state_changed(state):
582
618
    """Derived from the Avahi example code"""
583
619
    if state == avahi.SERVER_COLLISION:
584
 
        logger.error(u"Server name collision")
 
620
        logger.error(u"Zeroconf server name collision")
585
621
        service.remove()
586
622
    elif state == avahi.SERVER_RUNNING:
587
623
        service.add()
589
625
 
590
626
def entry_group_state_changed(state, error):
591
627
    """Derived from the Avahi example code"""
592
 
    logger.debug(u"state change: %i", state)
 
628
    logger.debug(u"Avahi state change: %i", state)
593
629
    
594
630
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
595
 
        logger.debug(u"Service established.")
 
631
        logger.debug(u"Zeroconf service established.")
596
632
    elif state == avahi.ENTRY_GROUP_COLLISION:
597
 
        logger.warning(u"Service name collision.")
 
633
        logger.warning(u"Zeroconf service name collision.")
598
634
        service.rename()
599
635
    elif state == avahi.ENTRY_GROUP_FAILURE:
600
 
        logger.critical(u"Error in group state changed %s",
 
636
        logger.critical(u"Avahi: Error in group state changed %s",
601
637
                        unicode(error))
602
638
        raise AvahiGroupError("State changed: %s", str(error))
603
639
 
605
641
    """Call the C function if_nametoindex(), or equivalent"""
606
642
    global if_nametoindex
607
643
    try:
608
 
        if "ctypes.util" not in sys.modules:
609
 
            import ctypes.util
610
644
        if_nametoindex = ctypes.cdll.LoadLibrary\
611
645
            (ctypes.util.find_library("c")).if_nametoindex
612
646
    except (OSError, AttributeError):
650
684
 
651
685
 
652
686
def main():
653
 
    global main_loop_started
654
 
    main_loop_started = False
655
 
    
656
 
    parser = OptionParser()
 
687
    parser = OptionParser(version = "%%prog %s" % version)
657
688
    parser.add_option("-i", "--interface", type="string",
658
689
                      metavar="IF", help="Bind to interface IF")
659
690
    parser.add_option("-a", "--address", type="string",
673
704
                      default="/etc/mandos", metavar="DIR",
674
705
                      help="Directory to search for configuration"
675
706
                      " files")
676
 
    (options, args) = parser.parse_args()
 
707
    options = parser.parse_args()[0]
677
708
    
678
709
    if options.check:
679
710
        import doctest
694
725
    server_config = ConfigParser.SafeConfigParser(server_defaults)
695
726
    del server_defaults
696
727
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
697
 
    server_section = "server"
698
728
    # Convert the SafeConfigParser object to a dict
699
 
    server_settings = dict(server_config.items(server_section))
 
729
    server_settings = server_config.defaults()
700
730
    # Use getboolean on the boolean config option
701
731
    server_settings["debug"] = server_config.getboolean\
702
 
                               (server_section, "debug")
 
732
                               ("DEFAULT", "debug")
703
733
    del server_config
704
734
    
705
735
    # Override the settings from the config file with command line
716
746
    
717
747
    if not debug:
718
748
        syslogger.setLevel(logging.WARNING)
 
749
        console.setLevel(logging.WARNING)
719
750
    
720
751
    if server_settings["servicename"] != "Mandos":
721
752
        syslogger.setFormatter(logging.Formatter\
726
757
    # Parse config file with clients
727
758
    client_defaults = { "timeout": "1h",
728
759
                        "interval": "5m",
729
 
                        "checker": "fping -q -- %%(host)s",
 
760
                        "checker": "fping -q -- %(host)s",
 
761
                        "host": "",
730
762
                        }
731
763
    client_config = ConfigParser.SafeConfigParser(client_defaults)
732
764
    client_config.read(os.path.join(server_settings["configdir"],
733
765
                                    "clients.conf"))
734
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
    
735
802
    global service
736
803
    service = AvahiService(name = server_settings["servicename"],
737
 
                           type = "_mandos._tcp", );
 
804
                           servicetype = "_mandos._tcp", )
738
805
    if server_settings["interface"]:
739
 
        service.interface = if_nametoindex(server_settings["interface"])
 
806
        service.interface = if_nametoindex\
 
807
                            (server_settings["interface"])
740
808
    
741
809
    global main_loop
742
810
    global bus
745
813
    DBusGMainLoop(set_as_default=True )
746
814
    main_loop = gobject.MainLoop()
747
815
    bus = dbus.SystemBus()
748
 
    server = dbus.Interface(
749
 
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
750
 
            avahi.DBUS_INTERFACE_SERVER )
 
816
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
 
817
                                           avahi.DBUS_PATH_SERVER),
 
818
                            avahi.DBUS_INTERFACE_SERVER)
751
819
    # End of Avahi example code
752
820
    
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
821
    def remove_from_clients(client):
763
822
        clients.remove(client)
764
823
        if not clients:
774
833
        logger.critical(u"No clients defined")
775
834
        sys.exit(1)
776
835
    
777
 
    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.
778
846
        daemon()
779
847
    
780
 
    pidfilename = "/var/run/mandos/mandos.pid"
781
 
    pid = os.getpid()
782
848
    try:
783
 
        pidfile = open(pidfilename, "w")
 
849
        pid = os.getpid()
784
850
        pidfile.write(str(pid) + "\n")
785
851
        pidfile.close()
786
852
        del pidfile
787
 
    except IOError, err:
788
 
        logger.error(u"Could not write %s file with PID %d",
789
 
                     pidfilename, os.getpid())
 
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
790
860
    
791
861
    def cleanup():
792
862
        "Cleanup function; run on exit"
812
882
    for client in clients:
813
883
        client.start()
814
884
    
815
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
816
 
                                 server_settings["port"]),
817
 
                                tcp_handler,
818
 
                                settings=server_settings,
819
 
                                clients=clients)
 
885
    tcp_server.enable()
 
886
    tcp_server.server_activate()
 
887
    
820
888
    # Find out what port we got
821
889
    service.port = tcp_server.socket.getsockname()[1]
822
890
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
840
908
                             (*args[2:], **kwargs) or True)
841
909
        
842
910
        logger.debug(u"Starting main loop")
843
 
        main_loop_started = True
844
911
        main_loop.run()
845
912
    except AvahiError, error:
846
913
        logger.critical(u"AvahiError: %s" + unicode(error))