Skip to content

feat(auth): implement SigV4 authentication for REST catalog#616

Open
plusplusjiajia wants to merge 4 commits intoapache:mainfrom
plusplusjiajia:sigv4
Open

feat(auth): implement SigV4 authentication for REST catalog#616
plusplusjiajia wants to merge 4 commits intoapache:mainfrom
plusplusjiajia:sigv4

Conversation

@plusplusjiajia
Copy link
Copy Markdown
Member

Implement AWS SigV4 authentication for the REST catalog client, following Java's RESTSigV4AuthManager and RESTSigV4AuthSession.

  • Extend AuthSession::Authenticate() with HTTPRequestContext (method, url, body) for SigV4 request signing
  • Add SigV4AuthSession: delegate-first auth → relocate conflicting Authorization header → sign with AWS SDK
  • Add SigV4AuthManager: wraps delegate AuthManager (default OAuth2), resolves credentials from properties or default chain
  • Body hash matches Java's SignerChecksumParams output: empty body → hex EMPTY_BODY_SHA256; non-empty body → Base64(SHA256(body))

@plusplusjiajia plusplusjiajia force-pushed the sigv4 branch 5 times, most recently from bfc98f7 to 9ddbdbd Compare April 11, 2026 09:35
@plusplusjiajia plusplusjiajia force-pushed the sigv4 branch 3 times, most recently from 915c87b to d1c0732 Compare April 11, 2026 11:00
Comment on lines +120 to +121
ICEBERG_PRECHECK(delegate_type != AuthProperties::kAuthTypeSigV4,
"Cannot delegate a SigV4 auth manager to another SigV4 auth manager");
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add delegate_type in error message?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add delegate_type in error message?

Good idea, done.

- name: Install dependencies
shell: bash
run: sudo apt-get update && sudo apt-get install -y libcurl4-openssl-dev
run: sudo apt-get update && sudo apt-get install -y libcurl4-openssl-dev ninja-build
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

n00b question why is ninja-build required here?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question — I added a build step in this PR so the linter can see the SigV4 code (needs compile_commands.json from a real build). I used cmake -G Ninja for speed and to be consistent with the other CI workflows, and Ninja is not preinstalled on ubuntu-24.04, hence the extra ninja-build package. Happy to switch to Make if you'd prefer.

Comment on lines +252 to +260
if (session_token_it != properties.end() && !session_token_it->second.empty()) {
Aws::Auth::AWSCredentials credentials(access_key_it->second.c_str(),
secret_key_it->second.c_str(),
session_token_it->second.c_str());
return std::make_shared<Aws::Auth::SimpleAWSCredentialsProvider>(credentials);
}
Aws::Auth::AWSCredentials credentials(access_key_it->second.c_str(),
secret_key_it->second.c_str());
return std::make_shared<Aws::Auth::SimpleAWSCredentialsProvider>(credentials);
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: could do only one return if Credentials are created in the conditional statement.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: could do only one return if Credentials are created in the conditional statement.

Nice catch, done.

Comment on lines +287 to +290
auto it = properties.find(AuthProperties::kSigV4SigningName);
if (it != properties.end() && !it->second.empty()) {
return it->second;
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if(properties.count(AuthProperties::kSigV4SigningName) > 0) {
   // do work
}

might be a little less verbose than

 auto it = properties.find(AuthProperties::kSigV4SigningName);
  if (it != properties.end() && !it->second.empty()) {
    return it->second;
  }

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion! I chose to keep the !it->second.empty() check on purpose — the intent is for an explicitly-empty value (e.g., a env var set to "") to also fall through to the legacy key / default.

const TableIdentifier& table,
const std::unordered_map<std::string, std::string>& properties,
std::shared_ptr<AuthSession> parent) {
auto* sigv4_parent = dynamic_cast<SigV4AuthSession*>(parent.get());
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use checked_pointer_cast instead

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use checked_pointer_cast instead

Done here as well.

Result<std::shared_ptr<AuthSession>> SigV4AuthManager::ContextualSession(
const std::unordered_map<std::string, std::string>& context,
std::shared_ptr<AuthSession> parent) {
auto* sigv4_parent = dynamic_cast<SigV4AuthSession*>(parent.get());
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use checked_pointer_cast

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use checked_pointer_cast

Thanks, that's much better! Done.

std::string signing_region_;
std::string signing_name_;
std::shared_ptr<Aws::Auth::AWSCredentialsProvider> credentials_provider_;
/// Shared signer instance, matching Java's single Aws4Signer per manager.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find this comment a bit confusing especially given that signer_ is a unique pointer that will be destroyed when SigV4AuthSession is destructed

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, sorry about the confusion — the "shared signer" wording was misleading since signer_ is owned per-session via unique_ptr. I've removed the comment.


std::unordered_map<std::string, std::string> headers;
ASSERT_THAT(session_result.value()->Authenticate(headers), IsOk());
ASSERT_THAT(session_result.value()->Authenticate(headers, {}), IsOk());
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it feels like Authenticate coudl accept a default value for the second parameter

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, thanks! Done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants