Merge pull request #54 from virtualtam/refactor/jwt

Refactor JWT authentication to avoid depending on the unmaintained 'requests-jwt' library

Author: virtualtam

setup.py

@@ -40,9 +40,8 @@ def get_package_metadata(attribute):
         ],
     },
     install_requires=[
-        'requests >= 2.10',
-        'requests-jwt >= 0.4, < 0.5',
-        'pyjwt == 1.7.1'
+        'requests >= 2.25',
+        'pyjwt == 2.0.1'
     ],
     classifiers=[
         'Development Status :: 3 - Alpha',

shaarli_client/client/v1.py

@@ -3,8 +3,8 @@
 import time
 from argparse import Action, ArgumentTypeError
 
+import jwt
 import requests
-from requests_jwt import JWTAuth
 
 
 def check_positive_integer(value):
@@ -248,20 +248,29 @@ def _retrieve_http_params(cls, args):
 
     def _request(self, method, endpoint, params, verify_certs=True):
         """Send an HTTP request to this instance"""
-        auth = JWTAuth(self.secret, alg='HS512', header_format='Bearer %s')
-        auth.add_field('iat', lambda req: calendar.timegm(time.gmtime()))
+        encoded_token = jwt.encode(
+            {'iat': calendar.timegm(time.gmtime())},
+            self.secret,
+            algorithm='HS512',
+        )
+        headers = {'Authorization': 'Bearer %s' % encoded_token}
 
         endpoint_uri = '%s/api/v%d/%s' % (self.uri, self.version, endpoint)
 
         if method == 'GET':
             return requests.request(
                 method,
                 endpoint_uri,
-                auth=auth,
+                headers=headers,
                 params=params,
                 verify=verify_certs
             )
-        return requests.request(method, endpoint_uri, auth=auth, json=params)
+        return requests.request(
+            method,
+            endpoint_uri,
+            headers=headers,
+            json=params,
+        )
 
     def request(self, args):
         """Send a parameterized request to this instance"""

tests/client/test_v1.py

@@ -119,7 +119,7 @@ def test_get_info_uri(request):
     request.assert_called_once_with(
         'GET',
         '%s/api/v1/info' % SHAARLI_URL,
-        auth=mock.ANY,
+        headers=mock.ANY,
         verify=True,
         params={}
     )
@@ -145,7 +145,7 @@ def test_get_links_uri(request):
     request.assert_called_once_with(
         'GET',
         '%s/api/v1/links' % SHAARLI_URL,
-        auth=mock.ANY,
+        headers=mock.ANY,
         verify=True,
         params={}
     )
@@ -187,7 +187,7 @@ def test_post_links_uri(request):
     request.assert_called_once_with(
         'POST',
         '%s/api/v1/links' % SHAARLI_URL,
-        auth=mock.ANY,
+        headers=mock.ANY,
         json={}
     )
 
@@ -229,7 +229,7 @@ def test_put_links_uri(request):
     request.assert_called_once_with(
         'PUT',
         '%s/api/v1/links/12' % SHAARLI_URL,
-        auth=mock.ANY,
+        headers=mock.ANY,
         json={}
     )
 
@@ -288,7 +288,7 @@ def test_get_tags_uri(request):
     request.assert_called_once_with(
         'GET',
         '%s/api/v1/tags' % SHAARLI_URL,
-        auth=mock.ANY,
+        headers=mock.ANY,
         verify=True,
         params={}
     )
@@ -301,7 +301,7 @@ def test_put_tags_uri(request):
     request.assert_called_once_with(
         'PUT',
         '%s/api/v1/tags/some-tag' % SHAARLI_URL,
-        auth=mock.ANY,
+        headers=mock.ANY,
         json={}
     )
 
@@ -340,7 +340,7 @@ def test_delete_tags_uri(request):
     request.assert_called_once_with(
         'DELETE',
         '%s/api/v1/tags/some-tag' % SHAARLI_URL,
-        auth=mock.ANY,
+        headers=mock.ANY,
         json={}
     )