15061: API support for linking local account to remote user
[arvados.git] / 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
8   skip_before_action :find_object_by_uuid, only:
9     [:activate, :current, :system, :setup, :merge]
10   skip_before_action :render_404_if_no_object, only:
11     [:activate, :current, :system, :setup, :merge]
12   before_action :admin_required, only: [:setup, :unsetup, :update_uuid]
13
14   def current
15     if current_user
16       @object = current_user
17       show
18     else
19       send_error("Not logged in", status: 401)
20     end
21   end
22
23   def system
24     @object = system_user
25     show
26   end
27
28   def activate
29     if current_user.andand.is_admin && params[:uuid]
30       @object = User.find params[:uuid]
31     else
32       @object = current_user
33     end
34     if not @object.is_active
35       if not (current_user.is_admin or @object.is_invited)
36         logger.warn "User #{@object.uuid} called users.activate " +
37           "but is not invited"
38         raise ArgumentError.new "Cannot activate without being invited."
39       end
40       act_as_system_user do
41         required_uuids = Link.where("owner_uuid = ? and link_class = ? and name = ? and tail_uuid = ? and head_uuid like ?",
42                                     system_user_uuid,
43                                     'signature',
44                                     'require',
45                                     system_user_uuid,
46                                     Collection.uuid_like_pattern).
47           collect(&:head_uuid)
48         signed_uuids = Link.where(owner_uuid: system_user_uuid,
49                                   link_class: 'signature',
50                                   name: 'click',
51                                   tail_uuid: @object.uuid,
52                                   head_uuid: required_uuids).
53           collect(&:head_uuid)
54         todo_uuids = required_uuids - signed_uuids
55         if todo_uuids.empty?
56           @object.update_attributes is_active: true
57           logger.info "User #{@object.uuid} activated"
58         else
59           logger.warn "User #{@object.uuid} called users.activate " +
60             "before signing agreements #{todo_uuids.inspect}"
61           raise ArvadosModel::PermissionDeniedError.new \
62           "Cannot activate without user agreements #{todo_uuids.inspect}."
63         end
64       end
65     end
66     show
67   end
68
69   # create user object and all the needed links
70   def setup
71     if params[:uuid]
72       @object = User.find_by_uuid(params[:uuid])
73       if !@object
74         return render_404_if_no_object
75       end
76     elsif !params[:user] || params[:user].empty?
77       raise ArgumentError.new "Required uuid or user"
78     elsif !params[:user]['email']
79       raise ArgumentError.new "Require user email"
80     elsif !params[:openid_prefix]
81       raise ArgumentError.new "Required openid_prefix parameter is missing."
82     else
83       @object = model_class.create! resource_attrs
84     end
85
86     # It's not always possible for the client to know the user's
87     # username when submitting this request: the username might have
88     # been assigned automatically in create!() above. If client
89     # provided a plain repository name, prefix it with the username
90     # now that we know what it is.
91     if params[:repo_name].nil?
92       full_repo_name = nil
93     elsif @object.username.nil?
94       raise ArgumentError.
95         new("cannot setup a repository because user has no username")
96     elsif params[:repo_name].index("/")
97       full_repo_name = params[:repo_name]
98     else
99       full_repo_name = "#{@object.username}/#{params[:repo_name]}"
100     end
101
102     @response = @object.setup(repo_name: full_repo_name,
103                               vm_uuid: params[:vm_uuid],
104                               openid_prefix: params[:openid_prefix])
105
106     # setup succeeded. send email to user
107     if params[:send_notification_email]
108       UserNotifier.account_is_setup(@object).deliver_now
109     end
110
111     send_json kind: "arvados#HashList", items: @response.as_api_response(nil)
112   end
113
114   # delete user agreements, vm, repository, login links; set state to inactive
115   def unsetup
116     reload_object_before_update
117     @object.unsetup
118     show
119   end
120
121   # Change UUID to a new (unused) uuid and transfer all owned/linked
122   # objects accordingly.
123   def update_uuid
124     @object.update_uuid(new_uuid: params[:new_uuid])
125     show
126   end
127
128   def merge
129     if !Thread.current[:api_client].andand.is_trusted
130       return send_error("supplied API token is not from a trusted client", status: 403)
131     elsif Thread.current[:api_client_authorization].scopes != ['all']
132       return send_error("cannot merge with a scoped token", status: 403)
133     end
134
135     new_auth = ApiClientAuthorization.validate(token: params[:new_user_token])
136     if !new_auth
137       return send_error("invalid new_user_token", status: 401)
138     end
139
140     if new_auth.user.uuid[0..4] == Rails.configuration.ClusterID
141       if !new_auth.api_client.andand.is_trusted
142         return send_error("supplied new_user_token is not from a trusted client", status: 403)
143       elsif new_auth.scopes != ['all']
144         return send_error("supplied new_user_token has restricted scope", status: 403)
145       end
146     end
147     new_user = new_auth.user
148
149     if current_user.uuid == new_user.uuid
150       return send_error("cannot merge user to self", status: 422)
151     end
152
153     if !new_user.can?(write: params[:new_owner_uuid])
154       return send_error("cannot move objects into supplied new_owner_uuid: new user does not have write permission", status: 403)
155     end
156
157     redirect = params[:redirect_to_new_user]
158     if !redirect
159       return send_error("merge with redirect_to_new_user=false is not yet supported", status: 422)
160     end
161
162     @object = current_user
163     act_as_system_user do
164       @object.merge(new_owner_uuid: params[:new_owner_uuid], redirect_to_user_uuid: redirect && new_user.uuid)
165     end
166     show
167   end
168
169   protected
170
171   def self._merge_requires_parameters
172     {
173       new_owner_uuid: {
174         type: 'string', required: true,
175       },
176       new_user_token: {
177         type: 'string', required: true,
178       },
179       redirect_to_new_user: {
180         type: 'boolean', required: false,
181       },
182     }
183   end
184
185   def self._setup_requires_parameters
186     {
187       user: {
188         type: 'object', required: false
189       },
190       openid_prefix: {
191         type: 'string', required: false
192       },
193       repo_name: {
194         type: 'string', required: false
195       },
196       vm_uuid: {
197         type: 'string', required: false
198       },
199       send_notification_email: {
200         type: 'boolean', required: false, default: false
201       },
202     }
203   end
204
205   def self._update_uuid_requires_parameters
206     {
207       new_uuid: {
208         type: 'string', required: true,
209       },
210     }
211   end
212
213   def apply_filters(model_class=nil)
214     return super if @read_users.any?(&:is_admin)
215     if params[:uuid] != current_user.andand.uuid
216       # Non-admin index/show returns very basic information about readable users.
217       safe_attrs = ["uuid", "is_active", "email", "first_name", "last_name", "username"]
218       if @select
219         @select = @select & safe_attrs
220       else
221         @select = safe_attrs
222       end
223       @filters += [['is_active', '=', true]]
224     end
225     super
226   end
227 end