UD-Cipher is a lightweight PHP and JavaScript library for encoding and decoding text using customizable symbol mappings, noise symbols, and a Caesar cipher variant. This mini encoding library provides an easy way to obfuscate text, making it suitable for various applications where text privacy is a concern.
- Simple Text Encoding and Decoding: Easily encode and decode text strings.
- Customizable Symbol Mappings: Define your own mappings for characters to symbols.
- Random Noise Symbols: Introduce random noise during encoding for increased complexity.
- Easy to Use and Lightweight: A straightforward implementation suitable for small projects.
This library should not and cannot be used for production encoding or large-scale applications. For large-scale use, consider modern encryption algorithms like AES-256 or Argon2.
- PHP 7.4+
-
Clone the Repository
git clone https://github.com/codetesla51/ud-cipher.git cd ud-cipher -
Open VSCode or Your Preferred Editor/IDE Using the PHP Version Include the UD-Cipher Library
In your PHP file, include the library and use the necessary classes:
require "src/init.php";
use UDC\SymbolMapper;
use UDC\NoiseGenerator;
use UDC\UDC- Instantiate the Classes
Call the UD-Cipher methods for encoding:
$symbolMapper = new SymbolMapper($mappings);
$noiseGenerator = new NoiseGenerator($noiseSymbols);
$encryptor = new UDC($symbolMapper, $noiseGenerator);4.Handle Encoding and Decoding in Your Application
Here’s an example of how to process text input:
if ($_SERVER["REQUEST_METHOD"] == "POST") {
$text = $_POST["text"]; // User input from the form
// Encode the input text
$encryptedText = $encryptor->encryptText($text);
echo "Encrypted Text: " . $encryptedText;
// Decode the encrypted text
$decryptedText = $encryptor->decryptText($encryptedText);
echo "Decrypted Text: " . $decryptedText;
}Example For a simple HTML form to input text, you could use:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>UD-Cipher Example</title>
</head>
<body>
<h1>Text Encoder/Decoder</h1>
<form method="POST">
<label for="text">Enter Text:</label>
<input type="text" id="text" name="text" required>
<input type="submit" value="Encode/Decode">
</form>
</body>
</html>JavaScript version The JavaScript version offers similar functionalities. It can be implemented as follows:
<script src="udc/init.js"></script>
initialize
const symbolMapper = new SymbolMapper(mappings);
const noiseGenerator = new NoiseGenerator(noiseSymbols);
const encryptor = new UDC(symbolMapper, noiseGenerator);
examples
const encryptedText = encryptor.encryptText("Hello World");
console.log("Encrypted Text:", encryptedText);
const decryptedText = encryptor.decryptText(encryptedText);
console.log("Decrypted Text:", decryptedText);const encryptedText = encryptor.encryptText(text);
console.log("Original Text:", text);
console.log("Encrypted Text:", encryptedText);
const decryptedText = encryptor.decryptText(encryptedText);
console.log("Decrypted Text:", decryptedText);Project Explanation UD-Cipher provides a simple interface to encode and decode text. The library uses a mapping of characters to symbols, which can be customized according to your needs. During encoding, random noise symbols can be added to increase the complexity of the encoded text.
This library is great for small projects or learning purposes, but it’s important to remember that it should not be used for sensitive data in production environments due to its simplicity and potential vulnerabilities compared to modern encryption methods.
License This project is licensed under the MIT License. See the LICENSE file for more details.