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 user_uuids_subquery = %{
125 select target_uuid from materialized_permissions where user_uuid = $1
126 and target_uuid like '_____-tpzed-_______________' and traverse_owned=true and perm_level >= #{VAL_FOR_PERM[action]}
129 unless ActiveRecord::Base.connection.
131 SELECT 1 FROM #{PERMISSION_VIEW}
132 WHERE user_uuid in (#{user_uuids_subquery}) and
133 ((target_uuid = $2 and perm_level >= $3)
134 or (target_uuid = $4 and perm_level >= $3 and traverse_owned))
136 # "name" arg is a query label that appears in logs:
140 [nil, VAL_FOR_PERM[action]],
141 [nil, target_owner_uuid]]
149 def before_ownership_change
150 if owner_uuid_changed? and !self.owner_uuid_was.nil?
151 MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
152 update_permissions self.owner_uuid_was, self.uuid, 0
156 def after_ownership_change
157 if owner_uuid_changed?
158 update_permissions self.owner_uuid, self.uuid, 3
162 def clear_permissions
163 update_permissions self.owner_uuid, self.uuid, 0
164 MaterializedPermission.where("user_uuid = ? or target_uuid = ?", uuid, uuid).delete_all
167 def check_permissions
168 check_permissions_against_full_refresh
171 # Return a hash of {user_uuid: group_perms}
172 def self.all_group_permissions
174 ActiveRecord::Base.connection.
175 exec_query("SELECT user_uuid, target_uuid, perm_level
176 FROM #{PERMISSION_VIEW}
177 WHERE traverse_owned",
178 # "name" arg is a query label that appears in logs:
179 "all_group_permissions").
180 rows.each do |user_uuid, group_uuid, max_p_val|
181 all_perms[user_uuid] ||= {}
182 all_perms[user_uuid][group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
187 # Return a hash of {group_uuid: perm_hash} where perm_hash[:read]
188 # and perm_hash[:write] are true if this user can read and write
189 # objects owned by group_uuid.
190 def group_permissions(level=1)
192 ActiveRecord::Base.connection.
194 SELECT target_uuid, perm_level
195 FROM #{PERMISSION_VIEW}
196 WHERE user_uuid = $1 and perm_level >= $2
198 # "name" arg is a query label that appears in logs:
199 "group_permissions_for_user",
200 # "binds" arg is an array of [col_id, value] for '$1' vars:
203 rows.each do |group_uuid, max_p_val|
204 group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
210 def setup(repo_name: nil, vm_uuid: nil)
211 repo_perm = create_user_repo_link repo_name
212 vm_login_perm = create_vm_login_permission_link(vm_uuid, username) if vm_uuid
213 group_perm = create_user_group_link
215 return [repo_perm, vm_login_perm, group_perm, self].compact
218 # delete user signatures, login, repo, and vm perms, and mark as inactive
220 # delete oid_login_perms for this user
222 # note: these permission links are obsolete, they have no effect
223 # on anything and they are not created for new users.
224 Link.where(tail_uuid: self.email,
225 link_class: 'permission',
226 name: 'can_login').destroy_all
228 # delete repo_perms for this user
229 Link.where(tail_uuid: self.uuid,
230 link_class: 'permission',
231 name: 'can_manage').destroy_all
233 # delete vm_login_perms for this user
234 Link.where(tail_uuid: self.uuid,
235 link_class: 'permission',
236 name: 'can_login').destroy_all
238 # delete "All users" group read permissions for this user
239 group = Group.where(name: 'All users').select do |g|
240 g[:uuid].match(/-f+$/)
242 Link.where(tail_uuid: self.uuid,
243 head_uuid: group[:uuid],
244 link_class: 'permission',
245 name: 'can_read').destroy_all
247 # delete any signatures by this user
248 Link.where(link_class: 'signature',
249 tail_uuid: self.uuid).destroy_all
251 # delete user preferences (including profile)
254 # mark the user as inactive
255 self.is_active = false
259 def must_unsetup_to_deactivate
260 if !self.new_record? &&
261 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
262 self.uuid[0..4] != Rails.configuration.ClusterID
263 # OK to update our local record to whatever the LoginCluster
264 # reports, because self-activate is not allowed.
266 elsif self.is_active_changed? &&
267 self.is_active_was &&
270 group = Group.where(name: 'All users').select do |g|
271 g[:uuid].match(/-f+$/)
274 # When a user is set up, they are added to the "All users"
275 # group. A user that is part of the "All users" group is
276 # allowed to self-activate.
278 # It doesn't make sense to deactivate a user (set is_active =
279 # false) without first removing them from the "All users" group,
280 # because they would be able to immediately reactivate
283 # The 'unsetup' method removes the user from the "All users"
284 # group (and also sets is_active = false) so send a message
285 # explaining the correct way to deactivate a user.
287 if Link.where(tail_uuid: self.uuid,
288 head_uuid: group[:uuid],
289 link_class: 'permission',
290 name: 'can_read').any?
291 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
296 def set_initial_username(requested: false)
297 if !requested.is_a?(String) || requested.empty?
298 email_parts = email.partition("@")
299 local_parts = email_parts.first.partition("+")
300 if email_parts.any?(&:empty?)
302 elsif not local_parts.first.empty?
303 requested = local_parts.first
305 requested = email_parts.first
308 requested.sub!(/^[^A-Za-z]+/, "")
309 requested.gsub!(/[^A-Za-z0-9]/, "")
310 unless requested.empty?
311 self.username = find_usable_username_from(requested)
315 def update_uuid(new_uuid:)
316 if !current_user.andand.is_admin
317 raise PermissionDeniedError
319 if uuid == system_user_uuid || uuid == anonymous_user_uuid
320 raise "update_uuid cannot update system accounts"
322 if self.class != self.class.resource_class_for_uuid(new_uuid)
323 raise "invalid new_uuid #{new_uuid.inspect}"
325 transaction(requires_new: true) do
329 save!(validate: false)
330 change_all_uuid_refs(old_uuid: old_uuid, new_uuid: new_uuid)
331 ActiveRecord::Base.connection.exec_update %{
332 update #{PERMISSION_VIEW} set user_uuid=$1 where user_uuid = $2
334 'User.update_uuid.update_permissions_user_uuid',
337 ActiveRecord::Base.connection.exec_update %{
338 update #{PERMISSION_VIEW} set target_uuid=$1 where target_uuid = $2
340 'User.update_uuid.update_permissions_target_uuid',
346 # Move this user's (i.e., self's) owned items to new_owner_uuid and
347 # new_user_uuid (for things normally owned directly by the user).
349 # If redirect_auth is true, also reassign auth tokens and ssh keys,
350 # and redirect this account to redirect_to_user_uuid, i.e., when a
351 # caller authenticates to this account in the future, the account
352 # redirect_to_user_uuid account will be used instead.
354 # current_user must have admin privileges, i.e., the caller is
355 # responsible for checking permission to do this.
356 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
357 raise PermissionDeniedError if !current_user.andand.is_admin
358 raise "Missing new_owner_uuid" if !new_owner_uuid
359 raise "Missing new_user_uuid" if !new_user_uuid
360 transaction(requires_new: true) do
362 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
364 new_user = User.where(uuid: new_user_uuid).first
365 raise "user does not exist" if !new_user
366 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
368 self.clear_permissions
370 # If 'self' is a remote user, don't transfer authorizations
371 # (i.e. ability to access the account) to the new user, because
372 # that gives the remote site the ability to access the 'new'
373 # user account that takes over the 'self' account.
375 # If 'self' is a local user, it is okay to transfer
376 # authorizations, even if the 'new' user is a remote account,
377 # because the remote site does not gain the ability to access an
378 # account it could not before.
380 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
381 # Existing API tokens and ssh keys are updated to authenticate
383 ApiClientAuthorization.
385 update_all(user_id: new_user.id)
388 [AuthorizedKey, :owner_uuid],
389 [AuthorizedKey, :authorized_user_uuid],
395 # Destroy API tokens and ssh keys associated with the old
397 ApiClientAuthorization.where(user_id: id).destroy_all
398 AuthorizedKey.where(owner_uuid: uuid).destroy_all
399 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
406 # References to the old user UUID in the context of a user ID
407 # (rather than a "home project" in the project hierarchy) are
408 # updated to point to the new user.
409 user_updates.each do |klass, column|
410 klass.where(column => uuid).update_all(column => new_user.uuid)
413 # Need to update repository names to new username
415 old_repo_name_re = /^#{Regexp.escape(username)}\//
416 Repository.where(:owner_uuid => uuid).each do |repo|
417 repo.owner_uuid = new_user.uuid
418 repo_name_sub = "#{new_user.username}/"
419 name = repo.name.sub(old_repo_name_re, repo_name_sub)
420 while (conflict = Repository.where(:name => name).first) != nil
421 repo_name_sub += "migrated"
422 name = repo.name.sub(old_repo_name_re, repo_name_sub)
429 # References to the merged user's "home project" are updated to
430 # point to new_owner_uuid.
431 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
432 next if [ApiClientAuthorization,
436 Repository].include?(klass)
437 next if !klass.columns.collect(&:name).include?('owner_uuid')
438 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
441 if redirect_to_new_user
442 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
444 skip_check_permissions_against_full_refresh do
445 update_permissions self.owner_uuid, self.uuid, 3
446 update_permissions self.uuid, self.uuid, 3
447 update_permissions new_user.owner_uuid, new_user.uuid, 3
449 update_permissions new_user.uuid, new_user.uuid, 3
456 while (uuid = user.redirect_to_user_uuid)
458 nextuser = User.unscoped.find_by_uuid(uuid)
460 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
465 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
471 def self.register info
472 # login info expected fields, all can be optional but at minimum
473 # must supply either 'identity_url' or 'email'
485 identity_url = info['identity_url']
487 if identity_url && identity_url.length > 0
488 # Only local users can create sessions, hence uuid_like_pattern
490 user = User.unscoped.where('identity_url = ? and uuid like ?',
492 User.uuid_like_pattern).first
493 primary_user = user.redirects_to if user
497 # identity url is unset or didn't find matching record.
498 emails = [info['email']] + (info['alternate_emails'] || [])
499 emails.select! {|em| !em.nil? && !em.empty?}
501 User.unscoped.where('email in (?) and uuid like ?',
503 User.uuid_like_pattern).each do |user|
505 primary_user = user.redirects_to
506 elsif primary_user.uuid != user.redirects_to.uuid
507 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
513 # New user registration
514 primary_user = User.new(:owner_uuid => system_user_uuid,
516 :is_active => Rails.configuration.Users.NewUsersAreActive)
518 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
519 primary_user.identity_url = info['identity_url'] if identity_url
522 primary_user.email = info['email'] if info['email']
523 primary_user.first_name = info['first_name'] if info['first_name']
524 primary_user.last_name = info['last_name'] if info['last_name']
526 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
527 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
530 act_as_system_user do
539 def change_all_uuid_refs(old_uuid:, new_uuid:)
540 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
541 klass.columns.each do |col|
542 if col.name.end_with?('_uuid')
543 column = col.name.to_sym
544 klass.where(column => old_uuid).update_all(column => new_uuid)
550 def ensure_ownership_path_leads_to_user
554 def permission_to_update
555 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
556 current_user.andand.is_admin
558 # users must be able to update themselves (even if they are
559 # inactive) in order to create sessions
560 self == current_user or super
564 def permission_to_create
565 current_user.andand.is_admin or
566 (self == current_user &&
567 self.redirect_to_user_uuid.nil? &&
568 self.is_active == Rails.configuration.Users.NewUsersAreActive)
572 return if self.uuid.end_with?('anonymouspublic')
573 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
574 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
575 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
576 Rails.configuration.Users.AutoAdminFirstUser)
578 self.is_active = true
582 def find_usable_username_from(basename)
583 # If "basename" is a usable username, return that.
584 # Otherwise, find a unique username "basenameN", where N is the
585 # smallest integer greater than 1, and return that.
586 # Return nil if a unique username can't be found after reasonable
588 quoted_name = self.class.connection.quote_string(basename)
589 next_username = basename
591 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
593 next_username = "%s%i" % [basename, next_suffix]
595 0.upto(6).each do |suffix_len|
596 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
598 where("username like '#{pattern}'").
600 order('username asc').
602 if other_user.username > next_username
604 elsif other_user.username == next_username
606 next_username = "%s%i" % [basename, next_suffix]
609 return next_username if (next_username.size <= pattern.size)
614 def prevent_privilege_escalation
615 if current_user.andand.is_admin
618 if self.is_active_changed?
619 if self.is_active != self.is_active_was
620 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
621 self.is_active = self.is_active_was
624 if self.is_admin_changed?
625 if self.is_admin != self.is_admin_was
626 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
627 self.is_admin = self.is_admin_was
633 def prevent_inactive_admin
634 if self.is_admin and not self.is_active
635 # There is no known use case for the strange set of permissions
636 # that would result from this change. It's safest to assume it's
637 # a mistake and disallow it outright.
638 raise "Admin users cannot be inactive"
643 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
644 nextpaths = graph[start]
645 return merged if !nextpaths
646 return merged if upstream_path.has_key? start
647 upstream_path[start] = true
648 upstream_mask ||= ALL_PERMISSIONS
649 nextpaths.each do |head, mask|
652 merged[head][k] ||= v if upstream_mask[k]
654 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
656 upstream_path.delete start
660 def create_user_repo_link(repo_name)
661 # repo_name is optional
663 logger.warn ("Repository name not given for #{self.uuid}.")
667 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
668 logger.info { "repo uuid: " + repo[:uuid] }
669 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
670 link_class: "permission",
671 name: "can_manage").first_or_create!
672 logger.info { "repo permission: " + repo_perm[:uuid] }
676 # create login permission for the given vm_uuid, if it does not already exist
677 def create_vm_login_permission_link(vm_uuid, repo_name)
678 # vm uuid is optional
679 return if vm_uuid == ""
681 vm = VirtualMachine.where(uuid: vm_uuid).first
683 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
684 raise "No vm found for #{vm_uuid}"
687 logger.info { "vm uuid: " + vm[:uuid] }
689 tail_uuid: uuid, head_uuid: vm.uuid,
690 link_class: "permission", name: "can_login",
695 select { |link| link.properties["username"] == repo_name }.
699 create(login_attrs.merge(properties: {"username" => repo_name}))
701 logger.info { "login permission: " + login_perm[:uuid] }
705 # add the user to the 'All users' group
706 def create_user_group_link
707 return (Link.where(tail_uuid: self.uuid,
708 head_uuid: all_users_group[:uuid],
709 link_class: 'permission',
710 name: 'can_read').first or
711 Link.create(tail_uuid: self.uuid,
712 head_uuid: all_users_group[:uuid],
713 link_class: 'permission',
717 # Give the special "System group" permission to manage this user and
718 # all of this user's stuff.
719 def add_system_group_permission_link
720 return true if uuid == system_user_uuid
721 act_as_system_user do
722 Link.create(link_class: 'permission',
724 tail_uuid: system_group_uuid,
725 head_uuid: self.uuid)
729 # Send admin notifications
730 def send_admin_notifications
731 AdminNotifier.new_user(self).deliver_now
732 if not self.is_active then
733 AdminNotifier.new_inactive_user(self).deliver_now
737 # Automatically setup if is_active flag turns on
738 def setup_on_activate
739 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
740 if is_active && (new_record? || is_active_changed?)
745 # Automatically setup new user during creation
746 def auto_setup_new_user
749 create_vm_login_permission_link(Rails.configuration.Users.AutoSetupNewUsersWithVmUUID,
751 repo_name = "#{username}/#{username}"
752 if Rails.configuration.Users.AutoSetupNewUsersWithRepository and
753 Repository.where(name: repo_name).first.nil?
754 repo = Repository.create!(name: repo_name, owner_uuid: uuid)
755 Link.create!(tail_uuid: uuid, head_uuid: repo.uuid,
756 link_class: "permission", name: "can_manage")
761 # Send notification if the user saved profile for the first time
762 def send_profile_created_notification
763 if self.prefs_changed?
764 if self.prefs_was.andand.empty? || !self.prefs_was.andand['profile']
765 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
766 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
771 def verify_repositories_empty
772 unless repositories.first.nil?
773 errors.add(:username, "can't be unset when the user owns repositories")
778 def sync_repository_names
779 old_name_re = /^#{Regexp.escape(username_was)}\//
780 name_sub = "#{username}/"
781 repositories.find_each do |repo|
782 repo.name = repo.name.sub(old_name_re, name_sub)