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 validate :identity_url_nil_if_empty
25 before_update :prevent_privilege_escalation
26 before_update :prevent_inactive_admin
27 before_update :prevent_nonadmin_system_root
28 before_update :verify_repositories_empty, :if => Proc.new {
29 username.nil? and username_changed?
31 after_update :setup_on_activate
33 before_create :check_auto_admin
34 before_create :set_initial_username, :if => Proc.new {
35 username.nil? and email
37 after_create :after_ownership_change
38 after_create :setup_on_activate
39 after_create :add_system_group_permission_link
40 after_create :auto_setup_new_user, :if => Proc.new {
41 Rails.configuration.Users.AutoSetupNewUsers and
42 (uuid != system_user_uuid) and
43 (uuid != anonymous_user_uuid) and
44 (uuid[0..4] == Rails.configuration.ClusterID)
46 after_create :send_admin_notifications
48 before_update :before_ownership_change
49 after_update :after_ownership_change
50 after_update :send_profile_created_notification
51 after_update :sync_repository_names, :if => Proc.new {
52 (uuid != system_user_uuid) and
53 saved_change_to_username? and
54 (not username_before_last_save.nil?)
56 before_destroy :clear_permissions
57 after_destroy :remove_self_from_permissions
59 has_many :authorized_keys, :foreign_key => :authorized_user_uuid, :primary_key => :uuid
60 has_many :repositories, foreign_key: :owner_uuid, primary_key: :uuid
62 default_scope { where('redirect_to_user_uuid is null') }
64 api_accessible :user, extend: :common do |t|
80 ALL_PERMISSIONS = {read: true, write: true, manage: true}
82 # Map numeric permission levels (see lib/create_permission_view.sql)
83 # back to read/write/manage flags.
87 {read: true, write: true},
88 {read: true, write: true, manage: true}]
98 "#{first_name} #{last_name}".strip
103 Rails.configuration.Users.NewUsersAreActive ||
104 self.groups_i_can(:read).select { |x| x.match(/-f+$/) }.first)
107 def groups_i_can(verb)
108 my_groups = self.group_permissions(VAL_FOR_PERM[verb]).keys
110 my_groups << anonymous_group_uuid
116 actions.each do |action, target|
118 if target.respond_to? :uuid
119 target_uuid = target.uuid
122 target = ArvadosModel.find_by_uuid(target_uuid)
125 next if target_uuid == self.uuid
127 if action == :write && target && !target.new_record? &&
128 target.respond_to?(:frozen_by_uuid) &&
129 target.frozen_by_uuid_was
130 # Just an optimization to skip the PERMISSION_VIEW and
131 # FrozenGroup queries below
135 target_owner_uuid = target.owner_uuid if target.respond_to? :owner_uuid
137 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: "$3"}
139 if !is_admin && !ActiveRecord::Base.connection.
141 SELECT 1 FROM #{PERMISSION_VIEW}
142 WHERE user_uuid in (#{user_uuids_subquery}) and
143 ((target_uuid = $2 and perm_level >= $3)
144 or (target_uuid = $4 and perm_level >= $3 and traverse_owned))
146 # "name" arg is a query label that appears in logs:
150 [nil, VAL_FOR_PERM[action]],
151 [nil, target_owner_uuid]]
157 if FrozenGroup.where(uuid: [target_uuid, target_owner_uuid]).any?
158 # self or parent is frozen
161 elsif action == :unfreeze
162 # "unfreeze" permission means "can write, but only if
163 # explicitly un-freezing at the same time" (see
164 # ArvadosModel#ensure_owner_uuid_is_permitted). If the
165 # permission query above passed the permission level of
166 # :unfreeze (which is the same as :manage), and the parent
167 # isn't also frozen, then un-freeze is allowed.
168 if FrozenGroup.where(uuid: target_owner_uuid).any?
176 def before_ownership_change
177 if owner_uuid_changed? and !self.owner_uuid_was.nil?
178 MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
179 update_permissions self.owner_uuid_was, self.uuid, REVOKE_PERM
183 def after_ownership_change
184 if saved_change_to_owner_uuid?
185 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
189 def clear_permissions
190 MaterializedPermission.where("user_uuid = ? and target_uuid != ?", uuid, uuid).delete_all
193 def forget_cached_group_perms
197 def remove_self_from_permissions
198 MaterializedPermission.where("target_uuid = ?", uuid).delete_all
199 check_permissions_against_full_refresh
202 # Return a hash of {user_uuid: group_perms}
204 # note: this does not account for permissions that a user gains by
205 # having can_manage on another user.
206 def self.all_group_permissions
208 ActiveRecord::Base.connection.
210 SELECT user_uuid, target_uuid, perm_level
211 FROM #{PERMISSION_VIEW}
214 # "name" arg is a query label that appears in logs:
215 "all_group_permissions").
216 rows.each do |user_uuid, group_uuid, max_p_val|
217 all_perms[user_uuid] ||= {}
218 all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
223 # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
224 # and perm_hash[:write] are true if this user can read and write
225 # objects owned by group_uuid.
226 def group_permissions(level=1)
228 if @group_perms.empty?
229 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: 1}
231 ActiveRecord::Base.connection.
233 SELECT target_uuid, perm_level
234 FROM #{PERMISSION_VIEW}
235 WHERE user_uuid in (#{user_uuids_subquery}) and perm_level >= 1
237 # "name" arg is a query label that appears in logs:
238 "User.group_permissions",
239 # "binds" arg is an array of [col_id, value] for '$1' vars:
241 rows.each do |group_uuid, max_p_val|
242 @group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
250 @group_perms.select {|k,v| v[:write] }
252 @group_perms.select {|k,v| v[:manage] }
254 raise "level must be 1, 2 or 3"
259 def setup(repo_name: nil, vm_uuid: nil, send_notification_email: nil)
260 newly_invited = Link.where(tail_uuid: self.uuid,
261 head_uuid: all_users_group_uuid,
262 link_class: 'permission',
263 name: 'can_read').empty?
265 # Add can_read link from this user to "all users" which makes this
266 # user "invited", and (depending on config) a link in the opposite
267 # direction which makes this user visible to other users.
268 group_perms = add_to_all_users_group
271 repo_perm = if (!repo_name.nil? || Rails.configuration.Users.AutoSetupNewUsersWithRepository) and !username.nil?
272 repo_name ||= "#{username}/#{username}"
273 create_user_repo_link repo_name
276 # Add virtual machine
277 if vm_uuid.nil? and !Rails.configuration.Users.AutoSetupNewUsersWithVmUUID.empty?
278 vm_uuid = Rails.configuration.Users.AutoSetupNewUsersWithVmUUID
281 vm_login_perm = if vm_uuid && username
282 create_vm_login_permission_link(vm_uuid, username)
286 if send_notification_email.nil?
287 send_notification_email = Rails.configuration.Mail.SendUserSetupNotificationEmail
290 if newly_invited and send_notification_email and !Rails.configuration.Users.UserSetupMailText.empty?
292 UserNotifier.account_is_setup(self).deliver_now
294 logger.warn "Failed to send email to #{self.email}: #{e}"
298 forget_cached_group_perms
300 return [repo_perm, vm_login_perm, *group_perms, self].compact
303 # delete user signatures, login, repo, and vm perms, and mark as inactive
305 if self.uuid == system_user_uuid
306 raise "System root user cannot be deactivated"
309 # delete oid_login_perms for this user
311 # note: these permission links are obsolete, they have no effect
312 # on anything and they are not created for new users.
313 Link.where(tail_uuid: self.email,
314 link_class: 'permission',
315 name: 'can_login').destroy_all
317 # delete repo_perms for this user
318 Link.where(tail_uuid: self.uuid,
319 link_class: 'permission',
320 name: 'can_manage').destroy_all
322 # delete vm_login_perms for this user
323 Link.where(tail_uuid: self.uuid,
324 link_class: 'permission',
325 name: 'can_login').destroy_all
327 # delete "All users" group read permissions for this user
328 Link.where(tail_uuid: self.uuid,
329 head_uuid: all_users_group_uuid,
330 link_class: 'permission').destroy_all
332 # delete any signatures by this user
333 Link.where(link_class: 'signature',
334 tail_uuid: self.uuid).destroy_all
336 # delete tokens for this user
337 ApiClientAuthorization.where(user_id: self.id).destroy_all
338 # delete ssh keys for this user
339 AuthorizedKey.where(owner_uuid: self.uuid).destroy_all
340 AuthorizedKey.where(authorized_user_uuid: self.uuid).destroy_all
342 # delete user preferences (including profile)
345 # mark the user as inactive
346 self.is_admin = false # can't be admin and inactive
347 self.is_active = false
348 forget_cached_group_perms
352 # Called from ArvadosModel
353 def set_default_owner
354 self.owner_uuid = system_user_uuid
357 def must_unsetup_to_deactivate
358 if !self.new_record? &&
359 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
360 self.uuid[0..4] != Rails.configuration.ClusterID
361 # OK to update our local record to whatever the LoginCluster
362 # reports, because self-activate is not allowed.
364 elsif self.is_active_changed? &&
365 self.is_active_was &&
368 # When a user is set up, they are added to the "All users"
369 # group. A user that is part of the "All users" group is
370 # allowed to self-activate.
372 # It doesn't make sense to deactivate a user (set is_active =
373 # false) without first removing them from the "All users" group,
374 # because they would be able to immediately reactivate
377 # The 'unsetup' method removes the user from the "All users"
378 # group (and also sets is_active = false) so send a message
379 # explaining the correct way to deactivate a user.
381 if Link.where(tail_uuid: self.uuid,
382 head_uuid: all_users_group_uuid,
383 link_class: 'permission').any?
384 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
389 def set_initial_username(requested: false)
390 if !requested.is_a?(String) || requested.empty?
391 email_parts = email.partition("@")
392 local_parts = email_parts.first.partition("+")
393 if email_parts.any?(&:empty?)
395 elsif not local_parts.first.empty?
396 requested = local_parts.first
398 requested = email_parts.first
401 requested.sub!(/^[^A-Za-z]+/, "")
402 requested.gsub!(/[^A-Za-z0-9]/, "")
403 unless requested.empty?
404 self.username = find_usable_username_from(requested)
408 # Move this user's (i.e., self's) owned items to new_owner_uuid and
409 # new_user_uuid (for things normally owned directly by the user).
411 # If redirect_auth is true, also reassign auth tokens and ssh keys,
412 # and redirect this account to redirect_to_user_uuid, i.e., when a
413 # caller authenticates to this account in the future, the account
414 # redirect_to_user_uuid account will be used instead.
416 # current_user must have admin privileges, i.e., the caller is
417 # responsible for checking permission to do this.
418 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
419 raise PermissionDeniedError if !current_user.andand.is_admin
420 raise "Missing new_owner_uuid" if !new_owner_uuid
421 raise "Missing new_user_uuid" if !new_user_uuid
422 transaction(requires_new: true) do
424 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
426 new_user = User.where(uuid: new_user_uuid).first
427 raise "user does not exist" if !new_user
428 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
430 self.clear_permissions
431 new_user.clear_permissions
433 # If 'self' is a remote user, don't transfer authorizations
434 # (i.e. ability to access the account) to the new user, because
435 # that gives the remote site the ability to access the 'new'
436 # user account that takes over the 'self' account.
438 # If 'self' is a local user, it is okay to transfer
439 # authorizations, even if the 'new' user is a remote account,
440 # because the remote site does not gain the ability to access an
441 # account it could not before.
443 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
444 # Existing API tokens and ssh keys are updated to authenticate
446 ApiClientAuthorization.
448 update_all(user_id: new_user.id)
451 [AuthorizedKey, :owner_uuid],
452 [AuthorizedKey, :authorized_user_uuid],
458 # Destroy API tokens and ssh keys associated with the old
460 ApiClientAuthorization.where(user_id: id).destroy_all
461 AuthorizedKey.where(owner_uuid: uuid).destroy_all
462 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
469 # References to the old user UUID in the context of a user ID
470 # (rather than a "home project" in the project hierarchy) are
471 # updated to point to the new user.
472 user_updates.each do |klass, column|
473 klass.where(column => uuid).update_all(column => new_user.uuid)
476 # Need to update repository names to new username
478 old_repo_name_re = /^#{Regexp.escape(username)}\//
479 Repository.where(:owner_uuid => uuid).each do |repo|
480 repo.owner_uuid = new_user.uuid
481 repo_name_sub = "#{new_user.username}/"
482 name = repo.name.sub(old_repo_name_re, repo_name_sub)
483 while (conflict = Repository.where(:name => name).first) != nil
484 repo_name_sub += "migrated"
485 name = repo.name.sub(old_repo_name_re, repo_name_sub)
492 # References to the merged user's "home project" are updated to
493 # point to new_owner_uuid.
494 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
495 next if [ApiClientAuthorization,
499 Repository].include?(klass)
500 next if !klass.columns.collect(&:name).include?('owner_uuid')
501 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
504 if redirect_to_new_user
505 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
507 skip_check_permissions_against_full_refresh do
508 update_permissions self.uuid, self.uuid, CAN_MANAGE_PERM
509 update_permissions new_user.uuid, new_user.uuid, CAN_MANAGE_PERM
510 update_permissions new_user.owner_uuid, new_user.uuid, CAN_MANAGE_PERM
512 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
519 while (uuid = user.redirect_to_user_uuid)
521 nextuser = User.unscoped.find_by_uuid(uuid)
523 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
528 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
534 def self.register info
535 # login info expected fields, all can be optional but at minimum
536 # must supply either 'identity_url' or 'email'
548 identity_url = info['identity_url']
550 if identity_url && identity_url.length > 0
551 # Only local users can create sessions, hence uuid_like_pattern
553 user = User.unscoped.where('identity_url = ? and uuid like ?',
555 User.uuid_like_pattern).first
556 primary_user = user.redirects_to if user
560 # identity url is unset or didn't find matching record.
561 emails = [info['email']] + (info['alternate_emails'] || [])
562 emails.select! {|em| !em.nil? && !em.empty?}
564 User.unscoped.where('email in (?) and uuid like ?',
566 User.uuid_like_pattern).each do |user|
568 primary_user = user.redirects_to
569 elsif primary_user.uuid != user.redirects_to.uuid
570 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
576 # New user registration
577 primary_user = User.new(:owner_uuid => system_user_uuid,
579 :is_active => Rails.configuration.Users.NewUsersAreActive)
581 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
582 primary_user.identity_url = info['identity_url'] if identity_url
585 primary_user.email = info['email'] if info['email']
586 primary_user.first_name = info['first_name'] if info['first_name']
587 primary_user.last_name = info['last_name'] if info['last_name']
589 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
590 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
593 act_as_system_user do
602 def self.attributes_required_columns
604 'can_write' => ['owner_uuid', 'uuid'],
605 'can_manage' => ['owner_uuid', 'uuid'],
609 def change_all_uuid_refs(old_uuid:, new_uuid:)
610 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
611 klass.columns.each do |col|
612 if col.name.end_with?('_uuid')
613 column = col.name.to_sym
614 klass.where(column => old_uuid).update_all(column => new_uuid)
620 def ensure_ownership_path_leads_to_user
624 def permission_to_update
625 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
626 current_user.andand.is_admin
628 # users must be able to update themselves (even if they are
629 # inactive) in order to create sessions
630 self == current_user or super
634 def permission_to_create
635 current_user.andand.is_admin or
636 (self == current_user &&
637 self.redirect_to_user_uuid.nil? &&
638 self.is_active == Rails.configuration.Users.NewUsersAreActive)
642 return if self.uuid.end_with?('anonymouspublic')
643 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
644 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
645 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
646 Rails.configuration.Users.AutoAdminFirstUser)
648 self.is_active = true
652 def find_usable_username_from(basename)
653 # If "basename" is a usable username, return that.
654 # Otherwise, find a unique username "basenameN", where N is the
655 # smallest integer greater than 1, and return that.
656 # Return nil if a unique username can't be found after reasonable
658 quoted_name = self.class.connection.quote_string(basename)
659 next_username = basename
661 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
663 next_username = "%s%i" % [basename, next_suffix]
665 0.upto(6).each do |suffix_len|
666 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
668 where("username like '#{pattern}'").
670 order('username asc').
672 if other_user.username > next_username
674 elsif other_user.username == next_username
676 next_username = "%s%i" % [basename, next_suffix]
679 return next_username if (next_username.size <= pattern.size)
684 def prevent_privilege_escalation
685 if current_user.andand.is_admin
688 if self.is_active_changed?
689 if self.is_active != self.is_active_was
690 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
691 self.is_active = self.is_active_was
694 if self.is_admin_changed?
695 if self.is_admin != self.is_admin_was
696 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
697 self.is_admin = self.is_admin_was
703 def prevent_inactive_admin
704 if self.is_admin and not self.is_active
705 # There is no known use case for the strange set of permissions
706 # that would result from this change. It's safest to assume it's
707 # a mistake and disallow it outright.
708 raise "Admin users cannot be inactive"
713 def prevent_nonadmin_system_root
714 if self.uuid == system_user_uuid and self.is_admin_changed? and !self.is_admin
715 raise "System root user cannot be non-admin"
720 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
721 nextpaths = graph[start]
722 return merged if !nextpaths
723 return merged if upstream_path.has_key? start
724 upstream_path[start] = true
725 upstream_mask ||= ALL_PERMISSIONS
726 nextpaths.each do |head, mask|
729 merged[head][k] ||= v if upstream_mask[k]
731 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
733 upstream_path.delete start
737 def create_user_repo_link(repo_name)
738 # repo_name is optional
740 logger.warn ("Repository name not given for #{self.uuid}.")
744 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
745 logger.info { "repo uuid: " + repo[:uuid] }
746 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
747 link_class: "permission",
748 name: "can_manage").first_or_create!
749 logger.info { "repo permission: " + repo_perm[:uuid] }
753 # create login permission for the given vm_uuid, if it does not already exist
754 def create_vm_login_permission_link(vm_uuid, repo_name)
755 # vm uuid is optional
756 return if vm_uuid == ""
758 vm = VirtualMachine.where(uuid: vm_uuid).first
760 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
761 raise "No vm found for #{vm_uuid}"
764 logger.info { "vm uuid: " + vm[:uuid] }
766 tail_uuid: uuid, head_uuid: vm.uuid,
767 link_class: "permission", name: "can_login",
772 select { |link| link.properties["username"] == repo_name }.
776 create(login_attrs.merge(properties: {"username" => repo_name}))
778 logger.info { "login permission: " + login_perm[:uuid] }
782 def add_to_all_users_group
783 resp = [Link.where(tail_uuid: self.uuid,
784 head_uuid: all_users_group_uuid,
785 link_class: 'permission',
786 name: 'can_write').first ||
787 Link.create(tail_uuid: self.uuid,
788 head_uuid: all_users_group_uuid,
789 link_class: 'permission',
791 if Rails.configuration.Users.ActivatedUsersAreVisibleToOthers
792 resp += [Link.where(tail_uuid: all_users_group_uuid,
793 head_uuid: self.uuid,
794 link_class: 'permission',
795 name: 'can_read').first ||
796 Link.create(tail_uuid: all_users_group_uuid,
797 head_uuid: self.uuid,
798 link_class: 'permission',
804 # Give the special "System group" permission to manage this user and
805 # all of this user's stuff.
806 def add_system_group_permission_link
807 return true if uuid == system_user_uuid
808 act_as_system_user do
809 Link.create(link_class: 'permission',
811 tail_uuid: system_group_uuid,
812 head_uuid: self.uuid)
816 # Send admin notifications
817 def send_admin_notifications
818 AdminNotifier.new_user(self).deliver_now
819 if not self.is_active then
820 AdminNotifier.new_inactive_user(self).deliver_now
824 # Automatically setup if is_active flag turns on
825 def setup_on_activate
826 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
828 (new_record? || saved_change_to_is_active? || will_save_change_to_is_active?)
833 # Automatically setup new user during creation
834 def auto_setup_new_user
838 # Send notification if the user saved profile for the first time
839 def send_profile_created_notification
840 if saved_change_to_prefs?
841 if prefs_before_last_save.andand.empty? || !prefs_before_last_save.andand['profile']
842 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
843 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
848 def verify_repositories_empty
849 unless repositories.first.nil?
850 errors.add(:username, "can't be unset when the user owns repositories")
855 def sync_repository_names
856 old_name_re = /^#{Regexp.escape(username_before_last_save)}\//
857 name_sub = "#{username}/"
858 repositories.find_each do |repo|
859 repo.name = repo.name.sub(old_name_re, name_sub)
864 def identity_url_nil_if_empty
865 if identity_url == ""
866 self.identity_url = nil