https://github.com/adafruit/adafruit_circuitpython_hashlib
Secure hashes and message digests
https://github.com/adafruit/adafruit_circuitpython_hashlib
hacktoberfest hashlib sha1 sha224 sha384 sha512
Last synced: 3 months ago
JSON representation
Secure hashes and message digests
- Host: GitHub
- URL: https://github.com/adafruit/adafruit_circuitpython_hashlib
- Owner: adafruit
- License: other
- Created: 2019-08-19T16:14:25.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T19:47:28.000Z (3 months ago)
- Last Synced: 2025-01-28T22:37:33.205Z (3 months ago)
- Topics: hacktoberfest, hashlib, sha1, sha224, sha384, sha512
- Language: Python
- Size: 146 KB
- Stars: 9
- Watchers: 21
- Forks: 5
- Open Issues: 0
-
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/hashlib/badge/?version=latest
:target: https://docs.circuitpython.org/projects/hashlib/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_hashlib/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_hashlib/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
This module implements a common interface to many different secure hash and message digest algorithms.
Included are the FIPS secure hash algorithms SHA1, SHA224, SHA256, SHA384, and SHA512 (defined in FIPS 180-2)
as well as RSA’s MD5 algorithm (defined in Internet RFC 1321).
The SHA1 algorithm is not supported by the CircuitPython module.
`This library is based on the work performed in the micropython-lib hashlib module by Paul Sokolovsky `_
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython `_
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 adafruit-circuitpython-hashlib
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-hashlib
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-hashlib
Usage Example
=============
.. code-block:: python
import adafruit_hashlib as hashlib
m = hashlib.sha256()
m.update(b"CircuitPython")
print("Msg Hex Digest: {}\nMsg Digest Size: {}\nMsg Block Size: {}".format(
m.hexdigest(), m.digest_size, m.block_size))
Documentation
=============
API documentation for this library can be found on `Read the Docs `_.
For information on building library documentation, please check out `this guide `_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
`_
before contributing to help this project stay welcoming.