https://github.com/jimbobbennett/circuitpython_hmac

HMAC (Keyed-Hashing for Message Authentication) CircuitPython module. Implements the HMAC algorithm as described by RFC 2104.
https://github.com/jimbobbennett/circuitpython_hmac

circuitpython

Last synced: 6 days ago
JSON representation

HMAC (Keyed-Hashing for Message Authentication) CircuitPython module. Implements the HMAC algorithm as described by RFC 2104.

• Host: GitHub
• URL: https://github.com/jimbobbennett/circuitpython_hmac
• Owner: jimbobbennett
• License: mit
• Created: 2020-03-07T17:59:30.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-08-02T01:47:31.000Z (about 1 year ago)
• Last Synced: 2024-09-25T08:32:35.953Z (8 days ago)
• Topics: circuitpython
• Language: Python
• Size: 43.9 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/circuitpython-hmac/badge/?version=latest

    :target: https://circuitpython.readthedocs.io/projects/hmac/en/latest/

    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/jimbobbennett/CircuitPython_HMAC/workflows/Build%20CI/badge.svg

    :target: https://github.com/jimbobbennett/CircuitPython_HMAC/actions

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

HMAC (Keyed-Hashing for Message Authentication) Python module. Implements the HMAC algorithm as described by RFC 2104.

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

* `Adafruit CircuitPython Hashlib `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_.

Installing from PyPI

=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from

PyPI `_. To install for current user:

.. code-block:: shell

    pip3 install circuitpython-hmac

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install circuitpython-hmac

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name

    python3 -m venv .env

    source .env/bin/activate

    pip3 install circuitpython-hmac

Usage Example

=============

Create a keyed hash for authenticating a message.

.. code-block:: python

    secret = "secret"

    msg = "message"

    key = hmac.new(secret, msg=msg, digestmod=hashlib.sha256).digest()

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.

Documentation

=============

For information on building library documentation, please check out `this guide `_.