/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-12 19:47:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080812194750-uebbpk9ynxt3sjnt
* initramfs-tools-hook (gpg): Added "--no-random-seed-file" and
                              "--no-default-keyring".  Bug fix: moved
                              "--import" to end.

* mandos-keygen (gpg): Added "--no-options".

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
61
61
from dbus.mainloop.glib import DBusGMainLoop
62
62
import ctypes
63
63
 
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
 
 
 
64
version = "1.0"
75
65
 
76
66
logger = logging.Logger('mandos')
77
67
syslogger = logging.handlers.SysLogHandler\
78
 
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
 
68
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
69
             address = "/dev/log")
79
70
syslogger.setFormatter(logging.Formatter\
80
 
                        ('%(levelname)s: %(message)s'))
 
71
                        ('Mandos: %(levelname)s: %(message)s'))
81
72
logger.addHandler(syslogger)
82
 
del syslogger
83
73
 
 
74
console = logging.StreamHandler()
 
75
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
 
76
                                       ' %(message)s'))
 
77
logger.addHandler(console)
84
78
 
85
79
class AvahiError(Exception):
86
80
    def __init__(self, value):
96
90
 
97
91
 
98
92
class AvahiService(object):
99
 
    """
 
93
    """An Avahi (Zeroconf) service.
 
94
    Attributes:
100
95
    interface: integer; avahi.IF_UNSPEC or an interface index.
101
96
               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
 
97
    name: string; Example: 'Mandos'
 
98
    type: string; Example: '_mandos._tcp'.
 
99
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
100
    port: integer; what port to announce
 
101
    TXT: list of strings; TXT record for the service
 
102
    domain: string; Domain to publish on, default to .local if empty.
 
103
    host: string; Host to publish records for, default is localhost
 
104
    max_renames: integer; maximum number of renames
 
105
    rename_count: integer; counter so we only rename after collisions
 
106
                  a sensible number of times
113
107
    """
114
108
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
109
                 type = None, port = None, TXT = None, domain = "",
116
 
                 host = "", max_renames = 12):
117
 
        """An Avahi (Zeroconf) service. """
 
110
                 host = "", max_renames = 32768):
118
111
        self.interface = interface
119
112
        self.name = name
120
113
        self.type = type
133
126
                            u" retries, exiting.", rename_count)
134
127
            raise AvahiServiceError("Too many renames")
135
128
        name = server.GetAlternativeServiceName(name)
136
 
        logger.notice(u"Changing name to %r ...", name)
 
129
        logger.error(u"Changing name to %r ...", name)
 
130
        syslogger.setFormatter(logging.Formatter\
 
131
                               ('Mandos (%s): %%(levelname)s:'
 
132
                               ' %%(message)s' % name))
137
133
        self.remove()
138
134
        self.add()
139
135
        self.rename_count += 1
175
171
    fingerprint: string (40 or 32 hexadecimal digits); used to
176
172
                 uniquely identify the client
177
173
    secret:    bytestring; sent verbatim (over TLS) to client
178
 
    fqdn:      string (FQDN); available for use by the checker command
 
174
    host:      string; available for use by the checker command
179
175
    created:   datetime.datetime(); object creation, not client host
180
176
    last_checked_ok: datetime.datetime() or None if not yet checked OK
181
177
    timeout:   datetime.timedelta(); How long from last_checked_ok
221
217
    interval = property(lambda self: self._interval,
222
218
                        _set_interval)
223
219
    del _set_interval
224
 
    def __init__(self, name=None, stop_hook=None, fingerprint=None,
225
 
                 secret=None, secfile=None, fqdn=None, timeout=None,
226
 
                 interval=-1, checker=None):
227
 
        """Note: the 'checker' argument sets the 'checker_command'
228
 
        attribute and not the 'checker' attribute.."""
 
220
    def __init__(self, name = None, stop_hook=None, config={}):
 
221
        """Note: the 'checker' key in 'config' sets the
 
222
        'checker_command' attribute and *not* the 'checker'
 
223
        attribute."""
229
224
        self.name = name
230
225
        logger.debug(u"Creating client %r", self.name)
231
 
        # Uppercase and remove spaces from fingerprint
232
 
        # for later comparison purposes with return value of
233
 
        # the fingerprint() function
234
 
        self.fingerprint = fingerprint.upper().replace(u" ", u"")
 
226
        # Uppercase and remove spaces from fingerprint for later
 
227
        # comparison purposes with return value from the fingerprint()
 
228
        # function
 
229
        self.fingerprint = config["fingerprint"].upper()\
 
230
                           .replace(u" ", u"")
235
231
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
236
 
        if secret:
237
 
            self.secret = secret.decode(u"base64")
238
 
        elif secfile:
239
 
            sf = open(secfile)
 
232
        if "secret" in config:
 
233
            self.secret = config["secret"].decode(u"base64")
 
234
        elif "secfile" in config:
 
235
            sf = open(config["secfile"])
240
236
            self.secret = sf.read()
241
237
            sf.close()
242
238
        else:
243
239
            raise TypeError(u"No secret or secfile for client %s"
244
240
                            % self.name)
245
 
        self.fqdn = fqdn
 
241
        self.host = config.get("host", "")
246
242
        self.created = datetime.datetime.now()
247
243
        self.last_checked_ok = None
248
 
        self.timeout = string_to_delta(timeout)
249
 
        self.interval = string_to_delta(interval)
 
244
        self.timeout = string_to_delta(config["timeout"])
 
245
        self.interval = string_to_delta(config["interval"])
250
246
        self.stop_hook = stop_hook
251
247
        self.checker = None
252
248
        self.checker_initiator_tag = None
253
249
        self.stop_initiator_tag = None
254
250
        self.checker_callback_tag = None
255
 
        self.check_command = checker
 
251
        self.check_command = config["checker"]
256
252
    def start(self):
257
253
        """Start this client's checker and timeout hooks"""
258
254
        # Schedule a new checker to be started an 'interval' from now,
271
267
        The possibility that a client might be restarted is left open,
272
268
        but not currently used."""
273
269
        # If this client doesn't have a secret, it is already stopped.
274
 
        if self.secret:
275
 
            logger.debug(u"Stopping client %s", self.name)
 
270
        if hasattr(self, "secret") and self.secret:
 
271
            logger.info(u"Stopping client %s", self.name)
276
272
            self.secret = None
277
273
        else:
278
274
            return False
297
293
        self.checker = None
298
294
        if os.WIFEXITED(condition) \
299
295
               and (os.WEXITSTATUS(condition) == 0):
300
 
            logger.debug(u"Checker for %(name)s succeeded",
301
 
                         vars(self))
 
296
            logger.info(u"Checker for %(name)s succeeded",
 
297
                        vars(self))
302
298
            self.last_checked_ok = now
303
299
            gobject.source_remove(self.stop_initiator_tag)
304
300
            self.stop_initiator_tag = gobject.timeout_add\
308
304
            logger.warning(u"Checker for %(name)s crashed?",
309
305
                           vars(self))
310
306
        else:
311
 
            logger.debug(u"Checker for %(name)s failed",
312
 
                         vars(self))
 
307
            logger.info(u"Checker for %(name)s failed",
 
308
                        vars(self))
313
309
    def start_checker(self):
314
310
        """Start a new checker subprocess if one is not running.
315
311
        If a checker already exists, leave it running and do
325
321
        if self.checker is None:
326
322
            try:
327
323
                # In case check_command has exactly one % operator
328
 
                command = self.check_command % self.fqdn
 
324
                command = self.check_command % self.host
329
325
            except TypeError:
330
326
                # Escape attributes for the shell
331
327
                escaped_attrs = dict((key, re.escape(str(val)))
338
334
                                 u' %s', self.check_command, error)
339
335
                    return True # Try again later
340
336
            try:
341
 
                logger.debug(u"Starting checker %r for %s",
342
 
                             command, self.name)
 
337
                logger.info(u"Starting checker %r for %s",
 
338
                            command, self.name)
343
339
                self.checker = subprocess.Popen(command,
344
340
                                                close_fds=True,
345
341
                                                shell=True, cwd="/")
358
354
            self.checker_callback_tag = None
359
355
        if getattr(self, "checker", None) is None:
360
356
            return
361
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
357
        logger.debug(u"Stopping checker for %(name)s", vars(self))
362
358
        try:
363
359
            os.kill(self.checker.pid, signal.SIGTERM)
364
360
            #os.sleep(0.5)
396
392
 
397
393
def fingerprint(openpgp):
398
394
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
399
 
    # New empty GnuTLS certificate
400
 
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
401
 
    gnutls.library.functions.gnutls_openpgp_crt_init\
402
 
        (ctypes.byref(crt))
403
395
    # New GnuTLS "datum" with the OpenPGP public key
404
396
    datum = gnutls.library.types.gnutls_datum_t\
405
397
        (ctypes.cast(ctypes.c_char_p(openpgp),
406
398
                     ctypes.POINTER(ctypes.c_ubyte)),
407
399
         ctypes.c_uint(len(openpgp)))
 
400
    # New empty GnuTLS certificate
 
401
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
402
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
403
        (ctypes.byref(crt))
408
404
    # Import the OpenPGP public key into the certificate
409
 
    ret = gnutls.library.functions.gnutls_openpgp_crt_import\
410
 
        (crt,
411
 
         ctypes.byref(datum),
412
 
         gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
405
    gnutls.library.functions.gnutls_openpgp_crt_import\
 
406
                    (crt, ctypes.byref(datum),
 
407
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
408
    # New buffer for the fingerprint
414
409
    buffer = ctypes.create_string_buffer(20)
415
410
    buffer_length = ctypes.c_size_t()
431
426
    Note: This will run in its own forked process."""
432
427
    
433
428
    def handle(self):
434
 
        logger.debug(u"TCP connection from: %s",
 
429
        logger.info(u"TCP connection from: %s",
435
430
                     unicode(self.client_address))
436
431
        session = gnutls.connection.ClientSession\
437
432
                  (self.request, gnutls.connection.X509Credentials())
463
458
        try:
464
459
            session.handshake()
465
460
        except gnutls.errors.GNUTLSError, error:
466
 
            logger.debug(u"Handshake failed: %s", error)
 
461
            logger.warning(u"Handshake failed: %s", error)
467
462
            # Do not run session.bye() here: the session is not
468
463
            # established.  Just abandon the request.
469
464
            return
470
465
        try:
471
466
            fpr = fingerprint(peer_certificate(session))
472
467
        except (TypeError, gnutls.errors.GNUTLSError), error:
473
 
            logger.debug(u"Bad certificate: %s", error)
 
468
            logger.warning(u"Bad certificate: %s", error)
474
469
            session.bye()
475
470
            return
476
471
        logger.debug(u"Fingerprint: %s", fpr)
480
475
                client = c
481
476
                break
482
477
        if not client:
483
 
            logger.debug(u"Client not found for fingerprint: %s", fpr)
 
478
            logger.warning(u"Client not found for fingerprint: %s",
 
479
                           fpr)
484
480
            session.bye()
485
481
            return
486
482
        # Have to check if client.still_valid(), since it is possible
487
483
        # that the client timed out while establishing the GnuTLS
488
484
        # session.
489
485
        if not client.still_valid():
490
 
            logger.debug(u"Client %(name)s is invalid", vars(client))
 
486
            logger.warning(u"Client %(name)s is invalid",
 
487
                           vars(client))
491
488
            session.bye()
492
489
            return
493
490
        sent_size = 0
528
525
                                       self.settings["interface"])
529
526
            except socket.error, error:
530
527
                if error[0] == errno.EPERM:
531
 
                    logger.warning(u"No permission to"
532
 
                                   u" bind to interface %s",
533
 
                                   self.settings["interface"])
 
528
                    logger.error(u"No permission to"
 
529
                                 u" bind to interface %s",
 
530
                                 self.settings["interface"])
534
531
                else:
535
532
                    raise error
536
533
        # Only bind(2) the socket if we really need to.
539
536
                in6addr_any = "::"
540
537
                self.server_address = (in6addr_any,
541
538
                                       self.server_address[1])
542
 
            elif self.server_address[1] is None:
 
539
            elif not self.server_address[1]:
543
540
                self.server_address = (self.server_address[0],
544
541
                                       0)
 
542
#                 if self.settings["interface"]:
 
543
#                     self.server_address = (self.server_address[0],
 
544
#                                            0, # port
 
545
#                                            0, # flowinfo
 
546
#                                            if_nametoindex
 
547
#                                            (self.settings
 
548
#                                             ["interface"]))
545
549
            return super(type(self), self).server_bind()
546
550
 
547
551
 
582
586
def server_state_changed(state):
583
587
    """Derived from the Avahi example code"""
584
588
    if state == avahi.SERVER_COLLISION:
585
 
        logger.warning(u"Server name collision")
 
589
        logger.error(u"Server name collision")
586
590
        service.remove()
587
591
    elif state == avahi.SERVER_RUNNING:
588
592
        service.add()
627
631
    return if_nametoindex(interface)
628
632
 
629
633
 
630
 
def daemon(nochdir, noclose):
 
634
def daemon(nochdir = False, noclose = False):
631
635
    """See daemon(3).  Standard BSD Unix function.
632
636
    This should really exist as os.daemon, but it doesn't (yet)."""
633
637
    if os.fork():
635
639
    os.setsid()
636
640
    if not nochdir:
637
641
        os.chdir("/")
 
642
    if os.fork():
 
643
        sys.exit()
638
644
    if not noclose:
639
645
        # Close all standard open file descriptors
640
646
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
652
658
    global main_loop_started
653
659
    main_loop_started = False
654
660
    
655
 
    parser = OptionParser()
 
661
    parser = OptionParser(version = "%%prog %s" % version)
656
662
    parser.add_option("-i", "--interface", type="string",
657
663
                      metavar="IF", help="Bind to interface IF")
658
664
    parser.add_option("-a", "--address", type="string",
661
667
                      help="Port number to receive requests on")
662
668
    parser.add_option("--check", action="store_true", default=False,
663
669
                      help="Run self-test")
664
 
    parser.add_option("--debug", action="store_true", default=False,
 
670
    parser.add_option("--debug", action="store_true",
665
671
                      help="Debug mode; run in foreground and log to"
666
672
                      " terminal")
667
673
    parser.add_option("--priority", type="string", help="GnuTLS"
692
698
    # Parse config file for server-global settings
693
699
    server_config = ConfigParser.SafeConfigParser(server_defaults)
694
700
    del server_defaults
695
 
    server_config.read(os.path.join(options.configdir, "server.conf"))
 
701
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
696
702
    server_section = "server"
697
703
    # Convert the SafeConfigParser object to a dict
698
704
    server_settings = dict(server_config.items(server_section))
711
717
    del options
712
718
    # Now we have our good server settings in "server_settings"
713
719
    
 
720
    debug = server_settings["debug"]
 
721
    
 
722
    if not debug:
 
723
        syslogger.setLevel(logging.WARNING)
 
724
        console.setLevel(logging.WARNING)
 
725
    
 
726
    if server_settings["servicename"] != "Mandos":
 
727
        syslogger.setFormatter(logging.Formatter\
 
728
                               ('Mandos (%s): %%(levelname)s:'
 
729
                                ' %%(message)s'
 
730
                                % server_settings["servicename"]))
 
731
    
714
732
    # Parse config file with clients
715
733
    client_defaults = { "timeout": "1h",
716
734
                        "interval": "5m",
717
 
                        "checker": "fping -q -- %%(fqdn)s",
 
735
                        "checker": "fping -q -- %%(host)s",
718
736
                        }
719
737
    client_config = ConfigParser.SafeConfigParser(client_defaults)
720
738
    client_config.read(os.path.join(server_settings["configdir"],
738
756
            avahi.DBUS_INTERFACE_SERVER )
739
757
    # End of Avahi example code
740
758
    
741
 
    debug = server_settings["debug"]
742
 
    
743
 
    if debug:
744
 
        console = logging.StreamHandler()
745
 
        # console.setLevel(logging.DEBUG)
746
 
        console.setFormatter(logging.Formatter\
747
 
                             ('%(levelname)s: %(message)s'))
748
 
        logger.addHandler(console)
749
 
        del console
750
 
    
751
759
    clients = Set()
752
760
    def remove_from_clients(client):
753
761
        clients.remove(client)
754
762
        if not clients:
755
 
            logger.debug(u"No clients left, exiting")
 
763
            logger.critical(u"No clients left, exiting")
756
764
            sys.exit()
757
765
    
758
 
    clients.update(Set(Client(name=section,
 
766
    clients.update(Set(Client(name = section,
759
767
                              stop_hook = remove_from_clients,
760
 
                              **(dict(client_config\
761
 
                                      .items(section))))
 
768
                              config
 
769
                              = dict(client_config.items(section)))
762
770
                       for section in client_config.sections()))
 
771
    if not clients:
 
772
        logger.critical(u"No clients defined")
 
773
        sys.exit(1)
763
774
    
764
775
    if not debug:
765
 
        daemon(False, False)
 
776
        logger.removeHandler(console)
 
777
        daemon()
 
778
    
 
779
    pidfilename = "/var/run/mandos/mandos.pid"
 
780
    pid = os.getpid()
 
781
    try:
 
782
        pidfile = open(pidfilename, "w")
 
783
        pidfile.write(str(pid) + "\n")
 
784
        pidfile.close()
 
785
        del pidfile
 
786
    except IOError, err:
 
787
        logger.error(u"Could not write %s file with PID %d",
 
788
                     pidfilename, os.getpid())
766
789
    
767
790
    def cleanup():
768
791
        "Cleanup function; run on exit"
795
818
                                clients=clients)
796
819
    # Find out what port we got
797
820
    service.port = tcp_server.socket.getsockname()[1]
798
 
    logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
799
 
                 u" scope_id %d" % tcp_server.socket.getsockname())
 
821
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
 
822
                u" scope_id %d" % tcp_server.socket.getsockname())
800
823
    
801
824
    #service.interface = tcp_server.socket.getsockname()[3]
802
825
    
815
838
                             tcp_server.handle_request\
816
839
                             (*args[2:], **kwargs) or True)
817
840
        
818
 
        logger.debug("Starting main loop")
 
841
        logger.debug(u"Starting main loop")
819
842
        main_loop_started = True
820
843
        main_loop.run()
821
844
    except AvahiError, error: