Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/usrbinsam/jwt-key-server
JWT based remote licensing server.
https://github.com/usrbinsam/jwt-key-server
gin go keyserver license-generator license-keys license-management software-licensing
Last synced: 3 months ago
JSON representation
JWT based remote licensing server.
- Host: GitHub
- URL: https://github.com/usrbinsam/jwt-key-server
- Owner: usrbinsam
- License: mit
- Created: 2017-12-05T00:55:50.000Z (about 7 years ago)
- Default Branch: legacy
- Last Pushed: 2023-05-05T02:24:06.000Z (over 1 year ago)
- Last Synced: 2024-08-01T19:41:33.532Z (6 months ago)
- Topics: gin, go, keyserver, license-generator, license-keys, license-management, software-licensing
- Language: Go
- Homepage:
- Size: 591 KB
- Stars: 145
- Watchers: 13
- Forks: 41
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - usrbinsam/jwt-key-server - JWT based remote licensing server. (Go)
README
# mini-key-server
> :star: This repo has not been maintained since 2019 but will being receiving updates again soon. :star:
This web application provides a restful API for your desktop and other applications licensing needs.
### TODO
- [ ] Backend re-write in Go
- [ ] Frontend re-write with VueJS
### Key View
### Application View
### API Example
## Requirements
Aside from the python module requirements listed in [requirements.txt](requirements.txt), the following is required:
* Python 3.6 or later.
* PostgreSQL (or other SQLAlchemy supported backend)
## Installation
This software should be used from a [viritualenv](https://virtualenv.pypa.io/en/stable/)
environment.
```sh
virtualenv venv
source venv/bin/activate
pip3 install -U -r requirements.txt
```
Then edit the config:
```sh
mv keyserv/config.example.py keyserv/config.py
```
Make sure you set `SECRET_KEY` to a randomly generated value, then change `SQLALCHEMY_DATABASE_URI`
to the URI for the database you create below.
## Database Setup
The following commands will create a suitable database for the keyserver to use.
```sh
su - postgres
createuser keyserver
createdb -O keyserver keyserver
```
## User Setup
This creates a user and password on the command line. Currently there's no user creation available
in the user interface.
```sh
export FLASK_APP=keyserver.py
flask create-user username password
```
## Key Creation & Usage
1. Create an Application at the `/add/app` URL.
2. Create a Key at the `/add/key` URL. Activations set to `-1` means unlimited activations
### API Endpoints
#### `/api/check` GET
Used to check if a key is valid. Your application should exit if the response code is not `201`.
A response of `404` means the key does not exist. This endpoint only accepts the GET method.
404 response:
```json
{"result": "failure", "error": "invalid key"}
```
201 OK response:
```json
{"result": "ok"}
```
Arguments:
- `token` - The token of the key to check for
- `app_id` - Required ID of the application attempting to activate. An app-specific support message
will be included in the response body if the response failed.
- `machine` - The NetBIOS or domain name of the machine
- `user` - The name of the currently logged in user
- `hwid` - The same `hwid` provided during /api/activate (see below)
#### `/api/activate` POST
Used to activate the application. If successful, the number of remaining activations will decrement
by one. After activation, your application should store the token in an obscure location and use the
`/api/check` endpoint each time it starts up. This endpoint only supports the POST method.
404 Invalid Key response:
```json
{"result": "failure", "error": "invalid activation token", "support_message": "call 555-555-5555 for support or email [email protected]"}
```
410 Out of Activations response:
```json
{"result": "failure", "error": "key is out of activations", "support_message": "visit https://example.com/ for support"}
```
201 Activation Successful response:
```json
{"result": "ok", "remainingActivations": 1}
```
The number of remaining activations will be returned in the JSON payload. `-1` indicates unlimited
activations.
Arguments:
- `token` - The token of the key to check for
- `app_id` - Required ID of the application attempting to activate. An app-specific support message
will be included in the response body if the response failed. The ID is provided when an application is created
- `machine` - The NetBIOS or domain name of the machine
- `user` - The name of the currently logged in user
- `hwid` - Something that identifies the machine this token is being activated on. This should not be stored on the client side but should be unique for each client and should be generated on the client machine (MAC address, etc.)
Example:
```sh
curl localhost:5001/api/activate -X POST -d token=2SZRHXZBNB3GUCHM375FTB8DJ -d machine=ICEBREAKER -d user=sam
{
"result": "ok",
"remainingActivations": "9"
}
```
## Database Notice
The database schema is likely to change as this software is still young. Appropriate `ALTER TABLE` queries will come with the commit message.
## Implications
- Please run this software behind HTTPS, otherwise keys can be spoofed. Use [Qualys SSL Labs](https://www.ssllabs.com/) to verify. I recommend setting up HTTP Public Key Pinning - otherwise a bogus CA root can be issued to also spoof an instance of your domain. Setting up HPKP is not within the scope of this project.
- Keys can be shared between machines, if disallowing this is important to you, use a different product. I am working on a way to seed activations via a mini-key-server client library.
## TODO
- Client-side library (in progress)