mirrors/tc_tea_rust
1
0
Fork 0
mirror of https://github.com/jixunmoe/tc_tea_rust synced 2026-03-08 04:29:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: module doc + readme

Browse Source
This commit is contained in:
Jixun Wu
2021-12-28 23:07:20 +00:00
parent 00c5b318fd
commit ab6bca0ba6
5 changed files with 23 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Cargo.toml
View File

@@ -2,7 +2,7 @@
[package] [package]
name = "tc_tea" name = "tc_tea"
version = "0.1.0" version = "0.1.1"
authors = ["Jixun Wu <jixun.moe@gmail.com>"] authors = ["Jixun Wu <jixun.moe@gmail.com>"]
edition = "2021" edition = "2021"

1
LICENSE Normal file
View File

@@ -0,0 +1 @@
MIT OR Apache-2.0 license

18
README.md
View File

@@ -16,16 +16,16 @@ Code implemented according to the spec described in
Add the following to `[dependencies]` section in your `Cargo.toml` file: Add the following to `[dependencies]` section in your `Cargo.toml` file:
```toml ```toml
tc_tea = "0.1.0" tc_tea = "0.1.1"
``` ```
## Failures ## Troubleshooting
* Key size needs to be `>= 16` bytes. * Key need to have `16` bytes or more.
* `None` will be returned in this case. * `None` will be returned if less than `16` bytes provided.
* Only first 16 bytes are used. * If more bytes were provided, only the first 16 bytes will be used.
* Encrypted size are always multiple of 8. * Encrypted data should have a size that is multiple of 8.
* `None` will be returned in this case. * `None` will be returned if `encrypted_data.len() % 8 > 0`.
## Usage ## Usage
@@ -44,7 +44,9 @@ fn hello_tc_tea() {
Dual licensed under MIT OR Apache-2.0 license. Dual licensed under MIT OR Apache-2.0 license.
`SPDX-License-Identifier: MIT OR Apache-2.0` ```license
SPDX-License-Identifier: MIT OR Apache-2.0
```
[tc_tea_cpp]: https://github.com/TarsCloud/TarsCpp/blob/a6d5ed8/util/src/tc_tea.cpp [tc_tea_cpp]: https://github.com/TarsCloud/TarsCpp/blob/a6d5ed8/util/src/tc_tea.cpp
[tc_tea_spec]: https://github.com/iweizime/StepChanger/wiki/%E8%85%BE%E8%AE%AFTEA%E5%8A%A0%E5%AF%86%E7%AE%97%E6%B3%95 [tc_tea_spec]: https://github.com/iweizime/StepChanger/wiki/%E8%85%BE%E8%AE%AFTEA%E5%8A%A0%E5%AF%86%E7%AE%97%E6%B3%95

1
src/lib.rs
View File

@@ -1,4 +1,5 @@
//! _Tencent modified TEA_ (tc_tea) is a variant of the standard TEA (Tiny Encryption Algorithm). //! _Tencent modified TEA_ (tc_tea) is a variant of the standard TEA (Tiny Encryption Algorithm).
//!
//! Notably, it uses a different round number and uses a "tweaked" CBC mode. //! Notably, it uses a different round number and uses a "tweaked" CBC mode.
mod stream_ext; mod stream_ext;

13
src/tc_tea.rs
View File

@@ -8,6 +8,9 @@ const SALT_LEN: usize = 2;
const ZERO_LEN: usize = 7; const ZERO_LEN: usize = 7;
const FIXED_PADDING_LEN: usize = 1 + SALT_LEN + ZERO_LEN; const FIXED_PADDING_LEN: usize = 1 + SALT_LEN + ZERO_LEN;
/// Calculate expected size of encrypted data.
///
/// `body_size` is the size of data you'd like to encrypt.
pub fn calc_encrypted_size(body_size: usize) -> usize { pub fn calc_encrypted_size(body_size: usize) -> usize {
let len = FIXED_PADDING_LEN + body_size; let len = FIXED_PADDING_LEN + body_size;
let pad_len = (8 - (len & 0b0111)) & 0b0111; let pad_len = (8 - (len & 0b0111)) & 0b0111;
@@ -15,13 +18,16 @@ pub fn calc_encrypted_size(body_size: usize) -> usize {
} }
/// Encrypts an arbitrary length sized data in the following way: /// Encrypts an arbitrary length sized data in the following way:
///
/// * PadLen (1 byte) /// * PadLen (1 byte)
/// * Padding (variable, 0-7byte) /// * Padding (variable, 0-7byte)
/// * Salt (2 bytes) /// * Salt (2 bytes)
/// * Body (? bytes) /// * Body (? bytes)
/// * Zero (7 bytes) /// * Zero (7 bytes)
/// PadLen/Padding/Salt is random bytes. Minimum of 3 bytes. ///
/// PadLen is taken from the last 3 bit of the first byte. /// Returned bytes will always have a length multiple of 8.
///
/// PadLen/Padding/Salt are randomly bytes, with a minimum of 21 bits (3 * 8 - 3) randomness.
/// ///
/// # Panics /// # Panics
/// ///
@@ -78,12 +84,13 @@ pub fn encrypt<T: AsRef<[u8]>, K: AsRef<[u8]>>(plaintext: T, key: K) -> Option<B
} }
/// Decrypts a byte array containing the following: /// Decrypts a byte array containing the following:
///
/// * PadLen (1 byte) /// * PadLen (1 byte)
/// * Padding (variable, 0-7byte) /// * Padding (variable, 0-7byte)
/// * Salt (2 bytes) /// * Salt (2 bytes)
/// * Body (? bytes) /// * Body (? bytes)
/// * Zero (7 bytes) /// * Zero (7 bytes)
/// PadLen/Padding/Salt is random bytes. Minimum of 3 bytes. ///
/// PadLen is taken from the last 3 bit of the first byte. /// PadLen is taken from the last 3 bit of the first byte.
pub fn decrypt<T: AsRef<[u8]>, K: AsRef<[u8]>>(encrypted: T, key: K) -> Option<Box<[u8]>> { pub fn decrypt<T: AsRef<[u8]>, K: AsRef<[u8]>>(encrypted: T, key: K) -> Option<Box<[u8]>> {
let encrypted = encrypted.as_ref(); let encrypted = encrypted.as_ref();