Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laravel-ready/license-server
Ready to use License Server package for Laravel. Add a licensing system to your products or services.
https://github.com/laravel-ready/license-server
laravel license license-management license-server license-system
Last synced: about 20 hours ago
JSON representation
Ready to use License Server package for Laravel. Add a licensing system to your products or services.
- Host: GitHub
- URL: https://github.com/laravel-ready/license-server
- Owner: laravel-ready
- License: mit
- Created: 2022-04-02T23:53:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-04T17:09:20.000Z (5 months ago)
- Last Synced: 2024-10-13T13:39:20.345Z (25 days ago)
- Topics: laravel, license, license-management, license-server, license-system
- Language: PHP
- Homepage:
- Size: 53.7 KB
- Stars: 96
- Watchers: 4
- Forks: 21
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# License Server
[](https://github.com/laravel-ready/license-server)
[![Stable Version][badge_stable]][link_packagist]
[![Unstable Version][badge_unstable]][link_packagist]
[![Total Downloads][badge_downloads]][link_packagist]
[![License][badge_license]][link_license]
## ✅ Version Compatibility
| Laravel | License Server | PHP |
|:---------|:---------------|:----|
| 9.x | 1.2.x | ^8.0 |
| 10.x | 2.x | ^8.1 |
| 11.x | 3.x | ^8.2 |
## 📂 About
**License Server** package, which is a Laravel package that allows you to manage your Laravel applications license. You can use it with any product or service. License Server comes with the agnostic license management system, which allows you to manage your licenses in a simple and easy way. Just add license relation to any product model then you can work in your logic.
This package requires [license-connector](https://github.com/laravel-ready/license-connector) package. **License Connector** is client implementation for License Server. Package for the client makes a request to **License Server** and gets a response.
## 📋 Requirements
### PHP
This package requires PHP 8.0 or higher. Also these extesnions are required:
- [intl extension](https://secure.php.net/manual/en/book.intl.php)
- [json extension](https://secure.php.net/manual/en/book.json.php)
- [filter extension](https://secure.php.net/manual/en/book.filter.php)
If the above extensions already installed, you can enable them with `php.ini`.
### Laravel
This package requires Laravel 8.x or higher. Other versions are ignored.
## 📦 Installation (for Host App)
Get via composer
```bash
composer require laravel-ready/license-server
```
Publish migrations and migrate
```bash
# publish migrations
php artisan vendor:publish --tag=license-server-migrations
# apply migrations
php artisan migrate --path=/database/migrations/laravel-ready/license-server
```
Configs are very important. You can find them in [license-server.php](config/license-server.php) file. You should read all configs and configure for your needs.
```bash
# publish configs
php artisan vendor:publish --tag=license-server-configs
```
## 🗝️ Model Relations
Every license must-have product, because we need to know what it is licensed for. The client application will send this information to the License Server. Then we can check if the license is valid for given the product.
Product model can be any model that you want to be licensed. Add [Licensable](src/Traits/Licensable.php) trait to your product model.
```php
id);
// add license to user
$license = LicenseService::addLicense($product, null, $user->id);
// with expiration in days (see configs for defaults)
$license = LicenseService::addLicense($product, null, $user->id, 999);
// with lifetime license (see configs for defaults)
$license = LicenseService::addLicense($product, null, $user->id, null, true);
// with trial license (see configs for defaults)
$license = LicenseService::addLicense($product, null, $user->id, null, false, true);
```
- If you provide domain, then the license will be added to the domain. If you don't provide domain, then the license will be added to the user (*in this case user id is required.*).
- Other parameters are optional and do not forget to configure configs.
- This method returns `LaravelReady\LicenseServer\Models\License` model.
- All license keys are in UUID format.
### getLicenseBy*
- *getLicenseByKey*: get license by license key.
- `LicenseService::getLicenseByKey(string $licenseKey)`
- *getLicenseByUserId*: get license by user id and license key.
- `LicenseService::getLicenseByUserId(int $userId, string $licenseKey = null)`
- *getLicenseByDomain*: get license by domain and license key.
- `LicenseService::getLicenseByDomain(string $domain, string $licenseKey = null)`
### checkLicenseStatus
```php
// license key in uuid format
$licenseKey = "46fad906-bc51-435f-9929-db46cb4baf13";
// check license status
$licenseStatus = LicenseService::checkLicenseStatus($licenseKey);
```
Returns "active", "inactive", "suspended", "expired", "invalid-license-key" and "no-license-found".
### setLicenseStatus
```php
// license key in uuid format
$licenseKey = "46fad906-bc51-435f-9929-db46cb4baf13";
// check license status
$licenseStatus = LicenseService::setLicenseStatus($licenseKey, "suspended");
```
You can only set `active`, `inactive`, `suspended` status.
## 🛠️ Custom Controller
If you want to use own license validation controller you can integrate it easily.
Click to see the example!
```php
user()' will be is our license
$_license = $license->select(
'domain',
'license_key',
'status',
'expiration_date',
'is_trial',
'is_lifetime'
)->where([
['id', '=', auth()->user()->id],
['is_trial', '!=', true]
])->first();
$data = $request->input();
// event will be fired after license is checked
// this part depends to your logic, you can remove it or change it
Event::dispatch(new LicenseChecked($_license, $data));
$_license->appent_some_data = 'some data and date now -> ' . now();
return $_license;
}
}
```
Then you need to register this custom controller in your `config/license-server.php` file.
Click to see the example!
```php
/**
* Custom controllers for License Server
*/
'controllers' => [
/**
* License validation controller
*
* You can use this controller to handle license validating
*
* See the documentation for more information.
*
*/
'license_validation' => [
App\Http\Controllers\LicenseController::class,
'licenseValidate'
]
]
```
## 🪢 Events
### 🪡 LicenseChecked Event
You can send custom data with connector and on the license server-side, you can catch this custom data. First you need to create a listener for this event.
```bash
php artisan make:listener LicenseCheckedListener --event=LicenseChecked
```
Add class `LicenseChecked` with `LaravelReady\LicenseServer\Events\LicenseChecked` namespace. You can retrieve custom data from event.
```php
license,
// $event->data,
}
}
```
Finally, you need to register this listener in your `config/license-server.php` file.
Click to see the example!
```php
/**
* Event listeners for License Server
*/
'event_listeners' => [
/**
* License checked event listener
*
* You can use this event to do something when a license is checked.
* Also you can handle custom data with this listener.
*
* See the documentation for more information.
*
* Default: null
*/
'license_checked' => App\Listeners\LicenseCheckedListener::class,
],
```
## Ready to Use API
Ready to use API is included with simple resource methods. API endpoint is `/api/license-server/licenses`.
## Domain Validation
License Server uses a cache to store the public tld list. See tld list at https://data.iana.org/TLD/tlds-alpha-by-domain.txt
The TLD list cache is will be stored at the `storage/license-server/iana-tld-list.txt` file and do not edit this file.
In development you may use domain like `example.test` etc. but you won't pass domain validation because the `test` is not valid tld.
## ⚠️ Warnings
- This package is under active development and is not yet stable. There may be some changes in later versions.
- Don't forget this package just provides management of licenses and product/customer communication.
- Please don't confuse it with ioncube or similar source code encryption tools.
[badge_downloads]: https://img.shields.io/packagist/dt/laravel-ready/license-server.svg?style=flat-square
[badge_license]: https://img.shields.io/packagist/l/laravel-ready/license-server.svg?style=flat-square
[badge_stable]: https://img.shields.io/github/v/release/laravel-ready/license-server?label=stable&style=flat-square
[badge_unstable]: https://img.shields.io/badge/unstable-dev--main-orange?style=flat-square
[link_license]: LICENSE
[link_packagist]: https://packagist.org/packages/laravel-ready/license-server