Content-Length: 391403 | pFad | http://github.com/googleapis/python-storage/pull/48/files/cbd04127326a2a6231a761f399cc85afc1070eda

65 feat(storage): improve v4 signature query parameters encoding by IlyaFaer · Pull Request #48 · googleapis/python-storage · GitHub
Skip to content

feat(storage): improve v4 signature query parameters encoding #48

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.

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

Merged
merged 18 commits into from
Mar 7, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 32 additions & 3 deletions google/cloud/storage/_signing.py
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ def generate_signed_url_v4(

:type query_parameters: dict
:param query_parameters:
(Optional) Additional query paramtersto be included as part of the
(Optional) Additional query parameters to be included as part of the
signed URLs. See:
https://cloud.google.com/storage/docs/xml-api/reference-headers#query

Expand Down Expand Up @@ -586,8 +586,7 @@ def generate_signed_url_v4(
if generation is not None:
query_parameters["generation"] = generation

ordered_query_parameters = sorted(query_parameters.items())
canonical_query_string = six.moves.urllib.parse.urlencode(ordered_query_parameters)
canonical_query_string = _url_encode(query_parameters)

canonical_elements = [
method,
Expand Down Expand Up @@ -666,3 +665,33 @@ def _sign_message(message, access_token, service_account_email):

data = json.loads(response.data.decode("utf-8"))
return data["signature"]


def _url_encode(query_params):
"""Encode query params into URL.

:type query_params: dict
:param query_params: Query params to be encoded.

:rtype: str
:returns: URL encoded query params.
"""
params = []
for name, value in query_params.items():
params.append(_quote_param(name) + "=" + _quote_param(value))

return "&".join(sorted(params))


def _quote_param(param):
"""Quote query param.

:type param: dict
:param param: Query param to be encoded.

:rtype: str
:returns: URL encoded query param.
"""
if not isinstance(param, bytes):
param = str(param)
return six.moves.urllib.parse.quote(param, safe="~")
14 changes: 14 additions & 0 deletions tests/unit/test__signing.py
Original file line number Diff line number Diff line change
Expand Up @@ -702,6 +702,19 @@ def test_sign_bytes_failure(self):
)


class TestCustomURLEncoding(unittest.TestCase):
def test_url_encode(self):
from google.cloud.storage._signing import _url_encode

# param1 includes safe symbol ~
# param# includes symbols, which must be encoded
query_params = {"param1": "value~1-2", "param#": "*value+value/"}

self.assertEqual(
_url_encode(query_params), "param%23=%2Avalue%2Bvalue%2F&param1=value~1-2"
)


_DUMMY_SERVICE_ACCOUNT = None


Expand All @@ -728,6 +741,7 @@ def _run_conformance_test(resource, test_data):
method=test_data["method"],
_request_timestamp=test_data["timestamp"],
headers=test_data.get("headers"),
query_parameters=test_data.get("queryParameters"),
)

assert url == test_data["expectedUrl"]
Expand Down








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/googleapis/python-storage/pull/48/files/cbd04127326a2a6231a761f399cc85afc1070eda

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy