ffi_mac.cpp File Reference

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

Go to the source code of this file.

Functions
	BOTAN_FFI_DECLARE_STRUCT (botan_mac_struct, Botan::MessageAuthenticationCode, 0xA06E8FC1)
int	botan_mac_clear (botan_mac_t mac)
int	botan_mac_destroy (botan_mac_t mac)
int	botan_mac_final (botan_mac_t mac, uint8_t out[])
int	botan_mac_get_keyspec (botan_mac_t mac, size_t *out_minimum_keylength, size_t *out_maximum_keylength, size_t *out_keylength_modulo)
int	botan_mac_init (botan_mac_t *mac, const char *mac_name, uint32_t flags)
int	botan_mac_name (botan_mac_t mac, char *name, size_t *name_len)
int	botan_mac_output_length (botan_mac_t mac, size_t *out)
int	botan_mac_set_key (botan_mac_t mac, const uint8_t *key, size_t key_len)
int	botan_mac_set_nonce (botan_mac_t mac, const uint8_t *nonce, size_t nonce_len)
int	botan_mac_update (botan_mac_t mac, const uint8_t *buf, size_t len)

Function Documentation

BOTAN_FFI_DECLARE_STRUCT()

BOTAN_FFI_DECLARE_STRUCT	(	botan_mac_struct	,
		Botan::MessageAuthenticationCode	,
		0xA06E8FC1
	)

botan_mac_clear()

int botan_mac_clear

(

botan_mac_t

mac

)

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

Parameters

mac	mac object

Returns

0 on success, a negative value on failure

Definition at line 54 of file ffi_mac.cpp.

   {
   return BOTAN_FFI_VISIT(mac, [](auto& m) { m.clear(); });
   }

References BOTAN_FFI_VISIT.

botan_mac_destroy()

int botan_mac_destroy

(

botan_mac_t

mac

)

Frees all resources of the MAC object

Parameters

mac	mac object

Returns

0 if success, error if invalid object handle

Definition at line 34 of file ffi_mac.cpp.

   {
   return BOTAN_FFI_CHECKED_DELETE(mac);
   }

References BOTAN_FFI_CHECKED_DELETE.

botan_mac_final()

int botan_mac_final	(	botan_mac_t	mac,
		uint8_t	out[]
	)

Finalizes the MAC computation and writes the output to out[0:botan_mac_output_length()] then reinitializes for computing another MAC as if botan_mac_clear had been called.

Parameters

mac	mac object
out	output buffer

Returns

0 on success, a negative value on failure

Definition at line 64 of file ffi_mac.cpp.

   {
   return BOTAN_FFI_VISIT(mac, [=](auto& m) { m.final(out); });
   }

References BOTAN_FFI_VISIT.

botan_mac_get_keyspec()

int botan_mac_get_keyspec	(	botan_mac_t	mac,
		size_t *	out_minimum_keylength,
		size_t *	out_maximum_keylength,
		size_t *	out_keylength_modulo
	)

Get the key length limits of this auth code

Parameters

mac	the object to read
out_minimum_keylength	if non-NULL, will be set to minimum keylength of MAC
out_maximum_keylength	if non-NULL, will be set to maximum keylength of MAC
out_keylength_modulo	if non-NULL will be set to byte multiple of valid keys

Definition at line 75 of file ffi_mac.cpp.

   {
   return BOTAN_FFI_VISIT(mac, [=](auto& m) {
      if(out_minimum_keylength)
         *out_minimum_keylength = m.minimum_keylength();
      if(out_maximum_keylength)
         *out_maximum_keylength = m.maximum_keylength();
      if(out_keylength_modulo)
         *out_keylength_modulo = m.key_spec().keylength_multiple();
      });
   }

References BOTAN_FFI_VISIT.

botan_mac_init()

int botan_mac_init	(	botan_mac_t *	mac,
		const char *	mac_name,
		uint32_t	flags
	)

Initialize a message authentication code object

Parameters

mac	mac object
mac_name	name of the hash function, e.g., "HMAC(SHA-384)"
flags	should be 0 in current API revision, all other uses are reserved and return a negative value (error code)

Returns

0 on success, a negative value on failure

Definition at line 17 of file ffi_mac.cpp.

   {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(!mac || !mac_name || flags != 0)
         return BOTAN_FFI_ERROR_NULL_POINTER;
 
      std::unique_ptr<Botan::MessageAuthenticationCode> m =
         Botan::MessageAuthenticationCode::create(mac_name);
 
      if(m == nullptr)
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
 
      *mac = new botan_mac_struct(std::move(m));
      return BOTAN_FFI_SUCCESS;
      });
   }

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan::MessageAuthenticationCode::create(), and Botan_FFI::ffi_guard_thunk().

botan_mac_name()

int botan_mac_name	(	botan_mac_t	mac,
		char *	name,
		size_t *	name_len
	)

Get the name of this MAC

Parameters

mac	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 69 of file ffi_mac.cpp.

   {
   return BOTAN_FFI_VISIT(mac, [=](const auto& m) {
      return write_str_output(name, name_len, m.name()); });
   }

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

botan_mac_output_length()

int botan_mac_output_length	(	botan_mac_t	mac,
		size_t *	output_length
	)

Writes the output length of the message authentication code to *output_length

Parameters

mac	mac object
output_length	output buffer to hold the MAC output length

Returns

0 on success, a negative value on failure

Definition at line 49 of file ffi_mac.cpp.

   {
   return BOTAN_FFI_VISIT(mac, [=](const auto& m) { *out = m.output_length(); });
   }

References BOTAN_FFI_VISIT.

botan_mac_set_key()

int botan_mac_set_key	(	botan_mac_t	mac,
		const uint8_t *	key,
		size_t	key_len
	)

Sets the key on the MAC

Parameters

mac	mac object
key	buffer holding the key
key_len	size of the key buffer in bytes

Returns

0 on success, a negative value on failure

Definition at line 39 of file ffi_mac.cpp.

   {
   return BOTAN_FFI_VISIT(mac, [=](auto& m) { m.set_key(key, key_len); });
   }

References BOTAN_FFI_VISIT.

botan_mac_set_nonce()

int botan_mac_set_nonce	(	botan_mac_t	mac,
		const uint8_t *	nonce,
		size_t	nonce_len
	)

Sets the nonce on the MAC

Parameters

mac	mac object
nonce	buffer holding the key
nonce_len	size of the key buffer in bytes

Returns

0 on success, a negative value on failure

Definition at line 44 of file ffi_mac.cpp.

   {
   return BOTAN_FFI_VISIT(mac, [=](auto& m) { m.start(nonce, nonce_len); });
   }

References BOTAN_FFI_VISIT.

botan_mac_update()

int botan_mac_update	(	botan_mac_t	mac,
		const uint8_t *	buf,
		size_t	len
	)

Send more input to the message authentication code

Parameters

mac	mac object
buf	input buffer
len	number of bytes to read from the input buffer

Returns

0 on success, a negative value on failure

Definition at line 59 of file ffi_mac.cpp.

   {
   return BOTAN_FFI_VISIT(mac, [=](auto& m) { m.update(buf, len); });
   }

References BOTAN_FFI_VISIT.