Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(storage): respect WithEndpoint for SignedURLs and PostPolicy #8113

Merged
merged 8 commits into from Jun 27, 2023
Merged

feat(storage): respect WithEndpoint for SignedURLs and PostPolicy #8113

merged 8 commits into from Jun 27, 2023

Conversation

BrennaEpp
Copy link
Contributor

Clients initiated with a non default endpoint will use that endpoint for SignedURLs and Post Policies.

Uses the endpoint set for client.readHost as we set that anyway to the correct endpoint when initializing a client. It could also be extracted from client.raw.BasePath but client.readHost is already in the form we need.

@BrennaEpp
feat(storage): respect WithEndpoint for SignedURLs and PostPolicy
dbc2d68 
Clients initiated with a non default endpoint will use that endpoint for SignedURLs and Post Policies.
@BrennaEpp BrennaEpp requested review from a team as code owners June 15, 2023 22:30
@product-auto-label product-auto-label bot added size: l Pull request size is large. api: storage Issues related to the Cloud Storage API. labels Jun 15, 2023
tritone
tritone reviewed Jun 16, 2023
View reviewed changes
Copy link
Contributor

@tritone tritone left a comment

Choose a reason for hiding this comment

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

Nice start on this, a few comments.

storage/storage.go Outdated Show resolved Hide resolved
storage/storage.go Outdated Show resolved Hide resolved
storage/bucket.go Outdated
@@ -173,6 +173,9 @@ func (b *BucketHandle) Update(ctx context.Context, uattrs BucketAttrsToUpdate) (
// [Overview of access control]: https://cloud.google.com/storage/docs/accesscontrol#signed_urls_query_string_authentication
// [automatic detection of credentials]: https://pkg.go.dev/cloud.google.com/go/storage#hdr-Credential_requirements_for_signing
func (b *BucketHandle) SignedURL(object string, opts *SignedURLOptions) (string, error) {
// Extract the correct endpoint from the readhost set on the client
opts.endpoint = b.c.readHost
Copy link
Contributor

Choose a reason for hiding this comment

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

I think calling this endpoint is a bit misleading. Usually I think of endpoint as being the full path for the JSON API, i.e. https://storage.googleapis.com/storage/v1. Just storage.googleapis.com would be a hostname.

Sidenote, readHost is also a bit misleading because now using XML reads is optional; maybe we should rename to xmlHost. (not required for this PR though).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are correct.

Here is a PR for renaming readHost: #8160

storage/bucket_test.go
want string
}{
{
desc: "SignURLV4 creates link to resources in emulator",
Copy link
Contributor

Choose a reason for hiding this comment

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

These cases really seem like they belong in the conformance tests for signed URLs once the project is complete. Could you add a TODO to move them? (and I guess this would also require exporting the hostname option rather than having it be internal only)

storage/storage.go
@@ -268,7 +268,7 @@ const (
type URLStyle interface {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you also update the docs for PathStyle to indicate that the provided hostname is taken into account?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. To-do on virtual hosted style, if we decide to support it.

storage/storage.go Outdated
func (s virtualHostedStyle) host(bucket string) string {
func (s virtualHostedStyle) host(endpoint, bucket string) string {
if endpoint != "" {
return bucket + "." + stripScheme(endpoint)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not totally sure about this one and whether it is expected to be supported. Let's discuss offline next week.

tritone
tritone approved these changes Jun 23, 2023
View reviewed changes
Copy link
Contributor

@tritone tritone left a comment

Choose a reason for hiding this comment

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

One more minor comment, otherwise LGTM

storage/post_policy_v4.go Outdated
@@ -113,8 +113,13 @@ type PostPolicyV4Options struct {
// Optional.
Conditions []PostPolicyV4Condition

// Hostname sets the host of the signed post policy. This field overrides
// any endpoint set on a storage Client or through STORAGE_EMULATOR_HOST.
// Not compatible with BucketBoundHostname URLStyle.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would say "only compatible with PathStyle" because we omitted VirtualHosted also. Same in the docs for SignedURLOptions below.

codyoss and others added 4 commits June 26, 2023 17:10
@codyoss @BrennaEpp
chore: bulk update (googleapis#8157)
9569db6 
BEGIN_NESTED_COMMIT
fix(accessapproval): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(accesscontextmanager): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(advisorynotifications): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(aiplatform): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(alloydb): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(analytics): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(apigateway): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(apigeeconnect): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(apigeeregistry): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(apikeys): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(appengine): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(area120): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(artifactregistry): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(asset): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(assuredworkloads): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(automl): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(baremetalsolution): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(batch): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(beyondcorp): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(bigquery): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(bigtable): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(billing): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(binaryauthorization): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(certificatemanager): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(channel): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(cloudbuild): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(clouddms): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(cloudtasks): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(compute): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(confidentialcomputing): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(contactcenterinsights): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(container): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(containeranalysis): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(datacatalog): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(dataflow): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(dataform): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(datafusion): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(datalabeling): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(dataplex): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(dataproc): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(dataqna): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(datastore): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(datastream): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(deploy): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(dialogflow): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(discoveryengine): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(dlp): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(documentai): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(domains): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(edgecontainer): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(errorreporting): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(essentialcontacts): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(eventarc): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(filestore): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(firestore): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(functions): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(gaming): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(gkebackup): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(gkeconnect): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(gkehub): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(gkemulticloud): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(grafeas): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(gsuiteaddons): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(iam): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(iap): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(ids): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(iot): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(kms): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(language): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(lifesciences): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(logging): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(longrunning): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(managedidentities): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(maps): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(mediatranslation): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(memcache): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(metastore): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(monitoring): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(networkconnectivity): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(networkmanagement): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(networksecurity): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(notebooks): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(optimization): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(orchestration): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(orgpolicy): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(osconfig): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(oslogin): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(phishingprotection): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(policytroubleshooter): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(privatecatalog): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(profiler): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(pubsub): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(pubsublite): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(rapidmigrationassessment): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(recaptchaenterprise): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(recommendationengine): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(recommender): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(redis): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(resourcemanager): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(resourcesettings): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(retail): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(run): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(scheduler): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(secretmanager): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(security): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(securitycenter): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(servicecontrol): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(servicedirectory): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(servicemanagement): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(serviceusage): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(shell): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(spanner): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(speech): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(storage): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(storageinsights): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(storagetransfer): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(support): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(talent): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(texttospeech): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(tpu): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(trace): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(translate): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(video): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(videointelligence): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(vision): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(vmmigration): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(vmwareengine): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(vpcaccess): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(webrisk): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(websecurityscanner): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(workflows): REST query UpdateMask bug
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
fix(workstations): REST query UpdateMask bug
END_NESTED_COMMIT
@BrennaEpp
documentation on virtualhostedstyle
2bd4ab5
@BrennaEpp
fix broken test
9e90cff
@BrennaEpp
Merge branch 'main' into sign-with-endpoint
64440bc
@BrennaEpp BrennaEpp enabled auto-merge (squash) June 27, 2023 00:16
@BrennaEpp BrennaEpp merged commit f918f23 into googleapis:main Jun 27, 2023
8 checks passed
@release-please release-please bot mentioned this pull request Jun 26, 2023
Merged
@BrennaEpp BrennaEpp deleted the sign-with-endpoint branch June 27, 2023 00:34
@BrennaEpp BrennaEpp mentioned this pull request Jun 27, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tritone tritone tritone approved these changes

Assignees
No one assigned
Labels
api: storage Issues related to the Cloud Storage API. size: l Pull request size is large.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@BrennaEpp @tritone @codyoss