/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-10-12 07:27:43 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081012072743-0g7o9e5mqqv4fkob
* README: Refer to man pages of usplash, splashy, and askpass-fifo.

* debian/copyright: Rewritten to conform to
  <http://wiki.debian.org/Proposals/CopyrightFormat?action=recall&rev=233>.

* mandos-keygen: Sign encrypted keys.

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.1"
64
67
 
65
68
logger = logging.Logger('mandos')
66
69
syslogger = logging.handlers.SysLogHandler\
67
 
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
 
70
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
71
             address = "/dev/log")
68
72
syslogger.setFormatter(logging.Formatter\
69
 
                        ('%(levelname)s: %(message)s'))
 
73
                        ('Mandos: %(levelname)s: %(message)s'))
70
74
logger.addHandler(syslogger)
71
 
del 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 = "",
105
 
                 host = "", max_renames = 12):
 
112
                 servicetype = None, port = None, TXT = None, domain = "",
 
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))
 
136
        syslogger.setFormatter(logging.Formatter\
 
137
                               ('Mandos (%s): %%(levelname)s:'
 
138
                               ' %%(message)s' % self.name))
125
139
        self.remove()
126
140
        self.add()
127
141
        self.rename_count += 1
139
153
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
140
154
            group.connect_to_signal('StateChanged',
141
155
                                    entry_group_state_changed)
142
 
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
156
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
143
157
                     service.name, service.type)
144
158
        group.AddService(
145
159
                self.interface,         # interface
163
177
    fingerprint: string (40 or 32 hexadecimal digits); used to
164
178
                 uniquely identify the client
165
179
    secret:    bytestring; sent verbatim (over TLS) to client
166
 
    fqdn:      string (FQDN); available for use by the checker command
 
180
    host:      string; available for use by the checker command
167
181
    created:   datetime.datetime(); object creation, not client host
168
182
    last_checked_ok: datetime.datetime() or None if not yet checked OK
169
183
    timeout:   datetime.timedelta(); How long from last_checked_ok
209
223
    interval = property(lambda self: self._interval,
210
224
                        _set_interval)
211
225
    del _set_interval
212
 
    def __init__(self, name = None, stop_hook=None, config={}):
 
226
    def __init__(self, name = None, stop_hook=None, config=None):
213
227
        """Note: the 'checker' key in 'config' sets the
214
228
        'checker_command' attribute and *not* the 'checker'
215
229
        attribute."""
 
230
        if config is None:
 
231
            config = {}
216
232
        self.name = name
217
233
        logger.debug(u"Creating client %r", self.name)
218
234
        # Uppercase and remove spaces from fingerprint for later
224
240
        if "secret" in config:
225
241
            self.secret = config["secret"].decode(u"base64")
226
242
        elif "secfile" in config:
227
 
            sf = open(config["secfile"])
228
 
            self.secret = sf.read()
229
 
            sf.close()
 
243
            secfile = open(os.path.expanduser(os.path.expandvars
 
244
                                              (config["secfile"])))
 
245
            self.secret = secfile.read()
 
246
            secfile.close()
230
247
        else:
231
248
            raise TypeError(u"No secret or secfile for client %s"
232
249
                            % self.name)
233
 
        self.fqdn = config.get("fqdn", "")
 
250
        self.host = config.get("host", "")
234
251
        self.created = datetime.datetime.now()
235
252
        self.last_checked_ok = None
236
253
        self.timeout = string_to_delta(config["timeout"])
259
276
        The possibility that a client might be restarted is left open,
260
277
        but not currently used."""
261
278
        # If this client doesn't have a secret, it is already stopped.
262
 
        if self.secret:
 
279
        if hasattr(self, "secret") and self.secret:
263
280
            logger.info(u"Stopping client %s", self.name)
264
281
            self.secret = None
265
282
        else:
313
330
        if self.checker is None:
314
331
            try:
315
332
                # In case check_command has exactly one % operator
316
 
                command = self.check_command % self.fqdn
 
333
                command = self.check_command % self.host
317
334
            except TypeError:
318
335
                # Escape attributes for the shell
319
336
                escaped_attrs = dict((key, re.escape(str(val)))
328
345
            try:
329
346
                logger.info(u"Starting checker %r for %s",
330
347
                            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.)
331
352
                self.checker = subprocess.Popen(command,
332
353
                                                close_fds=True,
333
354
                                                shell=True, cwd="/")
334
355
                self.checker_callback_tag = gobject.child_watch_add\
335
356
                                            (self.checker.pid,
336
357
                                             self.checker_callback)
337
 
            except subprocess.OSError, error:
 
358
            except OSError, error:
338
359
                logger.error(u"Failed to start subprocess: %s",
339
360
                             error)
340
361
        # Re-run this periodically if run by gobject.timeout_add
346
367
            self.checker_callback_tag = None
347
368
        if getattr(self, "checker", None) is None:
348
369
            return
349
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
370
        logger.debug(u"Stopping checker for %(name)s", vars(self))
350
371
        try:
351
372
            os.kill(self.checker.pid, signal.SIGTERM)
352
373
            #os.sleep(0.5)
397
418
    gnutls.library.functions.gnutls_openpgp_crt_import\
398
419
                    (crt, ctypes.byref(datum),
399
420
                     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")
400
428
    # New buffer for the fingerprint
401
 
    buffer = ctypes.create_string_buffer(20)
402
 
    buffer_length = ctypes.c_size_t()
 
429
    buf = ctypes.create_string_buffer(20)
 
430
    buf_len = ctypes.c_size_t()
403
431
    # Get the fingerprint from the certificate into the buffer
404
432
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
405
 
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
433
        (crt, ctypes.byref(buf), ctypes.byref(buf_len))
406
434
    # Deinit the certificate
407
435
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
408
436
    # Convert the buffer to a Python bytestring
409
 
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
437
    fpr = ctypes.string_at(buf, buf_len.value)
410
438
    # Convert the bytestring to hexadecimal notation
411
439
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
412
440
    return hex_fpr
413
441
 
414
442
 
415
 
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
443
class TCP_handler(SocketServer.BaseRequestHandler, object):
416
444
    """A TCP request handler class.
417
445
    Instantiated by IPv6_TCPServer for each request to handle it.
418
446
    Note: This will run in its own forked process."""
445
473
        if self.server.settings["priority"]:
446
474
            priority = self.server.settings["priority"]
447
475
        gnutls.library.functions.gnutls_priority_set_direct\
448
 
            (session._c_object, priority, None);
 
476
            (session._c_object, priority, None)
449
477
        
450
478
        try:
451
479
            session.handshake()
494
522
    Attributes:
495
523
        settings:       Server settings
496
524
        clients:        Set() of Client objects
 
525
        enabled:        Boolean; whether this server is activated yet
497
526
    """
498
527
    address_family = socket.AF_INET6
499
528
    def __init__(self, *args, **kwargs):
503
532
        if "clients" in kwargs:
504
533
            self.clients = kwargs["clients"]
505
534
            del kwargs["clients"]
506
 
        return super(type(self), self).__init__(*args, **kwargs)
 
535
        self.enabled = False
 
536
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
507
537
    def server_bind(self):
508
538
        """This overrides the normal server_bind() function
509
539
        to bind to an interface if one was specified, and also NOT to
538
568
#                                            if_nametoindex
539
569
#                                            (self.settings
540
570
#                                             ["interface"]))
541
 
            return super(type(self), self).server_bind()
 
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
542
577
 
543
578
 
544
579
def string_to_delta(interval):
554
589
    datetime.timedelta(1)
555
590
    >>> string_to_delta(u'1w')
556
591
    datetime.timedelta(7)
 
592
    >>> string_to_delta('5m 30s')
 
593
    datetime.timedelta(0, 330)
557
594
    """
558
 
    try:
559
 
        suffix=unicode(interval[-1])
560
 
        value=int(interval[:-1])
561
 
        if suffix == u"d":
562
 
            delta = datetime.timedelta(value)
563
 
        elif suffix == u"s":
564
 
            delta = datetime.timedelta(0, value)
565
 
        elif suffix == u"m":
566
 
            delta = datetime.timedelta(0, 0, 0, 0, value)
567
 
        elif suffix == u"h":
568
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
569
 
        elif suffix == u"w":
570
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
571
 
        else:
 
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):
572
613
            raise ValueError
573
 
    except (ValueError, IndexError):
574
 
        raise ValueError
575
 
    return delta
 
614
        timevalue += delta
 
615
    return timevalue
576
616
 
577
617
 
578
618
def server_state_changed(state):
579
619
    """Derived from the Avahi example code"""
580
620
    if state == avahi.SERVER_COLLISION:
581
 
        logger.error(u"Server name collision")
 
621
        logger.error(u"Zeroconf server name collision")
582
622
        service.remove()
583
623
    elif state == avahi.SERVER_RUNNING:
584
624
        service.add()
586
626
 
587
627
def entry_group_state_changed(state, error):
588
628
    """Derived from the Avahi example code"""
589
 
    logger.debug(u"state change: %i", state)
 
629
    logger.debug(u"Avahi state change: %i", state)
590
630
    
591
631
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
592
 
        logger.debug(u"Service established.")
 
632
        logger.debug(u"Zeroconf service established.")
593
633
    elif state == avahi.ENTRY_GROUP_COLLISION:
594
 
        logger.warning(u"Service name collision.")
 
634
        logger.warning(u"Zeroconf service name collision.")
595
635
        service.rename()
596
636
    elif state == avahi.ENTRY_GROUP_FAILURE:
597
 
        logger.critical(u"Error in group state changed %s",
 
637
        logger.critical(u"Avahi: Error in group state changed %s",
598
638
                        unicode(error))
599
639
        raise AvahiGroupError("State changed: %s", str(error))
600
640
 
602
642
    """Call the C function if_nametoindex(), or equivalent"""
603
643
    global if_nametoindex
604
644
    try:
605
 
        if "ctypes.util" not in sys.modules:
606
 
            import ctypes.util
607
645
        if_nametoindex = ctypes.cdll.LoadLibrary\
608
646
            (ctypes.util.find_library("c")).if_nametoindex
609
647
    except (OSError, AttributeError):
647
685
 
648
686
 
649
687
def main():
650
 
    global main_loop_started
651
 
    main_loop_started = False
652
 
    
653
 
    parser = OptionParser()
 
688
    parser = OptionParser(version = "%%prog %s" % version)
654
689
    parser.add_option("-i", "--interface", type="string",
655
690
                      metavar="IF", help="Bind to interface IF")
656
691
    parser.add_option("-a", "--address", type="string",
670
705
                      default="/etc/mandos", metavar="DIR",
671
706
                      help="Directory to search for configuration"
672
707
                      " files")
673
 
    (options, args) = parser.parse_args()
 
708
    options = parser.parse_args()[0]
674
709
    
675
710
    if options.check:
676
711
        import doctest
691
726
    server_config = ConfigParser.SafeConfigParser(server_defaults)
692
727
    del server_defaults
693
728
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
694
 
    server_section = "server"
695
729
    # Convert the SafeConfigParser object to a dict
696
 
    server_settings = dict(server_config.items(server_section))
 
730
    server_settings = server_config.defaults()
697
731
    # Use getboolean on the boolean config option
698
732
    server_settings["debug"] = server_config.getboolean\
699
 
                               (server_section, "debug")
 
733
                               ("DEFAULT", "debug")
700
734
    del server_config
701
735
    
702
736
    # Override the settings from the config file with command line
709
743
    del options
710
744
    # Now we have our good server settings in "server_settings"
711
745
    
 
746
    debug = server_settings["debug"]
 
747
    
 
748
    if not debug:
 
749
        syslogger.setLevel(logging.WARNING)
 
750
        console.setLevel(logging.WARNING)
 
751
    
 
752
    if server_settings["servicename"] != "Mandos":
 
753
        syslogger.setFormatter(logging.Formatter\
 
754
                               ('Mandos (%s): %%(levelname)s:'
 
755
                                ' %%(message)s'
 
756
                                % server_settings["servicename"]))
 
757
    
712
758
    # Parse config file with clients
713
759
    client_defaults = { "timeout": "1h",
714
760
                        "interval": "5m",
715
 
                        "checker": "fping -q -- %%(fqdn)s",
 
761
                        "checker": "fping -q -- %(host)s",
 
762
                        "host": "",
716
763
                        }
717
764
    client_config = ConfigParser.SafeConfigParser(client_defaults)
718
765
    client_config.read(os.path.join(server_settings["configdir"],
719
766
                                    "clients.conf"))
720
767
    
 
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
    
721
803
    global service
722
804
    service = AvahiService(name = server_settings["servicename"],
723
 
                           type = "_mandos._tcp", );
 
805
                           servicetype = "_mandos._tcp", )
724
806
    if server_settings["interface"]:
725
 
        service.interface = if_nametoindex(server_settings["interface"])
 
807
        service.interface = if_nametoindex\
 
808
                            (server_settings["interface"])
726
809
    
727
810
    global main_loop
728
811
    global bus
731
814
    DBusGMainLoop(set_as_default=True )
732
815
    main_loop = gobject.MainLoop()
733
816
    bus = dbus.SystemBus()
734
 
    server = dbus.Interface(
735
 
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
736
 
            avahi.DBUS_INTERFACE_SERVER )
 
817
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
 
818
                                           avahi.DBUS_PATH_SERVER),
 
819
                            avahi.DBUS_INTERFACE_SERVER)
737
820
    # End of Avahi example code
738
821
    
739
 
    debug = server_settings["debug"]
740
 
    
741
 
    if debug:
742
 
        console = logging.StreamHandler()
743
 
        # console.setLevel(logging.DEBUG)
744
 
        console.setFormatter(logging.Formatter\
745
 
                             ('%(levelname)s: %(message)s'))
746
 
        logger.addHandler(console)
747
 
        del console
748
 
    
749
 
    clients = Set()
750
822
    def remove_from_clients(client):
751
823
        clients.remove(client)
752
824
        if not clients:
758
830
                              config
759
831
                              = dict(client_config.items(section)))
760
832
                       for section in client_config.sections()))
 
833
    if not clients:
 
834
        logger.critical(u"No clients defined")
 
835
        sys.exit(1)
761
836
    
762
 
    if not debug:
 
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
 
845
        logger.removeHandler(console)
 
846
        # Close all input and output, do double fork, etc.
763
847
        daemon()
764
848
    
 
849
    try:
 
850
        pid = os.getpid()
 
851
        pidfile.write(str(pid) + "\n")
 
852
        pidfile.close()
 
853
        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
 
861
    
765
862
    def cleanup():
766
863
        "Cleanup function; run on exit"
767
864
        global group
786
883
    for client in clients:
787
884
        client.start()
788
885
    
789
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
790
 
                                 server_settings["port"]),
791
 
                                tcp_handler,
792
 
                                settings=server_settings,
793
 
                                clients=clients)
 
886
    tcp_server.enable()
 
887
    tcp_server.server_activate()
 
888
    
794
889
    # Find out what port we got
795
890
    service.port = tcp_server.socket.getsockname()[1]
796
891
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
813
908
                             tcp_server.handle_request\
814
909
                             (*args[2:], **kwargs) or True)
815
910
        
816
 
        logger.debug("Starting main loop")
817
 
        main_loop_started = True
 
911
        logger.debug(u"Starting main loop")
818
912
        main_loop.run()
819
913
    except AvahiError, error:
820
914
        logger.critical(u"AvahiError: %s" + unicode(error))