ffi_hash.cpp File Reference

#include <botan/ffi.h>
#include <botan/hash.h>
#include <botan/internal/ffi_util.h>

Go to the source code of this file.

Functions
	BOTAN_FFI_DECLARE_STRUCT (botan_hash_struct, Botan::HashFunction, 0x1F0A4F84)
int	botan_hash_block_size (botan_hash_t hash, size_t *out)
int	botan_hash_clear (botan_hash_t hash)
int	botan_hash_copy_state (botan_hash_t *dest, const botan_hash_t source)
int	botan_hash_destroy (botan_hash_t hash)
int	botan_hash_final (botan_hash_t hash, uint8_t out[])
int	botan_hash_init (botan_hash_t *hash, const char *hash_name, uint32_t flags)
int	botan_hash_name (botan_hash_t hash, char *name, size_t *name_len)
int	botan_hash_output_length (botan_hash_t hash, size_t *out)
int	botan_hash_security_level (botan_hash_t hash, size_t *out)
int	botan_hash_update (botan_hash_t hash, const uint8_t *buf, size_t len)

Function Documentation

BOTAN_FFI_DECLARE_STRUCT()

BOTAN_FFI_DECLARE_STRUCT	(	botan_hash_struct	,
		Botan::HashFunction	,
		0x1F0A4F84	)

botan_hash_block_size()

int botan_hash_block_size	(	botan_hash_t	hash,
		size_t *	block_size )

Writes the block size of the hash function to *block_size

Parameters

Hashes	hash object
block_size	output buffer to hold the hash function output length

Returns

0 on success, a negative value on failure

Definition at line 48 of file ffi_hash.cpp.

                                                          {
   if(out == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
   return BOTAN_FFI_VISIT(hash, [=](const auto& h) { *out = h.hash_block_size(); });
}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

botan_hash_clear()

int botan_hash_clear

(

botan_hash_t

hash

)

Reinitializes the state of the hash computation. A hash can be computed (with update/final) immediately.

Parameters

Hashes

hash object

Returns

0 on success, a negative value on failure

Definition at line 62 of file ffi_hash.cpp.

                                        {
   return BOTAN_FFI_VISIT(hash, [](auto& h) { h.clear(); });
}

References BOTAN_FFI_VISIT.

botan_hash_copy_state()

int botan_hash_copy_state	(	botan_hash_t *	dest,
		botan_hash_t	source )

Copy the state of a hash function object

Parameters

dest	destination hash object
source	source hash object

Returns

0 on success, a negative value on failure

Definition at line 86 of file ffi_hash.cpp.

                                                                         {
   if(dest == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
   return BOTAN_FFI_VISIT(source, [=](const auto& src) { return ffi_new_object(dest, src.copy_state()); });
}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, and Botan_FFI::ffi_new_object().

botan_hash_destroy()

int botan_hash_destroy

(

botan_hash_t

hash

)

Frees all resources of the hash object

Parameters

Hashes

hash object

Returns

0 if success, error if invalid object handle

Definition at line 37 of file ffi_hash.cpp.

                                          {
   return BOTAN_FFI_CHECKED_DELETE(hash);
}

References BOTAN_FFI_CHECKED_DELETE.

botan_hash_final()

int botan_hash_final	(	botan_hash_t	hash,
		uint8_t	out[] )

Finalizes the hash computation and writes the output to out[0:botan_hash_output_length()] then reinitializes for computing another digest as if botan_hash_clear had been called.

Parameters

Hashes	hash object
out	output buffer

Returns

0 on success, a negative value on failure

Definition at line 78 of file ffi_hash.cpp.

                                                       {
   if(out == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
   return BOTAN_FFI_VISIT(hash, [=](auto& h) { h.final(out); });
}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

botan_hash_init()

int botan_hash_init	(	botan_hash_t *	hash,
		const char *	hash_name,
		uint32_t	flags )

Initialize a hash function object

Parameters

Hashes	hash object
hash_name	name of the hash function, e.g., "SHA-384"
flags	should be 0 in current API revision, all other uses are reserved and return BOTAN_FFI_ERROR_BAD_FLAG

Definition at line 18 of file ffi_hash.cpp.

                                                                               {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(hash == nullptr || hash_name == nullptr || *hash_name == 0) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
      if(flags != 0) {
         return BOTAN_FFI_ERROR_BAD_FLAG;
      }
 
      auto h = Botan::HashFunction::create(hash_name);
      if(h == nullptr) {
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
      }
 
      ffi_new_object(hash, std::move(h));
      return BOTAN_FFI_SUCCESS;
   });
}

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan::HashFunction::create(), Botan_FFI::ffi_guard_thunk(), and Botan_FFI::ffi_new_object().

botan_hash_name()

int botan_hash_name	(	botan_hash_t	hash,
		char *	name,
		size_t *	name_len )

Get the name of this hash function

Parameters

Hashes	the object to read
name	output buffer
name_len	on input, the length of buffer, on success the number of bytes written

Definition at line 93 of file ffi_hash.cpp.

                                                                     {
   if(name_len == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
 
   return BOTAN_FFI_VISIT(hash, [=](const auto& h) { return write_str_output(name, name_len, h.name()); });
}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, and Botan_FFI::write_str_output().

botan_hash_output_length()

int botan_hash_output_length	(	botan_hash_t	hash,
		size_t *	output_length )

Writes the output length of the hash function to *output_length

Parameters

Hashes	hash object
output_length	output buffer to hold the hash function output length

Returns

0 on success, a negative value on failure

Definition at line 41 of file ffi_hash.cpp.

                                                             {
   if(out == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
   return BOTAN_FFI_VISIT(hash, [=](const auto& h) { *out = h.output_length(); });
}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

botan_hash_security_level()

int botan_hash_security_level	(	botan_hash_t	hash,
		size_t *	security_level )

Writes the estimated security level of the hash function, in bits, with respect to collision resistance, to *security_level. Returns zero for checksums and any hash where finding collisions is trivial.

Parameters

Hashes	hash object
security_level	output variable to hold the security level

Returns

0 on success, a negative value on failure

Definition at line 55 of file ffi_hash.cpp.

                                                              {
   if(out == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
   return BOTAN_FFI_VISIT(hash, [=](const auto& h) { *out = h.security_level(); });
}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

botan_hash_update()

int botan_hash_update	(	botan_hash_t	hash,
		const uint8_t *	in,
		size_t	in_len )

Send more input to the hash function

Parameters

Hashes	hash object
in	input buffer
in_len	number of bytes to read from the input buffer

Returns

0 on success, a negative value on failure

Definition at line 66 of file ffi_hash.cpp.

                                                                         {
   if(len == 0) {
      return 0;
   }
 
   if(buf == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
 
   return BOTAN_FFI_VISIT(hash, [=](auto& h) { h.update(buf, len); });
}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.