/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
127
134
            raise AvahiServiceError("Too many renames")
128
135
        name = server.GetAlternativeServiceName(name)
129
136
        logger.error(u"Changing name to %r ...", name)
130
 
        syslogger.setFormatter(logging.Formatter\
131
 
                               ('Mandos (%s): %%(levelname)s:'
132
 
                               ' %%(message)s' % name))
133
137
        self.remove()
134
138
        self.add()
135
139
        self.rename_count += 1
171
175
    fingerprint: string (40 or 32 hexadecimal digits); used to
172
176
                 uniquely identify the client
173
177
    secret:    bytestring; sent verbatim (over TLS) to client
174
 
    host:      string; available for use by the checker command
 
178
    fqdn:      string (FQDN); available for use by the checker command
175
179
    created:   datetime.datetime(); object creation, not client host
176
180
    last_checked_ok: datetime.datetime() or None if not yet checked OK
177
181
    timeout:   datetime.timedelta(); How long from last_checked_ok
218
222
                        _set_interval)
219
223
    del _set_interval
220
224
    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."""
 
225
        """Note: the 'checker' argument sets the 'checker_command'
 
226
        attribute and not the 'checker' attribute.."""
224
227
        self.name = name
225
228
        logger.debug(u"Creating client %r", self.name)
226
 
        # Uppercase and remove spaces from fingerprint for later
227
 
        # comparison purposes with return value from the fingerprint()
228
 
        # function
 
229
        # Uppercase and remove spaces from fingerprint
 
230
        # for later comparison purposes with return value of
 
231
        # the fingerprint() function
229
232
        self.fingerprint = config["fingerprint"].upper()\
230
233
                           .replace(u" ", u"")
231
234
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
238
241
        else:
239
242
            raise TypeError(u"No secret or secfile for client %s"
240
243
                            % self.name)
241
 
        self.host = config.get("host", "")
 
244
        self.fqdn = config.get("fqdn", "")
242
245
        self.created = datetime.datetime.now()
243
246
        self.last_checked_ok = None
244
247
        self.timeout = string_to_delta(config["timeout"])
267
270
        The possibility that a client might be restarted is left open,
268
271
        but not currently used."""
269
272
        # If this client doesn't have a secret, it is already stopped.
270
 
        if hasattr(self, "secret") and self.secret:
 
273
        if self.secret:
271
274
            logger.info(u"Stopping client %s", self.name)
272
275
            self.secret = None
273
276
        else:
321
324
        if self.checker is None:
322
325
            try:
323
326
                # In case check_command has exactly one % operator
324
 
                command = self.check_command % self.host
 
327
                command = self.check_command % self.fqdn
325
328
            except TypeError:
326
329
                # Escape attributes for the shell
327
330
                escaped_attrs = dict((key, re.escape(str(val)))
354
357
            self.checker_callback_tag = None
355
358
        if getattr(self, "checker", None) is None:
356
359
            return
357
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
360
        logger.debug("Stopping checker for %(name)s", vars(self))
358
361
        try:
359
362
            os.kill(self.checker.pid, signal.SIGTERM)
360
363
            #os.sleep(0.5)
392
395
 
393
396
def fingerprint(openpgp):
394
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))
395
402
    # New GnuTLS "datum" with the OpenPGP public key
396
403
    datum = gnutls.library.types.gnutls_datum_t\
397
404
        (ctypes.cast(ctypes.c_char_p(openpgp),
398
405
                     ctypes.POINTER(ctypes.c_ubyte)),
399
406
         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))
404
407
    # Import the OpenPGP public key into the certificate
405
 
    gnutls.library.functions.gnutls_openpgp_crt_import\
406
 
                    (crt, ctypes.byref(datum),
407
 
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
408
    ret = gnutls.library.functions.gnutls_openpgp_crt_import\
 
409
        (crt,
 
410
         ctypes.byref(datum),
 
411
         gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
408
412
    # New buffer for the fingerprint
409
413
    buffer = ctypes.create_string_buffer(20)
410
414
    buffer_length = ctypes.c_size_t()
536
540
                in6addr_any = "::"
537
541
                self.server_address = (in6addr_any,
538
542
                                       self.server_address[1])
539
 
            elif not self.server_address[1]:
 
543
            elif self.server_address[1] is None:
540
544
                self.server_address = (self.server_address[0],
541
545
                                       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"]))
549
546
            return super(type(self), self).server_bind()
550
547
 
551
548
 
631
628
    return if_nametoindex(interface)
632
629
 
633
630
 
634
 
def daemon(nochdir = False, noclose = False):
 
631
def daemon(nochdir, noclose):
635
632
    """See daemon(3).  Standard BSD Unix function.
636
633
    This should really exist as os.daemon, but it doesn't (yet)."""
637
634
    if os.fork():
639
636
    os.setsid()
640
637
    if not nochdir:
641
638
        os.chdir("/")
642
 
    if os.fork():
643
 
        sys.exit()
644
639
    if not noclose:
645
640
        # Close all standard open file descriptors
646
641
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
658
653
    global main_loop_started
659
654
    main_loop_started = False
660
655
    
661
 
    parser = OptionParser(version = "%%prog %s" % version)
 
656
    parser = OptionParser()
662
657
    parser.add_option("-i", "--interface", type="string",
663
658
                      metavar="IF", help="Bind to interface IF")
664
659
    parser.add_option("-a", "--address", type="string",
667
662
                      help="Port number to receive requests on")
668
663
    parser.add_option("--check", action="store_true", default=False,
669
664
                      help="Run self-test")
670
 
    parser.add_option("--debug", action="store_true",
 
665
    parser.add_option("--debug", action="store_true", default=False,
671
666
                      help="Debug mode; run in foreground and log to"
672
667
                      " terminal")
673
668
    parser.add_option("--priority", type="string", help="GnuTLS"
698
693
    # Parse config file for server-global settings
699
694
    server_config = ConfigParser.SafeConfigParser(server_defaults)
700
695
    del server_defaults
701
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
696
    server_config.read(os.path.join(options.configdir, "server.conf"))
702
697
    server_section = "server"
703
698
    # Convert the SafeConfigParser object to a dict
704
699
    server_settings = dict(server_config.items(server_section))
717
712
    del options
718
713
    # Now we have our good server settings in "server_settings"
719
714
    
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
 
    
732
715
    # Parse config file with clients
733
716
    client_defaults = { "timeout": "1h",
734
717
                        "interval": "5m",
735
 
                        "checker": "fping -q -- %%(host)s",
 
718
                        "checker": "fping -q -- %%(fqdn)s",
736
719
                        }
737
720
    client_config = ConfigParser.SafeConfigParser(client_defaults)
738
721
    client_config.read(os.path.join(server_settings["configdir"],
756
739
            avahi.DBUS_INTERFACE_SERVER )
757
740
    # End of Avahi example code
758
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
    
759
752
    clients = Set()
760
753
    def remove_from_clients(client):
761
754
        clients.remove(client)
768
761
                              config
769
762
                              = dict(client_config.items(section)))
770
763
                       for section in client_config.sections()))
771
 
    if not clients:
772
 
        logger.critical(u"No clients defined")
773
 
        sys.exit(1)
774
764
    
775
765
    if not debug:
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
        daemon(False, False)
789
767
    
790
768
    def cleanup():
791
769
        "Cleanup function; run on exit"
838
816
                             tcp_server.handle_request\
839
817
                             (*args[2:], **kwargs) or True)
840
818
        
841
 
        logger.debug(u"Starting main loop")
 
819
        logger.debug("Starting main loop")
842
820
        main_loop_started = True
843
821
        main_loop.run()
844
822
    except AvahiError, error: