https://github.com/anvie/litcrypt.rs

a Rust compiler plugin to encrypt string literal at compile time.
https://github.com/anvie/litcrypt.rs

Last synced: about 2 months ago
JSON representation

a Rust compiler plugin to encrypt string literal at compile time.

• Host: GitHub
• URL: https://github.com/anvie/litcrypt.rs
• Owner: anvie
• License: other
• Created: 2017-01-02T13:46:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-11-14T15:01:10.000Z (10 months ago)
• Last Synced: 2024-07-12T08:58:49.793Z (2 months ago)
• Language: Rust
• Homepage:
• Size: 28.3 KB
• Stars: 179
• Watchers: 4
• Forks: 19
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-offensive-rust - Litcrypt - A Rust compiler plugin to encrypt string literal at compile time. (Useful Libraries)

README

        
LITCRYPT [![Build Status](https://travis-ci.org/anvie/litcrypt.rs.svg?branch=master)](https://travis-ci.org/anvie/litcrypt.rs) ![Crates.io](https://img.shields.io/crates/v/litcrypt)

===========

Is a short name of "Literal Encryption", a Rust proc macro that encrypts text using a basic XOR method. It protect plain text from static analysis tools and helps keep your important app safe from cracking activity.

LITCRYPT encrypts strings when compiling, keeping them encrypted in both disk and memory while running, and only decrypting them when needed.

USAGE

-----

Dependencies:

```rust

[dependencies]

litcrypt = "0.3"

```

Example:

```rust

#[macro_use]

extern crate litcrypt;

use_litcrypt!();

fn main(){

    println!("his name is: {}", lc!("Voldemort"));

}

```

`use_litcrypt!` macro call should be called first for initialization before you can

use `lc!` macro function. The first parameter is your secret key used for encrypt your

literal string. This key is also encrypted and will not visible under static analyzer.

Please take note that you need to set your encryption key using environment variable 

`LITCRYPT_ENCRYPT_KEY` before compile:

e.g:

    $ export LITCRYPT_ENCRYPT_KEY="myverysuperdupermegaultrasecretkey"

Litcrypt will encrypt each string written inside `lc!` statically.

Check the output binary using `strings` command to verify:

    $ strings target/debug/my_valuable_app | grep Voldemort

If the output is blank then your valuable string in your app is safe from static analyzer tool

like Hexeditor etc.

For working example code see `./examples` directory, and test using:

    $ cargo run --example simple

[] Robin.