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