Module refinery.units.crypto.hash

Implements various hashing algorithms.

Expand source code Browse git 
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Implements various hashing algorithms.
"""
from __future__ import annotations
from typing import TYPE_CHECKING

from refinery.units import Arg, Unit, abc

if TYPE_CHECKING:
    from typing import Protocol, Union

    class _Hash(Protocol):
        def digest(self) -> bytes: ...


class HashUnit(Unit, abstract=True):

    @abc.abstractmethod
    def _algorithm(self, data: bytes) -> Union[_Hash, bytes]:
        raise NotImplementedError

    def __init__(self, text: Arg('-t', help='Output a hexadecimal representation of the hash.') = False, **kwargs):
        super().__init__(text=text, **kwargs)

    def process(self, data: bytes) -> bytes:
        digest = self._algorithm(data)
        try:
            digest = digest.digest()
        except AttributeError:
            pass
        if self.args.text:
            digest = digest.hex().encode(self.codec)
        return digest

Sub-modules

refinery.units.crypto.hash.checksums

Implements hash algorithms of short length, commonly used as checksums.

refinery.units.crypto.hash.cryptographic

Implements various cryptographic hashing algorithms.

refinery.units.crypto.hash.imphash
refinery.units.crypto.hash.murmur
refinery.units.crypto.hash.password_hashes

Implements password hashing algorithms.

refinery.units.crypto.hash.xxhash

Classes

class HashUnit (text=False, **kwargs)
Expand source code Browse git 
class HashUnit(Unit, abstract=True):

    @abc.abstractmethod
    def _algorithm(self, data: bytes) -> Union[_Hash, bytes]:
        raise NotImplementedError

    def __init__(self, text: Arg('-t', help='Output a hexadecimal representation of the hash.') = False, **kwargs):
        super().__init__(text=text, **kwargs)

    def process(self, data: bytes) -> bytes:
        digest = self._algorithm(data)
        try:
            digest = digest.digest()
        except AttributeError:
            pass
        if self.args.text:
            digest = digest.hex().encode(self.codec)
        return digest

Ancestors

Subclasses

Class variables

var required_dependencies
var optional_dependencies

Inherited members