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.check_system_root_token token
 112     if token == Rails.configuration.SystemRootToken
 113       return ApiClientAuthorization.new(user: User.find_by_uuid(system_user_uuid),
 114                                         uuid: Rails.configuration.ClusterID+"-gj3su-000000000000000",
 115                                         api_token: token,
 116                                         api_client: ApiClient.new(is_trusted: true, url_prefix: ""))
 117     else
 118       return nil
 119     end
 120   end
 121
 122   def self.validate(token:, remote: nil)
 123     return nil if token.nil? or token.empty?
 124     remote ||= Rails.configuration.ClusterID
 125
 126     auth = self.check_system_root_token(token)
 127     if !auth.nil?
 128       return auth
 129     end
 130
 131     case token[0..2]
 132     when 'v2/'
 133       _, token_uuid, secret, optional = token.split('/')
 134       unless token_uuid.andand.length == 27 && secret.andand.length.andand > 0
 135         return nil
 136       end
 137
 138       if !optional.nil?
 139         # if "optional" is a container uuid, check that it
 140         # matches expections.
 141         c = Container.where(uuid: optional).first
 142         if !c.nil?
 143           if !c.auth_uuid.nil? and c.auth_uuid != token_uuid
 144             # token doesn't match the container's token
 145             return nil
 146           end
 147           if !c.runtime_token.nil? and "v2/#{token_uuid}/#{secret}" != c.runtime_token
 148             # token doesn't match the container's token
 149             return nil
 150           end
 151           if ![Container::Locked, Container::Running].include?(c.state)
 152             # container isn't locked or running, token shouldn't be used
 153             return nil
 154           end
 155         end
 156       end
 157
 158       # fast path: look up the token in the local database
 159       auth = ApiClientAuthorization.
 160              includes(:user, :api_client).
 161              where('uuid=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', token_uuid).
 162              first
 163       if auth && auth.user &&
 164          (secret == auth.api_token ||
 165           secret == OpenSSL::HMAC.hexdigest('sha1', auth.api_token, remote))
 166         # found it
 167         if token_uuid[0..4] != Rails.configuration.ClusterID
 168           Rails.logger.debug "found cached remote token #{token_uuid} with secret #{secret} in local db"
 169         end
 170         return auth
 171       end
 172
 173       token_uuid_prefix = token_uuid[0..4]
 174       if token_uuid_prefix == Rails.configuration.ClusterID
 175         # Token is supposedly issued by local cluster, but if the
 176         # token were valid, we would have been found in the database
 177         # in the above query.
 178         return nil
 179       elsif token_uuid_prefix.length != 5
 180         # malformed
 181         return nil
 182       end
 183
 184       # Invariant: token_uuid_prefix != Rails.configuration.ClusterID
 185       #
 186       # In other words the remaing code in this method below is the
 187       # case that determines whether to accept a token that was issued
 188       # by a remote cluster when the token absent or expired in our
 189       # database.  To begin, we need to ask the cluster that issued
 190       # the token to [re]validate it.
 191       clnt = ApiClientAuthorization.make_http_client(uuid_prefix: token_uuid_prefix)
 192
 193       host = remote_host(uuid_prefix: token_uuid_prefix)
 194       if !host
 195         Rails.logger.warn "remote authentication rejected: no host for #{token_uuid_prefix.inspect}"
 196         return nil
 197       end
 198
 199       begin
 200         remote_user = SafeJSON.load(
 201           clnt.get_content('https://' + host + '/arvados/v1/users/current',
 202                            {'remote' => Rails.configuration.ClusterID},
 203                            {'Authorization' => 'Bearer ' + token}))
 204       rescue => e
 205         Rails.logger.warn "remote authentication with token #{token.inspect} failed: #{e}"
 206         return nil
 207       end
 208
 209       # Check the response is well formed.
 210       if !remote_user.is_a?(Hash) || !remote_user['uuid'].is_a?(String)
 211         Rails.logger.warn "remote authentication rejected: remote_user=#{remote_user.inspect}"
 212         return nil
 213       end
 214
 215       remote_user_prefix = remote_user['uuid'][0..4]
 216
 217       # Clusters can only authenticate for their own users.
 218       if remote_user_prefix != token_uuid_prefix
 219         Rails.logger.warn "remote authentication rejected: claimed remote user #{remote_user_prefix} but token was issued by #{token_uuid_prefix}"
 220         return nil
 221       end
 222
 223       # Invariant:    remote_user_prefix == token_uuid_prefix
 224       # therefore:    remote_user_prefix != Rails.configuration.ClusterID
 225
 226       # Add or update user and token in local database so we can
 227       # validate subsequent requests faster.
 228
 229       user = User.find_by_uuid(remote_user['uuid'])
 230
 231       if !user
 232         # Create a new record for this user.
 233         user = User.new(uuid: remote_user['uuid'],
 234                         is_active: false,
 235                         is_admin: false,
 236                         email: remote_user['email'],
 237                         owner_uuid: system_user_uuid)
 238         user.set_initial_username(requested: remote_user['username'])
 239       end
 240
 241       # Sync user record.
 242       if remote_user_prefix == Rails.configuration.Login.LoginCluster
 243         # Remote cluster controls our user database, set is_active if
 244         # remote is active.  If remote is not active, user will be
 245         # unsetup (see below).
 246         user.is_active = true if remote_user['is_active']
 247         user.is_admin = remote_user['is_admin']
 248       else
 249         if Rails.configuration.Users.NewUsersAreActive ||
 250            Rails.configuration.RemoteClusters[remote_user_prefix].andand["ActivateUsers"]
 251           # Default policy is to activate users
 252           user.is_active = true if remote_user['is_active']
 253         end
 254       end
 255
 256       %w[first_name last_name email prefs].each do |attr|
 257         user.send(attr+'=', remote_user[attr])
 258       end
 259
 260       act_as_system_user do
 261         if user.is_active && !remote_user['is_active']
 262           user.unsetup
 263         end
 264
 265         user.save!
 266
 267         # We will accept this token (and avoid reloading the user
 268         # record) for 'RemoteTokenRefresh' (default 5 minutes).
 269         # Possible todo:
 270         # Request the actual api_client_auth record from the remote
 271         # server in case it wants the token to expire sooner.
 272         auth = ApiClientAuthorization.find_or_create_by(uuid: token_uuid) do |auth|
 273           auth.user = user
 274           auth.api_client_id = 0
 275         end
 276         auth.update_attributes!(user: user,
 277                                 api_token: secret,
 278                                 api_client_id: 0,
 279                                 expires_at: Time.now + Rails.configuration.Login.RemoteTokenRefresh)
 280         Rails.logger.debug "cached remote token #{token_uuid} with secret #{secret} in local db"
 281       end
 282       return auth
 283     else
 284       # token is not a 'v2' token
 285       auth = ApiClientAuthorization.
 286                includes(:user, :api_client).
 287                where('api_token=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', token).
 288                first
 289       if auth && auth.user
 290         return auth
 291       end
 292     end
 293
 294     return nil
 295   end
 296
 297   def token
 298     v2token
 299   end
 300
 301   def v1token
 302     api_token
 303   end
 304
 305   def v2token
 306     'v2/' + uuid + '/' + api_token
 307   end
 308
 309   def salted_token(remote:)
 310     if remote.nil?
 311       token
 312     end
 313     'v2/' + uuid + '/' + OpenSSL::HMAC.hexdigest('sha1', api_token, remote)
 314   end
 315
 316   protected
 317
 318   def permission_to_create
 319     current_user.andand.is_admin or (current_user.andand.id == self.user_id)
 320   end
 321
 322   def permission_to_update
 323     permission_to_create && !uuid_changed? &&
 324       (current_user.andand.is_admin || !user_id_changed?)
 325   end
 326
 327   def log_update
 328     super unless (changed - UNLOGGED_CHANGES).empty?
 329   end
 330 end