Source code for nacl.hash

# Copyright 2013 Donald Stufft and individual contributors
#
# 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 __future__ import absolute_import, division, print_function

import nacl.bindings
import nacl.encoding

BLAKE2B_BYTES = nacl.bindings.crypto_generichash_BYTES
BLAKE2B_BYTES_MIN = nacl.bindings.crypto_generichash_BYTES_MIN
BLAKE2B_BYTES_MAX = nacl.bindings.crypto_generichash_BYTES_MAX
BLAKE2B_KEYBYTES = nacl.bindings.crypto_generichash_KEYBYTES
BLAKE2B_KEYBYTES_MIN = nacl.bindings.crypto_generichash_KEYBYTES_MIN
BLAKE2B_KEYBYTES_MAX = nacl.bindings.crypto_generichash_KEYBYTES_MAX
BLAKE2B_SALTBYTES = nacl.bindings.crypto_generichash_SALTBYTES
BLAKE2B_PERSONALBYTES = nacl.bindings.crypto_generichash_PERSONALBYTES

SIPHASH_BYTES = nacl.bindings.crypto_shorthash_siphash24_BYTES
SIPHASH_KEYBYTES = nacl.bindings.crypto_shorthash_siphash24_KEYBYTES

SIPHASHX_BYTES = nacl.bindings.crypto_shorthash_siphashx24_BYTES
SIPHASHX_KEYBYTES = nacl.bindings.crypto_shorthash_siphashx24_KEYBYTES

_b2b_hash = nacl.bindings.crypto_generichash_blake2b_salt_personal
_sip_hash = nacl.bindings.crypto_shorthash_siphash24
_sip_hashx = nacl.bindings.crypto_shorthash_siphashx24


[docs]def sha256(message, encoder=nacl.encoding.HexEncoder): return encoder.encode(nacl.bindings.crypto_hash_sha256(message))
[docs]def sha512(message, encoder=nacl.encoding.HexEncoder): return encoder.encode(nacl.bindings.crypto_hash_sha512(message))
[docs]def blake2b(data, digest_size=BLAKE2B_BYTES, key=b'', salt=b'', person=b'', encoder=nacl.encoding.HexEncoder): """ One-shot blake2b digest :param data: the digest input byte sequence :type data: bytes :param digest_size: the requested digest size; must be at most :py:data:`.BLAKE2B_BYTES_MAX`; the default digest size is :py:data:`.BLAKE2B_BYTES` :type digest_size: int :param key: the key to be set for keyed MAC/PRF usage; if set, the key must be at most :py:data:`.BLAKE2B_KEYBYTES_MAX` long :type key: bytes :param salt: an initialization salt at most :py:data:`.BLAKE2B_SALTBYTES` long; it will be zero-padded if needed :type salt: bytes :param person: a personalization string at most :py:data:`.BLAKE2B_PERSONALBYTES` long; it will be zero-padded if needed :type person: bytes :param encoder: the encoder to use on returned digest :type encoder: class :return: encoded bytes data :rtype: the return type of the choosen encoder """ digest = _b2b_hash(data, digest_size=digest_size, key=key, salt=salt, person=person) return encoder.encode(digest)
generichash = blake2b
[docs]def siphash24(message, key=b'', encoder=nacl.encoding.HexEncoder): """ Computes a keyed MAC of ``message`` using siphash-2-4 :param message: The message to hash. :type message: bytes :param key: the message authentication key for the siphash MAC construct :type key: bytes(:py:data:`.SIPHASH_KEYBYTES`) :param encoder: A class that is able to encode the hashed message. :return: The hashed message. :rtype: bytes(:py:data:`.SIPHASH_BYTES`) The :py:func:`.siphash24` construct is also exposed with the :py:func:`.shorthash` name for compatibility with libsodium names. """ digest = _sip_hash(message, key) return encoder.encode(digest)
shorthash = siphash24
[docs]def siphashx24(message, key=b'', encoder=nacl.encoding.HexEncoder): """ Computes a keyed MAC of ``message`` using the 128 bit siphash-2-4 variant siphashx24 :param message: The message to hash. :type message: bytes :param key: the message authentication key for the siphash MAC construct :type key: bytes(:py:data:`.SIPHASHX_KEYBYTES`) :param encoder: A class that is able to encode the hashed message. :return: The hashed message. :rtype: bytes(:py:data:`.SIPHASHX_BYTES`) .. versionadded:: 1.2 """ digest = _sip_hashx(message, key) return encoder.encode(digest)