Add value dumper func

CHANGELOG.rst

@@ -15,6 +15,14 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+1.9
+-----
+2021-08-17
+
+- Add `value_dumper` to most of the functions/methods related to signature
+  generation/validation. It's aimed to make signatures generated in languages
+  better compatible with `ska`.
+
 1.8.2
 -----
 2021-06-18

setup.py

@@ -6,7 +6,7 @@
 except:
     readme = ""
 
-version = "1.8.2"
+version = "1.9"
 
 exec_dirs = [
     "src/ska/bin/",

src/ska/__init__.py

@@ -26,7 +26,7 @@
 from .utils import RequestHelper
 
 __title__ = "ska"
-__version__ = "1.8.2"
+__version__ = "1.9"
 __author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
 __copyright__ = "2013-2021 Artur Barseghyan"
 __license__ = "GPL 2.0/LGPL 2.1"

src/ska/base.py

@@ -1,7 +1,7 @@
 from base64 import b64encode
 from datetime import datetime, timedelta
 import time
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union, Callable
 
 from . import error_codes
 from .defaults import SIGNATURE_LIFETIME, TIMESTAMP_FORMAT
@@ -129,6 +129,7 @@ def validate_signature(
         valid_until: Union[str, float],
         extra: Optional[Dict[str, Union[bytes, str, float, int]]] = None,
         return_object: bool = False,
+        value_dumper: Optional[Callable] = None,
     ) -> Union[SignatureValidationResult, bool]:
         """Validates the signature.
 
@@ -139,6 +140,7 @@ def validate_signature(
         :param extra: Extra arguments to be validated.
         :param return_object: If set to True, an instance of
             ``SignatureValidationResult`` is returned.
+        :param value_dumper:
         :return:
 
         :example:
@@ -162,6 +164,7 @@ def validate_signature(
             secret_key=secret_key,
             valid_until=valid_until,
             extra=extra,
+            value_dumper=value_dumper,
         )
 
         if not return_object:
@@ -205,6 +208,7 @@ def get_base(
         auth_user: str,
         timestamp: Union[float, str],
         extra: Optional[Dict[str, Union[bytes, str, float, int]]] = None,
+        value_dumper: Optional[Callable] = None,
     ) -> bytes:
         """Get base string.
 
@@ -214,14 +218,17 @@ def get_base(
         :param auth_user:
         :param timestamp:
         :param extra:
+        :param value_dumper:
         """
         if not extra:
             extra = {}
 
         _base = [str(timestamp), auth_user]
 
         if extra:
-            urlencoded_extra = sorted_urlencode(extra)
+            urlencoded_extra = sorted_urlencode(
+                extra, value_dumper=value_dumper
+            )
             if urlencoded_extra:
                 _base.append(urlencoded_extra)
 
@@ -243,6 +250,7 @@ def make_hash(
         secret_key: str,
         valid_until: Union[str, float] = None,
         extra: Optional[Dict[str, Union[bytes, str, float, int]]] = None,
+        value_dumper: Optional[Callable] = None,
     ) -> bytes:
         """Make hash.
 
@@ -252,6 +260,7 @@ def make_hash(
         :param secret_key:
         :param valid_until: Unix timestamp, valid until.
         :param extra: Additional variables to be added.
+        :param value_dumper:
         :return:
         """
         raise NotImplementedError("You should implement this method!")
@@ -264,6 +273,7 @@ def generate_signature(
         valid_until: Optional[Union[float, str]] = None,
         lifetime: int = SIGNATURE_LIFETIME,
         extra: Optional[Dict[str, Union[bytes, str, float, int]]] = None,
+        value_dumper: Optional[Callable] = None,
     ) -> "AbstractSignature":
         """Generates the signature.
 
@@ -295,7 +305,13 @@ def generate_signature(
                 return None  # Something went wrong
 
         signature = b64encode(
-            cls.make_hash(auth_user, secret_key, valid_until, extra)
+            cls.make_hash(
+                auth_user,
+                secret_key,
+                valid_until,
+                extra,
+                value_dumper=value_dumper,
+            )
         )
 
         return cls(

src/ska/helpers.py

@@ -11,6 +11,7 @@
 __license__ = "GPL 2.0/LGPL 2.1"
 __all__ = (
     "get_callback_func",
+    "default_value_dumper",
     "dict_keys",
     "dict_to_ordered_list",
     "sorted_urlencode",
@@ -87,17 +88,27 @@ def dict_to_ordered_list(
     return items
 
 
+def default_value_dumper(value):
+    return value
+
+
 def sorted_urlencode(
-    data: Dict[str, Union[bytes, str, float, int]], quoted: bool = True
+    data: Dict[str, Union[bytes, str, float, int]],
+    quoted: bool = True,
+    value_dumper: Optional[Callable] = default_value_dumper,
 ) -> str:
     """Similar to built-in ``urlencode``, but always puts data in a sorted
     constant way that stays the same between various python versions.
 
     :param data:
     :param quoted:
+    :param value_dumper:
     :return:
     """
-    _sorted = [f"{k}={v}" for k, v in dict_to_ordered_list(data)]
+    if not value_dumper:
+        value_dumper = default_value_dumper
+
+    _sorted = [f"{k}={value_dumper(v)}" for k, v in dict_to_ordered_list(data)]
     res = "&".join(_sorted)
     if quoted:
         res = quote(res)

src/ska/shortcuts.py

@@ -1,4 +1,4 @@
-from typing import Dict, Optional, Type, Union
+from typing import Dict, Optional, Type, Union, Callable
 
 from .base import SignatureValidationResult, AbstractSignature
 from .defaults import (
@@ -43,6 +43,7 @@ def sign_url(
     extra: Optional[Dict[str, Union[bytes, str, float, int]]] = None,
     extra_param: str = DEFAULT_EXTRA_PARAM,
     signature_cls: Type[AbstractSignature] = Signature,
+    value_dumper: Optional[Callable] = None,
 ) -> str:
     """Sign the URL.
 
@@ -64,6 +65,7 @@ def sign_url(
     :param extra_param: Name of the GET param name which would hold the
         ``extra_keys`` value.
     :param signature_cls:
+    :param value_dumper:
     :return:
 
     :example:
@@ -101,6 +103,7 @@ def sign_url(
         valid_until=valid_until,
         lifetime=lifetime,
         extra=extra,
+        value_dumper=value_dumper,
     )
 
     request_helper = RequestHelper(
@@ -131,6 +134,7 @@ def signature_to_dict(
     extra: Optional[Dict[str, Union[str, int]]] = None,
     extra_param: str = DEFAULT_EXTRA_PARAM,
     signature_cls: Type[AbstractSignature] = Signature,
+    value_dumper: Optional[Callable] = None,
 ) -> Dict[str, Union[bytes, str, float, int]]:
     """Return a dictionary containing the signature data params.
 
@@ -149,6 +153,7 @@ def signature_to_dict(
     :param extra_param: Name of the (for example POST) param name which
         would hold the ``extra`` keys value.
     :param signature_cls:
+    :param value_dumper:
     :return:
 
     :example:
@@ -184,6 +189,7 @@ def signature_to_dict(
         valid_until=valid_until,
         lifetime=lifetime,
         extra=extra,
+        value_dumper=value_dumper,
     )
 
     request_helper = RequestHelper(
@@ -207,6 +213,7 @@ def validate_signed_request_data(
     valid_until_param: str = DEFAULT_VALID_UNTIL_PARAM,
     extra_param: str = DEFAULT_EXTRA_PARAM,
     signature_cls: Type[AbstractSignature] = Signature,
+    value_dumper: Optional[Callable] = None,
 ) -> SignatureValidationResult:
     """Validate the signed request data.
 
@@ -222,6 +229,7 @@ def validate_signed_request_data(
     :param extra_param: Name of the (foe example GET or POST) param
         name which holds the ``extra`` keys value.
     :param signature_cls:
+    :param value_dumper:
     :return: A ``ska.SignatureValidationResult``
         object with the following properties:
             - `result` (bool): True if data is valid. False otherwise.
@@ -237,7 +245,7 @@ def validate_signed_request_data(
     )
 
     validation_result = request_helper.validate_request_data(
-        data=data, secret_key=secret_key
+        data=data, secret_key=secret_key, value_dumper=value_dumper,
     )
 
     return validation_result
@@ -253,6 +261,7 @@ def extract_signed_request_data(
     validate: bool = False,
     fail_silently: bool = False,
     signature_cls: Type[AbstractSignature] = Signature,
+    value_dumper: Optional[Callable] = None,
 ) -> Dict[str, Union[bytes, str, float, int]]:
     """Validate the signed request data.
 
@@ -271,6 +280,7 @@ def extract_signed_request_data(
         returning the result.
     :param fail_silently: If set to True, exceptions are omitted.
     :param signature_cls:
+    :param value_dumper:
     :return: Dictionary with signed request data.
     """
     request_helper = RequestHelper(
@@ -286,4 +296,5 @@ def extract_signed_request_data(
         secret_key=secret_key,
         validate=validate,
         fail_silently=fail_silently,
+        value_dumper=value_dumper,
     )

src/ska/signatures/hmac_md5.py

@@ -1,6 +1,6 @@
 import hashlib
 import hmac
-from typing import Union, Optional, Dict
+from typing import Union, Optional, Dict, Callable
 
 from ..base import AbstractSignature
 
@@ -20,6 +20,7 @@ def make_hash(
         secret_key: str,
         valid_until: Union[str, float] = None,
         extra: Optional[Dict[str, Union[bytes, str, float, int]]] = None,
+        value_dumper: Optional[Callable] = None,
     ) -> bytes:
         """Make hash.
 
@@ -29,14 +30,17 @@ def make_hash(
         :param secret_key:
         :param valid_until: Unix timestamp, valid until.
         :param extra: Additional variables to be added.
+        :param value_dumper:
         :return:
         """
         if not extra:
             extra = {}
 
         raw_hmac = hmac.new(
             cls.make_secret_key(secret_key),
-            cls.get_base(auth_user, valid_until, extra=extra),
+            cls.get_base(
+                auth_user, valid_until, extra=extra, value_dumper=value_dumper
+            ),
             hashlib.md5,
         ).digest()
 

src/ska/signatures/hmac_sha1.py

@@ -1,6 +1,6 @@
 import hashlib
 import hmac
-from typing import Union, Optional, Dict
+from typing import Union, Optional, Dict, Callable
 
 from ..base import AbstractSignature
 
@@ -20,6 +20,7 @@ def make_hash(
         secret_key: str,
         valid_until: Union[str, float] = None,
         extra: Optional[Dict[str, Union[bytes, str, float, int]]] = None,
+        value_dumper: Optional[Callable] = None,
     ) -> bytes:
         """Make hash.
 
@@ -29,14 +30,17 @@ def make_hash(
         :param secret_key:
         :param valid_until: Unix timestamp, valid until.
         :param extra: Additional variables to be added.
+        :param value_dumper:
         :return:
         """
         if not extra:
             extra = {}
 
         raw_hmac = hmac.new(
             cls.make_secret_key(secret_key),
-            cls.get_base(auth_user, valid_until, extra=extra),
+            cls.get_base(
+                auth_user, valid_until, extra=extra, value_dumper=value_dumper
+            ),
             hashlib.sha1,
         ).digest()
 

src/ska/signatures/hmac_sha224.py

@@ -1,6 +1,6 @@
 import hashlib
 import hmac
-from typing import Union, Optional, Dict
+from typing import Union, Optional, Dict, Callable
 
 from ..base import AbstractSignature
 
@@ -20,6 +20,7 @@ def make_hash(
         secret_key: str,
         valid_until: Union[str, float] = None,
         extra: Optional[Dict[str, Union[bytes, str, float, int]]] = None,
+        value_dumper: Optional[Callable] = None,
     ) -> bytes:
         """Make hash.
 
@@ -29,14 +30,17 @@ def make_hash(
         :param secret_key:
         :param valid_until: Unix timestamp, valid until.
         :param extra: Additional variables to be added.
+        :param value_dumper:
         :return:
         """
         if not extra:
             extra = {}
 
         raw_hmac = hmac.new(
             cls.make_secret_key(secret_key),
-            cls.get_base(auth_user, valid_until, extra=extra),
+            cls.get_base(
+                auth_user, valid_until, extra=extra, value_dumper=value_dumper
+            ),
             hashlib.sha224,
         ).digest()