https://github.com/lorisleitner/schrott-id
SchrottID is a library for generating short, non-consecutive and opaque IDs from unsigned integers.
https://github.com/lorisleitner/schrott-id
library obfuscation
Last synced: about 1 month ago
JSON representation
SchrottID is a library for generating short, non-consecutive and opaque IDs from unsigned integers.
- Host: GitHub
- URL: https://github.com/lorisleitner/schrott-id
- Owner: lorisleitner
- License: mit
- Created: 2023-08-08T15:49:33.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-16T20:54:44.000Z (almost 3 years ago)
- Last Synced: 2026-05-22T22:55:31.721Z (about 1 month ago)
- Topics: library, obfuscation
- Language: C++
- Homepage:
- Size: 207 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SchrottID
SchrottID is a library for generating short, non-consecutive and opaque IDs from unsigned integers.
These can be used to obfuscate integer primary keys from your database and prevent enumeration of rows and leaking other
confidential information
(see [German tank problem](https://de.wikipedia.org/wiki/German_tank_problem)).
SchrottIDs can be used where UUIDs would be impractical and too long to remember.
```csharp
// Choose a character set for your SchrottIDs
string alphabet = Alphabets.Base64;
// Generate a permutation for your alphabet
// The permutation is your "key" for encoding and decoding
// You cannot decode IDs correctly without this key
string permutation = SchrottIdUtil.GeneratePermutation(alphabet);
// Choose a minimum length for your SchrottIDs
int minimumLength = 3;
// Make sure to store the three parameters above
// Create a encoder/decoder
SchrottIdEncoder schrottId = new SchrottIdEncoder(alphabet, permutation, minimumLength);
// A primary key from your database
ulong primaryKey = 420;
// Encode primaryKey to a SchrottID that you can safely expose
string externalId = schrottId.Encode(primaryKey);
// externalId = 9TN
// Decode back into your internal ID
ulong decodedKey = schrottId.Decode(externalId);
// decodedKey = 420
```
Implementations in other languages should very similar APIs. IDs generated by the same major version of the library are
always stable.
---
### Creating a new implementation
Implementations in other languages are very welcome. Create a new folder for your implementation and submit a pull
request. Use `test/control.txt` to verify your implementation. `C#` is the reference implementation.
---
> This library is inspired by [block-id](https://github.com/drifting-in-space/block-id) and removes the dependency on a
> deterministic random number generator so implementations in other languages are easier. The libraries are not
> cross-compatible.
> Disclaimer: I'm not a cryptographer and IDs generated by this library can possibly be reversed engineered. Use with
> caution.