services/api/app/controllers/arvados/v1/users_controller.rb

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 class Arvados::V1::UsersController < ApplicationController
   6   accept_attribute_as_json :prefs, Hash
   7   accept_param_as_json :updates
   8
   9   skip_before_action :find_object_by_uuid, only:
  10     [:activate, :current, :system, :setup, :merge, :batch_update]
  11   skip_before_action :render_404_if_no_object, only:
  12     [:activate, :current, :system, :setup, :merge, :batch_update]
  13   before_action :admin_required, only: [:setup, :unsetup, :update_uuid, :batch_update]
  14
  15   # Internal API used by controller to update local cache of user
  16   # records from LoginCluster.
  17   def batch_update
  18     @objects = []
  19     params[:updates].andand.each do |uuid, attrs|
  20       begin
  21         u = User.find_or_create_by(uuid: uuid)
  22       rescue ActiveRecord::RecordNotUnique
  23         retry
  24       end
  25       needupdate = {}
  26       nullify_attrs(attrs).each do |k,v|
  27         if !v.nil? && u.send(k) != v
  28           needupdate[k] = v
  29         end
  30       end
  31       if needupdate.length > 0
  32         begin
  33           u.update_attributes!(needupdate)
  34         rescue ActiveRecord::RecordInvalid
  35           loginCluster = Rails.configuration.Login.LoginCluster
  36           if u.uuid[0..4] == loginCluster && !needupdate[:username].nil?
  37             local_user = User.find_by_username(needupdate[:username])
  38             # A cached user record from the LoginCluster is stale, reset its username
  39             # and retry the update operation.
  40             if local_user.andand.uuid[0..4] == loginCluster && local_user.uuid != u.uuid
  41               Rails.logger.warn("cached username '#{needupdate[:username]}' collision with user '#{local_user.uuid}' - resetting")
  42               local_user.update_attributes!({username: nil})
  43               retry
  44             end
  45           end
  46           raise # Not the issue we're handling above
  47         end
  48       end
  49       @objects << u
  50     end
  51     @offset = 0
  52     @limit = -1
  53     render_list
  54   end
  55
  56   def current
  57     if current_user
  58       @object = current_user
  59       show
  60     else
  61       send_error("Not logged in", status: 401)
  62     end
  63   end
  64
  65   def system
  66     @object = system_user
  67     show
  68   end
  69
  70   def activate
  71     if params[:id] and params[:id].match(/\D/)
  72       params[:uuid] = params.delete :id
  73     end
  74     if current_user.andand.is_admin && params[:uuid]
  75       @object = User.find_by_uuid params[:uuid]
  76     else
  77       @object = current_user
  78     end
  79     if not @object.is_active
  80       if @object.uuid[0..4] == Rails.configuration.Login.LoginCluster &&
  81          @object.uuid[0..4] != Rails.configuration.ClusterID
  82         logger.warn "Local user #{@object.uuid} called users#activate but only LoginCluster can do that"
  83         raise ArgumentError.new "cannot activate user #{@object.uuid} here, only the #{@object.uuid[0..4]} cluster can do that"
  84       elsif not (current_user.is_admin or @object.is_invited)
  85         logger.warn "User #{@object.uuid} called users.activate " +
  86           "but is not invited"
  87         raise ArgumentError.new "Cannot activate without being invited."
  88       end
  89       act_as_system_user do
  90         required_uuids = Link.where("owner_uuid = ? and link_class = ? and name = ? and tail_uuid = ? and head_uuid like ?",
  91                                     system_user_uuid,
  92                                     'signature',
  93                                     'require',
  94                                     system_user_uuid,
  95                                     Collection.uuid_like_pattern).
  96           collect(&:head_uuid)
  97         signed_uuids = Link.where(owner_uuid: system_user_uuid,
  98                                   link_class: 'signature',
  99                                   name: 'click',
 100                                   tail_uuid: @object.uuid,
 101                                   head_uuid: required_uuids).
 102           collect(&:head_uuid)
 103         todo_uuids = required_uuids - signed_uuids
 104         if todo_uuids.empty?
 105           @object.update_attributes is_active: true
 106           logger.info "User #{@object.uuid} activated"
 107         else
 108           logger.warn "User #{@object.uuid} called users.activate " +
 109             "before signing agreements #{todo_uuids.inspect}"
 110           raise ArvadosModel::PermissionDeniedError.new \
 111           "Cannot activate without user agreements #{todo_uuids.inspect}."
 112         end
 113       end
 114     end
 115     show
 116   end
 117
 118   # create user object and all the needed links
 119   def setup
 120     if params[:uuid]
 121       @object = User.find_by_uuid(params[:uuid])
 122       if !@object
 123         return render_404_if_no_object
 124       end
 125     elsif !params[:user] || params[:user].empty?
 126       raise ArgumentError.new "Required uuid or user"
 127     elsif !params[:user]['email']
 128       raise ArgumentError.new "Require user email"
 129     else
 130       @object = model_class.create! resource_attrs
 131     end
 132
 133     # It's not always possible for the client to know the user's
 134     # username when submitting this request: the username might have
 135     # been assigned automatically in create!() above. If client
 136     # provided a plain repository name, prefix it with the username
 137     # now that we know what it is.
 138     if params[:repo_name].nil?
 139       full_repo_name = nil
 140     elsif @object.username.nil?
 141       raise ArgumentError.
 142         new("cannot setup a repository because user has no username")
 143     elsif params[:repo_name].index("/")
 144       full_repo_name = params[:repo_name]
 145     else
 146       full_repo_name = "#{@object.username}/#{params[:repo_name]}"
 147     end
 148
 149     @response = @object.setup(repo_name: full_repo_name,
 150                               vm_uuid: params[:vm_uuid],
 151                               send_notification_email: params[:send_notification_email])
 152
 153     send_json kind: "arvados#HashList", items: @response.as_api_response(nil)
 154   end
 155
 156   # delete user agreements, vm, repository, login links; set state to inactive
 157   def unsetup
 158     reload_object_before_update
 159     @object.unsetup
 160     show
 161   end
 162
 163   # Change UUID to a new (unused) uuid and transfer all owned/linked
 164   # objects accordingly.
 165   def update_uuid
 166     @object.update_uuid(new_uuid: params[:new_uuid])
 167     show
 168   end
 169
 170   def merge
 171     if (params[:old_user_uuid] || params[:new_user_uuid])
 172       if !current_user.andand.is_admin
 173         return send_error("Must be admin to use old_user_uuid/new_user_uuid", status: 403)
 174       end
 175       if !params[:old_user_uuid] || !params[:new_user_uuid]
 176         return send_error("Must supply both old_user_uuid and new_user_uuid", status: 422)
 177       end
 178       new_user = User.find_by_uuid(params[:new_user_uuid])
 179       if !new_user
 180         return send_error("User in new_user_uuid not found", status: 422)
 181       end
 182       @object = User.find_by_uuid(params[:old_user_uuid])
 183       if !@object
 184         return send_error("User in old_user_uuid not found", status: 422)
 185       end
 186     else
 187       if !Thread.current[:api_client].andand.is_trusted
 188         return send_error("supplied API token is not from a trusted client", status: 403)
 189       elsif Thread.current[:api_client_authorization].scopes != ['all']
 190         return send_error("cannot merge with a scoped token", status: 403)
 191       end
 192
 193       new_auth = ApiClientAuthorization.validate(token: params[:new_user_token])
 194       if !new_auth
 195         return send_error("invalid new_user_token", status: 401)
 196       end
 197
 198       if new_auth.user.uuid[0..4] == Rails.configuration.ClusterID
 199         if !new_auth.api_client.andand.is_trusted
 200           return send_error("supplied new_user_token is not from a trusted client", status: 403)
 201         elsif new_auth.scopes != ['all']
 202           return send_error("supplied new_user_token has restricted scope", status: 403)
 203         end
 204       end
 205       new_user = new_auth.user
 206       @object = current_user
 207     end
 208
 209     if @object.uuid == new_user.uuid
 210       return send_error("cannot merge user to self", status: 422)
 211     end
 212
 213     if !params[:new_owner_uuid]
 214       return send_error("missing new_owner_uuid", status: 422)
 215     end
 216
 217     if !new_user.can?(write: params[:new_owner_uuid])
 218       return send_error("cannot move objects into supplied new_owner_uuid: new user does not have write permission", status: 403)
 219     end
 220
 221     act_as_system_user do
 222       @object.merge(new_owner_uuid: params[:new_owner_uuid],
 223                     new_user_uuid: new_user.uuid,
 224                     redirect_to_new_user: params[:redirect_to_new_user])
 225     end
 226     show
 227   end
 228
 229   protected
 230
 231   def self._merge_requires_parameters
 232     {
 233       new_owner_uuid: {
 234         type: 'string', required: true,
 235       },
 236       new_user_token: {
 237         type: 'string', required: false,
 238       },
 239       redirect_to_new_user: {
 240         type: 'boolean', required: false, default: false,
 241       },
 242       old_user_uuid: {
 243         type: 'string', required: false,
 244       },
 245       new_user_uuid: {
 246         type: 'string', required: false,
 247       }
 248     }
 249   end
 250
 251   def self._setup_requires_parameters
 252     {
 253       uuid: {
 254         type: 'string', required: false,
 255       },
 256       user: {
 257         type: 'object', required: false,
 258       },
 259       repo_name: {
 260         type: 'string', required: false,
 261       },
 262       vm_uuid: {
 263         type: 'string', required: false,
 264       },
 265       send_notification_email: {
 266         type: 'boolean', required: false, default: false,
 267       },
 268     }
 269   end
 270
 271   def self._update_requires_parameters
 272     super.merge({
 273       bypass_federation: {
 274         type: 'boolean', required: false, default: false,
 275       },
 276     })
 277   end
 278
 279   def self._update_uuid_requires_parameters
 280     {
 281       new_uuid: {
 282         type: 'string', required: true,
 283       },
 284     }
 285   end
 286
 287   def apply_filters(model_class=nil)
 288     return super if @read_users.any?(&:is_admin)
 289     if params[:uuid] != current_user.andand.uuid
 290       # Non-admin index/show returns very basic information about readable users.
 291       safe_attrs = ["uuid", "is_active", "email", "first_name", "last_name", "username"]
 292       if @select
 293         @select = @select & safe_attrs
 294       else
 295         @select = safe_attrs
 296       end
 297       @filters += [['is_active', '=', true]]
 298     end
 299     super
 300   end
 301
 302   def nullable_attributes
 303     super + [:email, :first_name, :last_name, :username]
 304   end
 305 end