X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/5bcba288077488791daa43a15d5fd5fb0c6e653c..e22d3dc998f55e3c21125b1a1be7240f89c23dd6:/services/api/app/models/user.rb diff --git a/services/api/app/models/user.rb b/services/api/app/models/user.rb index a32ce39299..8ab8ea1d85 100644 --- a/services/api/app/models/user.rb +++ b/services/api/app/models/user.rb @@ -1,4 +1,9 @@ +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: AGPL-3.0 + require 'can_be_an_owner' +require 'refresh_permission_view' class User < ArvadosModel include HasUuid @@ -8,19 +13,47 @@ class User < ArvadosModel serialize :prefs, Hash has_many :api_client_authorizations + validates(:username, + format: { + with: /\A[A-Za-z][A-Za-z0-9]*\z/, + message: "must begin with a letter and contain only alphanumerics", + }, + uniqueness: true, + allow_nil: true) before_update :prevent_privilege_escalation before_update :prevent_inactive_admin + before_update :verify_repositories_empty, :if => Proc.new { |user| + user.username.nil? and user.username_changed? + } + before_update :setup_on_activate before_create :check_auto_admin + before_create :set_initial_username, :if => Proc.new { |user| + user.username.nil? and user.email + } + after_create :setup_on_activate after_create :add_system_group_permission_link - after_create :auto_setup_new_user + after_create :invalidate_permissions_cache + after_create :auto_setup_new_user, :if => Proc.new { |user| + Rails.configuration.Users.AutoSetupNewUsers and + (user.uuid != system_user_uuid) and + (user.uuid != anonymous_user_uuid) + } after_create :send_admin_notifications after_update :send_profile_created_notification - + after_update :sync_repository_names, :if => Proc.new { |user| + (user.uuid != system_user_uuid) and + user.username_changed? and + (not user.username_was.nil?) + } has_many :authorized_keys, :foreign_key => :authorized_user_uuid, :primary_key => :uuid + has_many :repositories, foreign_key: :owner_uuid, primary_key: :uuid + + default_scope { where('redirect_to_user_uuid is null') } api_accessible :user, extend: :common do |t| t.add :email + t.add :username t.add :full_name t.add :first_name t.add :last_name @@ -34,14 +67,22 @@ class User < ArvadosModel ALL_PERMISSIONS = {read: true, write: true, manage: true} + # Map numeric permission levels (see lib/create_permission_view.sql) + # back to read/write/manage flags. + PERMS_FOR_VAL = + [{}, + {read: true}, + {read: true, write: true}, + {read: true, write: true, manage: true}] + def full_name "#{first_name} #{last_name}".strip end def is_invited !!(self.is_active || - Rails.configuration.new_users_are_active || - self.groups_i_can(:read).select { |x| x.match /-f+$/ }.first) + Rails.configuration.Users.NewUsersAreActive || + self.groups_i_can(:read).select { |x| x.match(/-f+$/) }.first) end def groups_i_can(verb) @@ -100,78 +141,55 @@ class User < ArvadosModel true end - def self.invalidate_permissions_cache - Rails.cache.delete_matched(/^groups_for_user_/) + def self.invalidate_permissions_cache(async=false) + refresh_permission_view(async) + end + + def invalidate_permissions_cache + User.invalidate_permissions_cache + end + + # Return a hash of {user_uuid: group_perms} + def self.all_group_permissions + all_perms = {} + ActiveRecord::Base.connection. + exec_query("SELECT user_uuid, target_owner_uuid, perm_level, trashed + FROM #{PERMISSION_VIEW} + WHERE target_owner_uuid IS NOT NULL", + # "name" arg is a query label that appears in logs: + "all_group_permissions", + ).rows.each do |user_uuid, group_uuid, max_p_val, trashed| + all_perms[user_uuid] ||= {} + all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i] + end + all_perms end # Return a hash of {group_uuid: perm_hash} where perm_hash[:read] # and perm_hash[:write] are true if this user can read and write # objects owned by group_uuid. - # - # The permission graph is built by repeatedly enumerating all - # permission links reachable from self.uuid, and then calling - # search_permissions def group_permissions - Rails.cache.fetch "groups_for_user_#{self.uuid}" do - permissions_from = {} - todo = {self.uuid => true} - done = {} - # Build the equivalence class of permissions starting with - # self.uuid. On each iteration of this loop, todo contains - # the next set of uuids in the permission equivalence class - # to evaluate. - while !todo.empty? - lookup_uuids = todo.keys - lookup_uuids.each do |uuid| done[uuid] = true end - todo = {} - newgroups = [] - # include all groups owned by the current set of uuids. - Group.where('owner_uuid in (?)', lookup_uuids).each do |group| - newgroups << [group.owner_uuid, group.uuid, 'can_manage'] - end - # add any permission links from the current lookup_uuids to a Group. - Link.where('link_class = ? and tail_uuid in (?) and ' \ - '(head_uuid like ? or (name = ? and head_uuid like ?))', - 'permission', - lookup_uuids, - Group.uuid_like_pattern, - 'can_manage', - User.uuid_like_pattern).each do |link| - newgroups << [link.tail_uuid, link.head_uuid, link.name] - end - newgroups.each do |tail_uuid, head_uuid, perm_name| - unless done.has_key? head_uuid - todo[head_uuid] = true - end - link_permissions = {} - case perm_name - when 'can_read' - link_permissions = {read:true} - when 'can_write' - link_permissions = {read:true,write:true} - when 'can_manage' - link_permissions = ALL_PERMISSIONS - end - permissions_from[tail_uuid] ||= {} - permissions_from[tail_uuid][head_uuid] ||= {} - link_permissions.each do |k,v| - permissions_from[tail_uuid][head_uuid][k] ||= v - end - end - end - search_permissions(self.uuid, permissions_from) + group_perms = {self.uuid => {:read => true, :write => true, :manage => true}} + ActiveRecord::Base.connection. + exec_query("SELECT target_owner_uuid, perm_level, trashed + FROM #{PERMISSION_VIEW} + WHERE user_uuid = $1 + AND target_owner_uuid IS NOT NULL", + # "name" arg is a query label that appears in logs: + "group_permissions for #{uuid}", + # "binds" arg is an array of [col_id, value] for '$1' vars: + [[nil, uuid]], + ).rows.each do |group_uuid, max_p_val, trashed| + group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i] end - end - - def self.setup(user, openid_prefix, repo_name=nil, vm_uuid=nil) - return user.setup_repo_vm_links(repo_name, vm_uuid, openid_prefix) + group_perms end # create links - def setup_repo_vm_links(repo_name, vm_uuid, openid_prefix) + def setup(openid_prefix:, repo_name: nil, vm_uuid: nil) oid_login_perm = create_oid_login_perm openid_prefix repo_perm = create_user_repo_link repo_name - vm_login_perm = create_vm_login_permission_link vm_uuid, repo_name + vm_login_perm = create_vm_login_permission_link(vm_uuid, username) if vm_uuid group_perm = create_user_group_link return [oid_login_perm, repo_perm, vm_login_perm, group_perm, self].compact @@ -180,32 +198,32 @@ class User < ArvadosModel # delete user signatures, login, repo, and vm perms, and mark as inactive def unsetup # delete oid_login_perms for this user - Link.destroy_all(tail_uuid: self.email, + Link.where(tail_uuid: self.email, link_class: 'permission', - name: 'can_login') + name: 'can_login').destroy_all # delete repo_perms for this user - Link.destroy_all(tail_uuid: self.uuid, + Link.where(tail_uuid: self.uuid, link_class: 'permission', - name: 'can_manage') + name: 'can_manage').destroy_all # delete vm_login_perms for this user - Link.destroy_all(tail_uuid: self.uuid, + Link.where(tail_uuid: self.uuid, link_class: 'permission', - name: 'can_login') + name: 'can_login').destroy_all # delete "All users" group read permissions for this user group = Group.where(name: 'All users').select do |g| - g[:uuid].match /-f+$/ + g[:uuid].match(/-f+$/) end.first - Link.destroy_all(tail_uuid: self.uuid, + Link.where(tail_uuid: self.uuid, head_uuid: group[:uuid], link_class: 'permission', - name: 'can_read') + name: 'can_read').destroy_all # delete any signatures by this user - Link.destroy_all(link_class: 'signature', - tail_uuid: self.uuid) + Link.where(link_class: 'signature', + tail_uuid: self.uuid).destroy_all # delete user preferences (including profile) self.prefs = {} @@ -215,42 +233,268 @@ class User < ArvadosModel self.save! end + def set_initial_username(requested: false) + if !requested.is_a?(String) || requested.empty? + email_parts = email.partition("@") + local_parts = email_parts.first.partition("+") + if email_parts.any?(&:empty?) + return + elsif not local_parts.first.empty? + requested = local_parts.first + else + requested = email_parts.first + end + end + requested.sub!(/^[^A-Za-z]+/, "") + requested.gsub!(/[^A-Za-z0-9]/, "") + unless requested.empty? + self.username = find_usable_username_from(requested) + end + end + + def update_uuid(new_uuid:) + if !current_user.andand.is_admin + raise PermissionDeniedError + end + if uuid == system_user_uuid || uuid == anonymous_user_uuid + raise "update_uuid cannot update system accounts" + end + if self.class != self.class.resource_class_for_uuid(new_uuid) + raise "invalid new_uuid #{new_uuid.inspect}" + end + transaction(requires_new: true) do + reload + old_uuid = self.uuid + self.uuid = new_uuid + save!(validate: false) + change_all_uuid_refs(old_uuid: old_uuid, new_uuid: new_uuid) + end + end + + # Move this user's (i.e., self's) owned items into new_owner_uuid. + # Also redirect future uses of this account to + # redirect_to_user_uuid, i.e., when a caller authenticates to this + # account in the future, the account redirect_to_user_uuid account + # will be used instead. + # + # current_user must have admin privileges, i.e., the caller is + # responsible for checking permission to do this. + def merge(new_owner_uuid:, redirect_to_user_uuid:) + raise PermissionDeniedError if !current_user.andand.is_admin + raise "not implemented" if !redirect_to_user_uuid + transaction(requires_new: true) do + reload + raise "cannot merge an already merged user" if self.redirect_to_user_uuid + + new_user = User.where(uuid: redirect_to_user_uuid).first + raise "user does not exist" if !new_user + raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid + + # Existing API tokens are updated to authenticate to the new + # user. + ApiClientAuthorization. + where(user_id: id). + update_all(user_id: new_user.id) + + # References to the old user UUID in the context of a user ID + # (rather than a "home project" in the project hierarchy) are + # updated to point to the new user. + [ + [AuthorizedKey, :owner_uuid], + [AuthorizedKey, :authorized_user_uuid], + [Repository, :owner_uuid], + [Link, :owner_uuid], + [Link, :tail_uuid], + [Link, :head_uuid], + ].each do |klass, column| + klass.where(column => uuid).update_all(column => new_user.uuid) + end + + # References to the merged user's "home project" are updated to + # point to new_owner_uuid. + ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass| + next if [ApiClientAuthorization, + AuthorizedKey, + Link, + Log, + Repository].include?(klass) + next if !klass.columns.collect(&:name).include?('owner_uuid') + klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid) + end + + update_attributes!(redirect_to_user_uuid: new_user.uuid) + invalidate_permissions_cache + end + end + + def redirects_to + user = self + redirects = 0 + while (uuid = user.redirect_to_user_uuid) + user = User.unscoped.find_by_uuid(uuid) + if !user + raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid #{uuid}") + end + redirects += 1 + if redirects > 15 + raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects" + end + end + user + end + + def self.register info + # login info expected fields, all can be optional but at minimum + # must supply either 'identity_url' or 'email' + # + # email + # first_name + # last_name + # username + # alternate_emails + # identity_url + + info = info.with_indifferent_access + + primary_user = nil + + # local database + identity_url = info['identity_url'] + + if identity_url && identity_url.length > 0 + # Only local users can create sessions, hence uuid_like_pattern + # here. + user = User.unscoped.where('identity_url = ? and uuid like ?', + identity_url, + User.uuid_like_pattern).first + primary_user = user.redirects_to if user + end + + if !primary_user + # identity url is unset or didn't find matching record. + emails = [info['email']] + (info['alternate_emails'] || []) + emails.select! {|em| !em.nil? && !em.empty?} + + User.unscoped.where('email in (?) and uuid like ?', + emails, + User.uuid_like_pattern).each do |user| + if !primary_user + primary_user = user.redirects_to + elsif primary_user.uuid != user.redirects_to.uuid + raise "Ambigious email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}" + end + end + end + + if !primary_user + # New user registration + primary_user = User.new(:owner_uuid => system_user_uuid, + :is_admin => false, + :is_active => Rails.configuration.Users.NewUsersAreActive) + + primary_user.set_initial_username(requested: info['username']) if info['username'] + primary_user.identity_url = info['identity_url'] if identity_url + end + + primary_user.email = info['email'] if info['email'] + primary_user.first_name = info['first_name'] if info['first_name'] + primary_user.last_name = info['last_name'] if info['last_name'] + + if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?) + raise "Must have supply at least one of 'email' or 'identity_url' to User.register" + end + + act_as_system_user do + primary_user.save! + end + + primary_user + end + protected + def change_all_uuid_refs(old_uuid:, new_uuid:) + ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass| + klass.columns.each do |col| + if col.name.end_with?('_uuid') + column = col.name.to_sym + klass.where(column => old_uuid).update_all(column => new_uuid) + end + end + end + end + def ensure_ownership_path_leads_to_user true end def permission_to_update - # users must be able to update themselves (even if they are - # inactive) in order to create sessions - self == current_user or super + if username_changed? || redirect_to_user_uuid_changed? || email_changed? + current_user.andand.is_admin + else + # users must be able to update themselves (even if they are + # inactive) in order to create sessions + self == current_user or super + end end def permission_to_create current_user.andand.is_admin or - (self == current_user and - self.is_active == Rails.configuration.new_users_are_active) + (self == current_user && + self.redirect_to_user_uuid.nil? && + self.is_active == Rails.configuration.Users.NewUsersAreActive) end def check_auto_admin return if self.uuid.end_with?('anonymouspublic') if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and - Rails.configuration.auto_admin_user and self.email == Rails.configuration.auto_admin_user) or - (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and - Rails.configuration.auto_admin_first_user) + !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or + (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and + Rails.configuration.Users.AutoAdminFirstUser) self.is_admin = true self.is_active = true end end + def find_usable_username_from(basename) + # If "basename" is a usable username, return that. + # Otherwise, find a unique username "basenameN", where N is the + # smallest integer greater than 1, and return that. + # Return nil if a unique username can't be found after reasonable + # searching. + quoted_name = self.class.connection.quote_string(basename) + next_username = basename + next_suffix = 1 + while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username] + next_suffix += 1 + next_username = "%s%i" % [basename, next_suffix] + end + 0.upto(6).each do |suffix_len| + pattern = "%s%s" % [quoted_name, "_" * suffix_len] + self.class.unscoped. + where("username like '#{pattern}'"). + select(:username). + order('username asc'). + each do |other_user| + if other_user.username > next_username + break + elsif other_user.username == next_username + next_suffix += 1 + next_username = "%s%i" % [basename, next_suffix] + end + end + return next_username if (next_username.size <= pattern.size) + end + nil + end + def prevent_privilege_escalation if current_user.andand.is_admin return true end if self.is_active_changed? if self.is_active != self.is_active_was - logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}" + logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}" self.is_active = self.is_active_was end end @@ -290,22 +534,22 @@ class User < ArvadosModel merged end - def create_oid_login_perm (openid_prefix) - login_perm_props = { "identity_url_prefix" => openid_prefix} - + def create_oid_login_perm(openid_prefix) # Check oid_login_perm oid_login_perms = Link.where(tail_uuid: self.email, - link_class: 'permission', - name: 'can_login').where("head_uuid = ?", self.uuid) + head_uuid: self.uuid, + link_class: 'permission', + name: 'can_login') if !oid_login_perms.any? # create openid login permission - oid_login_perm = Link.create(link_class: 'permission', + oid_login_perm = Link.create!(link_class: 'permission', name: 'can_login', tail_uuid: self.email, head_uuid: self.uuid, - properties: login_perm_props - ) + properties: { + "identity_url_prefix" => openid_prefix, + }) logger.info { "openid login permission: " + oid_login_perm[:uuid] } else oid_login_perm = oid_login_perms.first @@ -321,80 +565,42 @@ class User < ArvadosModel return end - # Check for an existing repository with the same name we're about to use. - repo = Repository.where(name: repo_name).first - - if repo - logger.warn "Repository exists for #{repo_name}: #{repo[:uuid]}." - - # Look for existing repository access for this repo - repo_perms = Link.where(tail_uuid: self.uuid, - head_uuid: repo[:uuid], - link_class: 'permission', - name: 'can_manage') - if repo_perms.any? - logger.warn "User already has repository access " + - repo_perms.collect { |p| p[:uuid] }.inspect - return repo_perms.first - end - end - - # create repo, if does not already exist - repo ||= Repository.create(name: repo_name) + repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create! logger.info { "repo uuid: " + repo[:uuid] } - - repo_perm = Link.create(tail_uuid: self.uuid, - head_uuid: repo[:uuid], - link_class: 'permission', - name: 'can_manage') + repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid, + link_class: "permission", + name: "can_manage").first_or_create! logger.info { "repo permission: " + repo_perm[:uuid] } return repo_perm end # create login permission for the given vm_uuid, if it does not already exist def create_vm_login_permission_link(vm_uuid, repo_name) - begin - - # vm uuid is optional - if vm_uuid - vm = VirtualMachine.where(uuid: vm_uuid).first + # vm uuid is optional + return if vm_uuid == "" - if not vm - logger.warn "Could not find virtual machine for #{vm_uuid.inspect}" - raise "No vm found for #{vm_uuid}" - end - else - return - end - - logger.info { "vm uuid: " + vm[:uuid] } + vm = VirtualMachine.where(uuid: vm_uuid).first + if !vm + logger.warn "Could not find virtual machine for #{vm_uuid.inspect}" + raise "No vm found for #{vm_uuid}" + end - login_perms = Link.where(tail_uuid: self.uuid, - head_uuid: vm[:uuid], - link_class: 'permission', - name: 'can_login') + logger.info { "vm uuid: " + vm[:uuid] } + login_attrs = { + tail_uuid: uuid, head_uuid: vm.uuid, + link_class: "permission", name: "can_login", + } - perm_exists = false - login_perms.each do |perm| - if perm.properties['username'] == repo_name - perm_exists = perm - break - end - end + login_perm = Link. + where(login_attrs). + select { |link| link.properties["username"] == repo_name }. + first - if perm_exists - login_perm = perm_exists - else - login_perm = Link.create(tail_uuid: self.uuid, - head_uuid: vm[:uuid], - link_class: 'permission', - name: 'can_login', - properties: {'username' => repo_name}) - logger.info { "login permission: " + login_perm[:uuid] } - end + login_perm ||= Link. + create(login_attrs.merge(properties: {"username" => repo_name})) - return login_perm - end + logger.info { "login permission: " + login_perm[:uuid] } + login_perm end # add the user to the 'All users' group @@ -411,8 +617,8 @@ class User < ArvadosModel # Give the special "System group" permission to manage this user and # all of this user's stuff. - # def add_system_group_permission_link + return true if uuid == system_user_uuid act_as_system_user do Link.create(link_class: 'permission', name: 'can_manage', @@ -423,52 +629,33 @@ class User < ArvadosModel # Send admin notifications def send_admin_notifications - AdminNotifier.new_user(self).deliver + AdminNotifier.new_user(self).deliver_now if not self.is_active then - AdminNotifier.new_inactive_user(self).deliver + AdminNotifier.new_inactive_user(self).deliver_now end end - # Automatically setup new user during creation - def auto_setup_new_user - return true if !Rails.configuration.auto_setup_new_users - return true if !self.email - return true if self.uuid == system_user_uuid - return true if self.uuid == anonymous_user_uuid - - if Rails.configuration.auto_setup_new_users_with_vm_uuid || - Rails.configuration.auto_setup_new_users_with_repository - username = self.email.partition('@')[0] if self.email - return true if !username - - blacklisted_usernames = Rails.configuration.auto_setup_name_blacklist - if blacklisted_usernames.include?(username) - return true - elsif !(/^[a-zA-Z][-._a-zA-Z0-9]{0,30}[a-zA-Z0-9]$/.match(username)) - return true - else - return true if !(username = derive_unique_username username) - end + # Automatically setup if is_active flag turns on + def setup_on_activate + return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid) + if is_active && (new_record? || is_active_changed?) + setup(openid_prefix: Rails.configuration.default_openid_prefix) end - - # setup user - setup_repo_vm_links(username, - Rails.configuration.auto_setup_new_users_with_vm_uuid, - Rails.configuration.default_openid_prefix) end - # Find a username that starts with the given string and does not collide - # with any existing repository name or VM login name - def derive_unique_username username - while true - if Repository.where(name: username).empty? - login_collisions = Link.where(link_class: 'permission', - name: 'can_login').select do |perm| - perm.properties['username'] == username - end - return username if login_collisions.empty? + # Automatically setup new user during creation + def auto_setup_new_user + setup(openid_prefix: Rails.configuration.default_openid_prefix) + if username + create_vm_login_permission_link(Rails.configuration.Users.AutoSetupNewUsersWithVmUUID, + username) + repo_name = "#{username}/#{username}" + if Rails.configuration.Users.AutoSetupNewUsersWithRepository and + Repository.where(name: repo_name).first.nil? + repo = Repository.create!(name: repo_name, owner_uuid: uuid) + Link.create!(tail_uuid: uuid, head_uuid: repo.uuid, + link_class: "permission", name: "can_manage") end - username = username + SecureRandom.random_number(10).to_s end end @@ -476,10 +663,25 @@ class User < ArvadosModel def send_profile_created_notification if self.prefs_changed? if self.prefs_was.andand.empty? || !self.prefs_was.andand['profile'] - profile_notification_address = Rails.configuration.user_profile_notification_address - ProfileNotifier.profile_created(self, profile_notification_address).deliver if profile_notification_address + profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress + ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty? end end end + def verify_repositories_empty + unless repositories.first.nil? + errors.add(:username, "can't be unset when the user owns repositories") + throw(:abort) + end + end + + def sync_repository_names + old_name_re = /^#{Regexp.escape(username_was)}\// + name_sub = "#{username}/" + repositories.find_each do |repo| + repo.name = repo.name.sub(old_name_re, name_sub) + repo.save! + end + end end