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

Add setting to disable signed URLs for GCS uniform buckets #952

Merged
merged 3 commits into from
Nov 16, 2020
Merged

Add setting to disable signed URLs for GCS uniform buckets #952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
221055b
Add a new GS_QUERYSTRING_AUTH param to avoid signing urls
dulacp Jul 26, 2020
c2fef0d
Add documentation for the new parameter GS_QUERYSTRING_AUTH
dulacp Jul 26, 2020
08ab782
Minor logic refactor to no_signed_url
mands Nov 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/backends/gcloud.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,15 @@ a signed (expiring) url.

.. note::
When using this setting, make sure you have ``fine-grained`` access control enabled on your bucket,
as opposed to ``Uniform`` access control, or else, file uploads will return with HTTP 400.
as opposed to ``Uniform`` access control, or else, file uploads will return with HTTP 400. If you
already have a bucket with ``Uniform`` access control set to public read, please keep
``GS_DEFAULT_ACL`` to ``None`` and set ``GS_QUERYSTRING_AUTH`` to ``False``.

``GS_QUERYSTRING_AUTH`` (optional, default is True)

If set to ``False`` it forces the url not to be signed. This setting is useful if you need to have a
bucket configured with ``Uniform`` access control configured with public read. In that case you should
force the flag ``GS_QUERYSTRING_AUTH = False`` and ``GS_DEFAULT_ACL = None``

``GS_FILE_CHARSET`` (optional)

Expand Down
7 changes: 5 additions & 2 deletions storages/backends/gcloud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ def get_default_settings(self):
"custom_endpoint": setting('GS_CUSTOM_ENDPOINT', None),
"location": setting('GS_LOCATION', ''),
"default_acl": setting('GS_DEFAULT_ACL'),
"querystring_auth": setting('GS_QUERYSTRING_AUTH', True),
"expiration": setting('GS_EXPIRATION', timedelta(seconds=86400)),
"file_overwrite": setting('GS_FILE_OVERWRITE', True),
"cache_control": setting('GS_CACHE_CONTROL'),
Expand Down Expand Up @@ -240,10 +241,12 @@ def url(self, name):
"""
name = self._normalize_name(clean_name(name))
blob = self.bucket.blob(name)
no_signed_url = (
self.default_acl == 'publicRead' or not self.querystring_auth)

if not self.custom_endpoint and self.default_acl == 'publicRead':
if not self.custom_endpoint and no_signed_url:
return blob.public_url
elif self.default_acl == 'publicRead':
elif no_signed_url:
return '{storage_base_url}/{quoted_name}'.format(
storage_base_url=self.custom_endpoint,
quoted_name=_quote(name, safe=b"/~"),
Expand Down