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.RemoteClusters[uuid_prefix].andand["Host"]) ||
91 (Rails.configuration.RemoteClusters["*"]["Proxy"] &&
92 uuid_prefix+".arvadosapi.com")
95 def self.make_http_client(uuid_prefix:)
98 if uuid_prefix && (Rails.configuration.RemoteClusters[uuid_prefix].andand.Insecure ||
99 Rails.configuration.RemoteClusters['*'].andand.Insecure)
100 clnt.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
102 # Use system CA certificates
103 ["/etc/ssl/certs/ca-certificates.crt",
104 "/etc/pki/tls/certs/ca-bundle.crt"]
105 .select { |ca_path| File.readable?(ca_path) }
106 .each { |ca_path| clnt.ssl_config.add_trust_ca(ca_path) }
111 def self.validate(token:, remote: nil)
113 remote ||= Rails.configuration.ClusterID
117 _, token_uuid, secret, optional = token.split('/')
118 unless token_uuid.andand.length == 27 && secret.andand.length.andand > 0
123 # if "optional" is a container uuid, check that it
124 # matches expections.
125 c = Container.where(uuid: optional).first
127 if !c.auth_uuid.nil? and c.auth_uuid != token_uuid
128 # token doesn't match the container's token
131 if !c.runtime_token.nil? and "v2/#{token_uuid}/#{secret}" != c.runtime_token
132 # token doesn't match the container's token
135 if ![Container::Locked, Container::Running].include?(c.state)
136 # container isn't locked or running, token shouldn't be used
142 # fast path: look up the token in the local database
143 auth = ApiClientAuthorization.
144 includes(:user, :api_client).
145 where('uuid=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', token_uuid).
147 if auth && auth.user &&
148 (secret == auth.api_token ||
149 secret == OpenSSL::HMAC.hexdigest('sha1', auth.api_token, remote))
154 token_uuid_prefix = token_uuid[0..4]
155 if token_uuid_prefix == Rails.configuration.ClusterID
156 # Token is supposedly issued by local cluster, but if the
157 # token were valid, we would have been found in the database
158 # in the above query.
160 elsif token_uuid_prefix.length != 5
165 # Invariant: token_uuid_prefix != Rails.configuration.ClusterID
167 # In other words the remaing code in this method below is the
168 # case that determines whether to accept a token that was issued
169 # by a remote cluster when the token absent or expired in our
170 # database. To begin, we need to ask the cluster that issued
171 # the token to [re]validate it.
172 clnt = ApiClientAuthorization.make_http_client(uuid_prefix: token_uuid_prefix)
174 host = remote_host(uuid_prefix: token_uuid_prefix)
176 Rails.logger.warn "remote authentication rejected: no host for #{token_uuid_prefix.inspect}"
181 remote_user = SafeJSON.load(
182 clnt.get_content('https://' + host + '/arvados/v1/users/current',
183 {'remote' => Rails.configuration.ClusterID},
184 {'Authorization' => 'Bearer ' + token}))
186 Rails.logger.warn "remote authentication with token #{token.inspect} failed: #{e}"
190 # Check the response is well formed.
191 if !remote_user.is_a?(Hash) || !remote_user['uuid'].is_a?(String)
192 Rails.logger.warn "remote authentication rejected: remote_user=#{remote_user.inspect}"
196 remote_user_prefix = remote_user['uuid'][0..4]
198 # Clusters can only authenticate for their own users.
199 if remote_user_prefix != token_uuid_prefix
200 Rails.logger.warn "remote authentication rejected: claimed remote user #{remote_user_prefix} but token was issued by #{token_uuid_prefix}"
204 # Invariant: remote_user_prefix == token_uuid_prefix
205 # therefore: remote_user_prefix != Rails.configuration.ClusterID
207 # Add or update user and token in local database so we can
208 # validate subsequent requests faster.
210 user = User.find_by_uuid(remote_user['uuid'])
213 # Create a new record for this user.
214 user = User.new(uuid: remote_user['uuid'],
217 email: remote_user['email'],
218 owner_uuid: system_user_uuid)
219 user.set_initial_username(requested: remote_user['username'])
223 if remote_user_prefix == Rails.configuration.Login.LoginCluster
224 # Remote cluster controls our user database, copy both
225 # 'is_active' and 'is_admin'
226 user.is_active = remote_user['is_active']
227 user.is_admin = remote_user['is_admin']
229 if Rails.configuration.Users.NewUsersAreActive ||
230 Rails.configuration.RemoteClusters[remote_user_prefix].andand["ActivateUsers"]
231 # Default policy is to activate users, so match activate
232 # with the remote record.
233 user.is_active = remote_user['is_active']
234 elsif !remote_user['is_active']
235 # Deactivate user if the remote is inactive, otherwise don't
236 # change 'is_active'.
237 user.is_active = false
241 %w[first_name last_name email prefs].each do |attr|
242 user.send(attr+'=', remote_user[attr])
245 act_as_system_user do
248 # We will accept this token (and avoid reloading the user
249 # record) for 'RemoteTokenRefresh' (default 5 minutes).
251 # Request the actual api_client_auth record from the remote
252 # server in case it wants the token to expire sooner.
253 auth = ApiClientAuthorization.find_or_create_by(uuid: token_uuid) do |auth|
255 auth.api_client_id = 0
257 auth.update_attributes!(user: user,
260 expires_at: Time.now + Rails.configuration.Login.RemoteTokenRefresh)
264 # token is not a 'v2' token
265 auth = ApiClientAuthorization.
266 includes(:user, :api_client).
267 where('api_token=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', token).
286 'v2/' + uuid + '/' + api_token
289 def salted_token(remote:)
293 'v2/' + uuid + '/' + OpenSSL::HMAC.hexdigest('sha1', api_token, remote)
298 def permission_to_create
299 current_user.andand.is_admin or (current_user.andand.id == self.user_id)
302 def permission_to_update
303 permission_to_create && !uuid_changed? &&
304 (current_user.andand.is_admin || !user_id_changed?)
308 super unless (changed - UNLOGGED_CHANGES).empty?