/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-04 20:43:31 UTC
  • mfrom: (24.1.17 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080804204331-zgu42g8ii997h1l2
* ca.pem: Removed.
* cert.pem: - '' -
* client-cert.pem: - '' -
* client-key.pem: - '' -
* crl.pem: - '' -
* key.pem: - '' -

* plugins.d/mandosclient.c (start_mandos_communication): Change "to"
                                    to be a union.  All users changed.

* server.py: Changed log severity for many log messages.
  (Client.__init__): Take all config file settins as a dict instead of
                     as keyword arguments.

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
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
28
 
# <http://www.gnu.org/licenses/>.
 
27
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
29
28
# 
30
29
# Contact the authors at <mandos@fukt.bsnet.se>.
31
30
# 
62
61
from dbus.mainloop.glib import DBusGMainLoop
63
62
import ctypes
64
63
 
65
 
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
 
66
75
 
67
76
logger = logging.Logger('mandos')
68
77
syslogger = logging.handlers.SysLogHandler\
69
 
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
70
 
             address = "/dev/log")
 
78
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
71
79
syslogger.setFormatter(logging.Formatter\
72
 
                        ('Mandos: %(levelname)s: %(message)s'))
 
80
                        ('%(levelname)s: %(message)s'))
73
81
logger.addHandler(syslogger)
 
82
del syslogger
74
83
 
75
 
console = logging.StreamHandler()
76
 
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
77
 
                                       ' %(message)s'))
78
 
logger.addHandler(console)
79
84
 
80
85
class AvahiError(Exception):
81
86
    def __init__(self, value):
91
96
 
92
97
 
93
98
class AvahiService(object):
94
 
    """An Avahi (Zeroconf) service.
95
 
    Attributes:
 
99
    """
96
100
    interface: integer; avahi.IF_UNSPEC or an interface index.
97
101
               Used to optionally bind to the specified interface.
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
 
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
108
113
    """
109
114
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
110
115
                 type = None, port = None, TXT = None, domain = "",
111
 
                 host = "", max_renames = 32768):
 
116
                 host = "", max_renames = 12):
 
117
        """An Avahi (Zeroconf) service. """
112
118
        self.interface = interface
113
119
        self.name = name
114
120
        self.type = type
120
126
        self.domain = domain
121
127
        self.host = host
122
128
        self.rename_count = 0
123
 
        self.max_renames = max_renames
124
129
    def rename(self):
125
130
        """Derived from the Avahi example code"""
126
131
        if self.rename_count >= self.max_renames:
127
 
            logger.critical(u"No suitable Zeroconf service name found"
128
 
                            u" after %i retries, exiting.",
129
 
                            rename_count)
 
132
            logger.critical(u"No suitable service name found after %i"
 
133
                            u" retries, exiting.", rename_count)
130
134
            raise AvahiServiceError("Too many renames")
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))
 
135
        name = server.GetAlternativeServiceName(name)
 
136
        logger.error(u"Changing name to %r ...", 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 Zeroconf service '%s' of type '%s' ...",
 
154
        logger.debug(u"Adding 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
 
    host:      string; available for use by the checker command
 
178
    fqdn:      string (FQDN); 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' key in 'config' sets the
226
 
        'checker_command' attribute and *not* the 'checker'
227
 
        attribute."""
 
225
        """Note: the 'checker' argument sets the 'checker_command'
 
226
        attribute and not the 'checker' attribute.."""
228
227
        self.name = name
229
228
        logger.debug(u"Creating client %r", self.name)
230
 
        # Uppercase and remove spaces from fingerprint for later
231
 
        # comparison purposes with return value from the fingerprint()
232
 
        # function
 
229
        # Uppercase and remove spaces from fingerprint
 
230
        # for later comparison purposes with return value of
 
231
        # the fingerprint() function
233
232
        self.fingerprint = config["fingerprint"].upper()\
234
233
                           .replace(u" ", u"")
235
234
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
242
241
        else:
243
242
            raise TypeError(u"No secret or secfile for client %s"
244
243
                            % self.name)
245
 
        self.host = config.get("host", "")
 
244
        self.fqdn = config.get("fqdn", "")
246
245
        self.created = datetime.datetime.now()
247
246
        self.last_checked_ok = None
248
247
        self.timeout = string_to_delta(config["timeout"])
271
270
        The possibility that a client might be restarted is left open,
272
271
        but not currently used."""
273
272
        # If this client doesn't have a secret, it is already stopped.
274
 
        if hasattr(self, "secret") and self.secret:
 
273
        if self.secret:
275
274
            logger.info(u"Stopping client %s", self.name)
276
275
            self.secret = None
277
276
        else:
325
324
        if self.checker is None:
326
325
            try:
327
326
                # In case check_command has exactly one % operator
328
 
                command = self.check_command % self.host
 
327
                command = self.check_command % self.fqdn
329
328
            except TypeError:
330
329
                # Escape attributes for the shell
331
330
                escaped_attrs = dict((key, re.escape(str(val)))
340
339
            try:
341
340
                logger.info(u"Starting checker %r for %s",
342
341
                            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.)
347
342
                self.checker = subprocess.Popen(command,
348
343
                                                close_fds=True,
349
344
                                                shell=True, cwd="/")
350
345
                self.checker_callback_tag = gobject.child_watch_add\
351
346
                                            (self.checker.pid,
352
347
                                             self.checker_callback)
353
 
            except OSError, error:
 
348
            except subprocess.OSError, error:
354
349
                logger.error(u"Failed to start subprocess: %s",
355
350
                             error)
356
351
        # Re-run this periodically if run by gobject.timeout_add
362
357
            self.checker_callback_tag = None
363
358
        if getattr(self, "checker", None) is None:
364
359
            return
365
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
360
        logger.debug("Stopping checker for %(name)s", vars(self))
366
361
        try:
367
362
            os.kill(self.checker.pid, signal.SIGTERM)
368
363
            #os.sleep(0.5)
400
395
 
401
396
def fingerprint(openpgp):
402
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))
403
402
    # New GnuTLS "datum" with the OpenPGP public key
404
403
    datum = gnutls.library.types.gnutls_datum_t\
405
404
        (ctypes.cast(ctypes.c_char_p(openpgp),
406
405
                     ctypes.POINTER(ctypes.c_ubyte)),
407
406
         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))
412
407
    # Import the OpenPGP public key into the certificate
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")
 
408
    ret = gnutls.library.functions.gnutls_openpgp_crt_import\
 
409
        (crt,
 
410
         ctypes.byref(datum),
 
411
         gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
423
412
    # New buffer for the fingerprint
424
413
    buffer = ctypes.create_string_buffer(20)
425
414
    buffer_length = ctypes.c_size_t()
551
540
                in6addr_any = "::"
552
541
                self.server_address = (in6addr_any,
553
542
                                       self.server_address[1])
554
 
            elif not self.server_address[1]:
 
543
            elif self.server_address[1] is None:
555
544
                self.server_address = (self.server_address[0],
556
545
                                       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"]))
564
546
            return super(type(self), self).server_bind()
565
547
 
566
548
 
577
559
    datetime.timedelta(1)
578
560
    >>> string_to_delta(u'1w')
579
561
    datetime.timedelta(7)
580
 
    >>> string_to_delta('5m 30s')
581
 
    datetime.timedelta(0, 330)
582
562
    """
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):
 
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:
601
577
            raise ValueError
602
 
        timevalue += delta
603
 
    return timevalue
 
578
    except (ValueError, IndexError):
 
579
        raise ValueError
 
580
    return delta
604
581
 
605
582
 
606
583
def server_state_changed(state):
607
584
    """Derived from the Avahi example code"""
608
585
    if state == avahi.SERVER_COLLISION:
609
 
        logger.error(u"Zeroconf server name collision")
 
586
        logger.error(u"Server name collision")
610
587
        service.remove()
611
588
    elif state == avahi.SERVER_RUNNING:
612
589
        service.add()
614
591
 
615
592
def entry_group_state_changed(state, error):
616
593
    """Derived from the Avahi example code"""
617
 
    logger.debug(u"Avahi state change: %i", state)
 
594
    logger.debug(u"state change: %i", state)
618
595
    
619
596
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
620
 
        logger.debug(u"Zeroconf service established.")
 
597
        logger.debug(u"Service established.")
621
598
    elif state == avahi.ENTRY_GROUP_COLLISION:
622
 
        logger.warning(u"Zeroconf service name collision.")
 
599
        logger.warning(u"Service name collision.")
623
600
        service.rename()
624
601
    elif state == avahi.ENTRY_GROUP_FAILURE:
625
 
        logger.critical(u"Avahi: Error in group state changed %s",
 
602
        logger.critical(u"Error in group state changed %s",
626
603
                        unicode(error))
627
604
        raise AvahiGroupError("State changed: %s", str(error))
628
605
 
651
628
    return if_nametoindex(interface)
652
629
 
653
630
 
654
 
def daemon(nochdir = False, noclose = False):
 
631
def daemon(nochdir, noclose):
655
632
    """See daemon(3).  Standard BSD Unix function.
656
633
    This should really exist as os.daemon, but it doesn't (yet)."""
657
634
    if os.fork():
659
636
    os.setsid()
660
637
    if not nochdir:
661
638
        os.chdir("/")
662
 
    if os.fork():
663
 
        sys.exit()
664
639
    if not noclose:
665
640
        # Close all standard open file descriptors
666
641
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
678
653
    global main_loop_started
679
654
    main_loop_started = False
680
655
    
681
 
    parser = OptionParser(version = "%%prog %s" % version)
 
656
    parser = OptionParser()
682
657
    parser.add_option("-i", "--interface", type="string",
683
658
                      metavar="IF", help="Bind to interface IF")
684
659
    parser.add_option("-a", "--address", type="string",
687
662
                      help="Port number to receive requests on")
688
663
    parser.add_option("--check", action="store_true", default=False,
689
664
                      help="Run self-test")
690
 
    parser.add_option("--debug", action="store_true",
 
665
    parser.add_option("--debug", action="store_true", default=False,
691
666
                      help="Debug mode; run in foreground and log to"
692
667
                      " terminal")
693
668
    parser.add_option("--priority", type="string", help="GnuTLS"
718
693
    # Parse config file for server-global settings
719
694
    server_config = ConfigParser.SafeConfigParser(server_defaults)
720
695
    del server_defaults
721
 
    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"
722
698
    # Convert the SafeConfigParser object to a dict
723
 
    server_settings = server_config.defaults()
 
699
    server_settings = dict(server_config.items(server_section))
724
700
    # Use getboolean on the boolean config option
725
701
    server_settings["debug"] = server_config.getboolean\
726
 
                               ("DEFAULT", "debug")
 
702
                               (server_section, "debug")
727
703
    del server_config
728
704
    
729
705
    # Override the settings from the config file with command line
736
712
    del options
737
713
    # Now we have our good server settings in "server_settings"
738
714
    
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
 
    
751
715
    # Parse config file with clients
752
716
    client_defaults = { "timeout": "1h",
753
717
                        "interval": "5m",
754
 
                        "checker": "fping -q -- %(host)s",
755
 
                        "host": "",
 
718
                        "checker": "fping -q -- %%(fqdn)s",
756
719
                        }
757
720
    client_config = ConfigParser.SafeConfigParser(client_defaults)
758
721
    client_config.read(os.path.join(server_settings["configdir"],
762
725
    service = AvahiService(name = server_settings["servicename"],
763
726
                           type = "_mandos._tcp", );
764
727
    if server_settings["interface"]:
765
 
        service.interface = if_nametoindex\
766
 
                            (server_settings["interface"])
 
728
        service.interface = if_nametoindex(server_settings["interface"])
767
729
    
768
730
    global main_loop
769
731
    global bus
772
734
    DBusGMainLoop(set_as_default=True )
773
735
    main_loop = gobject.MainLoop()
774
736
    bus = dbus.SystemBus()
775
 
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
776
 
                                           avahi.DBUS_PATH_SERVER),
777
 
                            avahi.DBUS_INTERFACE_SERVER)
 
737
    server = dbus.Interface(
 
738
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
739
            avahi.DBUS_INTERFACE_SERVER )
778
740
    # End of Avahi example code
779
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
    
780
752
    clients = Set()
781
753
    def remove_from_clients(client):
782
754
        clients.remove(client)
789
761
                              config
790
762
                              = dict(client_config.items(section)))
791
763
                       for section in client_config.sections()))
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())
 
764
    
 
765
    if not debug:
 
766
        daemon(False, False)
818
767
    
819
768
    def cleanup():
820
769
        "Cleanup function; run on exit"
867
816
                             tcp_server.handle_request\
868
817
                             (*args[2:], **kwargs) or True)
869
818
        
870
 
        logger.debug(u"Starting main loop")
 
819
        logger.debug("Starting main loop")
871
820
        main_loop_started = True
872
821
        main_loop.run()
873
822
    except AvahiError, error: