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}]
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]]
146 if FrozenGroup.where(uuid: [target_uuid, target_owner_uuid]).any?
147 # self or parent is frozen
150 elsif action == :unfreeze
151 # "unfreeze" permission means "can write, but only if
152 # explicitly un-freezing at the same time" (see
153 # ArvadosModel#ensure_owner_uuid_is_permitted). If the
154 # permission query above passed the permission level of
155 # :unfreeze (which is the same as :manage), and the parent
156 # isn't also frozen, then un-freeze is allowed.
157 if FrozenGroup.where(uuid: target_owner_uuid).any?
165 def before_ownership_change
166 if owner_uuid_changed? and !self.owner_uuid_was.nil?
167 MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
168 update_permissions self.owner_uuid_was, self.uuid, REVOKE_PERM
172 def after_ownership_change
173 if saved_change_to_owner_uuid?
174 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
178 def clear_permissions
179 MaterializedPermission.where("user_uuid = ? and target_uuid != ?", uuid, uuid).delete_all
182 def forget_cached_group_perms
186 def remove_self_from_permissions
187 MaterializedPermission.where("target_uuid = ?", uuid).delete_all
188 check_permissions_against_full_refresh
191 # Return a hash of {user_uuid: group_perms}
193 # note: this does not account for permissions that a user gains by
194 # having can_manage on another user.
195 def self.all_group_permissions
197 ActiveRecord::Base.connection.
199 SELECT user_uuid, target_uuid, perm_level
200 FROM #{PERMISSION_VIEW}
203 # "name" arg is a query label that appears in logs:
204 "all_group_permissions").
205 rows.each do |user_uuid, group_uuid, max_p_val|
206 all_perms[user_uuid] ||= {}
207 all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
212 # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
213 # and perm_hash[:write] are true if this user can read and write
214 # objects owned by group_uuid.
215 def group_permissions(level=1)
217 if @group_perms.empty?
218 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: 1}
220 ActiveRecord::Base.connection.
222 SELECT target_uuid, perm_level
223 FROM #{PERMISSION_VIEW}
224 WHERE user_uuid in (#{user_uuids_subquery}) and perm_level >= 1
226 # "name" arg is a query label that appears in logs:
227 "User.group_permissions",
228 # "binds" arg is an array of [col_id, value] for '$1' vars:
230 rows.each do |group_uuid, max_p_val|
231 @group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
239 @group_perms.select {|k,v| v[:write] }
241 @group_perms.select {|k,v| v[:manage] }
243 raise "level must be 1, 2 or 3"
248 def setup(repo_name: nil, vm_uuid: nil, send_notification_email: nil)
249 newly_invited = Link.where(tail_uuid: self.uuid,
250 head_uuid: all_users_group_uuid,
251 link_class: 'permission',
252 name: 'can_read').empty?
254 # Add can_read link from this user to "all users" which makes this
255 # user "invited", and (depending on config) a link in the opposite
256 # direction which makes this user visible to other users.
257 group_perms = add_to_all_users_group
260 repo_perm = if (!repo_name.nil? || Rails.configuration.Users.AutoSetupNewUsersWithRepository) and !username.nil?
261 repo_name ||= "#{username}/#{username}"
262 create_user_repo_link repo_name
265 # Add virtual machine
266 if vm_uuid.nil? and !Rails.configuration.Users.AutoSetupNewUsersWithVmUUID.empty?
267 vm_uuid = Rails.configuration.Users.AutoSetupNewUsersWithVmUUID
270 vm_login_perm = if vm_uuid && username
271 create_vm_login_permission_link(vm_uuid, username)
275 if send_notification_email.nil?
276 send_notification_email = Rails.configuration.Mail.SendUserSetupNotificationEmail
279 if newly_invited and send_notification_email and !Rails.configuration.Users.UserSetupMailText.empty?
281 UserNotifier.account_is_setup(self).deliver_now
283 logger.warn "Failed to send email to #{self.email}: #{e}"
287 forget_cached_group_perms
289 return [repo_perm, vm_login_perm, *group_perms, self].compact
292 # delete user signatures, login, repo, and vm perms, and mark as inactive
294 # delete oid_login_perms for this user
296 # note: these permission links are obsolete, they have no effect
297 # on anything and they are not created for new users.
298 Link.where(tail_uuid: self.email,
299 link_class: 'permission',
300 name: 'can_login').destroy_all
302 # delete repo_perms for this user
303 Link.where(tail_uuid: self.uuid,
304 link_class: 'permission',
305 name: 'can_manage').destroy_all
307 # delete vm_login_perms for this user
308 Link.where(tail_uuid: self.uuid,
309 link_class: 'permission',
310 name: 'can_login').destroy_all
312 # delete "All users" group read permissions for this user
313 Link.where(tail_uuid: self.uuid,
314 head_uuid: all_users_group_uuid,
315 link_class: 'permission',
316 name: 'can_read').destroy_all
318 # delete any signatures by this user
319 Link.where(link_class: 'signature',
320 tail_uuid: self.uuid).destroy_all
322 # delete tokens for this user
323 ApiClientAuthorization.where(user_id: self.id).destroy_all
324 # delete ssh keys for this user
325 AuthorizedKey.where(owner_uuid: self.uuid).destroy_all
326 AuthorizedKey.where(authorized_user_uuid: self.uuid).destroy_all
328 # delete user preferences (including profile)
331 # mark the user as inactive
332 self.is_admin = false # can't be admin and inactive
333 self.is_active = false
334 forget_cached_group_perms
338 def must_unsetup_to_deactivate
339 if !self.new_record? &&
340 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
341 self.uuid[0..4] != Rails.configuration.ClusterID
342 # OK to update our local record to whatever the LoginCluster
343 # reports, because self-activate is not allowed.
345 elsif self.is_active_changed? &&
346 self.is_active_was &&
349 # When a user is set up, they are added to the "All users"
350 # group. A user that is part of the "All users" group is
351 # allowed to self-activate.
353 # It doesn't make sense to deactivate a user (set is_active =
354 # false) without first removing them from the "All users" group,
355 # because they would be able to immediately reactivate
358 # The 'unsetup' method removes the user from the "All users"
359 # group (and also sets is_active = false) so send a message
360 # explaining the correct way to deactivate a user.
362 if Link.where(tail_uuid: self.uuid,
363 head_uuid: all_users_group_uuid,
364 link_class: 'permission',
365 name: 'can_read').any?
366 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
371 def set_initial_username(requested: false)
372 if !requested.is_a?(String) || requested.empty?
373 email_parts = email.partition("@")
374 local_parts = email_parts.first.partition("+")
375 if email_parts.any?(&:empty?)
377 elsif not local_parts.first.empty?
378 requested = local_parts.first
380 requested = email_parts.first
383 requested.sub!(/^[^A-Za-z]+/, "")
384 requested.gsub!(/[^A-Za-z0-9]/, "")
385 unless requested.empty?
386 self.username = find_usable_username_from(requested)
390 # Move this user's (i.e., self's) owned items to new_owner_uuid and
391 # new_user_uuid (for things normally owned directly by the user).
393 # If redirect_auth is true, also reassign auth tokens and ssh keys,
394 # and redirect this account to redirect_to_user_uuid, i.e., when a
395 # caller authenticates to this account in the future, the account
396 # redirect_to_user_uuid account will be used instead.
398 # current_user must have admin privileges, i.e., the caller is
399 # responsible for checking permission to do this.
400 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
401 raise PermissionDeniedError if !current_user.andand.is_admin
402 raise "Missing new_owner_uuid" if !new_owner_uuid
403 raise "Missing new_user_uuid" if !new_user_uuid
404 transaction(requires_new: true) do
406 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
408 new_user = User.where(uuid: new_user_uuid).first
409 raise "user does not exist" if !new_user
410 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
412 self.clear_permissions
413 new_user.clear_permissions
415 # If 'self' is a remote user, don't transfer authorizations
416 # (i.e. ability to access the account) to the new user, because
417 # that gives the remote site the ability to access the 'new'
418 # user account that takes over the 'self' account.
420 # If 'self' is a local user, it is okay to transfer
421 # authorizations, even if the 'new' user is a remote account,
422 # because the remote site does not gain the ability to access an
423 # account it could not before.
425 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
426 # Existing API tokens and ssh keys are updated to authenticate
428 ApiClientAuthorization.
430 update_all(user_id: new_user.id)
433 [AuthorizedKey, :owner_uuid],
434 [AuthorizedKey, :authorized_user_uuid],
440 # Destroy API tokens and ssh keys associated with the old
442 ApiClientAuthorization.where(user_id: id).destroy_all
443 AuthorizedKey.where(owner_uuid: uuid).destroy_all
444 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
451 # References to the old user UUID in the context of a user ID
452 # (rather than a "home project" in the project hierarchy) are
453 # updated to point to the new user.
454 user_updates.each do |klass, column|
455 klass.where(column => uuid).update_all(column => new_user.uuid)
458 # Need to update repository names to new username
460 old_repo_name_re = /^#{Regexp.escape(username)}\//
461 Repository.where(:owner_uuid => uuid).each do |repo|
462 repo.owner_uuid = new_user.uuid
463 repo_name_sub = "#{new_user.username}/"
464 name = repo.name.sub(old_repo_name_re, repo_name_sub)
465 while (conflict = Repository.where(:name => name).first) != nil
466 repo_name_sub += "migrated"
467 name = repo.name.sub(old_repo_name_re, repo_name_sub)
474 # References to the merged user's "home project" are updated to
475 # point to new_owner_uuid.
476 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
477 next if [ApiClientAuthorization,
481 Repository].include?(klass)
482 next if !klass.columns.collect(&:name).include?('owner_uuid')
483 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
486 if redirect_to_new_user
487 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
489 skip_check_permissions_against_full_refresh do
490 update_permissions self.uuid, self.uuid, CAN_MANAGE_PERM
491 update_permissions new_user.uuid, new_user.uuid, CAN_MANAGE_PERM
492 update_permissions new_user.owner_uuid, new_user.uuid, CAN_MANAGE_PERM
494 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
501 while (uuid = user.redirect_to_user_uuid)
503 nextuser = User.unscoped.find_by_uuid(uuid)
505 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
510 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
516 def self.register info
517 # login info expected fields, all can be optional but at minimum
518 # must supply either 'identity_url' or 'email'
530 identity_url = info['identity_url']
532 if identity_url && identity_url.length > 0
533 # Only local users can create sessions, hence uuid_like_pattern
535 user = User.unscoped.where('identity_url = ? and uuid like ?',
537 User.uuid_like_pattern).first
538 primary_user = user.redirects_to if user
542 # identity url is unset or didn't find matching record.
543 emails = [info['email']] + (info['alternate_emails'] || [])
544 emails.select! {|em| !em.nil? && !em.empty?}
546 User.unscoped.where('email in (?) and uuid like ?',
548 User.uuid_like_pattern).each do |user|
550 primary_user = user.redirects_to
551 elsif primary_user.uuid != user.redirects_to.uuid
552 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
558 # New user registration
559 primary_user = User.new(:owner_uuid => system_user_uuid,
561 :is_active => Rails.configuration.Users.NewUsersAreActive)
563 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
564 primary_user.identity_url = info['identity_url'] if identity_url
567 primary_user.email = info['email'] if info['email']
568 primary_user.first_name = info['first_name'] if info['first_name']
569 primary_user.last_name = info['last_name'] if info['last_name']
571 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
572 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
575 act_as_system_user do
584 def change_all_uuid_refs(old_uuid:, new_uuid:)
585 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
586 klass.columns.each do |col|
587 if col.name.end_with?('_uuid')
588 column = col.name.to_sym
589 klass.where(column => old_uuid).update_all(column => new_uuid)
595 def ensure_ownership_path_leads_to_user
599 def permission_to_update
600 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
601 current_user.andand.is_admin
603 # users must be able to update themselves (even if they are
604 # inactive) in order to create sessions
605 self == current_user or super
609 def permission_to_create
610 current_user.andand.is_admin or
611 (self == current_user &&
612 self.redirect_to_user_uuid.nil? &&
613 self.is_active == Rails.configuration.Users.NewUsersAreActive)
617 return if self.uuid.end_with?('anonymouspublic')
618 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
619 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
620 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
621 Rails.configuration.Users.AutoAdminFirstUser)
623 self.is_active = true
627 def find_usable_username_from(basename)
628 # If "basename" is a usable username, return that.
629 # Otherwise, find a unique username "basenameN", where N is the
630 # smallest integer greater than 1, and return that.
631 # Return nil if a unique username can't be found after reasonable
633 quoted_name = self.class.connection.quote_string(basename)
634 next_username = basename
636 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
638 next_username = "%s%i" % [basename, next_suffix]
640 0.upto(6).each do |suffix_len|
641 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
643 where("username like '#{pattern}'").
645 order('username asc').
647 if other_user.username > next_username
649 elsif other_user.username == next_username
651 next_username = "%s%i" % [basename, next_suffix]
654 return next_username if (next_username.size <= pattern.size)
659 def prevent_privilege_escalation
660 if current_user.andand.is_admin
663 if self.is_active_changed?
664 if self.is_active != self.is_active_was
665 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
666 self.is_active = self.is_active_was
669 if self.is_admin_changed?
670 if self.is_admin != self.is_admin_was
671 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
672 self.is_admin = self.is_admin_was
678 def prevent_inactive_admin
679 if self.is_admin and not self.is_active
680 # There is no known use case for the strange set of permissions
681 # that would result from this change. It's safest to assume it's
682 # a mistake and disallow it outright.
683 raise "Admin users cannot be inactive"
688 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
689 nextpaths = graph[start]
690 return merged if !nextpaths
691 return merged if upstream_path.has_key? start
692 upstream_path[start] = true
693 upstream_mask ||= ALL_PERMISSIONS
694 nextpaths.each do |head, mask|
697 merged[head][k] ||= v if upstream_mask[k]
699 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
701 upstream_path.delete start
705 def create_user_repo_link(repo_name)
706 # repo_name is optional
708 logger.warn ("Repository name not given for #{self.uuid}.")
712 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
713 logger.info { "repo uuid: " + repo[:uuid] }
714 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
715 link_class: "permission",
716 name: "can_manage").first_or_create!
717 logger.info { "repo permission: " + repo_perm[:uuid] }
721 # create login permission for the given vm_uuid, if it does not already exist
722 def create_vm_login_permission_link(vm_uuid, repo_name)
723 # vm uuid is optional
724 return if vm_uuid == ""
726 vm = VirtualMachine.where(uuid: vm_uuid).first
728 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
729 raise "No vm found for #{vm_uuid}"
732 logger.info { "vm uuid: " + vm[:uuid] }
734 tail_uuid: uuid, head_uuid: vm.uuid,
735 link_class: "permission", name: "can_login",
740 select { |link| link.properties["username"] == repo_name }.
744 create(login_attrs.merge(properties: {"username" => repo_name}))
746 logger.info { "login permission: " + login_perm[:uuid] }
750 def add_to_all_users_group
751 resp = [Link.where(tail_uuid: self.uuid,
752 head_uuid: all_users_group_uuid,
753 link_class: 'permission',
754 name: 'can_read').first ||
755 Link.create(tail_uuid: self.uuid,
756 head_uuid: all_users_group_uuid,
757 link_class: 'permission',
759 if Rails.configuration.Users.ActivatedUsersAreVisibleToOthers
760 resp += [Link.where(tail_uuid: all_users_group_uuid,
761 head_uuid: self.uuid,
762 link_class: 'permission',
763 name: 'can_read').first ||
764 Link.create(tail_uuid: all_users_group_uuid,
765 head_uuid: self.uuid,
766 link_class: 'permission',
772 # Give the special "System group" permission to manage this user and
773 # all of this user's stuff.
774 def add_system_group_permission_link
775 return true if uuid == system_user_uuid
776 act_as_system_user do
777 Link.create(link_class: 'permission',
779 tail_uuid: system_group_uuid,
780 head_uuid: self.uuid)
784 # Send admin notifications
785 def send_admin_notifications
786 AdminNotifier.new_user(self).deliver_now
787 if not self.is_active then
788 AdminNotifier.new_inactive_user(self).deliver_now
792 # Automatically setup if is_active flag turns on
793 def setup_on_activate
794 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
796 (new_record? || saved_change_to_is_active? || will_save_change_to_is_active?)
801 # Automatically setup new user during creation
802 def auto_setup_new_user
806 # Send notification if the user saved profile for the first time
807 def send_profile_created_notification
808 if saved_change_to_prefs?
809 if prefs_before_last_save.andand.empty? || !prefs_before_last_save.andand['profile']
810 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
811 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
816 def verify_repositories_empty
817 unless repositories.first.nil?
818 errors.add(:username, "can't be unset when the user owns repositories")
823 def sync_repository_names
824 old_name_re = /^#{Regexp.escape(username_before_last_save)}\//
825 name_sub = "#{username}/"
826 repositories.find_each do |repo|
827 repo.name = repo.name.sub(old_name_re, name_sub)