Skip to content

Latest commit

 

History

History
146 lines (114 loc) · 5.03 KB

ReadMe.md

File metadata and controls

146 lines (114 loc) · 5.03 KB
Raw

WjCryptLib

WjCryptLib is a collection of cryptographic functions written in C. Each module is fully independent and generally requires only a single .c file and a a single .h file. AES-CTR does depend on the AES module, so in this case all four files are needed.

The functions are designed to be portable and have been tested on both a Little-Endian and a Big-Endian architecture. OpenMP is supported where parallelisation can occur.

The library and the demo programs can be built using CMake to generate a build setup for any system, including Visual Studio on Windows and Make or Ninja for Linux. Refer to cmake.org to get CMake.

Placed into Public Domain by WaterJuice 2013 - 2018

Library

To use the library functions, only the following files are required, depending on what cryptographic functions are wanted.

  • MD5 - (WjCryptLib_Md5.h, and WjCryptLib_Md5.c)
  • SHA1 - (WjCryptLib_Sha1.h, and WjCryptLib_Sha1.c)
  • SHA256 - (WjCryptLib_Sha256.h, and WjCryptLib_Sha256.c)
  • SHA512 - (WjCryptLib_Sha512.h, and WjCryptLib_Sha512.c)
  • RC4 - (WjCryptLib_Rc4.h, and WjCryptLib_Rc4.c)
  • AES - (WjCryptLib_Aes.h, and WjCryptLib_Aes.c)
  • AES-CTR - (WjCryptLib_AesCtr.h, and WjCryptLib_AesCtr.c, WjCryptLib_Aes.h, and WjCryptLib_Aes.c)
  • AES-OFB - (WjCryptLib_AesOfb.h, and WjCryptLib_AesOfb.c, WjCryptLib_Aes.h, and WjCryptLib_Aes.c)
  • AES-CBC - (WjCryptLib_AesCbc.h, and WjCryptLib_AesCbc.c, WjCryptLib_Aes.h, and WjCryptLib_Aes.c)

Version 2.3.0 - March 2018

  • Added AES-CBC module.
  • Added functions Md5Calculate, Sha1Calculate, Sha256Calculate, and Sha512Calculate to calculate a hash in one call.
  • Added function Rc4XorWithKey to encrypt/decrypt a buffer with RC4 in one call.
  • Bugfix: AesInitialise now returns -1 if invalid key size is provided. Previously it would return 0 despite what was documented.

Version 2.2.0 - January 2018

  • Added AES-OFB module.
  • File names have been changed to have the prefix WjCryptLib_ rather than CryptLib_.
  • Removed compiled binaries from source tree.

Version 2.1.0 - December 2017

Changes:

  • Changed implementation of AES to one which is almost 5 times as fast. The new implementation comes from LibTomCrypt. The newer implementation produces a larger binary size as a trade-off.
  • AES-CTR module now supports OpenMP and when compiled with OpenMP will run in parallel giving a much greater speed.
  • Changed interface for Initialisation functions for both AES and AES-CTR to be match RC4 (The context is first parameter not last)

Version 2.0.0 - December 2017

Changes:

  • Added AES and AES-CTR modules. AES-CTR conforms to the same counter mode used with AES in OpenSSL.
  • All algorithms now work on Big-Endian architectures.
  • Now uses CMake for building rather than make files and Visual Studio projects. CMake will generate whatever system is required.
  • Input function parameters are now marked const
  • File names have been changed to have the prefix CryptLib_ rather than Lib.
  • Various formatting changes to the files.

Version 1.0.0 - June 2013

Contains following algorithms:

  • MD5
  • SHA1
  • SHA256
  • SHA512
  • RC4

Test Programs

In the projects directory there are several programs that compile to command line executables. One is WjCryptLibTest. This tests the algorithms against known test vectors. If compiling on a different system this is useful to verify that the results are still valid.

Additionally there are sample programs that demonstrate the functions. For each of the hash functions there is a program that creates a hash from a string given on command line. For RC4 and AES-CTR there are programs that output the stream in hex.

  • Md5String
  • Sha1String
  • Sha256String
  • Sha512String
  • Rc4Output
  • AesBlock
  • AesCtrOutput
  • AesOfbOutput

Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org/