Changes of parameters

Author: alallema

meilisearch/client.py

@@ -1,14 +1,14 @@
 from typing import Any, Dict, List, Optional
 
+import base64
+import hashlib
+import hmac
+import json
 from meilisearch.index import Index
 from meilisearch.config import Config
 from meilisearch.task import get_task, get_tasks, wait_for_task
 from meilisearch._httprequests import HttpRequests
 from meilisearch.errors import MeiliSearchError
-import base64
-import hashlib
-import hmac
-import json
 
 class Client():
     """
@@ -469,33 +469,56 @@ def wait_for_task(
         """
         return wait_for_task(self.config, uid, timeout_in_ms, interval_in_ms)
 
-    def base64url_encode(
-        self,
-        input: bytes
-    ) -> str:
-        return base64.urlsafe_b64encode(input).decode('utf-8').replace('=','')
-
     def generate_tenant_token(
         self,
-        parentApiKey: str,
-        payload: str
+        options: str,
+        api_key: Optional[str] = None
     ) -> str:
+        """Generate a JWT token for the use of multitenancy.
+
+        Parameters
+        ----------
+        options:
+            Options, the information to generate the token (ex: { 'searchRules': ['*'], 'exp': '1645089029' }).
+            `searchRules`: A Dictionary which contains the rules to be enforced at search time for all or specific
+            accessible indexes for the signing API Key.
+            In the specific case of you want to have any restrictions you can also use a array ["*"].
+            Note that if an exp value is included it should a `timestamp`.
 
+        Returns
+        -------
+        jwt_token:
+           A string containing the jwt tenant token.
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
         header = {
             "typ": "JWT",
             "alg": "HS256"
         }
 
-        payload['apiKeyPrefix'] = parentApiKey[0:8]
+        if api_key is None:
+            api_key = self.config.api_key
+
+        options['apiKeyPrefix'] = api_key[0:8]
 
         json_header = json.dumps(header, separators=(",",":")).encode()
-        json_payload = json.dumps(payload, separators=(",",":")).encode()
+        json_options = json.dumps(options, separators=(",",":")).encode()
 
-        header_encode = self.base64url_encode(json_header)
-        header_payload = self.base64url_encode(json_payload)
+        header_encode = self._base64url_encode(json_header)
+        header_options = self._base64url_encode(json_options)
 
-        secret_encoded = parentApiKey.encode()
-        signature = hmac.new(secret_encoded, (header_encode + "." + header_payload).encode(), hashlib.sha256).digest()
-        jwt_token = header_encode + '.' + header_payload + '.' + self.base64url_encode(signature)
+        secret_encoded = api_key.encode()
+        signature = hmac.new(secret_encoded, (header_encode + "." + header_options).encode(), hashlib.sha256).digest()
+        jwt_token = header_encode + '.' + header_options + '.' + self._base64url_encode(signature)
 
         return jwt_token
+
+    @staticmethod
+    def _base64url_encode(
+        data: bytes
+    ) -> str:
+        return base64.urlsafe_b64encode(data).decode('utf-8').replace('=','')