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 before_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 remove_self_from_permissions
165 MaterializedPermission.where("target_uuid = ?", uuid).delete_all
166 check_permissions_against_full_refresh
169 # Return a hash of {user_uuid: group_perms}
171 # note: this does not account for permissions that a user gains by
172 # having can_manage on another user.
173 def self.all_group_permissions
175 ActiveRecord::Base.connection.
177 SELECT user_uuid, target_uuid, perm_level
178 FROM #{PERMISSION_VIEW}
181 # "name" arg is a query label that appears in logs:
182 "all_group_permissions").
183 rows.each do |user_uuid, group_uuid, max_p_val|
184 all_perms[user_uuid] ||= {}
185 all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
190 # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
191 # and perm_hash[:write] are true if this user can read and write
192 # objects owned by group_uuid.
193 def group_permissions(level=1)
196 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: "$2"}
198 ActiveRecord::Base.connection.
200 SELECT target_uuid, perm_level
201 FROM #{PERMISSION_VIEW}
202 WHERE user_uuid in (#{user_uuids_subquery}) and perm_level >= $2
204 # "name" arg is a query label that appears in logs:
205 "User.group_permissions",
206 # "binds" arg is an array of [col_id, value] for '$1' vars:
209 rows.each do |group_uuid, max_p_val|
210 group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
216 def setup(repo_name: nil, vm_uuid: nil, send_notification_email: nil)
217 newly_invited = Link.where(tail_uuid: self.uuid,
218 head_uuid: all_users_group_uuid,
219 link_class: 'permission',
220 name: 'can_read').empty?
222 group_perm = create_user_group_link
223 repo_perm = create_user_repo_link repo_name
224 vm_login_perm = create_vm_login_permission_link(vm_uuid, username) if vm_uuid
226 if send_notification_email.nil?
227 send_notification_email = Rails.configuration.Mail.SendUserSetupNotificationEmail
230 if newly_invited and send_notification_email and !Rails.configuration.Users.UserSetupMailText.empty?
232 UserNotifier.account_is_setup(self).deliver_now
234 logger.warn "Failed to send email to #{self.email}: #{e}"
238 return [repo_perm, vm_login_perm, group_perm, self].compact
241 # delete user signatures, login, repo, and vm perms, and mark as inactive
243 # delete oid_login_perms for this user
245 # note: these permission links are obsolete, they have no effect
246 # on anything and they are not created for new users.
247 Link.where(tail_uuid: self.email,
248 link_class: 'permission',
249 name: 'can_login').destroy_all
251 # delete repo_perms for this user
252 Link.where(tail_uuid: self.uuid,
253 link_class: 'permission',
254 name: 'can_manage').destroy_all
256 # delete vm_login_perms for this user
257 Link.where(tail_uuid: self.uuid,
258 link_class: 'permission',
259 name: 'can_login').destroy_all
261 # delete "All users" group read permissions for this user
262 Link.where(tail_uuid: self.uuid,
263 head_uuid: all_users_group_uuid,
264 link_class: 'permission',
265 name: 'can_read').destroy_all
267 # delete any signatures by this user
268 Link.where(link_class: 'signature',
269 tail_uuid: self.uuid).destroy_all
271 # delete user preferences (including profile)
274 # mark the user as inactive
275 self.is_admin = false # can't be admin and inactive
276 self.is_active = false
280 def must_unsetup_to_deactivate
281 if !self.new_record? &&
282 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
283 self.uuid[0..4] != Rails.configuration.ClusterID
284 # OK to update our local record to whatever the LoginCluster
285 # reports, because self-activate is not allowed.
287 elsif self.is_active_changed? &&
288 self.is_active_was &&
291 # When a user is set up, they are added to the "All users"
292 # group. A user that is part of the "All users" group is
293 # allowed to self-activate.
295 # It doesn't make sense to deactivate a user (set is_active =
296 # false) without first removing them from the "All users" group,
297 # because they would be able to immediately reactivate
300 # The 'unsetup' method removes the user from the "All users"
301 # group (and also sets is_active = false) so send a message
302 # explaining the correct way to deactivate a user.
304 if Link.where(tail_uuid: self.uuid,
305 head_uuid: all_users_group_uuid,
306 link_class: 'permission',
307 name: 'can_read').any?
308 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
313 def set_initial_username(requested: false)
314 if !requested.is_a?(String) || requested.empty?
315 email_parts = email.partition("@")
316 local_parts = email_parts.first.partition("+")
317 if email_parts.any?(&:empty?)
319 elsif not local_parts.first.empty?
320 requested = local_parts.first
322 requested = email_parts.first
325 requested.sub!(/^[^A-Za-z]+/, "")
326 requested.gsub!(/[^A-Za-z0-9]/, "")
327 unless requested.empty?
328 self.username = find_usable_username_from(requested)
332 def update_uuid(new_uuid:)
333 if !current_user.andand.is_admin
334 raise PermissionDeniedError
336 if uuid == system_user_uuid || uuid == anonymous_user_uuid
337 raise "update_uuid cannot update system accounts"
339 if self.class != self.class.resource_class_for_uuid(new_uuid)
340 raise "invalid new_uuid #{new_uuid.inspect}"
342 transaction(requires_new: true) do
346 save!(validate: false)
347 change_all_uuid_refs(old_uuid: old_uuid, new_uuid: new_uuid)
348 ActiveRecord::Base.connection.exec_update %{
349 update #{PERMISSION_VIEW} set user_uuid=$1 where user_uuid = $2
351 'User.update_uuid.update_permissions_user_uuid',
354 ActiveRecord::Base.connection.exec_update %{
355 update #{PERMISSION_VIEW} set target_uuid=$1 where target_uuid = $2
357 'User.update_uuid.update_permissions_target_uuid',
363 # Move this user's (i.e., self's) owned items to new_owner_uuid and
364 # new_user_uuid (for things normally owned directly by the user).
366 # If redirect_auth is true, also reassign auth tokens and ssh keys,
367 # and redirect this account to redirect_to_user_uuid, i.e., when a
368 # caller authenticates to this account in the future, the account
369 # redirect_to_user_uuid account will be used instead.
371 # current_user must have admin privileges, i.e., the caller is
372 # responsible for checking permission to do this.
373 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
374 raise PermissionDeniedError if !current_user.andand.is_admin
375 raise "Missing new_owner_uuid" if !new_owner_uuid
376 raise "Missing new_user_uuid" if !new_user_uuid
377 transaction(requires_new: true) do
379 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
381 new_user = User.where(uuid: new_user_uuid).first
382 raise "user does not exist" if !new_user
383 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
385 self.clear_permissions
386 new_user.clear_permissions
388 # If 'self' is a remote user, don't transfer authorizations
389 # (i.e. ability to access the account) to the new user, because
390 # that gives the remote site the ability to access the 'new'
391 # user account that takes over the 'self' account.
393 # If 'self' is a local user, it is okay to transfer
394 # authorizations, even if the 'new' user is a remote account,
395 # because the remote site does not gain the ability to access an
396 # account it could not before.
398 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
399 # Existing API tokens and ssh keys are updated to authenticate
401 ApiClientAuthorization.
403 update_all(user_id: new_user.id)
406 [AuthorizedKey, :owner_uuid],
407 [AuthorizedKey, :authorized_user_uuid],
413 # Destroy API tokens and ssh keys associated with the old
415 ApiClientAuthorization.where(user_id: id).destroy_all
416 AuthorizedKey.where(owner_uuid: uuid).destroy_all
417 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
424 # References to the old user UUID in the context of a user ID
425 # (rather than a "home project" in the project hierarchy) are
426 # updated to point to the new user.
427 user_updates.each do |klass, column|
428 klass.where(column => uuid).update_all(column => new_user.uuid)
431 # Need to update repository names to new username
433 old_repo_name_re = /^#{Regexp.escape(username)}\//
434 Repository.where(:owner_uuid => uuid).each do |repo|
435 repo.owner_uuid = new_user.uuid
436 repo_name_sub = "#{new_user.username}/"
437 name = repo.name.sub(old_repo_name_re, repo_name_sub)
438 while (conflict = Repository.where(:name => name).first) != nil
439 repo_name_sub += "migrated"
440 name = repo.name.sub(old_repo_name_re, repo_name_sub)
447 # References to the merged user's "home project" are updated to
448 # point to new_owner_uuid.
449 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
450 next if [ApiClientAuthorization,
454 Repository].include?(klass)
455 next if !klass.columns.collect(&:name).include?('owner_uuid')
456 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
459 if redirect_to_new_user
460 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
462 skip_check_permissions_against_full_refresh do
463 update_permissions self.uuid, self.uuid, CAN_MANAGE_PERM
464 update_permissions new_user.uuid, new_user.uuid, CAN_MANAGE_PERM
465 update_permissions new_user.owner_uuid, new_user.uuid, CAN_MANAGE_PERM
467 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
474 while (uuid = user.redirect_to_user_uuid)
476 nextuser = User.unscoped.find_by_uuid(uuid)
478 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
483 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
489 def self.register info
490 # login info expected fields, all can be optional but at minimum
491 # must supply either 'identity_url' or 'email'
503 identity_url = info['identity_url']
505 if identity_url && identity_url.length > 0
506 # Only local users can create sessions, hence uuid_like_pattern
508 user = User.unscoped.where('identity_url = ? and uuid like ?',
510 User.uuid_like_pattern).first
511 primary_user = user.redirects_to if user
515 # identity url is unset or didn't find matching record.
516 emails = [info['email']] + (info['alternate_emails'] || [])
517 emails.select! {|em| !em.nil? && !em.empty?}
519 User.unscoped.where('email in (?) and uuid like ?',
521 User.uuid_like_pattern).each do |user|
523 primary_user = user.redirects_to
524 elsif primary_user.uuid != user.redirects_to.uuid
525 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
531 # New user registration
532 primary_user = User.new(:owner_uuid => system_user_uuid,
534 :is_active => Rails.configuration.Users.NewUsersAreActive)
536 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
537 primary_user.identity_url = info['identity_url'] if identity_url
540 primary_user.email = info['email'] if info['email']
541 primary_user.first_name = info['first_name'] if info['first_name']
542 primary_user.last_name = info['last_name'] if info['last_name']
544 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
545 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
548 act_as_system_user do
557 def change_all_uuid_refs(old_uuid:, new_uuid:)
558 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
559 klass.columns.each do |col|
560 if col.name.end_with?('_uuid')
561 column = col.name.to_sym
562 klass.where(column => old_uuid).update_all(column => new_uuid)
568 def ensure_ownership_path_leads_to_user
572 def permission_to_update
573 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
574 current_user.andand.is_admin
576 # users must be able to update themselves (even if they are
577 # inactive) in order to create sessions
578 self == current_user or super
582 def permission_to_create
583 current_user.andand.is_admin or
584 (self == current_user &&
585 self.redirect_to_user_uuid.nil? &&
586 self.is_active == Rails.configuration.Users.NewUsersAreActive)
590 return if self.uuid.end_with?('anonymouspublic')
591 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
592 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
593 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
594 Rails.configuration.Users.AutoAdminFirstUser)
596 self.is_active = true
600 def find_usable_username_from(basename)
601 # If "basename" is a usable username, return that.
602 # Otherwise, find a unique username "basenameN", where N is the
603 # smallest integer greater than 1, and return that.
604 # Return nil if a unique username can't be found after reasonable
606 quoted_name = self.class.connection.quote_string(basename)
607 next_username = basename
609 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
611 next_username = "%s%i" % [basename, next_suffix]
613 0.upto(6).each do |suffix_len|
614 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
616 where("username like '#{pattern}'").
618 order('username asc').
620 if other_user.username > next_username
622 elsif other_user.username == next_username
624 next_username = "%s%i" % [basename, next_suffix]
627 return next_username if (next_username.size <= pattern.size)
632 def prevent_privilege_escalation
633 if current_user.andand.is_admin
636 if self.is_active_changed?
637 if self.is_active != self.is_active_was
638 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
639 self.is_active = self.is_active_was
642 if self.is_admin_changed?
643 if self.is_admin != self.is_admin_was
644 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
645 self.is_admin = self.is_admin_was
651 def prevent_inactive_admin
652 if self.is_admin and not self.is_active
653 # There is no known use case for the strange set of permissions
654 # that would result from this change. It's safest to assume it's
655 # a mistake and disallow it outright.
656 raise "Admin users cannot be inactive"
661 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
662 nextpaths = graph[start]
663 return merged if !nextpaths
664 return merged if upstream_path.has_key? start
665 upstream_path[start] = true
666 upstream_mask ||= ALL_PERMISSIONS
667 nextpaths.each do |head, mask|
670 merged[head][k] ||= v if upstream_mask[k]
672 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
674 upstream_path.delete start
678 def create_user_repo_link(repo_name)
679 # repo_name is optional
681 logger.warn ("Repository name not given for #{self.uuid}.")
685 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
686 logger.info { "repo uuid: " + repo[:uuid] }
687 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
688 link_class: "permission",
689 name: "can_manage").first_or_create!
690 logger.info { "repo permission: " + repo_perm[:uuid] }
694 # create login permission for the given vm_uuid, if it does not already exist
695 def create_vm_login_permission_link(vm_uuid, repo_name)
696 # vm uuid is optional
697 return if vm_uuid == ""
699 vm = VirtualMachine.where(uuid: vm_uuid).first
701 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
702 raise "No vm found for #{vm_uuid}"
705 logger.info { "vm uuid: " + vm[:uuid] }
707 tail_uuid: uuid, head_uuid: vm.uuid,
708 link_class: "permission", name: "can_login",
713 select { |link| link.properties["username"] == repo_name }.
717 create(login_attrs.merge(properties: {"username" => repo_name}))
719 logger.info { "login permission: " + login_perm[:uuid] }
723 # add the user to the 'All users' group
724 def create_user_group_link
725 return (Link.where(tail_uuid: self.uuid,
726 head_uuid: all_users_group_uuid,
727 link_class: 'permission',
728 name: 'can_read').first or
729 Link.create(tail_uuid: self.uuid,
730 head_uuid: all_users_group_uuid,
731 link_class: 'permission',
735 # Give the special "System group" permission to manage this user and
736 # all of this user's stuff.
737 def add_system_group_permission_link
738 return true if uuid == system_user_uuid
739 act_as_system_user do
740 Link.create(link_class: 'permission',
742 tail_uuid: system_group_uuid,
743 head_uuid: self.uuid)
747 # Send admin notifications
748 def send_admin_notifications
749 AdminNotifier.new_user(self).deliver_now
750 if not self.is_active then
751 AdminNotifier.new_inactive_user(self).deliver_now
755 # Automatically setup if is_active flag turns on
756 def setup_on_activate
757 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
759 (new_record? || saved_change_to_is_active? || will_save_change_to_is_active?)
764 # Automatically setup new user during creation
765 def auto_setup_new_user
768 create_vm_login_permission_link(Rails.configuration.Users.AutoSetupNewUsersWithVmUUID,
770 repo_name = "#{username}/#{username}"
771 if Rails.configuration.Users.AutoSetupNewUsersWithRepository and
772 Repository.where(name: repo_name).first.nil?
773 repo = Repository.create!(name: repo_name, owner_uuid: uuid)
774 Link.create!(tail_uuid: uuid, head_uuid: repo.uuid,
775 link_class: "permission", name: "can_manage")
780 # Send notification if the user saved profile for the first time
781 def send_profile_created_notification
782 if saved_change_to_prefs?
783 if prefs_before_last_save.andand.empty? || !prefs_before_last_save.andand['profile']
784 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
785 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
790 def verify_repositories_empty
791 unless repositories.first.nil?
792 errors.add(:username, "can't be unset when the user owns repositories")
797 def sync_repository_names
798 old_name_re = /^#{Regexp.escape(username_before_last_save)}\//
799 name_sub = "#{username}/"
800 repositories.find_each do |repo|
801 repo.name = repo.name.sub(old_name_re, name_sub)