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}]
95 "#{first_name} #{last_name}".strip
100 Rails.configuration.Users.NewUsersAreActive ||
101 self.groups_i_can(:read).select { |x| x.match(/-f+$/) }.first)
104 def groups_i_can(verb)
105 my_groups = self.group_permissions(VAL_FOR_PERM[verb]).keys
107 my_groups << anonymous_group_uuid
113 return true if is_admin
114 actions.each do |action, target|
116 if target.respond_to? :uuid
117 target_uuid = target.uuid
120 target = ArvadosModel.find_by_uuid(target_uuid)
123 next if target_uuid == self.uuid
125 target_owner_uuid = target.owner_uuid if target.respond_to? :owner_uuid
127 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: "$3"}
129 unless ActiveRecord::Base.connection.
131 SELECT 1 FROM #{PERMISSION_VIEW}
132 WHERE user_uuid in (#{user_uuids_subquery}) and
133 ((target_uuid = $2 and perm_level >= $3)
134 or (target_uuid = $4 and perm_level >= $3 and traverse_owned))
136 # "name" arg is a query label that appears in logs:
140 [nil, VAL_FOR_PERM[action]],
141 [nil, target_owner_uuid]]
147 if FrozenGroup.where(uuid: [target_uuid, target_owner_uuid]).any?
148 # self or parent is frozen
151 elsif action == :unfreeze
152 # "unfreeze" permission means "can write, but only if
153 # explicitly un-freezing at the same time" (see
154 # ArvadosModel#ensure_owner_uuid_is_permitted). If the
155 # permission query above passed the permission level of
156 # :unfreeze (which is the same as :manage), and the parent
157 # isn't also frozen, then un-freeze is allowed.
158 if FrozenGroup.where(uuid: target_owner_uuid).any?
166 def before_ownership_change
167 if owner_uuid_changed? and !self.owner_uuid_was.nil?
168 MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
169 update_permissions self.owner_uuid_was, self.uuid, REVOKE_PERM
173 def after_ownership_change
174 if saved_change_to_owner_uuid?
175 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
179 def clear_permissions
180 MaterializedPermission.where("user_uuid = ? and target_uuid != ?", uuid, uuid).delete_all
183 def forget_cached_group_perms
187 def remove_self_from_permissions
188 MaterializedPermission.where("target_uuid = ?", uuid).delete_all
189 check_permissions_against_full_refresh
192 # Return a hash of {user_uuid: group_perms}
194 # note: this does not account for permissions that a user gains by
195 # having can_manage on another user.
196 def self.all_group_permissions
198 ActiveRecord::Base.connection.
200 SELECT user_uuid, target_uuid, perm_level
201 FROM #{PERMISSION_VIEW}
204 # "name" arg is a query label that appears in logs:
205 "all_group_permissions").
206 rows.each do |user_uuid, group_uuid, max_p_val|
207 all_perms[user_uuid] ||= {}
208 all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
213 # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
214 # and perm_hash[:write] are true if this user can read and write
215 # objects owned by group_uuid.
216 def group_permissions(level=1)
218 if @group_perms.empty?
219 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: 1}
221 ActiveRecord::Base.connection.
223 SELECT target_uuid, perm_level
224 FROM #{PERMISSION_VIEW}
225 WHERE user_uuid in (#{user_uuids_subquery}) and perm_level >= 1
227 # "name" arg is a query label that appears in logs:
228 "User.group_permissions",
229 # "binds" arg is an array of [col_id, value] for '$1' vars:
231 rows.each do |group_uuid, max_p_val|
232 @group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
240 @group_perms.select {|k,v| v[:write] }
242 @group_perms.select {|k,v| v[:manage] }
244 raise "level must be 1, 2 or 3"
249 def setup(repo_name: nil, vm_uuid: nil, send_notification_email: nil)
250 newly_invited = Link.where(tail_uuid: self.uuid,
251 head_uuid: all_users_group_uuid,
252 link_class: 'permission',
253 name: 'can_read').empty?
255 # Add can_read link from this user to "all users" which makes this
256 # user "invited", and (depending on config) a link in the opposite
257 # direction which makes this user visible to other users.
258 group_perms = add_to_all_users_group
261 repo_perm = if (!repo_name.nil? || Rails.configuration.Users.AutoSetupNewUsersWithRepository) and !username.nil?
262 repo_name ||= "#{username}/#{username}"
263 create_user_repo_link repo_name
266 # Add virtual machine
267 if vm_uuid.nil? and !Rails.configuration.Users.AutoSetupNewUsersWithVmUUID.empty?
268 vm_uuid = Rails.configuration.Users.AutoSetupNewUsersWithVmUUID
271 vm_login_perm = if vm_uuid && username
272 create_vm_login_permission_link(vm_uuid, username)
276 if send_notification_email.nil?
277 send_notification_email = Rails.configuration.Mail.SendUserSetupNotificationEmail
280 if newly_invited and send_notification_email and !Rails.configuration.Users.UserSetupMailText.empty?
282 UserNotifier.account_is_setup(self).deliver_now
284 logger.warn "Failed to send email to #{self.email}: #{e}"
288 forget_cached_group_perms
290 return [repo_perm, vm_login_perm, *group_perms, self].compact
293 # delete user signatures, login, repo, and vm perms, and mark as inactive
295 # delete oid_login_perms for this user
297 # note: these permission links are obsolete, they have no effect
298 # on anything and they are not created for new users.
299 Link.where(tail_uuid: self.email,
300 link_class: 'permission',
301 name: 'can_login').destroy_all
303 # delete repo_perms for this user
304 Link.where(tail_uuid: self.uuid,
305 link_class: 'permission',
306 name: 'can_manage').destroy_all
308 # delete vm_login_perms for this user
309 Link.where(tail_uuid: self.uuid,
310 link_class: 'permission',
311 name: 'can_login').destroy_all
313 # delete "All users" group read permissions for this user
314 Link.where(tail_uuid: self.uuid,
315 head_uuid: all_users_group_uuid,
316 link_class: 'permission',
317 name: 'can_read').destroy_all
319 # delete any signatures by this user
320 Link.where(link_class: 'signature',
321 tail_uuid: self.uuid).destroy_all
323 # delete tokens for this user
324 ApiClientAuthorization.where(user_id: self.id).destroy_all
325 # delete ssh keys for this user
326 AuthorizedKey.where(owner_uuid: self.uuid).destroy_all
327 AuthorizedKey.where(authorized_user_uuid: self.uuid).destroy_all
329 # delete user preferences (including profile)
332 # mark the user as inactive
333 self.is_admin = false # can't be admin and inactive
334 self.is_active = false
335 forget_cached_group_perms
339 def must_unsetup_to_deactivate
340 if !self.new_record? &&
341 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
342 self.uuid[0..4] != Rails.configuration.ClusterID
343 # OK to update our local record to whatever the LoginCluster
344 # reports, because self-activate is not allowed.
346 elsif self.is_active_changed? &&
347 self.is_active_was &&
350 # When a user is set up, they are added to the "All users"
351 # group. A user that is part of the "All users" group is
352 # allowed to self-activate.
354 # It doesn't make sense to deactivate a user (set is_active =
355 # false) without first removing them from the "All users" group,
356 # because they would be able to immediately reactivate
359 # The 'unsetup' method removes the user from the "All users"
360 # group (and also sets is_active = false) so send a message
361 # explaining the correct way to deactivate a user.
363 if Link.where(tail_uuid: self.uuid,
364 head_uuid: all_users_group_uuid,
365 link_class: 'permission',
366 name: 'can_read').any?
367 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
372 def set_initial_username(requested: false)
373 if !requested.is_a?(String) || requested.empty?
374 email_parts = email.partition("@")
375 local_parts = email_parts.first.partition("+")
376 if email_parts.any?(&:empty?)
378 elsif not local_parts.first.empty?
379 requested = local_parts.first
381 requested = email_parts.first
384 requested.sub!(/^[^A-Za-z]+/, "")
385 requested.gsub!(/[^A-Za-z0-9]/, "")
386 unless requested.empty?
387 self.username = find_usable_username_from(requested)
391 # Move this user's (i.e., self's) owned items to new_owner_uuid and
392 # new_user_uuid (for things normally owned directly by the user).
394 # If redirect_auth is true, also reassign auth tokens and ssh keys,
395 # and redirect this account to redirect_to_user_uuid, i.e., when a
396 # caller authenticates to this account in the future, the account
397 # redirect_to_user_uuid account will be used instead.
399 # current_user must have admin privileges, i.e., the caller is
400 # responsible for checking permission to do this.
401 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
402 raise PermissionDeniedError if !current_user.andand.is_admin
403 raise "Missing new_owner_uuid" if !new_owner_uuid
404 raise "Missing new_user_uuid" if !new_user_uuid
405 transaction(requires_new: true) do
407 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
409 new_user = User.where(uuid: new_user_uuid).first
410 raise "user does not exist" if !new_user
411 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
413 self.clear_permissions
414 new_user.clear_permissions
416 # If 'self' is a remote user, don't transfer authorizations
417 # (i.e. ability to access the account) to the new user, because
418 # that gives the remote site the ability to access the 'new'
419 # user account that takes over the 'self' account.
421 # If 'self' is a local user, it is okay to transfer
422 # authorizations, even if the 'new' user is a remote account,
423 # because the remote site does not gain the ability to access an
424 # account it could not before.
426 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
427 # Existing API tokens and ssh keys are updated to authenticate
429 ApiClientAuthorization.
431 update_all(user_id: new_user.id)
434 [AuthorizedKey, :owner_uuid],
435 [AuthorizedKey, :authorized_user_uuid],
441 # Destroy API tokens and ssh keys associated with the old
443 ApiClientAuthorization.where(user_id: id).destroy_all
444 AuthorizedKey.where(owner_uuid: uuid).destroy_all
445 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
452 # References to the old user UUID in the context of a user ID
453 # (rather than a "home project" in the project hierarchy) are
454 # updated to point to the new user.
455 user_updates.each do |klass, column|
456 klass.where(column => uuid).update_all(column => new_user.uuid)
459 # Need to update repository names to new username
461 old_repo_name_re = /^#{Regexp.escape(username)}\//
462 Repository.where(:owner_uuid => uuid).each do |repo|
463 repo.owner_uuid = new_user.uuid
464 repo_name_sub = "#{new_user.username}/"
465 name = repo.name.sub(old_repo_name_re, repo_name_sub)
466 while (conflict = Repository.where(:name => name).first) != nil
467 repo_name_sub += "migrated"
468 name = repo.name.sub(old_repo_name_re, repo_name_sub)
475 # References to the merged user's "home project" are updated to
476 # point to new_owner_uuid.
477 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
478 next if [ApiClientAuthorization,
482 Repository].include?(klass)
483 next if !klass.columns.collect(&:name).include?('owner_uuid')
484 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
487 if redirect_to_new_user
488 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
490 skip_check_permissions_against_full_refresh do
491 update_permissions self.uuid, self.uuid, CAN_MANAGE_PERM
492 update_permissions new_user.uuid, new_user.uuid, CAN_MANAGE_PERM
493 update_permissions new_user.owner_uuid, new_user.uuid, CAN_MANAGE_PERM
495 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
502 while (uuid = user.redirect_to_user_uuid)
504 nextuser = User.unscoped.find_by_uuid(uuid)
506 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
511 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
517 def self.register info
518 # login info expected fields, all can be optional but at minimum
519 # must supply either 'identity_url' or 'email'
531 identity_url = info['identity_url']
533 if identity_url && identity_url.length > 0
534 # Only local users can create sessions, hence uuid_like_pattern
536 user = User.unscoped.where('identity_url = ? and uuid like ?',
538 User.uuid_like_pattern).first
539 primary_user = user.redirects_to if user
543 # identity url is unset or didn't find matching record.
544 emails = [info['email']] + (info['alternate_emails'] || [])
545 emails.select! {|em| !em.nil? && !em.empty?}
547 User.unscoped.where('email in (?) and uuid like ?',
549 User.uuid_like_pattern).each do |user|
551 primary_user = user.redirects_to
552 elsif primary_user.uuid != user.redirects_to.uuid
553 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
559 # New user registration
560 primary_user = User.new(:owner_uuid => system_user_uuid,
562 :is_active => Rails.configuration.Users.NewUsersAreActive)
564 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
565 primary_user.identity_url = info['identity_url'] if identity_url
568 primary_user.email = info['email'] if info['email']
569 primary_user.first_name = info['first_name'] if info['first_name']
570 primary_user.last_name = info['last_name'] if info['last_name']
572 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
573 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
576 act_as_system_user do
585 def change_all_uuid_refs(old_uuid:, new_uuid:)
586 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
587 klass.columns.each do |col|
588 if col.name.end_with?('_uuid')
589 column = col.name.to_sym
590 klass.where(column => old_uuid).update_all(column => new_uuid)
596 def ensure_ownership_path_leads_to_user
600 def permission_to_update
601 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
602 current_user.andand.is_admin
604 # users must be able to update themselves (even if they are
605 # inactive) in order to create sessions
606 self == current_user or super
610 def permission_to_create
611 current_user.andand.is_admin or
612 (self == current_user &&
613 self.redirect_to_user_uuid.nil? &&
614 self.is_active == Rails.configuration.Users.NewUsersAreActive)
618 return if self.uuid.end_with?('anonymouspublic')
619 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
620 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
621 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
622 Rails.configuration.Users.AutoAdminFirstUser)
624 self.is_active = true
628 def find_usable_username_from(basename)
629 # If "basename" is a usable username, return that.
630 # Otherwise, find a unique username "basenameN", where N is the
631 # smallest integer greater than 1, and return that.
632 # Return nil if a unique username can't be found after reasonable
634 quoted_name = self.class.connection.quote_string(basename)
635 next_username = basename
637 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
639 next_username = "%s%i" % [basename, next_suffix]
641 0.upto(6).each do |suffix_len|
642 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
644 where("username like '#{pattern}'").
646 order('username asc').
648 if other_user.username > next_username
650 elsif other_user.username == next_username
652 next_username = "%s%i" % [basename, next_suffix]
655 return next_username if (next_username.size <= pattern.size)
660 def prevent_privilege_escalation
661 if current_user.andand.is_admin
664 if self.is_active_changed?
665 if self.is_active != self.is_active_was
666 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
667 self.is_active = self.is_active_was
670 if self.is_admin_changed?
671 if self.is_admin != self.is_admin_was
672 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
673 self.is_admin = self.is_admin_was
679 def prevent_inactive_admin
680 if self.is_admin and not self.is_active
681 # There is no known use case for the strange set of permissions
682 # that would result from this change. It's safest to assume it's
683 # a mistake and disallow it outright.
684 raise "Admin users cannot be inactive"
689 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
690 nextpaths = graph[start]
691 return merged if !nextpaths
692 return merged if upstream_path.has_key? start
693 upstream_path[start] = true
694 upstream_mask ||= ALL_PERMISSIONS
695 nextpaths.each do |head, mask|
698 merged[head][k] ||= v if upstream_mask[k]
700 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
702 upstream_path.delete start
706 def create_user_repo_link(repo_name)
707 # repo_name is optional
709 logger.warn ("Repository name not given for #{self.uuid}.")
713 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
714 logger.info { "repo uuid: " + repo[:uuid] }
715 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
716 link_class: "permission",
717 name: "can_manage").first_or_create!
718 logger.info { "repo permission: " + repo_perm[:uuid] }
722 # create login permission for the given vm_uuid, if it does not already exist
723 def create_vm_login_permission_link(vm_uuid, repo_name)
724 # vm uuid is optional
725 return if vm_uuid == ""
727 vm = VirtualMachine.where(uuid: vm_uuid).first
729 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
730 raise "No vm found for #{vm_uuid}"
733 logger.info { "vm uuid: " + vm[:uuid] }
735 tail_uuid: uuid, head_uuid: vm.uuid,
736 link_class: "permission", name: "can_login",
741 select { |link| link.properties["username"] == repo_name }.
745 create(login_attrs.merge(properties: {"username" => repo_name}))
747 logger.info { "login permission: " + login_perm[:uuid] }
751 def add_to_all_users_group
752 resp = [Link.where(tail_uuid: self.uuid,
753 head_uuid: all_users_group_uuid,
754 link_class: 'permission',
755 name: 'can_read').first ||
756 Link.create(tail_uuid: self.uuid,
757 head_uuid: all_users_group_uuid,
758 link_class: 'permission',
760 if Rails.configuration.Users.ActivatedUsersAreVisibleToOthers
761 resp += [Link.where(tail_uuid: all_users_group_uuid,
762 head_uuid: self.uuid,
763 link_class: 'permission',
764 name: 'can_read').first ||
765 Link.create(tail_uuid: all_users_group_uuid,
766 head_uuid: self.uuid,
767 link_class: 'permission',
773 # Give the special "System group" permission to manage this user and
774 # all of this user's stuff.
775 def add_system_group_permission_link
776 return true if uuid == system_user_uuid
777 act_as_system_user do
778 Link.create(link_class: 'permission',
780 tail_uuid: system_group_uuid,
781 head_uuid: self.uuid)
785 # Send admin notifications
786 def send_admin_notifications
787 AdminNotifier.new_user(self).deliver_now
788 if not self.is_active then
789 AdminNotifier.new_inactive_user(self).deliver_now
793 # Automatically setup if is_active flag turns on
794 def setup_on_activate
795 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
797 (new_record? || saved_change_to_is_active? || will_save_change_to_is_active?)
802 # Automatically setup new user during creation
803 def auto_setup_new_user
807 # Send notification if the user saved profile for the first time
808 def send_profile_created_notification
809 if saved_change_to_prefs?
810 if prefs_before_last_save.andand.empty? || !prefs_before_last_save.andand['profile']
811 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
812 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
817 def verify_repositories_empty
818 unless repositories.first.nil?
819 errors.add(:username, "can't be unset when the user owns repositories")
824 def sync_repository_names
825 old_name_re = /^#{Regexp.escape(username_before_last_save)}\//
826 name_sub = "#{username}/"
827 repositories.find_each do |repo|
828 repo.name = repo.name.sub(old_name_re, name_sub)
833 def identity_url_nil_if_empty
834 if identity_url == ""
835 self.identity_url = nil