Update README.rst
parent
91313a6d43
commit
6bc1823fef
16
README.rst
16
README.rst
|
@ -1,12 +1,20 @@
|
||||||
requests-http-signature: A Requests auth module for HTTP Signature
|
requests-http-signature: A Requests auth module for HTTP Signature
|
||||||
==================================================================
|
==================================================================
|
||||||
|
|
||||||
**requests-http-signature** is a `Requests <https://github.com/requests/requests>`_ `authentication plugin
|
**requests-http-signature** is a `Requests <https://github.com/requests/requests>`_ `authentication plugin
|
||||||
<http://docs.python-requests.org/en/master/user/authentication/>`_ (``requests.auth.AuthBase`` subclass) implementing
|
<http://docs.python-requests.org/en/master/user/authentication/>`_ (``requests.auth.AuthBase`` subclass) implementing
|
||||||
the `IETF HTTP Signatures draft RFC <https://tools.ietf.org/html/draft-cavage-http-signatures>`_. It has no required
|
the `IETF HTTP Signatures draft RFC <https://tools.ietf.org/html/draft-cavage-http-signatures>`_. It has no required
|
||||||
dependencies outside the standard library. If you wish to use algorithms other than HMAC (namely, RSA and ECDSA algorithms
|
dependencies outside the standard library. If you wish to use algorithms other than HMAC (namely, RSA and ECDSA algorithms
|
||||||
specified in the RFC), there is an optional dependency on `cryptography <https://pypi.python.org/pypi/cryptography>`_.
|
specified in the RFC), there is an optional dependency on `cryptography <https://pypi.python.org/pypi/cryptography>`_.
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
::
|
||||||
|
|
||||||
|
pip install requests-http-signature
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
import requests
|
import requests
|
||||||
|
@ -31,12 +39,6 @@ incoming requests:
|
||||||
|
|
||||||
HTTPSignatureAuth.verify(request, key_resolver=key_resolver)
|
HTTPSignatureAuth.verify(request, key_resolver=key_resolver)
|
||||||
|
|
||||||
Installation
|
|
||||||
------------
|
|
||||||
::
|
|
||||||
|
|
||||||
pip install requests-http-signature
|
|
||||||
|
|
||||||
Asymmetric key algorithms (RSA and ECDSA)
|
Asymmetric key algorithms (RSA and ECDSA)
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
For asymmetric key algorithms, you should supply the private key as the ``key`` parameter to the ``HTTPSignatureAuth()``
|
For asymmetric key algorithms, you should supply the private key as the ``key`` parameter to the ``HTTPSignatureAuth()``
|
||||||
|
|
Loading…
Reference in New Issue