Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 3.02 KB

README.md

File metadata and controls

43 lines (30 loc) · 3.02 KB
Raw

Hexacrypt-API

C shared library for the Hexacrypt algorithm

Compiling and Running

This library is designed to work with the cross-platform IDE Code::Blocks. To compile, open Hexacrypt-API.cbp in Code::Blocks, and it should compile.

  • On Windows, it compiles to Hexacrypt-API.dll
  • On Mac/Linux, it compiles to Hexacrypt-API.so

When compiling for Windows, you might need to define the constant _WIN32. In the Code::Blocks toolbar, go to Settings -> Compiler Settings -> Global Compiler Settings. Under the tab #defines, add the line _Win32.

Cross-Platform Support

This shared library is designed to work on any platform. The file Dll.h defines the various constants needed to compile the .dll on Windows or the .so file on Mac/Linux. The file Hexacrypt-API.c also contains the DllMain function needed by Windows DLL files.

Targets

Hexacrypt-API defines 3 targets to use when compiling:

  • Debug - Compile an executible to test the code (located in bin/Debug)
  • Executable - Compile a command-line utility to run the various Hexacrypt algorithms from the command line (located in bin/Executable)
  • Release - Compile the .dll or .so file (located in bin/Release)

For the Debug target, Tester.c holds the main function used to compile the code. This target should be used for quickly testing new features in the code.

For the Executable target, Runner.c holds the code to the command line utility (and the main function). This code is designed to test the Hexacrypt library functions as a whole and not individual features. This code is written to be modular and expandable as more Hexacrypt functions in the future.

Algorithms Supported

  • Hexacrypt - The origional Hexacrypt algorithm as first programmed in Visual Basic. (see other notes)
  • Hexacrypt Plus - A new algorithm that improves on the old, adding multiple rounds of encryption, message scrambling (called Matrix Code), key expansion, and a better garbage system

Algorithms to Add

  • Hexabyte - Encrypt a binary string as opposed to a plain text string
  • HexaHash - Hash a string
  • ByteHash - Hash a binary string

Other Notes

This version of Hexacrypt is NOT COMPATIBLE with the Hexacrypt programmed for Visual Basic and PHP. In the process of writing Hexacrypt-API, I made some optimizations and other improvements to the origional Hexacrypt algorithm. My plan is to modify Hexacrypt and Hexacrypt-PHP in the near future to reflect these changes.

Here is a list of what I changed:

  • Removed the checksum
  • PseudoXOR uses the previous scrambled key string to scramble the new key string
  • The garbage can sometimes put "corrupted" garbage indexes on the string, and this decrypts just fine. Before, "corrupted" garbage returned an error.
  • The encrypted message is guaranteed to decrypt, even if the key is incorrect. Often times, a bad key will decrypt to an empty string "".