add missing imports
[plcapi.git] / PLC / AuthorizeHelpers.py
1 #
2 # Thierry Parmentelat - INRIA
3 #
4 from PLC.Faults import *
5 from PLC.Persons import Persons,Person
6 from PLC.Sites import Sites,Site
7 from PLC.Nodes import Nodes,Node
8 from PLC.Interfaces import Interfaces,Interface
9 from PLC.Slices import Slices,Slice
10
11 class AuthorizeHelpers:
12
13     @staticmethod
14     def person_tag_type_common_roles (api, person, tag_type):
15         return list (set(person['roles']).intersection(set(tag_type['roles'])))
16
17     @staticmethod
18     def caller_may_access_tag_type (api, caller, tag_type):
19         if isinstance(caller,Person):
20             return len(AuthorizeHelpers.person_tag_type_common_roles(api,caller,tag_type))!=0
21         elif isinstance(caller,Node):
22             return 'node' in tag_type['roles']
23         else:
24             raise PLCInvalidArgument, "caller_may_access_tag_type - unexpected arg"
25
26     @staticmethod
27     def person_may_access_person (api, caller_person, subject_person):
28         # keep it simple for now - could be a bit more advanced for PIs maybe
29         try:    return caller_person['person_id'] == subject_person['person_id']
30         except: return False
31
32     @staticmethod
33     def person_in_site (api, person, site):
34         return site['site_id'] in person['site_ids']
35
36     @staticmethod
37     def person_in_slice (api, caller_person, slice):
38         return caller_person['person_id'] in slice['person_ids']
39
40     @staticmethod
41     def slice_in_site (api, slice, site):
42         return slice['site_id']==site['site_id']
43
44     @staticmethod
45     def node_id_in_slice (api, node_id_or_hostname, slice):
46         if isinstance (node_id_or_hostname,int):
47             return node_id_or_hostname in slice['node_ids']
48         else:
49             try:   return Nodes(api,node_id_or_hostname)[0]['node_id'] in slice['node_ids']
50             except:return False
51
52     @staticmethod
53     def node_id_in_site (api, node_id_or_hostname, site):
54         if isinstance (node_id_or_hostname,int):
55             return node_id_or_hostname in site['node_ids']
56         else:
57             try:   return Nodes(api,node_id_or_hostname)[0]['node_id'] in site['node_ids']
58             except:return False
59
60
61     @staticmethod
62     def node_match_id (api, node, node_id_or_hostname):
63         if isinstance (node_id_or_hostname,int):
64             return node['node_id']==node_id_or_hostname
65         else:
66             return node['hostname']==node_id_or_hostname
67
68     @staticmethod
69     def interface_belongs_to_person (api,interface, person):
70         try:
71             node=Nodes(api,[interface['node_id']])[0]
72             return AuthorizeHelpers.node_belongs_to_person (api, node, person)
73         except:
74             return False
75
76     @staticmethod
77     def node_belongs_to_person (api, node, person):
78         try:
79             site=Sites(api,[node['site_id']])[0]
80             return AuthorizeHelpers.person_in_site (api, person, site)
81         except:
82             import traceback
83             return False
84
85     # does the slice belong to the site that the (pi) user is in ?
86     @staticmethod
87     def slice_belongs_to_pi (api, slice, pi):
88         return slice['site_id'] in pi['site_ids']
89
90
91 # authorization methods - check if a given caller can set tag on this object
92 # called in {Add,Update,Delete}<Class>Tags methods, and in the accessors created in factory
93 # attach these as <Class>.caller_may_write_tag so accessors can find it
94
95 def caller_may_write_node_tag (node, api, caller, tag_type):
96     if 'admin' in caller['roles']:
97         pass
98     elif not AuthorizeHelpers.caller_may_access_tag_type (api, caller, tag_type):
99         raise PLCPermissionDenied, "Role mismatch for writing tag %s"%(tag_type['tagname'])
100     elif AuthorizeHelpers.node_belongs_to_person (api, node, caller):
101         pass
102     else:
103         raise PLCPermissionDenied, "Writing node tag: must belong in the same site as %s"%\
104             (node['hostname'])
105
106 setattr(Node,'caller_may_write_tag',caller_may_write_node_tag)
107         
108
109 def caller_may_write_interface_tag (interface, api, caller, tag_type):
110     if 'admin' in caller['roles']:
111         pass
112     elif not AuthorizeHelpers.caller_may_access_tag_type (api, caller, tag_type):
113         raise PLCPermissionDenied, "Role mismatch for writing tag %s"%(tag_type['tagname'])
114     elif AuthorizeHelpers.interface_belongs_to_person (api, interface, caller):
115         pass
116     else:
117         raise PLCPermissionDenied, "Writing interface tag: must belong in the same site as %s"%\
118             (interface['ip'])
119         
120 setattr(Interface,'caller_may_write_tag',caller_may_write_interface_tag)
121         
122
123 def caller_may_write_site_tag (site, api, caller, tag_type):
124     if 'admin' in caller['roles']:
125         pass
126     elif not AuthorizeHelpers.caller_may_access_tag_type (api, caller, tag_type):
127         raise PLCPermissionDenied, "Role mismatch for writing tag %s"%(tag_type['tagname'])
128     elif AuthorizeHelpers.person_in_site (api, caller, site):
129         pass
130     else:
131         raise PLCPermissionDenied, "Writing site tag: must be part of site"%site['login_base']
132
133 setattr(Site,'caller_may_write_tag',caller_may_write_site_tag)
134
135
136 def caller_may_write_person_tag (person, api, caller, tag_type):
137     if 'admin' in caller['roles']:
138         pass
139     # user can change tags on self
140     elif AuthorizeHelpers.person_may_access_person (api, caller, person):
141         pass
142     else:
143         raise PLCPermissionDenied, "Writing person tag: you can only change your own tags"
144
145 setattr(Person,'caller_may_write_tag',caller_may_write_person_tag)
146
147
148 def caller_may_write_slice_tag (slice, api, caller, tag_type, node_id_or_hostname=None, nodegroup_id_or_name=None):
149     granted=False
150     if 'admin' in caller['roles']:
151         granted=True
152     # does caller have right role(s) ? this knows how to deal with caller being a node
153     elif not AuthorizeHelpers.caller_may_access_tag_type (api, caller, tag_type):
154         granted=False
155     # node callers: check the node is in the slice
156     elif isinstance(caller, Node): 
157         # nodes can only set their own sliver tags
158         if node_id_or_hostname is None: 
159             granted=False
160         elif not AuthorizeHelpers.node_match_id (api, caller, node_id_or_hostname):
161             granted=False
162         elif not AuthorizeHelpers.node_in_slice (api, caller, slice):
163             granted=False
164     # caller is a non-admin person
165     else:
166         # only admins can handle slice tags on a nodegroup
167         if nodegroup_id_or_name:
168             raise PLCPermissionDenied, "Cannot set slice tag %s on nodegroup - restricted to admins"%\
169                 (tag_type['tagname'])
170         # if a node is specified it is expected to be in the slice
171         if node_id_or_hostname:
172             if not AuthorizeHelpers.node_id_in_slice (api, node_id_or_hostname, slice):
173                 raise PLCPermissionDenied, "%s, node must be in slice when setting sliver tag"
174         # try all roles to find a match - tech are ignored b/c not in AddSliceTag.roles anyways
175         for role in AuthorizeHelpers.person_tag_type_common_roles(api,caller,tag_type):
176             # regular users need to be in the slice
177             if role=='user':
178                 if AuthorizeHelpers.person_in_slice(api, caller, slice):
179                     granted=True ; break
180             # for convenience, pi's can tweak all the slices in their site
181             elif role=='pi':
182                 if AuthorizeHelpers.slice_belongs_to_pi (api, slice, caller):
183                     granted=True ; break
184     if not granted:
185         raise PLCPermissionDenied, "Cannot write slice tag %s"%(tag_type['tagname'])
186
187 setattr(Slice,'caller_may_write_tag',caller_may_write_slice_tag)
188
189