ffi_block.cpp File Reference

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

Go to the source code of this file.

Functions
int	botan_block_cipher_block_size (botan_block_cipher_t bc)
int	botan_block_cipher_clear (botan_block_cipher_t bc)
int	botan_block_cipher_decrypt_blocks (botan_block_cipher_t bc, const uint8_t in[], uint8_t out[], size_t blocks)
int	botan_block_cipher_destroy (botan_block_cipher_t bc)
int	botan_block_cipher_encrypt_blocks (botan_block_cipher_t bc, const uint8_t in[], uint8_t out[], size_t blocks)
int	botan_block_cipher_get_keyspec (botan_block_cipher_t cipher, size_t *out_minimum_keylength, size_t *out_maximum_keylength, size_t *out_keylength_modulo)
int	botan_block_cipher_init (botan_block_cipher_t *bc, const char *bc_name)
int	botan_block_cipher_name (botan_block_cipher_t cipher, char *name, size_t *name_len)
int	botan_block_cipher_set_key (botan_block_cipher_t bc, const uint8_t key[], size_t len)
	BOTAN_FFI_DECLARE_STRUCT (botan_block_cipher_struct, Botan::BlockCipher, 0x64C29716)

Function Documentation

botan_block_cipher_block_size()

int botan_block_cipher_block_size

(

botan_block_cipher_t

bc

)

Return the positive block size of this block cipher, or negative to indicate an error

Definition at line 61 of file ffi_block.cpp.

                                                           {
   return BOTAN_FFI_VISIT(bc, [](const auto& b) { return static_cast<int>(b.block_size()); });
}

References BOTAN_FFI_VISIT.

botan_block_cipher_clear()

int botan_block_cipher_clear

(

botan_block_cipher_t

bc

)

Reinitializes the block cipher

Returns

0 on success, a negative value on failure

Definition at line 43 of file ffi_block.cpp.

                                                      {
   return BOTAN_FFI_VISIT(bc, [](auto& b) { b.clear(); });
}

References BOTAN_FFI_VISIT.

botan_block_cipher_decrypt_blocks()

int botan_block_cipher_decrypt_blocks	(	botan_block_cipher_t	bc,
		const uint8_t	in[],
		uint8_t	out[],
		size_t	blocks )

Decrypt one or more blocks with the cipher

Definition at line 72 of file ffi_block.cpp.

                                                                                                                 {
   if(in == nullptr || out == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
   return BOTAN_FFI_VISIT(bc, [=](const auto& b) { b.decrypt_n(in, out, blocks); });
}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

botan_block_cipher_destroy()

int botan_block_cipher_destroy

(

botan_block_cipher_t

bc

)

Destroy a block cipher object

Definition at line 39 of file ffi_block.cpp.

                                                        {
   return BOTAN_FFI_CHECKED_DELETE(bc);
}

References BOTAN_FFI_CHECKED_DELETE.

botan_block_cipher_encrypt_blocks()

int botan_block_cipher_encrypt_blocks	(	botan_block_cipher_t	bc,
		const uint8_t	in[],
		uint8_t	out[],
		size_t	blocks )

Encrypt one or more blocks with the cipher

Definition at line 65 of file ffi_block.cpp.

                                                                                                                 {
   if(in == nullptr || out == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
   return BOTAN_FFI_VISIT(bc, [=](const auto& b) { b.encrypt_n(in, out, blocks); });
}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

botan_block_cipher_get_keyspec()

int botan_block_cipher_get_keyspec	(	botan_block_cipher_t	cipher,
		size_t *	out_minimum_keylength,
		size_t *	out_maximum_keylength,
		size_t *	out_keylength_modulo )

Get the key length limits of this block cipher

Parameters

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

Definition at line 87 of file ffi_block.cpp.

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

References BOTAN_FFI_VISIT.

botan_block_cipher_init()

int botan_block_cipher_init	(	botan_block_cipher_t *	bc,
		const char *	cipher_name )

Initialize a block cipher object

Definition at line 18 of file ffi_block.cpp.

                                                                           {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(bc == nullptr || bc_name == nullptr || *bc_name == 0) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
 
      *bc = nullptr;
 
      auto cipher = Botan::BlockCipher::create(bc_name);
      if(cipher == nullptr) {
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
      }
 
      *bc = new botan_block_cipher_struct(std::move(cipher));
      return BOTAN_FFI_SUCCESS;
   });
}

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

botan_block_cipher_name()

int botan_block_cipher_name	(	botan_block_cipher_t	cipher,
		char *	name,
		size_t *	name_len )

Get the name of this block cipher

Parameters

cipher	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 79 of file ffi_block.cpp.

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

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

botan_block_cipher_set_key()

int botan_block_cipher_set_key	(	botan_block_cipher_t	bc,
		const uint8_t	key[],
		size_t	len )

Set the key for a block cipher instance

Definition at line 50 of file ffi_block.cpp.

                                                                                         {
   if(key == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
   return BOTAN_FFI_VISIT(bc, [=](auto& b) { b.set_key(key, len); });
}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

BOTAN_FFI_DECLARE_STRUCT()

BOTAN_FFI_DECLARE_STRUCT	(	botan_block_cipher_struct	,
		Botan::BlockCipher	,
		0x64C29716	)