ffi_keywrap.cpp File Reference

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

Go to the source code of this file.

Functions
int	botan_key_unwrap3394 (const uint8_t wrapped_key[], size_t wrapped_key_len, const uint8_t kek[], size_t kek_len, uint8_t key[], size_t *key_len)
int	botan_key_wrap3394 (const uint8_t key[], size_t key_len, const uint8_t kek[], size_t kek_len, uint8_t wrapped_key[], size_t *wrapped_key_len)
int	botan_nist_kw_dec (const char *cipher_algo, int padded, const uint8_t wrapped_key[], size_t wrapped_key_len, const uint8_t kek[], size_t kek_len, uint8_t key[], size_t *key_len)
int	botan_nist_kw_enc (const char *cipher_algo, int padded, const uint8_t key[], size_t key_len, const uint8_t kek[], size_t kek_len, uint8_t wrapped_key[], size_t *wrapped_key_len)

Function Documentation

botan_key_unwrap3394()

int botan_key_unwrap3394	(	const uint8_t	wrapped_key[],
		size_t	wrapped_key_len,
		const uint8_t	kek[],
		size_t	kek_len,
		uint8_t	key[],
		size_t *	key_len )

Key unwrapping as per RFC 3394

Parameters

wrapped_key	the wrapped key to unwrap
wrapped_key_len	length of wrapped_key in bytes
kek	the key encryption key
kek_len	length of kek in bytes
key	output buffer for the unwrapped key
key_len	on input the size of key, on output the number of bytes written or required

Returns

0 on success, a negative value on failure

Definition at line 104 of file ffi_keywrap.cpp.

                                          {
   const std::string cipher_name = "AES-" + std::to_string(8 * kek_len);
 
   return botan_nist_kw_dec(cipher_name.c_str(), 0, wrapped_key, wrapped_key_len, kek, kek_len, key, key_len);
}

References botan_nist_kw_dec().

botan_key_wrap3394()

int botan_key_wrap3394	(	const uint8_t	key[],
		size_t	key_len,
		const uint8_t	kek[],
		size_t	kek_len,
		uint8_t	wrapped_key[],
		size_t *	wrapped_key_len )

Key wrapping as per RFC 3394

Definition at line 93 of file ffi_keywrap.cpp.

                                                {
   const std::string cipher_name = "AES-" + std::to_string(8 * kek_len);
 
   return botan_nist_kw_enc(cipher_name.c_str(), 0, key, key_len, kek, kek_len, wrapped_key, wrapped_key_len);
}

References botan_nist_kw_enc().

botan_nist_kw_dec()

int botan_nist_kw_dec	(	const char *	cipher_algo,
		int	padded,
		const uint8_t	wrapped_key[],
		size_t	wrapped_key_len,
		const uint8_t	kek[],
		size_t	kek_len,
		uint8_t	key[],
		size_t *	key_len )

Key unwrapping as per NIST SP 800-38F

Parameters

cipher_algo	the block cipher to use, eg "AES-256"
padded	if non-zero use KWP (the padded variant), otherwise KW
wrapped_key	the wrapped key to unwrap
wrapped_key_len	length of wrapped_key in bytes
kek	the key encryption key
kek_len	length of kek in bytes
key	output buffer for the unwrapped key
key_len	on input the size of key, on output the number of bytes written or required

Returns

0 on success, a negative value on failure

Definition at line 57 of file ffi_keywrap.cpp.

                                       {
   if(any_null_pointers(cipher_algo, wrapped_key, kek)) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
#if defined(BOTAN_HAS_NIST_KEYWRAP)
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(padded != 0 && padded != 1) {
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
      }
 
      auto bc = Botan::BlockCipher::create_or_throw(cipher_algo);
      bc->set_key(kek, kek_len);
 
      Botan::secure_vector<uint8_t> output;
 
      if(padded == 0) {
         output = Botan::nist_key_unwrap(wrapped_key, wrapped_key_len, *bc);
      } else {
         output = Botan::nist_key_unwrap_padded(wrapped_key, wrapped_key_len, *bc);
      }
 
      return write_vec_output(key, key_len, output);
   });
#else
   BOTAN_UNUSED(cipher_algo, padded, key, key_len, kek, kek_len, wrapped_key, wrapped_key_len);
   return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}

References Botan_FFI::any_null_pointers(), BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_UNUSED, Botan::BlockCipher::create_or_throw(), Botan_FFI::ffi_guard_thunk(), Botan::nist_key_unwrap(), Botan::nist_key_unwrap_padded(), and Botan_FFI::write_vec_output().

Referenced by botan_key_unwrap3394().

botan_nist_kw_enc()

int botan_nist_kw_enc	(	const char *	cipher_algo,
		int	padded,
		const uint8_t	key[],
		size_t	key_len,
		const uint8_t	kek[],
		size_t	kek_len,
		uint8_t	wrapped_key[],
		size_t *	wrapped_key_len )

Key wrapping as per NIST SP 800-38F

Parameters

cipher_algo	the block cipher to use, eg "AES-256"
padded	if non-zero use KWP (the padded variant), otherwise KW
key	the key to wrap
key_len	length of key in bytes
kek	the key encryption key
kek_len	length of kek in bytes
wrapped_key	output buffer for the wrapped key
wrapped_key_len	on input the size of wrapped_key, on output the number of bytes written or required

Returns

0 on success, a negative value on failure

Definition at line 22 of file ffi_keywrap.cpp.

                                               {
   if(any_null_pointers(cipher_algo, key, kek)) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
#if defined(BOTAN_HAS_NIST_KEYWRAP)
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(padded != 0 && padded != 1) {
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
      }
      auto bc = Botan::BlockCipher::create_or_throw(cipher_algo);
      bc->set_key(kek, kek_len);
 
      std::vector<uint8_t> output;
 
      if(padded == 0) {
         output = Botan::nist_key_wrap(key, key_len, *bc);
      } else {
         output = Botan::nist_key_wrap_padded(key, key_len, *bc);
      }
 
      return write_vec_output(wrapped_key, wrapped_key_len, output);
   });
#else
   BOTAN_UNUSED(cipher_algo, padded, key, key_len, kek, kek_len, wrapped_key, wrapped_key_len);
   return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}

References Botan_FFI::any_null_pointers(), BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_UNUSED, Botan::BlockCipher::create_or_throw(), Botan_FFI::ffi_guard_thunk(), Botan::nist_key_wrap(), Botan::nist_key_wrap_padded(), and Botan_FFI::write_vec_output().

Referenced by botan_key_wrap3394().