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 before_destroy :clear_permissions
54 after_destroy :check_permissions
56 has_many :authorized_keys, :foreign_key => :authorized_user_uuid, :primary_key => :uuid
57 has_many :repositories, foreign_key: :owner_uuid, primary_key: :uuid
59 default_scope { where('redirect_to_user_uuid is null') }
61 api_accessible :user, extend: :common do |t|
75 ALL_PERMISSIONS = {read: true, write: true, manage: true}
77 # Map numeric permission levels (see lib/create_permission_view.sql)
78 # back to read/write/manage flags.
82 {read: true, write: true},
83 {read: true, write: true, manage: true}]
92 "#{first_name} #{last_name}".strip
97 Rails.configuration.Users.NewUsersAreActive ||
98 self.groups_i_can(:read).select { |x| x.match(/-f+$/) }.first)
101 def groups_i_can(verb)
102 my_groups = self.group_permissions(VAL_FOR_PERM[verb]).keys
104 my_groups << anonymous_group_uuid
110 return true if is_admin
111 actions.each do |action, target|
113 if target.respond_to? :uuid
114 target_uuid = target.uuid
117 target = ArvadosModel.find_by_uuid(target_uuid)
120 next if target_uuid == self.uuid
122 target_owner_uuid = target.owner_uuid if target.respond_to? :owner_uuid
124 unless ActiveRecord::Base.connection.
126 SELECT 1 FROM #{PERMISSION_VIEW}
127 WHERE user_uuid = $1 and
128 ((target_uuid = $2 and perm_level >= $3)
129 or (target_uuid = $4 and perm_level >= $3 and traverse_owned))
131 # "name" arg is a query label that appears in logs:
135 [nil, VAL_FOR_PERM[action]],
136 [nil, target_owner_uuid]]
144 def before_ownership_change
145 if owner_uuid_changed? and !self.owner_uuid_was.nil?
146 MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
147 update_permissions self.owner_uuid_was, self.uuid, 0
151 def after_ownership_change
152 if owner_uuid_changed?
153 update_permissions self.owner_uuid, self.uuid, 3
157 def clear_permissions
158 update_permissions self.owner_uuid, self.uuid, 0
159 MaterializedPermission.where("user_uuid = ? or target_uuid = ?", uuid, uuid).delete_all
162 def check_permissions
163 check_permissions_against_full_refresh
166 # Return a hash of {user_uuid: group_perms}
167 def self.all_group_permissions
169 ActiveRecord::Base.connection.
170 exec_query("SELECT user_uuid, target_uuid, perm_level
171 FROM #{PERMISSION_VIEW}
172 WHERE traverse_owned",
173 # "name" arg is a query label that appears in logs:
174 "all_group_permissions").
175 rows.each do |user_uuid, group_uuid, max_p_val|
176 all_perms[user_uuid] ||= {}
177 all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
182 # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
183 # and perm_hash[:write] are true if this user can read and write
184 # objects owned by group_uuid.
185 def group_permissions(level=1)
187 ActiveRecord::Base.connection.
189 SELECT target_uuid, perm_level
190 FROM #{PERMISSION_VIEW}
191 WHERE user_uuid = $1 and perm_level >= $2
193 # "name" arg is a query label that appears in logs:
194 "group_permissions_for_user",
195 # "binds" arg is an array of [col_id, value] for '$1' vars:
198 rows.each do |group_uuid, max_p_val|
199 group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
205 def setup(repo_name: nil, vm_uuid: nil)
206 repo_perm = create_user_repo_link repo_name
207 vm_login_perm = create_vm_login_permission_link(vm_uuid, username) if vm_uuid
208 group_perm = create_user_group_link
210 return [repo_perm, vm_login_perm, group_perm, self].compact
213 # delete user signatures, login, repo, and vm perms, and mark as inactive
215 # delete oid_login_perms for this user
217 # note: these permission links are obsolete, they have no effect
218 # on anything and they are not created for new users.
219 Link.where(tail_uuid: self.email,
220 link_class: 'permission',
221 name: 'can_login').destroy_all
223 # delete repo_perms for this user
224 Link.where(tail_uuid: self.uuid,
225 link_class: 'permission',
226 name: 'can_manage').destroy_all
228 # delete vm_login_perms for this user
229 Link.where(tail_uuid: self.uuid,
230 link_class: 'permission',
231 name: 'can_login').destroy_all
233 # delete "All users" group read permissions for this user
234 group = Group.where(name: 'All users').select do |g|
235 g[:uuid].match(/-f+$/)
237 Link.where(tail_uuid: self.uuid,
238 head_uuid: group[:uuid],
239 link_class: 'permission',
240 name: 'can_read').destroy_all
242 # delete any signatures by this user
243 Link.where(link_class: 'signature',
244 tail_uuid: self.uuid).destroy_all
246 # delete user preferences (including profile)
249 # mark the user as inactive
250 self.is_active = false
254 def must_unsetup_to_deactivate
255 if self.is_active_changed? &&
256 self.is_active_was == true &&
259 group = Group.where(name: 'All users').select do |g|
260 g[:uuid].match(/-f+$/)
263 # When a user is set up, they are added to the "All users"
264 # group. A user that is part of the "All users" group is
265 # allowed to self-activate.
267 # It doesn't make sense to deactivate a user (set is_active =
268 # false) without first removing them from the "All users" group,
269 # because they would be able to immediately reactivate
272 # The 'unsetup' method removes the user from the "All users"
273 # group (and also sets is_active = false) so send a message
274 # explaining the correct way to deactivate a user.
276 if Link.where(tail_uuid: self.uuid,
277 head_uuid: group[:uuid],
278 link_class: 'permission',
279 name: 'can_read').any?
280 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
285 def set_initial_username(requested: false)
286 if !requested.is_a?(String) || requested.empty?
287 email_parts = email.partition("@")
288 local_parts = email_parts.first.partition("+")
289 if email_parts.any?(&:empty?)
291 elsif not local_parts.first.empty?
292 requested = local_parts.first
294 requested = email_parts.first
297 requested.sub!(/^[^A-Za-z]+/, "")
298 requested.gsub!(/[^A-Za-z0-9]/, "")
299 unless requested.empty?
300 self.username = find_usable_username_from(requested)
304 def update_uuid(new_uuid:)
305 if !current_user.andand.is_admin
306 raise PermissionDeniedError
308 if uuid == system_user_uuid || uuid == anonymous_user_uuid
309 raise "update_uuid cannot update system accounts"
311 if self.class != self.class.resource_class_for_uuid(new_uuid)
312 raise "invalid new_uuid #{new_uuid.inspect}"
314 transaction(requires_new: true) do
318 save!(validate: false)
319 change_all_uuid_refs(old_uuid: old_uuid, new_uuid: new_uuid)
320 ActiveRecord::Base.connection.exec_update %{
321 update #{PERMISSION_VIEW} set user_uuid=$1 where user_uuid = $2
323 'User.update_uuid.update_permissions_user_uuid',
326 ActiveRecord::Base.connection.exec_update %{
327 update #{PERMISSION_VIEW} set target_uuid=$1 where target_uuid = $2
329 'User.update_uuid.update_permissions_target_uuid',
335 # Move this user's (i.e., self's) owned items to new_owner_uuid and
336 # new_user_uuid (for things normally owned directly by the user).
338 # If redirect_auth is true, also reassign auth tokens and ssh keys,
339 # and redirect this account to redirect_to_user_uuid, i.e., when a
340 # caller authenticates to this account in the future, the account
341 # redirect_to_user_uuid account will be used instead.
343 # current_user must have admin privileges, i.e., the caller is
344 # responsible for checking permission to do this.
345 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
346 raise PermissionDeniedError if !current_user.andand.is_admin
347 raise "Missing new_owner_uuid" if !new_owner_uuid
348 raise "Missing new_user_uuid" if !new_user_uuid
349 transaction(requires_new: true) do
351 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
353 new_user = User.where(uuid: new_user_uuid).first
354 raise "user does not exist" if !new_user
355 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
357 self.clear_permissions
359 # If 'self' is a remote user, don't transfer authorizations
360 # (i.e. ability to access the account) to the new user, because
361 # that gives the remote site the ability to access the 'new'
362 # user account that takes over the 'self' account.
364 # If 'self' is a local user, it is okay to transfer
365 # authorizations, even if the 'new' user is a remote account,
366 # because the remote site does not gain the ability to access an
367 # account it could not before.
369 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
370 # Existing API tokens and ssh keys are updated to authenticate
372 ApiClientAuthorization.
374 update_all(user_id: new_user.id)
377 [AuthorizedKey, :owner_uuid],
378 [AuthorizedKey, :authorized_user_uuid],
384 # Destroy API tokens and ssh keys associated with the old
386 ApiClientAuthorization.where(user_id: id).destroy_all
387 AuthorizedKey.where(owner_uuid: uuid).destroy_all
388 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
395 # References to the old user UUID in the context of a user ID
396 # (rather than a "home project" in the project hierarchy) are
397 # updated to point to the new user.
398 user_updates.each do |klass, column|
399 klass.where(column => uuid).update_all(column => new_user.uuid)
402 # Need to update repository names to new username
404 old_repo_name_re = /^#{Regexp.escape(username)}\//
405 Repository.where(:owner_uuid => uuid).each do |repo|
406 repo.owner_uuid = new_user.uuid
407 repo_name_sub = "#{new_user.username}/"
408 name = repo.name.sub(old_repo_name_re, repo_name_sub)
409 while (conflict = Repository.where(:name => name).first) != nil
410 repo_name_sub += "migrated"
411 name = repo.name.sub(old_repo_name_re, repo_name_sub)
418 # References to the merged user's "home project" are updated to
419 # point to new_owner_uuid.
420 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
421 next if [ApiClientAuthorization,
425 Repository].include?(klass)
426 next if !klass.columns.collect(&:name).include?('owner_uuid')
427 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
430 if redirect_to_new_user
431 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
433 update_permissions self.owner_uuid, self.uuid, 3, false
434 update_permissions new_user.owner_uuid, new_user.uuid, 3
441 while (uuid = user.redirect_to_user_uuid)
443 nextuser = User.unscoped.find_by_uuid(uuid)
445 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
450 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
456 def self.register info
457 # login info expected fields, all can be optional but at minimum
458 # must supply either 'identity_url' or 'email'
470 identity_url = info['identity_url']
472 if identity_url && identity_url.length > 0
473 # Only local users can create sessions, hence uuid_like_pattern
475 user = User.unscoped.where('identity_url = ? and uuid like ?',
477 User.uuid_like_pattern).first
478 primary_user = user.redirects_to if user
482 # identity url is unset or didn't find matching record.
483 emails = [info['email']] + (info['alternate_emails'] || [])
484 emails.select! {|em| !em.nil? && !em.empty?}
486 User.unscoped.where('email in (?) and uuid like ?',
488 User.uuid_like_pattern).each do |user|
490 primary_user = user.redirects_to
491 elsif primary_user.uuid != user.redirects_to.uuid
492 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
498 # New user registration
499 primary_user = User.new(:owner_uuid => system_user_uuid,
501 :is_active => Rails.configuration.Users.NewUsersAreActive)
503 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
504 primary_user.identity_url = info['identity_url'] if identity_url
507 primary_user.email = info['email'] if info['email']
508 primary_user.first_name = info['first_name'] if info['first_name']
509 primary_user.last_name = info['last_name'] if info['last_name']
511 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
512 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
515 act_as_system_user do
524 def change_all_uuid_refs(old_uuid:, new_uuid:)
525 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
526 klass.columns.each do |col|
527 if col.name.end_with?('_uuid')
528 column = col.name.to_sym
529 klass.where(column => old_uuid).update_all(column => new_uuid)
535 def ensure_ownership_path_leads_to_user
539 def permission_to_update
540 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
541 current_user.andand.is_admin
543 # users must be able to update themselves (even if they are
544 # inactive) in order to create sessions
545 self == current_user or super
549 def permission_to_create
550 current_user.andand.is_admin or
551 (self == current_user &&
552 self.redirect_to_user_uuid.nil? &&
553 self.is_active == Rails.configuration.Users.NewUsersAreActive)
557 return if self.uuid.end_with?('anonymouspublic')
558 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
559 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
560 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
561 Rails.configuration.Users.AutoAdminFirstUser)
563 self.is_active = true
567 def find_usable_username_from(basename)
568 # If "basename" is a usable username, return that.
569 # Otherwise, find a unique username "basenameN", where N is the
570 # smallest integer greater than 1, and return that.
571 # Return nil if a unique username can't be found after reasonable
573 quoted_name = self.class.connection.quote_string(basename)
574 next_username = basename
576 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
578 next_username = "%s%i" % [basename, next_suffix]
580 0.upto(6).each do |suffix_len|
581 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
583 where("username like '#{pattern}'").
585 order('username asc').
587 if other_user.username > next_username
589 elsif other_user.username == next_username
591 next_username = "%s%i" % [basename, next_suffix]
594 return next_username if (next_username.size <= pattern.size)
599 def prevent_privilege_escalation
600 if current_user.andand.is_admin
603 if self.is_active_changed?
604 if self.is_active != self.is_active_was
605 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
606 self.is_active = self.is_active_was
609 if self.is_admin_changed?
610 if self.is_admin != self.is_admin_was
611 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
612 self.is_admin = self.is_admin_was
618 def prevent_inactive_admin
619 if self.is_admin and not self.is_active
620 # There is no known use case for the strange set of permissions
621 # that would result from this change. It's safest to assume it's
622 # a mistake and disallow it outright.
623 raise "Admin users cannot be inactive"
628 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
629 nextpaths = graph[start]
630 return merged if !nextpaths
631 return merged if upstream_path.has_key? start
632 upstream_path[start] = true
633 upstream_mask ||= ALL_PERMISSIONS
634 nextpaths.each do |head, mask|
637 merged[head][k] ||= v if upstream_mask[k]
639 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
641 upstream_path.delete start
645 def create_user_repo_link(repo_name)
646 # repo_name is optional
648 logger.warn ("Repository name not given for #{self.uuid}.")
652 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
653 logger.info { "repo uuid: " + repo[:uuid] }
654 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
655 link_class: "permission",
656 name: "can_manage").first_or_create!
657 logger.info { "repo permission: " + repo_perm[:uuid] }
661 # create login permission for the given vm_uuid, if it does not already exist
662 def create_vm_login_permission_link(vm_uuid, repo_name)
663 # vm uuid is optional
664 return if vm_uuid == ""
666 vm = VirtualMachine.where(uuid: vm_uuid).first
668 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
669 raise "No vm found for #{vm_uuid}"
672 logger.info { "vm uuid: " + vm[:uuid] }
674 tail_uuid: uuid, head_uuid: vm.uuid,
675 link_class: "permission", name: "can_login",
680 select { |link| link.properties["username"] == repo_name }.
684 create(login_attrs.merge(properties: {"username" => repo_name}))
686 logger.info { "login permission: " + login_perm[:uuid] }
690 # add the user to the 'All users' group
691 def create_user_group_link
692 return (Link.where(tail_uuid: self.uuid,
693 head_uuid: all_users_group[:uuid],
694 link_class: 'permission',
695 name: 'can_read').first or
696 Link.create(tail_uuid: self.uuid,
697 head_uuid: all_users_group[:uuid],
698 link_class: 'permission',
702 # Give the special "System group" permission to manage this user and
703 # all of this user's stuff.
704 def add_system_group_permission_link
705 return true if uuid == system_user_uuid
706 act_as_system_user do
707 Link.create(link_class: 'permission',
709 tail_uuid: system_group_uuid,
710 head_uuid: self.uuid)
714 # Send admin notifications
715 def send_admin_notifications
716 AdminNotifier.new_user(self).deliver_now
717 if not self.is_active then
718 AdminNotifier.new_inactive_user(self).deliver_now
722 # Automatically setup if is_active flag turns on
723 def setup_on_activate
724 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
725 if is_active && (new_record? || is_active_changed?)
730 # Automatically setup new user during creation
731 def auto_setup_new_user
734 create_vm_login_permission_link(Rails.configuration.Users.AutoSetupNewUsersWithVmUUID,
736 repo_name = "#{username}/#{username}"
737 if Rails.configuration.Users.AutoSetupNewUsersWithRepository and
738 Repository.where(name: repo_name).first.nil?
739 repo = Repository.create!(name: repo_name, owner_uuid: uuid)
740 Link.create!(tail_uuid: uuid, head_uuid: repo.uuid,
741 link_class: "permission", name: "can_manage")
746 # Send notification if the user saved profile for the first time
747 def send_profile_created_notification
748 if self.prefs_changed?
749 if self.prefs_was.andand.empty? || !self.prefs_was.andand['profile']
750 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
751 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
756 def verify_repositories_empty
757 unless repositories.first.nil?
758 errors.add(:username, "can't be unset when the user owns repositories")
763 def sync_repository_names
764 old_name_re = /^#{Regexp.escape(username_was)}\//
765 name_sub = "#{username}/"
766 repositories.find_each do |repo|
767 repo.name = repo.name.sub(old_name_re, name_sub)