Source code for PyFunceble.helpers.hash

"""
The tool to check the availability or syntax of domain, IP or URL.

::


    ██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
    ██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
    ██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
    ██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
    ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
    ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

Provides the hashing helpers.

Author:
    Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks:
    https://pyfunceble.github.io/#/special-thanks

Contributors:
    https://pyfunceble.github.io/#/contributors

Project link:
    https://github.com/funilrys/PyFunceble

Project documentation:
    https://pyfunceble.readthedocs.io/en/dev/

Project homepage:
    https://pyfunceble.github.io/

License:
::


    Copyright 2017, 2018, 2019, 2020, 2022 Nissar Chababy

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
"""

from typing import Optional, Union

from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives import hashes

from PyFunceble.helpers.file import FileHelper


[docs]class HashHelper: """ Simplify the hashing of data or file content. :param str algo: The algorithm to use for hashing. :raise ValueError: When the given algo is not known. """ _algo: str = "SHA512_224" def __init__(self, algo: Optional[str] = None): if algo is not None: self.algo = algo @property def algo(self) -> str: """ Provides the current state fo the :code:`_algo` attribute. """ return self._algo @algo.setter def algo(self, value: str) -> None: """ Sets the algorithm to work with. :param value: The name of the hash to use. :raise TypeError: When :code:`value` is not a :py:class:`str`. """ if not isinstance(value, str): raise TypeError(f"<value> should be {str}, {type(value)} given.") value = value.upper() if not hasattr(hashes, value): raise ValueError( f"<value> ({value!r}) in an unknown algorithm ({self.algo!r})." ) self._algo = value
[docs] def set_algo(self, value: str) -> "HashHelper": """ Sets the algorithm to work with. :param value: The name of the hash to use. """ self.algo = value return self
def __get_hash(self) -> hashes.Hash: """ Provides the Hash to use. """ return hashes.Hash(getattr(hashes, self.algo)(), backend=default_backend())
[docs] def hash_file(self, file_path: str) -> str: """ Hashes the content of the given file. :param file_path: The path of the file to read. """ block_size = 4096 digest = self.__get_hash() with FileHelper(file_path).open("rb") as file_stream: block = file_stream.read(block_size) while block: digest.update(block) block = file_stream.read(block_size) return digest.finalize().hex()
[docs] def hash_data(self, data: Union[str, bytes]) -> str: """ Hashes the given data. :param data: The data to hash. :raise TypeError: When :code:`data` is not :py:class:`str` or :py:class:`bytes`. """ if not isinstance(data, (bytes, str)): raise TypeError(f"<data> should be {bytes} or {str}, {type(data)}, given.") if isinstance(data, str): data = data.encode() digest = self.__get_hash() digest.update(data) return digest.finalize().hex()