cryptocol 0.19.8

A cryptographic library that includes big number arithmetic operations, hash algorithms, symmetric-key cryptographic encryption/decryption algorithms, asymmetric-key (public-key) cryptographic encryption/decryption algorithms, pseudo random number generators, etc. Hash algorithms includes MD4, MD5, SHA224, SHA256, SHA384, SHA512, SHA3, etc. Symmetric key encryption algorithms include DES, AES, etc. Public key encryption algorithms include RSA, ECC, etc.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306

// Copyright 2023, 2024, 2025, 2026 PARK Youngho.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your option.
// This file may not be copied, modified, or distributed
// except according to those terms.

#![warn(missing_docs)]
// #![warn(rustdoc::missing_doc_code_examples)]

//! # cryptocol: A Comprehensive Cryptography Library
//!
//! ## Endianness Support
//!
//! `cryptocol` is optimized for **Little-endian** architectures, as they are
//! the most widely used in modern computing. For more detailed information
//! regarding Endianness (Little-endian vs. Big-endian), please read more
//! [here](https://en.wikipedia.org/wiki/Endianness).
//!
//! ### Big-endian Compatibility Notice
//!
//! Support for __Big-endian__ architectures is currently experimental. We do
//! not recommend using this crate on Big-endian systems for production or
//! critical applications. Users choosing to do so assume full responsibility
//! for any potential issues.
//!
//! ## Roadmap for Version 1.0
//!
//! The following features are planned for the `cryptocol` ecosystem.
//!
//! - [X] **Completed:** Implementation and documentation are at least **95%**
//!       complete.
//! - [ ] __In Progress:__ Implementation or documentation is below __95%__, or
//!       work has not yet begun.
//!
//! ### 1. Small Numbers
//! _Foundational types for Big Numbers and other cryptographic modules._
//!
//! - [X] **`SmallUInt` Trait:** Core implementation for primitive unsigned data
//!       types. --
//!       [`SmallUInt`](number/small_uint/trait.SmallUInt.html#trait.SmallUInt)
//! - [X] **Primitive Unions:** Implementation of unions for primitive unsigned
//!       types. --
//!       [`ShortUnion`](number/short_union/union.ShortUnion.html#union.ShortUnion),
//!       [`IntUnion`](number/int_union/union.IntUnion.html#union.IntUnion),
//!       [`LongUnion`](number/long_union/union.LongUnion.html#union.LongUnion),
//!       [`LongerUnion`](number/longer_union/union.LongerUnion.html#union.LongerUnion),
//!       [`SizeUnion`](number/size_union/union.SizeUnion.html#union.SizeUnion),
//!       [`SharedValues`](number/shared_values/union.SharedValues.html#union.SharedValues), and
//!       [`SharedArrays`](number/shared_arrays/union.SharedArrays.html#union.SharedArrays)
// ! - [ ] __`SmallSInt` Trait:__ (Planned) Core implementation for primitive
// !       signed data type. -- `SmallSInt`
// !       ===> Moved to Roadmap for ver. 2.0
//!
//! ### 2. Big Numbers
//! _Essential for Asymmetric-Key Algorithms and high-precision calculations._
//!
//! - [X] **Fixed-Size Big Unsigned Integers:** Standard operations for large
//!       unsigned integers. --
//!       [`BigUInt`](number/big_uint/struct.BigUInt.html#struct.BigUInt).
//! - [X] **Auxiliary Big Unsigned Integer Operations:** Specialized operations
//!       including modular arithmetic and primality testing. --
//!       [`BigUInt_More`](number/trait_big_uint_more/trait.BigUInt_More.html#trait.BigUInt_More),
//!       [`BigUInt_Modular`](number/trait_big_uint_modular/trait.BigUInt_Modular.html#trait.BigUInt_Modular),
//!       [`BigUInt_Prime`](number/trait_big_uint_prime/trait.BigUInt_Prime.html#trait.BigUInt_Prime), and
//!       [`BigUInt_Panic_Free`](number/trait_big_uint_panic_free/trait.BigUInt_Panic_Free.html#trait.BigUInt_Panic_Free).
// ! - [ ] __Fixed-Size Big Signed Integers:__ (Planned) Standard operations for
// !       large signed integers. -- `BigSInt`
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __Variable-Size Big Signed Integers:__ (Planned) Standard operations
// !       for large signed integers. -- `LargeInt`
// !       ===> Moved to Roadmap for ver. 2.0 or higher
//!
//! ### 3. Hash Algorithms
//!
//! #### 3-1. Official SHA-series
//! - [X] **SHA-3 & Keccak:** Supports 8/16/32/64-bit variants, including
//!       SHA3-224/256/384/512 and SHAKE 128/256. --
//!       [`Keccak_Generic`](hash/keccak/struct.Keccak_Generic.html#struct.Keccak_Generic)
//! - [X] **SHA-2 (512/t):** Including 512/256 and 512/224 variants. --
//!       [`SHA2_512_t_Generic`](hash/sha2_512_t/struct.SHA2_512_t_Generic.html#struct.SHA2_512_t_Generic)
//! - [X] **SHA-2 (512-bit):** SHA-512, SHA-384, and SHA-512/256. --
//!       [`SHA2_512_Generic`](hash/sha2_512/struct.SHA2_512_Generic.html#struct.SHA2_512_Generic)
//! - [X] **SHA-2 (256-bit):** SHA-256 and SHA-224. --
//!       [`SHA2_256_Generic`](hash/sha2_256/struct.SHA2_256_Generic.html#struct.SHA2_256_Generic)
//!
//! #### 3-2. Educational Hash Algorithms (Insecure)
//! **Warning:** These are intended for educational purposes only and should
//! not be used for securing sensitive data.
//!
//! - [X] **SHA-1 & SHA-0:** 160-bit hash algorithms. --
//!       [`SHA1_Generic`](hash/sha1/struct.SHA1_Generic.html#struct.SHA1_Generic)
// ! - [ ] __RIPEMD:__ (Planned) 256-bit hash algorithms. --
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __BLAKE3:__ (Planned) 256-bit hash algorithms. --
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __BLAKE2:__ (Planned) 256-bit hash algorithms. --
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __MD6:__ (Planned) 256-bit hash algorithms. --
// !       ===> Moved to Roadmap for ver. 2.0
//! - [X] **MD5:** 128-bit hash algorithm. --
//!       [`MD5_Generic`](hash/md5/struct.MD5_Generic.html#struct.MD5_Generic)
//! - [X] **MD4:** 128-bit hash algorithm. --
//!       [`MD4_Generic`](hash/md4/struct.MD4_Generic.html#struct.MD4_Generic)
// ! - [ ] __MD2:__ (Planned) 128-bit hash algorithms. --
// !       ===> Moved to Roadmap for ver. 2.0
//!
//! ### 4. Symmetric-Key Algorithms (Block Ciphers)
//! #### 4-1. AES Finalists
//! - [X] **AES (Advanced Encryption Standard) & Rijndael:** Full support for
//!       AES/Rijndael with various operation modes (ECB, CBC, PCBC, CFB, OFB,
//!       CTR) and padding schemes (PKCS#7, ISO 7816-4). --
//!       [`Rijndael_Generic`](symmetric/struct.Rijndael_Generic.html#struct.Rijndael_Generic),
//!       [`ECB_PKCS7`](symmetric/trait.ECB_PKCS7.html#trait.ECB_PKCS7),
//!       [`ECB_ISO`](symmetric/trait.ECB_ISO.html#trait.ECB_ISO),
//!       [`CBC_PKCS7`](symmetric/trait.CBC_PKCS7.html#trait.CBC_PKCS7),
//!       [`CBC_ISO`](symmetric/trait.CBC_ISO.html#trait.CBC_ISO),
//!       [`PCBC_PKCS7`](symmetric/trait.PCBC_PKCS7.html#trait.PCBC_PKCS7),
//!       [`PCBC_ISO`](symmetric/trait.PCBC_ISO.html#trait.PCBC_ISO),
//!       [`CFB`](symmetric/trait.CFB.html#trait.CFB),
//!       [`OFB`](symmetric/trait.OFB.html#trait.OFB), and
//!       [`CTR`](symmetric/trait.CTR.html#trait.CTR).
// ! - [ ] __MARS:__ (Planned) Full support for MARS with various operation
// !       modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding schemes (PKCS#7,
// !       ISO 7816-4). -- `MARS_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __Serpent:__ (Planned) Full support for Serpent with various
// !       operation modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding schemes
// !       (PKCS#7, ISO 7816-4). -- `Serpent_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __Twofish:__ (Planned) Full support for Twofish with various
// !       operation modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding schemes
// !       (PKCS#7, ISO 7816-4). -- `Twofish_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __RC6:__ (Planned) Full support for RC6 with various operation
// !       modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding schemes (PKCS#7,
// !       ISO 7816-4). -- `RC6_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// !
// ! #### 4-2. South Korean Encryption/Decryption algorithms
// ! - [ ] __SEED:__ (Planned) Full support for SEED with various operation
// !       modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding schemes (PKCS#7,
// !       ISO 7816-4). -- `SEED_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __HIGHT:__ (Planned) Full support for HIGHT with various operation
// !       modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding schemes (PKCS#7,
// !       ISO 7816-4). -- `HIGHT_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __ARIA:__ (Planned) Full support for ARIA with various operation
// !       modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding schemes (PKCS#7,
// !       ISO 7816-4). -- `ARIA_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __LEA:__ (Planned) Full support for LEA with various operation
// !       modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding schemes (PKCS#7,
// !       ISO 7816-4). -- `LEA_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __IDEA:__ (Planned) Full support for IDEA with various operation
// !       modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding schemes (PKCS#7,
// !       ISO 7816-4). -- `IDEA_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// !
// ! #### 4-3. Miscellaneous Encryption/Decryption algorithms
// ! - [ ] __Bluefish:__ (Planned) Full support for Bluefish with various
// !       operation modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding schemes
// !       (PKCS#7, ISO 7816-4). -- `Bluefish_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __RC5:__ (Planned) Full support for RC5 with various operation
// !       modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding schemes (PKCS#7,
// !       ISO 7816-4). -- `RC5_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
//!
//! #### 4-2. Educational Block Ciphers (Insecure)
//! **Warning:** These are intended for educational purposes only and should
//! not be used for securing sensitive data.
//!
// ! - [ ] __RC2:__ (Planned) Standard DES implementation with multiple modes
// !       (ECB, CBC, PCBC, CFB, OFB, CTR) and padding options (PKCS#7, ISO
// !       7816-4). -- `RC2_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
//! - [X] **DES (Data Encryption Standard):** Standard DES implementation with
//!       multiple modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding options
//!       (PKCS#7, ISO 7816-4). --
//!       [`DES_Generic`](symmetric/struct.DES_Generic.html#struct.DES_Generic),
//!       [`ECB_PKCS7`](symmetric/trait.ECB_PKCS7.html#trait.ECB_PKCS7),
//!       [`ECB_ISO`](symmetric/trait.ECB_ISO.html#trait.ECB_ISO),
//!       [`CBC_PKCS7`](symmetric/trait.CBC_PKCS7.html#trait.CBC_PKCS7),
//!       [`CBC_ISO`](symmetric/trait.CBC_ISO.html#trait.CBC_ISO),
//!       [`PCBC_PKCS7`](symmetric/trait.PCBC_PKCS7.html#trait.PCBC_PKCS7),
//!       [`PCBC_ISO`](symmetric/trait.PCBC_ISO.html#trait.PCBC_ISO),
//!       [`CFB`](symmetric/trait.CFB.html#trait.CFB),
//!       [`OFB`](symmetric/trait.OFB.html#trait.OFB), and
//!       [`CTR`](symmetric/trait.CTR.html#trait.CTR).
// ! - [ ] __Lucifer:__ (Planned) Standard Lucifer implementation with multiple
// !       modes (ECB, CBC, PCBC, CFB, OFB, CTR) and padding options (PKCS#7,
// !       ISO 7816-4). -- `Lucifer_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
//!
//! #### 4-3. Combined Cipher Containers
//! - [X] **BigCryptor128:** A tool for combining multiple symmetric
//!       algorithms (e.g., 2AES, 3AES) with multiple modes (ECB, CBC, PCBC,
//!       CFB, OFB, CTR) and padding options (PKCS#7, ISO 7816-4). --
//!       [`BigCryptor128`](symmetric/struct.BigCryptor128.html#struct.BigCryptor128),
//!       [`ECB_PKCS7`](symmetric/trait.ECB_PKCS7.html#trait.ECB_PKCS7),
//!       [`ECB_ISO`](symmetric/trait.ECB_ISO.html#trait.ECB_ISO),
//!       [`CBC_PKCS7`](symmetric/trait.CBC_PKCS7.html#trait.CBC_PKCS7),
//!       [`CBC_ISO`](symmetric/trait.CBC_ISO.html#trait.CBC_ISO),
//!       [`PCBC_PKCS7`](symmetric/trait.PCBC_PKCS7.html#trait.PCBC_PKCS7),
//!       [`PCBC_ISO`](symmetric/trait.PCBC_ISO.html#trait.PCBC_ISO),
//!       [`CFB`](symmetric/trait.CFB.html#trait.CFB),
//!       [`OFB`](symmetric/trait.OFB.html#trait.OFB), and
//!       [`CTR`](symmetric/trait.CTR.html#trait.CTR).
//!
//! _Note: While supported, using native AES-256 or specific Rijndael variants
//! is generally recommended over 2AES/3AES for better security and
//! performance._
//!
//! - [X] **BigCryptor64:** A tool for combining multiple symmetric
//!       algorithms (e.g., 2DES, 3DES) with multiple modes (ECB, CBC, PCBC,
//!       CFB, OFB, CTR) and padding options (PKCS#7, ISO 7816-4). --
//!       [`BigCryptor64`](symmetric/struct.BigCryptor64.html#struct.BigCryptor64),
//!       [`ECB_PKCS7`](symmetric/trait.ECB_PKCS7.html#trait.ECB_PKCS7),
//!       [`ECB_ISO`](symmetric/trait.ECB_ISO.html#trait.ECB_ISO),
//!       [`CBC_PKCS7`](symmetric/trait.CBC_PKCS7.html#trait.CBC_PKCS7),
//!       [`CBC_ISO`](symmetric/trait.CBC_ISO.html#trait.CBC_ISO),
//!       [`PCBC_PKCS7`](symmetric/trait.PCBC_PKCS7.html#trait.PCBC_PKCS7),
//!       [`PCBC_ISO`](symmetric/trait.PCBC_ISO.html#trait.PCBC_ISO),
//!       [`CFB`](symmetric/trait.CFB.html#trait.CFB),
//!       [`OFB`](symmetric/trait.OFB.html#trait.OFB), and
//!       [`CTR`](symmetric/trait.CTR.html#trait.CTR).
//!
// ! ### 5. Symmetric-Key Algorithms (Stream Ciphers)
// ! - [ ] __Chacha20:__ (Planned) Full support for Chacha20. --
// !       `Chacha20_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// ! - [ ] __Salsa20:__ (Planned) Full support for Chacha20. --
// !       `Salsa20_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// !
// ! #### 5-1. Educational Stream Ciphers (Insecure)
// ! - [ ] __RC4:__ (Planned) Full support for RC4. -- `RC4_Generic`
// !       ===> Moved to Roadmap for ver. 2.0
// !
//! ### 5. Pseudo-Random Number Generators (PRNG)
//! - [X] **Generic PRNG Framework:** --
//!       struct [`Random_Generic`](random/struct.Random_Generic.html#struct.Random_Generic) and
//!       trait [`Random_Engine`](random/trait_random_engine/trait.Random_Engine.html#trait.Random_Engine)
//! - [X] **Hash-based PRNGs:** Engines leveraging Keccak, SHA-3, SHA-2, and
//!       others. --
//!       [`Random_BIG_KECCAK_1024`](random/struct.Random_BIG_KECCAK_1024.html#struct.Random_BIG_KECCAK_1024),
//!       [`Random_SHA3_512`](random/struct.Random_SHA3_512.html#struct.Random_SHA3_512),
//!       [`Random_SHA2_512`](random/struct.Random_SHA2_512.html#struct.Random_SHA2_512),
//!       [`Any_SHAKE_256`](random/struct.Any_SHAKE_256.html#struct.Any_SHAKE_256),
//!       [`Any_SHAKE_128`](random/struct.Any_SHAKE_128.html#struct.Any_SHAKE_128),
//!       [`Any_SHA3_512`](random/struct.Any_SHA3_512.html#struct.Any_SHA3_512),
//!       [`Any_SHA3_256`](random/struct.Any_SHA3_256.html#struct.Any_SHA3_256),
//!       [`Any_SHA2_512`](random/struct.Any_SHA2_512.html#struct.Any_SHA2_512),
//!       [`Any_SHA2_256`](random/struct.Any_SHA2_256.html#struct.Any_SHA2_256),
//!       [`Slapdash_SHA1`](random/struct.Slapdash_SHA1.html#struct.Slapdash_SHA1),
//!       [`Slapdash_SHA0`](random/struct.Slapdash_SHA0.html#struct.Slapdash_SHA0),
//!       [`Slapdash_MD5`](random/struct.Slapdash_MD5.html#struct.Slapdash_MD5), and
//!       [`Slapdash_MD4`](random/struct.Slapdash_MD4.html#struct.Slapdash_MD4).
//! - [X] **Cipher-based PRNGs:** Engines leveraging Rijndael and DES. --
//!       [`Random_Rijndael`](random/struct.Random_Rijndael.html#struct.Random_Rijndael),
//!       [`Any_Rijndael`](random/struct.Any_Rijndael.html#struct.Any_Rijndael), and
//!       [`Slapdash_DES`](random/struct.Slapdash_DES.html#struct.Slapdash_DES).
//! - [X] **Simple PRNGs:** Basic randomization algorithms like
//!       [`Slapdash_Num_C`](random/struct.Slapdash_Num_C.html#struct.Slapdash_Num_C).
//!
//! ### 6. Asymmetric-Key Algorithms
//!
//! - [ ] __ECC (Elliptic Curve Cryptography):__ (Planned) Generic ECC
//!       implementation with padding support. --
//!       `ECC_Generic`.
//! - [ ] __RSA (Ron Rivest, Adi Samir, Leonard Adleman):__ (In Progress)
//!       Implementation of RSA with PKCS #1 v1.5 and OAEP (Optimal Asymmetric
//!       Encryption Padding) (PKCS #1 v2.0/RFC 2437) padding. --
//!       [`RSA_Generic`](asymmetric/struct.RSA_Generic.html#struct.RSA_Generic),
//!       [`PKCS1V15`](asymmetric/trait.PKCS1V15.html#trait.PKCS1V15), and
//!       OAEP.
//!
//! ## Versioning Policy
//! The project will reach Version 1.0.0.0 once all twenty-one functional
//! areas listed above are fully implemented.
//!
//! - __Pre-v1.0:__ Versions will range up to 0.21.x.x based on the progress
//!   of the listed functionalities.
//! - **Post-v1.0:** New features will increment the version beyond 1.0.0.0.
//!
//! _Note: Version numbers like 0.5.0.0 indicate progress through the
//! functionality list, not necessarily a 50% completion of the entire
//! codebase._


#![doc(
    html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
    html_favicon_url = "https://www.rust-lang.org/favicon.ico",
    html_root_url = "https://rust-random.github.io/rand/"
)]

pub mod number;
pub mod hash;
pub mod symmetric;
pub mod random;
pub mod asymmetric;
pub(crate) mod concurrency;