sfa/server/sfa-server.py

   1 #!/usr/bin/python
   2 #
   3 ### $Id$
   4 ### $URL$
   5 #
   6 # SFA PLC Wrapper
   7 #
   8 # This wrapper implements the SFA Registry and Slice Interfaces on PLC.
   9 # Depending on command line options, it starts some combination of a
  10 # Registry, an Aggregate Manager, and a Slice Manager.
  11 #
  12 # There are several items that need to be done before starting the wrapper
  13 # server.
  14 #
  15 # NOTE:  Many configuration settings, including the PLC maintenance account
  16 # credentials, URI of the PLCAPI, and PLC DB URI and admin credentials are initialized
  17 # from your MyPLC configuration (/etc/planetlab/plc_config*).  Please make sure this information
  18 # is up to date and accurate.
  19 #
  20 # 1) Import the existing planetlab database, creating the
  21 #    appropriate SFA records. This is done by running the "sfa-import-plc.py" tool.
  22 #
  23 # 2) Create a "trusted_roots" directory and place the certificate of the root
  24 #    authority in that directory. Given the defaults in sfa-import-plc.py, this
  25 #    certificate would be named "planetlab.gid". For example,
  26 #
  27 #    mkdir trusted_roots; cp authorities/planetlab.gid trusted_roots/
  28 #
  29 # TODO: Can all three servers use the same "registry" certificate?
  30 ##
  31
  32 # TCP ports for the three servers
  33 registry_port=12345
  34 aggregate_port=12346
  35 slicemgr_port=12347
  36 component_port=12346
  37 import os, os.path
  38 import sys
  39 from optparse import OptionParser
  40 from sfa.trust.trustedroot import TrustedRootList
  41 from sfa.trust.certificate import Keypair, Certificate
  42 from sfa.trust.hierarchy import Hierarchy
  43 from sfa.util.config import Config
  44 from sfa.util.report import trace
  45 from sfa.plc.api import SfaAPI
  46 from sfa.server.registry import Registries
  47 from sfa.server.aggregate import Aggregates
  48
  49 # after http://www.erlenstar.demon.co.uk/unix/faq_2.html
  50 def daemon():
  51     """Daemonize the current process."""
  52     if os.fork() != 0: os._exit(0)
  53     os.setsid()
  54     if os.fork() != 0: os._exit(0)
  55     os.umask(0)
  56     devnull = os.open(os.devnull, os.O_RDWR)
  57     os.dup2(devnull, 0)
  58     # xxx fixme - this is just to make sure that nothing gets stupidly lost - should use devnull
  59     crashlog = os.open('/var/log/sfa.daemon', os.O_RDWR | os.O_APPEND | os.O_CREAT, 0644)
  60     os.dup2(crashlog, 1)
  61     os.dup2(crashlog, 2)
  62
  63 def init_server_key(server_key_file, server_cert_file, config, hierarchy):
  64
  65     subject = config.SFA_INTERFACE_HRN
  66     # check if the server's private key exists. If it doesnt,
  67     # get the right one from the authorities directory. If it cant be
  68     # found in the authorities directory, generate a random one
  69     if not os.path.exists(server_key_file):
  70         hrn = config.SFA_INTERFACE_HRN.lower()
  71         hrn_parts = hrn.split(".")
  72         rel_key_path = hrn
  73         pkey_filename = hrn+".pkey"
  74
  75         # sub authority's have "." in their hrn. This must
  76         # be converted to os.path separator
  77         if len(hrn_parts) > 0:
  78             rel_key_path = hrn.replace(".", os.sep)
  79             pkey_filename= hrn_parts[-1]+".pkey"
  80
  81         key_file = os.sep.join([hierarchy.basedir, rel_key_path, pkey_filename])
  82         if not os.path.exists(key_file):
  83             # if it doesnt exist then this is probably a fresh interface
  84             # with no records. Generate a random keypair for now
  85             trace("server's public key not found in %s" % key_file)
  86             trace("generating a random server key pair")
  87             key = Keypair(create=True)
  88             key.save_to_file(server_key_file)
  89             cert = Certificate(subject=subject)
  90             cert.set_issuer(key=key, subject=subject)
  91             cert.set_pubkey(key)
  92             cert.sign()
  93             cert.save_to_file(server_cert_file, save_parents=True)
  94
  95         else:
  96             # the pkey was found in the authorites directory. lets
  97             # copy it to where the server key should be and generate
  98             # the cert
  99             key = Keypair(filename=key_file)
 100             key.save_to_file(server_key_file)
 101             cert = Certificate(subject=subject)
 102             cert.set_issuer(key=key, subject=subject)
 103             cert.set_pubkey(key)
 104             cert.sign()
 105             cert.save_to_file(server_cert_file, save_parents=True)
 106
 107
 108     # If private key exists and cert doesnt, recreate cert
 109     if (os.path.exists(server_key_file)) and (not os.path.exists(server_cert_file)):
 110         key = Keypair(filename=server_key_file)
 111         cert = Certificate(subject=subject)
 112         cert.set_issuer(key=key, subject=subject)
 113         cert.set_pubkey(key)
 114         cert.sign()
 115         cert.save_to_file(server_cert_file)
 116
 117 def init_server(options, config):
 118     """
 119     Execute the init method defined in the manager file
 120     """
 121     manager_base = 'sfa.managers'
 122     if options.registry:
 123         mgr_type = config.SFA_REGISTRY_TYPE
 124         manager_module = manager_base + ".registry_manager_%s" % mgr_type
 125         try: manager = __import__(manager_module, fromlist=[manager_base])
 126         except: manager = None
 127         if manager and hasattr(manager, 'init_server'):
 128             manager.init_server()
 129     if options.am:
 130         mgr_type = config.SFA_AGGREGATE_TYPE
 131         manager_module = manager_base + ".aggregate_manager_%s" % mgr_type
 132         try: manager = __import__(manager_module, fromlist=[manager_base])
 133         except: manager = None
 134         if manager and hasattr(manager, 'init_server'):
 135             manager.init_server()
 136     if options.sm:
 137         mgr_type = config.SFA_SM_TYPE
 138         manager_module = manager_base + ".slice_manager_%s" % mgr_type
 139         try: manager = __import__(manager_module, fromlist=[manager_base])
 140         except: manager = None
 141         if manager and hasattr(manager, 'init_server'):
 142             manager.init_server()
 143     if options.cm:
 144         mgr_type = config.SFA_CM_TYPE
 145         manager_module = manager_base + ".component_manager_%s" % mgr_type
 146         try: manager = __import__(manager_module, fromlist=[manager_base])
 147         except: manager = None
 148         if manager and hasattr(manager, 'init_server'):
 149             manager.init_server()
 150
 151 def sync_interfaces(server_key_file, server_cert_file):
 152     """
 153     Attempt to install missing trusted gids and db records for
 154     our federated interfaces
 155     """
 156     api = SfaAPI(key_file = server_key_file, cert_file = server_cert_file)
 157     registries = Registries(api)
 158     aggregates = Aggregates(api)
 159     registries.sync_interfaces()
 160     aggregates.sync_interfaces()
 161
 162 def main():
 163     # xxx get rid of globals - name consistently CamelCase or under_score
 164     global AuthHierarchy
 165     global TrustedRoots
 166     global registry_port
 167     global aggregate_port
 168     global slicemgr_port
 169
 170     # Generate command line parser
 171     parser = OptionParser(usage="sfa-server [options]")
 172     parser.add_option("-r", "--registry", dest="registry", action="store_true",
 173          help="run registry server", default=False)
 174     parser.add_option("-s", "--slicemgr", dest="sm", action="store_true",
 175          help="run slice manager", default=False)
 176     parser.add_option("-a", "--aggregate", dest="am", action="store_true",
 177          help="run aggregate manager", default=False)
 178     parser.add_option("-c", "--component", dest="cm", action="store_true",
 179          help="run component server", default=False)
 180     parser.add_option("-v", "--verbose", dest="verbose", action="store_true",
 181          help="verbose mode", default=False)
 182     parser.add_option("-d", "--daemon", dest="daemon", action="store_true",
 183          help="Run as daemon.", default=False)
 184     (options, args) = parser.parse_args()
 185
 186
 187     config = Config()
 188     hierarchy = Hierarchy()
 189     server_key_file = os.path.join(hierarchy.basedir, "server.key")
 190     server_cert_file = os.path.join(hierarchy.basedir, "server.cert")
 191
 192     init_server_key(server_key_file, server_cert_file, config, hierarchy)
 193     init_server(options, config)
 194     sync_interfaces(server_key_file, server_cert_file)
 195
 196     if (options.daemon):  daemon()
 197     # start registry server
 198     if (options.registry):
 199         from sfa.server.registry import Registry
 200         r = Registry("", registry_port, server_key_file, server_cert_file)
 201         r.start()
 202
 203     # start aggregate manager
 204     if (options.am):
 205         from sfa.server.aggregate import Aggregate
 206         a = Aggregate("", aggregate_port, server_key_file, server_cert_file)
 207         a.start()
 208
 209     # start slice manager
 210     if (options.sm):
 211         from sfa.server.slicemgr import SliceMgr
 212         s = SliceMgr("", slicemgr_port, server_key_file, server_cert_file)
 213         s.start()
 214
 215     if (options.cm):
 216         from sfa.server.component import Component
 217         c = Component("", component_port, server_key_file, server_cert_file)
 218         c.start()
 219
 220 if __name__ == "__main__":
 221     main()