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