Crate short_crypt 

ShortCrypt

ShortCrypt is a very simple deterministic encryption library, which aims to encrypt any data into something random at first glance.

Even if these data are similar, the ciphers are still pretty different.

The most important thing is that a cipher contains only 5 bits more information than its plaintext so that it is suitable for data used in a URL or a QR Code. Besides these, it is also an ideal candidate for serial number generation.

ShortCrypt does not provide cryptographic authentication and must not be used to protect sensitive data or resist malicious tampering.

Examples

encrypt method can create a Cipher tuple separating into a base and a body of the cipher. The base contains 5 bits of information and is stored as a u8, while the size of the body is equal to the plaintext.

extern crate short_crypt;

use short_crypt::ShortCrypt;

let sc = ShortCrypt::new("magickey");

assert_eq!((8, [216, 78, 214, 199, 157, 190, 78, 250].to_vec()), sc.encrypt("articles"));
assert_eq!("articles".as_bytes().to_vec(), sc.decrypt(&(8, vec![216, 78, 214, 199, 157, 190, 78, 250])).unwrap());

encrypt_to_url_component method is common for encryption in most cases. After ShortCrypt encrypt a plaintext, it encodes the cipher into a random-like string based on Base64-URL format so that it can be concatenated with URLs.

extern crate short_crypt;

use short_crypt::ShortCrypt;

let sc = ShortCrypt::new("magickey");

assert_eq!("2E87Wx52-Tvo", sc.encrypt_to_url_component("articles"));
assert_eq!("articles".as_bytes().to_vec(), sc.decrypt_url_component("2E87Wx52-Tvo").unwrap());

encrypt_to_qr_code_alphanumeric method is usually used for encrypting something into a QR code. After ShortCrypt encrypt a plaintext, it encodes the cipher into a random-like string based on Base32 format so that it can be inserted into a QR code with the compatibility with alphanumeric mode.

extern crate short_crypt;

use short_crypt::ShortCrypt;

let sc = ShortCrypt::new("magickey");

assert_eq!("3BHNNR45XZH8PU", sc.encrypt_to_qr_code_alphanumeric("articles"));
assert_eq!("articles".as_bytes().to_vec(), sc.decrypt_qr_code_alphanumeric("3BHNNR45XZH8PU").unwrap());

Besides, in order to reduce the copy times of strings, you can also use encrypt_to_url_component_and_push_to_string, encrypt_to_qr_code_alphanumeric_and_push_to_string methods to use the same memory space.

extern crate short_crypt;

use short_crypt::ShortCrypt;

let sc = ShortCrypt::new("magickey");

let url = "https://magiclen.org/".to_string();

assert_eq!("https://magiclen.org/2E87Wx52-Tvo", sc.encrypt_to_url_component_and_push_to_string("articles", url));

let url = "https://magiclen.org/".to_string();

assert_eq!("https://magiclen.org/3BHNNR45XZH8PU", sc.encrypt_to_qr_code_alphanumeric_and_push_to_string("articles", url));

Re-exports

pub extern crate base32;

pub extern crate base64_url;

Re-exports

pub use base64_url::base64;

Structs

ShortCrypt

A deterministic encryption context derived from a string key.

Type Aliases

Cipher

A tuple containing a 5-bit base stored as a u8 and a body whose length equals the plaintext length. You can use your own algorithm to combine them, or use ShortCrypt::encrypt_to_url_component or ShortCrypt::encrypt_to_qr_code_alphanumeric to produce a random-like string.