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
237 # user "invited", and (depending on config) a link in the opposite
238 # direction which makes this user visible to other users.
239 group_perms = add_to_all_users_group
242 repo_perm = if (!repo_name.nil? || Rails.configuration.Users.AutoSetupNewUsersWithRepository) and !username.nil?
243 repo_name ||= "#{username}/#{username}"
244 create_user_repo_link repo_name
247 # Add virtual machine
248 if vm_uuid.nil? and !Rails.configuration.Users.AutoSetupNewUsersWithVmUUID.empty?
249 vm_uuid = Rails.configuration.Users.AutoSetupNewUsersWithVmUUID
252 vm_login_perm = if vm_uuid && username
253 create_vm_login_permission_link(vm_uuid, username)
257 if send_notification_email.nil?
258 send_notification_email = Rails.configuration.Mail.SendUserSetupNotificationEmail
261 if newly_invited and send_notification_email and !Rails.configuration.Users.UserSetupMailText.empty?
263 UserNotifier.account_is_setup(self).deliver_now
265 logger.warn "Failed to send email to #{self.email}: #{e}"
269 forget_cached_group_perms
271 return [repo_perm, vm_login_perm, *group_perms, self].compact
274 # delete user signatures, login, repo, and vm perms, and mark as inactive
276 # delete oid_login_perms for this user
278 # note: these permission links are obsolete, they have no effect
279 # on anything and they are not created for new users.
280 Link.where(tail_uuid: self.email,
281 link_class: 'permission',
282 name: 'can_login').destroy_all
284 # delete repo_perms for this user
285 Link.where(tail_uuid: self.uuid,
286 link_class: 'permission',
287 name: 'can_manage').destroy_all
289 # delete vm_login_perms for this user
290 Link.where(tail_uuid: self.uuid,
291 link_class: 'permission',
292 name: 'can_login').destroy_all
294 # delete "All users" group read permissions for this user
295 Link.where(tail_uuid: self.uuid,
296 head_uuid: all_users_group_uuid,
297 link_class: 'permission',
298 name: 'can_read').destroy_all
300 # delete any signatures by this user
301 Link.where(link_class: 'signature',
302 tail_uuid: self.uuid).destroy_all
304 # delete tokens for this user
305 ApiClientAuthorization.where(user_id: self.id).destroy_all
306 # delete ssh keys for this user
307 AuthorizedKey.where(owner_uuid: self.uuid).destroy_all
308 AuthorizedKey.where(authorized_user_uuid: self.uuid).destroy_all
310 # delete user preferences (including profile)
313 # mark the user as inactive
314 self.is_admin = false # can't be admin and inactive
315 self.is_active = false
316 forget_cached_group_perms
320 def must_unsetup_to_deactivate
321 if !self.new_record? &&
322 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
323 self.uuid[0..4] != Rails.configuration.ClusterID
324 # OK to update our local record to whatever the LoginCluster
325 # reports, because self-activate is not allowed.
327 elsif self.is_active_changed? &&
328 self.is_active_was &&
331 # When a user is set up, they are added to the "All users"
332 # group. A user that is part of the "All users" group is
333 # allowed to self-activate.
335 # It doesn't make sense to deactivate a user (set is_active =
336 # false) without first removing them from the "All users" group,
337 # because they would be able to immediately reactivate
340 # The 'unsetup' method removes the user from the "All users"
341 # group (and also sets is_active = false) so send a message
342 # explaining the correct way to deactivate a user.
344 if Link.where(tail_uuid: self.uuid,
345 head_uuid: all_users_group_uuid,
346 link_class: 'permission',
347 name: 'can_read').any?
348 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
353 def set_initial_username(requested: false)
354 if !requested.is_a?(String) || requested.empty?
355 email_parts = email.partition("@")
356 local_parts = email_parts.first.partition("+")
357 if email_parts.any?(&:empty?)
359 elsif not local_parts.first.empty?
360 requested = local_parts.first
362 requested = email_parts.first
365 requested.sub!(/^[^A-Za-z]+/, "")
366 requested.gsub!(/[^A-Za-z0-9]/, "")
367 unless requested.empty?
368 self.username = find_usable_username_from(requested)
372 # Move this user's (i.e., self's) owned items to new_owner_uuid and
373 # new_user_uuid (for things normally owned directly by the user).
375 # If redirect_auth is true, also reassign auth tokens and ssh keys,
376 # and redirect this account to redirect_to_user_uuid, i.e., when a
377 # caller authenticates to this account in the future, the account
378 # redirect_to_user_uuid account will be used instead.
380 # current_user must have admin privileges, i.e., the caller is
381 # responsible for checking permission to do this.
382 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
383 raise PermissionDeniedError if !current_user.andand.is_admin
384 raise "Missing new_owner_uuid" if !new_owner_uuid
385 raise "Missing new_user_uuid" if !new_user_uuid
386 transaction(requires_new: true) do
388 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
390 new_user = User.where(uuid: new_user_uuid).first
391 raise "user does not exist" if !new_user
392 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
394 self.clear_permissions
395 new_user.clear_permissions
397 # If 'self' is a remote user, don't transfer authorizations
398 # (i.e. ability to access the account) to the new user, because
399 # that gives the remote site the ability to access the 'new'
400 # user account that takes over the 'self' account.
402 # If 'self' is a local user, it is okay to transfer
403 # authorizations, even if the 'new' user is a remote account,
404 # because the remote site does not gain the ability to access an
405 # account it could not before.
407 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
408 # Existing API tokens and ssh keys are updated to authenticate
410 ApiClientAuthorization.
412 update_all(user_id: new_user.id)
415 [AuthorizedKey, :owner_uuid],
416 [AuthorizedKey, :authorized_user_uuid],
422 # Destroy API tokens and ssh keys associated with the old
424 ApiClientAuthorization.where(user_id: id).destroy_all
425 AuthorizedKey.where(owner_uuid: uuid).destroy_all
426 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
433 # References to the old user UUID in the context of a user ID
434 # (rather than a "home project" in the project hierarchy) are
435 # updated to point to the new user.
436 user_updates.each do |klass, column|
437 klass.where(column => uuid).update_all(column => new_user.uuid)
440 # Need to update repository names to new username
442 old_repo_name_re = /^#{Regexp.escape(username)}\//
443 Repository.where(:owner_uuid => uuid).each do |repo|
444 repo.owner_uuid = new_user.uuid
445 repo_name_sub = "#{new_user.username}/"
446 name = repo.name.sub(old_repo_name_re, repo_name_sub)
447 while (conflict = Repository.where(:name => name).first) != nil
448 repo_name_sub += "migrated"
449 name = repo.name.sub(old_repo_name_re, repo_name_sub)
456 # References to the merged user's "home project" are updated to
457 # point to new_owner_uuid.
458 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
459 next if [ApiClientAuthorization,
463 Repository].include?(klass)
464 next if !klass.columns.collect(&:name).include?('owner_uuid')
465 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
468 if redirect_to_new_user
469 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
471 skip_check_permissions_against_full_refresh do
472 update_permissions self.uuid, self.uuid, CAN_MANAGE_PERM
473 update_permissions new_user.uuid, new_user.uuid, CAN_MANAGE_PERM
474 update_permissions new_user.owner_uuid, new_user.uuid, CAN_MANAGE_PERM
476 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
483 while (uuid = user.redirect_to_user_uuid)
485 nextuser = User.unscoped.find_by_uuid(uuid)
487 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
492 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
498 def self.register info
499 # login info expected fields, all can be optional but at minimum
500 # must supply either 'identity_url' or 'email'
512 identity_url = info['identity_url']
514 if identity_url && identity_url.length > 0
515 # Only local users can create sessions, hence uuid_like_pattern
517 user = User.unscoped.where('identity_url = ? and uuid like ?',
519 User.uuid_like_pattern).first
520 primary_user = user.redirects_to if user
524 # identity url is unset or didn't find matching record.
525 emails = [info['email']] + (info['alternate_emails'] || [])
526 emails.select! {|em| !em.nil? && !em.empty?}
528 User.unscoped.where('email in (?) and uuid like ?',
530 User.uuid_like_pattern).each do |user|
532 primary_user = user.redirects_to
533 elsif primary_user.uuid != user.redirects_to.uuid
534 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
540 # New user registration
541 primary_user = User.new(:owner_uuid => system_user_uuid,
543 :is_active => Rails.configuration.Users.NewUsersAreActive)
545 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
546 primary_user.identity_url = info['identity_url'] if identity_url
549 primary_user.email = info['email'] if info['email']
550 primary_user.first_name = info['first_name'] if info['first_name']
551 primary_user.last_name = info['last_name'] if info['last_name']
553 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
554 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
557 act_as_system_user do
566 def change_all_uuid_refs(old_uuid:, new_uuid:)
567 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
568 klass.columns.each do |col|
569 if col.name.end_with?('_uuid')
570 column = col.name.to_sym
571 klass.where(column => old_uuid).update_all(column => new_uuid)
577 def ensure_ownership_path_leads_to_user
581 def permission_to_update
582 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
583 current_user.andand.is_admin
585 # users must be able to update themselves (even if they are
586 # inactive) in order to create sessions
587 self == current_user or super
591 def permission_to_create
592 current_user.andand.is_admin or
593 (self == current_user &&
594 self.redirect_to_user_uuid.nil? &&
595 self.is_active == Rails.configuration.Users.NewUsersAreActive)
599 return if self.uuid.end_with?('anonymouspublic')
600 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
601 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
602 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
603 Rails.configuration.Users.AutoAdminFirstUser)
605 self.is_active = true
609 def find_usable_username_from(basename)
610 # If "basename" is a usable username, return that.
611 # Otherwise, find a unique username "basenameN", where N is the
612 # smallest integer greater than 1, and return that.
613 # Return nil if a unique username can't be found after reasonable
615 quoted_name = self.class.connection.quote_string(basename)
616 next_username = basename
618 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
620 next_username = "%s%i" % [basename, next_suffix]
622 0.upto(6).each do |suffix_len|
623 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
625 where("username like '#{pattern}'").
627 order('username asc').
629 if other_user.username > next_username
631 elsif other_user.username == next_username
633 next_username = "%s%i" % [basename, next_suffix]
636 return next_username if (next_username.size <= pattern.size)
641 def prevent_privilege_escalation
642 if current_user.andand.is_admin
645 if self.is_active_changed?
646 if self.is_active != self.is_active_was
647 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
648 self.is_active = self.is_active_was
651 if self.is_admin_changed?
652 if self.is_admin != self.is_admin_was
653 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
654 self.is_admin = self.is_admin_was
660 def prevent_inactive_admin
661 if self.is_admin and not self.is_active
662 # There is no known use case for the strange set of permissions
663 # that would result from this change. It's safest to assume it's
664 # a mistake and disallow it outright.
665 raise "Admin users cannot be inactive"
670 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
671 nextpaths = graph[start]
672 return merged if !nextpaths
673 return merged if upstream_path.has_key? start
674 upstream_path[start] = true
675 upstream_mask ||= ALL_PERMISSIONS
676 nextpaths.each do |head, mask|
679 merged[head][k] ||= v if upstream_mask[k]
681 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
683 upstream_path.delete start
687 def create_user_repo_link(repo_name)
688 # repo_name is optional
690 logger.warn ("Repository name not given for #{self.uuid}.")
694 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
695 logger.info { "repo uuid: " + repo[:uuid] }
696 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
697 link_class: "permission",
698 name: "can_manage").first_or_create!
699 logger.info { "repo permission: " + repo_perm[:uuid] }
703 # create login permission for the given vm_uuid, if it does not already exist
704 def create_vm_login_permission_link(vm_uuid, repo_name)
705 # vm uuid is optional
706 return if vm_uuid == ""
708 vm = VirtualMachine.where(uuid: vm_uuid).first
710 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
711 raise "No vm found for #{vm_uuid}"
714 logger.info { "vm uuid: " + vm[:uuid] }
716 tail_uuid: uuid, head_uuid: vm.uuid,
717 link_class: "permission", name: "can_login",
722 select { |link| link.properties["username"] == repo_name }.
726 create(login_attrs.merge(properties: {"username" => repo_name}))
728 logger.info { "login permission: " + login_perm[:uuid] }
732 def add_to_all_users_group
733 resp = [Link.where(tail_uuid: self.uuid,
734 head_uuid: all_users_group_uuid,
735 link_class: 'permission',
736 name: 'can_read').first ||
737 Link.create(tail_uuid: self.uuid,
738 head_uuid: all_users_group_uuid,
739 link_class: 'permission',
741 if Rails.configuration.Users.ActivatedUsersAreVisibleToOthers
742 resp += [Link.where(tail_uuid: all_users_group_uuid,
743 head_uuid: self.uuid,
744 link_class: 'permission',
745 name: 'can_read').first ||
746 Link.create(tail_uuid: all_users_group_uuid,
747 head_uuid: self.uuid,
748 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)