+##
+# Geni Registry Wrapper
+#
+# This wrapper implements the Geni Registry.
+#
+# There are several items that need to be done before starting the registry.
+#
+# 1) Import the existing planetlab database, creating the
+# appropriate geni records. This is done by running the "import.py" tool.
+#
+# 2) Create a "trusted_roots" directory and place the certificate of the root
+# authority in that directory. Given the defaults in import.py, this certificate
+# would be named "planetlab.gid". For example,
+#
+# mkdir trusted_roots; cp authorities/planetlab.gid trusted_roots/
+##
+
import tempfile
import os
+import time
+import sys
from cert import *
from gid import *
from geniserver import *
from excep import *
+from trustedroot import *
from hierarchy import *
from misc import *
-
-def get_pl_object_by_hrn(hrn):
- # find the object in the planetlab database
- pointer = None
- if (type=="sa") or (type=="ma"):
- authname = hrn_to_pl_authname(name):
- pl_res = shell.GetSites(pl_auth, {'name': authname)
- if pl_res:
- site_info = pl_res[0]
- pointer = auth_info['auth_id']
- return (site_info, pointer)
- elif (type=="slice"):
- slicename = hrn_to_pl_slicename(name)
- pl_res = shell.GetSlices(pl_auth, {'name': slicename)
- if pl_res:
- slice_info = pl_res[0]
- pointer = slice_info['slice_id']
- return (slice_info, pointer)
- elif (type=="user"):
- username = hrn_to_pl_username(name)
- pl_res = shell.GetPersons(pl_auth, {'name': slicename)
- if pl_res:
- person_info = pl_res[0]
- pointer = slice_info['person_id']
- return (person_info, pointer)
- elif (type=="component"):
- node_name = hrn_to_pl_nodename(hrn)
- pl_res = shell.GetNodes(pl_auth, {'name': nodename)
- if pl_res:
- node_info = pl_res[0]
- pointer = node_info['node_id']
- return (node_info, pointer)
- else:
- raise UnknownGeniType(type)
-
- return (None, None)
+from record import *
+from genitable import *
+from geniticket import *
+
+##
+# Convert geni fields to PLC fields for use when registering up updating
+# registry record in the PLC database
+#
+# @params type type of record (user, slice, ...)
+# @params hrn human readable name
+# @params geni_fields dictionary of geni fields
+# @params pl_fields dictionary of PLC fields (output)
+
+def geni_fields_to_pl_fields(type, hrn, geni_fields, pl_fields):
+ if type == "user":
+ if not "email" in pl_fields:
+ if not "email" in geni_fields:
+ raise MissingGeniInfo("email")
+ pl_fields["email"] = geni_fields["email"]
+
+ if not "first_name" in pl_fields:
+ pl_fields["first_name"] = "geni"
+
+ if not "last_name" in pl_fields:
+ pl_fields["last_name"] = hrn
+
+ elif type == "slice":
+ if not "instantiation" in pl_fields:
+ pl_fields["instantiation"] = "plc-instantiated"
+ if not "name" in pl_fields:
+ pl_fields["name"] = hrn_to_pl_slicename(hrn)
+ if not "max_nodes" in pl_fields:
+ pl_fields["max_nodes"] = 10
+
+ elif type == "node":
+ if not "hostname" in pl_fields:
+ if not "dns" in geni_fields:
+ raise MissingGeniInfo("dns")
+ pl_fields["hostname"] = geni_fields["dns"]
+
+ if not "model" in pl_fields:
+ pl_fields["model"] = "geni"
+
+ elif type == "sa":
+ pl_fields["login_base"] = hrn_to_pl_login_base(hrn)
+
+ if not "name" in pl_fields:
+ pl_fields["name"] = hrn
+
+ if not "abbreviated_name" in pl_fields:
+ pl_fields["abbreviated_name"] = hrn
+
+ if not "enabled" in pl_fields:
+ pl_fields["enabled"] = True
+
+ if not "is_public" in pl_fields:
+ pl_fields["is_public"] = True
+
+##
+# Registry is a GeniServer that serves registry requests. It also serves
+# component and slice operations that are implemented on the registry
+# due to SFA engineering decisions
+#
class Registry(GeniServer):
+ ##
+ # Create a new registry object.
+ #
+ # @param ip the ip address to listen on
+ # @param port the port to listen on
+ # @param key_file private key filename of registry
+ # @param cert_file certificate filename containing public key (could be a GID file)
+
def __init__(self, ip, port, key_file, cert_file):
GeniServer.__init__(self, ip, port, key_file, cert_file)
+ # get PL account settings from config module
+ self.pl_auth = get_pl_auth()
+
+ # connect to planetlab
+ if "Url" in self.pl_auth:
+ self.connect_remote_shell()
+ else:
+ self.connect_local_shell()
+
+ ##
+ # Connect to a remote shell via XMLRPC
+
+ def connect_remote_shell(self):
+ import remoteshell
+ self.shell = remoteshell.RemoteShell()
+
+ ##
+ # Connect to a local shell via local API functions
+
+ def connect_local_shell(self):
+ import PLC.Shell
+ self.shell = PLC.Shell.Shell(globals = globals())
+
+ ##
+ # Register the server RPCs for the registry
+
def register_functions(self):
GeniServer.register_functions(self)
+ # registry interface
+ self.server.register_function(self.create_gid)
self.server.register_function(self.get_self_credential)
self.server.register_function(self.get_credential)
self.server.register_function(self.get_gid)
-
- def get_auth_info(name):
- return Hierarchy.get_auth_info(name)
+ self.server.register_function(self.register)
+ self.server.register_function(self.remove)
+ self.server.register_function(self.update)
+ self.server.register_function(self.list)
+ self.server.register_function(self.resolve)
+ # component interface
+ self.server.register_function(self.get_ticket)
+
+ ##
+ # Given an authority name, return the information for that authority. This
+ # is basically a stub that calls the hierarchy module.
+ #
+ # @param auth_hrn human readable name of authority
+
+ def get_auth_info(self, auth_hrn):
+ return AuthHierarchy.get_auth_info(auth_hrn)
+
+ ##
+ # Given an authority name, return the database table for that authority. If
+ # the database table does not exist, then one will be automatically
+ # created.
+ #
+ # @param auth_name human readable name of authority
def get_auth_table(self, auth_name):
- auth_info = get_auth_info(name, can_create=False)
+ auth_info = self.get_auth_info(auth_name)
- table = GeniTable(hrn = auth_name,
- auth_info.get_cninfo()
- auth_info.get_privkey_object()
- auth_info.get_gid_object())
+ table = GeniTable(hrn=auth_name,
+ cninfo=auth_info.get_dbinfo())
# if the table doesn't exist, then it means we haven't put any records
# into this authority yet.
if not table.exists():
+ report.trace("Registry: creating table for authority " + auth_name)
table.create()
return table
+ ##
+ # Verify that an authority belongs to this registry. This is basically left
+ # up to the implementation of the hierarchy module. If the specified name
+ # does not belong to this registry, an exception is thrown indicating the
+ # caller should contact someone else.
+ #
+ # @param auth_name human readable name of authority
+
def verify_auth_belongs_to_me(self, name):
# get_auth_info will throw an exception if the authority does not
# exist
self.get_auth_info(name)
+ ##
+ # Verify that an object belongs to this registry. By extension, this implies
+ # that the authority that owns the object belongs to this registry. If the
+ # object does not belong to this registry, then an exception is thrown.
+ #
+ # @param name human readable name of object
+
def verify_object_belongs_to_me(self, name):
auth_name = get_authority(name)
+ if not auth_name:
+ # the root authority belongs to the registry by default?
+ # TODO: is this true?
+ return
self.verify_auth_belongs_to_me(auth_name)
- def register(self, cred, name, record_dict):
- self.decode_authentication(cred)
+ ##
+ # Verify that the object_gid that was specified in the credential allows
+ # permission to the object 'name'. This is done by a simple prefix test.
+ # For example, an object_gid for planetlab.us.arizona would match the
+ # objects planetlab.us.arizona.slice1 and planetlab.us.arizona.
+ #
+ # @param name human readable name to test
+
+ def verify_object_permission(self, name):
+ object_hrn = self.object_gid.get_hrn()
+ if object_hrn == name:
+ return
+ if name.startswith(object_hrn + "."):
+ return
+ raise PermissionError(name)
+
+ ##
+ # Fill in the planetlab-specific fields of a Geni record. This involves
+ # calling the appropriate PLC methods to retrieve the database record for
+ # the object.
+ #
+ # PLC data is filled into the pl_info field of the record.
+ #
+ # @param record record to fill in fields (in/out param)
+
+ def fill_record_pl_info(self, record):
+ type = record.get_type()
+ pointer = record.get_pointer()
- auth_name = get_authority(name)
- auth_info = self.get_auth_info(auth_name)
- table = self.get_auth_table(auth_name)
+ # records with pointer==-1 do not have plc info associated with them.
+ # for example, the top level authority records which are
+ # authorities, but not PL "sites"
+ if pointer == -1:
+ return
+
+ if (type == "sa") or (type == "ma"):
+ pl_res = self.shell.GetSites(self.pl_auth, [pointer])
+ elif (type == "slice"):
+ pl_res = self.shell.GetSlices(self.pl_auth, [pointer])
+ elif (type == "user"):
+ pl_res = self.shell.GetPersons(self.pl_auth, [pointer])
+ elif (type == "node"):
+ pl_res = self.shell.GetNodes(self.pl_auth, [pointer])
+ else:
+ raise UnknownGeniType(type)
+
+ if not pl_res:
+ # the planetlab record no longer exists
+ # TODO: delete the geni record ?
+ raise PlanetLabRecordDoesNotExist(record.get_name())
+
+ record.set_pl_info(pl_res[0])
+
+ ##
+ # Look up user records given PLC user-ids. This is used as part of the
+ # process for reverse-mapping PLC records into Geni records.
+ #
+ # @param auth_table database table for the authority that holds the user records
+ # @param user_id_list list of user ids
+ # @param role either "*" or a string describing the role to look for ("pi", "user", ...)
+ #
+ # TODO: This function currently only searches one authority because it would
+ # be inefficient to brute-force search all authorities for a user id. The
+ # solution would likely be to implement a reverse mapping of user-id to
+ # (type, hrn) pairs.
+
+ def lookup_users(self, auth_table, user_id_list, role="*"):
+ record_list = []
+ for person_id in user_id_list:
+ user_records = auth_table.find("user", person_id, "pointer")
+ for user_record in user_records:
+ self.fill_record_info(user_record)
+
+ user_roles = user_record.get_pl_info().get("roles")
+ if (role=="*") or (role in user_roles):
+ record_list.append(user_record.get_name())
+ return record_list
+
+ ##
+ # Fill in the geni-specific fields of the record.
+ #
+ # Note: It is assumed the fill_record_pl_info() has already been performed
+ # on the record.
+
+ def fill_record_geni_info(self, record):
+ geni_info = {}
+ type = record.get_type()
+
+ if (type == "slice"):
+ auth_table = self.get_auth_table(get_authority(record.get_name()))
+ person_ids = record.pl_info.get("person_ids", [])
+ researchers = self.lookup_users(auth_table, person_ids)
+ geni_info['researcher'] = researchers
+
+ elif (type == "sa"):
+ auth_table = self.get_auth_table(record.get_name())
+ person_ids = record.pl_info.get("person_ids", [])
+ pis = self.lookup_users(auth_table, person_ids, "pi")
+ geni_info['pi'] = pis
+ # TODO: OrganizationName
+
+ elif (type == "ma"):
+ auth_table = self.get_auth_table(record.get_name())
+ person_ids = record.pl_info.get("person_ids", [])
+ operators = self.lookup_users(auth_table, person_ids, "tech")
+ geni_info['operator'] = operators
+ # TODO: OrganizationName
+
+ auth_table = self.get_auth_table(record.get_name())
+ person_ids = record.pl_info.get("person_ids", [])
+ owners = self.lookup_users(auth_table, person_ids, "admin")
+ geni_info['owner'] = owners
+
+ elif (type == "node"):
+ geni_info['dns'] = record.pl_info.get("hostname", "")
+ # TODO: URI, LatLong, IP, DNS
+
+ elif (type == "user"):
+ geni_info['email'] = record.pl_info.get("email", "")
+ # TODO: PostalAddress, Phone
+
+ record.set_geni_info(geni_info)
+
+ ##
+ # Given a Geni record, fill in the PLC-specific and Geni-specific fields
+ # in the record.
+
+ def fill_record_info(self, record):
+ self.fill_record_pl_info(record)
+ self.fill_record_geni_info(record)
+
+ ##
+ # GENI API: register
+ #
+ # Register an object with the registry. In addition to being stored in the
+ # Geni database, the appropriate records will also be created in the
+ # PLC databases
+ #
+ # @param cred credential string
+ # @param record_dict dictionary containing record fields
+
+ def register(self, cred, record_dict):
+ self.decode_authentication(cred, "register")
record = GeniRecord(dict = record_dict)
type = record.get_type()
+ name = record.get_name()
+
+ auth_name = get_authority(name)
+ self.verify_object_permission(auth_name)
+ auth_info = self.get_auth_info(auth_name)
+ table = self.get_auth_table(auth_name)
pkey = None
# check if record already exists
- existing_records = table.resolve(name, type)
+ existing_records = table.resolve(type, name)
if existing_records:
raise ExistingRecord(name)
if (type == "sa") or (type=="ma"):
# update the tree
- if not Hierarchy.auth_exists(name):
- Hierarchy.create_auth(name)
+ if not AuthHierarchy.auth_exists(name):
+ AuthHierarchy.create_auth(name)
- # get the public key from the newly created authority
+ # authorities are special since they are managed by the registry
+ # rather than by the caller. We create our own GID for the
+ # authority rather than relying on the caller to supply one.
+
+ # get the GID from the newly created authority
child_auth_info = self.get_auth_info(name)
- pkey = child_auth_info.get_pkey_object()
+ gid = auth_info.get_gid_object()
+ record.set_gid(gid.save_to_string(save_parents=True))
+ geni_fields = record.get_geni_info()
site_fields = record.get_pl_info()
- pointer = shell.AddSite(pl_auth, site_fields)
+
+ # if registering a sa, see if a ma already exists
+ # if registering a ma, see if a sa already exists
+ if (type == "sa"):
+ other_rec = table.resolve("ma", record.get_name())
+ elif (type == "ma"):
+ other_rec = table.resolve("sa", record.get_name())
+
+ if other_rec:
+ print "linking ma and sa to the same plc site"
+ pointer = other_rec[0].get_pointer()
+ else:
+ geni_fields_to_pl_fields(type, name, geni_fields, site_fields)
+ print "adding site with fields", site_fields
+ pointer = self.shell.AddSite(self.pl_auth, site_fields)
+
record.set_pointer(pointer)
elif (type == "slice"):
+ geni_fields = record.get_geni_info()
slice_fields = record.get_pl_info()
- pointer = shell.AddSlice(pl_auth, slice_fields)
+
+ geni_fields_to_pl_fields(type, name, geni_fields, slice_fields)
+
+ pointer = self.shell.AddSlice(self.pl_auth, slice_fields)
record.set_pointer(pointer)
elif (type == "user"):
- # TODO: extract pkey from user_fields
+ geni_fields = record.get_geni_info()
user_fields = record.get_pl_info()
- pointer = shell.AddPerson(pl_auth, user_fields)
+
+ geni_fields_to_pl_fields(type, name, geni_fields, user_fields)
+
+ pointer = self.shell.AddPerson(self.pl_auth, user_fields)
record.set_pointer(pointer)
elif (type == "node"):
+ geni_fields = record.get_geni_info()
node_fields = record.get_pl_info()
- pointer = shell.AddNode(pl_auth, login_base, node_fields)
+
+ geni_fields_to_pl_fields(type, name, geni_fields, node_fields)
+
+ login_base = hrn_to_pl_login_base(auth_name)
+
+ print "calling addnode with", login_base, node_fields
+ pointer = self.shell.AddNode(self.pl_auth, login_base, node_fields)
record.set_pointer(pointer)
else:
raise UnknownGeniType(type)
- gid = Hierarchy.create_gid(name, create_uuid(), pkey)
- record.set_gid(gid.save_to_string())
table.insert(record)
+ return record.get_gid_object().save_to_string(save_parents=True)
+
+ ##
+ # GENI API: remove
+ #
+ # Remove an object from the registry. If the object represents a PLC object,
+ # then the PLC records will also be removed.
+ #
+ # @param cred credential string
+ # @param record_dict dictionary containing record fields. The only relevant
+ # fields of the record are 'name' and 'type', which are used to lookup
+ # the current copy of the record in the Geni database, to make sure
+ # that the appopriate record is removed.
+
def remove(self, cred, record_dict):
- self.decode_authentication(cred)
+ self.decode_authentication(cred, "remove")
record = GeniRecord(dict = record_dict)
type = record.get_type()
+ self.verify_object_permission(record.get_name())
+
auth_name = get_authority(record.get_name())
table = self.get_auth_table(auth_name)
# let's not trust that the caller has a well-formed record (a forged
# pointer field could be a disaster), so look it up ourselves
- record = table.resolve(type, record.get_name(), must_exist=True)[0]
+ record_list = table.resolve(type, record.get_name())
+ if not record_list:
+ raise RecordNotFound(name)
+ record = record_list[0]
# TODO: sa, ma
if type == "user":
- shell.DeletePerson(pl_auth, record.get_pointer())
+ self.shell.DeletePerson(self.pl_auth, record.get_pointer())
elif type == "slice":
- shell.DeleteSlice(pl_auth, record.get_pointer())
+ self.shell.DeleteSlice(self.pl_auth, record.get_pointer())
elif type == "node":
- shell.DeleteNode(pl_auth, record.get_pointer())
+ self.shell.DeleteNode(self.pl_auth, record.get_pointer())
+ elif (type == "sa") or (type == "ma"):
+ if (type == "sa"):
+ other_rec = table.resolve("ma", record.get_name())
+ elif (type == "ma"):
+ other_rec = table.resolve("sa", record.get_name())
+
+ if other_rec:
+ # sa and ma both map to a site, so if we are deleting one
+ # but the other still exists, then do not delete the site
+ print "not removing site", record.get_name(), "because either sa or ma still exists"
+ pass
+ else:
+ print "removing site", record.get_name()
+ self.shell.DeleteSite(self.pl_auth, record.get_pointer())
else:
raise UnknownGeniType(type)
- table.remove(record_dict)
+ table.remove(record)
+
+ return True
+
+ ##
+ # GENI API: Register
+ #
+ # Update an object in the registry. Currently, this only updates the
+ # PLC information associated with the record. The Geni fields (name, type,
+ # GID) are fixed.
+ #
+ # The record is expected to have the pl_info field filled in with the data
+ # that should be updated.
+ #
+ # TODO: The geni_info member of the record should be parsed and the pl_info
+ # adjusted as necessary (add/remove users from a slice, etc)
+ #
+ # @param cred credential string specifying rights of the caller
+ # @param record a record dictionary to be updated
def update(self, cred, record_dict):
- self.decode_authentication(cred)
+ self.decode_authentication(cred, "update")
record = GeniRecord(dict = record_dict)
type = record.get_type()
+ self.verify_object_permission(record.get_name())
+
auth_name = get_authority(record.get_name())
table = self.get_auth_table(auth_name)
# make sure the record exists
- existing_record = table.resolve(type, record.get_name(), must_exist=True)[0]
+ existing_record_list = table.resolve(type, record.get_name())
+ if not existing_record_list:
+ raise RecordNotFound(record.get_name())
+
+ existing_record = existing_record_list[0]
pointer = existing_record.get_pointer()
+ # update the PLC information that was specified with the record
+
if (type == "sa") or (type == "ma"):
- shell.UpdateSite(pl_auth, pointer, record.get_pl_info())
+ self.shell.UpdateSite(self.pl_auth, pointer, record.get_pl_info())
elif type == "slice":
- shell.UpdateSlice(pl_auth, pointer, record.get_pl_info())
+ self.shell.UpdateSlice(self.pl_auth, pointer, record.get_pl_info())
elif type == "user":
- shell.UpdatePerson(pl_auth, pointer, record.get_pl_info())
+ self.shell.UpdatePerson(self.pl_auth, pointer, record.get_pl_info())
elif type == "node":
- shell.UpdateNode(pl_auth, pointer, record.get_pl_info())
+ self.shell.UpdateNode(self.pl_auth, pointer, record.get_pl_info())
else:
raise UnknownGeniType(type)
+ ##
+ # List the records in an authority. The objectGID in the supplied credential
+ # should name the authority that will be listed.
+ #
+ # TODO: List doesn't take an hrn and uses the hrn contained in the
+ # objectGid of the credential. Does this mean the only way to list an
+ # authority is by having a credential for that authority?
+ #
+ # @param cred credential string specifying rights of the caller
+ #
+ # @return list of record dictionaries
def list(self, cred):
- self.decode_authentication(cred)
+ self.decode_authentication(cred, "list")
auth_name = self.object_gid.get_hrn()
table = self.get_auth_table(auth_name)
- dict_list = table.list_dict()
+ records = table.list()
+
+ good_records = []
+ for record in records:
+ try:
+ self.fill_record_info(record)
+ good_records.append(record)
+ except PlanetLabRecordDoesNotExist:
+ # silently drop the ones that are missing in PL.
+ # is this the right thing to do?
+ report.error("ignoring geni record " + record.get_name() + " because pl record does not exist")
+ table.remove(record)
+
+ dicts = []
+ for record in good_records:
+ dicts.append(record.as_dict())
+
+ return dicts
return dict_list
+ ##
+ # Resolve a record. This is an internal version of the Resolve API call
+ # and returns records in record object format rather than dictionaries
+ # that may be sent over XMLRPC.
+ #
+ # @param type type of record to resolve (user | sa | ma | slice | node)
+ # @param name human readable name of object
+ # @param must_exist if True, throw an exception if no records are found
+ #
+ # @return a list of record objects, or an empty list []
+
def resolve_raw(self, type, name, must_exist=True):
auth_name = get_authority(name)
- table = get_auth_table(auth_name)
+ table = self.get_auth_table(auth_name)
records = table.resolve(type, name)
if (not records) and must_exist:
raise RecordNotFound(name)
- return records
-
- def resolve(self, name):
- self.decode_authentication(cred)
+ good_records = []
+ for record in records:
+ try:
+ self.fill_record_info(record)
+ good_records.append(record)
+ except PlanetLabRecordDoesNotExist:
+ # silently drop the ones that are missing in PL.
+ # is this the right thing to do?
+ report.error("ignoring geni record " + record.get_name() + " because pl record does not exist")
+ table.remove(record)
+
+ return good_records
+
+ ##
+ # GENI API: Resolve
+ #
+ # This is a wrapper around resolve_raw that converts records objects into
+ # dictionaries before returning them to the user.
+ #
+ # @param cred credential string authorizing the caller
+ # @param name human readable name to resolve
+ #
+ # @return a list of record dictionaries, or an empty list
+
+ def resolve(self, cred, name):
+ self.decode_authentication(cred, "resolve")
- records = self.resolve("*", name)
+ records = self.resolve_raw("*", name)
dicts = []
for record in records:
dicts.append(record.as_dict())
return dicts
+ ##
+ # GENI API: get_gid
+ #
+ # Retrieve the GID for an object. This function looks up a record in the
+ # registry and returns the GID of the record if it exists.
+ # TODO: Is this function needed? It's a shortcut for Resolve()
+ #
+ # @param name hrn to look up
+ #
+ # @return the string representation of a GID object
+
def get_gid(self, name):
- self.verify_object_belongs_to_me(name) # XXX Fixme
+ self.verify_object_belongs_to_me(name)
records = self.resolve_raw("*", name)
gid_string_list = []
for record in records:
gid = record.get_gid()
- gid_string_list.append(gid.save_to_string())
+ gid_string_list.append(gid.save_to_string(save_parents=True))
return gid_string_list
+ ##
+ # Determine tje rights that an object should have. The rights are entirely
+ # dependent on the type of the object. For example, users automatically
+ # get "refresh", "resolve", and "info".
+ #
+ # @param type the type of the object (user | sa | ma | slice | node)
+ # @param name human readable name of the object (not used at this time)
+ #
+ # @return RightList object containing rights
+
+ def determine_rights(self, type, name):
+ rl = RightList()
+
+ # rights seem to be somewhat redundant with the type of the credential.
+ # For example, a "sa" credential implies the authority right, because
+ # a sa credential cannot be issued to a user who is not an owner of
+ # the authority
+
+ if type == "user":
+ rl.add("refresh")
+ rl.add("resolve")
+ rl.add("info")
+ elif type == "sa":
+ rl.add("authority")
+ elif type == "ma":
+ rl.add("authority")
+ elif type == "slice":
+ rl.add("embed")
+ rl.add("bind")
+ rl.add("control")
+ rl.add("info")
+ elif type == "component":
+ rl.add("operator")
+
+ return rl
+
+ ##
+ # GENI API: Get_self_credential
+ #
+ # Get_self_credential a degenerate version of get_credential used by a
+ # client to get his initial credential when he doesn't have one. This is
+ # the same as get_credential(..., cred=None,...).
+ #
+ # The registry ensures that the client is the principal that is named by
+ # (type, name) by comparing the public key in the record's GID to the
+ # private key used to encrypt the client-side of the HTTPS connection. Thus
+ # it is impossible for one principal to retrieve another principal's
+ # credential without having the appropriate private key.
+ #
+ # @param type type of object (user | slice | sa | ma | node
+ # @param name human readable name of object
+ #
+ # @return the string representation of a credential object
+
def get_self_credential(self, type, name):
self.verify_object_belongs_to_me(name)
+ auth_hrn = get_authority(name)
+ auth_info = self.get_auth_info(auth_hrn)
+
# find a record that matches
records = self.resolve_raw(type, name, must_exist=True)
record = records[0]
- gid = record.get_gid()
+ gid = record.get_gid_object()
peer_cert = self.server.peer_cert
if not peer_cert.is_pubkey(gid.get_pubkey()):
raise ConnectionKeyGIDMismatch(gid.get_subject())
# create the credential
- gid = found_record.get_gid()
+ gid = record.get_gid_object()
cred = Credential(subject = gid.get_subject())
cred.set_gid_caller(gid)
cred.set_gid_object(gid)
- cred.set_issuer(key=self.key, subject=auth_hrn)
+ cred.set_issuer(key=auth_info.get_pkey_object(), subject=auth_hrn)
cred.set_pubkey(gid.get_pubkey())
+
+ rl = self.determine_rights(type, name)
+ cred.set_privileges(rl)
+
+ cred.set_parent(AuthHierarchy.get_auth_cred(auth_hrn))
+
cred.encode()
cred.sign()
- return cred.save_to_string()
+ return cred.save_to_string(save_parents=True)
+
+ ##
+ # GENI API: Get_credential
+ #
+ # Retrieve a credential for an object.
+ #
+ # If cred==None, then the behavior reverts to get_self_credential()
+ #
+ # @param cred credential object specifying rights of the caller
+ # @param type type of object (user | slice | sa | ma | node)
+ # @param name human readable name of object
+ #
+ # @return the string representation of a credental object
def get_credential(self, cred, type, name):
if not cred:
return get_self_credential(self, type, name)
- self.decode_authentication(cred)
+ self.decode_authentication(cred, "getcredential")
self.verify_object_belongs_to_me(name)
- records = self.resolve(type, name, must_exist=True)
+ auth_hrn = get_authority(name)
+ auth_info = self.get_auth_info(auth_hrn)
+
+ records = self.resolve_raw(type, name, must_exist=True)
record = records[0]
- object_gid = record.get_gid()
+ # TODO: Check permission that self.client_cred can access the object
+
+ object_gid = record.get_gid_object()
new_cred = Credential(subject = object_gid.get_subject())
new_cred.set_gid_caller(self.client_gid)
new_cred.set_gid_object(object_gid)
- new_cred.set_issuer(key=self.key, cert=self.cert)
+ new_cred.set_issuer(key=auth_info.get_pkey_object(), subject=auth_hrn)
new_cred.set_pubkey(object_gid.get_pubkey())
+
+ rl = self.determine_rights(type, name)
+ new_cred.set_privileges(rl)
+
+ new_cred.set_parent(AuthHierarchy.get_auth_cred(auth_hrn))
+
new_cred.encode()
new_cred.sign()
- return new_cred.save_to_string()
+ return new_cred.save_to_string(save_parents=True)
+
+ ##
+ # GENI_API: Create_gid
+ #
+ # Create a new GID. For MAs and SAs that are physically located on the
+ # registry, this allows a owner/operator/PI to create a new GID and have it
+ # signed by his respective authority.
+ #
+ # @param cred credential of caller
+ # @param name hrn for new GID
+ # @param uuid unique identifier for new GID
+ # @param pkey_string public-key string (TODO: why is this a string and not a keypair object?)
+ #
+ # @return the string representation of a GID object
+
+ def create_gid(self, cred, name, uuid, pubkey_str):
+ self.decode_authentication(cred, "getcredential")
+
+ self.verify_object_belongs_to_me(name)
+
+ self.verify_object_permission(name)
+
+ if uuid == None:
+ uuid = create_uuid()
+
+ pkey = Keypair()
+ pkey.load_pubkey_from_string(pubkey_str)
+ gid = AuthHierarchy.create_gid(name, uuid, pkey)
+
+ return gid.save_to_string(save_parents=True)
+
+ # ------------------------------------------------------------------------
+ # Component Interface
+
+ ##
+ # Convert a PLC record into the slice information that will be stored in
+ # a ticket. There are two parts to this information: attributes and
+ # rspec.
+ #
+ # Attributes are non-resource items, such as keys and the initscript
+ # Rspec is a set of resource specifications
+ #
+ # @param record a record object
+ #
+ # @return a tuple (attrs, rspec) of dictionaries
+
+ def record_to_slice_info(self, record):
+
+ # get the user keys from the slice
+ keys = []
+ persons = self.shell.GetPersons(self.pl_auth, record.pl_info['person_ids'])
+ for person in persons:
+ person_keys = self.shell.GetKeys(self.pl_auth, person["key_ids"])
+ for person_key in person_keys:
+ keys = keys + [person_key['key']]
+
+ attributes={}
+ attributes['name'] = record.pl_info['name']
+ attributes['keys'] = keys
+ attributes['instantiation'] = record.pl_info['instantiation']
+ attributes['vref'] = 'default'
+ attributes['timestamp'] = time.time()
+
+ rspec = {}
+
+ # get the PLC attributes and separate them into slice attributes and
+ # rspec attributes
+ filter = {}
+ filter['slice_id'] = record.pl_info['slice_id']
+ plc_attrs = self.shell.GetSliceAttributes(self.pl_auth, filter)
+ for attr in plc_attrs:
+ name = attr['name']
+
+ # initscripts: lookup the contents of the initscript and store it
+ # in the ticket attributes
+ if (name == "initscript"):
+ filter={'name': attr['value']}
+ initscripts = self.shell.GetInitScripts(self.pl_auth, filter)
+ if initscripts:
+ attributes['initscript'] = initscripts[0]['script']
+ else:
+ rspec[name] = attr['value']
+
+ return (attributes, rspec)
+
+ ##
+ # GENI API: get_ticket
+ #
+ # Retrieve a ticket. This operation is currently implemented on the
+ # registry (see SFA, engineering decisions), and is not implemented on
+ # components.
+ #
+ # The ticket is filled in with information from the PLC database. This
+ # information includes resources, and attributes such as user keys and
+ # initscripts.
+ #
+ # @param cred credential string
+ # @param name name of the slice to retrieve a ticket for
+ # @param rspec resource specification dictionary
+ #
+ # @return the string representation of a ticket object
+
+ def get_ticket(self, cred, name, rspec):
+ self.decode_authentication(cred, "getticket")
+
+ self.verify_object_belongs_to_me(name)
+
+ self.verify_object_permission(name)
+
+ # XXX much of this code looks like get_credential... are they so similar
+ # that they should be combined?
+
+ auth_hrn = get_authority(name)
+ auth_info = self.get_auth_info(auth_hrn)
+
+ records = self.resolve_raw("slice", name, must_exist=True)
+ record = records[0]
+
+ object_gid = record.get_gid_object()
+ new_ticket = Ticket(subject = object_gid.get_subject())
+ new_ticket.set_gid_caller(self.client_gid)
+ new_ticket.set_gid_object(object_gid)
+ new_ticket.set_issuer(key=auth_info.get_pkey_object(), subject=auth_hrn)
+ new_ticket.set_pubkey(object_gid.get_pubkey())
+
+ self.fill_record_info(record)
+
+ (attributes, rspec) = self.record_to_slice_info(record)
+
+ new_ticket.set_attributes(attributes)
+ new_ticket.set_rspec(rspec)
+
+ new_ticket.set_parent(AuthHierarchy.get_auth_ticket(auth_hrn))
+
+ new_ticket.encode()
+ new_ticket.sign()
+
+ return new_ticket.save_to_string(save_parents=True)
+
if __name__ == "__main__":
+ global AuthHierarchy
+ global TrustedRoots
+
key_file = "server.key"
cert_file = "server.cert"
cert.sign()
cert.save_to_file(cert_file)
- s = Registry("localhost", 12345, key_file, cert_file)
+ AuthHierarchy = Hierarchy()
+
+ TrustedRoots = TrustedRootList()
+
+ s = Registry("", 12345, key_file, cert_file)
+ s.trusted_cert_list = TrustedRoots.get_list()
s.run()
git://git.onelab.eu / sfa.git / blobdiff