services/api/app/models/user.rb

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