services/api/app/models/user.rb

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