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