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