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}"
  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                                  head_kind: 'arvados#user',
 133                                  link_class: 'permission',
 134                                  name: 'can_login')
 135     oid_login_perms.each do |perm|
 136       Link.delete perm
 137     end
 138
 139     # delete repo_perms for this user
 140     repo_perms = Link.where(tail_uuid: self.uuid,
 141                             head_kind: 'arvados#repository',
 142                             link_class: 'permission',
 143                             name: 'can_write')
 144     repo_perms.each do |perm|
 145       Link.delete perm
 146     end
 147
 148     # delete vm_login_perms for this user
 149     vm_login_perms = Link.where(tail_uuid: self.uuid,
 150                                 head_kind: 'arvados#virtualMachine',
 151                                 link_class: 'permission',
 152                                 name: 'can_login')
 153     vm_login_perms.each do |perm|
 154       Link.delete perm
 155     end
 156
 157     # delete "All users' group read permissions for this user
 158     group = Group.where(name: 'All users').select do |g|
 159       g[:uuid].match /-f+$/
 160     end.first
 161     group_perms = Link.where(tail_uuid: self.uuid,
 162                              head_uuid: group[:uuid],
 163                              head_kind: 'arvados#group',
 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_kind: 'arvados#user',
 173                               tail_uuid: self.uuid)
 174     signed_uuids.each do |sign|
 175       Link.delete sign
 176     end
 177
 178     # mark the user as inactive
 179     self.is_active = false
 180     self.save!
 181   end
 182
 183   protected
 184
 185   def permission_to_update
 186     # users must be able to update themselves (even if they are
 187     # inactive) in order to create sessions
 188     self == current_user or super
 189   end
 190
 191   def permission_to_create
 192     current_user.andand.is_admin or
 193       (self == current_user and
 194        self.is_active == Rails.configuration.new_users_are_active)
 195   end
 196
 197   def check_auto_admin
 198     if User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and Rails.configuration.auto_admin_user
 199       if current_user.email == Rails.configuration.auto_admin_user
 200         self.is_admin = true
 201         self.is_active = true
 202       end
 203     end
 204   end
 205
 206   def prevent_privilege_escalation
 207     if current_user.andand.is_admin
 208       return true
 209     end
 210     if self.is_active_changed?
 211       if self.is_active != self.is_active_was
 212         logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
 213         self.is_active = self.is_active_was
 214       end
 215     end
 216     if self.is_admin_changed?
 217       if self.is_admin != self.is_admin_was
 218         logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
 219         self.is_admin = self.is_admin_was
 220       end
 221     end
 222     true
 223   end
 224
 225   def prevent_inactive_admin
 226     if self.is_admin and not self.is_active
 227       # There is no known use case for the strange set of permissions
 228       # that would result from this change. It's safest to assume it's
 229       # a mistake and disallow it outright.
 230       raise "Admin users cannot be inactive"
 231     end
 232     true
 233   end
 234
 235   def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
 236     nextpaths = graph[start]
 237     return merged if !nextpaths
 238     return merged if upstream_path.has_key? start
 239     upstream_path[start] = true
 240     upstream_mask ||= ALL_PERMISSIONS
 241     nextpaths.each do |head, mask|
 242       merged[head] ||= {}
 243       mask.each do |k,v|
 244         merged[head][k] ||= v if upstream_mask[k]
 245       end
 246       search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
 247     end
 248     upstream_path.delete start
 249     merged
 250   end
 251
 252   def create_oid_login_perm (openid_prefix)
 253     login_perm_props = {identity_url_prefix: openid_prefix}
 254
 255     # Check oid_login_perm
 256     oid_login_perms = Link.where(tail_uuid: self.email,
 257                                    head_kind: 'arvados#user',
 258                                    link_class: 'permission',
 259                                    name: 'can_login')
 260
 261     if !oid_login_perms.any?
 262       # create openid login permission
 263       oid_login_perm = Link.create(link_class: 'permission',
 264                                    name: 'can_login',
 265                                    tail_kind: 'email',
 266                                    tail_uuid: self.email,
 267                                    head_kind: 'arvados#user',
 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_kind: 'arvados#repository',
 295                               head_uuid: repo[:uuid],
 296                               link_class: 'permission',
 297                               name: 'can_write')
 298       if repo_perms.any?
 299         logger.warn "User already has repository access " +
 300             repo_perms.collect { |p| p[:uuid] }.inspect
 301         return repo_perms.first
 302       end
 303     end
 304
 305     # create repo, if does not already exist
 306     repo ||= Repository.create(name: repo_name)
 307     logger.info { "repo uuid: " + repo[:uuid] }
 308
 309     repo_perm = Link.create(tail_kind: 'arvados#user',
 310                             tail_uuid: self.uuid,
 311                             head_kind: 'arvados#repository',
 312                             head_uuid: repo[:uuid],
 313                             link_class: 'permission',
 314                             name: 'can_write')
 315     logger.info { "repo permission: " + repo_perm[:uuid] }
 316     return repo_perm
 317   end
 318
 319   # create login permission for the given vm_uuid, if it does not already exist
 320   def create_vm_login_permission_link(vm_uuid, repo_name)
 321     begin
 322
 323       # vm uuid is optional
 324       if vm_uuid
 325         vm = VirtualMachine.where(uuid: vm_uuid).first
 326
 327         if not vm
 328           logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
 329           raise "No vm found for #{vm_uuid}"
 330         end
 331       else
 332         return
 333       end
 334
 335       logger.info { "vm uuid: " + vm[:uuid] }
 336
 337       login_perms = Link.where(tail_uuid: self.uuid,
 338                               head_uuid: vm[:uuid],
 339                               head_kind: 'arvados#virtualMachine',
 340                               link_class: 'permission',
 341                               name: 'can_login')
 342
 343       perm_exists = false
 344       login_perms.each do |perm|
 345         if perm.properties[:username] == repo_name
 346           perm_exists = true
 347           break
 348         end
 349       end
 350
 351       if !perm_exists
 352         login_perm = Link.create(tail_kind: 'arvados#user',
 353                                  tail_uuid: self.uuid,
 354                                  head_kind: 'arvados#virtualMachine',
 355                                  head_uuid: vm[:uuid],
 356                                  link_class: 'permission',
 357                                  name: 'can_login',
 358                                  properties: {username: repo_name})
 359         logger.info { "login permission: " + login_perm[:uuid] }
 360       else
 361         login_perm = login_perms.first
 362       end
 363
 364       return login_perm
 365     end
 366   end
 367
 368   # add the user to the 'All users' group
 369   def create_user_group_link
 370     # Look up the "All users" group (we expect uuid *-*-fffffffffffffff).
 371     group = Group.where(name: 'All users').select do |g|
 372       g[:uuid].match /-f+$/
 373     end.first
 374
 375     if not group
 376       logger.warn "No 'All users' group with uuid '*-*-fffffffffffffff'."
 377       raise "No 'All users' group with uuid '*-*-fffffffffffffff' is found"
 378     else
 379       logger.info { "\"All users\" group uuid: " + group[:uuid] }
 380
 381       group_perms = Link.where(tail_uuid: self.uuid,
 382                               head_uuid: group[:uuid],
 383                               head_kind: 'arvados#group',
 384                               link_class: 'permission',
 385                               name: 'can_read')
 386
 387       if !group_perms.any?
 388         group_perm = Link.create(tail_kind: 'arvados#user',
 389                                  tail_uuid: self.uuid,
 390                                  head_kind: 'arvados#group',
 391                                  head_uuid: group[:uuid],
 392                                  link_class: 'permission',
 393                                  name: 'can_read')
 394         logger.info { "group permission: " + group_perm[:uuid] }
 395       else
 396         group_perm = group_perms.first
 397       end
 398
 399       return group_perm
 400     end
 401   end
 402
 403   # Give the special "System group" permission to manage this user and
 404   # all of this user's stuff.
 405   #
 406   def add_system_group_permission_link
 407     act_as_system_user do
 408       Link.create(link_class: 'permission',
 409                   name: 'can_manage',
 410                   tail_kind: 'arvados#group',
 411                   tail_uuid: system_group_uuid,
 412                   head_kind: 'arvados#user',
 413                   head_uuid: self.uuid)
 414     end
 415   end
 416 end