ffi_xof.cpp File Reference

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

Go to the source code of this file.

Functions
	BOTAN_FFI_DECLARE_STRUCT (botan_xof_struct, Botan::XOF, 0x0f1303a0)
int	botan_xof_accepts_input (botan_xof_t this_xof)
int	botan_xof_block_size (botan_xof_t this_xof, size_t *out)
int	botan_xof_clear (botan_xof_t this_xof)
int	botan_xof_copy_state (botan_xof_t *dest, const botan_xof_t this_xof)
int	botan_xof_destroy (botan_xof_t xof)
int	botan_xof_init (botan_xof_t *this_xof, const char *xof_name, uint32_t flags)
int	botan_xof_name (botan_xof_t this_xof, char *name, size_t *name_len)
int	botan_xof_output (botan_xof_t this_xof, uint8_t *out, size_t out_len)
int	botan_xof_update (botan_xof_t this_xof, const uint8_t *in, size_t in_len)

Function Documentation

BOTAN_FFI_DECLARE_STRUCT()

BOTAN_FFI_DECLARE_STRUCT	(	botan_xof_struct	,
		Botan::XOF	,
		0x0f1303a0	)

botan_xof_accepts_input()

int botan_xof_accepts_input

(

botan_xof_t

xof

)

Get the input/output state of this eXtendable Output Function Typically, XOFs don't accept input as soon as the first output bytes were requested.

Parameters

xof	the object to read

Returns

1 iff the XOF is still accepting input bytes

Definition at line 58 of file ffi_xof.cpp.

                                                  {
   return BOTAN_FFI_VISIT(this_xof, [=](const auto& xof) { return xof.accepts_input() ? 1 : 0; });
}

References BOTAN_FFI_VISIT.

botan_xof_block_size()

int botan_xof_block_size	(	botan_xof_t	xof,
		size_t *	block_size )

Writes the block size of the eXtendable Output Function to *block_size

Parameters

xof	XOF object
block_size	variable to hold the XOF's block size

Returns

0 on success, a negative value on failure

Definition at line 43 of file ffi_xof.cpp.

                                                            {
   if(Botan::any_null_pointers(out)) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
   return BOTAN_FFI_VISIT(this_xof, [=](const auto& xof) { *out = xof.block_size(); });
}

References Botan::any_null_pointers(), BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

botan_xof_clear()

int botan_xof_clear

(

botan_xof_t

xof

)

Reinitializes the state of the eXtendable Output Function.

Parameters

xof	XOF object

Returns

0 on success, a negative value on failure

Definition at line 62 of file ffi_xof.cpp.

                                          {
   return BOTAN_FFI_VISIT(this_xof, [](auto& xof) { xof.clear(); });
}

References BOTAN_FFI_VISIT.

botan_xof_copy_state()

int botan_xof_copy_state	(	botan_xof_t *	dest,
		botan_xof_t	source )

Copy the state of an eXtendable Output Function

Parameters

dest	destination XOF object
source	source XOF object

Returns

0 on success, a negative value on failure

Definition at line 39 of file ffi_xof.cpp.

                                                                        {
   return BOTAN_FFI_VISIT(this_xof, [=](const auto& src) { return ffi_new_object(dest, src.copy_state()); });
}

References BOTAN_FFI_VISIT, and Botan_FFI::ffi_new_object().

botan_xof_destroy()

int botan_xof_destroy

(

botan_xof_t

xof

)

Frees all resources of the eXtendable Output Function object

Parameters

xof	xof object

Returns

0 if success, error if invalid object handle

Definition at line 90 of file ffi_xof.cpp.

                                       {
   return BOTAN_FFI_CHECKED_DELETE(xof);
}

References BOTAN_FFI_CHECKED_DELETE.

botan_xof_init()

int botan_xof_init	(	botan_xof_t *	xof,
		const char *	xof_name,
		uint32_t	flags )

Initialize an eXtendable Output Function

Parameters

xof	XOF object
xof_name	name of the XOF, e.g., "SHAKE-128"
flags	should be 0 in current API revision, all other uses are reserved and return BOTAN_FFI_ERROR_BAD_FLAG

Definition at line 19 of file ffi_xof.cpp.

                                                                                {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(Botan::any_null_pointers(this_xof, xof_name) || *xof_name == 0) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
      if(flags != 0) {
         return BOTAN_FFI_ERROR_BAD_FLAG;
      }
 
      auto xof = Botan::XOF::create(xof_name);
      if(xof == nullptr) {
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
      }
 
      ffi_new_object(this_xof, std::move(xof));
      return BOTAN_FFI_SUCCESS;
   });
}

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

botan_xof_name()

int botan_xof_name	(	botan_xof_t	xof,
		char *	name,
		size_t *	name_len )

Get the name of this eXtendable Output Function

Parameters

xof	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 50 of file ffi_xof.cpp.

                                                                       {
   if(Botan::any_null_pointers(name_len)) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
 
   return BOTAN_FFI_VISIT(this_xof, [=](const auto& xof) { return write_str_output(name, name_len, xof.name()); });
}

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

botan_xof_output()

int botan_xof_output	(	botan_xof_t	xof,
		uint8_t *	out,
		size_t	out_len )

Generate output bytes from the eXtendable Output Function

Parameters

xof	XOF object
out	output buffer
out_len	number of bytes to write into the output buffer

Returns

0 on success, a negative value on failure

Definition at line 78 of file ffi_xof.cpp.

                                                                         {
   if(out_len == 0) {
      return 0;
   }
 
   if(Botan::any_null_pointers(out)) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
 
   return BOTAN_FFI_VISIT(this_xof, [=](auto& xof) { xof.output({out, out_len}); });
}

References Botan::any_null_pointers(), BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

botan_xof_update()

int botan_xof_update	(	botan_xof_t	xof,
		const uint8_t *	in,
		size_t	in_len )

Send more input to the eXtendable Output Function

Parameters

xof	XOF 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_xof.cpp.

                                                                             {
   if(in_len == 0) {
      return 0;
   }
 
   if(Botan::any_null_pointers(in)) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
 
   return BOTAN_FFI_VISIT(this_xof, [=](auto& xof) { xof.update({in, in_len}); });
}

References Botan::any_null_pointers(), BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.