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)
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 {
49 (uuid != system_user_uuid) and
50 saved_change_to_username? and
51 (not username_before_last_save.nil?)
53 before_destroy :clear_permissions
54 after_destroy :remove_self_from_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: "$3"}
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, REVOKE_PERM
153 def after_ownership_change
154 if saved_change_to_owner_uuid?
155 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
159 def clear_permissions
160 MaterializedPermission.where("user_uuid = ? and target_uuid != ?", uuid, uuid).delete_all
163 def remove_self_from_permissions
164 MaterializedPermission.where("target_uuid = ?", uuid).delete_all
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.
176 SELECT user_uuid, target_uuid, perm_level
177 FROM #{PERMISSION_VIEW}
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)
195 user_uuids_subquery = USER_UUIDS_SUBQUERY_TEMPLATE % {user: "$1", perm_level: "$2"}
197 ActiveRecord::Base.connection.
199 SELECT target_uuid, perm_level
200 FROM #{PERMISSION_VIEW}
201 WHERE user_uuid in (#{user_uuids_subquery}) and perm_level >= $2
203 # "name" arg is a query label that appears in logs:
204 "User.group_permissions",
205 # "binds" arg is an array of [col_id, value] for '$1' vars:
208 rows.each do |group_uuid, max_p_val|
209 group_perms[group_uuid] = PERMS_FOR_VAL[max_p_val.to_i]
215 def setup(repo_name: nil, vm_uuid: nil)
216 repo_perm = create_user_repo_link repo_name
217 vm_login_perm = create_vm_login_permission_link(vm_uuid, username) if vm_uuid
218 group_perm = create_user_group_link
220 return [repo_perm, vm_login_perm, group_perm, self].compact
223 # delete user signatures, login, repo, and vm perms, and mark as inactive
225 # delete oid_login_perms for this user
227 # note: these permission links are obsolete, they have no effect
228 # on anything and they are not created for new users.
229 Link.where(tail_uuid: self.email,
230 link_class: 'permission',
231 name: 'can_login').destroy_all
233 # delete repo_perms for this user
234 Link.where(tail_uuid: self.uuid,
235 link_class: 'permission',
236 name: 'can_manage').destroy_all
238 # delete vm_login_perms for this user
239 Link.where(tail_uuid: self.uuid,
240 link_class: 'permission',
241 name: 'can_login').destroy_all
243 # delete "All users" group read permissions for this user
244 group = Group.where(name: 'All users').select do |g|
245 g[:uuid].match(/-f+$/)
247 Link.where(tail_uuid: self.uuid,
248 head_uuid: group[:uuid],
249 link_class: 'permission',
250 name: 'can_read').destroy_all
252 # delete any signatures by this user
253 Link.where(link_class: 'signature',
254 tail_uuid: self.uuid).destroy_all
256 # delete user preferences (including profile)
259 # mark the user as inactive
260 self.is_active = false
264 def must_unsetup_to_deactivate
265 if !self.new_record? &&
266 self.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
267 self.uuid[0..4] != Rails.configuration.ClusterID
268 # OK to update our local record to whatever the LoginCluster
269 # reports, because self-activate is not allowed.
271 elsif self.is_active_changed? &&
272 self.is_active_was &&
275 group = Group.where(name: 'All users').select do |g|
276 g[:uuid].match(/-f+$/)
279 # When a user is set up, they are added to the "All users"
280 # group. A user that is part of the "All users" group is
281 # allowed to self-activate.
283 # It doesn't make sense to deactivate a user (set is_active =
284 # false) without first removing them from the "All users" group,
285 # because they would be able to immediately reactivate
288 # The 'unsetup' method removes the user from the "All users"
289 # group (and also sets is_active = false) so send a message
290 # explaining the correct way to deactivate a user.
292 if Link.where(tail_uuid: self.uuid,
293 head_uuid: group[:uuid],
294 link_class: 'permission',
295 name: 'can_read').any?
296 errors.add :is_active, "cannot be set to false directly, use the 'Deactivate' button on Workbench, or the 'unsetup' API call"
301 def set_initial_username(requested: false)
302 if !requested.is_a?(String) || requested.empty?
303 email_parts = email.partition("@")
304 local_parts = email_parts.first.partition("+")
305 if email_parts.any?(&:empty?)
307 elsif not local_parts.first.empty?
308 requested = local_parts.first
310 requested = email_parts.first
313 requested.sub!(/^[^A-Za-z]+/, "")
314 requested.gsub!(/[^A-Za-z0-9]/, "")
315 unless requested.empty?
316 self.username = find_usable_username_from(requested)
320 def update_uuid(new_uuid:)
321 if !current_user.andand.is_admin
322 raise PermissionDeniedError
324 if uuid == system_user_uuid || uuid == anonymous_user_uuid
325 raise "update_uuid cannot update system accounts"
327 if self.class != self.class.resource_class_for_uuid(new_uuid)
328 raise "invalid new_uuid #{new_uuid.inspect}"
330 transaction(requires_new: true) do
334 save!(validate: false)
335 change_all_uuid_refs(old_uuid: old_uuid, new_uuid: new_uuid)
336 ActiveRecord::Base.connection.exec_update %{
337 update #{PERMISSION_VIEW} set user_uuid=$1 where user_uuid = $2
339 'User.update_uuid.update_permissions_user_uuid',
342 ActiveRecord::Base.connection.exec_update %{
343 update #{PERMISSION_VIEW} set target_uuid=$1 where target_uuid = $2
345 'User.update_uuid.update_permissions_target_uuid',
351 # Move this user's (i.e., self's) owned items to new_owner_uuid and
352 # new_user_uuid (for things normally owned directly by the user).
354 # If redirect_auth is true, also reassign auth tokens and ssh keys,
355 # and redirect this account to redirect_to_user_uuid, i.e., when a
356 # caller authenticates to this account in the future, the account
357 # redirect_to_user_uuid account will be used instead.
359 # current_user must have admin privileges, i.e., the caller is
360 # responsible for checking permission to do this.
361 def merge(new_owner_uuid:, new_user_uuid:, redirect_to_new_user:)
362 raise PermissionDeniedError if !current_user.andand.is_admin
363 raise "Missing new_owner_uuid" if !new_owner_uuid
364 raise "Missing new_user_uuid" if !new_user_uuid
365 transaction(requires_new: true) do
367 raise "cannot merge an already merged user" if self.redirect_to_user_uuid
369 new_user = User.where(uuid: new_user_uuid).first
370 raise "user does not exist" if !new_user
371 raise "cannot merge to an already merged user" if new_user.redirect_to_user_uuid
373 self.clear_permissions
374 new_user.clear_permissions
376 # If 'self' is a remote user, don't transfer authorizations
377 # (i.e. ability to access the account) to the new user, because
378 # that gives the remote site the ability to access the 'new'
379 # user account that takes over the 'self' account.
381 # If 'self' is a local user, it is okay to transfer
382 # authorizations, even if the 'new' user is a remote account,
383 # because the remote site does not gain the ability to access an
384 # account it could not before.
386 if redirect_to_new_user and self.uuid[0..4] == Rails.configuration.ClusterID
387 # Existing API tokens and ssh keys are updated to authenticate
389 ApiClientAuthorization.
391 update_all(user_id: new_user.id)
394 [AuthorizedKey, :owner_uuid],
395 [AuthorizedKey, :authorized_user_uuid],
401 # Destroy API tokens and ssh keys associated with the old
403 ApiClientAuthorization.where(user_id: id).destroy_all
404 AuthorizedKey.where(owner_uuid: uuid).destroy_all
405 AuthorizedKey.where(authorized_user_uuid: uuid).destroy_all
412 # References to the old user UUID in the context of a user ID
413 # (rather than a "home project" in the project hierarchy) are
414 # updated to point to the new user.
415 user_updates.each do |klass, column|
416 klass.where(column => uuid).update_all(column => new_user.uuid)
419 # Need to update repository names to new username
421 old_repo_name_re = /^#{Regexp.escape(username)}\//
422 Repository.where(:owner_uuid => uuid).each do |repo|
423 repo.owner_uuid = new_user.uuid
424 repo_name_sub = "#{new_user.username}/"
425 name = repo.name.sub(old_repo_name_re, repo_name_sub)
426 while (conflict = Repository.where(:name => name).first) != nil
427 repo_name_sub += "migrated"
428 name = repo.name.sub(old_repo_name_re, repo_name_sub)
435 # References to the merged user's "home project" are updated to
436 # point to new_owner_uuid.
437 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
438 next if [ApiClientAuthorization,
442 Repository].include?(klass)
443 next if !klass.columns.collect(&:name).include?('owner_uuid')
444 klass.where(owner_uuid: uuid).update_all(owner_uuid: new_owner_uuid)
447 if redirect_to_new_user
448 update_attributes!(redirect_to_user_uuid: new_user.uuid, username: nil)
450 skip_check_permissions_against_full_refresh do
451 update_permissions self.uuid, self.uuid, CAN_MANAGE_PERM
452 update_permissions new_user.uuid, new_user.uuid, CAN_MANAGE_PERM
453 update_permissions new_user.owner_uuid, new_user.uuid, CAN_MANAGE_PERM
455 update_permissions self.owner_uuid, self.uuid, CAN_MANAGE_PERM
462 while (uuid = user.redirect_to_user_uuid)
464 nextuser = User.unscoped.find_by_uuid(uuid)
466 raise Exception.new("user uuid #{user.uuid} redirects to nonexistent uuid '#{uuid}'")
471 raise "Starting from #{self.uuid} redirect_to_user_uuid exceeded maximum number of redirects"
477 def self.register info
478 # login info expected fields, all can be optional but at minimum
479 # must supply either 'identity_url' or 'email'
491 identity_url = info['identity_url']
493 if identity_url && identity_url.length > 0
494 # Only local users can create sessions, hence uuid_like_pattern
496 user = User.unscoped.where('identity_url = ? and uuid like ?',
498 User.uuid_like_pattern).first
499 primary_user = user.redirects_to if user
503 # identity url is unset or didn't find matching record.
504 emails = [info['email']] + (info['alternate_emails'] || [])
505 emails.select! {|em| !em.nil? && !em.empty?}
507 User.unscoped.where('email in (?) and uuid like ?',
509 User.uuid_like_pattern).each do |user|
511 primary_user = user.redirects_to
512 elsif primary_user.uuid != user.redirects_to.uuid
513 raise "Ambiguous email address, directs to both #{primary_user.uuid} and #{user.redirects_to.uuid}"
519 # New user registration
520 primary_user = User.new(:owner_uuid => system_user_uuid,
522 :is_active => Rails.configuration.Users.NewUsersAreActive)
524 primary_user.set_initial_username(requested: info['username']) if info['username'] && !info['username'].blank?
525 primary_user.identity_url = info['identity_url'] if identity_url
528 primary_user.email = info['email'] if info['email']
529 primary_user.first_name = info['first_name'] if info['first_name']
530 primary_user.last_name = info['last_name'] if info['last_name']
532 if (!primary_user.email or primary_user.email.empty?) and (!primary_user.identity_url or primary_user.identity_url.empty?)
533 raise "Must have supply at least one of 'email' or 'identity_url' to User.register"
536 act_as_system_user do
545 def change_all_uuid_refs(old_uuid:, new_uuid:)
546 ActiveRecord::Base.descendants.reject(&:abstract_class?).each do |klass|
547 klass.columns.each do |col|
548 if col.name.end_with?('_uuid')
549 column = col.name.to_sym
550 klass.where(column => old_uuid).update_all(column => new_uuid)
556 def ensure_ownership_path_leads_to_user
560 def permission_to_update
561 if username_changed? || redirect_to_user_uuid_changed? || email_changed?
562 current_user.andand.is_admin
564 # users must be able to update themselves (even if they are
565 # inactive) in order to create sessions
566 self == current_user or super
570 def permission_to_create
571 current_user.andand.is_admin or
572 (self == current_user &&
573 self.redirect_to_user_uuid.nil? &&
574 self.is_active == Rails.configuration.Users.NewUsersAreActive)
578 return if self.uuid.end_with?('anonymouspublic')
579 if (User.where("email = ?",self.email).where(:is_admin => true).count == 0 and
580 !Rails.configuration.Users.AutoAdminUserWithEmail.empty? and self.email == Rails.configuration.Users["AutoAdminUserWithEmail"]) or
581 (User.where("uuid not like '%-000000000000000'").where(:is_admin => true).count == 0 and
582 Rails.configuration.Users.AutoAdminFirstUser)
584 self.is_active = true
588 def find_usable_username_from(basename)
589 # If "basename" is a usable username, return that.
590 # Otherwise, find a unique username "basenameN", where N is the
591 # smallest integer greater than 1, and return that.
592 # Return nil if a unique username can't be found after reasonable
594 quoted_name = self.class.connection.quote_string(basename)
595 next_username = basename
597 while Rails.configuration.Users.AutoSetupUsernameBlacklist[next_username]
599 next_username = "%s%i" % [basename, next_suffix]
601 0.upto(6).each do |suffix_len|
602 pattern = "%s%s" % [quoted_name, "_" * suffix_len]
604 where("username like '#{pattern}'").
606 order('username asc').
608 if other_user.username > next_username
610 elsif other_user.username == next_username
612 next_username = "%s%i" % [basename, next_suffix]
615 return next_username if (next_username.size <= pattern.size)
620 def prevent_privilege_escalation
621 if current_user.andand.is_admin
624 if self.is_active_changed?
625 if self.is_active != self.is_active_was
626 logger.warn "User #{current_user.uuid} tried to change is_active from #{self.is_active_was} to #{self.is_active} for #{self.uuid}"
627 self.is_active = self.is_active_was
630 if self.is_admin_changed?
631 if self.is_admin != self.is_admin_was
632 logger.warn "User #{current_user.uuid} tried to change is_admin from #{self.is_admin_was} to #{self.is_admin} for #{self.uuid}"
633 self.is_admin = self.is_admin_was
639 def prevent_inactive_admin
640 if self.is_admin and not self.is_active
641 # There is no known use case for the strange set of permissions
642 # that would result from this change. It's safest to assume it's
643 # a mistake and disallow it outright.
644 raise "Admin users cannot be inactive"
649 def search_permissions(start, graph, merged={}, upstream_mask=nil, upstream_path={})
650 nextpaths = graph[start]
651 return merged if !nextpaths
652 return merged if upstream_path.has_key? start
653 upstream_path[start] = true
654 upstream_mask ||= ALL_PERMISSIONS
655 nextpaths.each do |head, mask|
658 merged[head][k] ||= v if upstream_mask[k]
660 search_permissions(head, graph, merged, upstream_mask.select { |k,v| v && merged[head][k] }, upstream_path)
662 upstream_path.delete start
666 def create_user_repo_link(repo_name)
667 # repo_name is optional
669 logger.warn ("Repository name not given for #{self.uuid}.")
673 repo = Repository.where(owner_uuid: uuid, name: repo_name).first_or_create!
674 logger.info { "repo uuid: " + repo[:uuid] }
675 repo_perm = Link.where(tail_uuid: uuid, head_uuid: repo.uuid,
676 link_class: "permission",
677 name: "can_manage").first_or_create!
678 logger.info { "repo permission: " + repo_perm[:uuid] }
682 # create login permission for the given vm_uuid, if it does not already exist
683 def create_vm_login_permission_link(vm_uuid, repo_name)
684 # vm uuid is optional
685 return if vm_uuid == ""
687 vm = VirtualMachine.where(uuid: vm_uuid).first
689 logger.warn "Could not find virtual machine for #{vm_uuid.inspect}"
690 raise "No vm found for #{vm_uuid}"
693 logger.info { "vm uuid: " + vm[:uuid] }
695 tail_uuid: uuid, head_uuid: vm.uuid,
696 link_class: "permission", name: "can_login",
701 select { |link| link.properties["username"] == repo_name }.
705 create(login_attrs.merge(properties: {"username" => repo_name}))
707 logger.info { "login permission: " + login_perm[:uuid] }
711 # add the user to the 'All users' group
712 def create_user_group_link
713 return (Link.where(tail_uuid: self.uuid,
714 head_uuid: all_users_group[:uuid],
715 link_class: 'permission',
716 name: 'can_read').first or
717 Link.create(tail_uuid: self.uuid,
718 head_uuid: all_users_group[:uuid],
719 link_class: 'permission',
723 # Give the special "System group" permission to manage this user and
724 # all of this user's stuff.
725 def add_system_group_permission_link
726 return true if uuid == system_user_uuid
727 act_as_system_user do
728 Link.create(link_class: 'permission',
730 tail_uuid: system_group_uuid,
731 head_uuid: self.uuid)
735 # Send admin notifications
736 def send_admin_notifications
737 AdminNotifier.new_user(self).deliver_now
738 if not self.is_active then
739 AdminNotifier.new_inactive_user(self).deliver_now
743 # Automatically setup if is_active flag turns on
744 def setup_on_activate
745 return if [system_user_uuid, anonymous_user_uuid].include?(self.uuid)
746 if is_active && (new_record? || saved_change_to_is_active?)
751 # Automatically setup new user during creation
752 def auto_setup_new_user
755 create_vm_login_permission_link(Rails.configuration.Users.AutoSetupNewUsersWithVmUUID,
757 repo_name = "#{username}/#{username}"
758 if Rails.configuration.Users.AutoSetupNewUsersWithRepository and
759 Repository.where(name: repo_name).first.nil?
760 repo = Repository.create!(name: repo_name, owner_uuid: uuid)
761 Link.create!(tail_uuid: uuid, head_uuid: repo.uuid,
762 link_class: "permission", name: "can_manage")
767 # Send notification if the user saved profile for the first time
768 def send_profile_created_notification
769 if saved_change_to_prefs?
770 if prefs_before_last_save.andand.empty? || !prefs_before_last_save.andand['profile']
771 profile_notification_address = Rails.configuration.Users.UserProfileNotificationAddress
772 ProfileNotifier.profile_created(self, profile_notification_address).deliver_now if profile_notification_address and !profile_notification_address.empty?
777 def verify_repositories_empty
778 unless repositories.first.nil?
779 errors.add(:username, "can't be unset when the user owns repositories")
784 def sync_repository_names
785 old_name_re = /^#{Regexp.escape(username_before_last_save)}\//
786 name_sub = "#{username}/"
787 repositories.find_each do |repo|
788 repo.name = repo.name.sub(old_name_re, name_sub)