Add support for HMAC auth to client API (#203)

* Add support for HMAC auth to client API

Author: satterly

.isort.cfg

@@ -1,2 +1,2 @@
 [settings]
-known_third_party = click,pytz,requests,requests_mock,setuptools,tabulate
+known_third_party = click,pytz,requests,requests_hawk,requests_mock,setuptools,tabulate

alertaclient/api.py

@@ -8,7 +8,9 @@
 
 import requests
 from requests.auth import AuthBase, HTTPBasicAuth
+from requests_hawk import HawkAuth
 
+from alertaclient.auth.utils import merge
 from alertaclient.exceptions import UnknownError
 from alertaclient.models.alert import Alert
 from alertaclient.models.blackout import Blackout
@@ -29,18 +31,19 @@ class Client:
 
     DEFAULT_ENDPOINT = 'http://localhost:8080'
 
-    def __init__(self, endpoint=None, key=None, token=None, username=None, password=None, timeout=5.0, ssl_verify=True, debug=False):
+    def __init__(self, endpoint=None, key=None, secret=None, token=None, username=None, password=None, timeout=5.0, ssl_verify=True, headers=None, debug=False):
         self.endpoint = endpoint or os.environ.get('ALERTA_ENDPOINT', self.DEFAULT_ENDPOINT)
 
         if debug:
             HTTPConnection.debuglevel = 1
 
         key = key or os.environ.get('ALERTA_API_KEY', '')
-        self.http = HTTPClient(self.endpoint, key, token, username, password, timeout, ssl_verify, debug)
+        self.http = HTTPClient(self.endpoint, key, secret, token, username, password, timeout, ssl_verify, headers, debug)
 
     # Alerts
     def send_alert(self, resource, event, **kwargs):
         data = {
+            'id': kwargs.get('id'),
             'resource': resource,
             'event': event,
             'environment': kwargs.get('environment'),
@@ -467,25 +470,30 @@ def __call__(self, r):
 
 class HTTPClient:
 
-    def __init__(self, endpoint, key=None, token=None, username=None, password=None, timeout=30.0, ssl_verify=True, debug=False):
+    def __init__(self, endpoint, key=None, secret=None, token=None, username=None, password=None, timeout=30.0, ssl_verify=True, headers=None, debug=False):
         self.endpoint = endpoint
         self.auth = None
 
         if username:
             self.auth = HTTPBasicAuth(username, password)
+        elif secret:
+            self.auth = HawkAuth(id=key, key=secret)  # HMAC
         elif key:
-            self.auth = ApiKeyAuth(key)
+            self.auth = ApiKeyAuth(api_key=key)
         elif token:
             self.auth = TokenAuth(token)
 
         self.timeout = timeout
         self.session = requests.Session()
         self.session.verify = ssl_verify  # or use REQUESTS_CA_BUNDLE env var
 
+        self.headers = headers or dict()
+        merge(self.headers, self.default_headers())
+
         self.debug = debug
 
     @staticmethod
-    def headers():
+    def default_headers():
         return {
             'X-Request-ID': str(uuid.uuid4()),
             'Content-Type': 'application/json'
@@ -500,7 +508,7 @@ def get(self, path, query=None, **kwargs):
 
         url = self.endpoint + path + '?' + urlencode(query, doseq=True)
         try:
-            response = self.session.get(url, headers=self.headers(), auth=self.auth, timeout=self.timeout)
+            response = self.session.get(url, headers=self.headers, auth=self.auth, timeout=self.timeout)
         except requests.exceptions.RequestException:
             raise
         return self._handle_error(response)
@@ -509,7 +517,7 @@ def post(self, path, data=None):
         url = self.endpoint + path
         try:
             response = self.session.post(url, data=json.dumps(data, cls=CustomJsonEncoder),
-                                         headers=self.headers(), auth=self.auth, timeout=self.timeout)
+                                         headers=self.headers, auth=self.auth, timeout=self.timeout)
         except requests.exceptions.RequestException:
             raise
         return self._handle_error(response)
@@ -518,7 +526,7 @@ def put(self, path, data=None):
         url = self.endpoint + path
         try:
             response = self.session.put(url, data=json.dumps(data, cls=CustomJsonEncoder),
-                                        headers=self.headers(), auth=self.auth, timeout=self.timeout)
+                                        headers=self.headers, auth=self.auth, timeout=self.timeout)
         except requests.exceptions.RequestException:
             raise
         return self._handle_error(response)
@@ -527,7 +535,7 @@ def delete(self, path):
         url = self.endpoint + path
 
         try:
-            response = self.session.delete(url, headers=self.headers(), auth=self.auth, timeout=self.timeout)
+            response = self.session.delete(url, headers=self.headers, auth=self.auth, timeout=self.timeout)
         except requests.exceptions.RequestException:
             raise
         return self._handle_error(response)

alertaclient/auth/hmac.py

@@ -64,3 +64,17 @@ def dump_netrc(self):
             rep = rep + line
         rep = rep + '\n'
     return rep
+
+
+def merge(dict1, dict2):
+    """
+    Merge two dictionaries.
+    :param dict1:
+    :param dict2:
+    :return:
+    """
+    for k in dict2:
+        if k in dict1 and isinstance(dict1[k], dict) and isinstance(dict2[k], dict):
+            merge(dict1[k], dict2[k])
+        else:
+            dict1[k] = dict2[k]

alertaclient/auth/utils.py

@@ -1,4 +1,2 @@
 [mypy]
-
-[mypy-tabulate.*]
 ignore_missing_imports = True

mypy.ini

@@ -1,4 +1,6 @@
-click
-pytz
-requests
-tabulate
+Click==7.0
+pytz==2019.3
+PyYAML==5.3
+requests==2.22.0
+requests-hawk==1.0.1
+tabulate==0.8.6

requirements.txt

@@ -23,6 +23,7 @@ def read(filename):
     install_requires=[
         'Click',
         'requests',
+        'requests_hawk',
         'tabulate',
         'pytz'
     ],