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}]
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 forget_cached_group_perms
168 def remove_self_from_permissions
169 MaterializedPermission.where("target_uuid = ?", uuid).delete_all
170 check_permissions_against_full_refresh
173 # Return a hash of {user_uuid: group_perms}
175 # note: this does not account for permissions that a user gains by
176 # having can_manage on another user.
177 def self.all_group_permissions
179 ActiveRecord::Base.connection.
181 SELECT user_uuid, target_uuid, perm_level
182 FROM #{PERMISSION_VIEW}
185 # "name" arg is a query label that appears in logs:
186 "all_group_permissions").
187 rows.each do |user_uuid, group_uuid, max_p_val|
188 all_perms[user_uuid] ||= {}
189 all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
194 # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
195 # and perm_hash[:write] are true if this user can read and write
196 # objects owned by group_uuid.
197 def group_permissions(level=1)
199 if @group_perms.empty?
200 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: 1}
202 ActiveRecord::Base.connection.
204 SELECT target_uuid, perm_level
205 FROM #{PERMISSION_VIEW}
206 WHERE user_uuid in (#{user_uuids_subquery}) and perm_level >= 1
208 # "name" arg is a query label that appears in logs:
209 "User.group_permissions",
210 # "binds" arg is an array of [col_id, value] for '$1' vars:
212 rows.each do |group_uuid, max_p_val|
213 @group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
221 @group_perms.select {|k,v| v[:write] }
223 @group_perms.select {|k,v| v[:manage] }
225 raise "level must be 1, 2 or 3"
230 def setup(repo_name: nil, vm_uuid: nil, send_notification_email: nil)
231 newly_invited = Link.where(tail_uuid: self.uuid,
232 head_uuid: all_users_group_uuid,
233 link_class: 'permission',
234 name: 'can_read').empty?
236 # Add can_read link from this user to "all users" which makes this
238 group_perm = create_user_group_link
241 repo_perm = if (!repo_name.nil? || Rails.configuration.Users.AutoSetupNewUsersWithRepository) and !username.nil?
242 repo_name ||= "#{username}/#{username}"
243 create_user_repo_link repo_name
246 # Add virtual machine
247 if vm_uuid.nil? and !Rails.configuration.Users.AutoSetupNewUsersWithVmUUID.empty?
248 vm_uuid = Rails.configuration.Users.AutoSetupNewUsersWithVmUUID
251 vm_login_perm = if vm_uuid && username
252 create_vm_login_permission_link(vm_uuid, username)
256 if send_notification_email.nil?
257 send_notification_email = Rails.configuration.Mail.SendUserSetupNotificationEmail
260 if newly_invited and send_notification_email and !Rails.configuration.Users.UserSetupMailText.empty?
262 UserNotifier.account_is_setup(self).deliver_now
264 logger.warn "Failed to send email to #{self.email}: #{e}"
268 forget_cached_group_perms
270 return [repo_perm, vm_login_perm, group_perm, self].compact
273 # delete user signatures, login, repo, and vm perms, and mark as inactive
275 # delete oid_login_perms for this user
277 # note: these permission links are obsolete, they have no effect
278 # on anything and they are not created for new users.
279 Link.where(tail_uuid: self.email,
280 link_class: 'permission',
281 name: 'can_login').destroy_all
283 # delete repo_perms for this user
284 Link.where(tail_uuid: self.uuid,
285 link_class: 'permission',
286 name: 'can_manage').destroy_all
288 # delete vm_login_perms for this user
289 Link.where(tail_uuid: self.uuid,
290 link_class: 'permission',
291 name: 'can_login').destroy_all
293 # delete "All users" group read permissions for this user
294 Link.where(tail_uuid: self.uuid,
295 head_uuid: all_users_group_uuid,
296 link_class: 'permission',
297 name: 'can_read').destroy_all
299 # delete any signatures by this user
300 Link.where(link_class: 'signature',
301 tail_uuid: self.uuid).destroy_all
303 # delete tokens for this user
304 ApiClientAuthorization.where(user_id: self.id).destroy_all
305 # delete ssh keys for this user
306 AuthorizedKey.where(owner_uuid: self.uuid).destroy_all
307 AuthorizedKey.where(authorized_user_uuid: self.uuid).destroy_all
309 # delete user preferences (including profile)
312 # mark the user as inactive
313 self.is_admin = false # can't be admin and inactive
314 self.is_active = false
315 forget_cached_group_perms
319 def must_unsetup_to_deactivate
320 if !self.new_record? &&
321 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
322 self.uuid[0..4] != Rails.configuration.ClusterID
323 # OK to update our local record to whatever the LoginCluster
324 # reports, because self-activate is not allowed.
326 elsif self.is_active_changed? &&
327 self.is_active_was &&
330 # When a user is set up, they are added to the "All users"
331 # group. A user that is part of the "All users" group is
332 # allowed to self-activate.
334 # It doesn't make sense to deactivate a user (set is_active =
335 # false) without first removing them from the "All users" group,
336 # because they would be able to immediately reactivate
339 # The 'unsetup' method removes the user from the "All users"
340 # group (and also sets is_active = false) so send a message
341 # explaining the correct way to deactivate a user.
343 if Link.where(tail_uuid: self.uuid,
344 head_uuid: all_users_group_uuid,
345 link_class: 'permission',
346 name: 'can_read').any?
347 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
352 def set_initial_username(requested: false)
353 if !requested.is_a?(String) || requested.empty?
354 email_parts = email.partition("@")
355 local_parts = email_parts.first.partition("+")
356 if email_parts.any?(&:empty?)
358 elsif not local_parts.first.empty?
359 requested = local_parts.first
361 requested = email_parts.first
364 requested.sub!(/^[^A-Za-z]+/, "")
365 requested.gsub!(/[^A-Za-z0-9]/, "")
366 unless requested.empty?
367 self.username = find_usable_username_from(requested)
371 # Move this user's (i.e., self's) owned items to new_owner_uuid and
372 # new_user_uuid (for things normally owned directly by the user).
374 # If redirect_auth is true, also reassign auth tokens and ssh keys,
375 # and redirect this account to redirect_to_user_uuid, i.e., when a
376 # caller authenticates to this account in the future, the account
377 # redirect_to_user_uuid account will be used instead.
379 # current_user must have admin privileges, i.e., the caller is
380 # responsible for checking permission to do this.
381 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
382 raise PermissionDeniedError if !current_user.andand.is_admin
383 raise "Missing new_owner_uuid" if !new_owner_uuid
384 raise "Missing new_user_uuid" if !new_user_uuid
385 transaction(requires_new: true) do
387 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
389 new_user = User.where(uuid: new_user_uuid).first
390 raise "user does not exist" if !new_user
391 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
393 self.clear_permissions
394 new_user.clear_permissions
396 # If 'self' is a remote user, don't transfer authorizations
397 # (i.e. ability to access the account) to the new user, because
398 # that gives the remote site the ability to access the 'new'
399 # user account that takes over the 'self' account.
401 # If 'self' is a local user, it is okay to transfer
402 # authorizations, even if the 'new' user is a remote account,
403 # because the remote site does not gain the ability to access an
404 # account it could not before.
406 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
407 # Existing API tokens and ssh keys are updated to authenticate
409 ApiClientAuthorization.
411 update_all(user_id: new_user.id)
414 [AuthorizedKey, :owner_uuid],
415 [AuthorizedKey, :authorized_user_uuid],
421 # Destroy API tokens and ssh keys associated with the old
423 ApiClientAuthorization.where(user_id: id).destroy_all
424 AuthorizedKey.where(owner_uuid: uuid).destroy_all
425 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
432 # References to the old user UUID in the context of a user ID
433 # (rather than a "home project" in the project hierarchy) are
434 # updated to point to the new user.
435 user_updates.each do |klass, column|
436 klass.where(column => uuid).update_all(column => new_user.uuid)
439 # Need to update repository names to new username
441 old_repo_name_re = /^#{Regexp.escape(username)}\//
442 Repository.where(:owner_uuid => uuid).each do |repo|
443 repo.owner_uuid = new_user.uuid
444 repo_name_sub = "#{new_user.username}/"
445 name = repo.name.sub(old_repo_name_re, repo_name_sub)
446 while (conflict = Repository.where(:name => name).first) != nil
447 repo_name_sub += "migrated"
448 name = repo.name.sub(old_repo_name_re, repo_name_sub)
455 # References to the merged user's "home project" are updated to
456 # point to new_owner_uuid.
457 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
458 next if [ApiClientAuthorization,
462 Repository].include?(klass)
463 next if !klass.columns.collect(&:name).include?('owner_uuid')
464 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
467 if redirect_to_new_user
468 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
470 skip_check_permissions_against_full_refresh do
471 update_permissions self.uuid, self.uuid, CAN_MANAGE_PERM
472 update_permissions new_user.uuid, new_user.uuid, CAN_MANAGE_PERM
473 update_permissions new_user.owner_uuid, new_user.uuid, CAN_MANAGE_PERM
475 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
482 while (uuid = user.redirect_to_user_uuid)
484 nextuser = User.unscoped.find_by_uuid(uuid)
486 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
491 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
497 def self.register info
498 # login info expected fields, all can be optional but at minimum
499 # must supply either 'identity_url' or 'email'
511 identity_url = info['identity_url']
513 if identity_url && identity_url.length > 0
514 # Only local users can create sessions, hence uuid_like_pattern
516 user = User.unscoped.where('identity_url = ? and uuid like ?',
518 User.uuid_like_pattern).first
519 primary_user = user.redirects_to if user
523 # identity url is unset or didn't find matching record.
524 emails = [info['email']] + (info['alternate_emails'] || [])
525 emails.select! {|em| !em.nil? && !em.empty?}
527 User.unscoped.where('email in (?) and uuid like ?',
529 User.uuid_like_pattern).each do |user|
531 primary_user = user.redirects_to
532 elsif primary_user.uuid != user.redirects_to.uuid
533 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
539 # New user registration
540 primary_user = User.new(:owner_uuid => system_user_uuid,
542 :is_active => Rails.configuration.Users.NewUsersAreActive)
544 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
545 primary_user.identity_url = info['identity_url'] if identity_url
548 primary_user.email = info['email'] if info['email']
549 primary_user.first_name = info['first_name'] if info['first_name']
550 primary_user.last_name = info['last_name'] if info['last_name']
552 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
553 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
556 act_as_system_user do
565 def change_all_uuid_refs(old_uuid:, new_uuid:)
566 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
567 klass.columns.each do |col|
568 if col.name.end_with?('_uuid')
569 column = col.name.to_sym
570 klass.where(column => old_uuid).update_all(column => new_uuid)
576 def ensure_ownership_path_leads_to_user
580 def permission_to_update
581 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
582 current_user.andand.is_admin
584 # users must be able to update themselves (even if they are
585 # inactive) in order to create sessions
586 self == current_user or super
590 def permission_to_create
591 current_user.andand.is_admin or
592 (self == current_user &&
593 self.redirect_to_user_uuid.nil? &&
594 self.is_active == Rails.configuration.Users.NewUsersAreActive)
598 return if self.uuid.end_with?('anonymouspublic')
599 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
600 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
601 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
602 Rails.configuration.Users.AutoAdminFirstUser)
604 self.is_active = true
608 def find_usable_username_from(basename)
609 # If "basename" is a usable username, return that.
610 # Otherwise, find a unique username "basenameN", where N is the
611 # smallest integer greater than 1, and return that.
612 # Return nil if a unique username can't be found after reasonable
614 quoted_name = self.class.connection.quote_string(basename)
615 next_username = basename
617 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
619 next_username = "%s%i" % [basename, next_suffix]
621 0.upto(6).each do |suffix_len|
622 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
624 where("username like '#{pattern}'").
626 order('username asc').
628 if other_user.username > next_username
630 elsif other_user.username == next_username
632 next_username = "%s%i" % [basename, next_suffix]
635 return next_username if (next_username.size <= pattern.size)
640 def prevent_privilege_escalation
641 if current_user.andand.is_admin
644 if self.is_active_changed?
645 if self.is_active != self.is_active_was
646 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
647 self.is_active = self.is_active_was
650 if self.is_admin_changed?
651 if self.is_admin != self.is_admin_was
652 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
653 self.is_admin = self.is_admin_was
659 def prevent_inactive_admin
660 if self.is_admin and not self.is_active
661 # There is no known use case for the strange set of permissions
662 # that would result from this change. It's safest to assume it's
663 # a mistake and disallow it outright.
664 raise "Admin users cannot be inactive"
669 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
670 nextpaths = graph[start]
671 return merged if !nextpaths
672 return merged if upstream_path.has_key? start
673 upstream_path[start] = true
674 upstream_mask ||= ALL_PERMISSIONS
675 nextpaths.each do |head, mask|
678 merged[head][k] ||= v if upstream_mask[k]
680 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
682 upstream_path.delete start
686 def create_user_repo_link(repo_name)
687 # repo_name is optional
689 logger.warn ("Repository name not given for #{self.uuid}.")
693 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
694 logger.info { "repo uuid: " + repo[:uuid] }
695 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
696 link_class: "permission",
697 name: "can_manage").first_or_create!
698 logger.info { "repo permission: " + repo_perm[:uuid] }
702 # create login permission for the given vm_uuid, if it does not already exist
703 def create_vm_login_permission_link(vm_uuid, repo_name)
704 # vm uuid is optional
705 return if vm_uuid == ""
707 vm = VirtualMachine.where(uuid: vm_uuid).first
709 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
710 raise "No vm found for #{vm_uuid}"
713 logger.info { "vm uuid: " + vm[:uuid] }
715 tail_uuid: uuid, head_uuid: vm.uuid,
716 link_class: "permission", name: "can_login",
721 select { |link| link.properties["username"] == repo_name }.
725 create(login_attrs.merge(properties: {"username" => repo_name}))
727 logger.info { "login permission: " + login_perm[:uuid] }
731 # add the user to the 'All users' group
732 def create_user_group_link
733 return (Link.where(tail_uuid: self.uuid,
734 head_uuid: all_users_group_uuid,
735 link_class: 'permission',
736 name: 'can_read').first or
737 Link.create(tail_uuid: self.uuid,
738 head_uuid: all_users_group_uuid,
739 link_class: 'permission',
743 # Give the special "System group" permission to manage this user and
744 # all of this user's stuff.
745 def add_system_group_permission_link
746 return true if uuid == system_user_uuid
747 act_as_system_user do
748 Link.create(link_class: 'permission',
750 tail_uuid: system_group_uuid,
751 head_uuid: self.uuid)
755 # Send admin notifications
756 def send_admin_notifications
757 AdminNotifier.new_user(self).deliver_now
758 if not self.is_active then
759 AdminNotifier.new_inactive_user(self).deliver_now
763 # Automatically setup if is_active flag turns on
764 def setup_on_activate
765 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
767 (new_record? || saved_change_to_is_active? || will_save_change_to_is_active?)
772 # Automatically setup new user during creation
773 def auto_setup_new_user
777 # Send notification if the user saved profile for the first time
778 def send_profile_created_notification
779 if saved_change_to_prefs?
780 if prefs_before_last_save.andand.empty? || !prefs_before_last_save.andand['profile']
781 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
782 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
787 def verify_repositories_empty
788 unless repositories.first.nil?
789 errors.add(:username, "can't be unset when the user owns repositories")
794 def sync_repository_names
795 old_name_re = /^#{Regexp.escape(username_before_last_save)}\//
796 name_sub = "#{username}/"
797 repositories.find_each do |repo|
798 repo.name = repo.name.sub(old_name_re, name_sub)