https://github.com/hannesbarbez/barbezdoteu.license
Basic .NET Core license key generator and verifier library featuring TPL and async/await.
https://github.com/hannesbarbez/barbezdoteu.license
generator license license-checking license-generator license-key license-keys serial serial-number serial-number-generator serial-numbers verificator
Last synced: 24 days ago
JSON representation
Basic .NET Core license key generator and verifier library featuring TPL and async/await.
- Host: GitHub
- URL: https://github.com/hannesbarbez/barbezdoteu.license
- Owner: hannesbarbez
- License: gpl-3.0
- Created: 2020-09-19T15:41:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T19:25:20.000Z (about 2 months ago)
- Last Synced: 2025-03-17T20:28:55.617Z (about 2 months ago)
- Topics: generator, license, license-checking, license-generator, license-key, license-keys, serial, serial-number, serial-number-generator, serial-numbers, verificator
- Language: C#
- Homepage: https://barbez.eu
- Size: 225 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Generic "Resulting-Sum" License Key Generator Library
A generator for human-friendly, readable license keys and serial numbers by www.barbez.eu.
Produces license keys you don't mind spelling out loud to another person.
The Barbez.eu license key generator is ideal for all your license key or serial number generation needs, producing keys or serials that are easy to read out loud one human to another. Yet, the algorithm is quick enough to generate a decent amount of them in a short period of time.
## Table of Contents
0. [NuGet Packages and Demo app](#nuget-packages-and-demo-app)
1. [Features](#features)
2. [Custom Resulting-Sum Algorithm](#custom-resulting-sum-algorithm)
3. [Performance](#performance)
4. [Stats](#stats)
5. [Using the Generator](#Generator)
6. [Using the Verifier](#Verification)
7. [Disclaimer](#disclaimer)
8. [Author](#author)
## NuGet Packages and Demo app
Get the **generator** NuGet package from https://www.nuget.org/packages/BarbezDotEu.License.Generation/ or use
> Install-Package BarbezDotEu.License.Generation
Get the **verifier** NuGet package from https://www.nuget.org/packages/BarbezDotEu.License.Verification/ or use
> Install-Package BarbezDotEu.License.Verification
A demo project using this generic library can be found at https://github.com/hannesbarbez/BarbezDotEu.License.Generator.WinForms.
## Features
- Full multithreading, thanks to .NET Core’s TPL (Task Parallel Library);
- Custom “resulting-sum” algorithm to generate a bunch of unique license keys quickly;
- On-the-fly license key validator;
- Decoupling, e.g. strict separation between UI and logic;
- Generated license keys that are easy for people to spell out loud;
- Native support for async/await.
## Custom Resulting-Sum Algorithm
Lacking academic knowledge on serial number or license key generation algos, the generator algorithm is my own idea, so I’ve decided to dub it “resulting-sum”. More info on the exact workings to follow, for now the source code should suffice to explain its inner workings.
## Performance
After running a couple of tests on an AMD Ryzen 1600 (6 cores, 12 threads) based machine, I compiled a short table with the results.
On this hardware, a ResultingSum of 68 takes Y time to generate X number of unique keys, and are shown in the below table.
Results will differ for other ResultingSum values. For a value of 68, about 80 000 unique keys are generated in under 5 seconds, whereas 150 000 unique keys take about 19 seconds.
## Stats
*Note: these stats are from version 3.0.0 of the generator, which is much faster than the initial version.*
A "resulting sum" of 68 takes Y time to render/generate X number of unique keys on a Ryzen 1600 based machine.
| Keys (X) | Time (ms, Y) | ms/key (=Y/X) |
| -------- | ------------ | ------------- |
| 1 | 14 | 14 |
| 10 | 14 | 1.4 |
| 100 | 22 | .22 |
| 1 000 | 209 | .21 |
| 2 500 | 218 | .09 |
| 5 000 | 402 | .08 |
| 10 000 | 703 | .07 |
| 20 000 | 1 472 | .07 |
| 30 000 | 2 007 | .07 |
| 50 000 | 3 365 | .07 |
| 62 500 | 4 220 | .07 |
| 75 000 | 4 867 | .06 |
| 87 500 | 5 733 | .07 |
| 100 000 | 6 379 | .06 |
| 150 000 | 9 550 | .06 |
| 300 000 | 19 291 | .06 |
| 1 000 000 | 63 035 | .06 |
# Generator
How to use BarbezDotEu.License.Generation.
## Contents
- [KeyGenerator](#T-BarbezDotEu-License-Generation-KeyGenerator 'BarbezDotEu.License.Generation.KeyGenerator')
- [#ctor(resultingSum,divider)](#M-BarbezDotEu-License-Generation-KeyGenerator-#ctor-System-Int32,System-String- 'BarbezDotEu.License.Generation.KeyGenerator.#ctor(System.Int32,System.String)')
- [EXCEPTION](#F-BarbezDotEu-License-Generation-KeyGenerator-EXCEPTION 'BarbezDotEu.License.Generation.KeyGenerator.EXCEPTION')
- [GenerateKeys(numberOfKeys,excludedKeys)](#M-BarbezDotEu-License-Generation-KeyGenerator-GenerateKeys-System-UInt32,System-String[]- 'BarbezDotEu.License.Generation.KeyGenerator.GenerateKeys(System.UInt32,System.String[])')
BarbezDotEu.License.Generation
Basic key generator class.
### #ctor(resultingSum,divider) `constructor`
Constructs a new [KeyGenerator](#T-BarbezDotEu-License-Generation-KeyGenerator 'BarbezDotEu.License.Generation.KeyGenerator').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| resultingSum | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The expected "sum" of the key. All keys share the same "sum", which is what makes the key validatable. Negative or default values are not valid. |
| divider | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The desored division in between segments of the license key. |
One or more parameters are invalid. NULL, negative, empty or default values are not valid parameters.
### GenerateKeys(numberOfKeys,excludedKeys) `method`
Generates a number of license keys.
##### Returns
The generated license keys.
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| numberOfKeys | [System.UInt32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.UInt32 'System.UInt32') | The amount of keys to generate. |
| excludedKeys | [System.String[]](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String[] 'System.String[]') | Keys that cannot be present in the resulting key set. |
# Verification
How to use BarbezDotEu.License.Verification.
## Contents
- [KeyVerificator](#T-BarbezDotEu-License-Verification-KeyVerificator 'BarbezDotEu.License.Verification.KeyVerificator')
- [#ctor(resultingSum,divider)](#M-BarbezDotEu-License-Verification-KeyVerificator-#ctor-System-Int32,System-String- 'BarbezDotEu.License.Verification.KeyVerificator.#ctor(System.Int32,System.String)')
- [EXCEPTION](#F-BarbezDotEu-License-Verification-KeyVerificator-EXCEPTION 'BarbezDotEu.License.Verification.KeyVerificator.EXCEPTION')
- [ValidKey()](#M-BarbezDotEu-License-Verification-KeyVerificator-ValidKey-System-String,System-String,System-String,System-String,System-String- 'BarbezDotEu.License.Verification.KeyVerificator.ValidKey(System.String,System.String,System.String,System.String,System.String)')
- [ValidateSegment(segment)](#M-BarbezDotEu-License-Verification-KeyVerificator-ValidateSegment-System-String- 'BarbezDotEu.License.Verification.KeyVerificator.ValidateSegment(System.String)')
- [VerifyKey()](#M-BarbezDotEu-License-Verification-KeyVerificator-VerifyKey-System-String,System-String,System-String,System-String,System-String- 'BarbezDotEu.License.Verification.KeyVerificator.VerifyKey(System.String,System.String,System.String,System.String,System.String)')
- [VerifyKey(key)](#M-BarbezDotEu-License-Verification-KeyVerificator-VerifyKey-System-String- 'BarbezDotEu.License.Verification.KeyVerificator.VerifyKey(System.String)')
BarbezDotEu.License.Verification
Basic key verifier class.
### #ctor(resultingSum,divider) `constructor`
Constructs a new basic key verifier (verificator, lat.)
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| resultingSum | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | The resulting sum that has to be met for a key to be valid. |
| divider | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The divider (e.g. "-") expected to be found in between different segments of a key. |
One or more parameters are invalid. NULL, negative, empty or default values are not valid parameters.
Checks if inputted key is valid
##### Returns
True if valid, false if invalid.
##### Parameters
This method has no parameters.
### ValidateSegment(segment) `method`
Checks if a segment valid.
##### Returns
True if valid, false if invalid.
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| segment | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The segment to interpret. |
Checks if a key is valid as well as all of its segments.
##### Returns
True if the key is valid; false otherwise.
##### Parameters
This method has no parameters.
Verifies a given key.
##### Returns
TRUE if the key is valid. False, otherwise.
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| key | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | The key to verify. |
# Disclaimer
The code in this repository was written for and used within a variety of Barbez.eu apps distributed via Amazon.com in the late 2010's.
If you're looking for a license key generator that is "uncrackable", this is one is not for you (also, both generator and verificator are open source). You can however consider using it as a base for your own license key generator, perhaps.
## Author
www.barbez.eu