/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 server.py

Merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
server.py
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
 
# 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".
 
9
# following functions: "AvahiService.add", "AvahiService.remove",
 
10
# "server_state_changed", "entry_group_state_changed", and some lines
 
11
# 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
 
version = "1.0"
 
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
75
 
66
76
logger = logging.Logger('mandos')
67
77
syslogger = logging.handlers.SysLogHandler\
68
 
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
69
 
             address = "/dev/log")
 
78
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
70
79
syslogger.setFormatter(logging.Formatter\
71
 
                        ('Mandos: %(levelname)s: %(message)s'))
 
80
                        ('%(levelname)s: %(message)s'))
72
81
logger.addHandler(syslogger)
 
82
del syslogger
73
83
 
74
 
console = logging.StreamHandler()
75
 
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
76
 
                                       ' %(message)s'))
77
 
logger.addHandler(console)
78
84
 
79
85
class AvahiError(Exception):
80
86
    def __init__(self, value):
90
96
 
91
97
 
92
98
class AvahiService(object):
93
 
    """An Avahi (Zeroconf) service.
94
 
    Attributes:
 
99
    """
95
100
    interface: integer; avahi.IF_UNSPEC or an interface index.
96
101
               Used to optionally bind to the specified interface.
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
 
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
107
113
    """
108
114
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
109
115
                 type = None, port = None, TXT = None, domain = "",
110
 
                 host = "", max_renames = 32768):
 
116
                 host = "", max_renames = 12):
 
117
        """An Avahi (Zeroconf) service. """
111
118
        self.interface = interface
112
119
        self.name = name
113
120
        self.type = type
119
126
        self.domain = domain
120
127
        self.host = host
121
128
        self.rename_count = 0
122
 
        self.max_renames = max_renames
123
129
    def rename(self):
124
130
        """Derived from the Avahi example code"""
125
131
        if self.rename_count >= self.max_renames:
126
132
            logger.critical(u"No suitable service name found after %i"
127
133
                            u" retries, exiting.", rename_count)
128
134
            raise AvahiServiceError("Too many renames")
129
 
        self.name = server.GetAlternativeServiceName(self.name)
130
 
        logger.info(u"Changing name to %r ...", str(self.name))
131
 
        syslogger.setFormatter(logging.Formatter\
132
 
                               ('Mandos (%s): %%(levelname)s:'
133
 
                               ' %%(message)s' % self.name))
 
135
        name = server.GetAlternativeServiceName(name)
 
136
        logger.error(u"Changing name to %r ...", name)
134
137
        self.remove()
135
138
        self.add()
136
139
        self.rename_count += 1
172
175
    fingerprint: string (40 or 32 hexadecimal digits); used to
173
176
                 uniquely identify the client
174
177
    secret:    bytestring; sent verbatim (over TLS) to client
175
 
    host:      string; available for use by the checker command
 
178
    fqdn:      string (FQDN); available for use by the checker command
176
179
    created:   datetime.datetime(); object creation, not client host
177
180
    last_checked_ok: datetime.datetime() or None if not yet checked OK
178
181
    timeout:   datetime.timedelta(); How long from last_checked_ok
219
222
                        _set_interval)
220
223
    del _set_interval
221
224
    def __init__(self, name = None, stop_hook=None, config={}):
222
 
        """Note: the 'checker' key in 'config' sets the
223
 
        'checker_command' attribute and *not* the 'checker'
224
 
        attribute."""
 
225
        """Note: the 'checker' argument sets the 'checker_command'
 
226
        attribute and not the 'checker' attribute.."""
225
227
        self.name = name
226
228
        logger.debug(u"Creating client %r", self.name)
227
 
        # Uppercase and remove spaces from fingerprint for later
228
 
        # comparison purposes with return value from the fingerprint()
229
 
        # function
 
229
        # Uppercase and remove spaces from fingerprint
 
230
        # for later comparison purposes with return value of
 
231
        # the fingerprint() function
230
232
        self.fingerprint = config["fingerprint"].upper()\
231
233
                           .replace(u" ", u"")
232
234
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
239
241
        else:
240
242
            raise TypeError(u"No secret or secfile for client %s"
241
243
                            % self.name)
242
 
        self.host = config.get("host", "")
 
244
        self.fqdn = config.get("fqdn", "")
243
245
        self.created = datetime.datetime.now()
244
246
        self.last_checked_ok = None
245
247
        self.timeout = string_to_delta(config["timeout"])
268
270
        The possibility that a client might be restarted is left open,
269
271
        but not currently used."""
270
272
        # If this client doesn't have a secret, it is already stopped.
271
 
        if hasattr(self, "secret") and self.secret:
 
273
        if self.secret:
272
274
            logger.info(u"Stopping client %s", self.name)
273
275
            self.secret = None
274
276
        else:
322
324
        if self.checker is None:
323
325
            try:
324
326
                # In case check_command has exactly one % operator
325
 
                command = self.check_command % self.host
 
327
                command = self.check_command % self.fqdn
326
328
            except TypeError:
327
329
                # Escape attributes for the shell
328
330
                escaped_attrs = dict((key, re.escape(str(val)))
337
339
            try:
338
340
                logger.info(u"Starting checker %r for %s",
339
341
                            command, self.name)
340
 
                # We don't need to redirect stdout and stderr, since
341
 
                # in normal mode, that is already done by daemon(),
342
 
                # and in debug mode we don't want to.  (Stdin is
343
 
                # always replaced by /dev/null.)
344
342
                self.checker = subprocess.Popen(command,
345
343
                                                close_fds=True,
346
344
                                                shell=True, cwd="/")
347
345
                self.checker_callback_tag = gobject.child_watch_add\
348
346
                                            (self.checker.pid,
349
347
                                             self.checker_callback)
350
 
            except OSError, error:
 
348
            except subprocess.OSError, error:
351
349
                logger.error(u"Failed to start subprocess: %s",
352
350
                             error)
353
351
        # Re-run this periodically if run by gobject.timeout_add
359
357
            self.checker_callback_tag = None
360
358
        if getattr(self, "checker", None) is None:
361
359
            return
362
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
360
        logger.debug("Stopping checker for %(name)s", vars(self))
363
361
        try:
364
362
            os.kill(self.checker.pid, signal.SIGTERM)
365
363
            #os.sleep(0.5)
397
395
 
398
396
def fingerprint(openpgp):
399
397
    "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))
400
402
    # New GnuTLS "datum" with the OpenPGP public key
401
403
    datum = gnutls.library.types.gnutls_datum_t\
402
404
        (ctypes.cast(ctypes.c_char_p(openpgp),
403
405
                     ctypes.POINTER(ctypes.c_ubyte)),
404
406
         ctypes.c_uint(len(openpgp)))
405
 
    # New empty GnuTLS certificate
406
 
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
407
 
    gnutls.library.functions.gnutls_openpgp_crt_init\
408
 
        (ctypes.byref(crt))
409
407
    # Import the OpenPGP public key into the certificate
410
 
    gnutls.library.functions.gnutls_openpgp_crt_import\
411
 
                    (crt, ctypes.byref(datum),
412
 
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
 
    # Verify the self signature in the key
414
 
    crtverify = ctypes.c_uint();
415
 
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
416
 
        (crt, ctypes.c_uint(0), ctypes.byref(crtverify))
417
 
    if crtverify.value != 0:
418
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
419
 
        raise gnutls.errors.CertificateSecurityError("Verify failed")
 
408
    ret = gnutls.library.functions.gnutls_openpgp_crt_import\
 
409
        (crt,
 
410
         ctypes.byref(datum),
 
411
         gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
420
412
    # New buffer for the fingerprint
421
413
    buffer = ctypes.create_string_buffer(20)
422
414
    buffer_length = ctypes.c_size_t()
548
540
                in6addr_any = "::"
549
541
                self.server_address = (in6addr_any,
550
542
                                       self.server_address[1])
551
 
            elif not self.server_address[1]:
 
543
            elif self.server_address[1] is None:
552
544
                self.server_address = (self.server_address[0],
553
545
                                       0)
554
 
#                 if self.settings["interface"]:
555
 
#                     self.server_address = (self.server_address[0],
556
 
#                                            0, # port
557
 
#                                            0, # flowinfo
558
 
#                                            if_nametoindex
559
 
#                                            (self.settings
560
 
#                                             ["interface"]))
561
546
            return super(type(self), self).server_bind()
562
547
 
563
548
 
574
559
    datetime.timedelta(1)
575
560
    >>> string_to_delta(u'1w')
576
561
    datetime.timedelta(7)
577
 
    >>> string_to_delta('5m 30s')
578
 
    datetime.timedelta(0, 330)
579
562
    """
580
 
    timevalue = datetime.timedelta(0)
581
 
    for s in interval.split():
582
 
        try:
583
 
            suffix=unicode(s[-1])
584
 
            value=int(s[:-1])
585
 
            if suffix == u"d":
586
 
                delta = datetime.timedelta(value)
587
 
            elif suffix == u"s":
588
 
                delta = datetime.timedelta(0, value)
589
 
            elif suffix == u"m":
590
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
591
 
            elif suffix == u"h":
592
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
593
 
            elif suffix == u"w":
594
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
595
 
            else:
596
 
                raise ValueError
597
 
        except (ValueError, IndexError):
 
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:
598
577
            raise ValueError
599
 
        timevalue += delta
600
 
    return timevalue
 
578
    except (ValueError, IndexError):
 
579
        raise ValueError
 
580
    return delta
601
581
 
602
582
 
603
583
def server_state_changed(state):
648
628
    return if_nametoindex(interface)
649
629
 
650
630
 
651
 
def daemon(nochdir = False, noclose = False):
 
631
def daemon(nochdir, noclose):
652
632
    """See daemon(3).  Standard BSD Unix function.
653
633
    This should really exist as os.daemon, but it doesn't (yet)."""
654
634
    if os.fork():
656
636
    os.setsid()
657
637
    if not nochdir:
658
638
        os.chdir("/")
659
 
    if os.fork():
660
 
        sys.exit()
661
639
    if not noclose:
662
640
        # Close all standard open file descriptors
663
641
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
675
653
    global main_loop_started
676
654
    main_loop_started = False
677
655
    
678
 
    parser = OptionParser(version = "%%prog %s" % version)
 
656
    parser = OptionParser()
679
657
    parser.add_option("-i", "--interface", type="string",
680
658
                      metavar="IF", help="Bind to interface IF")
681
659
    parser.add_option("-a", "--address", type="string",
684
662
                      help="Port number to receive requests on")
685
663
    parser.add_option("--check", action="store_true", default=False,
686
664
                      help="Run self-test")
687
 
    parser.add_option("--debug", action="store_true",
 
665
    parser.add_option("--debug", action="store_true", default=False,
688
666
                      help="Debug mode; run in foreground and log to"
689
667
                      " terminal")
690
668
    parser.add_option("--priority", type="string", help="GnuTLS"
715
693
    # Parse config file for server-global settings
716
694
    server_config = ConfigParser.SafeConfigParser(server_defaults)
717
695
    del server_defaults
718
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
696
    server_config.read(os.path.join(options.configdir, "server.conf"))
 
697
    server_section = "server"
719
698
    # Convert the SafeConfigParser object to a dict
720
 
    server_settings = server_config.defaults()
 
699
    server_settings = dict(server_config.items(server_section))
721
700
    # Use getboolean on the boolean config option
722
701
    server_settings["debug"] = server_config.getboolean\
723
 
                               ("DEFAULT", "debug")
 
702
                               (server_section, "debug")
724
703
    del server_config
725
704
    
726
705
    # Override the settings from the config file with command line
733
712
    del options
734
713
    # Now we have our good server settings in "server_settings"
735
714
    
736
 
    debug = server_settings["debug"]
737
 
    
738
 
    if not debug:
739
 
        syslogger.setLevel(logging.WARNING)
740
 
        console.setLevel(logging.WARNING)
741
 
    
742
 
    if server_settings["servicename"] != "Mandos":
743
 
        syslogger.setFormatter(logging.Formatter\
744
 
                               ('Mandos (%s): %%(levelname)s:'
745
 
                                ' %%(message)s'
746
 
                                % server_settings["servicename"]))
747
 
    
748
715
    # Parse config file with clients
749
716
    client_defaults = { "timeout": "1h",
750
717
                        "interval": "5m",
751
 
                        "checker": "fping -q -- %(host)s",
752
 
                        "host": "",
 
718
                        "checker": "fping -q -- %%(fqdn)s",
753
719
                        }
754
720
    client_config = ConfigParser.SafeConfigParser(client_defaults)
755
721
    client_config.read(os.path.join(server_settings["configdir"],
773
739
            avahi.DBUS_INTERFACE_SERVER )
774
740
    # End of Avahi example code
775
741
    
 
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
    
776
752
    clients = Set()
777
753
    def remove_from_clients(client):
778
754
        clients.remove(client)
785
761
                              config
786
762
                              = dict(client_config.items(section)))
787
763
                       for section in client_config.sections()))
788
 
    if not clients:
789
 
        logger.critical(u"No clients defined")
790
 
        sys.exit(1)
791
 
    
792
 
    if debug:
793
 
        # Redirect stdin so all checkers get /dev/null
794
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
795
 
        os.dup2(null, sys.stdin.fileno())
796
 
        if null > 2:
797
 
            os.close(null)
798
 
    else:
799
 
        # No console logging
800
 
        logger.removeHandler(console)
801
 
        # Close all input and output, do double fork, etc.
802
 
        daemon()
803
 
    
804
 
    pidfilename = "/var/run/mandos/mandos.pid"
805
 
    pid = os.getpid()
806
 
    try:
807
 
        pidfile = open(pidfilename, "w")
808
 
        pidfile.write(str(pid) + "\n")
809
 
        pidfile.close()
810
 
        del pidfile
811
 
    except IOError, err:
812
 
        logger.error(u"Could not write %s file with PID %d",
813
 
                     pidfilename, os.getpid())
 
764
    
 
765
    if not debug:
 
766
        daemon(False, False)
814
767
    
815
768
    def cleanup():
816
769
        "Cleanup function; run on exit"
863
816
                             tcp_server.handle_request\
864
817
                             (*args[2:], **kwargs) or True)
865
818
        
866
 
        logger.debug(u"Starting main loop")
 
819
        logger.debug("Starting main loop")
867
820
        main_loop_started = True
868
821
        main_loop.run()
869
822
    except AvahiError, error: