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