/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2008-08-29 07:30:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829073017-tvryowganbf75zp5
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
                                      man-pages(7).
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml (SEE ALSO): Changed from an
                                             <itemizedlist> to a
                                             <para>, as per
                                             man-pages(7).  Also
                                             alphabetize.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
 
# following functions: "AvahiService.add", "AvahiService.remove",
10
 
# "server_state_changed", "entry_group_state_changed", and some lines
11
 
# in "main".
 
9
# methods "add" and "remove" in the "AvahiService" class, the
 
10
# "server_state_changed" and "entry_group_state_changed" functions,
 
11
# and some lines in "main".
12
12
# 
13
13
# Everything else is
14
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
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
# 
61
62
from dbus.mainloop.glib import DBusGMainLoop
62
63
import ctypes
63
64
 
64
 
# Brief description of the operation of this program:
65
 
# 
66
 
# This server announces itself as a Zeroconf service.  Connecting
67
 
# clients use the TLS protocol, with the unusual quirk that this
68
 
# server program acts as a TLS "client" while a connecting client acts
69
 
# as a TLS "server".  The client (acting as a TLS "server") must
70
 
# supply an OpenPGP certificate, and the fingerprint of this
71
 
# certificate is used by this server to look up (in a list read from a
72
 
# file at start time) which binary blob to give the client.  No other
73
 
# authentication or authorization is done by this server.
74
 
 
 
65
version = "1.0"
75
66
 
76
67
logger = logging.Logger('mandos')
77
68
syslogger = logging.handlers.SysLogHandler\
78
 
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
 
69
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
70
             address = "/dev/log")
79
71
syslogger.setFormatter(logging.Formatter\
80
 
                        ('%(levelname)s: %(message)s'))
 
72
                        ('Mandos: %(levelname)s: %(message)s'))
81
73
logger.addHandler(syslogger)
82
 
del syslogger
83
74
 
 
75
console = logging.StreamHandler()
 
76
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
 
77
                                       ' %(message)s'))
 
78
logger.addHandler(console)
84
79
 
85
80
class AvahiError(Exception):
86
81
    def __init__(self, value):
96
91
 
97
92
 
98
93
class AvahiService(object):
99
 
    """
 
94
    """An Avahi (Zeroconf) service.
 
95
    Attributes:
100
96
    interface: integer; avahi.IF_UNSPEC or an interface index.
101
97
               Used to optionally bind to the specified interface.
102
 
    name = string; Example: "Mandos"
103
 
    type = string; Example: "_mandos._tcp".
104
 
                   See <http://www.dns-sd.org/ServiceTypes.html>
105
 
    port = integer; what port to announce
106
 
    TXT = list of strings; TXT record for the service
107
 
    domain = string; Domain to publish on, default to .local if empty.
108
 
    host = string; Host to publish records for, default to localhost
109
 
                   if empty.
110
 
    max_renames = integer; maximum number of renames
111
 
    rename_count = integer; counter so we only rename after collisions
112
 
                   a sensible number of times
 
98
    name: string; Example: 'Mandos'
 
99
    type: string; Example: '_mandos._tcp'.
 
100
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
101
    port: integer; what port to announce
 
102
    TXT: list of strings; TXT record for the service
 
103
    domain: string; Domain to publish on, default to .local if empty.
 
104
    host: string; Host to publish records for, default is localhost
 
105
    max_renames: integer; maximum number of renames
 
106
    rename_count: integer; counter so we only rename after collisions
 
107
                  a sensible number of times
113
108
    """
114
109
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
110
                 type = None, port = None, TXT = None, domain = "",
116
 
                 host = "", max_renames = 12):
117
 
        """An Avahi (Zeroconf) service. """
 
111
                 host = "", max_renames = 32768):
118
112
        self.interface = interface
119
113
        self.name = name
120
114
        self.type = type
126
120
        self.domain = domain
127
121
        self.host = host
128
122
        self.rename_count = 0
 
123
        self.max_renames = max_renames
129
124
    def rename(self):
130
125
        """Derived from the Avahi example code"""
131
126
        if self.rename_count >= self.max_renames:
132
 
            logger.critical(u"No suitable service name found after %i"
133
 
                            u" retries, exiting.", rename_count)
 
127
            logger.critical(u"No suitable Zeroconf service name found"
 
128
                            u" after %i retries, exiting.",
 
129
                            rename_count)
134
130
            raise AvahiServiceError("Too many renames")
135
 
        name = server.GetAlternativeServiceName(name)
136
 
        logger.error(u"Changing name to %r ...", name)
 
131
        self.name = server.GetAlternativeServiceName(self.name)
 
132
        logger.info(u"Changing Zeroconf service name to %r ...",
 
133
                    str(self.name))
 
134
        syslogger.setFormatter(logging.Formatter\
 
135
                               ('Mandos (%s): %%(levelname)s:'
 
136
                               ' %%(message)s' % self.name))
137
137
        self.remove()
138
138
        self.add()
139
139
        self.rename_count += 1
151
151
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
152
152
            group.connect_to_signal('StateChanged',
153
153
                                    entry_group_state_changed)
154
 
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
154
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
155
155
                     service.name, service.type)
156
156
        group.AddService(
157
157
                self.interface,         # interface
175
175
    fingerprint: string (40 or 32 hexadecimal digits); used to
176
176
                 uniquely identify the client
177
177
    secret:    bytestring; sent verbatim (over TLS) to client
178
 
    fqdn:      string (FQDN); available for use by the checker command
 
178
    host:      string; available for use by the checker command
179
179
    created:   datetime.datetime(); object creation, not client host
180
180
    last_checked_ok: datetime.datetime() or None if not yet checked OK
181
181
    timeout:   datetime.timedelta(); How long from last_checked_ok
222
222
                        _set_interval)
223
223
    del _set_interval
224
224
    def __init__(self, name = None, stop_hook=None, config={}):
225
 
        """Note: the 'checker' argument sets the 'checker_command'
226
 
        attribute and not the 'checker' attribute.."""
 
225
        """Note: the 'checker' key in 'config' sets the
 
226
        'checker_command' attribute and *not* the 'checker'
 
227
        attribute."""
227
228
        self.name = name
228
229
        logger.debug(u"Creating client %r", self.name)
229
 
        # Uppercase and remove spaces from fingerprint
230
 
        # for later comparison purposes with return value of
231
 
        # the fingerprint() function
 
230
        # Uppercase and remove spaces from fingerprint for later
 
231
        # comparison purposes with return value from the fingerprint()
 
232
        # function
232
233
        self.fingerprint = config["fingerprint"].upper()\
233
234
                           .replace(u" ", u"")
234
235
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
241
242
        else:
242
243
            raise TypeError(u"No secret or secfile for client %s"
243
244
                            % self.name)
244
 
        self.fqdn = config.get("fqdn", "")
 
245
        self.host = config.get("host", "")
245
246
        self.created = datetime.datetime.now()
246
247
        self.last_checked_ok = None
247
248
        self.timeout = string_to_delta(config["timeout"])
270
271
        The possibility that a client might be restarted is left open,
271
272
        but not currently used."""
272
273
        # If this client doesn't have a secret, it is already stopped.
273
 
        if self.secret:
 
274
        if hasattr(self, "secret") and self.secret:
274
275
            logger.info(u"Stopping client %s", self.name)
275
276
            self.secret = None
276
277
        else:
324
325
        if self.checker is None:
325
326
            try:
326
327
                # In case check_command has exactly one % operator
327
 
                command = self.check_command % self.fqdn
 
328
                command = self.check_command % self.host
328
329
            except TypeError:
329
330
                # Escape attributes for the shell
330
331
                escaped_attrs = dict((key, re.escape(str(val)))
339
340
            try:
340
341
                logger.info(u"Starting checker %r for %s",
341
342
                            command, self.name)
 
343
                # We don't need to redirect stdout and stderr, since
 
344
                # in normal mode, that is already done by daemon(),
 
345
                # and in debug mode we don't want to.  (Stdin is
 
346
                # always replaced by /dev/null.)
342
347
                self.checker = subprocess.Popen(command,
343
348
                                                close_fds=True,
344
349
                                                shell=True, cwd="/")
345
350
                self.checker_callback_tag = gobject.child_watch_add\
346
351
                                            (self.checker.pid,
347
352
                                             self.checker_callback)
348
 
            except subprocess.OSError, error:
 
353
            except OSError, error:
349
354
                logger.error(u"Failed to start subprocess: %s",
350
355
                             error)
351
356
        # Re-run this periodically if run by gobject.timeout_add
357
362
            self.checker_callback_tag = None
358
363
        if getattr(self, "checker", None) is None:
359
364
            return
360
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
365
        logger.debug(u"Stopping checker for %(name)s", vars(self))
361
366
        try:
362
367
            os.kill(self.checker.pid, signal.SIGTERM)
363
368
            #os.sleep(0.5)
395
400
 
396
401
def fingerprint(openpgp):
397
402
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
398
 
    # New empty GnuTLS certificate
399
 
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
400
 
    gnutls.library.functions.gnutls_openpgp_crt_init\
401
 
        (ctypes.byref(crt))
402
403
    # New GnuTLS "datum" with the OpenPGP public key
403
404
    datum = gnutls.library.types.gnutls_datum_t\
404
405
        (ctypes.cast(ctypes.c_char_p(openpgp),
405
406
                     ctypes.POINTER(ctypes.c_ubyte)),
406
407
         ctypes.c_uint(len(openpgp)))
 
408
    # New empty GnuTLS certificate
 
409
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
410
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
411
        (ctypes.byref(crt))
407
412
    # Import the OpenPGP public key into the certificate
408
 
    ret = gnutls.library.functions.gnutls_openpgp_crt_import\
409
 
        (crt,
410
 
         ctypes.byref(datum),
411
 
         gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
413
    gnutls.library.functions.gnutls_openpgp_crt_import\
 
414
                    (crt, ctypes.byref(datum),
 
415
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
416
    # Verify the self signature in the key
 
417
    crtverify = ctypes.c_uint();
 
418
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
 
419
        (crt, 0, ctypes.byref(crtverify))
 
420
    if crtverify.value != 0:
 
421
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
422
        raise gnutls.errors.CertificateSecurityError("Verify failed")
412
423
    # New buffer for the fingerprint
413
424
    buffer = ctypes.create_string_buffer(20)
414
425
    buffer_length = ctypes.c_size_t()
540
551
                in6addr_any = "::"
541
552
                self.server_address = (in6addr_any,
542
553
                                       self.server_address[1])
543
 
            elif self.server_address[1] is None:
 
554
            elif not self.server_address[1]:
544
555
                self.server_address = (self.server_address[0],
545
556
                                       0)
 
557
#                 if self.settings["interface"]:
 
558
#                     self.server_address = (self.server_address[0],
 
559
#                                            0, # port
 
560
#                                            0, # flowinfo
 
561
#                                            if_nametoindex
 
562
#                                            (self.settings
 
563
#                                             ["interface"]))
546
564
            return super(type(self), self).server_bind()
547
565
 
548
566
 
559
577
    datetime.timedelta(1)
560
578
    >>> string_to_delta(u'1w')
561
579
    datetime.timedelta(7)
 
580
    >>> string_to_delta('5m 30s')
 
581
    datetime.timedelta(0, 330)
562
582
    """
563
 
    try:
564
 
        suffix=unicode(interval[-1])
565
 
        value=int(interval[:-1])
566
 
        if suffix == u"d":
567
 
            delta = datetime.timedelta(value)
568
 
        elif suffix == u"s":
569
 
            delta = datetime.timedelta(0, value)
570
 
        elif suffix == u"m":
571
 
            delta = datetime.timedelta(0, 0, 0, 0, value)
572
 
        elif suffix == u"h":
573
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
574
 
        elif suffix == u"w":
575
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
576
 
        else:
 
583
    timevalue = datetime.timedelta(0)
 
584
    for s in interval.split():
 
585
        try:
 
586
            suffix=unicode(s[-1])
 
587
            value=int(s[:-1])
 
588
            if suffix == u"d":
 
589
                delta = datetime.timedelta(value)
 
590
            elif suffix == u"s":
 
591
                delta = datetime.timedelta(0, value)
 
592
            elif suffix == u"m":
 
593
                delta = datetime.timedelta(0, 0, 0, 0, value)
 
594
            elif suffix == u"h":
 
595
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
596
            elif suffix == u"w":
 
597
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
598
            else:
 
599
                raise ValueError
 
600
        except (ValueError, IndexError):
577
601
            raise ValueError
578
 
    except (ValueError, IndexError):
579
 
        raise ValueError
580
 
    return delta
 
602
        timevalue += delta
 
603
    return timevalue
581
604
 
582
605
 
583
606
def server_state_changed(state):
584
607
    """Derived from the Avahi example code"""
585
608
    if state == avahi.SERVER_COLLISION:
586
 
        logger.error(u"Server name collision")
 
609
        logger.error(u"Zeroconf server name collision")
587
610
        service.remove()
588
611
    elif state == avahi.SERVER_RUNNING:
589
612
        service.add()
591
614
 
592
615
def entry_group_state_changed(state, error):
593
616
    """Derived from the Avahi example code"""
594
 
    logger.debug(u"state change: %i", state)
 
617
    logger.debug(u"Avahi state change: %i", state)
595
618
    
596
619
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
597
 
        logger.debug(u"Service established.")
 
620
        logger.debug(u"Zeroconf service established.")
598
621
    elif state == avahi.ENTRY_GROUP_COLLISION:
599
 
        logger.warning(u"Service name collision.")
 
622
        logger.warning(u"Zeroconf service name collision.")
600
623
        service.rename()
601
624
    elif state == avahi.ENTRY_GROUP_FAILURE:
602
 
        logger.critical(u"Error in group state changed %s",
 
625
        logger.critical(u"Avahi: Error in group state changed %s",
603
626
                        unicode(error))
604
627
        raise AvahiGroupError("State changed: %s", str(error))
605
628
 
628
651
    return if_nametoindex(interface)
629
652
 
630
653
 
631
 
def daemon(nochdir, noclose):
 
654
def daemon(nochdir = False, noclose = False):
632
655
    """See daemon(3).  Standard BSD Unix function.
633
656
    This should really exist as os.daemon, but it doesn't (yet)."""
634
657
    if os.fork():
636
659
    os.setsid()
637
660
    if not nochdir:
638
661
        os.chdir("/")
 
662
    if os.fork():
 
663
        sys.exit()
639
664
    if not noclose:
640
665
        # Close all standard open file descriptors
641
666
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
653
678
    global main_loop_started
654
679
    main_loop_started = False
655
680
    
656
 
    parser = OptionParser()
 
681
    parser = OptionParser(version = "%%prog %s" % version)
657
682
    parser.add_option("-i", "--interface", type="string",
658
683
                      metavar="IF", help="Bind to interface IF")
659
684
    parser.add_option("-a", "--address", type="string",
662
687
                      help="Port number to receive requests on")
663
688
    parser.add_option("--check", action="store_true", default=False,
664
689
                      help="Run self-test")
665
 
    parser.add_option("--debug", action="store_true", default=False,
 
690
    parser.add_option("--debug", action="store_true",
666
691
                      help="Debug mode; run in foreground and log to"
667
692
                      " terminal")
668
693
    parser.add_option("--priority", type="string", help="GnuTLS"
693
718
    # Parse config file for server-global settings
694
719
    server_config = ConfigParser.SafeConfigParser(server_defaults)
695
720
    del server_defaults
696
 
    server_config.read(os.path.join(options.configdir, "server.conf"))
697
 
    server_section = "server"
 
721
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
698
722
    # Convert the SafeConfigParser object to a dict
699
 
    server_settings = dict(server_config.items(server_section))
 
723
    server_settings = server_config.defaults()
700
724
    # Use getboolean on the boolean config option
701
725
    server_settings["debug"] = server_config.getboolean\
702
 
                               (server_section, "debug")
 
726
                               ("DEFAULT", "debug")
703
727
    del server_config
704
728
    
705
729
    # Override the settings from the config file with command line
712
736
    del options
713
737
    # Now we have our good server settings in "server_settings"
714
738
    
 
739
    debug = server_settings["debug"]
 
740
    
 
741
    if not debug:
 
742
        syslogger.setLevel(logging.WARNING)
 
743
        console.setLevel(logging.WARNING)
 
744
    
 
745
    if server_settings["servicename"] != "Mandos":
 
746
        syslogger.setFormatter(logging.Formatter\
 
747
                               ('Mandos (%s): %%(levelname)s:'
 
748
                                ' %%(message)s'
 
749
                                % server_settings["servicename"]))
 
750
    
715
751
    # Parse config file with clients
716
752
    client_defaults = { "timeout": "1h",
717
753
                        "interval": "5m",
718
 
                        "checker": "fping -q -- %%(fqdn)s",
 
754
                        "checker": "fping -q -- %(host)s",
 
755
                        "host": "",
719
756
                        }
720
757
    client_config = ConfigParser.SafeConfigParser(client_defaults)
721
758
    client_config.read(os.path.join(server_settings["configdir"],
725
762
    service = AvahiService(name = server_settings["servicename"],
726
763
                           type = "_mandos._tcp", );
727
764
    if server_settings["interface"]:
728
 
        service.interface = if_nametoindex(server_settings["interface"])
 
765
        service.interface = if_nametoindex\
 
766
                            (server_settings["interface"])
729
767
    
730
768
    global main_loop
731
769
    global bus
734
772
    DBusGMainLoop(set_as_default=True )
735
773
    main_loop = gobject.MainLoop()
736
774
    bus = dbus.SystemBus()
737
 
    server = dbus.Interface(
738
 
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
739
 
            avahi.DBUS_INTERFACE_SERVER )
 
775
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
 
776
                                           avahi.DBUS_PATH_SERVER),
 
777
                            avahi.DBUS_INTERFACE_SERVER)
740
778
    # End of Avahi example code
741
779
    
742
 
    debug = server_settings["debug"]
743
 
    
744
 
    if debug:
745
 
        console = logging.StreamHandler()
746
 
        # console.setLevel(logging.DEBUG)
747
 
        console.setFormatter(logging.Formatter\
748
 
                             ('%(levelname)s: %(message)s'))
749
 
        logger.addHandler(console)
750
 
        del console
751
 
    
752
780
    clients = Set()
753
781
    def remove_from_clients(client):
754
782
        clients.remove(client)
761
789
                              config
762
790
                              = dict(client_config.items(section)))
763
791
                       for section in client_config.sections()))
764
 
    
765
 
    if not debug:
766
 
        daemon(False, False)
 
792
    if not clients:
 
793
        logger.critical(u"No clients defined")
 
794
        sys.exit(1)
 
795
    
 
796
    if debug:
 
797
        # Redirect stdin so all checkers get /dev/null
 
798
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
799
        os.dup2(null, sys.stdin.fileno())
 
800
        if null > 2:
 
801
            os.close(null)
 
802
    else:
 
803
        # No console logging
 
804
        logger.removeHandler(console)
 
805
        # Close all input and output, do double fork, etc.
 
806
        daemon()
 
807
    
 
808
    pidfilename = "/var/run/mandos/mandos.pid"
 
809
    pid = os.getpid()
 
810
    try:
 
811
        pidfile = open(pidfilename, "w")
 
812
        pidfile.write(str(pid) + "\n")
 
813
        pidfile.close()
 
814
        del pidfile
 
815
    except IOError, err:
 
816
        logger.error(u"Could not write %s file with PID %d",
 
817
                     pidfilename, os.getpid())
767
818
    
768
819
    def cleanup():
769
820
        "Cleanup function; run on exit"
816
867
                             tcp_server.handle_request\
817
868
                             (*args[2:], **kwargs) or True)
818
869
        
819
 
        logger.debug("Starting main loop")
 
870
        logger.debug(u"Starting main loop")
820
871
        main_loop_started = True
821
872
        main_loop.run()
822
873
    except AvahiError, error: