encryptionfunctions.h

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
#ifndef ENCRYPTION_FUNCTIONS_H
#define ENCRYPTION_FUNCTIONS_H
 
#include <string>
 
namespace modelspace {
 
    const int MAX_SIZE_CHAR = 0xFF;
 
    /// @brief Function to perform a simple encryption of a buffer of data
    /// @param unencrypted The unencrypted buffer to encrypt
    /// @param encrypted The encrypted buffer result
    /// @param size The size of the buffer
    /// @param key The encryption key to use for the buffer
    void simpleEncrypt(char* unencrypted, char* encrypted, char size, const std::string &key);
 
    /// @brief Function to decrypt a buffer of data -- companion to simpleEncrypt
    /// @param unencrypted The encrypted buffer to decrypt
    /// @param encrypted The unencrypted buffer result
    /// @param size The size of the buffer
    /// @param key The encryption key to use for the buffer
    void simpleDecrypt(char* encrypted, char* unencrypted, char size, const std::string &key);
 
    /// @brief Function to write a buffer of bytes to a file, along with their size
    /// @param buffer The buffer of data to write to file
    /// @param buffer_size The size of the buffer to be written
    /// @param filename The name of the file to write to
    void writeFileBinarySize(char* buffer, char buffer_size, const std::string &filename);
 
    /// @brief Function to read a buffer of bytes from a file
    /// @param buffer The buffer of data to read from -- max size is the max value of a char
    /// @param buffer_size The size of the buffer to be written
    /// @param filename The name of the file to write to
    void readFileBinarySize(char buffer[MAX_SIZE_CHAR], char* size_actual, const std::string &filename);
 
}
 
#endif