/*

 * Key metadata entry functions

 *

 * Copyright (C) 2011-2025, Joachim Metz <joachim.metz@gmail.com>

 *

 * Refer to AUTHORS for acknowledgements.

 *

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU Lesser General Public License as published by

 * the Free Software Foundation, either version 3 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public License

 * along with this program.  If not, see <https://www.gnu.org/licenses/>.

 */

#include <common.h>

#include <byte_stream.h>

#include <memory.h>

#include <types.h>

#include "libbde_debug.h"

#include "libbde_definitions.h"

#include "libbde_key.h"

#include "libbde_libcerror.h"

#include "libbde_libcnotify.h"

#include "libbde_metadata_entry.h"

#include "bde_metadata.h"

/* Creates a key

 * Make sure the value key is referencing, is set to NULL

 * Returns 1 if successful or -1 on error

 */

int libbde_key_initialize(

     libbde_key_t **key,

     libcerror_error_t **error )

{

  static char *function = "libbde_key_initialize";

  if( key == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid key.",

     function );

    return( -1 );

  }

  if( *key != NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,

     "%s: invalid key value already set.",

     function );

    return( -1 );

  }

  *key = memory_allocate_structure(

          libbde_key_t );

  if( *key == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create key.",

     function );

    goto on_error;

  }

  if( memory_set(

       *key,

       0,

       sizeof( libbde_key_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_SET_FAILED,

     "%s: unable to clear key.",

     function );

    goto on_error;

  }

  return( 1 );

on_error:

  if( *key != NULL )

  {

    memory_free(

     *key );

    *key = NULL;

  }

  return( -1 );

}

/* Frees a key

 * Returns 1 if successful or -1 on error

 */

int libbde_key_free(

     libbde_key_t **key,

     libcerror_error_t **error )

{

  static char *function = "libbde_key_free";

  if( key == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid key.",

     function );

    return( -1 );

  }

  if( *key != NULL )

  {

    if( ( *key )->data != NULL )

    {

      memory_free(

       ( *key )->data );

    }

    memory_free(

     *key );

    *key = NULL;

  }

  return( 1 );

}

/* Reads a key from the metadata entry

 * Returns 1 if successful or -1 on error

 */

int libbde_key_read(

     libbde_key_t *key,

     libbde_metadata_entry_t *metadata_entry,

     libcerror_error_t **error )

{

  uint8_t *value_data    = NULL;

  static char *function  = "libbde_key_read";

  size_t value_data_size = 0;

  if( key == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid key.",

     function );

    return( -1 );

  }

  if( metadata_entry == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid metadata entry.",

     function );

    return( -1 );

  }

  if( metadata_entry->value_data == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_MISSING,

     "%s: invalid metadata entry - missing value data.",

     function );

    return( -1 );

  }

  if( metadata_entry->value_type != LIBBDE_VALUE_TYPE_KEY )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,

     "%s: invalid metadata entry - unsupported value type: 0x%04" PRIx16 ".",

     function,

     metadata_entry->value_type );

    return( -1 );

  }

  value_data      = metadata_entry->value_data;

  value_data_size = metadata_entry->value_data_size;

  if( ( value_data_size < sizeof( bde_metadata_entry_key_header_t ) )

   || ( value_data_size > MEMORY_MAXIMUM_ALLOCATION_SIZE ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

     "%s: invalid metadata entry - value data size value out of bounds.",

     function );

    return( -1 );

  }

  byte_stream_copy_to_uint32_little_endian(

   ( (bde_metadata_entry_key_header_t *) value_data )->encryption_method,

   key->encryption_method );

#if defined( HAVE_DEBUG_OUTPUT )

  if( libcnotify_verbose != 0 )

  {

    libcnotify_printf(

     "%s: encryption method\t\t\t\t\t: 0x%08" PRIx32 " (%s)\n",

     function,

     key->encryption_method,

     libbde_debug_print_encryption_method(

      key->encryption_method ) );

  }

#endif

  value_data      += sizeof( bde_metadata_entry_key_header_t );

  value_data_size -= sizeof( bde_metadata_entry_key_header_t );

#if defined( HAVE_DEBUG_OUTPUT )

  if( libcnotify_verbose != 0 )

  {

    libcnotify_printf(

     "%s: key data:\n",

     function );

    libcnotify_print_data(

     value_data,

     value_data_size,

     0 );

  }

#endif

  key->data = (uint8_t *) memory_allocate(

                           sizeof( uint8_t ) * value_data_size );

  if( key->data == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create data.",

     function );

    goto on_error;

  }

  if( memory_copy(

       key->data,

       value_data,

       value_data_size ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_COPY_FAILED,

     "%s: unable to copy data to key.",

     function );

    goto on_error;

  }

  key->data_size = value_data_size;

  return( 1 );

on_error:

  if( key->data != NULL )

  {

    memory_free(

     key->data );

    key->data = NULL;

  }

  return( -1 );

}