GrpcRemoteDownloader: optionally propagate credentials to remote server #23578
Conversation
This file contains 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
sluongng
force-pushed
the
sluongng/grpc-downloader-w-creds
branch
from
e83ba32 to
389b613
Compare
sluongng
changed the title
sluongng
force-pushed
the
sluongng/grpc-downloader-w-creds
branch
2 times, most recently
from
555fd05 to
a6d936d
Compare
github-actions
bot
added
team-Remote-Exec
|
cc: @coeuvre I think the failed test was not caused by my change but I am not certain. |
sluongng
added a commit
to buildbuddy-io/buildbuddy
that referenced
this pull request
Sep 10, 2024
In addition to the checksum.sri qualifier from remote api spec, Bazel includes it's own set of qualifiers to each FetchBlob requests. https://cs.opensource.google/bazel/bazel/+/master:src/main/java/com/google/devtools/build/lib/remote/downloader/GrpcRemoteDownloader.java;l=76-85;drc=618c0abbfe518f4e29de523a2e63ca9179050e94 This change adds initial support for the http_header qualifier as well as acknoledge the existence of bazel.canonical_id header (without actually using it). Relevant tests were also added to demonstrate the current behavior. In a future patch, we may start rejecting unknown qualifiers as recommended by the Remote Asset API spec and thus, flip the assertions in the test. See bazelbuild/remote-apis#301 for more info. Another change to consider in the future is support for custom url-specific header credentials. This is being proposed in Bazel via bazelbuild/bazel#23578.
|
cc: @sushain97, since you added the headers support. |
sluongng
force-pushed
the
sluongng/grpc-downloader-w-creds
branch
from
a6d936d to
fc63914
Compare
sluongng
added a commit
to buildbuddy-io/buildbuddy
that referenced
this pull request
Sep 11, 2024
In addition to the checksum.sri qualifier from remote api spec, Bazel includes it's own set of qualifiers to each FetchBlob requests. https://cs.opensource.google/bazel/bazel/+/master:src/main/java/com/google/devtools/build/lib/remote/downloader/GrpcRemoteDownloader.java;l=76-85;drc=618c0abbfe518f4e29de523a2e63ca9179050e94 This change adds initial support for the http_header qualifier as well as acknoledge the existence of bazel.canonical_id header (without actually using it). Relevant tests were also added to demonstrate the current behavior. In a future patch, we may start rejecting unknown qualifiers as recommended by the Remote Asset API spec and thus, flip the assertions in the test. See bazelbuild/remote-apis#301 for more info. Another change to consider in the future is support for custom url-specific header credentials. This is being proposed in Bazel via bazelbuild/bazel#23578.
coeuvre
requested changes
Sep 12, 2024
src/main/java/com/google/devtools/build/lib/remote/options/RemoteOptions.java
Outdated
Show resolved
Hide resolved
In a multi-tenancy server deployment setup, the clients might want to treat the remote downloader server as a pull-through proxy and use it to download from private storage systems. Currently, we do support it via --remote_downloader_headers. However this scheme does not apply to the specific URL, while credentials and authentication could sometimes be host/domain specific. Add a flag to let users opt-in to credentials propagation to the remote server. This is off by default as not all remote servers can be trusted. When the flag is enabled, URL-specific credentials from Netrc or a custom credentials helper can be propagated to the remote server. The server implementation needs to support the new http_header_url:<url-index>:<header-key> qualifier where the url-index is a 0-based position of the URL inside the FetchBlobRequest's uris field. This new qualifier is modeled after the existing http_header qualifier.
sluongng
force-pushed
the
sluongng/grpc-downloader-w-creds
branch
from
fc63914 to
e8220b0
Compare
coeuvre
approved these changes
Sep 12, 2024
coeuvre
added
awaiting-PR-merge
github-actions
bot
removed
the
awaiting-PR-merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In a multi-tenancy server deployment setup, the clients might want to
treat the remote downloader server as a pull-through proxy and use it to
download from private storage systems.
Currently, we do support it via --remote_downloader_headers. However
this scheme does not apply to the specific URL, while credentials and
authentication could sometimes be host/domain specific.
Add a flag to let users opt-in to credentials propagation to the remote
server. This is off by default as not all remote servers can be
trusted. When the flag is enabled, URL-specific credentials from Netrc
or a custom credentials helper can be propagated to the remote server.
The server implementation needs to support the new
http_header_url:<url-index>:<header-key>qualifier where theurl-indexis a 0-based position of the URL inside theFetchBlobRequest's uris field. This new qualifier is modeled after the
existing
http_headerqualifier.Fixes #23499