auth_session.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 <memory>
#include <optional>
#include <string>
#include <unordered_map>
 
#include "iceberg/catalog/rest/http_request.h"
#include "iceberg/catalog/rest/iceberg_rest_export.h"
#include "iceberg/catalog/rest/type_fwd.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
 
 
namespace iceberg::rest::auth {
 
struct ICEBERG_REST_EXPORT OAuth2SessionInfo {
  std::string token;
  std::string issued_token_type;
  std::string credential;
  std::string scope;
  std::string oauth2_server_uri;
  std::unordered_map<std::string, std::string> optional_oauth_params;
  std::unordered_map<std::string, std::string> headers;
};
 
class ICEBERG_REST_EXPORT AuthSession {
 public:
  virtual ~AuthSession() = default;
 
  virtual Result<HttpRequest> Authenticate(HttpRequest request) = 0;
 
  virtual std::optional<OAuth2SessionInfo> OAuth2Info() const { return std::nullopt; }
 
  virtual Status Close() { return {}; }
 
  static std::shared_ptr<AuthSession> MakeDefault(
      std::unordered_map<std::string, std::string> headers);
 
  static Result<std::shared_ptr<AuthSession>> MakeOAuth2(
      const OAuthTokenResponse& initial_token, const std::string& token_endpoint,
      const std::string& client_id, const std::string& client_secret,
      const std::string& scope, bool keep_refreshed,
      const std::unordered_map<std::string, std::string>& optional_oauth_params,
      std::shared_ptr<HttpClient> client, Executor* auth_executor = nullptr);
};
 
}  // namespace iceberg::rest::auth