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.remote_hosts[uuid_prefix] ||
  91       (Rails.configuration.remote_hosts_via_dns &&
  92        uuid_prefix+".arvadosapi.com")
  93   end
  94
  95   # Delete token, if remote, attempt to delete on the host as well.
  96   def expire_destroy
  97       uuid_prefix = self.uuid[0..4]
  98       if uuid_prefix != Rails.configuration.uuid_prefix
  99         # remote token
 100         host = remote_host(uuid_prefix: uuid_prefix)
 101         begin
 102           clnt = HTTPClient.new
 103           if Rails.configuration.sso_insecure
 104             clnt.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
 105           end
 106           result = SafeJSON.load(
 107             clnt.delete('https://' + host + '/arvados/v1/users/current',
 108                         {'Authorization' => 'Bearer ' + token}))
 109         rescue => e
 110           Rails.logger.warn "deleting remote token #{self.uuid} failed: #{e}"
 111         end
 112       end
 113       destroy
 114   end
 115
 116   def self.validate(token:, remote: nil)
 117     return nil if !token
 118     remote ||= Rails.configuration.uuid_prefix
 119
 120     case token[0..2]
 121     when 'v2/'
 122       _, uuid, secret = token.split('/')
 123       unless uuid.andand.length == 27 && secret.andand.length.andand > 0
 124         return nil
 125       end
 126
 127       auth = ApiClientAuthorization.
 128              includes(:user, :api_client).
 129              where('uuid=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', uuid).
 130              first
 131       if auth && auth.user &&
 132          (secret == auth.api_token ||
 133           secret == OpenSSL::HMAC.hexdigest('sha1', auth.api_token, remote))
 134         return auth
 135       end
 136
 137       uuid_prefix = uuid[0..4]
 138       if uuid_prefix == Rails.configuration.uuid_prefix
 139         # If the token were valid, we would have validated it above
 140         return nil
 141       elsif uuid_prefix.length != 5
 142         # malformed
 143         return nil
 144       end
 145
 146       host = remote_host(uuid_prefix: uuid_prefix)
 147       if !host
 148         Rails.logger.warn "remote authentication rejected: no host for #{uuid_prefix.inspect}"
 149         return nil
 150       end
 151
 152       # Token was issued by a different cluster. If it's expired or
 153       # missing in our database, ask the originating cluster to
 154       # [re]validate it.
 155       begin
 156         clnt = HTTPClient.new
 157         if Rails.configuration.sso_insecure
 158           clnt.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
 159         end
 160         remote_user = SafeJSON.load(
 161           clnt.get_content('https://' + host + '/arvados/v1/users/current',
 162                            {'remote' => Rails.configuration.uuid_prefix},
 163                            {'Authorization' => 'Bearer ' + token}))
 164       rescue => e
 165         Rails.logger.warn "remote authentication with token #{token.inspect} failed: #{e}"
 166         return nil
 167       end
 168       if !remote_user.is_a?(Hash) || !remote_user['uuid'].is_a?(String) || remote_user['uuid'][0..4] != uuid[0..4]
 169         Rails.logger.warn "remote authentication rejected: remote_user=#{remote_user.inspect}"
 170         return nil
 171       end
 172       act_as_system_user do
 173         # Add/update user and token in our database so we can
 174         # validate subsequent requests faster.
 175
 176         user = User.find_or_create_by(uuid: remote_user['uuid']) do |user|
 177           # (this block runs for the "create" case, not for "find")
 178           user.is_admin = false
 179           user.email = remote_user['email']
 180           if remote_user['username'].andand.length.andand > 0
 181             user.set_initial_username(requested: remote_user['username'])
 182           end
 183         end
 184
 185         if Rails.configuration.new_users_are_active ||
 186            Rails.configuration.auto_activate_users_from.include?(remote_user['uuid'][0..4])
 187           # Update is_active to whatever it is at the remote end
 188           user.is_active = remote_user['is_active']
 189         elsif !remote_user['is_active']
 190           # Remote user is inactive; our mirror should be, too.
 191           user.is_active = false
 192         end
 193
 194         %w[first_name last_name email prefs].each do |attr|
 195           user.send(attr+'=', remote_user[attr])
 196         end
 197
 198         user.save!
 199
 200         auth = ApiClientAuthorization.find_or_create_by(uuid: uuid) do |auth|
 201           auth.user = user
 202           auth.api_token = secret
 203           auth.api_client_id = 0
 204         end
 205
 206         # Accept this token (and don't reload the user record) for
 207         # 5 minutes. TODO: Request the actual api_client_auth
 208         # record from the remote server in case it wants the token
 209         # to expire sooner.
 210         auth.update_attributes!(user: user,
 211                                 api_token: secret,
 212                                 api_client_id: 0,
 213                                 expires_at: Time.now + 5.minutes)
 214       end
 215       return auth
 216     else
 217       auth = ApiClientAuthorization.
 218              includes(:user, :api_client).
 219              where('api_token=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', token).
 220              first
 221       if auth && auth.user
 222         return auth
 223       end
 224     end
 225     return nil
 226   end
 227
 228   def token
 229     v2token
 230   end
 231
 232   def v1token
 233     api_token
 234   end
 235
 236   def v2token
 237     'v2/' + uuid + '/' + api_token
 238   end
 239
 240   protected
 241
 242   def permission_to_create
 243     current_user.andand.is_admin or (current_user.andand.id == self.user_id)
 244   end
 245
 246   def permission_to_update
 247     permission_to_create && !uuid_changed? &&
 248       (current_user.andand.is_admin || !user_id_changed?)
 249   end
 250
 251   def log_update
 252     super unless (changed - UNLOGGED_CHANGES).empty?
 253   end
 254 end