services/api/app/models/user.rb

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 require 'can_be_an_owner'
   6 require 'refresh_permission_view'
   7
   8 class User < ArvadosModel
   9   include HasUuid
  10   include KindAndEtag
  11   include CommonApiTemplate
  12   include CanBeAnOwner
  13
  14   serialize :prefs, Hash
  15   has_many :api_client_authorizations
  16   validates(:username,
  17             format: {
  18               with: /\A[A-Za-z][A-Za-z0-9]*\z/,
  19               message: "must begin with a letter and contain only alphanumerics",
  20             },
  21             uniqueness: true,
  22             allow_nil: true)
  23   before_update :prevent_privilege_escalation
  24   before_update :prevent_inactive_admin
  25   before_update :verify_repositories_empty, :if => Proc.new { |user|
  26     user.username.nil? and user.username_changed?
  27   }
  28   before_update :setup_on_activate
  29   before_create :check_auto_admin
  30   before_create :set_initial_username, :if => Proc.new { |user|
  31     user.username.nil? and user.email
  32   }
  33   after_create :add_system_group_permission_link
  34   after_create :invalidate_permissions_cache
  35   after_create :auto_setup_new_user, :if => Proc.new { |user|
  36     Rails.configuration.auto_setup_new_users and
  37     (user.uuid != system_user_uuid) and
  38     (user.uuid != anonymous_user_uuid)
  39   }
  40   after_create :send_admin_notifications
  41   after_update :send_profile_created_notification
  42   after_update :sync_repository_names, :if => Proc.new { |user|
  43     (user.uuid != system_user_uuid) and
  44     user.username_changed? and
  45     (not user.username_was.nil?)
  46   }
  47
  48   has_many :authorized_keys, :foreign_key => :authorized_user_uuid, :primary_key => :uuid
  49   has_many :repositories, foreign_key: :owner_uuid, primary_key: :uuid
  50
  51   api_accessible :user, extend: :common do |t|
  52     t.add :email
  53     t.add :username
  54     t.add :full_name
  55     t.add :first_name
  56     t.add :last_name
  57     t.add :identity_url
  58     t.add :is_active
  59     t.add :is_admin
  60     t.add :is_invited
  61     t.add :prefs
  62     t.add :writable_by
  63   end
  64
  65   ALL_PERMISSIONS = {read: true, write: true, manage: true}
  66
  67   # Map numeric permission levels (see lib/create_permission_view.sql)
  68   # back to read/write/manage flags.
  69   PERMS_FOR_VAL =
  70     [{},
  71      {read: true},
  72      {read: true, write: true},
  73      {read: true, write: true, manage: true}]
  74
  75   def full_name
  76     "#{first_name} #{last_name}".strip
  77   end
  78
  79   def is_invited
  80     !!(self.is_active ||
  81        Rails.configuration.new_users_are_active ||
  82        self.groups_i_can(:read).select { |x| x.match(/-f+$/) }.first)
  83   end
  84
  85   def groups_i_can(verb)
  86     my_groups = self.group_permissions.select { |uuid, mask| mask[verb] }.keys
  87     if verb == :read
  88       my_groups << anonymous_group_uuid
  89     end
  90     my_groups
  91   end
  92
  93   def can?(actions)
  94     return true if is_admin
  95     actions.each do |action, target|
  96       unless target.nil?
  97         if target.respond_to? :uuid
  98           target_uuid = target.uuid
  99         else
 100           target_uuid = target
 101           target = ArvadosModel.find_by_uuid(target_uuid)
 102         end
 103       end
 104       next if target_uuid == self.uuid
 105       next if (group_permissions[target_uuid] and
 106                group_permissions[target_uuid][action])
 107       if target.respond_to? :owner_uuid
 108         next if target.owner_uuid == self.uuid
 109         next if (group_permissions[target.owner_uuid] and
 110                  group_permissions[target.owner_uuid][action])
 111       end
 112       sufficient_perms = case action
 113                          when :manage
 114                            ['can_manage']
 115                          when :write
 116                            ['can_manage', 'can_write']
 117                          when :read
 118                            ['can_manage', 'can_write', 'can_read']
 119                          else
 120                            # (Skip this kind of permission opportunity
 121                            # if action is an unknown permission type)
 122                          end
 123       if sufficient_perms
 124         # Check permission links with head_uuid pointing directly at
 125         # the target object. If target is a Group, this is redundant
 126         # and will fail except [a] if permission caching is broken or
 127         # [b] during a race condition, where a permission link has
 128         # *just* been added.
 129         if Link.where(link_class: 'permission',
 130                       name: sufficient_perms,
 131                       tail_uuid: groups_i_can(action) + [self.uuid],
 132                       head_uuid: target_uuid).any?
 133           next
 134         end
 135       end
 136       return false
 137     end
 138     true
 139   end
 140
 141   def self.invalidate_permissions_cache(timestamp=nil)
 142     if Rails.configuration.async_permissions_update
 143       timestamp = DbCurrentTime::db_current_time.to_i if timestamp.nil?
 144       connection.execute "NOTIFY invalidate_permissions_cache, '#{timestamp}'"
 145     else
 146       refresh_permission_view
 147     end
 148   end
 149
 150   def invalidate_permissions_cache(timestamp=nil)
 151     User.invalidate_permissions_cache
 152   end
 153
 154   # Return a hash of {user_uuid: group_perms}
 155   def self.all_group_permissions
 156     all_perms = {}
 157     ActiveRecord::Base.connection.
 158       exec_query("SELECT user_uuid, target_owner_uuid, perm_level, trashed
 159                   FROM #{PERMISSION_VIEW}
 160                   WHERE target_owner_uuid IS NOT NULL",
 161                   # "name" arg is a query label that appears in logs:
 162                   "all_group_permissions",
 163                   ).rows.each do |user_uuid, group_uuid, max_p_val, trashed|
 164       all_perms[user_uuid] ||= {}
 165       all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
 166     end
 167     all_perms
 168   end
 169
 170   # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
 171   # and perm_hash[:write] are true if this user can read and write
 172   # objects owned by group_uuid.
 173   def group_permissions
 174     group_perms = {self.uuid => {:read => true, :write => true, :manage => true}}
 175     ActiveRecord::Base.connection.
 176       exec_query("SELECT target_owner_uuid, perm_level, trashed
 177                   FROM #{PERMISSION_VIEW}
 178                   WHERE user_uuid = $1
 179                   AND target_owner_uuid IS NOT NULL",
 180                   # "name" arg is a query label that appears in logs:
 181                   "group_permissions for #{uuid}",
 182                   # "binds" arg is an array of [col_id, value] for '$1' vars:
 183                   [[nil, uuid]],
 184                 ).rows.each do |group_uuid, max_p_val, trashed|
 185       group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
 186     end
 187     group_perms
 188   end
 189
 190   # create links
 191   def setup(openid_prefix:, repo_name: nil, vm_uuid: nil)
 192     oid_login_perm = create_oid_login_perm openid_prefix
 193     repo_perm = create_user_repo_link repo_name
 194     vm_login_perm = create_vm_login_permission_link(vm_uuid, username) if vm_uuid
 195     group_perm = create_user_group_link
 196
 197     return [oid_login_perm, repo_perm, vm_login_perm, group_perm, self].compact
 198   end
 199
 200   # delete user signatures, login, repo, and vm perms, and mark as inactive
 201   def unsetup
 202     # delete oid_login_perms for this user
 203     Link.destroy_all(tail_uuid: self.email,
 204                      link_class: 'permission',
 205                      name: 'can_login')
 206
 207     # delete repo_perms for this user
 208     Link.destroy_all(tail_uuid: self.uuid,
 209                      link_class: 'permission',
 210                      name: 'can_manage')
 211
 212     # delete vm_login_perms for this user
 213     Link.destroy_all(tail_uuid: self.uuid,
 214                      link_class: 'permission',
 215                      name: 'can_login')
 216
 217     # delete "All users" group read permissions for this user
 218     group = Group.where(name: 'All users').select do |g|
 219       g[:uuid].match(/-f+$/)
 220     end.first
 221     Link.destroy_all(tail_uuid: self.uuid,
 222                      head_uuid: group[:uuid],
 223                      link_class: 'permission',
 224                      name: 'can_read')
 225
 226     # delete any signatures by this user
 227     Link.destroy_all(link_class: 'signature',
 228                      tail_uuid: self.uuid)
 229
 230     # delete user preferences (including profile)
 231     self.prefs = {}
 232
 233     # mark the user as inactive
 234     self.is_active = false
 235     self.save!
 236   end
 237
 238   def set_initial_username(requested: false)
 239     if !requested.is_a?(String) || requested.empty?
 240       email_parts = email.partition("@")
 241       local_parts = email_parts.first.partition("+")
 242       if email_parts.any?(&:empty?)
 243         return
 244       elsif not local_parts.first.empty?
 245         requested = local_parts.first
 246       else
 247         requested = email_parts.first
 248       end
 249     end
 250     requested.sub!(/^[^A-Za-z]+/, "")
 251     requested.gsub!(/[^A-Za-z0-9]/, "")
 252     unless requested.empty?
 253       self.username = find_usable_username_from(requested)
 254     end
 255   end
 256
 257   protected
 258
 259   def ensure_ownership_path_leads_to_user
 260     true
 261   end
 262
 263   def permission_to_update
 264     if username_changed?
 265       current_user.andand.is_admin
 266     else
 267       # users must be able to update themselves (even if they are
 268       # inactive) in order to create sessions
 269       self == current_user or super
 270     end
 271   end
 272
 273   def permission_to_create
 274     current_user.andand.is_admin or
 275       (self == current_user and
 276        self.is_active == Rails.configuration.new_users_are_active)
 277   end
 278
 279   def check_auto_admin
 280     return if self.uuid.end_with?('anonymouspublic')
 281     if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
 282         Rails.configuration.auto_admin_user and self.email == Rails.configuration.auto_admin_user) or
 283        (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
 284         Rails.configuration.auto_admin_first_user)
 285       self.is_admin = true
 286       self.is_active = true
 287     end
 288   end
 289
 290   def find_usable_username_from(basename)
 291     # If "basename" is a usable username, return that.
 292     # Otherwise, find a unique username "basenameN", where N is the
 293     # smallest integer greater than 1, and return that.
 294     # Return nil if a unique username can't be found after reasonable
 295     # searching.
 296     quoted_name = self.class.connection.quote_string(basename)
 297     next_username = basename
 298     next_suffix = 1
 299     while Rails.configuration.auto_setup_name_blacklist.include?(next_username)
 300       next_suffix += 1
 301       next_username = "%s%i" % [basename, next_suffix]
 302     end
 303     0.upto(6).each do |suffix_len|
 304       pattern = "%s%s" % [quoted_name, "_" * suffix_len]
 305       self.class.
 306           where("username like '#{pattern}'").
 307           select(:username).
 308           order('username asc').
 309           each do |other_user|
 310         if other_user.username > next_username
 311           break
 312         elsif other_user.username == next_username
 313           next_suffix += 1
 314           next_username = "%s%i" % [basename, next_suffix]
 315         end
 316       end
 317       return next_username if (next_username.size <= pattern.size)
 318     end
 319     nil
 320   end
 321
 322   def prevent_privilege_escalation
 323     if current_user.andand.is_admin
 324       return true
 325     end
 326     if self.is_active_changed?
 327       if self.is_active != self.is_active_was
 328         logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
 329         self.is_active = self.is_active_was
 330       end
 331     end
 332     if self.is_admin_changed?
 333       if self.is_admin != self.is_admin_was
 334         logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
 335         self.is_admin = self.is_admin_was
 336       end
 337     end
 338     true
 339   end
 340
 341   def prevent_inactive_admin
 342     if self.is_admin and not self.is_active
 343       # There is no known use case for the strange set of permissions
 344       # that would result from this change. It's safest to assume it's
 345       # a mistake and disallow it outright.
 346       raise "Admin users cannot be inactive"
 347     end
 348     true
 349   end
 350
 351   def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
 352     nextpaths = graph[start]
 353     return merged if !nextpaths
 354     return merged if upstream_path.has_key? start
 355     upstream_path[start] = true
 356     upstream_mask ||= ALL_PERMISSIONS
 357     nextpaths.each do |head, mask|
 358       merged[head] ||= {}
 359       mask.each do |k,v|
 360         merged[head][k] ||= v if upstream_mask[k]
 361       end
 362       search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
 363     end
 364     upstream_path.delete start
 365     merged
 366   end
 367
 368   def create_oid_login_perm(openid_prefix)
 369     # Check oid_login_perm
 370     oid_login_perms = Link.where(tail_uuid: self.email,
 371                                  head_uuid: self.uuid,
 372                                  link_class: 'permission',
 373                                  name: 'can_login')
 374
 375     if !oid_login_perms.any?
 376       # create openid login permission
 377       oid_login_perm = Link.create(link_class: 'permission',
 378                                    name: 'can_login',
 379                                    tail_uuid: self.email,
 380                                    head_uuid: self.uuid,
 381                                    properties: {
 382                                      "identity_url_prefix" => openid_prefix,
 383                                    })
 384       logger.info { "openid login permission: " + oid_login_perm[:uuid] }
 385     else
 386       oid_login_perm = oid_login_perms.first
 387     end
 388
 389     return oid_login_perm
 390   end
 391
 392   def create_user_repo_link(repo_name)
 393     # repo_name is optional
 394     if not repo_name
 395       logger.warn ("Repository name not given for #{self.uuid}.")
 396       return
 397     end
 398
 399     repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
 400     logger.info { "repo uuid: " + repo[:uuid] }
 401     repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
 402                            link_class: "permission",
 403                            name: "can_manage").first_or_create!
 404     logger.info { "repo permission: " + repo_perm[:uuid] }
 405     return repo_perm
 406   end
 407
 408   # create login permission for the given vm_uuid, if it does not already exist
 409   def create_vm_login_permission_link(vm_uuid, repo_name)
 410     # vm uuid is optional
 411     return if !vm_uuid
 412
 413     vm = VirtualMachine.where(uuid: vm_uuid).first
 414     if !vm
 415       logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
 416       raise "No vm found for #{vm_uuid}"
 417     end
 418
 419     logger.info { "vm uuid: " + vm[:uuid] }
 420     login_attrs = {
 421       tail_uuid: uuid, head_uuid: vm.uuid,
 422       link_class: "permission", name: "can_login",
 423     }
 424
 425     login_perm = Link.
 426       where(login_attrs).
 427       select { |link| link.properties["username"] == repo_name }.
 428       first
 429
 430     login_perm ||= Link.
 431       create(login_attrs.merge(properties: {"username" => repo_name}))
 432
 433     logger.info { "login permission: " + login_perm[:uuid] }
 434     login_perm
 435   end
 436
 437   # add the user to the 'All users' group
 438   def create_user_group_link
 439     return (Link.where(tail_uuid: self.uuid,
 440                        head_uuid: all_users_group[:uuid],
 441                        link_class: 'permission',
 442                        name: 'can_read').first or
 443             Link.create(tail_uuid: self.uuid,
 444                         head_uuid: all_users_group[:uuid],
 445                         link_class: 'permission',
 446                         name: 'can_read'))
 447   end
 448
 449   # Give the special "System group" permission to manage this user and
 450   # all of this user's stuff.
 451   def add_system_group_permission_link
 452     return true if uuid == system_user_uuid
 453     act_as_system_user do
 454       Link.create(link_class: 'permission',
 455                   name: 'can_manage',
 456                   tail_uuid: system_group_uuid,
 457                   head_uuid: self.uuid)
 458     end
 459   end
 460
 461   # Send admin notifications
 462   def send_admin_notifications
 463     AdminNotifier.new_user(self).deliver_now
 464     if not self.is_active then
 465       AdminNotifier.new_inactive_user(self).deliver_now
 466     end
 467   end
 468
 469   # Automatically setup if is_active flag turns on
 470   def setup_on_activate
 471     return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
 472     if is_active && (new_record? || is_active_changed?)
 473       setup(openid_prefix: Rails.configuration.default_openid_prefix)
 474     end
 475   end
 476
 477   # Automatically setup new user during creation
 478   def auto_setup_new_user
 479     setup(openid_prefix: Rails.configuration.default_openid_prefix)
 480     if username
 481       create_vm_login_permission_link(Rails.configuration.auto_setup_new_users_with_vm_uuid,
 482                                       username)
 483       repo_name = "#{username}/#{username}"
 484       if Rails.configuration.auto_setup_new_users_with_repository and
 485           Repository.where(name: repo_name).first.nil?
 486         repo = Repository.create!(name: repo_name, owner_uuid: uuid)
 487         Link.create!(tail_uuid: uuid, head_uuid: repo.uuid,
 488                      link_class: "permission", name: "can_manage")
 489       end
 490     end
 491   end
 492
 493   # Send notification if the user saved profile for the first time
 494   def send_profile_created_notification
 495     if self.prefs_changed?
 496       if self.prefs_was.andand.empty? || !self.prefs_was.andand['profile']
 497         profile_notification_address = Rails.configuration.user_profile_notification_address
 498         ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address
 499       end
 500     end
 501   end
 502
 503   def verify_repositories_empty
 504     unless repositories.first.nil?
 505       errors.add(:username, "can't be unset when the user owns repositories")
 506       false
 507     end
 508   end
 509
 510   def sync_repository_names
 511     old_name_re = /^#{Regexp.escape(username_was)}\//
 512     name_sub = "#{username}/"
 513     repositories.find_each do |repo|
 514       repo.name = repo.name.sub(old_name_re, name_sub)
 515       repo.save!
 516     end
 517   end
 518 end