5 # This wrapper implements the SFA Registry and Slice Interfaces on PLC.
6 # Depending on command line options, it starts some combination of a
7 # Registry, an Aggregate Manager, and a Slice Manager.
9 # There are several items that need to be done before starting the wrapper
12 # NOTE: Many configuration settings, including the PLC maintenance account
13 # credentials, URI of the PLCAPI, and PLC DB URI and admin credentials are initialized
14 # from your MyPLC configuration (/etc/planetlab/plc_config*). Please make sure this information
15 # is up to date and accurate.
17 # 1) Import the existing planetlab database, creating the
18 # appropriate SFA records. This is done by running the "sfa-import-plc.py" tool.
20 # 2) Create a "trusted_roots" directory and place the certificate of the root
21 # authority in that directory. Given the defaults in sfa-import-plc.py, this
22 # certificate would be named "planetlab.gid". For example,
24 # mkdir trusted_roots; cp authorities/planetlab.gid trusted_roots/
26 # TODO: Can all three servers use the same "registry" certificate?
29 # TCP ports for the three servers
33 ### xxx todo not in the config yet
38 from optparse import OptionParser
40 from sfa.util.sfalogging import sfa_logger
41 from sfa.trust.trustedroot import TrustedRootList
42 from sfa.trust.certificate import Keypair, Certificate
43 from sfa.trust.hierarchy import Hierarchy
44 from sfa.trust.gid import GID
45 from sfa.util.config import Config
46 from sfa.plc.api import SfaAPI
47 from sfa.server.registry import Registries
48 from sfa.server.aggregate import Aggregates
50 # after http://www.erlenstar.demon.co.uk/unix/faq_2.html
52 """Daemonize the current process."""
53 if os.fork() != 0: os._exit(0)
55 if os.fork() != 0: os._exit(0)
57 devnull = os.open(os.devnull, os.O_RDWR)
59 # xxx fixme - this is just to make sure that nothing gets stupidly lost - should use devnull
60 crashlog = os.open('/var/log/httpd/sfa_access_log', os.O_RDWR | os.O_APPEND | os.O_CREAT, 0644)
64 def init_server_key(server_key_file, server_cert_file, config, hierarchy):
66 hrn = config.SFA_INTERFACE_HRN.lower()
67 # check if the server's private key exists. If it doesnt,
68 # get the right one from the authorities directory. If it cant be
69 # found in the authorities directory, generate a random one
70 if not os.path.exists(server_key_file):
71 hrn = config.SFA_INTERFACE_HRN.lower()
72 hrn_parts = hrn.split(".")
74 pkey_filename = hrn+".pkey"
76 # sub authority's have "." in their hrn. This must
77 # be converted to os.path separator
78 if len(hrn_parts) > 0:
79 rel_key_path = hrn.replace(".", os.sep)
80 pkey_filename= hrn_parts[-1]+".pkey"
82 key_file = os.sep.join([hierarchy.basedir, rel_key_path, pkey_filename])
83 if not os.path.exists(key_file):
84 # if it doesnt exist then this is probably a fresh interface
85 # with no records. Generate a random keypair for now
86 sfa_logger().debug("server's public key not found in %s" % key_file)
87 sfa_logger().debug("generating a random server key pair")
88 key = Keypair(create=True)
89 key.save_to_file(server_key_file)
90 init_server_cert(hrn, key, server_cert_file, self_signed=True)
93 # the pkey was found in the authorites directory. lets
94 # copy it to where the server key should be and generate
96 key = Keypair(filename=key_file)
97 key.save_to_file(server_key_file)
98 init_server_cert(hrn, key, server_cert_file)
100 # If private key exists and cert doesnt, recreate cert
101 if (os.path.exists(server_key_file)) and (not os.path.exists(server_cert_file)):
102 key = Keypair(filename=server_key_file)
103 init_server_cert(hrn, key, server_cert_file)
106 def init_server_cert(hrn, key, server_cert_file, self_signed=False):
108 Setup the certificate for this server. Attempt to use gid before
109 creating a self signed cert
112 init_self_signed_cert(hrn, key, server_cert_file)
116 sfa_logger().debug("generating server cert from gid: %s"% hrn)
117 hierarchy = Hierarchy()
118 auth_info = hierarchy.get_auth_info(hrn)
119 gid = GID(filename=auth_info.gid_filename)
120 gid.save_to_file(filename=server_cert_file)
122 # fall back to self signed cert
123 sfa_logger().debug("gid for %s not found" % hrn)
124 init_self_signed_cert(hrn, key, server_cert_file)
126 def init_self_signed_cert(hrn, key, server_cert_file):
127 sfa_logger().debug("generating self signed cert")
128 # generate self signed certificate
129 cert = Certificate(subject=hrn)
130 cert.set_issuer(key=key, subject=hrn)
133 cert.save_to_file(server_cert_file)
135 def init_server(options, config):
137 Execute the init method defined in the manager file
139 def init_manager(manager_module, manager_base):
140 try: manager = __import__(manager_module, fromlist=[manager_base])
141 except: manager = None
142 if manager and hasattr(manager, 'init_server'):
143 manager.init_server()
145 manager_base = 'sfa.managers'
147 mgr_type = config.SFA_REGISTRY_TYPE
148 manager_module = manager_base + ".registry_manager_%s" % mgr_type
149 init_manager(manager_module, manager_base)
151 mgr_type = config.SFA_AGGREGATE_TYPE
152 manager_module = manager_base + ".aggregate_manager_%s" % mgr_type
153 init_manager(manager_module, manager_base)
155 mgr_type = config.SFA_SM_TYPE
156 manager_module = manager_base + ".slice_manager_%s" % mgr_type
157 init_manager(manager_module, manager_base)
159 mgr_type = config.SFA_CM_TYPE
160 manager_module = manager_base + ".component_manager_%s" % mgr_type
161 init_manager(manager_module, manager_base)
163 def sync_interfaces(server_key_file, server_cert_file):
165 Attempt to install missing trusted gids and db records for
166 our federated interfaces
168 api = SfaAPI(key_file = server_key_file, cert_file = server_cert_file)
169 registries = Registries(api)
170 aggregates = Aggregates(api)
171 registries.sync_interfaces()
172 aggregates.sync_interfaces()
175 # Generate command line parser
176 parser = OptionParser(usage="sfa-server [options]")
177 parser.add_option("-r", "--registry", dest="registry", action="store_true",
178 help="run registry server", default=False)
179 parser.add_option("-s", "--slicemgr", dest="sm", action="store_true",
180 help="run slice manager", default=False)
181 parser.add_option("-a", "--aggregate", dest="am", action="store_true",
182 help="run aggregate manager", default=False)
183 parser.add_option("-c", "--component", dest="cm", action="store_true",
184 help="run component server", default=False)
185 parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0,
186 help="verbose mode - cumulative")
187 parser.add_option("-d", "--daemon", dest="daemon", action="store_true",
188 help="Run as daemon.", default=False)
189 (options, args) = parser.parse_args()
190 sfa_logger().setLevelFromOptVerbose(options.verbose)
193 if config.SFA_API_DEBUG: sfa_logger().setLevelDebug()
194 hierarchy = Hierarchy()
195 server_key_file = os.path.join(hierarchy.basedir, "server.key")
196 server_cert_file = os.path.join(hierarchy.basedir, "server.cert")
198 init_server_key(server_key_file, server_cert_file, config, hierarchy)
199 init_server(options, config)
200 sync_interfaces(server_key_file, server_cert_file)
202 if (options.daemon): daemon()
203 # start registry server
204 if (options.registry):
205 from sfa.server.registry import Registry
206 r = Registry("", config.SFA_REGISTRY_PORT, server_key_file, server_cert_file)
210 from sfa.server.aggregate import Aggregate
211 a = Aggregate("", config.SFA_AGGREGATE_PORT, server_key_file, server_cert_file)
214 # start slice manager
216 from sfa.server.slicemgr import SliceMgr
217 s = SliceMgr("", config.SFA_SM_PORT, server_key_file, server_cert_file)
221 from sfa.server.component import Component
222 c = Component("", config.component_port, server_key_file, server_cert_file)
223 # c = Component("", config.SFA_COMPONENT_PORT, server_key_file, server_cert_file)
226 if __name__ == "__main__":
230 sfa_logger().log_exc_critical("SFA server is exiting")