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