oauth2_util.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#pragma once
 
#include <cstdint>
#include <optional>
#include <string>
#include <string_view>
#include <unordered_map>
 
#include "iceberg/catalog/rest/iceberg_rest_export.h"
#include "iceberg/catalog/rest/type_fwd.h"
#include "iceberg/catalog/rest/types.h"
#include "iceberg/result.h"
 
 
namespace iceberg::rest::auth {
 
class ICEBERG_REST_EXPORT OAuth2Util {
 public:
  OAuth2Util() = delete;
 
  static Result<OAuthTokenResponse> FetchToken(HttpClient& client, AuthSession& session,
                                               const AuthProperties& properties);
 
  static std::unordered_map<std::string, std::string> AuthHeaders(
      const std::string& token);
 
  static Result<OAuthTokenResponse> ExchangeToken(
      HttpClient& client, AuthSession& session,
      const std::unordered_map<std::string, std::string>& extra_headers,
      const std::string& subject_token, const std::string& subject_token_type,
      const std::optional<std::string>& actor_token,
      const std::optional<std::string>& actor_token_type, const std::string& scope,
      const std::string& oauth2_server_uri,
      const std::unordered_map<std::string, std::string>& optional_params);
 
  static std::optional<int64_t> ExpiresAtMillis(std::string_view token);
 
 private:
  static Result<std::unordered_map<std::string, std::string>> TokenExchangeRequest(
      const std::string& subject_token, const std::string& subject_token_type,
      const std::optional<std::string>& actor_token,
      const std::optional<std::string>& actor_token_type, const std::string& scope,
      const std::unordered_map<std::string, std::string>& optional_params);
};
 
}  // namespace iceberg::rest::auth