Crate cryptocol

Source
Expand description

cryptocol crate provides libraries for cryptography.

This crate is optimized for Little-endian CPUs because Little-Endian CPUs are far more popular than Big-endian CPUs. For the information about Endianness (including Little-endian and Big-endian) Read more.

The webserver docs.rs has been failing in generating BigUInt page from ver. 0.8.5 on for some technical reason that has not been solved yet. If the webserver docs.rs fails in generating BigUInt page in this version, too, you can download the manual here. I hope that it will be fixed soon.

§Big-endian issue

This crate is just experimental for Big-endian CPUs. So, you are not encouraged to use this crate for Big-endian CPUs for serious purpose. Only use this crate for Big-endian CPUs with your own full responsibility.

§Road Map for Version 1.0

This crate Cryptocol is planned to provide the following functionalities. The checked items have already been implemented including documentation at least 95%. The unchecked items have been implemented including documentation less than 95% or have not yet even been started to implement.

§Small Numbers: meaningful as itself, and also foundations mainly for Big Numbers as well as for other modules

§Big Numbers: meaningful as itself and also the foundation for Asymmetric-Key Algorithms

  • Fixed Sized Big Unsigned Integer Operation — BigUInt

§Hash Algorithms

  • MD4 hash algorithms based on 128 bits — Includes MD4 and its expanded versions. MD4_Generic
  • MD5 hash algorithms based on 128 bits — Includes MD5 and its expanded versions. MD5_Generic
  • SHA-1 hash algorithms based on 160 bits — Includes SHA-1, SHA-0, and their expanded versions. SHA1_Generic
  • SHA-2 hash algorithms based on 256 bits — Includes SHA-256, SHA-224, and their expanded versions. SHA2_256_Generic
  • SHA-2 hash algorithms based on 512 bits — Includes SHA-512, SHA-384, SHA-512/256, and their expanded versions. SHA2_512_Generic
  • SHA-2 hash algorithms based on 512/t bits — Includes 512/256, SHA-512/224, and their expanded versions. SHA2_512_t_Generic
  • SHA-3 (SHA3-224)
  • SHA-3 (SHA3-256)
  • SHA-3 (SHA3-384)
  • SHA-3 (SHA3-512)
  • SHA-3 (SHAKE 128)
  • SHA-3 (SHAKE 256)

§Symmetric-key Algorithms for the Encryption/Decryption of digital data

  • DES symmetric-key encryption/decryption algorithm — Includes DES and its expanded versions. DES_Generic
  • NDES symmetric-key encryption/decryption algorithm — Includes 2DES, 3DES, 4DES, etc., and their expanded versions. NDES_Generic
  • AES symmetric-key encryption/decryption algorithm — Includes AES and its expanded versions. AES_Generic
  • NAES symmetric-key encryption/decryption algorithm — Includes 2AES, 3AES, 4AES, etc., and their expanded versions. NAES_Generic

§Pseudo-Random Number Generator Algorithms

§Asymmetric-Key Algorithms for the Encryption/Decryption of digital data

  • RSA (Ron Rivest, Adi Shamir, Leonard Adleman)
  • ECC (Elliptic Curve Cryptosystem)

When the implementation of all the above functionalitis are completed, the version number 1.0.0.0 will be given. After that whenever another functionality is added to this crate, the version number will get higher beyond 1.0.0.0. Before the version number 1.0.0.0, the maximum version number will be 0.25.x.x since there are all twenty-five functionalities listed above. So, for example, even if the version number is 0.5.0.0, it does not mean that 50% of all functionalities are implemented.

Modules§

hash
various cryptographic hash functions
number
various numbers such as small fixed-sized unsigned integers, small fixed-sized signed integers, small fixed-sized integer unions, big fixed-sized unsigned integers, big fixed-sized signed integers, and large variable-sized signed integers
random
various pseudo-random number generators
symmetric
various symmetric-key algorithms for the encryption/decryption of digital data

Macros§

define_utypes_with
The macro that defines the types U256, U512, U1024, U2048, U3072, U4096, U5120, U6144, U7168, U8192, and U16384.
define_utypes_with_u8
The macro that defines the types U256, U512, U1024, U2048, U3072, U4096, U5120, U6144, U7168, U8192, and U16384 based on u8.
define_utypes_with_u16
The macro that defines the types U256, U512, U1024, U2048, U3072, U4096, U5120, U6144, U7168, U8192, and U16384 based on u16.
define_utypes_with_u32
The macro that defines the types U256, U512, U1024, U2048, U3072, U4096, U5120, U6144, U7168, U8192, and U16384 based on u32.
define_utypes_with_u64
The macro that defines the types U256, U512, U1024, U2048, U3072, U4096, U5120, U6144, U7168, U8192, and U16384 based on u64.
define_utypes_with_u128
The macro that defines the types U256, U512, U1024, U2048, U3072, U4096, U5120, U6144, U7168, U8192, and U16384 based on u128.