https://github.com/junian/standard.licensing
Easy-to-use licensing library for .NET Framework, Mono, .NET Core, and MAUI / Xamarin products
https://github.com/junian/standard.licensing
dotnet licensing mono netcore netframework netstandard xamarin
Last synced: 5 days ago
JSON representation
Easy-to-use licensing library for .NET Framework, Mono, .NET Core, and MAUI / Xamarin products
- Host: GitHub
- URL: https://github.com/junian/standard.licensing
- Owner: junian
- License: mit
- Created: 2018-02-17T06:10:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-14T08:46:36.000Z (6 months ago)
- Last Synced: 2025-05-15T09:08:19.684Z (5 days ago)
- Topics: dotnet, licensing, mono, netcore, netframework, netstandard, xamarin
- Language: C#
- Homepage: https://junian.dev/Standard.Licensing/
- Size: 11.8 MB
- Stars: 601
- Watchers: 32
- Forks: 140
- Open Issues: 23
-
Metadata Files:
- Readme: docs/README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Standard.Licensing
Easy-to-use licensing library for .NET and .NET Framework products.
----
## Installation
Get [Standard.Licensing](https://www.nuget.org/packages/Standard.Licensing/) from NuGet.
```shell
dotnet add package Standard.Licensing
```
## Usage
### Create a private and public key for your product
Standard.Licensing uses the Elliptic Curve Digital Signature Algorithm (ECDSA) to ensure the license cannot be altered after creation.
First you need to create a new public/private key pair for your product:
```csharp
var keyGenerator = Standard.Licensing.Security.Cryptography.KeyGenerator.Create();
var keyPair = keyGenerator.GenerateKeyPair();
var privateKey = keyPair.ToEncryptedPrivateKeyString(passPhrase);
var publicKey = keyPair.ToPublicKeyString();
```
Store the private key securely and distribute the public key with your product.
Normally you create one key pair for each product, otherwise it is possible to use a license with all products using the same key pair.
If you want your customer to buy a new license on each major release you can create a key pair for each release and product.
### Create the license generator
Now we need something to generate licenses. This could be easily done with the `LicenseFactory`:
```csharp
var license = License.New()
.WithUniqueIdentifier(Guid.NewGuid())
.As(LicenseType.Trial)
.ExpiresAt(DateTime.Now.AddDays(30))
.WithMaximumUtilization(5)
.WithProductFeatures(new Dictionary
{
{"Sales Module", "yes"},
{"Purchase Module", "yes"},
{"Maximum Transactions", "10000"}
})
.LicensedTo("John Doe", "[email protected]")
.CreateAndSignWithPrivateKey(privateKey, passPhrase);
```
Now you can take the license and save it to a file:
```csharp
File.WriteAllText("License.lic", license.ToString(), Encoding.UTF8);
```
or
```csharp
license.Save(xmlWriter);
```
### Validate the license in your application ###
The easiest way to assert the license is in the entry point of your application.
First load the license from a file or resource:
```csharp
var license = License.Load(...);
```
Then you can assert the license:
```csharp
using Standard.Licensing.Validation;
var validationFailures = license.Validate()
.ExpirationDate(systemDateTime: DateTime.Now)
.When(lic => lic.Type == LicenseType.Trial)
.And()
.Signature(publicKey)
.AssertValidLicense();
```
Standard.Licensing will not throw any Exception and just return an enumeration of validation failures.
Now you can iterate over possible validation failures:
```csharp
foreach (var failure in validationFailures)
Console.WriteLine(failure.GetType().Name + ": " + failure.Message + " - " + failure.HowToResolve);
```
Or simply check if there is any failure:
```csharp
if (validationFailures.Any())
// ...
```
Make sure to call `validationFailures.ToList()` or `validationFailures.ToArray()` before using the result multiple times.
## Third Party Projects
- [PatrickRainer/LicenseManager](https://github.com/PatrickRainer/LicenseManager) - A WPF license manager for developers to generate and validate licenses.
- [skst/LicenseManager](https://github.com/skst/LicenseManager) - GUI front-end for Standard.Licensing project.
## Credits
This is project is derived from [Portable.Licensing](https://github.com/dnauck/Portable.Licensing/) library.
The purpose of this fork is to add support for more .NET platforms, especially .NET Standard and .NET Core.
- [dnauck/Portable.Licensing](https://github.com/dnauck/Portable.Licensing/) for the original work.
## License
This project is licensed under [MIT License](https://github.com/junian/Standard.Licensing/blob/master/LICENSE).
---
Made with ☕ by [Junian.dev](https://www.junian.dev).