Merge branch '1968-monitor-disk-usage'
[arvados.git] / services / api / app / models / user.rb
1 class User < ArvadosModel
2   include AssignUuid
3   include KindAndEtag
4   include CommonApiTemplate
5   serialize :prefs, Hash
6   has_many :api_client_authorizations
7   before_update :prevent_privilege_escalation
8   before_update :prevent_inactive_admin
9   before_create :check_auto_admin
10   after_create :add_system_group_permission_link
11   after_create AdminNotifier
12
13   has_many :authorized_keys, :foreign_key => :authorized_user_uuid, :primary_key => :uuid
14
15   api_accessible :user, extend: :common do |t|
16     t.add :email
17     t.add :full_name
18     t.add :first_name
19     t.add :last_name
20     t.add :identity_url
21     t.add :is_active
22     t.add :is_admin
23     t.add :is_invited
24     t.add :prefs
25   end
26
27   ALL_PERMISSIONS = {read: true, write: true, manage: true}
28
29   def full_name
30     "#{first_name} #{last_name}".strip
31   end
32
33   def is_invited
34     !!(self.is_active ||
35        Rails.configuration.new_users_are_active ||
36        self.groups_i_can(:read).select { |x| x.match /-f+$/ }.first)
37   end
38
39   def groups_i_can(verb)
40     self.group_permissions.select { |uuid, mask| mask[verb] }.keys
41   end
42
43   def can?(actions)
44     return true if is_admin
45     actions.each do |action, target|
46       target_uuid = target
47       if target.respond_to? :uuid
48         target_uuid = target.uuid
49       end
50       next if target_uuid == self.uuid
51       next if (group_permissions[target_uuid] and
52                group_permissions[target_uuid][action])
53       if target.respond_to? :owner_uuid
54         next if target.owner_uuid == self.uuid
55         next if (group_permissions[target.owner_uuid] and
56                  group_permissions[target.owner_uuid][action])
57       end
58       return false
59     end
60     true
61   end
62
63   def self.invalidate_permissions_cache
64     Rails.cache.delete_matched(/^groups_for_user_/)
65   end
66
67   # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
68   # and perm_hash[:write] are true if this user can read and write
69   # objects owned by group_uuid.
70   def group_permissions
71     Rails.cache.fetch "groups_for_user_#{self.uuid}" do
72       permissions_from = {}
73       todo = {self.uuid => true}
74       done = {}
75       while !todo.empty?
76         lookup_uuids = todo.keys
77         lookup_uuids.each do |uuid| done[uuid] = true end
78         todo = {}
79         newgroups = []
80         Group.where('owner_uuid in (?)', lookup_uuids).each do |group|
81           newgroups << [group.owner_uuid, group.uuid, 'can_manage']
82         end
83         Link.where('tail_uuid in (?) and link_class = ? and (head_uuid like ? or head_uuid like ?)',
84                    lookup_uuids,
85                    'permission',
86                    Group.uuid_like_pattern,
87                    User.uuid_like_pattern).each do |link|
88           newgroups << [link.tail_uuid, link.head_uuid, link.name]
89         end
90         newgroups.each do |tail_uuid, head_uuid, perm_name|
91           unless done.has_key? head_uuid
92             todo[head_uuid] = true
93           end
94           link_permissions = {}
95           case perm_name
96           when 'can_read'
97             link_permissions = {read:true}
98           when 'can_write'
99             link_permissions = {read:true,write:true}
100           when 'can_manage'
101             link_permissions = ALL_PERMISSIONS
102           end
103           permissions_from[tail_uuid] ||= {}
104           permissions_from[tail_uuid][head_uuid] ||= {}
105           link_permissions.each do |k,v|
106             permissions_from[tail_uuid][head_uuid][k] ||= v
107           end
108         end
109       end
110       search_permissions(self.uuid, permissions_from)
111     end
112   end
113
114   def self.setup(user, openid_prefix, repo_name=nil, vm_uuid=nil)
115     return user.setup_repo_vm_links(repo_name, vm_uuid, openid_prefix)
116   end
117
118   # create links
119   def setup_repo_vm_links(repo_name, vm_uuid, openid_prefix)
120     oid_login_perm = create_oid_login_perm openid_prefix
121     repo_perm = create_user_repo_link repo_name
122     vm_login_perm = create_vm_login_permission_link vm_uuid, repo_name
123     group_perm = create_user_group_link
124
125     return [oid_login_perm, repo_perm, vm_login_perm, group_perm, self].compact
126   end
127
128   # delete user signatures, login, repo, and vm perms, and mark as inactive
129   def unsetup
130     # delete oid_login_perms for this user
131     oid_login_perms = Link.where(tail_uuid: self.email,
132                                  link_class: 'permission',
133                                  name: 'can_login')
134     oid_login_perms.each do |perm|
135       Link.delete perm
136     end
137
138     # delete repo_perms for this user
139     repo_perms = Link.where(tail_uuid: self.uuid,
140                             link_class: 'permission',
141                             name: 'can_write')
142     repo_perms.each do |perm|
143       Link.delete perm
144     end
145
146     # delete vm_login_perms for this user
147     vm_login_perms = Link.where(tail_uuid: self.uuid,
148                                 link_class: 'permission',
149                                 name: 'can_login')
150     vm_login_perms.each do |perm|
151       Link.delete perm
152     end
153
154     # delete "All users' group read permissions for this user
155     group = Group.where(name: 'All users').select do |g|
156       g[:uuid].match /-f+$/
157     end.first
158     group_perms = Link.where(tail_uuid: self.uuid,
159                              head_uuid: group[:uuid],
160                              link_class: 'permission',
161                              name: 'can_read')
162     group_perms.each do |perm|
163       Link.delete perm
164     end
165
166     # delete any signatures by this user
167     signed_uuids = Link.where(link_class: 'signature',
168                               tail_uuid: self.uuid)
169     signed_uuids.each do |sign|
170       Link.delete sign
171     end
172
173     # mark the user as inactive
174     self.is_active = false
175     self.save!
176   end
177
178   protected
179
180   def ensure_ownership_path_leads_to_user
181     true
182   end
183
184   def permission_to_update
185     # users must be able to update themselves (even if they are
186     # inactive) in order to create sessions
187     self == current_user or super
188   end
189
190   def permission_to_create
191     current_user.andand.is_admin or
192       (self == current_user and
193        self.is_active == Rails.configuration.new_users_are_active)
194   end
195
196   def check_auto_admin
197     if User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and Rails.configuration.auto_admin_user
198       if current_user.email == Rails.configuration.auto_admin_user
199         self.is_admin = true
200         self.is_active = true
201       end
202     end
203   end
204
205   def prevent_privilege_escalation
206     if current_user.andand.is_admin
207       return true
208     end
209     if self.is_active_changed?
210       if self.is_active != self.is_active_was
211         logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
212         self.is_active = self.is_active_was
213       end
214     end
215     if self.is_admin_changed?
216       if self.is_admin != self.is_admin_was
217         logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
218         self.is_admin = self.is_admin_was
219       end
220     end
221     true
222   end
223
224   def prevent_inactive_admin
225     if self.is_admin and not self.is_active
226       # There is no known use case for the strange set of permissions
227       # that would result from this change. It's safest to assume it's
228       # a mistake and disallow it outright.
229       raise "Admin users cannot be inactive"
230     end
231     true
232   end
233
234   def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
235     nextpaths = graph[start]
236     return merged if !nextpaths
237     return merged if upstream_path.has_key? start
238     upstream_path[start] = true
239     upstream_mask ||= ALL_PERMISSIONS
240     nextpaths.each do |head, mask|
241       merged[head] ||= {}
242       mask.each do |k,v|
243         merged[head][k] ||= v if upstream_mask[k]
244       end
245       search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
246     end
247     upstream_path.delete start
248     merged
249   end
250
251   def create_oid_login_perm (openid_prefix)
252     login_perm_props = { "identity_url_prefix" => openid_prefix}
253
254     # Check oid_login_perm
255     oid_login_perms = Link.where(tail_uuid: self.email,
256                                    link_class: 'permission',
257                                    name: 'can_login').where("head_uuid = ?", self.uuid)
258
259     if !oid_login_perms.any?
260       # create openid login permission
261       oid_login_perm = Link.create(link_class: 'permission',
262                                    name: 'can_login',
263                                    tail_uuid: self.email,
264                                    head_uuid: self.uuid,
265                                    properties: login_perm_props
266                                   )
267       logger.info { "openid login permission: " + oid_login_perm[:uuid] }
268     else
269       oid_login_perm = oid_login_perms.first
270     end
271
272     return oid_login_perm
273   end
274
275   def create_user_repo_link(repo_name)
276     # repo_name is optional
277     if not repo_name
278       logger.warn ("Repository name not given for #{self.uuid}.")
279       return
280     end
281
282     # Check for an existing repository with the same name we're about to use.
283     repo = Repository.where(name: repo_name).first
284
285     if repo
286       logger.warn "Repository exists for #{repo_name}: #{repo[:uuid]}."
287
288       # Look for existing repository access for this repo
289       repo_perms = Link.where(tail_uuid: self.uuid,
290                               head_uuid: repo[:uuid],
291                               link_class: 'permission',
292                               name: 'can_write')
293       if repo_perms.any?
294         logger.warn "User already has repository access " +
295             repo_perms.collect { |p| p[:uuid] }.inspect
296         return repo_perms.first
297       end
298     end
299
300     # create repo, if does not already exist
301     repo ||= Repository.create(name: repo_name)
302     logger.info { "repo uuid: " + repo[:uuid] }
303
304     repo_perm = Link.create(tail_uuid: self.uuid,
305                             head_uuid: repo[:uuid],
306                             link_class: 'permission',
307                             name: 'can_write')
308     logger.info { "repo permission: " + repo_perm[:uuid] }
309     return repo_perm
310   end
311
312   # create login permission for the given vm_uuid, if it does not already exist
313   def create_vm_login_permission_link(vm_uuid, repo_name)
314     begin
315
316       # vm uuid is optional
317       if vm_uuid
318         vm = VirtualMachine.where(uuid: vm_uuid).first
319
320         if not vm
321           logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
322           raise "No vm found for #{vm_uuid}"
323         end
324       else
325         return
326       end
327
328       logger.info { "vm uuid: " + vm[:uuid] }
329
330       login_perms = Link.where(tail_uuid: self.uuid,
331                               head_uuid: vm[:uuid],
332                               link_class: 'permission',
333                               name: 'can_login')
334
335       perm_exists = false
336       login_perms.each do |perm|
337         if perm.properties[:username] == repo_name
338           perm_exists = true
339           break
340         end
341       end
342
343       if !perm_exists
344         login_perm = Link.create(tail_uuid: self.uuid,
345                                  head_uuid: vm[:uuid],
346                                  link_class: 'permission',
347                                  name: 'can_login',
348                                  properties: {username: repo_name})
349         logger.info { "login permission: " + login_perm[:uuid] }
350       else
351         login_perm = login_perms.first
352       end
353
354       return login_perm
355     end
356   end
357
358   # add the user to the 'All users' group
359   def create_user_group_link
360     # Look up the "All users" group (we expect uuid *-*-fffffffffffffff).
361     group = Group.where(name: 'All users').select do |g|
362       g[:uuid].match /-f+$/
363     end.first
364
365     if not group
366       logger.warn "No 'All users' group with uuid '*-*-fffffffffffffff'."
367       raise "No 'All users' group with uuid '*-*-fffffffffffffff' is found"
368     else
369       logger.info { "\"All users\" group uuid: " + group[:uuid] }
370
371       group_perms = Link.where(tail_uuid: self.uuid,
372                               head_uuid: group[:uuid],
373                               link_class: 'permission',
374                               name: 'can_read')
375
376       if !group_perms.any?
377         group_perm = Link.create(tail_uuid: self.uuid,
378                                  head_uuid: group[:uuid],
379                                  link_class: 'permission',
380                                  name: 'can_read')
381         logger.info { "group permission: " + group_perm[:uuid] }
382       else
383         group_perm = group_perms.first
384       end
385
386       return group_perm
387     end
388   end
389
390   # Give the special "System group" permission to manage this user and
391   # all of this user's stuff.
392   #
393   def add_system_group_permission_link
394     act_as_system_user do
395       Link.create(link_class: 'permission',
396                   name: 'can_manage',
397                   tail_uuid: system_group_uuid,
398                   head_uuid: self.uuid)
399     end
400   end
401 end