Package: requests-hawk
This project allows you to usethe python requests librarywiththe hawk authenticationmechanism.Hawk itself does not provide any mechanism for obtaining or transmitting the
set of shared credentials required, but this project proposes a scheme we use
across mozilla services projects.Great, how can I use it?First, you’ll need to install it:pipinstallrequests-hawkThen, in your project, if you know theidandkey, you can use:importrequestsfromrequests_hawkimportHawkAuthhawk_auth=HawkAuth(id='my-hawk-id',key='my-hawk-secret-key')requests.post("https://example.com/url",auth=hawk_auth)Or if you need to derive them from the hawk session token, instead use:importrequestsfromrequests_hawkimportHawkAuthhawk_auth=HawkAuth(hawk_session=resp.headers['hawk-session-token'],server_url=self.server_url)requests.post("/url",auth=hawk_auth)In the second example, theserver_urlparameter toHawkAuthwas used to
provide a default host name, to avoid having to repeat it for each request.If you wish to override the default algorithm ofsha256, pass the desired
algorithm name using the optionalalgorithmparameter.Note: Thecredentialsparameter has been removed. Instead passidandkeyseparately (as above), or pass the existing dict as**credentials.Integration with httpieHttpieis a tool which lets you do
requests to a distant server in a nice and easy way. Under the hood,httpieuses the requests library. We’ve made it simple for you to plug hawk with it.If you know the id and key, use it like that:httpPOSTlocalhost:5000/registration\--auth-type=hawk--auth='id:key'Or, if you want to use the hawk session token, you can do as follows:httpPOSTlocalhost:5000/registration\--auth-type=hawk--auth='c0d8cd2ec579a3599bef60f060412f01f5dc46f90465f42b5c47467481315f51:'Take care, don’t forget to add the extra:at the end of the hawk session
token for it to be considered like so.How are the shared credentials shared?Okay, on to the actual details.The server gives you a session token, that you’ll need to derive to get the
hawk credentials.Do an HKDF derivation on the given session token. You’ll need to use the
following parameters:key_material=HKDF(hawk_session,'','identity.mozilla.com/picl/v1/sessionToken',32*2)The key material you’ll get out of the HKDF needs to be separated into two
parts, the first 32 hex characters are thehawk id, and the next 32 ones are thehawk key:credentials={'id':keyMaterial[0:32]'key':keyMaterial[32:64]'algorithm':'sha256'}Run testsTo run test, you can use tox:toxCHANGELOG1.2.1 (2023-05-03)Add support for ext external data string (#34)
(thanks @jtmaclachlan)1.2.0 (unreleased)Nothing changed yet.1.1.1 (2021-06-04)Handle cases where Content-Type is defined as bytes rather than string. (#25)Allow for app mohawk sender parameter configuration1.1.0 (2020-12-16)Allow to skip hashing request and response bodies withalways_hash_content.1.0.1 (2020-01-20)Add Python 3 support. (#22)1.0.0 (2015-12-15)Simplified API for using HawkAuth when the id and key are known. (#8)Added support for overriding the default algorithm (sha256) when deriving
credentials from the hawk session token, via a newalgorithmparameter.See the README for migration advice if you use thecredentialsparameter.0.2.1 (2015-10-14)Make sure the requests json parameter is handled properly. (#7)0.2.0 (2015-05-19)Fix encoding error in setup.py with Python 3.4Add a configuration parameter in order to be able to set the
timestamp to use.0.1.2 (2014-08-13)Add Python3 support0.1.1 (2014-07-21)First version