/*
 * Windows NT Access Control List (ACL) functions
 *
 * Copyright (C) 2009-2024, 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 "libfwnt_access_control_entry.h"
#include "libfwnt_access_control_list.h"
#include "libfwnt_definitions.h"
#include "libfwnt_libcerror.h"
#include "libfwnt_libcnotify.h"
#include "libfwnt_types.h"

/* Creates an access control list
 * Make sure the value access_control_list is referencing, is set to NULL
 * Returns 1 if successful or -1 on error
 */
int libfwnt_access_control_list_initialize(
     libfwnt_access_control_list_t **access_control_list,
     libcerror_error_t **error )
{
	libfwnt_internal_access_control_list_t *internal_access_control_list = NULL;
	static char *function                                                = "libfwnt_access_control_list_initialize";

	if( access_control_list == NULL )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
		 LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
		 "%s: invalid access control list.",
		 function );

		return( -1 );
	}
	if( *access_control_list != NULL )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_RUNTIME,
		 LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,
		 "%s: invalid access control list value already set.",
		 function );

		return( -1 );
	}
	internal_access_control_list = memory_allocate_structure(
	                                libfwnt_internal_access_control_list_t );

	if( internal_access_control_list == NULL )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_MEMORY,
		 LIBCERROR_MEMORY_ERROR_INSUFFICIENT,
		 "%s: unable to create access control list.",
		 function );

		goto on_error;
	}
	if( memory_set(
	     internal_access_control_list,
	     0,
	     sizeof( libfwnt_internal_access_control_list_t ) ) == NULL )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_MEMORY,
		 LIBCERROR_MEMORY_ERROR_SET_FAILED,
		 "%s: unable to clear access control list.",
		 function );

		goto on_error;
	}
	*access_control_list = (libfwnt_access_control_list_t *) internal_access_control_list;

	return( 1 );

on_error:
	if( internal_access_control_list != NULL )
	{
		memory_free(
		 internal_access_control_list );
	}
	return( -1 );
}

/* Frees an access control list
 * Returns 1 if successful or -1 on error
 */
int libfwnt_access_control_list_free(
     libfwnt_access_control_list_t **access_control_list,
     libcerror_error_t **error )
{
	static char *function = "libfwnt_access_control_list_free";

	if( access_control_list == NULL )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
		 LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
		 "%s: invalid access control list.",
		 function );

		return( -1 );
	}
	if( *access_control_list != NULL )
	{
		*access_control_list = NULL;
	}
	return( 1 );
}

/* Frees an access control list
 * Returns 1 if successful or -1 on error
 */
int libfwnt_internal_access_control_list_free(
     libfwnt_internal_access_control_list_t **internal_access_control_list,
     libcerror_error_t **error )
{
	static char *function = "libfwnt_internal_access_control_list_free";
	int result            = 1;

	if( internal_access_control_list == NULL )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
		 LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
		 "%s: invalid access control list.",
		 function );

		return( -1 );
	}
	if( *internal_access_control_list != NULL )
	{
		if( ( *internal_access_control_list )->entries_array != NULL )
		{
			if( libcdata_array_free(
			     &( ( *internal_access_control_list )->entries_array ),
			     (int (*)(intptr_t **, libcerror_error_t **)) &libfwnt_internal_access_control_entry_free,
			     error ) != 1 )
			{
				libcerror_error_set(
				 error,
				 LIBCERROR_ERROR_DOMAIN_RUNTIME,
				 LIBCERROR_RUNTIME_ERROR_FINALIZE_FAILED,
				 "%s: unable to free entries array.",
				 function );

				result = -1;
			}
		}
		memory_free(
		 *internal_access_control_list );

		*internal_access_control_list = NULL;
	}
	return( result );
}

/* Converts an access control list stored in a byte stream into a runtime version
 * Returns 1 if successful or -1 on error
 */
int libfwnt_access_control_list_copy_from_byte_stream(
     libfwnt_access_control_list_t *access_control_list,
     const uint8_t *byte_stream,
     size_t byte_stream_size,
     int byte_order,
     libcerror_error_t **error )
{
	libfwnt_internal_access_control_entry_t *internal_access_control_entry = NULL;
	libfwnt_internal_access_control_list_t *internal_access_control_list   = NULL;
	static char *function                                                  = "libfwnt_access_control_list_copy_from_byte_stream";
	size_t byte_stream_offset                                              = 0;
	uint16_t entry_index                                                   = 0;
	uint16_t number_of_entries                                             = 0;
	uint16_t size                                                          = 0;

#if defined( HAVE_DEBUG_OUTPUT )
	uint16_t value_16bit                                                   = 0;
#endif

	if( access_control_list == NULL )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
		 LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
		 "%s: invalid access control list.",
		 function );

		return( -1 );
	}
	internal_access_control_list = (libfwnt_internal_access_control_list_t *) access_control_list;

	if( internal_access_control_list->entries_array != NULL )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_RUNTIME,
		 LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,
		 "%s: invalid access control list - entries array value already set.",
		 function );

		return( -1 );
	}
	if( byte_stream == NULL )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
		 LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
		 "%s: invalid byte stream.",
		 function );

		return( -1 );
	}
	if( byte_stream_size < 8 )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
		 LIBCERROR_ARGUMENT_ERROR_VALUE_TOO_SMALL,
		 "%s: byte stream too small.",
		 function );

		return( -1 );
	}
	if( byte_stream_size > (size_t) SSIZE_MAX )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
		 LIBCERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,
		 "%s: byte stream size exceeds maximum.",
		 function );

		return( -1 );
	}
	if( byte_order != LIBFWNT_ENDIAN_LITTLE )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
		 LIBCERROR_ARGUMENT_ERROR_UNSUPPORTED_VALUE,
		 "%s: unsupported byte order.",
		 function );

		return( -1 );
	}
#if defined( HAVE_DEBUG_OUTPUT )
	if( libcnotify_verbose != 0 )
	{
		libcnotify_printf(
		 "%s: header data:\n",
		 function );
		libcnotify_print_data(
		 byte_stream,
		 8,
		 0 );
	}
#endif
	internal_access_control_list->revision_number = byte_stream[ 0 ];

	byte_stream_copy_to_uint16_little_endian(
	 &( byte_stream[ 2 ] ),
	 size );

	byte_stream_copy_to_uint16_little_endian(
	 &( byte_stream[ 4 ] ),
	 number_of_entries );

#if defined( HAVE_DEBUG_OUTPUT )
	if( libcnotify_verbose != 0 )
	{
		libcnotify_printf(
		 "%s: revision number\t: %" PRIu8 "\n",
		 function,
		 internal_access_control_list->revision_number );

		libcnotify_printf(
		 "%s: padding1\t\t: 0x%02" PRIx8 "\n",
		 function,
		 byte_stream[ 1 ] );

		libcnotify_printf(
		 "%s: size\t\t\t: %" PRIu16 "\n",
		 function,
		 size );

		libcnotify_printf(
		 "%s: number of entries\t: %" PRIu16 "\n",
		 function,
		 number_of_entries );

		byte_stream_copy_to_uint16_little_endian(
		 &( byte_stream[ 6 ] ),
		 value_16bit );
		libcnotify_printf(
		 "%s: padding2\t\t: 0x%04" PRIx16 "\n",
		 function,
		 value_16bit );

		libcnotify_printf(
		 "\n" );
	}
#endif
	byte_stream_offset = 8;

/* TODO check bounds of number_of_entries */
	if( libcdata_array_initialize(
	     &( internal_access_control_list->entries_array ),
	     (int) number_of_entries,
	     error ) != 1 )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_RUNTIME,
		 LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,
		 "%s: unable to create entries array.",
		 function );

		goto on_error;
	}
	for( entry_index = 0;
	     entry_index < number_of_entries;
	     entry_index++ )
	{
		if( libfwnt_access_control_entry_initialize(
		     (libfwnt_access_control_entry_t **) &internal_access_control_entry,
		     error ) != 1 )
		{
			libcerror_error_set(
			 error,
			 LIBCERROR_ERROR_DOMAIN_RUNTIME,
			 LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,
			 "%s: unable to create access control entry: %" PRIu16 ".",
			 function,
			 entry_index );

			goto on_error;
		}
		if( libfwnt_access_control_entry_copy_from_byte_stream(
		     (libfwnt_access_control_entry_t *) internal_access_control_entry,
		     &( byte_stream[ byte_stream_offset ] ),
		     byte_stream_size - byte_stream_offset,
		     byte_order,
		     error ) != 1 )
		{
			libcerror_error_set(
			 error,
			 LIBCERROR_ERROR_DOMAIN_RUNTIME,
			 LIBCERROR_RUNTIME_ERROR_COPY_FAILED,
			 "%s: unable to access control entry: %" PRIu16 " from byte stream.",
			 function,
			 entry_index );

			goto on_error;
		}
		if( (size_t) internal_access_control_entry->size > byte_stream_size )

		{
			libcerror_error_set(
			 error,
			 LIBCERROR_ERROR_DOMAIN_RUNTIME,
			 LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
			 "%s: access control entry: %" PRIu16 " size value out of bounds.",
			 function,
			 entry_index );

			goto on_error;
		}
		byte_stream_offset += internal_access_control_entry->size;

		if( libcdata_array_set_entry_by_index(
		     internal_access_control_list->entries_array,
		     (int) entry_index,
		     (intptr_t *) internal_access_control_entry,
		     error ) != 1 )
		{
			libcerror_error_set(
			 error,
			 LIBCERROR_ERROR_DOMAIN_RUNTIME,
			 LIBCERROR_RUNTIME_ERROR_SET_FAILED,
			 "%s: unable to set access control entry: %" PRIu16 ".",
			 function,
			 entry_index );

			goto on_error;
		}
		internal_access_control_entry = NULL;
	}
	return( 1 );

on_error:
	if( internal_access_control_entry != NULL )
	{
		libfwnt_internal_access_control_entry_free(
		 &internal_access_control_entry,
		 NULL );
	}
	if( internal_access_control_list->entries_array != NULL )
	{
		libcdata_array_free(
		 &( internal_access_control_list->entries_array ),
		 (int (*)(intptr_t **, libcerror_error_t **)) &libfwnt_internal_access_control_entry_free,
		 NULL );
	}
	return( -1 );
}

/* Retrieves the number of access control entries
 * Returns 1 if successful or -1 on error
 */
int libfwnt_access_control_list_get_number_of_entries(
     libfwnt_access_control_list_t *access_control_list,
     int *number_of_entries,
     libcerror_error_t **error )
{
	libfwnt_internal_access_control_list_t *internal_access_control_list = NULL;
	static char *function                                                = "libfwnt_access_control_list_get_number_of_entries";

	if( access_control_list == NULL )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
		 LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
		 "%s: invalid access control list.",
		 function );

		return( -1 );
	}
	internal_access_control_list = (libfwnt_internal_access_control_list_t *) access_control_list;

	if( libcdata_array_get_number_of_entries(
	     internal_access_control_list->entries_array,
	     number_of_entries,
	     error ) != 1 )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_RUNTIME,
		 LIBCERROR_RUNTIME_ERROR_GET_FAILED,
		 "%s: unable to retrieve number of access control entries in array.",
		 function );

		return( -1 );
	}
	return( 1 );
}

/* Retrieves a specific access control entry
 * Returns 1 if successful or -1 on error
 */
int libfwnt_access_control_list_get_entry_by_index(
     libfwnt_access_control_list_t *access_control_list,
     int entry_index,
     libfwnt_access_control_entry_t **access_control_entry,
     libcerror_error_t **error )
{
	libfwnt_internal_access_control_list_t *internal_access_control_list = NULL;
	static char *function                                                = "libfwnt_access_control_list_get_entry_by_index";

	if( access_control_list == NULL )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
		 LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
		 "%s: invalid access control list.",
		 function );

		return( -1 );
	}
	internal_access_control_list = (libfwnt_internal_access_control_list_t *) access_control_list;

	if( libcdata_array_get_entry_by_index(
	     internal_access_control_list->entries_array,
	     entry_index,
	     (intptr_t **) access_control_entry,
	     error ) != 1 )
	{
		libcerror_error_set(
		 error,
		 LIBCERROR_ERROR_DOMAIN_RUNTIME,
		 LIBCERROR_RUNTIME_ERROR_GET_FAILED,
		 "%s: unable to retrieve access control entry: %d from array.",
		 function,
		 entry_index );

		return( -1 );
	}
	return( 1 );
}