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_kind in (?)',
  84                    lookup_uuids,
  85                    'permission',
  86                    ['arvados#group', 'arvados#user']).each do |link|
  87           newgroups << [link.tail_uuid, link.head_uuid, link.name]
  88         end
  89         newgroups.each do |tail_uuid, head_uuid, perm_name|
  90           unless done.has_key? head_uuid
  91             todo[head_uuid] = true
  92           end
  93           link_permissions = {}
  94           case perm_name
  95           when 'can_read'
  96             link_permissions = {read:true}
  97           when 'can_write'
  98             link_permissions = {read:true,write:true}
  99           when 'can_manage'
 100             link_permissions = ALL_PERMISSIONS
 101           end
 102           permissions_from[tail_uuid] ||= {}
 103           permissions_from[tail_uuid][head_uuid] ||= {}
 104           link_permissions.each do |k,v|
 105             permissions_from[tail_uuid][head_uuid][k] ||= v
 106           end
 107         end
 108       end
 109       search_permissions(self.uuid, permissions_from)
 110     end
 111   end
 112
 113   def self.setup(user, openid_prefix, repo_name=nil, vm_uuid=nil)
 114     return user.setup_repo_vm_links(repo_name, vm_uuid, openid_prefix)
 115   end
 116
 117   # create links
 118   def setup_repo_vm_links(repo_name, vm_uuid, openid_prefix)
 119     oid_login_perm = create_oid_login_perm openid_prefix
 120     repo_perm = create_user_repo_link repo_name
 121     vm_login_perm = create_vm_login_permission_link vm_uuid, repo_name
 122     group_perm = create_user_group_link
 123
 124     return [oid_login_perm, repo_perm, vm_login_perm, group_perm, self].compact
 125   end
 126
 127   # delete user signatures, login, repo, and vm perms, and mark as inactive
 128   def unsetup
 129     # delete oid_login_perms for this user
 130     oid_login_perms = Link.where(tail_uuid: self.email,
 131                                  head_kind: 'arvados#user',
 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                             head_kind: 'arvados#repository',
 141                             link_class: 'permission',
 142                             name: 'can_write')
 143     repo_perms.each do |perm|
 144       Link.delete perm
 145     end
 146
 147     # delete vm_login_perms for this user
 148     vm_login_perms = Link.where(tail_uuid: self.uuid,
 149                                 head_kind: 'arvados#virtualMachine',
 150                                 link_class: 'permission',
 151                                 name: 'can_login')
 152     vm_login_perms.each do |perm|
 153       Link.delete perm
 154     end
 155
 156     # delete "All users' group read permissions for this user
 157     group = Group.where(name: 'All users').select do |g|
 158       g[:uuid].match /-f+$/
 159     end.first
 160     group_perms = Link.where(tail_uuid: self.uuid,
 161                              head_uuid: group[:uuid],
 162                              head_kind: 'arvados#group',
 163                              link_class: 'permission',
 164                              name: 'can_read')
 165     group_perms.each do |perm|
 166       Link.delete perm
 167     end
 168
 169     # delete any signatures by this user
 170     signed_uuids = Link.where(link_class: 'signature',
 171                               tail_kind: 'arvados#user',
 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 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                                    head_kind: 'arvados#user',
 257                                    link_class: 'permission',
 258                                    name: 'can_login')
 259
 260     if !oid_login_perms.any?
 261       # create openid login permission
 262       oid_login_perm = Link.create(link_class: 'permission',
 263                                    name: 'can_login',
 264                                    tail_kind: 'email',
 265                                    tail_uuid: self.email,
 266                                    head_kind: 'arvados#user',
 267                                    head_uuid: self.uuid,
 268                                    properties: login_perm_props
 269                                   )
 270       logger.info { "openid login permission: " + oid_login_perm[:uuid] }
 271     else
 272       oid_login_perm = oid_login_perms.first
 273     end
 274
 275     return oid_login_perm
 276   end
 277
 278   def create_user_repo_link(repo_name)
 279     # repo_name is optional
 280     if not repo_name
 281       logger.warn ("Repository name not given for #{self.uuid}.")
 282       return
 283     end
 284
 285     # Check for an existing repository with the same name we're about to use.
 286     repo = Repository.where(name: repo_name).first
 287
 288     if repo
 289       logger.warn "Repository exists for #{repo_name}: #{repo[:uuid]}."
 290
 291       # Look for existing repository access for this repo
 292       repo_perms = Link.where(tail_uuid: self.uuid,
 293                               head_kind: 'arvados#repository',
 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_kind: 'arvados#user',
 309                             tail_uuid: self.uuid,
 310                             head_kind: 'arvados#repository',
 311                             head_uuid: repo[:uuid],
 312                             link_class: 'permission',
 313                             name: 'can_write')
 314     logger.info { "repo permission: " + repo_perm[:uuid] }
 315     return repo_perm
 316   end
 317
 318   # create login permission for the given vm_uuid, if it does not already exist
 319   def create_vm_login_permission_link(vm_uuid, repo_name)
 320     begin
 321
 322       # vm uuid is optional
 323       if vm_uuid
 324         vm = VirtualMachine.where(uuid: vm_uuid).first
 325
 326         if not vm
 327           logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
 328           raise "No vm found for #{vm_uuid}"
 329         end
 330       else
 331         return
 332       end
 333
 334       logger.info { "vm uuid: " + vm[:uuid] }
 335
 336       login_perms = Link.where(tail_uuid: self.uuid,
 337                               head_uuid: vm[:uuid],
 338                               head_kind: 'arvados#virtualMachine',
 339                               link_class: 'permission',
 340                               name: 'can_login')
 341
 342       perm_exists = false
 343       login_perms.each do |perm|
 344         if perm.properties[:username] == repo_name
 345           perm_exists = true
 346           break
 347         end
 348       end
 349
 350       if !perm_exists
 351         login_perm = Link.create(tail_kind: 'arvados#user',
 352                                  tail_uuid: self.uuid,
 353                                  head_kind: 'arvados#virtualMachine',
 354                                  head_uuid: vm[:uuid],
 355                                  link_class: 'permission',
 356                                  name: 'can_login',
 357                                  properties: {username: repo_name})
 358         logger.info { "login permission: " + login_perm[:uuid] }
 359       else
 360         login_perm = login_perms.first
 361       end
 362
 363       return login_perm
 364     end
 365   end
 366
 367   # add the user to the 'All users' group
 368   def create_user_group_link
 369     # Look up the "All users" group (we expect uuid *-*-fffffffffffffff).
 370     group = Group.where(name: 'All users').select do |g|
 371       g[:uuid].match /-f+$/
 372     end.first
 373
 374     if not group
 375       logger.warn "No 'All users' group with uuid '*-*-fffffffffffffff'."
 376       raise "No 'All users' group with uuid '*-*-fffffffffffffff' is found"
 377     else
 378       logger.info { "\"All users\" group uuid: " + group[:uuid] }
 379
 380       group_perms = Link.where(tail_uuid: self.uuid,
 381                               head_uuid: group[:uuid],
 382                               head_kind: 'arvados#group',
 383                               link_class: 'permission',
 384                               name: 'can_read')
 385
 386       if !group_perms.any?
 387         group_perm = Link.create(tail_kind: 'arvados#user',
 388                                  tail_uuid: self.uuid,
 389                                  head_kind: 'arvados#group',
 390                                  head_uuid: group[:uuid],
 391                                  link_class: 'permission',
 392                                  name: 'can_read')
 393         logger.info { "group permission: " + group_perm[:uuid] }
 394       else
 395         group_perm = group_perms.first
 396       end
 397
 398       return group_perm
 399     end
 400   end
 401
 402   # Give the special "System group" permission to manage this user and
 403   # all of this user's stuff.
 404   #
 405   def add_system_group_permission_link
 406     act_as_system_user do
 407       Link.create(link_class: 'permission',
 408                   name: 'can_manage',
 409                   tail_kind: 'arvados#group',
 410                   tail_uuid: system_group_uuid,
 411                   head_kind: 'arvados#user',
 412                   head_uuid: self.uuid)
 413     end
 414   end
 415 end