-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #40 from ghimiresdp/feature/ruscrypt
feature/ruscrypt
- Loading branch information
Showing
7 changed files
with
128 additions
and
6 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,4 +11,5 @@ members = [ | |
"problem-solving", | ||
# projects | ||
"projects/pandas", | ||
"projects/ruscrypt", | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
[package] | ||
name = "ruscrypt" | ||
version = "0.1.0" | ||
edition = "2021" | ||
|
||
[dependencies] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Ruscrypt | ||
|
||
`ruscrypt` is a basic encryption and decryption project that can encrypt and | ||
decrypt messages with passwords. | ||
|
||
This library demonstrates the basics of encrypting the data which is not safe | ||
in production use, however you can use it as a fun project and encrypt and | ||
decrypt your basic messages. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
mod ruscrypt; | ||
|
||
use ruscrypt::Crypto; | ||
|
||
/// A basic implementation of `ruscrypt::Crypto` structure | ||
/// to run/test the solution, please run the following: | ||
/// * `cargo run --bin ruscrypt` | ||
/// * `cargo test --bin ruscrypt` | ||
fn main() { | ||
// please check the Crypto struct for documentation of how it works | ||
let crypto = Crypto::new("test".to_owned()); | ||
let encrypted = crypto.encrypt("This is a original text".to_owned()); | ||
println!("Encrypted: {encrypted}"); | ||
let decrypted = crypto.decrypt(encrypted); | ||
println!("Decrypted: {decrypted}"); | ||
} | ||
|
||
#[cfg(test)] | ||
mod tests { | ||
use crate::ruscrypt::Crypto; | ||
|
||
#[test] | ||
fn test_encrypt_decrypt() { | ||
let key = String::from("My Encryption Key"); | ||
let message = String::from("This is my Secret Message"); | ||
|
||
let crypt = Crypto::new(key); | ||
assert_eq!(crypt.decrypt(crypt.encrypt(message.clone())), message); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
pub(crate) struct Crypto { | ||
key: Vec<u8>, | ||
} | ||
|
||
/// Structure `Crypto` is a cryptographic feature that allows us to perform a | ||
/// simple encryption and decryption of our messages. | ||
/// | ||
/// This algorithm uses one of the simplest ways to encrypt and decrypt the data | ||
/// using basic XOR operation with the key provided. | ||
/// | ||
/// To add more security, we perform XOR operation with different key with | ||
/// character at key which is get using modulus of the index of the message. | ||
impl Crypto { | ||
pub(crate) fn new(key: String) -> Self { | ||
Self { | ||
key: key.as_bytes().to_owned(), | ||
} | ||
} | ||
|
||
/// the `encrypt` method is used to encrypt the message using the key | ||
/// provided during initialization of the Crypto structure. | ||
/// the algorithm will first convert the key into a vector of bytes and then | ||
/// performs XOR operation with each byte that is enumerated with the index | ||
/// of the byte in the message string. | ||
/// | ||
/// for example: | ||
/// If key is ABC, it's bytes are [0x41, 0x42, and 0x43] | ||
/// | ||
/// If the message string is Hello, then it's bytes are | ||
/// [0x48, 0x65, 0x6C, 0x6C, 0x6F] | ||
/// | ||
/// so to encrypt the message, we perform XOR operation with corresponding | ||
/// byte of the key. if the index is larger, we perform modulus operation to | ||
/// get the byte for that index. | ||
/// | ||
/// the final output might contain non-printable characters, so these can | ||
/// also be saved as hex strings. | ||
pub(crate) fn encrypt(&self, message: String) -> String { | ||
let len = self.key.len(); | ||
let enc = message | ||
.bytes() // convert to bytes | ||
.enumerate() // enumerate with index | ||
.map(|(idx, ch)| { | ||
let target = self.key[idx % len]; // find encrypting character | ||
(target ^ ch) as char // perform XOR operation | ||
}) | ||
.collect::<String>(); | ||
return enc; | ||
} | ||
|
||
/// the decrypt operation is exactly the same as that of encryption | ||
/// since we performed the XOR operation on the message, performing the XOR | ||
/// operation on the encrypted data will revert back to the original message | ||
/// for example: | ||
/// 0 0 1 0 1 1 0 1 (original message) | ||
/// XOR 1 0 1 1 0 1 0 1 (encryption key) | ||
/// --------------------- | ||
/// = 1 0 0 1 1 0 0 0 (encrypted message) | ||
/// XOR 1 0 1 1 0 1 0 1 (encryption key) | ||
/// --------------------- | ||
/// = 0 0 1 0 1 1 0 1 (original message) | ||
pub(crate) fn decrypt(&self, message: String) -> String { | ||
return self.encrypt(message); | ||
} | ||
} |