5 unstable releases

Uses new Rust 2021

0.3.0 Oct 29, 2022
0.2.1 Oct 20, 2022
0.2.0 Oct 18, 2022
0.1.1 Oct 7, 2022
0.1.0 Oct 7, 2022

#375 in Cryptography

38 downloads per month

MIT/Apache

19KB
246 lines

Keysmith

Create keys or ids for data with Rust.

WARNING

Keysmith is currently a WIP and not recommended for production projects yet.

Here's some example keys:

5WdT@KfYRyRDqh0AAVUsyitSXbm4OQwzClX9.XYn5kLmKeObCf8YE3HqzHdU3UTS
g1Y_Zp9-9rDf7VAaR1KGnH9Uf5klGjSQ6P2rAjK35iK-GnZ@dVXYu.aElzTfTOaK
M3rkxIbrD0lz-SpUBe704X2)Gd(_WprzRJW7N51O@_58180Gs9esIVBO5.OdFOlY

This looks like gibberish, but that's the point. Two id's in a database should not overlap. So if you need a lot of entries, you need to reduce the odds of that happening. If the odds of two identical id's are astronomically low, you shouldn't even need to check for an existing id in the first place. Keysmith does that generation for you and outputs it as a String.

You can also generate version 4 UUID's. Examples:

be3b5529-931b-6b75-1678-a057bccf71c9
440146ab-a19a-8a36-2d4b-ba19a79570d4
0090da40-6ce2-59d3-629d-11b293c9e2d3

Usage

For usage, see the documentation.

Changelog

You can find the changelog in CHANGELOG.md.

Building

  1. Install rustup if you haven't already.
  2. Clone this repo. Usually with git clone https://github.com/njshockey/keysmith-rs.git.
  3. Run cargo build or cargo build --release to build.
    • To run the test package, run cargo run -p ks-tests instead.

License

Keysmith uses the Rust standard MIT/Apache 2.0 dual license for best compatibility. See LICENSE-APACHE.txt and LICENSE-MIT.txt for the full licenses.

Dependencies

~1.5MB
~21K SLoC