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     if user[:uuid]
 115       found = User.find_by_uuid user[:uuid]
 116     end
 117
 118     if !found
 119       if !user[:email]
 120         raise "No email found in the input. Aborting user creation."
 121       end
 122
 123       if !user.save
 124         raise "Save failed"
 125       end
 126     else
 127       user = found
 128     end
 129
 130     # Check opd_login_perm
 131     oid_login_perm = Link.where(tail_uuid: user[:email],
 132                                 head_kind: 'arvados#user',
 133                                 link_class: 'permission',
 134                                 name: 'can_login')
 135
 136     if !oid_login_perm.any?
 137       # create openid login permission
 138       oid_login_perm = Link.create(link_class: 'permission',
 139                                    name: 'can_login',
 140                                    tail_kind: 'email',
 141                                    tail_uuid: user[:email],
 142                                    head_kind: 'arvados#user',
 143                                    head_uuid: user[:uuid],
 144                                    properties: login_perm_props
 145                                   )
 146       logger.info { "openid login permission: " + oid_login_perm[:uuid] }
 147     end
 148
 149     # create repo, vm, and group links
 150     response = {user: user, oid_login_perm: oid_login_perm}
 151
 152     user.setup_links(repo_name, vm_uuid, openid_prefix, response)
 153
 154     return response
 155   end
 156
 157   # create links
 158   def setup_links(repo_name, vm_uuid, openid_prefix, response)
 159     repo_perm = create_user_repo_link repo_name
 160     if repo_perm
 161       response[:repo_perm] = repo_perm
 162     end
 163
 164     vm_login_perm = create_vm_login_permission_link vm_uuid, repo_name
 165     if vm_login_perm
 166       response[:vm_login_perm] = vm_login_perm
 167     end
 168
 169     group_perm = create_user_group_links
 170     if group_perm
 171       response[:group_perm] = group_perm
 172     end
 173   end
 174
 175   protected
 176
 177   def permission_to_update
 178     # users must be able to update themselves (even if they are
 179     # inactive) in order to create sessions
 180     self == current_user or super
 181   end
 182
 183   def permission_to_create
 184     current_user.andand.is_admin or
 185       (self == current_user and
 186        self.is_active == Rails.configuration.new_users_are_active)
 187   end
 188
 189   def check_auto_admin
 190     if User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and Rails.configuration.auto_admin_user
 191       if current_user.email == Rails.configuration.auto_admin_user
 192         self.is_admin = true
 193         self.is_active = true
 194       end
 195     end
 196   end
 197
 198   def prevent_privilege_escalation
 199     if current_user.andand.is_admin
 200       return true
 201     end
 202     if self.is_active_changed?
 203       if self.is_active != self.is_active_was
 204         logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
 205         self.is_active = self.is_active_was
 206       end
 207     end
 208     if self.is_admin_changed?
 209       if self.is_admin != self.is_admin_was
 210         logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
 211         self.is_admin = self.is_admin_was
 212       end
 213     end
 214     true
 215   end
 216
 217   def prevent_inactive_admin
 218     if self.is_admin and not self.is_active
 219       # There is no known use case for the strange set of permissions
 220       # that would result from this change. It's safest to assume it's
 221       # a mistake and disallow it outright.
 222       raise "Admin users cannot be inactive"
 223     end
 224     true
 225   end
 226
 227   def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
 228     nextpaths = graph[start]
 229     return merged if !nextpaths
 230     return merged if upstream_path.has_key? start
 231     upstream_path[start] = true
 232     upstream_mask ||= ALL_PERMISSIONS
 233     nextpaths.each do |head, mask|
 234       merged[head] ||= {}
 235       mask.each do |k,v|
 236         merged[head][k] ||= v if upstream_mask[k]
 237       end
 238       search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
 239     end
 240     upstream_path.delete start
 241     merged
 242   end
 243
 244   def create_user_repo_link(repo_name)
 245     # repo_name is optional
 246     if not repo_name
 247       logger.warn ("Repository name not given for #{self.uuid}.")
 248       return
 249     end
 250
 251     # Check for an existing repository with the same name we're about to use.
 252     repo = Repository.where(name: repo_name).first
 253
 254     if repo
 255       logger.warn "Repository exists for #{repo_name}: #{repo[:uuid]}."
 256
 257       # Look for existing repository access for this repo
 258       repo_perms = Link.where(tail_uuid: self.uuid,
 259                               head_kind: 'arvados#repository',
 260                               head_uuid: repo[:uuid],
 261                               link_class: 'permission',
 262                               name: 'can_write')
 263       if repo_perms.any?
 264         logger.warn "User already has repository access " +
 265             repo_perms.collect { |p| p[:uuid] }.inspect
 266         return repo_perms.first
 267       end
 268     end
 269
 270     # create repo, if does not already exist
 271     repo ||= Repository.create(name: repo_name)
 272     logger.info { "repo uuid: " + repo[:uuid] }
 273
 274     repo_perm = Link.create(tail_kind: 'arvados#user',
 275                             tail_uuid: self.uuid,
 276                             head_kind: 'arvados#repository',
 277                             head_uuid: repo[:uuid],
 278                             link_class: 'permission',
 279                             name: 'can_write')
 280     logger.info { "repo permission: " + repo_perm[:uuid] }
 281     return repo_perm
 282   end
 283
 284   # create login permission for the given vm_uuid, if it does not already exist
 285   def create_vm_login_permission_link(vm_uuid, repo_name)
 286     begin
 287
 288       # vm uuid is optional
 289       if vm_uuid
 290         vm = VirtualMachine.where(uuid: vm_uuid).first
 291
 292         if not vm
 293           logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
 294           raise "No vm found for #{vm_uuid}"
 295         end
 296       else
 297         return
 298       end
 299
 300       logger.info { "vm uuid: " + vm[:uuid] }
 301
 302       login_perm = Link.where(tail_uuid: self.uuid,
 303                               head_uuid: vm[:uuid],
 304                               head_kind: 'arvados#virtualMachine',
 305                               link_class: 'permission',
 306                               name: 'can_login')
 307       if !login_perm.any?
 308         login_perm = Link.create(tail_kind: 'arvados#user',
 309                                  tail_uuid: self.uuid,
 310                                  head_kind: 'arvados#virtualMachine',
 311                                  head_uuid: vm[:uuid],
 312                                  link_class: 'permission',
 313                                  name: 'can_login',
 314                                  properties: {username: repo_name})
 315         logger.info { "login permission: " + login_perm[:uuid] }
 316       end
 317
 318       return login_perm
 319     end
 320   end
 321
 322   # add the user to the 'All users' group
 323   def create_user_group_links
 324     # Look up the "All users" group (we expect uuid *-*-fffffffffffffff).
 325     group = Group.where(name: 'All users').select do |g|
 326       g[:uuid].match /-f+$/
 327     end.first
 328
 329     if not group
 330       logger.warn "No 'All users' group with uuid '*-*-fffffffffffffff'."
 331       raise "No 'All users' group with uuid '*-*-fffffffffffffff' is found"
 332     else
 333       logger.info { "\"All users\" group uuid: " + group[:uuid] }
 334
 335       group_perm = Link.where(tail_uuid: self.uuid,
 336                               head_uuid: group[:uuid],
 337                               head_kind: 'arvados#group',
 338                               link_class: 'permission',
 339                               name: 'can_read')
 340
 341       if !group_perm.any?
 342         group_perm = Link.create(tail_kind: 'arvados#user',
 343                                  tail_uuid: self.uuid,
 344                                  head_kind: 'arvados#group',
 345                                  head_uuid: group[:uuid],
 346                                  link_class: 'permission',
 347                                  name: 'can_read')
 348         logger.info { "group permission: " + group_perm[:uuid] }
 349       end
 350
 351       return group_perm
 352     end
 353   end
 354
 355 end