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 = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: VAL_FOR_PERM[action]}
126 unless ActiveRecord::Base.connection.
128 SELECT 1 FROM #{PERMISSION_VIEW}
129 WHERE user_uuid in (#{user_uuids_subquery}) and
130 ((target_uuid = $2 and perm_level >= $3)
131 or (target_uuid = $4 and perm_level >= $3 and traverse_owned))
133 # "name" arg is a query label that appears in logs:
137 [nil, VAL_FOR_PERM[action]],
138 [nil, target_owner_uuid]]
146 def before_ownership_change
147 if owner_uuid_changed? and !self.owner_uuid_was.nil?
148 MaterializedPermission.where(user_uuid: owner_uuid_was, target_uuid: uuid).delete_all
149 update_permissions self.owner_uuid_was, self.uuid, 0
153 def after_ownership_change
154 if owner_uuid_changed?
155 update_permissions self.owner_uuid, self.uuid, 3
159 def clear_permissions
160 update_permissions self.owner_uuid, self.uuid, 0
161 MaterializedPermission.where("user_uuid = ? or target_uuid = ?", uuid, uuid).delete_all
164 def check_permissions
165 check_permissions_against_full_refresh
168 # Return a hash of {user_uuid: group_perms}
170 # note: this does not account for permissions that a user gains by
171 # having can_manage on another user.
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)
193 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: VAL_FOR_PERM[action]}
195 ActiveRecord::Base.connection.
197 SELECT target_uuid, perm_level
198 FROM #{PERMISSION_VIEW}
199 WHERE user_uuid = user_uuid in (#{user_uuids_subquery}) and perm_level >= $2
201 # "name" arg is a query label that appears in logs:
202 "User.group_permissions",
203 # "binds" arg is an array of [col_id, value] for '$1' vars:
206 rows.each do |group_uuid, max_p_val|
207 group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
213 def setup(repo_name: nil, vm_uuid: nil)
214 repo_perm = create_user_repo_link repo_name
215 vm_login_perm = create_vm_login_permission_link(vm_uuid, username) if vm_uuid
216 group_perm = create_user_group_link
218 return [repo_perm, vm_login_perm, group_perm, self].compact
221 # delete user signatures, login, repo, and vm perms, and mark as inactive
223 # delete oid_login_perms for this user
225 # note: these permission links are obsolete, they have no effect
226 # on anything and they are not created for new users.
227 Link.where(tail_uuid: self.email,
228 link_class: 'permission',
229 name: 'can_login').destroy_all
231 # delete repo_perms for this user
232 Link.where(tail_uuid: self.uuid,
233 link_class: 'permission',
234 name: 'can_manage').destroy_all
236 # delete vm_login_perms for this user
237 Link.where(tail_uuid: self.uuid,
238 link_class: 'permission',
239 name: 'can_login').destroy_all
241 # delete "All users" group read permissions for this user
242 group = Group.where(name: 'All users').select do |g|
243 g[:uuid].match(/-f+$/)
245 Link.where(tail_uuid: self.uuid,
246 head_uuid: group[:uuid],
247 link_class: 'permission',
248 name: 'can_read').destroy_all
250 # delete any signatures by this user
251 Link.where(link_class: 'signature',
252 tail_uuid: self.uuid).destroy_all
254 # delete user preferences (including profile)
257 # mark the user as inactive
258 self.is_active = false
262 def must_unsetup_to_deactivate
263 if !self.new_record? &&
264 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
265 self.uuid[0..4] != Rails.configuration.ClusterID
266 # OK to update our local record to whatever the LoginCluster
267 # reports, because self-activate is not allowed.
269 elsif self.is_active_changed? &&
270 self.is_active_was &&
273 group = Group.where(name: 'All users').select do |g|
274 g[:uuid].match(/-f+$/)
277 # When a user is set up, they are added to the "All users"
278 # group. A user that is part of the "All users" group is
279 # allowed to self-activate.
281 # It doesn't make sense to deactivate a user (set is_active =
282 # false) without first removing them from the "All users" group,
283 # because they would be able to immediately reactivate
286 # The 'unsetup' method removes the user from the "All users"
287 # group (and also sets is_active = false) so send a message
288 # explaining the correct way to deactivate a user.
290 if Link.where(tail_uuid: self.uuid,
291 head_uuid: group[:uuid],
292 link_class: 'permission',
293 name: 'can_read').any?
294 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
299 def set_initial_username(requested: false)
300 if !requested.is_a?(String) || requested.empty?
301 email_parts = email.partition("@")
302 local_parts = email_parts.first.partition("+")
303 if email_parts.any?(&:empty?)
305 elsif not local_parts.first.empty?
306 requested = local_parts.first
308 requested = email_parts.first
311 requested.sub!(/^[^A-Za-z]+/, "")
312 requested.gsub!(/[^A-Za-z0-9]/, "")
313 unless requested.empty?
314 self.username = find_usable_username_from(requested)
318 def update_uuid(new_uuid:)
319 if !current_user.andand.is_admin
320 raise PermissionDeniedError
322 if uuid == system_user_uuid || uuid == anonymous_user_uuid
323 raise "update_uuid cannot update system accounts"
325 if self.class != self.class.resource_class_for_uuid(new_uuid)
326 raise "invalid new_uuid #{new_uuid.inspect}"
328 transaction(requires_new: true) do
332 save!(validate: false)
333 change_all_uuid_refs(old_uuid: old_uuid, new_uuid: new_uuid)
334 ActiveRecord::Base.connection.exec_update %{
335 update #{PERMISSION_VIEW} set user_uuid=$1 where user_uuid = $2
337 'User.update_uuid.update_permissions_user_uuid',
340 ActiveRecord::Base.connection.exec_update %{
341 update #{PERMISSION_VIEW} set target_uuid=$1 where target_uuid = $2
343 'User.update_uuid.update_permissions_target_uuid',
349 # Move this user's (i.e., self's) owned items to new_owner_uuid and
350 # new_user_uuid (for things normally owned directly by the user).
352 # If redirect_auth is true, also reassign auth tokens and ssh keys,
353 # and redirect this account to redirect_to_user_uuid, i.e., when a
354 # caller authenticates to this account in the future, the account
355 # redirect_to_user_uuid account will be used instead.
357 # current_user must have admin privileges, i.e., the caller is
358 # responsible for checking permission to do this.
359 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
360 raise PermissionDeniedError if !current_user.andand.is_admin
361 raise "Missing new_owner_uuid" if !new_owner_uuid
362 raise "Missing new_user_uuid" if !new_user_uuid
363 transaction(requires_new: true) do
365 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
367 new_user = User.where(uuid: new_user_uuid).first
368 raise "user does not exist" if !new_user
369 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
371 self.clear_permissions
373 # If 'self' is a remote user, don't transfer authorizations
374 # (i.e. ability to access the account) to the new user, because
375 # that gives the remote site the ability to access the 'new'
376 # user account that takes over the 'self' account.
378 # If 'self' is a local user, it is okay to transfer
379 # authorizations, even if the 'new' user is a remote account,
380 # because the remote site does not gain the ability to access an
381 # account it could not before.
383 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
384 # Existing API tokens and ssh keys are updated to authenticate
386 ApiClientAuthorization.
388 update_all(user_id: new_user.id)
391 [AuthorizedKey, :owner_uuid],
392 [AuthorizedKey, :authorized_user_uuid],
398 # Destroy API tokens and ssh keys associated with the old
400 ApiClientAuthorization.where(user_id: id).destroy_all
401 AuthorizedKey.where(owner_uuid: uuid).destroy_all
402 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
409 # References to the old user UUID in the context of a user ID
410 # (rather than a "home project" in the project hierarchy) are
411 # updated to point to the new user.
412 user_updates.each do |klass, column|
413 klass.where(column => uuid).update_all(column => new_user.uuid)
416 # Need to update repository names to new username
418 old_repo_name_re = /^#{Regexp.escape(username)}\//
419 Repository.where(:owner_uuid => uuid).each do |repo|
420 repo.owner_uuid = new_user.uuid
421 repo_name_sub = "#{new_user.username}/"
422 name = repo.name.sub(old_repo_name_re, repo_name_sub)
423 while (conflict = Repository.where(:name => name).first) != nil
424 repo_name_sub += "migrated"
425 name = repo.name.sub(old_repo_name_re, repo_name_sub)
432 # References to the merged user's "home project" are updated to
433 # point to new_owner_uuid.
434 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
435 next if [ApiClientAuthorization,
439 Repository].include?(klass)
440 next if !klass.columns.collect(&:name).include?('owner_uuid')
441 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
444 if redirect_to_new_user
445 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
447 skip_check_permissions_against_full_refresh do
448 update_permissions self.owner_uuid, self.uuid, 3
449 update_permissions self.uuid, self.uuid, 3
450 update_permissions new_user.owner_uuid, new_user.uuid, 3
452 update_permissions new_user.uuid, new_user.uuid, 3
459 while (uuid = user.redirect_to_user_uuid)
461 nextuser = User.unscoped.find_by_uuid(uuid)
463 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
468 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
474 def self.register info
475 # login info expected fields, all can be optional but at minimum
476 # must supply either 'identity_url' or 'email'
488 identity_url = info['identity_url']
490 if identity_url && identity_url.length > 0
491 # Only local users can create sessions, hence uuid_like_pattern
493 user = User.unscoped.where('identity_url = ? and uuid like ?',
495 User.uuid_like_pattern).first
496 primary_user = user.redirects_to if user
500 # identity url is unset or didn't find matching record.
501 emails = [info['email']] + (info['alternate_emails'] || [])
502 emails.select! {|em| !em.nil? && !em.empty?}
504 User.unscoped.where('email in (?) and uuid like ?',
506 User.uuid_like_pattern).each do |user|
508 primary_user = user.redirects_to
509 elsif primary_user.uuid != user.redirects_to.uuid
510 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
516 # New user registration
517 primary_user = User.new(:owner_uuid => system_user_uuid,
519 :is_active => Rails.configuration.Users.NewUsersAreActive)
521 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
522 primary_user.identity_url = info['identity_url'] if identity_url
525 primary_user.email = info['email'] if info['email']
526 primary_user.first_name = info['first_name'] if info['first_name']
527 primary_user.last_name = info['last_name'] if info['last_name']
529 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
530 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
533 act_as_system_user do
542 def change_all_uuid_refs(old_uuid:, new_uuid:)
543 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
544 klass.columns.each do |col|
545 if col.name.end_with?('_uuid')
546 column = col.name.to_sym
547 klass.where(column => old_uuid).update_all(column => new_uuid)
553 def ensure_ownership_path_leads_to_user
557 def permission_to_update
558 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
559 current_user.andand.is_admin
561 # users must be able to update themselves (even if they are
562 # inactive) in order to create sessions
563 self == current_user or super
567 def permission_to_create
568 current_user.andand.is_admin or
569 (self == current_user &&
570 self.redirect_to_user_uuid.nil? &&
571 self.is_active == Rails.configuration.Users.NewUsersAreActive)
575 return if self.uuid.end_with?('anonymouspublic')
576 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
577 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
578 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
579 Rails.configuration.Users.AutoAdminFirstUser)
581 self.is_active = true
585 def find_usable_username_from(basename)
586 # If "basename" is a usable username, return that.
587 # Otherwise, find a unique username "basenameN", where N is the
588 # smallest integer greater than 1, and return that.
589 # Return nil if a unique username can't be found after reasonable
591 quoted_name = self.class.connection.quote_string(basename)
592 next_username = basename
594 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
596 next_username = "%s%i" % [basename, next_suffix]
598 0.upto(6).each do |suffix_len|
599 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
601 where("username like '#{pattern}'").
603 order('username asc').
605 if other_user.username > next_username
607 elsif other_user.username == next_username
609 next_username = "%s%i" % [basename, next_suffix]
612 return next_username if (next_username.size <= pattern.size)
617 def prevent_privilege_escalation
618 if current_user.andand.is_admin
621 if self.is_active_changed?
622 if self.is_active != self.is_active_was
623 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
624 self.is_active = self.is_active_was
627 if self.is_admin_changed?
628 if self.is_admin != self.is_admin_was
629 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
630 self.is_admin = self.is_admin_was
636 def prevent_inactive_admin
637 if self.is_admin and not self.is_active
638 # There is no known use case for the strange set of permissions
639 # that would result from this change. It's safest to assume it's
640 # a mistake and disallow it outright.
641 raise "Admin users cannot be inactive"
646 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
647 nextpaths = graph[start]
648 return merged if !nextpaths
649 return merged if upstream_path.has_key? start
650 upstream_path[start] = true
651 upstream_mask ||= ALL_PERMISSIONS
652 nextpaths.each do |head, mask|
655 merged[head][k] ||= v if upstream_mask[k]
657 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
659 upstream_path.delete start
663 def create_user_repo_link(repo_name)
664 # repo_name is optional
666 logger.warn ("Repository name not given for #{self.uuid}.")
670 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
671 logger.info { "repo uuid: " + repo[:uuid] }
672 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
673 link_class: "permission",
674 name: "can_manage").first_or_create!
675 logger.info { "repo permission: " + repo_perm[:uuid] }
679 # create login permission for the given vm_uuid, if it does not already exist
680 def create_vm_login_permission_link(vm_uuid, repo_name)
681 # vm uuid is optional
682 return if vm_uuid == ""
684 vm = VirtualMachine.where(uuid: vm_uuid).first
686 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
687 raise "No vm found for #{vm_uuid}"
690 logger.info { "vm uuid: " + vm[:uuid] }
692 tail_uuid: uuid, head_uuid: vm.uuid,
693 link_class: "permission", name: "can_login",
698 select { |link| link.properties["username"] == repo_name }.
702 create(login_attrs.merge(properties: {"username" => repo_name}))
704 logger.info { "login permission: " + login_perm[:uuid] }
708 # add the user to the 'All users' group
709 def create_user_group_link
710 return (Link.where(tail_uuid: self.uuid,
711 head_uuid: all_users_group[:uuid],
712 link_class: 'permission',
713 name: 'can_read').first or
714 Link.create(tail_uuid: self.uuid,
715 head_uuid: all_users_group[:uuid],
716 link_class: 'permission',
720 # Give the special "System group" permission to manage this user and
721 # all of this user's stuff.
722 def add_system_group_permission_link
723 return true if uuid == system_user_uuid
724 act_as_system_user do
725 Link.create(link_class: 'permission',
727 tail_uuid: system_group_uuid,
728 head_uuid: self.uuid)
732 # Send admin notifications
733 def send_admin_notifications
734 AdminNotifier.new_user(self).deliver_now
735 if not self.is_active then
736 AdminNotifier.new_inactive_user(self).deliver_now
740 # Automatically setup if is_active flag turns on
741 def setup_on_activate
742 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
743 if is_active && (new_record? || is_active_changed?)
748 # Automatically setup new user during creation
749 def auto_setup_new_user
752 create_vm_login_permission_link(Rails.configuration.Users.AutoSetupNewUsersWithVmUUID,
754 repo_name = "#{username}/#{username}"
755 if Rails.configuration.Users.AutoSetupNewUsersWithRepository and
756 Repository.where(name: repo_name).first.nil?
757 repo = Repository.create!(name: repo_name, owner_uuid: uuid)
758 Link.create!(tail_uuid: uuid, head_uuid: repo.uuid,
759 link_class: "permission", name: "can_manage")
764 # Send notification if the user saved profile for the first time
765 def send_profile_created_notification
766 if self.prefs_changed?
767 if self.prefs_was.andand.empty? || !self.prefs_was.andand['profile']
768 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
769 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
774 def verify_repositories_empty
775 unless repositories.first.nil?
776 errors.add(:username, "can't be unset when the user owns repositories")
781 def sync_repository_names
782 old_name_re = /^#{Regexp.escape(username_was)}\//
783 name_sub = "#{username}/"
784 repositories.find_each do |repo|
785 repo.name = repo.name.sub(old_name_re, name_sub)