services/api/app/models/api_client_authorization.rb

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 class ApiClientAuthorization < ArvadosModel
   6   include HasUuid
   7   include KindAndEtag
   8   include CommonApiTemplate
   9   extend CurrentApiClient
  10
  11   belongs_to :api_client
  12   belongs_to :user
  13   after_initialize :assign_random_api_token
  14   serialize :scopes, Array
  15
  16   api_accessible :user, extend: :common do |t|
  17     t.add :owner_uuid
  18     t.add :user_id
  19     t.add :api_client_id
  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".
  23     t.add :api_token
  24     t.add :created_by_ip_address
  25     t.add :default_owner_uuid
  26     t.add :expires_at
  27     t.add :last_used_at
  28     t.add :last_used_by_ip_address
  29     t.add :scopes
  30   end
  31
  32   UNLOGGED_CHANGES = ['last_used_at', 'last_used_by_ip_address', 'updated_at']
  33
  34   def assign_random_api_token
  35     self.api_token ||= rand(2**256).to_s(36)
  36   end
  37
  38   def owner_uuid
  39     self.user.andand.uuid
  40   end
  41   def owner_uuid_was
  42     self.user_id_changed? ? User.where(id: self.user_id_was).first.andand.uuid : self.user.andand.uuid
  43   end
  44   def owner_uuid_changed?
  45     self.user_id_changed?
  46   end
  47
  48   def modified_by_client_uuid
  49     nil
  50   end
  51   def modified_by_client_uuid=(x) end
  52
  53   def modified_by_user_uuid
  54     nil
  55   end
  56   def modified_by_user_uuid=(x) end
  57
  58   def modified_at
  59     nil
  60   end
  61   def modified_at=(x) end
  62
  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))
  67     end
  68     false
  69   end
  70
  71   def scopes_allow_request?(request)
  72     method = request.request_method
  73     if method == 'HEAD'
  74       (scopes_allow?(['HEAD', request.path].join(' ')) ||
  75        scopes_allow?(['GET', request.path].join(' ')))
  76     else
  77       scopes_allow?([method, request.path].join(' '))
  78     end
  79   end
  80
  81   def logged_attributes
  82     super.except 'api_token'
  83   end
  84
  85   def self.default_orders
  86     ["#{table_name}.id desc"]
  87   end
  88
  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")
  93   end
  94
  95   def self.make_http_client(uuid_prefix:)
  96     clnt = HTTPClient.new
  97
  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
 101     else
 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) }
 107     end
 108     clnt
 109   end
 110
 111   def self.validate(token:, remote: nil)
 112     return nil if !token
 113     remote ||= Rails.configuration.ClusterID
 114
 115     case token[0..2]
 116     when 'v2/'
 117       _, token_uuid, secret, optional = token.split('/')
 118       unless token_uuid.andand.length == 27 && secret.andand.length.andand > 0
 119         return nil
 120       end
 121
 122       if !optional.nil?
 123         # if "optional" is a container uuid, check that it
 124         # matches expections.
 125         c = Container.where(uuid: optional).first
 126         if !c.nil?
 127           if !c.auth_uuid.nil? and c.auth_uuid != token_uuid
 128             # token doesn't match the container's token
 129             return nil
 130           end
 131           if !c.runtime_token.nil? and "v2/#{token_uuid}/#{secret}" != c.runtime_token
 132             # token doesn't match the container's token
 133             return nil
 134           end
 135           if ![Container::Locked, Container::Running].include?(c.state)
 136             # container isn't locked or running, token shouldn't be used
 137             return nil
 138           end
 139         end
 140       end
 141
 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).
 146              first
 147       if auth && auth.user &&
 148          (secret == auth.api_token ||
 149           secret == OpenSSL::HMAC.hexdigest('sha1', auth.api_token, remote))
 150         # found it
 151         return auth
 152       end
 153
 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.
 159         return nil
 160       elsif token_uuid_prefix.length != 5
 161         # malformed
 162         return nil
 163       end
 164
 165       # Invariant: token_uuid_prefix != Rails.configuration.ClusterID
 166       #
 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)
 173
 174       host = remote_host(uuid_prefix: token_uuid_prefix)
 175       if !host
 176         Rails.logger.warn "remote authentication rejected: no host for #{token_uuid_prefix.inspect}"
 177         return nil
 178       end
 179
 180       begin
 181         remote_user = SafeJSON.load(
 182           clnt.get_content('https://' + host + '/arvados/v1/users/current',
 183                            {'remote' => Rails.configuration.ClusterID},
 184                            {'Authorization' => 'Bearer ' + token}))
 185       rescue => e
 186         Rails.logger.warn "remote authentication with token #{token.inspect} failed: #{e}"
 187         return nil
 188       end
 189
 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}"
 193         return nil
 194       end
 195
 196       remote_user_prefix = remote_user['uuid'][0..4]
 197
 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}"
 201         return nil
 202       end
 203
 204       # Invariant:    remote_user_prefix == token_uuid_prefix
 205       # therefore:    remote_user_prefix != Rails.configuration.ClusterID
 206
 207       # Add or update user and token in local database so we can
 208       # validate subsequent requests faster.
 209
 210       user = User.find_by_uuid(remote_user['uuid'])
 211
 212       if !user
 213         # Create a new record for this user.
 214         user = User.new(uuid: remote_user['uuid'],
 215                         is_active: false,
 216                         is_admin: false,
 217                         email: remote_user['email'],
 218                         owner_uuid: system_user_uuid)
 219         user.set_initial_username(requested: remote_user['username'])
 220       end
 221
 222       # Sync user record.
 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']
 228       else
 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
 238         end
 239       end
 240
 241       %w[first_name last_name email prefs].each do |attr|
 242         user.send(attr+'=', remote_user[attr])
 243       end
 244
 245       act_as_system_user do
 246         user.save!
 247
 248         # We will accept this token (and avoid reloading the user
 249         # record) for 'RemoteTokenRefresh' (default 5 minutes).
 250         # Possible todo:
 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|
 254           auth.user = user
 255           auth.api_client_id = 0
 256         end
 257         auth.update_attributes!(user: user,
 258                                 api_token: secret,
 259                                 api_client_id: 0,
 260                                 expires_at: Time.now + Rails.configuration.Login.RemoteTokenRefresh)
 261       end
 262       return auth
 263     else
 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).
 268                first
 269       if auth && auth.user
 270         return auth
 271       end
 272     end
 273
 274     return nil
 275   end
 276
 277   def token
 278     v2token
 279   end
 280
 281   def v1token
 282     api_token
 283   end
 284
 285   def v2token
 286     'v2/' + uuid + '/' + api_token
 287   end
 288
 289   def salted_token(remote:)
 290     if remote.nil?
 291       token
 292     end
 293     'v2/' + uuid + '/' + OpenSSL::HMAC.hexdigest('sha1', api_token, remote)
 294   end
 295
 296   protected
 297
 298   def permission_to_create
 299     current_user.andand.is_admin or (current_user.andand.id == self.user_id)
 300   end
 301
 302   def permission_to_update
 303     permission_to_create && !uuid_changed? &&
 304       (current_user.andand.is_admin || !user_id_changed?)
 305   end
 306
 307   def log_update
 308     super unless (changed - UNLOGGED_CHANGES).empty?
 309   end
 310 end