/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 03:50:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818035028-su31apqs2pv2147v
* mandos-keygen.xml: Removed <?xml-stylesheet>.  New entity
                     "&OVERVIEW;" referring to "overview.xml".
  (PURPOSE, OVERVIEW): New sections, same as in mandos(8).
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* mandos.xml (OPTIONS, CLIENTS): Slight wording change.

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
# 
32
31
 
33
 
from __future__ import division, with_statement, absolute_import
 
32
from __future__ import division
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
 
from contextlib import closing
59
57
 
60
58
import dbus
61
59
import gobject
62
60
import avahi
63
61
from dbus.mainloop.glib import DBusGMainLoop
64
62
import ctypes
65
 
import ctypes.util
66
63
 
67
 
version = "1.0.2"
 
64
version = "1.0"
68
65
 
69
66
logger = logging.Logger('mandos')
70
67
syslogger = logging.handlers.SysLogHandler\
82
79
class AvahiError(Exception):
83
80
    def __init__(self, value):
84
81
        self.value = value
85
 
        super(AvahiError, self).__init__()
86
82
    def __str__(self):
87
83
        return repr(self.value)
88
84
 
110
106
                  a sensible number of times
111
107
    """
112
108
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
113
 
                 servicetype = None, port = None, TXT = None, domain = "",
 
109
                 type = None, port = None, TXT = None, domain = "",
114
110
                 host = "", max_renames = 32768):
115
111
        self.interface = interface
116
112
        self.name = name
117
 
        self.type = servicetype
 
113
        self.type = type
118
114
        self.port = port
119
115
        if TXT is None:
120
116
            self.TXT = []
127
123
    def rename(self):
128
124
        """Derived from the Avahi example code"""
129
125
        if self.rename_count >= self.max_renames:
130
 
            logger.critical(u"No suitable Zeroconf service name found"
131
 
                            u" after %i retries, exiting.",
132
 
                            self.rename_count)
 
126
            logger.critical(u"No suitable service name found after %i"
 
127
                            u" retries, exiting.", rename_count)
133
128
            raise AvahiServiceError("Too many renames")
134
129
        self.name = server.GetAlternativeServiceName(self.name)
135
 
        logger.info(u"Changing Zeroconf service name to %r ...",
136
 
                    str(self.name))
 
130
        logger.info(u"Changing name to %r ...", str(self.name))
137
131
        syslogger.setFormatter(logging.Formatter\
138
132
                               ('Mandos (%s): %%(levelname)s:'
139
133
                               ' %%(message)s' % self.name))
154
148
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
155
149
            group.connect_to_signal('StateChanged',
156
150
                                    entry_group_state_changed)
157
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
 
151
        logger.debug(u"Adding service '%s' of type '%s' ...",
158
152
                     service.name, service.type)
159
153
        group.AddService(
160
154
                self.interface,         # interface
224
218
    interval = property(lambda self: self._interval,
225
219
                        _set_interval)
226
220
    del _set_interval
227
 
    def __init__(self, name = None, stop_hook=None, config=None):
 
221
    def __init__(self, name = None, stop_hook=None, config={}):
228
222
        """Note: the 'checker' key in 'config' sets the
229
223
        'checker_command' attribute and *not* the 'checker'
230
224
        attribute."""
231
 
        if config is None:
232
 
            config = {}
233
225
        self.name = name
234
226
        logger.debug(u"Creating client %r", self.name)
235
227
        # Uppercase and remove spaces from fingerprint for later
241
233
        if "secret" in config:
242
234
            self.secret = config["secret"].decode(u"base64")
243
235
        elif "secfile" in config:
244
 
            with closing(open(os.path.expanduser
245
 
                              (os.path.expandvars
246
 
                               (config["secfile"])))) \
247
 
                               as secfile:
248
 
                self.secret = secfile.read()
 
236
            sf = open(config["secfile"])
 
237
            self.secret = sf.read()
 
238
            sf.close()
249
239
        else:
250
240
            raise TypeError(u"No secret or secfile for client %s"
251
241
                            % self.name)
299
289
        self.stop()
300
290
    def checker_callback(self, pid, condition):
301
291
        """The checker has completed, so take appropriate actions."""
 
292
        now = datetime.datetime.now()
302
293
        self.checker_callback_tag = None
303
294
        self.checker = None
304
295
        if os.WIFEXITED(condition) \
305
296
               and (os.WEXITSTATUS(condition) == 0):
306
297
            logger.info(u"Checker for %(name)s succeeded",
307
298
                        vars(self))
308
 
            self.bump_timeout()
 
299
            self.last_checked_ok = now
 
300
            gobject.source_remove(self.stop_initiator_tag)
 
301
            self.stop_initiator_tag = gobject.timeout_add\
 
302
                                      (self._timeout_milliseconds,
 
303
                                       self.stop)
309
304
        elif not os.WIFEXITED(condition):
310
305
            logger.warning(u"Checker for %(name)s crashed?",
311
306
                           vars(self))
312
307
        else:
313
308
            logger.info(u"Checker for %(name)s failed",
314
309
                        vars(self))
315
 
    def bump_timeout(self):
316
 
        """Bump up the timeout for this client.
317
 
        This should only be called when the client has been seen,
318
 
        alive and well.
319
 
        """
320
 
        self.last_checked_ok = datetime.datetime.now()
321
 
        gobject.source_remove(self.stop_initiator_tag)
322
 
        self.stop_initiator_tag = gobject.timeout_add\
323
 
            (self._timeout_milliseconds, self.stop)
324
310
    def start_checker(self):
325
311
        """Start a new checker subprocess if one is not running.
326
312
        If a checker already exists, leave it running and do
351
337
            try:
352
338
                logger.info(u"Starting checker %r for %s",
353
339
                            command, self.name)
354
 
                # We don't need to redirect stdout and stderr, since
355
 
                # in normal mode, that is already done by daemon(),
356
 
                # and in debug mode we don't want to.  (Stdin is
357
 
                # always replaced by /dev/null.)
358
340
                self.checker = subprocess.Popen(command,
359
341
                                                close_fds=True,
360
342
                                                shell=True, cwd="/")
361
343
                self.checker_callback_tag = gobject.child_watch_add\
362
344
                                            (self.checker.pid,
363
345
                                             self.checker_callback)
364
 
            except OSError, error:
 
346
            except subprocess.OSError, error:
365
347
                logger.error(u"Failed to start subprocess: %s",
366
348
                             error)
367
349
        # Re-run this periodically if run by gobject.timeout_add
424
406
    gnutls.library.functions.gnutls_openpgp_crt_import\
425
407
                    (crt, ctypes.byref(datum),
426
408
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
427
 
    # Verify the self signature in the key
428
 
    crtverify = ctypes.c_uint()
429
 
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
430
 
        (crt, 0, ctypes.byref(crtverify))
431
 
    if crtverify.value != 0:
432
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
433
 
        raise gnutls.errors.CertificateSecurityError("Verify failed")
434
409
    # New buffer for the fingerprint
435
 
    buf = ctypes.create_string_buffer(20)
436
 
    buf_len = ctypes.c_size_t()
 
410
    buffer = ctypes.create_string_buffer(20)
 
411
    buffer_length = ctypes.c_size_t()
437
412
    # Get the fingerprint from the certificate into the buffer
438
413
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
439
 
        (crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
414
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
440
415
    # Deinit the certificate
441
416
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
442
417
    # Convert the buffer to a Python bytestring
443
 
    fpr = ctypes.string_at(buf, buf_len.value)
 
418
    fpr = ctypes.string_at(buffer, buffer_length.value)
444
419
    # Convert the bytestring to hexadecimal notation
445
420
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
446
421
    return hex_fpr
447
422
 
448
423
 
449
 
class TCP_handler(SocketServer.BaseRequestHandler, object):
 
424
class tcp_handler(SocketServer.BaseRequestHandler, object):
450
425
    """A TCP request handler class.
451
426
    Instantiated by IPv6_TCPServer for each request to handle it.
452
427
    Note: This will run in its own forked process."""
453
428
    
454
429
    def handle(self):
455
430
        logger.info(u"TCP connection from: %s",
456
 
                    unicode(self.client_address))
 
431
                     unicode(self.client_address))
457
432
        session = gnutls.connection.ClientSession\
458
433
                  (self.request, gnutls.connection.X509Credentials())
459
434
        
474
449
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
475
450
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
476
451
        #                "+DHE-DSS"))
477
 
        # Use a fallback default, since this MUST be set.
478
 
        priority = self.server.settings.get("priority", "NORMAL")
 
452
        priority = "NORMAL"             # Fallback default, since this
 
453
                                        # MUST be set.
 
454
        if self.server.settings["priority"]:
 
455
            priority = self.server.settings["priority"]
479
456
        gnutls.library.functions.gnutls_priority_set_direct\
480
 
            (session._c_object, priority, None)
 
457
            (session._c_object, priority, None);
481
458
        
482
459
        try:
483
460
            session.handshake()
511
488
                           vars(client))
512
489
            session.bye()
513
490
            return
514
 
        ## This won't work here, since we're in a fork.
515
 
        # client.bump_timeout()
516
491
        sent_size = 0
517
492
        while sent_size < len(client.secret):
518
493
            sent = session.send(client.secret[sent_size:])
523
498
        session.bye()
524
499
 
525
500
 
526
 
class IPv6_TCPServer(SocketServer.ForkingMixIn,
527
 
                     SocketServer.TCPServer, object):
 
501
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
528
502
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
529
503
    Attributes:
530
504
        settings:       Server settings
531
505
        clients:        Set() of Client objects
532
 
        enabled:        Boolean; whether this server is activated yet
533
506
    """
534
507
    address_family = socket.AF_INET6
535
508
    def __init__(self, *args, **kwargs):
539
512
        if "clients" in kwargs:
540
513
            self.clients = kwargs["clients"]
541
514
            del kwargs["clients"]
542
 
        self.enabled = False
543
 
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
 
515
        return super(type(self), self).__init__(*args, **kwargs)
544
516
    def server_bind(self):
545
517
        """This overrides the normal server_bind() function
546
518
        to bind to an interface if one was specified, and also NOT to
575
547
#                                            if_nametoindex
576
548
#                                            (self.settings
577
549
#                                             ["interface"]))
578
 
            return super(IPv6_TCPServer, self).server_bind()
579
 
    def server_activate(self):
580
 
        if self.enabled:
581
 
            return super(IPv6_TCPServer, self).server_activate()
582
 
    def enable(self):
583
 
        self.enabled = True
 
550
            return super(type(self), self).server_bind()
584
551
 
585
552
 
586
553
def string_to_delta(interval):
596
563
    datetime.timedelta(1)
597
564
    >>> string_to_delta(u'1w')
598
565
    datetime.timedelta(7)
599
 
    >>> string_to_delta('5m 30s')
600
 
    datetime.timedelta(0, 330)
601
566
    """
602
 
    timevalue = datetime.timedelta(0)
603
 
    for s in interval.split():
604
 
        try:
605
 
            suffix = unicode(s[-1])
606
 
            value = int(s[:-1])
607
 
            if suffix == u"d":
608
 
                delta = datetime.timedelta(value)
609
 
            elif suffix == u"s":
610
 
                delta = datetime.timedelta(0, value)
611
 
            elif suffix == u"m":
612
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
613
 
            elif suffix == u"h":
614
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
615
 
            elif suffix == u"w":
616
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
617
 
            else:
618
 
                raise ValueError
619
 
        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:
620
581
            raise ValueError
621
 
        timevalue += delta
622
 
    return timevalue
 
582
    except (ValueError, IndexError):
 
583
        raise ValueError
 
584
    return delta
623
585
 
624
586
 
625
587
def server_state_changed(state):
626
588
    """Derived from the Avahi example code"""
627
589
    if state == avahi.SERVER_COLLISION:
628
 
        logger.error(u"Zeroconf server name collision")
 
590
        logger.error(u"Server name collision")
629
591
        service.remove()
630
592
    elif state == avahi.SERVER_RUNNING:
631
593
        service.add()
633
595
 
634
596
def entry_group_state_changed(state, error):
635
597
    """Derived from the Avahi example code"""
636
 
    logger.debug(u"Avahi state change: %i", state)
 
598
    logger.debug(u"state change: %i", state)
637
599
    
638
600
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
639
 
        logger.debug(u"Zeroconf service established.")
 
601
        logger.debug(u"Service established.")
640
602
    elif state == avahi.ENTRY_GROUP_COLLISION:
641
 
        logger.warning(u"Zeroconf service name collision.")
 
603
        logger.warning(u"Service name collision.")
642
604
        service.rename()
643
605
    elif state == avahi.ENTRY_GROUP_FAILURE:
644
 
        logger.critical(u"Avahi: Error in group state changed %s",
 
606
        logger.critical(u"Error in group state changed %s",
645
607
                        unicode(error))
646
608
        raise AvahiGroupError("State changed: %s", str(error))
647
609
 
649
611
    """Call the C function if_nametoindex(), or equivalent"""
650
612
    global if_nametoindex
651
613
    try:
 
614
        if "ctypes.util" not in sys.modules:
 
615
            import ctypes.util
652
616
        if_nametoindex = ctypes.cdll.LoadLibrary\
653
617
            (ctypes.util.find_library("c")).if_nametoindex
654
618
    except (OSError, AttributeError):
659
623
        def if_nametoindex(interface):
660
624
            "Get an interface index the hard way, i.e. using fcntl()"
661
625
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
662
 
            with closing(socket.socket()) as s:
663
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
664
 
                                    struct.pack("16s16x", interface))
 
626
            s = socket.socket()
 
627
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
628
                                struct.pack("16s16x", interface))
 
629
            s.close()
665
630
            interface_index = struct.unpack("I", ifreq[16:20])[0]
666
631
            return interface_index
667
632
    return if_nametoindex(interface)
691
656
 
692
657
 
693
658
def main():
 
659
    global main_loop_started
 
660
    main_loop_started = False
 
661
    
694
662
    parser = OptionParser(version = "%%prog %s" % version)
695
663
    parser.add_option("-i", "--interface", type="string",
696
664
                      metavar="IF", help="Bind to interface IF")
711
679
                      default="/etc/mandos", metavar="DIR",
712
680
                      help="Directory to search for configuration"
713
681
                      " files")
714
 
    options = parser.parse_args()[0]
 
682
    (options, args) = parser.parse_args()
715
683
    
716
684
    if options.check:
717
685
        import doctest
732
700
    server_config = ConfigParser.SafeConfigParser(server_defaults)
733
701
    del server_defaults
734
702
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
703
    server_section = "server"
735
704
    # Convert the SafeConfigParser object to a dict
736
 
    server_settings = server_config.defaults()
 
705
    server_settings = dict(server_config.items(server_section))
737
706
    # Use getboolean on the boolean config option
738
707
    server_settings["debug"] = server_config.getboolean\
739
 
                               ("DEFAULT", "debug")
 
708
                               (server_section, "debug")
740
709
    del server_config
741
710
    
742
711
    # Override the settings from the config file with command line
764
733
    # Parse config file with clients
765
734
    client_defaults = { "timeout": "1h",
766
735
                        "interval": "5m",
767
 
                        "checker": "fping -q -- %(host)s",
768
 
                        "host": "",
 
736
                        "checker": "fping -q -- %%(host)s",
769
737
                        }
770
738
    client_config = ConfigParser.SafeConfigParser(client_defaults)
771
739
    client_config.read(os.path.join(server_settings["configdir"],
772
740
                                    "clients.conf"))
773
741
    
774
 
    clients = Set()
775
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
776
 
                                 server_settings["port"]),
777
 
                                TCP_handler,
778
 
                                settings=server_settings,
779
 
                                clients=clients)
780
 
    pidfilename = "/var/run/mandos.pid"
781
 
    try:
782
 
        pidfile = open(pidfilename, "w")
783
 
    except IOError, error:
784
 
        logger.error("Could not open file %r", pidfilename)
785
 
    
786
 
    uid = 65534
787
 
    gid = 65534
788
 
    try:
789
 
        uid = pwd.getpwnam("mandos").pw_uid
790
 
    except KeyError:
791
 
        try:
792
 
            uid = pwd.getpwnam("nobody").pw_uid
793
 
        except KeyError:
794
 
            pass
795
 
    try:
796
 
        gid = pwd.getpwnam("mandos").pw_gid
797
 
    except KeyError:
798
 
        try:
799
 
            gid = pwd.getpwnam("nogroup").pw_gid
800
 
        except KeyError:
801
 
            pass
802
 
    try:
803
 
        os.setuid(uid)
804
 
        os.setgid(gid)
805
 
    except OSError, error:
806
 
        if error[0] != errno.EPERM:
807
 
            raise error
808
 
    
809
742
    global service
810
743
    service = AvahiService(name = server_settings["servicename"],
811
 
                           servicetype = "_mandos._tcp", )
 
744
                           type = "_mandos._tcp", );
812
745
    if server_settings["interface"]:
813
 
        service.interface = if_nametoindex\
814
 
                            (server_settings["interface"])
 
746
        service.interface = if_nametoindex(server_settings["interface"])
815
747
    
816
748
    global main_loop
817
749
    global bus
820
752
    DBusGMainLoop(set_as_default=True )
821
753
    main_loop = gobject.MainLoop()
822
754
    bus = dbus.SystemBus()
823
 
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
824
 
                                           avahi.DBUS_PATH_SERVER),
825
 
                            avahi.DBUS_INTERFACE_SERVER)
 
755
    server = dbus.Interface(
 
756
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
757
            avahi.DBUS_INTERFACE_SERVER )
826
758
    # End of Avahi example code
827
759
    
 
760
    clients = Set()
828
761
    def remove_from_clients(client):
829
762
        clients.remove(client)
830
763
        if not clients:
840
773
        logger.critical(u"No clients defined")
841
774
        sys.exit(1)
842
775
    
843
 
    if debug:
844
 
        # Redirect stdin so all checkers get /dev/null
845
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
846
 
        os.dup2(null, sys.stdin.fileno())
847
 
        if null > 2:
848
 
            os.close(null)
849
 
    else:
850
 
        # No console logging
 
776
    if not debug:
851
777
        logger.removeHandler(console)
852
 
        # Close all input and output, do double fork, etc.
853
778
        daemon()
854
779
    
 
780
    pidfilename = "/var/run/mandos/mandos.pid"
 
781
    pid = os.getpid()
855
782
    try:
856
 
        pid = os.getpid()
 
783
        pidfile = open(pidfilename, "w")
857
784
        pidfile.write(str(pid) + "\n")
858
785
        pidfile.close()
859
786
        del pidfile
860
 
    except IOError:
861
 
        logger.error(u"Could not write to file %r with PID %d",
862
 
                     pidfilename, pid)
863
 
    except NameError:
864
 
        # "pidfile" was never created
865
 
        pass
866
 
    del pidfilename
 
787
    except IOError, err:
 
788
        logger.error(u"Could not write %s file with PID %d",
 
789
                     pidfilename, os.getpid())
867
790
    
868
791
    def cleanup():
869
792
        "Cleanup function; run on exit"
889
812
    for client in clients:
890
813
        client.start()
891
814
    
892
 
    tcp_server.enable()
893
 
    tcp_server.server_activate()
894
 
    
 
815
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
816
                                 server_settings["port"]),
 
817
                                tcp_handler,
 
818
                                settings=server_settings,
 
819
                                clients=clients)
895
820
    # Find out what port we got
896
821
    service.port = tcp_server.socket.getsockname()[1]
897
822
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
915
840
                             (*args[2:], **kwargs) or True)
916
841
        
917
842
        logger.debug(u"Starting main loop")
 
843
        main_loop_started = True
918
844
        main_loop.run()
919
845
    except AvahiError, error:
920
846
        logger.critical(u"AvahiError: %s" + unicode(error))