2 # This Module implements rights and lists of rights for the Geni wrapper. Rights
3 # are implemented by two classes:
5 # Right - represents a single right
7 # RightList - represents a list of rights
9 # A right may allow several different operations. For example, the "info" right
10 # allows "listslices", "listcomponentresources", etc.
14 # privilege_table is a list of priviliges and what operations are allowed
17 privilege_table = {"authority": ["register", "remove", "update", "resolve", "list", "getcredential"],
18 "refresh": ["remove", "update"],
19 "resolve": ["resolve", "list", "getcredential"],
20 "sa": ["getticket", "redeemslice", "createslice", "deleteslice", "updateslice", "getsliceresources", "getticket", "loanresources", "stopslice", "startslice", "deleteslice", "resetslice", "listslices", "listnodes", "getpolicy"],
21 "embed": ["getticket", "redeemslice", "createslice", "deleteslice", "updateslice", "getsliceresources"],
22 "bind": ["getticket", "loanresources"],
23 "control": ["updateslice", "createslice", "stopslice", "startslice", "deleteslice", "resetslice", "getsliceresources"],
24 "info": ["listslices", "listnodes", "getpolicy"],
25 "ma": ["setbootstate", "getbootstate", "reboot"]}
29 # Determine tje rights that an object should have. The rights are entirely
30 # dependent on the type of the object. For example, users automatically
31 # get "refresh", "resolve", and "info".
33 # @param type the type of the object (user | sa | ma | slice | node)
34 # @param name human readable name of the object (not used at this time)
36 # @return RightList object containing rights
38 def determine_rights(type, name):
41 # rights seem to be somewhat redundant with the type of the credential.
42 # For example, a "sa" credential implies the authority right, because
43 # a sa credential cannot be issued to a user who is not an owner of
50 rl.add("authority,sa")
52 rl.add("authority,ma")
53 elif type == "authority":
54 rl.add("authority,sa,ma")
61 elif type == "component":
67 # The Right class represents a single privilege.
75 # @param kind is a string naming the right. For example "control"
77 def __init__(self, kind):
81 # Test to see if this right object is allowed to perform an operation.
82 # Returns True if the operation is allowed, False otherwise.
84 # @param op_name is a string naming the operation. For example "listslices".
86 def can_perform(self, op_name):
87 allowed_ops = privilege_table.get(self.kind.lower(), None)
91 # if "*" is specified, then all ops are permitted
92 if "*" in allowed_ops:
95 return (op_name.lower() in allowed_ops)
98 # Test to see if this right is a superset of a child right. A right is a
99 # superset if every operating that is allowed by the child is also allowed
102 # @param child is a Right object describing the child right
104 def is_superset(self, child):
105 my_allowed_ops = privilege_table.get(self.kind.lower(), None)
106 child_allowed_ops = privilege_table.get(child.kind.lower(), None)
108 if "*" in my_allowed_ops:
111 for right in child_allowed_ops:
112 if not right in my_allowed_ops:
118 # A RightList object represents a list of privileges.
122 # Create a new rightlist object, containing no rights.
124 # @param string if string!=None, load the rightlist from the string
126 def __init__(self, string=None):
129 self.load_from_string(string)
132 return self.rights == []
135 # Add a right to this list
137 # @param right is either a Right object or a string describing the right
139 def add(self, right):
140 if isinstance(right, str):
141 right = Right(kind = right)
142 self.rights.append(right)
145 # Load the rightlist object from a string
147 def load_from_string(self, string):
150 # none == no rights, so leave the list empty
154 parts = string.split(",")
156 self.rights.append(Right(part))
159 # Save the rightlist object to a string. It is saved in the format of a
160 # comma-separated list.
162 def save_to_string(self):
164 for right in self.rights:
165 right_names.append(right.kind)
167 return ",".join(right_names)
170 # Check to see if some right in this list allows an operation. This is
171 # done by evaluating the can_perform function of each operation in the
174 # @param op_name is an operation to check, for example "listslices"
176 def can_perform(self, op_name):
177 for right in self.rights:
178 if right.can_perform(op_name):
183 # Check to see if all of the rights in this rightlist are a superset
184 # of all the rights in a child rightlist. A rightlist is a superset
185 # if there is no operation in the child rightlist that cannot be
186 # performed in the parent rightlist.
188 # @param child is a rightlist object describing the child
190 def is_superset(self, child):
191 for child_right in child.rights:
193 for my_right in self.rights:
194 if my_right.is_superset(child_right):
202 # Determine tje rights that an object should have. The rights are entirely
203 # dependent on the type of the object. For example, users automatically
204 # get "refresh", "resolve", and "info".
206 # @param type the type of the object (user | sa | ma | slice | node)
207 # @param name human readable name of the object (not used at this time)
209 # @return RightList object containing rights
211 def determine_rights(self, type, name):
214 # rights seem to be somewhat redundant with the type of the credential.
215 # For example, a "sa" credential implies the authority right, because
216 # a sa credential cannot be issued to a user who is not an owner of
224 rl.add("authority,sa")
226 rl.add("authority,ma")
227 elif type == "authority":
228 rl.add("authority,sa,ma")
229 elif type == "slice":
235 elif type == "component":