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 {
27 username.nil? and username_changed?
29 after_update :setup_on_activate
31 before_create :check_auto_admin
32 before_create :set_initial_username, :if => Proc.new {
33 username.nil? and 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 {
39 Rails.configuration.Users.AutoSetupNewUsers and
40 (uuid != system_user_uuid) and
41 (uuid != anonymous_user_uuid) and
42 (uuid[0..4] == Rails.configuration.ClusterID)
44 after_create :send_admin_notifications
46 before_update :before_ownership_change
47 after_update :after_ownership_change
48 after_update :send_profile_created_notification
49 after_update :sync_repository_names, :if => Proc.new {
50 (uuid != system_user_uuid) and
51 saved_change_to_username? and
52 (not username_before_last_save.nil?)
54 before_destroy :clear_permissions
55 after_destroy :remove_self_from_permissions
57 has_many :authorized_keys, :foreign_key => :authorized_user_uuid, :primary_key => :uuid
58 has_many :repositories, foreign_key: :owner_uuid, primary_key: :uuid
60 default_scope { where('redirect_to_user_uuid is null') }
62 api_accessible :user, extend: :common do |t|
76 ALL_PERMISSIONS = {read: true, write: true, manage: true}
78 # Map numeric permission levels (see lib/create_permission_view.sql)
79 # back to read/write/manage flags.
83 {read: true, write: true},
84 {read: true, write: true, manage: true}]
93 "#{first_name} #{last_name}".strip
98 Rails.configuration.Users.NewUsersAreActive ||
99 self.groups_i_can(:read).select { |x| x.match(/-f+$/) }.first)
102 def groups_i_can(verb)
103 my_groups = self.group_permissions(VAL_FOR_PERM[verb]).keys
105 my_groups << anonymous_group_uuid
111 return true if is_admin
112 actions.each do |action, target|
114 if target.respond_to? :uuid
115 target_uuid = target.uuid
118 target = ArvadosModel.find_by_uuid(target_uuid)
121 next if target_uuid == self.uuid
123 target_owner_uuid = target.owner_uuid if target.respond_to? :owner_uuid
125 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: "$3"}
127 unless ActiveRecord::Base.connection.
129 SELECT 1 FROM #{PERMISSION_VIEW}
130 WHERE user_uuid in (#{user_uuids_subquery}) and
131 ((target_uuid = $2 and perm_level >= $3)
132 or (target_uuid = $4 and perm_level >= $3 and traverse_owned))
134 # "name" arg is a query label that appears in logs:
138 [nil, VAL_FOR_PERM[action]],
139 [nil, target_owner_uuid]]
147 def before_ownership_change
148 if owner_uuid_changed? and !self.owner_uuid_was.nil?
149 MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
150 update_permissions self.owner_uuid_was, self.uuid, REVOKE_PERM
154 def after_ownership_change
155 if saved_change_to_owner_uuid?
156 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
160 def clear_permissions
161 MaterializedPermission.where("user_uuid = ? and target_uuid != ?", uuid, uuid).delete_all
164 def remove_self_from_permissions
165 MaterializedPermission.where("target_uuid = ?", uuid).delete_all
166 check_permissions_against_full_refresh
169 # Return a hash of {user_uuid: group_perms}
171 # note: this does not account for permissions that a user gains by
172 # having can_manage on another user.
173 def self.all_group_permissions
175 ActiveRecord::Base.connection.
177 SELECT user_uuid, target_uuid, perm_level
178 FROM #{PERMISSION_VIEW}
181 # "name" arg is a query label that appears in logs:
182 "all_group_permissions").
183 rows.each do |user_uuid, group_uuid, max_p_val|
184 all_perms[user_uuid] ||= {}
185 all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
190 # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
191 # and perm_hash[:write] are true if this user can read and write
192 # objects owned by group_uuid.
193 def group_permissions(level=1)
196 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: "$2"}
198 ActiveRecord::Base.connection.
200 SELECT target_uuid, perm_level
201 FROM #{PERMISSION_VIEW}
202 WHERE user_uuid in (#{user_uuids_subquery}) and perm_level >= $2
204 # "name" arg is a query label that appears in logs:
205 "User.group_permissions",
206 # "binds" arg is an array of [col_id, value] for '$1' vars:
209 rows.each do |group_uuid, max_p_val|
210 group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
216 def setup(repo_name: nil, vm_uuid: nil, send_notification_email: nil)
217 newly_invited = Link.where(tail_uuid: self.uuid,
218 head_uuid: all_users_group_uuid,
219 link_class: 'permission',
220 name: 'can_read').empty?
222 # Add can_read link from this user to "all users" which makes this
224 group_perm = create_user_group_link
227 repo_perm = if (!repo_name.nil? || Rails.configuration.Users.AutoSetupNewUsersWithRepository) and !username.nil?
228 repo_name ||= "#{username}/#{username}"
229 create_user_repo_link repo_name
232 # Add virtual machine
233 if vm_uuid.nil? and !Rails.configuration.Users.AutoSetupNewUsersWithVmUUID.empty?
234 vm_uuid = Rails.configuration.Users.AutoSetupNewUsersWithVmUUID
237 vm_login_perm = if vm_uuid && username
238 create_vm_login_permission_link(vm_uuid, username)
242 if send_notification_email.nil?
243 send_notification_email = Rails.configuration.Mail.SendUserSetupNotificationEmail
246 if newly_invited and send_notification_email and !Rails.configuration.Users.UserSetupMailText.empty?
248 UserNotifier.account_is_setup(self).deliver_now
250 logger.warn "Failed to send email to #{self.email}: #{e}"
254 return [repo_perm, vm_login_perm, group_perm, self].compact
257 # delete user signatures, login, repo, and vm perms, and mark as inactive
259 # delete oid_login_perms for this user
261 # note: these permission links are obsolete, they have no effect
262 # on anything and they are not created for new users.
263 Link.where(tail_uuid: self.email,
264 link_class: 'permission',
265 name: 'can_login').destroy_all
267 # delete repo_perms for this user
268 Link.where(tail_uuid: self.uuid,
269 link_class: 'permission',
270 name: 'can_manage').destroy_all
272 # delete vm_login_perms for this user
273 Link.where(tail_uuid: self.uuid,
274 link_class: 'permission',
275 name: 'can_login').destroy_all
277 # delete "All users" group read permissions for this user
278 Link.where(tail_uuid: self.uuid,
279 head_uuid: all_users_group_uuid,
280 link_class: 'permission',
281 name: 'can_read').destroy_all
283 # delete any signatures by this user
284 Link.where(link_class: 'signature',
285 tail_uuid: self.uuid).destroy_all
287 # delete user preferences (including profile)
290 # mark the user as inactive
291 self.is_admin = false # can't be admin and inactive
292 self.is_active = false
296 def must_unsetup_to_deactivate
297 if !self.new_record? &&
298 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
299 self.uuid[0..4] != Rails.configuration.ClusterID
300 # OK to update our local record to whatever the LoginCluster
301 # reports, because self-activate is not allowed.
303 elsif self.is_active_changed? &&
304 self.is_active_was &&
307 # When a user is set up, they are added to the "All users"
308 # group. A user that is part of the "All users" group is
309 # allowed to self-activate.
311 # It doesn't make sense to deactivate a user (set is_active =
312 # false) without first removing them from the "All users" group,
313 # because they would be able to immediately reactivate
316 # The 'unsetup' method removes the user from the "All users"
317 # group (and also sets is_active = false) so send a message
318 # explaining the correct way to deactivate a user.
320 if Link.where(tail_uuid: self.uuid,
321 head_uuid: all_users_group_uuid,
322 link_class: 'permission',
323 name: 'can_read').any?
324 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
329 def set_initial_username(requested: false)
330 if !requested.is_a?(String) || requested.empty?
331 email_parts = email.partition("@")
332 local_parts = email_parts.first.partition("+")
333 if email_parts.any?(&:empty?)
335 elsif not local_parts.first.empty?
336 requested = local_parts.first
338 requested = email_parts.first
341 requested.sub!(/^[^A-Za-z]+/, "")
342 requested.gsub!(/[^A-Za-z0-9]/, "")
343 unless requested.empty?
344 self.username = find_usable_username_from(requested)
348 def update_uuid(new_uuid:)
349 if !current_user.andand.is_admin
350 raise PermissionDeniedError
352 if uuid == system_user_uuid || uuid == anonymous_user_uuid
353 raise "update_uuid cannot update system accounts"
355 if self.class != self.class.resource_class_for_uuid(new_uuid)
356 raise "invalid new_uuid #{new_uuid.inspect}"
358 transaction(requires_new: true) do
362 save!(validate: false)
363 change_all_uuid_refs(old_uuid: old_uuid, new_uuid: new_uuid)
364 ActiveRecord::Base.connection.exec_update %{
365 update #{PERMISSION_VIEW} set user_uuid=$1 where user_uuid = $2
367 'User.update_uuid.update_permissions_user_uuid',
370 ActiveRecord::Base.connection.exec_update %{
371 update #{PERMISSION_VIEW} set target_uuid=$1 where target_uuid = $2
373 'User.update_uuid.update_permissions_target_uuid',
379 # Move this user's (i.e., self's) owned items to new_owner_uuid and
380 # new_user_uuid (for things normally owned directly by the user).
382 # If redirect_auth is true, also reassign auth tokens and ssh keys,
383 # and redirect this account to redirect_to_user_uuid, i.e., when a
384 # caller authenticates to this account in the future, the account
385 # redirect_to_user_uuid account will be used instead.
387 # current_user must have admin privileges, i.e., the caller is
388 # responsible for checking permission to do this.
389 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
390 raise PermissionDeniedError if !current_user.andand.is_admin
391 raise "Missing new_owner_uuid" if !new_owner_uuid
392 raise "Missing new_user_uuid" if !new_user_uuid
393 transaction(requires_new: true) do
395 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
397 new_user = User.where(uuid: new_user_uuid).first
398 raise "user does not exist" if !new_user
399 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
401 self.clear_permissions
402 new_user.clear_permissions
404 # If 'self' is a remote user, don't transfer authorizations
405 # (i.e. ability to access the account) to the new user, because
406 # that gives the remote site the ability to access the 'new'
407 # user account that takes over the 'self' account.
409 # If 'self' is a local user, it is okay to transfer
410 # authorizations, even if the 'new' user is a remote account,
411 # because the remote site does not gain the ability to access an
412 # account it could not before.
414 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
415 # Existing API tokens and ssh keys are updated to authenticate
417 ApiClientAuthorization.
419 update_all(user_id: new_user.id)
422 [AuthorizedKey, :owner_uuid],
423 [AuthorizedKey, :authorized_user_uuid],
429 # Destroy API tokens and ssh keys associated with the old
431 ApiClientAuthorization.where(user_id: id).destroy_all
432 AuthorizedKey.where(owner_uuid: uuid).destroy_all
433 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
440 # References to the old user UUID in the context of a user ID
441 # (rather than a "home project" in the project hierarchy) are
442 # updated to point to the new user.
443 user_updates.each do |klass, column|
444 klass.where(column => uuid).update_all(column => new_user.uuid)
447 # Need to update repository names to new username
449 old_repo_name_re = /^#{Regexp.escape(username)}\//
450 Repository.where(:owner_uuid => uuid).each do |repo|
451 repo.owner_uuid = new_user.uuid
452 repo_name_sub = "#{new_user.username}/"
453 name = repo.name.sub(old_repo_name_re, repo_name_sub)
454 while (conflict = Repository.where(:name => name).first) != nil
455 repo_name_sub += "migrated"
456 name = repo.name.sub(old_repo_name_re, repo_name_sub)
463 # References to the merged user's "home project" are updated to
464 # point to new_owner_uuid.
465 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
466 next if [ApiClientAuthorization,
470 Repository].include?(klass)
471 next if !klass.columns.collect(&:name).include?('owner_uuid')
472 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
475 if redirect_to_new_user
476 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
478 skip_check_permissions_against_full_refresh do
479 update_permissions self.uuid, self.uuid, CAN_MANAGE_PERM
480 update_permissions new_user.uuid, new_user.uuid, CAN_MANAGE_PERM
481 update_permissions new_user.owner_uuid, new_user.uuid, CAN_MANAGE_PERM
483 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
490 while (uuid = user.redirect_to_user_uuid)
492 nextuser = User.unscoped.find_by_uuid(uuid)
494 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
499 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
505 def self.register info
506 # login info expected fields, all can be optional but at minimum
507 # must supply either 'identity_url' or 'email'
519 identity_url = info['identity_url']
521 if identity_url && identity_url.length > 0
522 # Only local users can create sessions, hence uuid_like_pattern
524 user = User.unscoped.where('identity_url = ? and uuid like ?',
526 User.uuid_like_pattern).first
527 primary_user = user.redirects_to if user
531 # identity url is unset or didn't find matching record.
532 emails = [info['email']] + (info['alternate_emails'] || [])
533 emails.select! {|em| !em.nil? && !em.empty?}
535 User.unscoped.where('email in (?) and uuid like ?',
537 User.uuid_like_pattern).each do |user|
539 primary_user = user.redirects_to
540 elsif primary_user.uuid != user.redirects_to.uuid
541 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
547 # New user registration
548 primary_user = User.new(:owner_uuid => system_user_uuid,
550 :is_active => Rails.configuration.Users.NewUsersAreActive)
552 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
553 primary_user.identity_url = info['identity_url'] if identity_url
556 primary_user.email = info['email'] if info['email']
557 primary_user.first_name = info['first_name'] if info['first_name']
558 primary_user.last_name = info['last_name'] if info['last_name']
560 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
561 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
564 act_as_system_user do
573 def change_all_uuid_refs(old_uuid:, new_uuid:)
574 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
575 klass.columns.each do |col|
576 if col.name.end_with?('_uuid')
577 column = col.name.to_sym
578 klass.where(column => old_uuid).update_all(column => new_uuid)
584 def ensure_ownership_path_leads_to_user
588 def permission_to_update
589 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
590 current_user.andand.is_admin
592 # users must be able to update themselves (even if they are
593 # inactive) in order to create sessions
594 self == current_user or super
598 def permission_to_create
599 current_user.andand.is_admin or
600 (self == current_user &&
601 self.redirect_to_user_uuid.nil? &&
602 self.is_active == Rails.configuration.Users.NewUsersAreActive)
606 return if self.uuid.end_with?('anonymouspublic')
607 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
608 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
609 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
610 Rails.configuration.Users.AutoAdminFirstUser)
612 self.is_active = true
616 def find_usable_username_from(basename)
617 # If "basename" is a usable username, return that.
618 # Otherwise, find a unique username "basenameN", where N is the
619 # smallest integer greater than 1, and return that.
620 # Return nil if a unique username can't be found after reasonable
622 quoted_name = self.class.connection.quote_string(basename)
623 next_username = basename
625 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
627 next_username = "%s%i" % [basename, next_suffix]
629 0.upto(6).each do |suffix_len|
630 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
632 where("username like '#{pattern}'").
634 order('username asc').
636 if other_user.username > next_username
638 elsif other_user.username == next_username
640 next_username = "%s%i" % [basename, next_suffix]
643 return next_username if (next_username.size <= pattern.size)
648 def prevent_privilege_escalation
649 if current_user.andand.is_admin
652 if self.is_active_changed?
653 if self.is_active != self.is_active_was
654 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
655 self.is_active = self.is_active_was
658 if self.is_admin_changed?
659 if self.is_admin != self.is_admin_was
660 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
661 self.is_admin = self.is_admin_was
667 def prevent_inactive_admin
668 if self.is_admin and not self.is_active
669 # There is no known use case for the strange set of permissions
670 # that would result from this change. It's safest to assume it's
671 # a mistake and disallow it outright.
672 raise "Admin users cannot be inactive"
677 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
678 nextpaths = graph[start]
679 return merged if !nextpaths
680 return merged if upstream_path.has_key? start
681 upstream_path[start] = true
682 upstream_mask ||= ALL_PERMISSIONS
683 nextpaths.each do |head, mask|
686 merged[head][k] ||= v if upstream_mask[k]
688 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
690 upstream_path.delete start
694 def create_user_repo_link(repo_name)
695 # repo_name is optional
697 logger.warn ("Repository name not given for #{self.uuid}.")
701 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
702 logger.info { "repo uuid: " + repo[:uuid] }
703 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
704 link_class: "permission",
705 name: "can_manage").first_or_create!
706 logger.info { "repo permission: " + repo_perm[:uuid] }
710 # create login permission for the given vm_uuid, if it does not already exist
711 def create_vm_login_permission_link(vm_uuid, repo_name)
712 # vm uuid is optional
713 return if vm_uuid == ""
715 vm = VirtualMachine.where(uuid: vm_uuid).first
717 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
718 raise "No vm found for #{vm_uuid}"
721 logger.info { "vm uuid: " + vm[:uuid] }
723 tail_uuid: uuid, head_uuid: vm.uuid,
724 link_class: "permission", name: "can_login",
729 select { |link| link.properties["username"] == repo_name }.
733 create(login_attrs.merge(properties: {"username" => repo_name}))
735 logger.info { "login permission: " + login_perm[:uuid] }
739 # add the user to the 'All users' group
740 def create_user_group_link
741 return (Link.where(tail_uuid: self.uuid,
742 head_uuid: all_users_group_uuid,
743 link_class: 'permission',
744 name: 'can_read').first or
745 Link.create(tail_uuid: self.uuid,
746 head_uuid: all_users_group_uuid,
747 link_class: 'permission',
751 # Give the special "System group" permission to manage this user and
752 # all of this user's stuff.
753 def add_system_group_permission_link
754 return true if uuid == system_user_uuid
755 act_as_system_user do
756 Link.create(link_class: 'permission',
758 tail_uuid: system_group_uuid,
759 head_uuid: self.uuid)
763 # Send admin notifications
764 def send_admin_notifications
765 AdminNotifier.new_user(self).deliver_now
766 if not self.is_active then
767 AdminNotifier.new_inactive_user(self).deliver_now
771 # Automatically setup if is_active flag turns on
772 def setup_on_activate
773 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
775 (new_record? || saved_change_to_is_active? || will_save_change_to_is_active?)
780 # Automatically setup new user during creation
781 def auto_setup_new_user
785 # Send notification if the user saved profile for the first time
786 def send_profile_created_notification
787 if saved_change_to_prefs?
788 if prefs_before_last_save.andand.empty? || !prefs_before_last_save.andand['profile']
789 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
790 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
795 def verify_repositories_empty
796 unless repositories.first.nil?
797 errors.add(:username, "can't be unset when the user owns repositories")
802 def sync_repository_names
803 old_name_re = /^#{Regexp.escape(username_before_last_save)}\//
804 name_sub = "#{username}/"
805 repositories.find_each do |repo|
806 repo.name = repo.name.sub(old_name_re, name_sub)