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   extend DbCurrentTime
  11
  12   belongs_to :api_client
  13   belongs_to :user
  14   after_initialize :assign_random_api_token
  15   serialize :scopes, Array
  16
  17   before_validation :clamp_token_expiration
  18
  19   api_accessible :user, extend: :common do |t|
  20     t.add :owner_uuid
  21     t.add :user_id
  22     t.add :api_client_id
  23     # NB the "api_token" db column is a misnomer in that it's only the
  24     # "secret" part of a token: a v1 token is just the secret, but a
  25     # v2 token is "v2/uuid/secret".
  26     t.add :api_token
  27     t.add :created_by_ip_address
  28     t.add :default_owner_uuid
  29     t.add :expires_at
  30     t.add :last_used_at
  31     t.add :last_used_by_ip_address
  32     t.add :scopes
  33   end
  34
  35   UNLOGGED_CHANGES = ['last_used_at', 'last_used_by_ip_address', 'updated_at']
  36
  37   def assign_random_api_token
  38     self.api_token ||= rand(2**256).to_s(36)
  39   end
  40
  41   def owner_uuid
  42     self.user.andand.uuid
  43   end
  44   def owner_uuid_was
  45     self.user_id_changed? ? User.where(id: self.user_id_was).first.andand.uuid : self.user.andand.uuid
  46   end
  47   def owner_uuid_changed?
  48     self.user_id_changed?
  49   end
  50
  51   def modified_by_client_uuid
  52     nil
  53   end
  54   def modified_by_client_uuid=(x) end
  55
  56   def modified_by_user_uuid
  57     nil
  58   end
  59   def modified_by_user_uuid=(x) end
  60
  61   def modified_at
  62     nil
  63   end
  64   def modified_at=(x) end
  65
  66   def scopes_allow?(req_s)
  67     scopes.each do |scope|
  68       return true if (scope == 'all') or (scope == req_s) or
  69         ((scope.end_with? '/') and (req_s.start_with? scope))
  70     end
  71     false
  72   end
  73
  74   def scopes_allow_request?(request)
  75     method = request.request_method
  76     if method == 'HEAD'
  77       (scopes_allow?(['HEAD', request.path].join(' ')) ||
  78        scopes_allow?(['GET', request.path].join(' ')))
  79     else
  80       scopes_allow?([method, request.path].join(' '))
  81     end
  82   end
  83
  84   def logged_attributes
  85     super.except 'api_token'
  86   end
  87
  88   def self.default_orders
  89     ["#{table_name}.id desc"]
  90   end
  91
  92   def self.remote_host(uuid_prefix:)
  93     (Rails.configuration.RemoteClusters[uuid_prefix].andand["Host"]) ||
  94       (Rails.configuration.RemoteClusters["*"]["Proxy"] &&
  95        uuid_prefix+".arvadosapi.com")
  96   end
  97
  98   def self.make_http_client(uuid_prefix:)
  99     clnt = HTTPClient.new
 100
 101     if uuid_prefix && (Rails.configuration.RemoteClusters[uuid_prefix].andand.Insecure ||
 102                        Rails.configuration.RemoteClusters['*'].andand.Insecure)
 103       clnt.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
 104     else
 105       # Use system CA certificates
 106       ["/etc/ssl/certs/ca-certificates.crt",
 107        "/etc/pki/tls/certs/ca-bundle.crt"]
 108         .select { |ca_path| File.readable?(ca_path) }
 109         .each { |ca_path| clnt.ssl_config.add_trust_ca(ca_path) }
 110     end
 111     clnt
 112   end
 113
 114   def self.check_anonymous_user_token token
 115     if token.length >= 50 and token == Rails.configuration.Users.AnonymousUserToken
 116       return ApiClientAuthorization.new(user: User.find_by_uuid(anonymous_user_uuid),
 117                                         uuid: Rails.configuration.ClusterID+"-gj3su-anonymouspublic",
 118                                         api_token: token,
 119                                         api_client: anonymous_user_token_api_client)
 120     else
 121       return nil
 122     end
 123   end
 124
 125   def self.check_system_root_token token
 126     if token == Rails.configuration.SystemRootToken
 127       return ApiClientAuthorization.new(user: User.find_by_uuid(system_user_uuid),
 128                                         uuid: Rails.configuration.ClusterID+"-gj3su-000000000000000",
 129                                         api_token: token,
 130                                         api_client: system_root_token_api_client)
 131     else
 132       return nil
 133     end
 134   end
 135
 136   def self.validate(token:, remote: nil)
 137     return nil if token.nil? or token.empty?
 138     remote ||= Rails.configuration.ClusterID
 139
 140     auth = self.check_anonymous_user_token(token)
 141     if !auth.nil?
 142       return auth
 143     end
 144
 145     auth = self.check_system_root_token(token)
 146     if !auth.nil?
 147       return auth
 148     end
 149
 150     token_uuid = ''
 151     secret = token
 152     stored_secret = nil         # ...if different from secret
 153     optional = nil
 154
 155     case token[0..2]
 156     when 'v2/'
 157       _, token_uuid, secret, optional = token.split('/')
 158       unless token_uuid.andand.length == 27 && secret.andand.length.andand > 0
 159         return nil
 160       end
 161
 162       if !optional.nil?
 163         # if "optional" is a container uuid, check that it
 164         # matches expections.
 165         c = Container.where(uuid: optional).first
 166         if !c.nil?
 167           if !c.auth_uuid.nil? and c.auth_uuid != token_uuid
 168             # token doesn't match the container's token
 169             return nil
 170           end
 171           if !c.runtime_token.nil? and "v2/#{token_uuid}/#{secret}" != c.runtime_token
 172             # token doesn't match the container's token
 173             return nil
 174           end
 175           if ![Container::Locked, Container::Running].include?(c.state)
 176             # container isn't locked or running, token shouldn't be used
 177             return nil
 178           end
 179         end
 180       end
 181
 182       # fast path: look up the token in the local database
 183       auth = ApiClientAuthorization.
 184              includes(:user, :api_client).
 185              where('uuid=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', token_uuid).
 186              first
 187       if auth && auth.user &&
 188          (secret == auth.api_token ||
 189           secret == OpenSSL::HMAC.hexdigest('sha1', auth.api_token, remote))
 190         # found it
 191         if token_uuid[0..4] != Rails.configuration.ClusterID
 192           Rails.logger.debug "found cached remote token #{token_uuid} with secret #{secret} in local db"
 193         end
 194         return auth
 195       end
 196
 197       upstream_cluster_id = token_uuid[0..4]
 198       if upstream_cluster_id == Rails.configuration.ClusterID
 199         # Token is supposedly issued by local cluster, but if the
 200         # token were valid, we would have been found in the database
 201         # in the above query.
 202         return nil
 203       elsif upstream_cluster_id.length != 5
 204         # malformed
 205         return nil
 206       end
 207
 208     else
 209       # token is not a 'v2' token. It could be just the secret part
 210       # ("v1 token") -- or it could be an OpenIDConnect access token,
 211       # in which case either (a) the controller will have inserted a
 212       # row with api_token = hmac(systemroottoken,oidctoken) before
 213       # forwarding it, or (b) we'll have done that ourselves, or (c)
 214       # we'll need to ask LoginCluster to validate it for us below,
 215       # and then insert a local row for a faster lookup next time.
 216       hmac = OpenSSL::HMAC.hexdigest('sha256', Rails.configuration.SystemRootToken, token)
 217       auth = ApiClientAuthorization.
 218                includes(:user, :api_client).
 219                where('api_token in (?, ?) and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', token, hmac).
 220                first
 221       if auth && auth.user
 222         return auth
 223       elsif !Rails.configuration.Login.LoginCluster.blank? && Rails.configuration.Login.LoginCluster != Rails.configuration.ClusterID
 224         # An unrecognized non-v2 token might be an OIDC Access Token
 225         # that can be verified by our login cluster in the code
 226         # below. If so, we'll stuff the database with hmac instead of
 227         # the real OIDC token.
 228         upstream_cluster_id = Rails.configuration.Login.LoginCluster
 229         stored_secret = hmac
 230       else
 231         return nil
 232       end
 233     end
 234
 235     # Invariant: upstream_cluster_id != Rails.configuration.ClusterID
 236     #
 237     # In other words the remaining code in this method decides
 238     # whether to accept a token that was issued by a remote cluster
 239     # when the token is absent or expired in our database.  To
 240     # begin, we need to ask the cluster that issued the token to
 241     # [re]validate it.
 242     clnt = ApiClientAuthorization.make_http_client(uuid_prefix: upstream_cluster_id)
 243
 244     host = remote_host(uuid_prefix: upstream_cluster_id)
 245     if !host
 246       Rails.logger.warn "remote authentication rejected: no host for #{upstream_cluster_id.inspect}"
 247       return nil
 248     end
 249
 250     begin
 251       remote_user = SafeJSON.load(
 252         clnt.get_content('https://' + host + '/arvados/v1/users/current',
 253                          {'remote' => Rails.configuration.ClusterID},
 254                          {'Authorization' => 'Bearer ' + token}))
 255     rescue => e
 256       Rails.logger.warn "remote authentication with token #{token.inspect} failed: #{e}"
 257       return nil
 258     end
 259
 260     # Check the response is well formed.
 261     if !remote_user.is_a?(Hash) || !remote_user['uuid'].is_a?(String)
 262       Rails.logger.warn "remote authentication rejected: remote_user=#{remote_user.inspect}"
 263       return nil
 264     end
 265
 266     remote_user_prefix = remote_user['uuid'][0..4]
 267
 268     # Get token scope, and make sure we use the same UUID as the
 269     # remote when caching the token.
 270     remote_token = nil
 271     begin
 272       remote_token = SafeJSON.load(
 273         clnt.get_content('https://' + host + '/arvados/v1/api_client_authorizations/current',
 274                          {'remote' => Rails.configuration.ClusterID},
 275                          {'Authorization' => 'Bearer ' + token}))
 276       Rails.logger.debug "retrieved remote token #{remote_token.inspect}"
 277       token_uuid = remote_token['uuid']
 278       if !token_uuid.match(HasUuid::UUID_REGEX) || token_uuid[0..4] != upstream_cluster_id
 279         raise "remote cluster #{upstream_cluster_id} returned invalid token uuid #{token_uuid.inspect}"
 280       end
 281     rescue HTTPClient::BadResponseError => e
 282       if e.res.status != 401
 283         raise
 284       end
 285       rev = SafeJSON.load(clnt.get_content('https://' + host + '/discovery/v1/apis/arvados/v1/rest'))['revision']
 286       if rev >= '20010101' && rev < '20210503'
 287         Rails.logger.warn "remote cluster #{upstream_cluster_id} at #{host} with api rev #{rev} does not provide token expiry and scopes; using scopes=['all']"
 288       else
 289         # remote server is new enough that it should have accepted
 290         # this request if the token was valid
 291         raise
 292       end
 293     rescue => e
 294       Rails.logger.warn "error getting remote token details for #{token.inspect}: #{e}"
 295       return nil
 296     end
 297
 298     # Clusters can only authenticate for their own users.
 299     if remote_user_prefix != upstream_cluster_id
 300       Rails.logger.warn "remote authentication rejected: claimed remote user #{remote_user_prefix} but token was issued by #{upstream_cluster_id}"
 301       return nil
 302     end
 303
 304     # Invariant:    remote_user_prefix == upstream_cluster_id
 305     # therefore:    remote_user_prefix != Rails.configuration.ClusterID
 306
 307     # Add or update user and token in local database so we can
 308     # validate subsequent requests faster.
 309
 310     if remote_user['uuid'][-22..-1] == '-tpzed-anonymouspublic'
 311       # Special case: map the remote anonymous user to local anonymous user
 312       remote_user['uuid'] = anonymous_user_uuid
 313     end
 314
 315     user = User.find_by_uuid(remote_user['uuid'])
 316
 317     if !user
 318       # Create a new record for this user.
 319       user = User.new(uuid: remote_user['uuid'],
 320                       is_active: false,
 321                       is_admin: false,
 322                       email: remote_user['email'],
 323                       owner_uuid: system_user_uuid)
 324       user.set_initial_username(requested: remote_user['username'])
 325     end
 326
 327     # Sync user record.
 328     act_as_system_user do
 329       %w[first_name last_name email prefs].each do |attr|
 330         user.send(attr+'=', remote_user[attr])
 331       end
 332
 333       if remote_user['uuid'][-22..-1] == '-tpzed-000000000000000'
 334         user.first_name = "root"
 335         user.last_name = "from cluster #{remote_user_prefix}"
 336       end
 337
 338       begin
 339         user.save!
 340       rescue ActiveRecord::RecordInvalid, ActiveRecord::RecordNotUnique
 341         Rails.logger.debug("remote user #{remote_user['uuid']} already exists, retrying...")
 342         # Some other request won the race: retry fetching the user record.
 343         user = User.find_by_uuid(remote_user['uuid'])
 344         if !user
 345           Rails.logger.warn("cannot find or create remote user #{remote_user['uuid']}")
 346           return nil
 347         end
 348       end
 349
 350       if user.is_invited && !remote_user['is_invited']
 351         # Remote user is not "invited" state, they should be unsetup, which
 352         # also makes them inactive.
 353         user.unsetup
 354       else
 355         if !user.is_invited && remote_user['is_invited'] and
 356           (remote_user_prefix == Rails.configuration.Login.LoginCluster or
 357            Rails.configuration.Users.AutoSetupNewUsers or
 358            Rails.configuration.Users.NewUsersAreActive or
 359            Rails.configuration.RemoteClusters[remote_user_prefix].andand["ActivateUsers"])
 360           user.setup
 361         end
 362
 363         if !user.is_active && remote_user['is_active'] && user.is_invited and
 364           (remote_user_prefix == Rails.configuration.Login.LoginCluster or
 365            Rails.configuration.Users.NewUsersAreActive or
 366            Rails.configuration.RemoteClusters[remote_user_prefix].andand["ActivateUsers"])
 367           user.update_attributes!(is_active: true)
 368         elsif user.is_active && !remote_user['is_active']
 369           user.update_attributes!(is_active: false)
 370         end
 371
 372         if remote_user_prefix == Rails.configuration.Login.LoginCluster and
 373           user.is_active and
 374           user.is_admin != remote_user['is_admin']
 375           # Remote cluster controls our user database, including the
 376           # admin flag.
 377           user.update_attributes!(is_admin: remote_user['is_admin'])
 378         end
 379       end
 380
 381       # If stored_secret is set, we save stored_secret in the database
 382       # but return the real secret to the caller. This way, if we end
 383       # up returning the auth record to the client, they see the same
 384       # secret they supplied, instead of the HMAC we saved in the
 385       # database.
 386       stored_secret = stored_secret || secret
 387
 388       # We will accept this token (and avoid reloading the user
 389       # record) for 'RemoteTokenRefresh' (default 5 minutes).
 390       exp = [db_current_time + Rails.configuration.Login.RemoteTokenRefresh,
 391              remote_token.andand['expires_at']].compact.min
 392       scopes = remote_token.andand['scopes'] || ['all']
 393       begin
 394         retries ||= 0
 395         auth = ApiClientAuthorization.find_or_create_by(uuid: token_uuid) do |auth|
 396           auth.user = user
 397           auth.api_token = stored_secret
 398           auth.api_client_id = 0
 399           auth.scopes = scopes
 400           auth.expires_at = exp
 401         end
 402       rescue ActiveRecord::RecordNotUnique
 403         Rails.logger.debug("cached remote token #{token_uuid} already exists, retrying...")
 404         # Some other request won the race: retry just once before erroring out
 405         if (retries += 1) <= 1
 406           retry
 407         else
 408           Rails.logger.warn("cannot find or create cached remote token #{token_uuid}")
 409           return nil
 410         end
 411       end
 412       auth.update_attributes!(user: user,
 413                               api_token: stored_secret,
 414                               api_client_id: 0,
 415                               scopes: scopes,
 416                               expires_at: exp)
 417       Rails.logger.debug "cached remote token #{token_uuid} with secret #{stored_secret} and scopes #{scopes} in local db"
 418       auth.api_token = secret
 419       return auth
 420     end
 421
 422     return nil
 423   end
 424
 425   def token
 426     v2token
 427   end
 428
 429   def v1token
 430     api_token
 431   end
 432
 433   def v2token
 434     'v2/' + uuid + '/' + api_token
 435   end
 436
 437   def salted_token(remote:)
 438     if remote.nil?
 439       token
 440     end
 441     'v2/' + uuid + '/' + OpenSSL::HMAC.hexdigest('sha1', api_token, remote)
 442   end
 443
 444   protected
 445
 446   def clamp_token_expiration
 447     if Rails.configuration.API.MaxTokenLifetime > 0
 448       max_token_expiration = db_current_time + Rails.configuration.API.MaxTokenLifetime
 449       if (self.new_record? || self.expires_at_changed?) && (self.expires_at.nil? || (self.expires_at > max_token_expiration && !current_user.andand.is_admin))
 450         self.expires_at = max_token_expiration
 451       end
 452     end
 453   end
 454
 455   def permission_to_create
 456     current_user.andand.is_admin or (current_user.andand.id == self.user_id)
 457   end
 458
 459   def permission_to_update
 460     permission_to_create && !uuid_changed? &&
 461       (current_user.andand.is_admin || !user_id_changed?)
 462   end
 463
 464   def log_update
 465     super unless (saved_changes.keys - UNLOGGED_CHANGES).empty?
 466   end
 467 end