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 before_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 if repo_name.nil? && username && Rails.configuration.Users.AutoSetupNewUsersWithRepository
228 repo_name = "#{username}/#{username}"
231 repo_perm = if repo_name
232 create_user_repo_link repo_name
235 # Add virtual machine
236 if vm_uuid.nil? and !Rails.configuration.Users.AutoSetupNewUsersWithVmUUID.empty?
237 vm_uuid = Rails.configuration.Users.AutoSetupNewUsersWithVmUUID
240 vm_login_perm = if vm_uuid && username
241 create_vm_login_permission_link(vm_uuid, username)
245 if send_notification_email.nil?
246 send_notification_email = Rails.configuration.Mail.SendUserSetupNotificationEmail
249 if newly_invited and send_notification_email and !Rails.configuration.Users.UserSetupMailText.empty?
251 UserNotifier.account_is_setup(self).deliver_now
253 logger.warn "Failed to send email to #{self.email}: #{e}"
257 return [repo_perm, vm_login_perm, group_perm, self].compact
260 # delete user signatures, login, repo, and vm perms, and mark as inactive
262 # delete oid_login_perms for this user
264 # note: these permission links are obsolete, they have no effect
265 # on anything and they are not created for new users.
266 Link.where(tail_uuid: self.email,
267 link_class: 'permission',
268 name: 'can_login').destroy_all
270 # delete repo_perms for this user
271 Link.where(tail_uuid: self.uuid,
272 link_class: 'permission',
273 name: 'can_manage').destroy_all
275 # delete vm_login_perms for this user
276 Link.where(tail_uuid: self.uuid,
277 link_class: 'permission',
278 name: 'can_login').destroy_all
280 # delete "All users" group read permissions for this user
281 Link.where(tail_uuid: self.uuid,
282 head_uuid: all_users_group_uuid,
283 link_class: 'permission',
284 name: 'can_read').destroy_all
286 # delete any signatures by this user
287 Link.where(link_class: 'signature',
288 tail_uuid: self.uuid).destroy_all
290 # delete user preferences (including profile)
293 # mark the user as inactive
294 self.is_admin = false # can't be admin and inactive
295 self.is_active = false
299 def must_unsetup_to_deactivate
300 if !self.new_record? &&
301 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
302 self.uuid[0..4] != Rails.configuration.ClusterID
303 # OK to update our local record to whatever the LoginCluster
304 # reports, because self-activate is not allowed.
306 elsif self.is_active_changed? &&
307 self.is_active_was &&
310 # When a user is set up, they are added to the "All users"
311 # group. A user that is part of the "All users" group is
312 # allowed to self-activate.
314 # It doesn't make sense to deactivate a user (set is_active =
315 # false) without first removing them from the "All users" group,
316 # because they would be able to immediately reactivate
319 # The 'unsetup' method removes the user from the "All users"
320 # group (and also sets is_active = false) so send a message
321 # explaining the correct way to deactivate a user.
323 if Link.where(tail_uuid: self.uuid,
324 head_uuid: all_users_group_uuid,
325 link_class: 'permission',
326 name: 'can_read').any?
327 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
332 def set_initial_username(requested: false)
333 if !requested.is_a?(String) || requested.empty?
334 email_parts = email.partition("@")
335 local_parts = email_parts.first.partition("+")
336 if email_parts.any?(&:empty?)
338 elsif not local_parts.first.empty?
339 requested = local_parts.first
341 requested = email_parts.first
344 requested.sub!(/^[^A-Za-z]+/, "")
345 requested.gsub!(/[^A-Za-z0-9]/, "")
346 unless requested.empty?
347 self.username = find_usable_username_from(requested)
351 def update_uuid(new_uuid:)
352 if !current_user.andand.is_admin
353 raise PermissionDeniedError
355 if uuid == system_user_uuid || uuid == anonymous_user_uuid
356 raise "update_uuid cannot update system accounts"
358 if self.class != self.class.resource_class_for_uuid(new_uuid)
359 raise "invalid new_uuid #{new_uuid.inspect}"
361 transaction(requires_new: true) do
365 save!(validate: false)
366 change_all_uuid_refs(old_uuid: old_uuid, new_uuid: new_uuid)
367 ActiveRecord::Base.connection.exec_update %{
368 update #{PERMISSION_VIEW} set user_uuid=$1 where user_uuid = $2
370 'User.update_uuid.update_permissions_user_uuid',
373 ActiveRecord::Base.connection.exec_update %{
374 update #{PERMISSION_VIEW} set target_uuid=$1 where target_uuid = $2
376 'User.update_uuid.update_permissions_target_uuid',
382 # Move this user's (i.e., self's) owned items to new_owner_uuid and
383 # new_user_uuid (for things normally owned directly by the user).
385 # If redirect_auth is true, also reassign auth tokens and ssh keys,
386 # and redirect this account to redirect_to_user_uuid, i.e., when a
387 # caller authenticates to this account in the future, the account
388 # redirect_to_user_uuid account will be used instead.
390 # current_user must have admin privileges, i.e., the caller is
391 # responsible for checking permission to do this.
392 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
393 raise PermissionDeniedError if !current_user.andand.is_admin
394 raise "Missing new_owner_uuid" if !new_owner_uuid
395 raise "Missing new_user_uuid" if !new_user_uuid
396 transaction(requires_new: true) do
398 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
400 new_user = User.where(uuid: new_user_uuid).first
401 raise "user does not exist" if !new_user
402 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
404 self.clear_permissions
405 new_user.clear_permissions
407 # If 'self' is a remote user, don't transfer authorizations
408 # (i.e. ability to access the account) to the new user, because
409 # that gives the remote site the ability to access the 'new'
410 # user account that takes over the 'self' account.
412 # If 'self' is a local user, it is okay to transfer
413 # authorizations, even if the 'new' user is a remote account,
414 # because the remote site does not gain the ability to access an
415 # account it could not before.
417 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
418 # Existing API tokens and ssh keys are updated to authenticate
420 ApiClientAuthorization.
422 update_all(user_id: new_user.id)
425 [AuthorizedKey, :owner_uuid],
426 [AuthorizedKey, :authorized_user_uuid],
432 # Destroy API tokens and ssh keys associated with the old
434 ApiClientAuthorization.where(user_id: id).destroy_all
435 AuthorizedKey.where(owner_uuid: uuid).destroy_all
436 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
443 # References to the old user UUID in the context of a user ID
444 # (rather than a "home project" in the project hierarchy) are
445 # updated to point to the new user.
446 user_updates.each do |klass, column|
447 klass.where(column => uuid).update_all(column => new_user.uuid)
450 # Need to update repository names to new username
452 old_repo_name_re = /^#{Regexp.escape(username)}\//
453 Repository.where(:owner_uuid => uuid).each do |repo|
454 repo.owner_uuid = new_user.uuid
455 repo_name_sub = "#{new_user.username}/"
456 name = repo.name.sub(old_repo_name_re, repo_name_sub)
457 while (conflict = Repository.where(:name => name).first) != nil
458 repo_name_sub += "migrated"
459 name = repo.name.sub(old_repo_name_re, repo_name_sub)
466 # References to the merged user's "home project" are updated to
467 # point to new_owner_uuid.
468 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
469 next if [ApiClientAuthorization,
473 Repository].include?(klass)
474 next if !klass.columns.collect(&:name).include?('owner_uuid')
475 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
478 if redirect_to_new_user
479 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
481 skip_check_permissions_against_full_refresh do
482 update_permissions self.uuid, self.uuid, CAN_MANAGE_PERM
483 update_permissions new_user.uuid, new_user.uuid, CAN_MANAGE_PERM
484 update_permissions new_user.owner_uuid, new_user.uuid, CAN_MANAGE_PERM
486 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
493 while (uuid = user.redirect_to_user_uuid)
495 nextuser = User.unscoped.find_by_uuid(uuid)
497 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
502 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
508 def self.register info
509 # login info expected fields, all can be optional but at minimum
510 # must supply either 'identity_url' or 'email'
522 identity_url = info['identity_url']
524 if identity_url && identity_url.length > 0
525 # Only local users can create sessions, hence uuid_like_pattern
527 user = User.unscoped.where('identity_url = ? and uuid like ?',
529 User.uuid_like_pattern).first
530 primary_user = user.redirects_to if user
534 # identity url is unset or didn't find matching record.
535 emails = [info['email']] + (info['alternate_emails'] || [])
536 emails.select! {|em| !em.nil? && !em.empty?}
538 User.unscoped.where('email in (?) and uuid like ?',
540 User.uuid_like_pattern).each do |user|
542 primary_user = user.redirects_to
543 elsif primary_user.uuid != user.redirects_to.uuid
544 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
550 # New user registration
551 primary_user = User.new(:owner_uuid => system_user_uuid,
553 :is_active => Rails.configuration.Users.NewUsersAreActive)
555 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
556 primary_user.identity_url = info['identity_url'] if identity_url
559 primary_user.email = info['email'] if info['email']
560 primary_user.first_name = info['first_name'] if info['first_name']
561 primary_user.last_name = info['last_name'] if info['last_name']
563 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
564 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
567 act_as_system_user do
576 def change_all_uuid_refs(old_uuid:, new_uuid:)
577 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
578 klass.columns.each do |col|
579 if col.name.end_with?('_uuid')
580 column = col.name.to_sym
581 klass.where(column => old_uuid).update_all(column => new_uuid)
587 def ensure_ownership_path_leads_to_user
591 def permission_to_update
592 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
593 current_user.andand.is_admin
595 # users must be able to update themselves (even if they are
596 # inactive) in order to create sessions
597 self == current_user or super
601 def permission_to_create
602 current_user.andand.is_admin or
603 (self == current_user &&
604 self.redirect_to_user_uuid.nil? &&
605 self.is_active == Rails.configuration.Users.NewUsersAreActive)
609 return if self.uuid.end_with?('anonymouspublic')
610 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
611 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
612 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
613 Rails.configuration.Users.AutoAdminFirstUser)
615 self.is_active = true
619 def find_usable_username_from(basename)
620 # If "basename" is a usable username, return that.
621 # Otherwise, find a unique username "basenameN", where N is the
622 # smallest integer greater than 1, and return that.
623 # Return nil if a unique username can't be found after reasonable
625 quoted_name = self.class.connection.quote_string(basename)
626 next_username = basename
628 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
630 next_username = "%s%i" % [basename, next_suffix]
632 0.upto(6).each do |suffix_len|
633 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
635 where("username like '#{pattern}'").
637 order('username asc').
639 if other_user.username > next_username
641 elsif other_user.username == next_username
643 next_username = "%s%i" % [basename, next_suffix]
646 return next_username if (next_username.size <= pattern.size)
651 def prevent_privilege_escalation
652 if current_user.andand.is_admin
655 if self.is_active_changed?
656 if self.is_active != self.is_active_was
657 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
658 self.is_active = self.is_active_was
661 if self.is_admin_changed?
662 if self.is_admin != self.is_admin_was
663 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
664 self.is_admin = self.is_admin_was
670 def prevent_inactive_admin
671 if self.is_admin and not self.is_active
672 # There is no known use case for the strange set of permissions
673 # that would result from this change. It's safest to assume it's
674 # a mistake and disallow it outright.
675 raise "Admin users cannot be inactive"
680 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
681 nextpaths = graph[start]
682 return merged if !nextpaths
683 return merged if upstream_path.has_key? start
684 upstream_path[start] = true
685 upstream_mask ||= ALL_PERMISSIONS
686 nextpaths.each do |head, mask|
689 merged[head][k] ||= v if upstream_mask[k]
691 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
693 upstream_path.delete start
697 def create_user_repo_link(repo_name)
698 # repo_name is optional
700 logger.warn ("Repository name not given for #{self.uuid}.")
704 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
705 logger.info { "repo uuid: " + repo[:uuid] }
706 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
707 link_class: "permission",
708 name: "can_manage").first_or_create!
709 logger.info { "repo permission: " + repo_perm[:uuid] }
713 # create login permission for the given vm_uuid, if it does not already exist
714 def create_vm_login_permission_link(vm_uuid, repo_name)
715 # vm uuid is optional
716 return if vm_uuid == ""
718 vm = VirtualMachine.where(uuid: vm_uuid).first
720 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
721 raise "No vm found for #{vm_uuid}"
724 logger.info { "vm uuid: " + vm[:uuid] }
726 tail_uuid: uuid, head_uuid: vm.uuid,
727 link_class: "permission", name: "can_login",
732 select { |link| link.properties["username"] == repo_name }.
736 create(login_attrs.merge(properties: {"username" => repo_name}))
738 logger.info { "login permission: " + login_perm[:uuid] }
742 # add the user to the 'All users' group
743 def create_user_group_link
744 return (Link.where(tail_uuid: self.uuid,
745 head_uuid: all_users_group_uuid,
746 link_class: 'permission',
747 name: 'can_read').first or
748 Link.create(tail_uuid: self.uuid,
749 head_uuid: all_users_group_uuid,
750 link_class: 'permission',
754 # Give the special "System group" permission to manage this user and
755 # all of this user's stuff.
756 def add_system_group_permission_link
757 return true if uuid == system_user_uuid
758 act_as_system_user do
759 Link.create(link_class: 'permission',
761 tail_uuid: system_group_uuid,
762 head_uuid: self.uuid)
766 # Send admin notifications
767 def send_admin_notifications
768 AdminNotifier.new_user(self).deliver_now
769 if not self.is_active then
770 AdminNotifier.new_inactive_user(self).deliver_now
774 # Automatically setup if is_active flag turns on
775 def setup_on_activate
776 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
778 (new_record? || saved_change_to_is_active? || will_save_change_to_is_active?)
783 # Automatically setup new user during creation
784 def auto_setup_new_user
788 # Send notification if the user saved profile for the first time
789 def send_profile_created_notification
790 if saved_change_to_prefs?
791 if prefs_before_last_save.andand.empty? || !prefs_before_last_save.andand['profile']
792 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
793 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
798 def verify_repositories_empty
799 unless repositories.first.nil?
800 errors.add(:username, "can't be unset when the user owns repositories")
805 def sync_repository_names
806 old_name_re = /^#{Regexp.escape(username_before_last_save)}\//
807 name_sub = "#{username}/"
808 repositories.find_each do |repo|
809 repo.name = repo.name.sub(old_name_re, name_sub)