1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
5 require 'can_be_an_owner'
7 class User < ArvadosModel
10 include CommonApiTemplate
12 extend CurrentApiClient
14 serialize :prefs, Hash
15 has_many :api_client_authorizations
18 with: /\A[A-Za-z][A-Za-z0-9]*\z/,
19 message: "must begin with a letter and contain only alphanumerics",
23 validate :must_unsetup_to_deactivate
24 before_update :prevent_privilege_escalation
25 before_update :prevent_inactive_admin
26 before_update :verify_repositories_empty, :if => Proc.new { |user|
27 user.username.nil? and user.username_changed?
29 before_update :setup_on_activate
31 before_create :check_auto_admin
32 before_create :set_initial_username, :if => Proc.new { |user|
33 user.username.nil? and user.email
35 after_create :after_ownership_change
36 after_create :setup_on_activate
37 after_create :add_system_group_permission_link
38 after_create :auto_setup_new_user, :if => Proc.new { |user|
39 Rails.configuration.Users.AutoSetupNewUsers and
40 (user.uuid != system_user_uuid) and
41 (user.uuid != anonymous_user_uuid)
43 after_create :send_admin_notifications
45 before_update :before_ownership_change
46 after_update :after_ownership_change
47 after_update :send_profile_created_notification
48 after_update :sync_repository_names, :if => Proc.new { |user|
49 (user.uuid != system_user_uuid) and
50 user.username_changed? and
51 (not user.username_was.nil?)
53 after_destroy :clear_permissions
55 has_many :authorized_keys, :foreign_key => :authorized_user_uuid, :primary_key => :uuid
56 has_many :repositories, foreign_key: :owner_uuid, primary_key: :uuid
58 default_scope { where('redirect_to_user_uuid is null') }
60 api_accessible :user, extend: :common do |t|
74 ALL_PERMISSIONS = {read: true, write: true, manage: true}
76 # Map numeric permission levels (see lib/create_permission_view.sql)
77 # back to read/write/manage flags.
81 {read: true, write: true},
82 {read: true, write: true, manage: true}]
91 "#{first_name} #{last_name}".strip
96 Rails.configuration.Users.NewUsersAreActive ||
97 self.groups_i_can(:read).select { |x| x.match(/-f+$/) }.first)
100 def groups_i_can(verb)
101 my_groups = self.group_permissions(VAL_FOR_PERM[verb]).keys
103 my_groups << anonymous_group_uuid
109 return true if is_admin
110 actions.each do |action, target|
112 if target.respond_to? :uuid
113 target_uuid = target.uuid
116 target = ArvadosModel.find_by_uuid(target_uuid)
119 next if target_uuid == self.uuid
121 target_owner_uuid = target.owner_uuid if target.respond_to? :owner_uuid
123 unless ActiveRecord::Base.connection.
125 SELECT 1 FROM #{PERMISSION_VIEW}
126 WHERE user_uuid = $1 and
127 ((target_uuid = $2 and perm_level >= $3)
128 or (target_uuid = $4 and perm_level >= $3 and traverse_owned))
130 # "name" arg is a query label that appears in logs:
134 [nil, VAL_FOR_PERM[action]],
135 [nil, target_owner_uuid]]
143 def before_ownership_change
144 if owner_uuid_changed? and !self.owner_uuid_was.nil?
145 MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
146 update_permissions self.owner_uuid_was, self.uuid, 0, false
150 def after_ownership_change
151 if owner_uuid_changed?
152 update_permissions self.owner_uuid, self.uuid, 3
156 def clear_permissions
157 MaterializedPermission.where("user_uuid = ? or target_uuid = ?", uuid, uuid).delete_all
160 # Return a hash of {user_uuid: group_perms}
161 def self.all_group_permissions
163 ActiveRecord::Base.connection.
164 exec_query("SELECT user_uuid, target_uuid, perm_level
165 FROM #{PERMISSION_VIEW}
166 WHERE traverse_owned",
167 # "name" arg is a query label that appears in logs:
168 "all_group_permissions").
169 rows.each do |user_uuid, group_uuid, max_p_val|
170 all_perms[user_uuid] ||= {}
171 all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
176 # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
177 # and perm_hash[:write] are true if this user can read and write
178 # objects owned by group_uuid.
179 def group_permissions(level=1)
181 ActiveRecord::Base.connection.
183 SELECT target_uuid, perm_level
184 FROM #{PERMISSION_VIEW}
185 WHERE user_uuid = $1 and perm_level >= $2
187 # "name" arg is a query label that appears in logs:
188 "group_permissions_for_user",
189 # "binds" arg is an array of [col_id, value] for '$1' vars:
192 rows.each do |group_uuid, max_p_val|
193 group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
199 def setup(repo_name: nil, vm_uuid: nil)
200 repo_perm = create_user_repo_link repo_name
201 vm_login_perm = create_vm_login_permission_link(vm_uuid, username) if vm_uuid
202 group_perm = create_user_group_link
204 return [repo_perm, vm_login_perm, group_perm, self].compact
207 # delete user signatures, login, repo, and vm perms, and mark as inactive
209 # delete oid_login_perms for this user
211 # note: these permission links are obsolete, they have no effect
212 # on anything and they are not created for new users.
213 Link.where(tail_uuid: self.email,
214 link_class: 'permission',
215 name: 'can_login').destroy_all
217 # delete repo_perms for this user
218 Link.where(tail_uuid: self.uuid,
219 link_class: 'permission',
220 name: 'can_manage').destroy_all
222 # delete vm_login_perms for this user
223 Link.where(tail_uuid: self.uuid,
224 link_class: 'permission',
225 name: 'can_login').destroy_all
227 # delete "All users" group read permissions for this user
228 group = Group.where(name: 'All users').select do |g|
229 g[:uuid].match(/-f+$/)
231 Link.where(tail_uuid: self.uuid,
232 head_uuid: group[:uuid],
233 link_class: 'permission',
234 name: 'can_read').destroy_all
236 # delete any signatures by this user
237 Link.where(link_class: 'signature',
238 tail_uuid: self.uuid).destroy_all
240 # delete user preferences (including profile)
243 # mark the user as inactive
244 self.is_active = false
248 def must_unsetup_to_deactivate
249 if self.is_active_changed? &&
250 self.is_active_was == true &&
253 group = Group.where(name: 'All users').select do |g|
254 g[:uuid].match(/-f+$/)
257 # When a user is set up, they are added to the "All users"
258 # group. A user that is part of the "All users" group is
259 # allowed to self-activate.
261 # It doesn't make sense to deactivate a user (set is_active =
262 # false) without first removing them from the "All users" group,
263 # because they would be able to immediately reactivate
266 # The 'unsetup' method removes the user from the "All users"
267 # group (and also sets is_active = false) so send a message
268 # explaining the correct way to deactivate a user.
270 if Link.where(tail_uuid: self.uuid,
271 head_uuid: group[:uuid],
272 link_class: 'permission',
273 name: 'can_read').any?
274 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
279 def set_initial_username(requested: false)
280 if !requested.is_a?(String) || requested.empty?
281 email_parts = email.partition("@")
282 local_parts = email_parts.first.partition("+")
283 if email_parts.any?(&:empty?)
285 elsif not local_parts.first.empty?
286 requested = local_parts.first
288 requested = email_parts.first
291 requested.sub!(/^[^A-Za-z]+/, "")
292 requested.gsub!(/[^A-Za-z0-9]/, "")
293 unless requested.empty?
294 self.username = find_usable_username_from(requested)
298 def update_uuid(new_uuid:)
299 if !current_user.andand.is_admin
300 raise PermissionDeniedError
302 if uuid == system_user_uuid || uuid == anonymous_user_uuid
303 raise "update_uuid cannot update system accounts"
305 if self.class != self.class.resource_class_for_uuid(new_uuid)
306 raise "invalid new_uuid #{new_uuid.inspect}"
308 transaction(requires_new: true) do
312 save!(validate: false)
313 change_all_uuid_refs(old_uuid: old_uuid, new_uuid: new_uuid)
314 ActiveRecord::Base.connection.exec_update %{
315 update #{PERMISSION_VIEW} set user_uuid=$1 where user_uuid = $2
317 'User.update_uuid.update_permissions_user_uuid',
320 ActiveRecord::Base.connection.exec_update %{
321 update #{PERMISSION_VIEW} set target_uuid=$1 where target_uuid = $2
323 'User.update_uuid.update_permissions_target_uuid',
329 # Move this user's (i.e., self's) owned items to new_owner_uuid and
330 # new_user_uuid (for things normally owned directly by the user).
332 # If redirect_auth is true, also reassign auth tokens and ssh keys,
333 # and redirect this account to redirect_to_user_uuid, i.e., when a
334 # caller authenticates to this account in the future, the account
335 # redirect_to_user_uuid account will be used instead.
337 # current_user must have admin privileges, i.e., the caller is
338 # responsible for checking permission to do this.
339 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
340 raise PermissionDeniedError if !current_user.andand.is_admin
341 raise "Missing new_owner_uuid" if !new_owner_uuid
342 raise "Missing new_user_uuid" if !new_user_uuid
343 transaction(requires_new: true) do
345 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
347 new_user = User.where(uuid: new_user_uuid).first
348 raise "user does not exist" if !new_user
349 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
351 update_permissions self.owner_uuid, self.uuid, 0
353 # If 'self' is a remote user, don't transfer authorizations
354 # (i.e. ability to access the account) to the new user, because
355 # that gives the remote site the ability to access the 'new'
356 # user account that takes over the 'self' account.
358 # If 'self' is a local user, it is okay to transfer
359 # authorizations, even if the 'new' user is a remote account,
360 # because the remote site does not gain the ability to access an
361 # account it could not before.
363 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
364 # Existing API tokens and ssh keys are updated to authenticate
366 ApiClientAuthorization.
368 update_all(user_id: new_user.id)
371 [AuthorizedKey, :owner_uuid],
372 [AuthorizedKey, :authorized_user_uuid],
378 # Destroy API tokens and ssh keys associated with the old
380 ApiClientAuthorization.where(user_id: id).destroy_all
381 AuthorizedKey.where(owner_uuid: uuid).destroy_all
382 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
389 # References to the old user UUID in the context of a user ID
390 # (rather than a "home project" in the project hierarchy) are
391 # updated to point to the new user.
392 user_updates.each do |klass, column|
393 klass.where(column => uuid).update_all(column => new_user.uuid)
396 # Need to update repository names to new username
398 old_repo_name_re = /^#{Regexp.escape(username)}\//
399 Repository.where(:owner_uuid => uuid).each do |repo|
400 repo.owner_uuid = new_user.uuid
401 repo_name_sub = "#{new_user.username}/"
402 name = repo.name.sub(old_repo_name_re, repo_name_sub)
403 while (conflict = Repository.where(:name => name).first) != nil
404 repo_name_sub += "migrated"
405 name = repo.name.sub(old_repo_name_re, repo_name_sub)
412 # References to the merged user's "home project" are updated to
413 # point to new_owner_uuid.
414 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
415 next if [ApiClientAuthorization,
419 Repository].include?(klass)
420 next if !klass.columns.collect(&:name).include?('owner_uuid')
421 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
424 if redirect_to_new_user
425 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
427 update_permissions self.owner_uuid, self.uuid, 3
428 update_permissions new_user.owner_uuid, new_user.uuid, 3
435 while (uuid = user.redirect_to_user_uuid)
437 nextuser = User.unscoped.find_by_uuid(uuid)
439 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
444 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
450 def self.register info
451 # login info expected fields, all can be optional but at minimum
452 # must supply either 'identity_url' or 'email'
464 identity_url = info['identity_url']
466 if identity_url && identity_url.length > 0
467 # Only local users can create sessions, hence uuid_like_pattern
469 user = User.unscoped.where('identity_url = ? and uuid like ?',
471 User.uuid_like_pattern).first
472 primary_user = user.redirects_to if user
476 # identity url is unset or didn't find matching record.
477 emails = [info['email']] + (info['alternate_emails'] || [])
478 emails.select! {|em| !em.nil? && !em.empty?}
480 User.unscoped.where('email in (?) and uuid like ?',
482 User.uuid_like_pattern).each do |user|
484 primary_user = user.redirects_to
485 elsif primary_user.uuid != user.redirects_to.uuid
486 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
492 # New user registration
493 primary_user = User.new(:owner_uuid => system_user_uuid,
495 :is_active => Rails.configuration.Users.NewUsersAreActive)
497 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
498 primary_user.identity_url = info['identity_url'] if identity_url
501 primary_user.email = info['email'] if info['email']
502 primary_user.first_name = info['first_name'] if info['first_name']
503 primary_user.last_name = info['last_name'] if info['last_name']
505 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
506 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
509 act_as_system_user do
518 def change_all_uuid_refs(old_uuid:, new_uuid:)
519 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
520 klass.columns.each do |col|
521 if col.name.end_with?('_uuid')
522 column = col.name.to_sym
523 klass.where(column => old_uuid).update_all(column => new_uuid)
529 def ensure_ownership_path_leads_to_user
533 def permission_to_update
534 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
535 current_user.andand.is_admin
537 # users must be able to update themselves (even if they are
538 # inactive) in order to create sessions
539 self == current_user or super
543 def permission_to_create
544 current_user.andand.is_admin or
545 (self == current_user &&
546 self.redirect_to_user_uuid.nil? &&
547 self.is_active == Rails.configuration.Users.NewUsersAreActive)
551 return if self.uuid.end_with?('anonymouspublic')
552 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
553 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
554 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
555 Rails.configuration.Users.AutoAdminFirstUser)
557 self.is_active = true
561 def find_usable_username_from(basename)
562 # If "basename" is a usable username, return that.
563 # Otherwise, find a unique username "basenameN", where N is the
564 # smallest integer greater than 1, and return that.
565 # Return nil if a unique username can't be found after reasonable
567 quoted_name = self.class.connection.quote_string(basename)
568 next_username = basename
570 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
572 next_username = "%s%i" % [basename, next_suffix]
574 0.upto(6).each do |suffix_len|
575 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
577 where("username like '#{pattern}'").
579 order('username asc').
581 if other_user.username > next_username
583 elsif other_user.username == next_username
585 next_username = "%s%i" % [basename, next_suffix]
588 return next_username if (next_username.size <= pattern.size)
593 def prevent_privilege_escalation
594 if current_user.andand.is_admin
597 if self.is_active_changed?
598 if self.is_active != self.is_active_was
599 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
600 self.is_active = self.is_active_was
603 if self.is_admin_changed?
604 if self.is_admin != self.is_admin_was
605 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
606 self.is_admin = self.is_admin_was
612 def prevent_inactive_admin
613 if self.is_admin and not self.is_active
614 # There is no known use case for the strange set of permissions
615 # that would result from this change. It's safest to assume it's
616 # a mistake and disallow it outright.
617 raise "Admin users cannot be inactive"
622 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
623 nextpaths = graph[start]
624 return merged if !nextpaths
625 return merged if upstream_path.has_key? start
626 upstream_path[start] = true
627 upstream_mask ||= ALL_PERMISSIONS
628 nextpaths.each do |head, mask|
631 merged[head][k] ||= v if upstream_mask[k]
633 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
635 upstream_path.delete start
639 def create_user_repo_link(repo_name)
640 # repo_name is optional
642 logger.warn ("Repository name not given for #{self.uuid}.")
646 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
647 logger.info { "repo uuid: " + repo[:uuid] }
648 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
649 link_class: "permission",
650 name: "can_manage").first_or_create!
651 logger.info { "repo permission: " + repo_perm[:uuid] }
655 # create login permission for the given vm_uuid, if it does not already exist
656 def create_vm_login_permission_link(vm_uuid, repo_name)
657 # vm uuid is optional
658 return if vm_uuid == ""
660 vm = VirtualMachine.where(uuid: vm_uuid).first
662 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
663 raise "No vm found for #{vm_uuid}"
666 logger.info { "vm uuid: " + vm[:uuid] }
668 tail_uuid: uuid, head_uuid: vm.uuid,
669 link_class: "permission", name: "can_login",
674 select { |link| link.properties["username"] == repo_name }.
678 create(login_attrs.merge(properties: {"username" => repo_name}))
680 logger.info { "login permission: " + login_perm[:uuid] }
684 # add the user to the 'All users' group
685 def create_user_group_link
686 return (Link.where(tail_uuid: self.uuid,
687 head_uuid: all_users_group[:uuid],
688 link_class: 'permission',
689 name: 'can_read').first or
690 Link.create(tail_uuid: self.uuid,
691 head_uuid: all_users_group[:uuid],
692 link_class: 'permission',
696 # Give the special "System group" permission to manage this user and
697 # all of this user's stuff.
698 def add_system_group_permission_link
699 return true if uuid == system_user_uuid
700 act_as_system_user do
701 Link.create(link_class: 'permission',
703 tail_uuid: system_group_uuid,
704 head_uuid: self.uuid)
708 # Send admin notifications
709 def send_admin_notifications
710 AdminNotifier.new_user(self).deliver_now
711 if not self.is_active then
712 AdminNotifier.new_inactive_user(self).deliver_now
716 # Automatically setup if is_active flag turns on
717 def setup_on_activate
718 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
719 if is_active && (new_record? || is_active_changed?)
724 # Automatically setup new user during creation
725 def auto_setup_new_user
728 create_vm_login_permission_link(Rails.configuration.Users.AutoSetupNewUsersWithVmUUID,
730 repo_name = "#{username}/#{username}"
731 if Rails.configuration.Users.AutoSetupNewUsersWithRepository and
732 Repository.where(name: repo_name).first.nil?
733 repo = Repository.create!(name: repo_name, owner_uuid: uuid)
734 Link.create!(tail_uuid: uuid, head_uuid: repo.uuid,
735 link_class: "permission", name: "can_manage")
740 # Send notification if the user saved profile for the first time
741 def send_profile_created_notification
742 if self.prefs_changed?
743 if self.prefs_was.andand.empty? || !self.prefs_was.andand['profile']
744 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
745 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
750 def verify_repositories_empty
751 unless repositories.first.nil?
752 errors.add(:username, "can't be unset when the user owns repositories")
757 def sync_repository_names
758 old_name_re = /^#{Regexp.escape(username_was)}\//
759 name_sub = "#{username}/"
760 repositories.find_each do |repo|
761 repo.name = repo.name.sub(old_name_re, name_sub)