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 { |user|
27 user.username.nil? and user.username_changed?
29 before_update :setup_on_activate
31 before_create :check_auto_admin
32 before_create :set_initial_username, :if => Proc.new { |user|
33 user.username.nil? and user.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 { |user|
39 Rails.configuration.Users.AutoSetupNewUsers and
40 (user.uuid != system_user_uuid) and
41 (user.uuid != anonymous_user_uuid)
43 after_create :send_admin_notifications
45 before_update :before_ownership_change
46 after_update :after_ownership_change
47 after_update :send_profile_created_notification
48 after_update :sync_repository_names, :if => Proc.new { |user|
49 (user.uuid != system_user_uuid) and
50 user.username_changed? and
51 (not user.username_was.nil?)
53 after_destroy :clear_permissions
55 has_many :authorized_keys, :foreign_key => :authorized_user_uuid, :primary_key => :uuid
56 has_many :repositories, foreign_key: :owner_uuid, primary_key: :uuid
58 default_scope { where('redirect_to_user_uuid is null') }
60 api_accessible :user, extend: :common do |t|
74 ALL_PERMISSIONS = {read: true, write: true, manage: true}
76 # Map numeric permission levels (see lib/create_permission_view.sql)
77 # back to read/write/manage flags.
81 {read: true, write: true},
82 {read: true, write: true, manage: true}]
91 "#{first_name} #{last_name}".strip
96 Rails.configuration.Users.NewUsersAreActive ||
97 self.groups_i_can(:read).select { |x| x.match(/-f+$/) }.first)
100 def groups_i_can(verb)
101 my_groups = self.group_permissions(VAL_FOR_PERM[verb]).keys
103 my_groups << anonymous_group_uuid
109 return true if is_admin
110 actions.each do |action, target|
112 if target.respond_to? :uuid
113 target_uuid = target.uuid
116 target = ArvadosModel.find_by_uuid(target_uuid)
119 next if target_uuid == self.uuid
121 target_owner_uuid = target.owner_uuid if target.respond_to? :owner_uuid
123 unless ActiveRecord::Base.connection.
125 SELECT 1 FROM #{PERMISSION_VIEW}
126 WHERE user_uuid = $1 and
127 ((target_uuid = $2 and perm_level >= $3)
128 or (target_uuid = $4 and perm_level >= $3 and traverse_owned))
130 # "name" arg is a query label that appears in logs:
134 [nil, VAL_FOR_PERM[action]],
135 [nil, target_owner_uuid]]
143 def before_ownership_change
144 if owner_uuid_changed? and !self.owner_uuid_was.nil?
145 MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
146 update_permissions self.owner_uuid_was, self.uuid, 0, false
150 def after_ownership_change
151 if owner_uuid_changed?
152 update_permissions self.owner_uuid, self.uuid, 3
156 def clear_permissions
157 MaterializedPermission.where("user_uuid = ? or target_uuid = ?", uuid, uuid).delete_all
160 def recompute_permissions
161 ActiveRecord::Base.connection.exec_delete("DELETE FROM #{PERMISSION_VIEW} where user_uuid=$1",
162 "User.recompute_permissions.delete_user_uuid",
164 ActiveRecord::Base.connection.exec_insert %{
165 INSERT INTO #{PERMISSION_VIEW}
166 select $1::varchar, g.target_uuid, g.val, g.traverse_owned
167 from search_permission_graph($1::varchar, 3) as g
169 "User.recompute_permissions.insert",
173 # Return a hash of {user_uuid: group_perms}
174 def self.all_group_permissions
176 ActiveRecord::Base.connection.
177 exec_query("SELECT user_uuid, target_uuid, perm_level
178 FROM #{PERMISSION_VIEW}
179 WHERE traverse_owned",
180 # "name" arg is a query label that appears in logs:
181 "all_group_permissions").
182 rows.each do |user_uuid, group_uuid, max_p_val|
183 all_perms[user_uuid] ||= {}
184 all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
189 # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
190 # and perm_hash[:write] are true if this user can read and write
191 # objects owned by group_uuid.
192 def group_permissions(level=1)
194 ActiveRecord::Base.connection.
196 SELECT target_uuid, perm_level
197 FROM #{PERMISSION_VIEW}
198 WHERE user_uuid = $1 and perm_level >= $2
200 # "name" arg is a query label that appears in logs:
201 "group_permissions_for_user",
202 # "binds" arg is an array of [col_id, value] for '$1' vars:
205 rows.each do |group_uuid, max_p_val|
206 group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
212 def setup(repo_name: nil, vm_uuid: nil)
213 repo_perm = create_user_repo_link repo_name
214 vm_login_perm = create_vm_login_permission_link(vm_uuid, username) if vm_uuid
215 group_perm = create_user_group_link
217 return [repo_perm, vm_login_perm, group_perm, self].compact
220 # delete user signatures, login, repo, and vm perms, and mark as inactive
222 # delete oid_login_perms for this user
224 # note: these permission links are obsolete, they have no effect
225 # on anything and they are not created for new users.
226 Link.where(tail_uuid: self.email,
227 link_class: 'permission',
228 name: 'can_login').destroy_all
230 # delete repo_perms for this user
231 Link.where(tail_uuid: self.uuid,
232 link_class: 'permission',
233 name: 'can_manage').destroy_all
235 # delete vm_login_perms for this user
236 Link.where(tail_uuid: self.uuid,
237 link_class: 'permission',
238 name: 'can_login').destroy_all
240 # delete "All users" group read permissions for this user
241 group = Group.where(name: 'All users').select do |g|
242 g[:uuid].match(/-f+$/)
244 Link.where(tail_uuid: self.uuid,
245 head_uuid: group[:uuid],
246 link_class: 'permission',
247 name: 'can_read').destroy_all
249 # delete any signatures by this user
250 Link.where(link_class: 'signature',
251 tail_uuid: self.uuid).destroy_all
253 # delete user preferences (including profile)
256 # mark the user as inactive
257 self.is_active = false
261 def must_unsetup_to_deactivate
262 if self.is_active_changed? &&
263 self.is_active_was == true &&
266 group = Group.where(name: 'All users').select do |g|
267 g[:uuid].match(/-f+$/)
270 # When a user is set up, they are added to the "All users"
271 # group. A user that is part of the "All users" group is
272 # allowed to self-activate.
274 # It doesn't make sense to deactivate a user (set is_active =
275 # false) without first removing them from the "All users" group,
276 # because they would be able to immediately reactivate
279 # The 'unsetup' method removes the user from the "All users"
280 # group (and also sets is_active = false) so send a message
281 # explaining the correct way to deactivate a user.
283 if Link.where(tail_uuid: self.uuid,
284 head_uuid: group[:uuid],
285 link_class: 'permission',
286 name: 'can_read').any?
287 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
292 def set_initial_username(requested: false)
293 if !requested.is_a?(String) || requested.empty?
294 email_parts = email.partition("@")
295 local_parts = email_parts.first.partition("+")
296 if email_parts.any?(&:empty?)
298 elsif not local_parts.first.empty?
299 requested = local_parts.first
301 requested = email_parts.first
304 requested.sub!(/^[^A-Za-z]+/, "")
305 requested.gsub!(/[^A-Za-z0-9]/, "")
306 unless requested.empty?
307 self.username = find_usable_username_from(requested)
311 def update_uuid(new_uuid:)
312 if !current_user.andand.is_admin
313 raise PermissionDeniedError
315 if uuid == system_user_uuid || uuid == anonymous_user_uuid
316 raise "update_uuid cannot update system accounts"
318 if self.class != self.class.resource_class_for_uuid(new_uuid)
319 raise "invalid new_uuid #{new_uuid.inspect}"
321 transaction(requires_new: true) do
325 save!(validate: false)
326 change_all_uuid_refs(old_uuid: old_uuid, new_uuid: new_uuid)
327 ActiveRecord::Base.connection.exec_update %{
328 update #{PERMISSION_VIEW} set user_uuid=$1 where user_uuid = $2
330 'User.update_uuid.update_permissions_user_uuid',
333 ActiveRecord::Base.connection.exec_update %{
334 update #{PERMISSION_VIEW} set target_uuid=$1 where target_uuid = $2
336 'User.update_uuid.update_permissions_target_uuid',
342 # Move this user's (i.e., self's) owned items to new_owner_uuid and
343 # new_user_uuid (for things normally owned directly by the user).
345 # If redirect_auth is true, also reassign auth tokens and ssh keys,
346 # and redirect this account to redirect_to_user_uuid, i.e., when a
347 # caller authenticates to this account in the future, the account
348 # redirect_to_user_uuid account will be used instead.
350 # current_user must have admin privileges, i.e., the caller is
351 # responsible for checking permission to do this.
352 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
353 raise PermissionDeniedError if !current_user.andand.is_admin
354 raise "Missing new_owner_uuid" if !new_owner_uuid
355 raise "Missing new_user_uuid" if !new_user_uuid
356 transaction(requires_new: true) do
358 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
360 new_user = User.where(uuid: new_user_uuid).first
361 raise "user does not exist" if !new_user
362 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
364 # If 'self' is a remote user, don't transfer authorizations
365 # (i.e. ability to access the account) to the new user, because
366 # that gives the remote site the ability to access the 'new'
367 # user account that takes over the 'self' account.
369 # If 'self' is a local user, it is okay to transfer
370 # authorizations, even if the 'new' user is a remote account,
371 # because the remote site does not gain the ability to access an
372 # account it could not before.
374 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
375 # Existing API tokens and ssh keys are updated to authenticate
377 ApiClientAuthorization.
379 update_all(user_id: new_user.id)
382 [AuthorizedKey, :owner_uuid],
383 [AuthorizedKey, :authorized_user_uuid],
389 # Destroy API tokens and ssh keys associated with the old
391 ApiClientAuthorization.where(user_id: id).destroy_all
392 AuthorizedKey.where(owner_uuid: uuid).destroy_all
393 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
400 # References to the old user UUID in the context of a user ID
401 # (rather than a "home project" in the project hierarchy) are
402 # updated to point to the new user.
403 user_updates.each do |klass, column|
404 klass.where(column => uuid).update_all(column => new_user.uuid)
407 # Need to update repository names to new username
409 old_repo_name_re = /^#{Regexp.escape(username)}\//
410 Repository.where(:owner_uuid => uuid).each do |repo|
411 repo.owner_uuid = new_user.uuid
412 repo_name_sub = "#{new_user.username}/"
413 name = repo.name.sub(old_repo_name_re, repo_name_sub)
414 while (conflict = Repository.where(:name => name).first) != nil
415 repo_name_sub += "migrated"
416 name = repo.name.sub(old_repo_name_re, repo_name_sub)
423 # References to the merged user's "home project" are updated to
424 # point to new_owner_uuid.
425 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
426 next if [ApiClientAuthorization,
430 Repository].include?(klass)
431 next if !klass.columns.collect(&:name).include?('owner_uuid')
432 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
435 if redirect_to_new_user
436 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
438 self.recompute_permissions
439 new_user.recompute_permissions
446 while (uuid = user.redirect_to_user_uuid)
448 nextuser = User.unscoped.find_by_uuid(uuid)
450 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
455 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
461 def self.register info
462 # login info expected fields, all can be optional but at minimum
463 # must supply either 'identity_url' or 'email'
475 identity_url = info['identity_url']
477 if identity_url && identity_url.length > 0
478 # Only local users can create sessions, hence uuid_like_pattern
480 user = User.unscoped.where('identity_url = ? and uuid like ?',
482 User.uuid_like_pattern).first
483 primary_user = user.redirects_to if user
487 # identity url is unset or didn't find matching record.
488 emails = [info['email']] + (info['alternate_emails'] || [])
489 emails.select! {|em| !em.nil? && !em.empty?}
491 User.unscoped.where('email in (?) and uuid like ?',
493 User.uuid_like_pattern).each do |user|
495 primary_user = user.redirects_to
496 elsif primary_user.uuid != user.redirects_to.uuid
497 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
503 # New user registration
504 primary_user = User.new(:owner_uuid => system_user_uuid,
506 :is_active => Rails.configuration.Users.NewUsersAreActive)
508 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
509 primary_user.identity_url = info['identity_url'] if identity_url
512 primary_user.email = info['email'] if info['email']
513 primary_user.first_name = info['first_name'] if info['first_name']
514 primary_user.last_name = info['last_name'] if info['last_name']
516 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
517 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
520 act_as_system_user do
529 def change_all_uuid_refs(old_uuid:, new_uuid:)
530 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
531 klass.columns.each do |col|
532 if col.name.end_with?('_uuid')
533 column = col.name.to_sym
534 klass.where(column => old_uuid).update_all(column => new_uuid)
540 def ensure_ownership_path_leads_to_user
544 def permission_to_update
545 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
546 current_user.andand.is_admin
548 # users must be able to update themselves (even if they are
549 # inactive) in order to create sessions
550 self == current_user or super
554 def permission_to_create
555 current_user.andand.is_admin or
556 (self == current_user &&
557 self.redirect_to_user_uuid.nil? &&
558 self.is_active == Rails.configuration.Users.NewUsersAreActive)
562 return if self.uuid.end_with?('anonymouspublic')
563 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
564 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
565 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
566 Rails.configuration.Users.AutoAdminFirstUser)
568 self.is_active = true
572 def find_usable_username_from(basename)
573 # If "basename" is a usable username, return that.
574 # Otherwise, find a unique username "basenameN", where N is the
575 # smallest integer greater than 1, and return that.
576 # Return nil if a unique username can't be found after reasonable
578 quoted_name = self.class.connection.quote_string(basename)
579 next_username = basename
581 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
583 next_username = "%s%i" % [basename, next_suffix]
585 0.upto(6).each do |suffix_len|
586 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
588 where("username like '#{pattern}'").
590 order('username asc').
592 if other_user.username > next_username
594 elsif other_user.username == next_username
596 next_username = "%s%i" % [basename, next_suffix]
599 return next_username if (next_username.size <= pattern.size)
604 def prevent_privilege_escalation
605 if current_user.andand.is_admin
608 if self.is_active_changed?
609 if self.is_active != self.is_active_was
610 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
611 self.is_active = self.is_active_was
614 if self.is_admin_changed?
615 if self.is_admin != self.is_admin_was
616 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
617 self.is_admin = self.is_admin_was
623 def prevent_inactive_admin
624 if self.is_admin and not self.is_active
625 # There is no known use case for the strange set of permissions
626 # that would result from this change. It's safest to assume it's
627 # a mistake and disallow it outright.
628 raise "Admin users cannot be inactive"
633 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
634 nextpaths = graph[start]
635 return merged if !nextpaths
636 return merged if upstream_path.has_key? start
637 upstream_path[start] = true
638 upstream_mask ||= ALL_PERMISSIONS
639 nextpaths.each do |head, mask|
642 merged[head][k] ||= v if upstream_mask[k]
644 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
646 upstream_path.delete start
650 def create_user_repo_link(repo_name)
651 # repo_name is optional
653 logger.warn ("Repository name not given for #{self.uuid}.")
657 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
658 logger.info { "repo uuid: " + repo[:uuid] }
659 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
660 link_class: "permission",
661 name: "can_manage").first_or_create!
662 logger.info { "repo permission: " + repo_perm[:uuid] }
666 # create login permission for the given vm_uuid, if it does not already exist
667 def create_vm_login_permission_link(vm_uuid, repo_name)
668 # vm uuid is optional
669 return if vm_uuid == ""
671 vm = VirtualMachine.where(uuid: vm_uuid).first
673 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
674 raise "No vm found for #{vm_uuid}"
677 logger.info { "vm uuid: " + vm[:uuid] }
679 tail_uuid: uuid, head_uuid: vm.uuid,
680 link_class: "permission", name: "can_login",
685 select { |link| link.properties["username"] == repo_name }.
689 create(login_attrs.merge(properties: {"username" => repo_name}))
691 logger.info { "login permission: " + login_perm[:uuid] }
695 # add the user to the 'All users' group
696 def create_user_group_link
697 return (Link.where(tail_uuid: self.uuid,
698 head_uuid: all_users_group[:uuid],
699 link_class: 'permission',
700 name: 'can_read').first or
701 Link.create(tail_uuid: self.uuid,
702 head_uuid: all_users_group[:uuid],
703 link_class: 'permission',
707 # Give the special "System group" permission to manage this user and
708 # all of this user's stuff.
709 def add_system_group_permission_link
710 return true if uuid == system_user_uuid
711 act_as_system_user do
712 Link.create(link_class: 'permission',
714 tail_uuid: system_group_uuid,
715 head_uuid: self.uuid)
719 # Send admin notifications
720 def send_admin_notifications
721 AdminNotifier.new_user(self).deliver_now
722 if not self.is_active then
723 AdminNotifier.new_inactive_user(self).deliver_now
727 # Automatically setup if is_active flag turns on
728 def setup_on_activate
729 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
730 if is_active && (new_record? || is_active_changed?)
735 # Automatically setup new user during creation
736 def auto_setup_new_user
739 create_vm_login_permission_link(Rails.configuration.Users.AutoSetupNewUsersWithVmUUID,
741 repo_name = "#{username}/#{username}"
742 if Rails.configuration.Users.AutoSetupNewUsersWithRepository and
743 Repository.where(name: repo_name).first.nil?
744 repo = Repository.create!(name: repo_name, owner_uuid: uuid)
745 Link.create!(tail_uuid: uuid, head_uuid: repo.uuid,
746 link_class: "permission", name: "can_manage")
751 # Send notification if the user saved profile for the first time
752 def send_profile_created_notification
753 if self.prefs_changed?
754 if self.prefs_was.andand.empty? || !self.prefs_was.andand['profile']
755 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
756 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
761 def verify_repositories_empty
762 unless repositories.first.nil?
763 errors.add(:username, "can't be unset when the user owns repositories")
768 def sync_repository_names
769 old_name_re = /^#{Regexp.escape(username_was)}\//
770 name_sub = "#{username}/"
771 repositories.find_each do |repo|
772 repo.name = repo.name.sub(old_name_re, name_sub)