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 :verify_repositories_empty, :if => Proc.new {
28 username.nil? and username_changed?
30 after_update :setup_on_activate
32 before_create :check_auto_admin
33 before_create :set_initial_username, :if => Proc.new {
34 username.nil? and email
36 after_create :after_ownership_change
37 after_create :setup_on_activate
38 after_create :add_system_group_permission_link
39 after_create :auto_setup_new_user, :if => Proc.new {
40 Rails.configuration.Users.AutoSetupNewUsers and
41 (uuid != system_user_uuid) and
42 (uuid != anonymous_user_uuid) and
43 (uuid[0..4] == Rails.configuration.ClusterID)
45 after_create :send_admin_notifications
47 before_update :before_ownership_change
48 after_update :after_ownership_change
49 after_update :send_profile_created_notification
50 after_update :sync_repository_names, :if => Proc.new {
51 (uuid != system_user_uuid) and
52 saved_change_to_username? and
53 (not username_before_last_save.nil?)
55 before_destroy :clear_permissions
56 after_destroy :remove_self_from_permissions
58 has_many :authorized_keys, :foreign_key => :authorized_user_uuid, :primary_key => :uuid
59 has_many :repositories, foreign_key: :owner_uuid, primary_key: :uuid
61 default_scope { where('redirect_to_user_uuid is null') }
63 api_accessible :user, extend: :common do |t|
77 ALL_PERMISSIONS = {read: true, write: true, manage: true}
79 # Map numeric permission levels (see lib/create_permission_view.sql)
80 # back to read/write/manage flags.
84 {read: true, write: true},
85 {read: true, write: true, manage: true}]
94 "#{first_name} #{last_name}".strip
99 Rails.configuration.Users.NewUsersAreActive ||
100 self.groups_i_can(:read).select { |x| x.match(/-f+$/) }.first)
103 def groups_i_can(verb)
104 my_groups = self.group_permissions(VAL_FOR_PERM[verb]).keys
106 my_groups << anonymous_group_uuid
112 return true if is_admin
113 actions.each do |action, target|
115 if target.respond_to? :uuid
116 target_uuid = target.uuid
119 target = ArvadosModel.find_by_uuid(target_uuid)
122 next if target_uuid == self.uuid
124 target_owner_uuid = target.owner_uuid if target.respond_to? :owner_uuid
126 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: "$3"}
128 unless ActiveRecord::Base.connection.
130 SELECT 1 FROM #{PERMISSION_VIEW}
131 WHERE user_uuid in (#{user_uuids_subquery}) and
132 ((target_uuid = $2 and perm_level >= $3)
133 or (target_uuid = $4 and perm_level >= $3 and traverse_owned))
135 # "name" arg is a query label that appears in logs:
139 [nil, VAL_FOR_PERM[action]],
140 [nil, target_owner_uuid]]
148 def before_ownership_change
149 if owner_uuid_changed? and !self.owner_uuid_was.nil?
150 MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
151 update_permissions self.owner_uuid_was, self.uuid, REVOKE_PERM
155 def after_ownership_change
156 if saved_change_to_owner_uuid?
157 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
161 def clear_permissions
162 MaterializedPermission.where("user_uuid = ? and target_uuid != ?", uuid, uuid).delete_all
165 def forget_cached_group_perms
169 def remove_self_from_permissions
170 MaterializedPermission.where("target_uuid = ?", uuid).delete_all
171 check_permissions_against_full_refresh
174 # Return a hash of {user_uuid: group_perms}
176 # note: this does not account for permissions that a user gains by
177 # having can_manage on another user.
178 def self.all_group_permissions
180 ActiveRecord::Base.connection.
182 SELECT user_uuid, target_uuid, perm_level
183 FROM #{PERMISSION_VIEW}
186 # "name" arg is a query label that appears in logs:
187 "all_group_permissions").
188 rows.each do |user_uuid, group_uuid, max_p_val|
189 all_perms[user_uuid] ||= {}
190 all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
195 # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
196 # and perm_hash[:write] are true if this user can read and write
197 # objects owned by group_uuid.
198 def group_permissions(level=1)
200 if @group_perms.empty?
201 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: 1}
203 ActiveRecord::Base.connection.
205 SELECT target_uuid, perm_level
206 FROM #{PERMISSION_VIEW}
207 WHERE user_uuid in (#{user_uuids_subquery}) and perm_level >= 1
209 # "name" arg is a query label that appears in logs:
210 "User.group_permissions",
211 # "binds" arg is an array of [col_id, value] for '$1' vars:
213 rows.each do |group_uuid, max_p_val|
214 @group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
222 @group_perms.select {|k,v| v[:write] }
224 @group_perms.select {|k,v| v[:manage] }
226 raise "level must be 1, 2 or 3"
231 def setup(repo_name: nil, vm_uuid: nil, send_notification_email: nil)
232 newly_invited = Link.where(tail_uuid: self.uuid,
233 head_uuid: all_users_group_uuid,
234 link_class: 'permission',
235 name: 'can_read').empty?
237 # Add can_read link from this user to "all users" which makes this
238 # user "invited", and (depending on config) a link in the opposite
239 # direction which makes this user visible to other users.
240 group_perms = add_to_all_users_group
243 repo_perm = if (!repo_name.nil? || Rails.configuration.Users.AutoSetupNewUsersWithRepository) and !username.nil?
244 repo_name ||= "#{username}/#{username}"
245 create_user_repo_link repo_name
248 # Add virtual machine
249 if vm_uuid.nil? and !Rails.configuration.Users.AutoSetupNewUsersWithVmUUID.empty?
250 vm_uuid = Rails.configuration.Users.AutoSetupNewUsersWithVmUUID
253 vm_login_perm = if vm_uuid && username
254 create_vm_login_permission_link(vm_uuid, username)
258 if send_notification_email.nil?
259 send_notification_email = Rails.configuration.Mail.SendUserSetupNotificationEmail
262 if newly_invited and send_notification_email and !Rails.configuration.Users.UserSetupMailText.empty?
264 UserNotifier.account_is_setup(self).deliver_now
266 logger.warn "Failed to send email to #{self.email}: #{e}"
270 forget_cached_group_perms
272 return [repo_perm, vm_login_perm, *group_perms, self].compact
275 # delete user signatures, login, repo, and vm perms, and mark as inactive
277 # delete oid_login_perms for this user
279 # note: these permission links are obsolete, they have no effect
280 # on anything and they are not created for new users.
281 Link.where(tail_uuid: self.email,
282 link_class: 'permission',
283 name: 'can_login').destroy_all
285 # delete repo_perms for this user
286 Link.where(tail_uuid: self.uuid,
287 link_class: 'permission',
288 name: 'can_manage').destroy_all
290 # delete vm_login_perms for this user
291 Link.where(tail_uuid: self.uuid,
292 link_class: 'permission',
293 name: 'can_login').destroy_all
295 # delete "All users" group read permissions for this user
296 Link.where(tail_uuid: self.uuid,
297 head_uuid: all_users_group_uuid,
298 link_class: 'permission',
299 name: 'can_read').destroy_all
301 # delete any signatures by this user
302 Link.where(link_class: 'signature',
303 tail_uuid: self.uuid).destroy_all
305 # delete tokens for this user
306 ApiClientAuthorization.where(user_id: self.id).destroy_all
307 # delete ssh keys for this user
308 AuthorizedKey.where(owner_uuid: self.uuid).destroy_all
309 AuthorizedKey.where(authorized_user_uuid: self.uuid).destroy_all
311 # delete user preferences (including profile)
314 # mark the user as inactive
315 self.is_admin = false # can't be admin and inactive
316 self.is_active = false
317 forget_cached_group_perms
321 def must_unsetup_to_deactivate
322 if !self.new_record? &&
323 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
324 self.uuid[0..4] != Rails.configuration.ClusterID
325 # OK to update our local record to whatever the LoginCluster
326 # reports, because self-activate is not allowed.
328 elsif self.is_active_changed? &&
329 self.is_active_was &&
332 # When a user is set up, they are added to the "All users"
333 # group. A user that is part of the "All users" group is
334 # allowed to self-activate.
336 # It doesn't make sense to deactivate a user (set is_active =
337 # false) without first removing them from the "All users" group,
338 # because they would be able to immediately reactivate
341 # The 'unsetup' method removes the user from the "All users"
342 # group (and also sets is_active = false) so send a message
343 # explaining the correct way to deactivate a user.
345 if Link.where(tail_uuid: self.uuid,
346 head_uuid: all_users_group_uuid,
347 link_class: 'permission',
348 name: 'can_read').any?
349 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
354 def set_initial_username(requested: false)
355 if !requested.is_a?(String) || requested.empty?
356 email_parts = email.partition("@")
357 local_parts = email_parts.first.partition("+")
358 if email_parts.any?(&:empty?)
360 elsif not local_parts.first.empty?
361 requested = local_parts.first
363 requested = email_parts.first
366 requested.sub!(/^[^A-Za-z]+/, "")
367 requested.gsub!(/[^A-Za-z0-9]/, "")
368 unless requested.empty?
369 self.username = find_usable_username_from(requested)
373 # Move this user's (i.e., self's) owned items to new_owner_uuid and
374 # new_user_uuid (for things normally owned directly by the user).
376 # If redirect_auth is true, also reassign auth tokens and ssh keys,
377 # and redirect this account to redirect_to_user_uuid, i.e., when a
378 # caller authenticates to this account in the future, the account
379 # redirect_to_user_uuid account will be used instead.
381 # current_user must have admin privileges, i.e., the caller is
382 # responsible for checking permission to do this.
383 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
384 raise PermissionDeniedError if !current_user.andand.is_admin
385 raise "Missing new_owner_uuid" if !new_owner_uuid
386 raise "Missing new_user_uuid" if !new_user_uuid
387 transaction(requires_new: true) do
389 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
391 new_user = User.where(uuid: new_user_uuid).first
392 raise "user does not exist" if !new_user
393 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
395 self.clear_permissions
396 new_user.clear_permissions
398 # If 'self' is a remote user, don't transfer authorizations
399 # (i.e. ability to access the account) to the new user, because
400 # that gives the remote site the ability to access the 'new'
401 # user account that takes over the 'self' account.
403 # If 'self' is a local user, it is okay to transfer
404 # authorizations, even if the 'new' user is a remote account,
405 # because the remote site does not gain the ability to access an
406 # account it could not before.
408 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
409 # Existing API tokens and ssh keys are updated to authenticate
411 ApiClientAuthorization.
413 update_all(user_id: new_user.id)
416 [AuthorizedKey, :owner_uuid],
417 [AuthorizedKey, :authorized_user_uuid],
423 # Destroy API tokens and ssh keys associated with the old
425 ApiClientAuthorization.where(user_id: id).destroy_all
426 AuthorizedKey.where(owner_uuid: uuid).destroy_all
427 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
434 # References to the old user UUID in the context of a user ID
435 # (rather than a "home project" in the project hierarchy) are
436 # updated to point to the new user.
437 user_updates.each do |klass, column|
438 klass.where(column => uuid).update_all(column => new_user.uuid)
441 # Need to update repository names to new username
443 old_repo_name_re = /^#{Regexp.escape(username)}\//
444 Repository.where(:owner_uuid => uuid).each do |repo|
445 repo.owner_uuid = new_user.uuid
446 repo_name_sub = "#{new_user.username}/"
447 name = repo.name.sub(old_repo_name_re, repo_name_sub)
448 while (conflict = Repository.where(:name => name).first) != nil
449 repo_name_sub += "migrated"
450 name = repo.name.sub(old_repo_name_re, repo_name_sub)
457 # References to the merged user's "home project" are updated to
458 # point to new_owner_uuid.
459 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
460 next if [ApiClientAuthorization,
464 Repository].include?(klass)
465 next if !klass.columns.collect(&:name).include?('owner_uuid')
466 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
469 if redirect_to_new_user
470 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
472 skip_check_permissions_against_full_refresh do
473 update_permissions self.uuid, self.uuid, CAN_MANAGE_PERM
474 update_permissions new_user.uuid, new_user.uuid, CAN_MANAGE_PERM
475 update_permissions new_user.owner_uuid, new_user.uuid, CAN_MANAGE_PERM
477 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
484 while (uuid = user.redirect_to_user_uuid)
486 nextuser = User.unscoped.find_by_uuid(uuid)
488 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
493 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
499 def self.register info
500 # login info expected fields, all can be optional but at minimum
501 # must supply either 'identity_url' or 'email'
513 identity_url = info['identity_url']
515 if identity_url && identity_url.length > 0
516 # Only local users can create sessions, hence uuid_like_pattern
518 user = User.unscoped.where('identity_url = ? and uuid like ?',
520 User.uuid_like_pattern).first
521 primary_user = user.redirects_to if user
525 # identity url is unset or didn't find matching record.
526 emails = [info['email']] + (info['alternate_emails'] || [])
527 emails.select! {|em| !em.nil? && !em.empty?}
529 User.unscoped.where('email in (?) and uuid like ?',
531 User.uuid_like_pattern).each do |user|
533 primary_user = user.redirects_to
534 elsif primary_user.uuid != user.redirects_to.uuid
535 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
541 # New user registration
542 primary_user = User.new(:owner_uuid => system_user_uuid,
544 :is_active => Rails.configuration.Users.NewUsersAreActive)
546 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
547 primary_user.identity_url = info['identity_url'] if identity_url
550 primary_user.email = info['email'] if info['email']
551 primary_user.first_name = info['first_name'] if info['first_name']
552 primary_user.last_name = info['last_name'] if info['last_name']
554 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
555 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
558 act_as_system_user do
567 def change_all_uuid_refs(old_uuid:, new_uuid:)
568 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
569 klass.columns.each do |col|
570 if col.name.end_with?('_uuid')
571 column = col.name.to_sym
572 klass.where(column => old_uuid).update_all(column => new_uuid)
578 def ensure_ownership_path_leads_to_user
582 def permission_to_update
583 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
584 current_user.andand.is_admin
586 # users must be able to update themselves (even if they are
587 # inactive) in order to create sessions
588 self == current_user or super
592 def permission_to_create
593 current_user.andand.is_admin or
594 (self == current_user &&
595 self.redirect_to_user_uuid.nil? &&
596 self.is_active == Rails.configuration.Users.NewUsersAreActive)
600 return if self.uuid.end_with?('anonymouspublic')
601 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
602 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
603 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
604 Rails.configuration.Users.AutoAdminFirstUser)
606 self.is_active = true
610 def find_usable_username_from(basename)
611 # If "basename" is a usable username, return that.
612 # Otherwise, find a unique username "basenameN", where N is the
613 # smallest integer greater than 1, and return that.
614 # Return nil if a unique username can't be found after reasonable
616 quoted_name = self.class.connection.quote_string(basename)
617 next_username = basename
619 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
621 next_username = "%s%i" % [basename, next_suffix]
623 0.upto(6).each do |suffix_len|
624 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
626 where("username like '#{pattern}'").
628 order('username asc').
630 if other_user.username > next_username
632 elsif other_user.username == next_username
634 next_username = "%s%i" % [basename, next_suffix]
637 return next_username if (next_username.size <= pattern.size)
642 def prevent_privilege_escalation
643 if current_user.andand.is_admin
646 if self.is_active_changed?
647 if self.is_active != self.is_active_was
648 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
649 self.is_active = self.is_active_was
652 if self.is_admin_changed?
653 if self.is_admin != self.is_admin_was
654 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
655 self.is_admin = self.is_admin_was
661 def prevent_inactive_admin
662 if self.is_admin and not self.is_active
663 # There is no known use case for the strange set of permissions
664 # that would result from this change. It's safest to assume it's
665 # a mistake and disallow it outright.
666 raise "Admin users cannot be inactive"
671 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
672 nextpaths = graph[start]
673 return merged if !nextpaths
674 return merged if upstream_path.has_key? start
675 upstream_path[start] = true
676 upstream_mask ||= ALL_PERMISSIONS
677 nextpaths.each do |head, mask|
680 merged[head][k] ||= v if upstream_mask[k]
682 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
684 upstream_path.delete start
688 def create_user_repo_link(repo_name)
689 # repo_name is optional
691 logger.warn ("Repository name not given for #{self.uuid}.")
695 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
696 logger.info { "repo uuid: " + repo[:uuid] }
697 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
698 link_class: "permission",
699 name: "can_manage").first_or_create!
700 logger.info { "repo permission: " + repo_perm[:uuid] }
704 # create login permission for the given vm_uuid, if it does not already exist
705 def create_vm_login_permission_link(vm_uuid, repo_name)
706 # vm uuid is optional
707 return if vm_uuid == ""
709 vm = VirtualMachine.where(uuid: vm_uuid).first
711 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
712 raise "No vm found for #{vm_uuid}"
715 logger.info { "vm uuid: " + vm[:uuid] }
717 tail_uuid: uuid, head_uuid: vm.uuid,
718 link_class: "permission", name: "can_login",
723 select { |link| link.properties["username"] == repo_name }.
727 create(login_attrs.merge(properties: {"username" => repo_name}))
729 logger.info { "login permission: " + login_perm[:uuid] }
733 def add_to_all_users_group
734 resp = [Link.where(tail_uuid: self.uuid,
735 head_uuid: all_users_group_uuid,
736 link_class: 'permission',
737 name: 'can_read').first ||
738 Link.create(tail_uuid: self.uuid,
739 head_uuid: all_users_group_uuid,
740 link_class: 'permission',
742 if Rails.configuration.Users.ActivatedUsersAreVisibleToOthers
743 resp += [Link.where(tail_uuid: all_users_group_uuid,
744 head_uuid: self.uuid,
745 link_class: 'permission',
746 name: 'can_read').first ||
747 Link.create(tail_uuid: all_users_group_uuid,
748 head_uuid: self.uuid,
749 link_class: 'permission',
755 # Give the special "System group" permission to manage this user and
756 # all of this user's stuff.
757 def add_system_group_permission_link
758 return true if uuid == system_user_uuid
759 act_as_system_user do
760 Link.create(link_class: 'permission',
762 tail_uuid: system_group_uuid,
763 head_uuid: self.uuid)
767 # Send admin notifications
768 def send_admin_notifications
769 AdminNotifier.new_user(self).deliver_now
770 if not self.is_active then
771 AdminNotifier.new_inactive_user(self).deliver_now
775 # Automatically setup if is_active flag turns on
776 def setup_on_activate
777 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
779 (new_record? || saved_change_to_is_active? || will_save_change_to_is_active?)
784 # Automatically setup new user during creation
785 def auto_setup_new_user
789 # Send notification if the user saved profile for the first time
790 def send_profile_created_notification
791 if saved_change_to_prefs?
792 if prefs_before_last_save.andand.empty? || !prefs_before_last_save.andand['profile']
793 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
794 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
799 def verify_repositories_empty
800 unless repositories.first.nil?
801 errors.add(:username, "can't be unset when the user owns repositories")
806 def sync_repository_names
807 old_name_re = /^#{Regexp.escape(username_before_last_save)}\//
808 name_sub = "#{username}/"
809 repositories.find_each do |repo|
810 repo.name = repo.name.sub(old_name_re, name_sub)
815 def identity_url_nil_if_empty
816 if identity_url == ""
817 self.identity_url = nil