Go to file
Andrey Kislyuk 9d5f17ae82 Add license notice 2024-05-27 07:23:19 -07:00
.github Update actions 2023-03-05 11:54:11 -08:00
docs Use isort and black 2022-08-31 10:50:44 -07:00
requests_http_signature Use isort and black 2022-08-31 10:50:44 -07:00
test Use isort and black 2022-08-31 10:50:44 -07:00
.gitignore Begin requests-http-signature 2017-08-22 12:05:04 -07:00
Changes.rst v0.7.1 2022-04-19 11:39:44 -07:00
LICENSE Begin requests-http-signature 2017-08-22 12:05:04 -07:00
Makefile Use mypy check-untyped-defs 2022-04-21 16:28:37 -07:00
NOTICE Add license notice 2024-05-27 07:23:19 -07:00
README.rst Add license notice 2024-05-27 07:23:19 -07:00
common.mk Use gh to manage releases 2023-03-04 16:38:19 -08:00
pyproject.toml Update isort config 2022-09-11 11:42:53 -07:00
setup.cfg Update package to follow the latest draft 2022-04-10 14:52:41 -07:00
setup.py Fix typo in package data manifest 2022-10-15 22:00:13 -07:00


requests-http-signature: A Requests auth module for HTTP Signature
**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
`IETF RFC 9421 HTTP Message Signatures standard <https://datatracker.ietf.org/doc/rfc9421/>`_.


    $ pip install requests-http-signature


.. code-block:: python

  import requests
  from requests_http_signature import HTTPSignatureAuth, algorithms
  preshared_key_id = 'squirrel'
  preshared_secret = b'monorail_cat'
  url = 'https://example.com/'

  auth = HTTPSignatureAuth(key=preshared_secret,
  requests.get(url, auth=auth)

By default, only the ``Date`` header and the ``@method``, ``@authority``, and ``@target-uri`` derived component
identifiers are signed for body-less requests such as GET. The ``Date`` header is set if it is absent. In addition,
the ``Authorization`` header is signed if it is present, and for requests with bodies (such as POST), the
``Content-Digest`` header is set to the SHA256 of the request body using the format described in the
`IETF Digest Fields draft <https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-digest-headers>`_ and signed.
To add other headers to the signature, pass an array of header names in the ``covered_component_ids`` keyword argument.
See the `API documentation <https://pyauth.github.io/requests-http-signature/#id3>`_ for the full list of options and

Verifying responses
The class method ``HTTPSignatureAuth.verify()`` can be used to verify responses received back from the server:

.. code-block:: python

  class MyKeyResolver:
      def resolve_public_key(self, key_id):
          assert key_id == 'squirrel'
          return 'monorail_cat'

  response = requests.get(url, auth=auth)
  verify_result = HTTPSignatureAuth.verify(response,

More generally, you can reconstruct an arbitrary request using the
`Requests API <https://docs.python-requests.org/en/latest/api/#requests.Request>`_ and pass it to ``verify()``:

.. code-block:: python

  request = requests.Request(...)  # Reconstruct the incoming request using the Requests API
  prepared_request = request.prepare()  # Generate a PreparedRequest
  HTTPSignatureAuth.verify(prepared_request, ...)

To verify incoming requests and sign responses in the context of an HTTP server, see the
`flask-http-signature <https://github.com/pyauth/flask-http-signature>`_ and
`http-message-signatures <https://github.com/pyauth/http-message-signatures>`_ packages.

.. admonition:: See what is signed

 It is important to understand and follow the best practice rule of "See what is signed" when verifying HTTP message
 signatures. The gist of this rule is: if your application neglects to verify that the information it trusts is
 what was actually signed, the attacker can supply a valid signature but point you to malicious data that wasn't signed
 by that signature. Failure to follow this rule can lead to vulnerability against signature wrapping and substitution

 In requests-http-signature, you can ensure that the information signed is what you expect to be signed by only trusting
 the data returned by the ``verify()`` method::

   verify_result = HTTPSignatureAuth.verify(message, ...)

See the `API documentation <https://pyauth.github.io/requests-http-signature/#id3>`_ for full details.

Asymmetric key algorithms
To sign or verify messages with an asymmetric key algorithm, set the ``signature_algorithm`` keyword argument to
``algorithms.ED25519``, ``algorithms.ECDSA_P256_SHA256``, ``algorithms.RSA_V1_5_SHA256``, or

For asymmetric key algorithms, you can supply the private key as the ``key`` parameter to the ``HTTPSignatureAuth()``
constructor as bytes in the PEM format, or configure the key resolver as follows:

.. code-block:: python

  with open('key.pem', 'rb') as fh:
      auth = HTTPSignatureAuth(signature_algorithm=algorithms.RSA_V1_5_SHA256,
  requests.get(url, auth=auth)

  class MyKeyResolver:
      def resolve_public_key(self, key_id: str):
          return public_key_pem_bytes[key_id]

      def resolve_private_key(self, key_id: str):
          return private_key_pem_bytes[key_id]

  auth = HTTPSignatureAuth(signature_algorithm=algorithms.RSA_V1_5_SHA256,
  requests.get(url, auth=auth)

Digest algorithms
To generate a Content-Digest header using SHA-512 instead of the default SHA-256, subclass ``HTTPSignatureAuth`` as

  class MySigner(HTTPSignatureAuth):
      signing_content_digest_algorithm = "sha-512"

* `Andrey Kislyuk <https://kislyuk.com>`

* `Project home page (GitHub) <https://github.com/pyauth/requests-http-signature>`_
* `Package documentation <https://pyauth.github.io/requests-http-signature/>`_
* `Package distribution (PyPI) <https://pypi.python.org/pypi/requests-http-signature>`_
* `Change log <https://github.com/pyauth/requests-http-signature/blob/master/Changes.rst>`_
* `http-message-signatures <https://github.com/pyauth/http-message-signatures>`_ - a dependency of this library that
  handles much of the implementation
* `IETF RFC 9421, HTTP Message Signatures <https://datatracker.ietf.org/doc/rfc9421/>`_

Please report bugs, issues, feature requests, etc. on `GitHub <https://github.com/pyauth/requests-http-signature/issues>`_.

Copyright 2017-2024, Andrey Kislyuk and requests-http-signature contributors. Licensed under the terms of the
`Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_. Distribution of attribution information,
LICENSE and NOTICE files with source copies of this package and derivative works is **REQUIRED** as specified by the
Apache License.