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