1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
5 class ApiClientAuthorization < ArvadosModel
8 include CommonApiTemplate
9 extend CurrentApiClient
11 belongs_to :api_client
13 after_initialize :assign_random_api_token
14 serialize :scopes, Array
16 api_accessible :user, extend: :common do |t|
20 # NB the "api_token" db column is a misnomer in that it's only the
21 # "secret" part of a token: a v1 token is just the secret, but a
22 # v2 token is "v2/uuid/secret".
24 t.add :created_by_ip_address
25 t.add :default_owner_uuid
28 t.add :last_used_by_ip_address
32 UNLOGGED_CHANGES = ['last_used_at', 'last_used_by_ip_address', 'updated_at']
34 def assign_random_api_token
35 self.api_token ||= rand(2**256).to_s(36)
42 self.user_id_changed? ? User.where(id: self.user_id_was).first.andand.uuid : self.user.andand.uuid
44 def owner_uuid_changed?
48 def modified_by_client_uuid
51 def modified_by_client_uuid=(x) end
53 def modified_by_user_uuid
56 def modified_by_user_uuid=(x) end
61 def modified_at=(x) end
63 def scopes_allow?(req_s)
64 scopes.each do |scope|
65 return true if (scope == 'all') or (scope == req_s) or
66 ((scope.end_with? '/') and (req_s.start_with? scope))
71 def scopes_allow_request?(request)
72 method = request.request_method
74 (scopes_allow?(['HEAD', request.path].join(' ')) ||
75 scopes_allow?(['GET', request.path].join(' ')))
77 scopes_allow?([method, request.path].join(' '))
82 super.except 'api_token'
85 def self.default_orders
86 ["#{table_name}.id desc"]
89 def self.remote_host(uuid_prefix:)
90 Rails.configuration.remote_hosts[uuid_prefix] ||
91 (Rails.configuration.remote_hosts_via_dns &&
92 uuid_prefix+".arvadosapi.com")
95 def self.validate(token:, remote: nil)
97 remote ||= Rails.configuration.uuid_prefix
101 _, uuid, secret = token.split('/')
102 unless uuid.andand.length == 27 && secret.andand.length.andand > 0
106 auth = ApiClientAuthorization.
107 includes(:user, :api_client).
108 where('uuid=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', uuid).
110 if auth && auth.user &&
111 (secret == auth.api_token ||
112 secret == OpenSSL::HMAC.hexdigest('sha1', auth.api_token, remote))
116 uuid_prefix = uuid[0..4]
117 if uuid_prefix == Rails.configuration.uuid_prefix
118 # If the token were valid, we would have validated it above
120 elsif uuid_prefix.length != 5
125 host = remote_host(uuid_prefix: uuid_prefix)
127 Rails.logger.warn "remote authentication rejected: no host for #{uuid_prefix.inspect}"
131 # Token was issued by a different cluster. If it's expired or
132 # missing in our database, ask the originating cluster to
135 clnt = HTTPClient.new
136 if Rails.configuration.sso_insecure
137 clnt.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
139 remote_user = SafeJSON.load(
140 clnt.get_content('https://' + host + '/arvados/v1/users/current',
141 {'remote' => Rails.configuration.uuid_prefix},
142 {'Authorization' => 'Bearer ' + token}))
144 Rails.logger.warn "remote authentication with token #{token.inspect} failed: #{e}"
147 if !remote_user.is_a?(Hash) || !remote_user['uuid'].is_a?(String) || remote_user['uuid'][0..4] != uuid[0..4]
148 Rails.logger.warn "remote authentication rejected: remote_user=#{remote_user.inspect}"
151 act_as_system_user do
152 # Add/update user and token in our database so we can
153 # validate subsequent requests faster.
155 user = User.find_or_create_by(uuid: remote_user['uuid']) do |user|
156 # (this block runs for the "create" case, not for "find")
157 user.is_admin = false
158 user.email = remote_user['email']
159 if remote_user['username'].andand.length.andand > 0
160 user.set_initial_username(requested: remote_user['username'])
164 if Rails.configuration.new_users_are_active ||
165 Rails.configuration.auto_activate_users_from.include?(remote_user['uuid'][0..4])
166 # Update is_active to whatever it is at the remote end
167 user.is_active = remote_user['is_active']
168 elsif !remote_user['is_active']
169 # Remote user is inactive; our mirror should be, too.
170 user.is_active = false
173 %w[first_name last_name email prefs].each do |attr|
174 user.send(attr+'=', remote_user[attr])
179 auth = ApiClientAuthorization.find_or_create_by(uuid: uuid) do |auth|
181 auth.api_token = secret
182 auth.api_client_id = 0
185 # Accept this token (and don't reload the user record) for
186 # 5 minutes. TODO: Request the actual api_client_auth
187 # record from the remote server in case it wants the token
189 auth.update_attributes!(user: user,
192 expires_at: Time.now + 5.minutes)
196 auth = ApiClientAuthorization.
197 includes(:user, :api_client).
198 where('api_token=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', token).
209 def permission_to_create
210 current_user.andand.is_admin or (current_user.andand.id == self.user_id)
213 def permission_to_update
214 permission_to_create && !uuid_changed? &&
215 (current_user.andand.is_admin || !user_id_changed?)
219 super unless (changed - UNLOGGED_CHANGES).empty?