feat(auth): implement SigV4 authentication for REST catalog #616
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| # 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. | ||
|
|
||
| # AWS-related tests. ICEBERG_S3 and ICEBERG_SIGV4 are exercised individually and | ||
| # together; with both on, Arrow's S3 reuses SigV4's system AWS SDK | ||
| # (AWSSDK_SOURCE=SYSTEM) so a single AWS SDK is linked (no ODR). | ||
| name: AWS Tests | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - '**' | ||
| - '!dependabot/**' | ||
| tags: | ||
| - '**' | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, ready_for_review] | ||
|
|
||
| concurrency: | ||
| group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }} | ||
| cancel-in-progress: true | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| env: | ||
| ICEBERG_HOME: /tmp/iceberg | ||
|
|
||
| jobs: | ||
| aws: | ||
| if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false }} | ||
| name: AWS (${{ matrix.title }}) | ||
| runs-on: ${{ matrix.runs-on }} | ||
| timeout-minutes: 45 | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| include: | ||
| - title: AMD64 Ubuntu 24.04, S3 | ||
| runs-on: ubuntu-24.04 | ||
| CC: gcc-14 | ||
| CXX: g++-14 | ||
| s3: "ON" | ||
| sigv4: "OFF" | ||
| - title: AMD64 Ubuntu 24.04, SigV4 | ||
| runs-on: ubuntu-24.04 | ||
| CC: gcc-14 | ||
| CXX: g++-14 | ||
| s3: "OFF" | ||
| sigv4: "ON" | ||
| aws-sdk-features: core | ||
| - title: AMD64 Ubuntu 24.04, S3 + SigV4 | ||
| runs-on: ubuntu-24.04 | ||
| CC: gcc-14 | ||
| CXX: g++-14 | ||
| s3: "ON" | ||
| sigv4: "ON" | ||
| # Arrow's S3 filesystem consumes this same AWS SDK, so it needs the | ||
| # S3-related components in addition to core (config is required by | ||
| # Arrow's FindAWSSDKAlt). | ||
| aws-sdk-features: core,config,s3,identity-management,sts,transfer | ||
| - title: AArch64 macOS 26, S3 | ||
| runs-on: macos-26 | ||
| s3: "ON" | ||
| sigv4: "OFF" | ||
| env: | ||
| ICEBERG_TEST_S3_URI: s3://iceberg-test | ||
| AWS_ACCESS_KEY_ID: minio | ||
| AWS_SECRET_ACCESS_KEY: minio123 | ||
| AWS_DEFAULT_REGION: us-east-1 | ||
| AWS_ENDPOINT_URL: http://127.0.0.1:9000 | ||
| AWS_EC2_METADATA_DISABLED: "TRUE" | ||
| steps: | ||
| - name: Checkout iceberg-cpp | ||
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
| with: | ||
| persist-credentials: false | ||
| - name: Install dependencies on Ubuntu | ||
| if: ${{ startsWith(matrix.runs-on, 'ubuntu') }} | ||
| shell: bash | ||
| run: sudo apt-get update && sudo apt-get install -y libcurl4-openssl-dev | ||
| - name: Cache vcpkg packages | ||
| if: ${{ matrix.sigv4 == 'ON' && matrix.s3 == 'OFF' }} | ||
| uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 | ||
| id: vcpkg-cache | ||
| with: | ||
| path: /usr/local/share/vcpkg/installed | ||
| key: vcpkg-x64-linux-aws-sdk-cpp-s3-${{ matrix.s3 }}-sigv4-${{ matrix.sigv4 }}-${{ hashFiles('.github/workflows/aws_test.yml') }} | ||
| - name: Install AWS SDK via vcpkg | ||
| if: ${{ matrix.sigv4 == 'ON' && matrix.s3 == 'OFF' && steps.vcpkg-cache.outputs.cache-hit != 'true' }} | ||
| shell: bash | ||
| # Retry to ride out transient GitHub/mirror download failures (504s). | ||
| run: | | ||
| for attempt in 1 2 3; do | ||
| if vcpkg install "aws-sdk-cpp[${{ matrix.aws-sdk-features }}]:x64-linux"; then | ||
| exit 0 | ||
| fi | ||
| echo "::warning::vcpkg install failed (attempt ${attempt}/3), retrying in 30s" | ||
| sleep 30 | ||
| done | ||
| echo "::error::vcpkg install failed after 3 attempts" | ||
| exit 1 | ||
| - name: Set Ubuntu Compilers | ||
| if: ${{ startsWith(matrix.runs-on, 'ubuntu') }} | ||
| run: | | ||
| echo "CC=${{ matrix.CC }}" >> $GITHUB_ENV | ||
| echo "CXX=${{ matrix.CXX }}" >> $GITHUB_ENV | ||
| - name: Start MinIO | ||
| if: ${{ matrix.s3 == 'ON' }} | ||
| shell: bash | ||
| run: bash ci/scripts/start_minio.sh | ||
| - name: Build and test Iceberg | ||
| shell: bash | ||
| env: | ||
| CMAKE_TOOLCHAIN_FILE: ${{ matrix.sigv4 == 'ON' && matrix.s3 == 'OFF' && '/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake' || '' }} | ||
| run: ci/scripts/build_iceberg.sh "$(pwd)" OFF OFF ${{ matrix.s3 }} ${{ matrix.sigv4 }} | ||
|
|
||
| # Exercise the Meson build with SigV4 enabled (resolves aws-cpp-sdk-core via | ||
| # its CMake config, not pkg-config whose Cflags force -std=c++11). | ||
| meson-sigv4: | ||
| if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false }} | ||
| name: Meson SigV4 (AMD64 Ubuntu 24.04) | ||
| runs-on: ubuntu-24.04 | ||
| timeout-minutes: 45 | ||
| steps: | ||
| - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 | ||
| with: | ||
| python-version: '3.x' | ||
| - name: Checkout iceberg-cpp | ||
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
| with: | ||
| persist-credentials: false | ||
| - name: Install build dependencies | ||
| shell: bash | ||
| run: | | ||
| sudo apt-get update && sudo apt-get install -y libcurl4-openssl-dev | ||
| python3 -m pip install --upgrade pip | ||
| python3 -m pip install -r requirements.txt | ||
| - name: Cache vcpkg packages | ||
| uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 | ||
| id: vcpkg-cache | ||
| with: | ||
| path: /usr/local/share/vcpkg/installed | ||
| key: vcpkg-x64-linux-aws-sdk-cpp-core-${{ hashFiles('.github/workflows/aws_test.yml') }} | ||
| - name: Install AWS SDK via vcpkg | ||
| if: ${{ steps.vcpkg-cache.outputs.cache-hit != 'true' }} | ||
| shell: bash | ||
| # Retry to ride out transient GitHub/mirror download failures (504s). | ||
| run: | | ||
| for attempt in 1 2 3; do | ||
| if vcpkg install aws-sdk-cpp[core]:x64-linux; then | ||
| exit 0 | ||
| fi | ||
| echo "::warning::vcpkg install failed (attempt ${attempt}/3), retrying in 30s" | ||
| sleep 30 | ||
| done | ||
| echo "::error::vcpkg install failed after 3 attempts" | ||
| exit 1 | ||
| - name: Set Ubuntu Compilers | ||
| run: | | ||
| echo "CC=gcc-14" >> $GITHUB_ENV | ||
| echo "CXX=g++-14" >> $GITHUB_ENV | ||
| - name: Build and test Iceberg | ||
| shell: bash | ||
| env: | ||
| CMAKE_PREFIX_PATH: /usr/local/share/vcpkg/installed/x64-linux | ||
| run: | | ||
| meson setup builddir -Dsigv4=enabled | ||
| meson compile -C builddir | ||
| meson test -C builddir --timeout-multiplier 0 --print-errorlogs |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,6 +20,22 @@ | |
| set(ICEBERG_SYSTEM_DEPENDENCIES) | ||
| set(ICEBERG_ARROW_INSTALL_INTERFACE_LIBS) | ||
|
|
||
| if(ICEBERG_SIGV4) | ||
| set(ICEBERG_AWSSDK_SOURCE_RESOLVED "${ICEBERG_AWSSDK_SOURCE}") | ||
| if(ICEBERG_AWSSDK_SOURCE_RESOLVED STREQUAL "AUTO") | ||
| if(ICEBERG_S3) | ||
| set(ICEBERG_AWSSDK_SOURCE_RESOLVED "BUNDLED") | ||
| else() | ||
| set(ICEBERG_AWSSDK_SOURCE_RESOLVED "SYSTEM") | ||
| endif() | ||
| endif() | ||
| if(ICEBERG_AWSSDK_SOURCE_RESOLVED STREQUAL "BUNDLED" AND NOT ICEBERG_S3) | ||
| message(FATAL_ERROR "ICEBERG_AWSSDK_SOURCE=BUNDLED requires ICEBERG_S3=ON: " | ||
| "the bundled AWS SDK is provided by Arrow's S3 support.") | ||
| endif() | ||
| message(STATUS "AWS SDK source for SigV4: ${ICEBERG_AWSSDK_SOURCE_RESOLVED}") | ||
| endif() | ||
|
|
||
| # ---------------------------------------------------------------------- | ||
| # Versions and URLs for toolchain builds | ||
| # | ||
|
|
@@ -110,6 +126,11 @@ function(resolve_arrow_dependency) | |
| set(ARROW_RUNTIME_SIMD_LEVEL "NONE") | ||
| set(ARROW_POSITION_INDEPENDENT_CODE ON) | ||
| set(ARROW_DEPENDENCY_SOURCE "BUNDLED") | ||
| if(ICEBERG_S3 | ||
| AND ICEBERG_SIGV4 | ||
| AND ICEBERG_AWSSDK_SOURCE_RESOLVED STREQUAL "SYSTEM") | ||
| set(AWSSDK_SOURCE "SYSTEM") | ||
| endif() | ||
| set(ARROW_WITH_ZLIB ON) | ||
| set(ZLIB_SOURCE "SYSTEM") | ||
| set(ARROW_VERBOSE_THIRDPARTY_BUILD OFF) | ||
|
|
@@ -628,3 +649,30 @@ endif() | |
| if(ICEBERG_BUILD_SQL_CATALOG) | ||
| resolve_sql_catalog_dependencies() | ||
| endif() | ||
|
|
||
| # ---------------------------------------------------------------------- | ||
| # AWS SDK for C++ | ||
|
|
||
| function(resolve_aws_sdk_dependency) | ||
| if(ICEBERG_AWSSDK_SOURCE_RESOLVED STREQUAL "BUNDLED") | ||
| message(STATUS "SigV4 reuses Arrow's bundled AWS SDK (aws-cpp-sdk-core)") | ||
| return() | ||
| endif() | ||
| find_package(AWSSDK REQUIRED COMPONENTS core) | ||
| list(APPEND ICEBERG_SYSTEM_DEPENDENCIES AWSSDK) | ||
|
Member
There was a problem hiding this comment. Here it records only AWSSDK for installed-package dependency discovery, while src/iceberg/catalog/rest/CMakeLists.txt exports I'd suggest to special-case find_dependency(AWSSDK COMPONENTS core) in the iceberg-config.cmake.in or otherwise export the AWS SDK dependency component-aware.
Member
Author
There was a problem hiding this comment. Thanks @wgtmac , good point — handled in iceberg-config.cmake.in by special-casing AWSSDK to call find_dependency(AWSSDK COMPONENTS core) so downstream installed builds bring in aws-cpp-sdk-core. |
||
| set(ICEBERG_SYSTEM_DEPENDENCIES | ||
| ${ICEBERG_SYSTEM_DEPENDENCIES} | ||
| PARENT_SCOPE) | ||
| # Forwarded to find_dependency(AWSSDK ...) in iceberg-config.cmake.in so | ||
| # downstream installed builds load aws-cpp-sdk-core via AWSSDK_FIND_COMPONENTS. | ||
| set(ICEBERG_FIND_EXTRA_ARGS_AWSSDK | ||
| "COMPONENTS;core" | ||
| PARENT_SCOPE) | ||
| endfunction() | ||
|
|
||
| if(ICEBERG_SIGV4) | ||
| if(NOT ICEBERG_BUILD_REST) | ||
| message(FATAL_ERROR "ICEBERG_SIGV4 requires ICEBERG_BUILD_REST to be ON") | ||
| endif() | ||
| resolve_aws_sdk_dependency() | ||
| endif() | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This still resolves SigV4 against a separate system/vcpkg AWS SDK, while ICEBERG_S3 uses Arrow built with its own bundled AWS SDK. The PR currently tests those modes separately because enabling both causes ODR conflicts, but ICEBERG_S3=ON + ICEBERG_SIGV4=ON should be a supported configuration. If fully vendoring AWS SDK here is too large for this PR, can we at least make Arrow S3 consume the same resolved AWS SDK so both features link against one AWS SDK instance, and track full vendoring as a follow-up?