Rivlo.Licensing 13.0.0-beta3

Rivlo Licensing – Flexible Licensing Validator for Umbraco Packages

Rivlo Licensing is a lightweight .NET package designed to help you license and protect your Umbraco packages with ease.

It supports:

• 🔒 Signed offline licence files
• 🌐 Multi-domain licences with configurable domain limits
• ⏳ Built-in per-package trial fallback
• 🧠 Custom validation rules (e.g. block dev domains)
• 🧪 Dashboard-ready status API
• 🧰 Dependency-injectable services for integration

📦 Installation

Add the NuGet package to your Umbraco project:

dotnet add package Rivlo.Licensing

⚙️ Quick Start

In your Startup or Composer class:

builder.AddRivloLicensing(new LicenceOptions()
    {
        PublicKeyPem = "-----BEGIN PUBLIC KEY-----...-----END PUBLIC KEY-----",
        ProductName = "YourPackage",
        TrialDays = 0,
        TrialIdKey = "YourPackage",
        RelativeLicensePath = "umbraco/licences/yourpackage.lic",
        CustomRule = lic =>
        {
            var isDev = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") == "Development";
            return isDev || !lic.AllowedDomains.Any(d => d.Contains("localhost"));
        }
    });

🧪 Licence File Format

You must generate your own licence files. A basic licence contains the following in JSON format:

{
  "allowedDomains": ["www.example.com", "dev.example.com"],
  "allowedVersions": ["13", "14", "15"],
  "issued": "2025-07-14T10:00:00Z",
  "expires": "2026-07-14T10:00:00Z",
  "maxDomains": 3,
  "includedProducts": ["YourPackage"]
}

This file is signed and stored as a .lic file at the configured path (options.RelativeLicensePath).

📊 Surfacing Licence Status

The package includes a built-in backoffice API endpoint, automatically registered when the licence validator is configured. You can call this from any custom dashboard or debug panel to check the current status.

GET /umbraco/backoffice/RivloLicensing/LicenceApi/Get

Returns:

{
  "isValid": true,
  "reason": null,
  "payload": { ... }
}

Use this in your back-office UI to show licence or trial status.

📌 Features Summary

🧯 Troubleshooting

By default trial info is stored in App_Data/rivlolicensing-trial-<key>.dat

You can change this by using your own custom ITrialInfoStorage implementation.

For debugging, you can inspect .lic files by base64 decoding or using the generator tool.

If IHttpContextAccessor is unavailable (e.g. during application startup), domain validation may be deferred.

🔐 Security

All validation is local — no phone-home, no tracking.

If you wish to implement usage reporting, you can hook into validation results via your own logic.

📄 License

This package is distributed under a proprietary licence. You may use it freely in commercial or private projects, but redistribution is not permitted.

For the full End User Licence Agreement (EULA), see: https://www.rivlotools.com/products/rivlo-licensing/eula

🌐 Learn More

Explore the full RivloTools suite at

👉 www.rivlotools.com