Secure Storage 🔒

🚀 Overview

Secure Storage 🔒 is a WebAssembly (WASM) module written in Rust that provides secure, high-performance encryption and decryption capabilities using the ChaCha20-Poly1305 AEAD (Authenticated Encryption with Associated Data) algorithm. This project is ideal for securely storing and transmitting sensitive data in web applications.

✨ Features

1. ✅ End-to-end Encryption - Uses the ChaCha20-Poly1305 cipher for secure data encryption.
2. ✅ WASM Powered - High-performance cryptographic operations in the browser.
3. ✅ Lightweight & Fast - Rust’s efficiency ensures minimal overhead.
4. ✅ Authenticated Encryption - Ensures data integrity and authenticity.

Configuration

To include wasm into your application, Based on the bundler

Vite

    // To configure vite with wasm
    import wasm from "vite-plugin-wasm";
    
    // https://vite.dev/config/
    export default defineConfig({
        plugins: [react(), wasm()],
    })

🛠️ Usage

    import { getItem, setItem, clear } from "secure-storage";
    
    // To store data with encryption
    setItem("key", "data")
    // To store raw data (without encryption)
    setItem("key", "data", true)
    getItem("key") // -> string

📚 API Reference

set_item(key: string, data: string, encrypted?: boolean | null) => void

@default: encrypted = true Generates and sets the encrypted/raw data in the localstorage based on encrypted boolean

get_item(key: string) => string

Gets the decrypted data in the localstorage

remove(key: string) => void

Removes the key from localstorage

clear() => void

Clears the localstorage

✔️ Compatible web engine

Here is the list of tested web engine,

1. Chromium
2. Safari
3. Gecko

✔️ Supported frameworks

1. Vite
2. Nextjs
3. Vuejs
4. create-react-route

And few more testing in progress.

🤝 Contributing

We welcome contributions! Feel free to submit issues, feature requests, or pull requests.

1. Fork the repo
2. Create a new branch: git checkout -b feature-branch
3. Commit changes: git commit -m "Add a new feature"
4. Push to the branch: git push origin feature-branch
5. Create a Pull Request

📜 License

This project is licensed under the MIT License.

🙌 Acknowledgments

Special thanks to the Rust and WebAssembly communities for their amazing tools and documentation!

🚀 Secure your data with Secure Storage 🔒 today!