mirror of
https://gitea.publichub.eu/oscar.krause/fastapi-dls.git
synced 2026-04-08 16:45:48 +03:00
Compare commits
50 Commits
f38378bbc8
...
drivers-di
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5973e75327 | ||
|
|
42008ff66f | ||
|
|
0c5368b863 | ||
|
|
5c54f5171f | ||
|
|
2afd3a4eb3 | ||
|
|
b5e186a58e | ||
|
|
3ebf87f01a | ||
|
|
b8ec5e11e2 | ||
|
|
bffa357225 | ||
|
|
656d568cbe | ||
|
|
82c8e89d8f | ||
|
|
2ee92b6f81 | ||
|
|
52a1834817 | ||
|
|
dd0042b850 | ||
|
|
eded286c89 | ||
|
|
764e012fb7 | ||
|
|
52e9f2cae9 | ||
|
|
09fe2a605c | ||
|
|
8ec87a8859 | ||
|
|
18f577b4f6 | ||
|
|
eab3b21d60 | ||
|
|
2157394dfa | ||
|
|
b577edcf67 | ||
|
|
8e3e49fc36 | ||
|
|
2638f67cd9 | ||
|
|
60a6c83a3d | ||
|
|
ae03867502 | ||
|
|
295e3c9482 | ||
|
|
3961acf231 | ||
|
|
04914740a4 | ||
|
|
6af9cd04c9 | ||
|
|
29268b1658 | ||
|
|
938a112b8a | ||
|
|
16870e9d67 | ||
|
|
55b7437fe7 | ||
|
|
e7e007a45f | ||
|
|
161a1430cf | ||
|
|
1ccb203b25 | ||
|
|
6c1a8d42dc | ||
|
|
d248496f34 | ||
|
|
fd1babaca5 | ||
|
|
cd9c655d65 | ||
|
|
6ed4bdfe6f | ||
|
|
e1ae757a50 | ||
|
|
b0ca5d7ab5 | ||
|
|
14f8b54752 | ||
|
|
dc783e6518 | ||
|
|
3666e22707 | ||
|
|
6b54d4794b | ||
|
|
c6ca1cafb9 |
@@ -2,7 +2,7 @@ Package: fastapi-dls
|
||||
Version: 0.0
|
||||
Architecture: all
|
||||
Maintainer: Oscar Krause oscar.krause@collinwebdesigns.de
|
||||
Depends: python3, python3-fastapi, python3-uvicorn, python3-dotenv, python3-dateutil, python3-josepy, python3-sqlalchemy, python3-cryptography, python3-markdown, uvicorn, openssl
|
||||
Depends: python3, python3-fastapi, python3-uvicorn, python3-dotenv, python3-dateutil, python3-jose, python3-sqlalchemy, python3-cryptography, python3-markdown, uvicorn, openssl
|
||||
Recommends: curl
|
||||
Installed-Size: 10240
|
||||
Homepage: https://git.collinwebdesigns.de/oscar.krause/fastapi-dls
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
# Toggle debug mode
|
||||
#DEBUG=false
|
||||
|
||||
# Cert Path
|
||||
CERT_PATH="/etc/fastapi-dls/cert"
|
||||
|
||||
# Where the client can find the DLS server
|
||||
DLS_URL=127.0.0.1
|
||||
DLS_PORT=443
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
WORKING_DIR=/usr/share/fastapi-dls
|
||||
CONFIG_DIR=/etc/fastapi-dls
|
||||
|
||||
source $CONFIG_DIR/env
|
||||
|
||||
while true; do
|
||||
[ -f $CONFIG_DIR/webserver.key ] && default_answer="N" || default_answer="Y"
|
||||
[ $default_answer == "Y" ] && V="Y/n" || V="y/N"
|
||||
@@ -25,27 +27,32 @@ if [ -f $CONFIG_DIR/webserver.key ]; then
|
||||
|
||||
if [ -x "$(command -v curl)" ]; then
|
||||
echo "> Testing API ..."
|
||||
source $CONFIG_DIR/env
|
||||
curl --insecure -X GET https://$DLS_URL:$DLS_PORT/-/health
|
||||
else
|
||||
echo "> Testing API failed, curl not available. Please test manually!"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "> Create Certificate-Chain folder ..."
|
||||
mkdir -p $CERT_PATH
|
||||
|
||||
echo "> Set permissions ..."
|
||||
chown -R www-data:www-data $CONFIG_DIR
|
||||
chown -R www-data:www-data $WORKING_DIR
|
||||
|
||||
echo "> Done."
|
||||
|
||||
cat <<EOF
|
||||
|
||||
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
|
||||
# #
|
||||
# fastapi-dls is now installed. #
|
||||
# #
|
||||
# Service should be up and running. #
|
||||
# Webservice is listen to https://localhost #
|
||||
# #
|
||||
# Configuration is stored in /etc/fastapi-dls/env. #
|
||||
# Service should be up and running (if you choose to auto-generate #
|
||||
# self-signed webserver certificate). #
|
||||
# #
|
||||
# - Webservice is listen to https://localhost # #
|
||||
# - Configuration is stored in /etc/fastapi-dls/env #
|
||||
# #
|
||||
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
|
||||
|
||||
|
||||
@@ -162,20 +162,22 @@ test:apt:
|
||||
image: $IMAGE
|
||||
stage: test
|
||||
rules:
|
||||
- if: $CI_COMMIT_BRANCH && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
|
||||
- if: $CI_PIPELINE_SOURCE == 'merge_request_event'
|
||||
- if: ($CI_PIPELINE_SOURCE == 'merge_request_event') || ($CI_COMMIT_BRANCH && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH)
|
||||
changes:
|
||||
- app/**/*
|
||||
- .DEBIAN/**/*
|
||||
- if: $CI_PIPELINE_SOURCE == 'merge_request_event'
|
||||
- .gitlab-ci.yml
|
||||
variables:
|
||||
VERSION: "0.0.1"
|
||||
parallel:
|
||||
matrix:
|
||||
- IMAGE:
|
||||
- debian:trixie-slim # EOL: t.b.a.
|
||||
# - debian:trixie-slim # EOL: t.b.a.; "python3-jose" not available, but "python3-josepy"
|
||||
- debian:bookworm-slim # EOL: June 06, 2026
|
||||
- debian:bookworm-slim # EOL: June 06, 2026
|
||||
- ubuntu:24.04 # EOL: April 2036
|
||||
- ubuntu:24.10
|
||||
# - ubuntu:24.10 # EOL: t.b.a.; "python3-jose" not available, but "python3-josepy"
|
||||
# - ubuntu:25.04 # EOL: t.b.a.; "python3-jose" not available, but "python3-josepy"
|
||||
needs:
|
||||
- job: build:apt
|
||||
artifacts: true
|
||||
@@ -210,8 +212,7 @@ test:apt:
|
||||
test:pacman:archlinux:
|
||||
image: archlinux:base
|
||||
rules:
|
||||
- if: $CI_COMMIT_BRANCH && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
|
||||
- if: $CI_PIPELINE_SOURCE == 'merge_request_event'
|
||||
- if: ($CI_PIPELINE_SOURCE == 'merge_request_event') || ($CI_COMMIT_BRANCH && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH)
|
||||
changes:
|
||||
- app/**/*
|
||||
- .PKGBUILD/**/*
|
||||
@@ -376,7 +377,7 @@ deploy:pacman:
|
||||
release:
|
||||
image: registry.gitlab.com/gitlab-org/release-cli:latest
|
||||
stage: .post
|
||||
needs: [ build:docker, build:apt, build:pacman ]
|
||||
needs: [ deploy:docker, deploy:apt, deploy:pacman ]
|
||||
rules:
|
||||
- if: $CI_COMMIT_TAG
|
||||
script:
|
||||
@@ -391,4 +392,4 @@ release:
|
||||
- name: 'Package Registry'
|
||||
url: 'https://git.collinwebdesigns.de/oscar.krause/fastapi-dls/-/packages'
|
||||
- name: 'Container Registry'
|
||||
url: 'https://git.collinwebdesigns.de/oscar.krause/fastapi-dls/container_registry/40'
|
||||
url: 'https://git.collinwebdesigns.de/oscar.krause/fastapi-dls/container_registry/70'
|
||||
|
||||
195
README.md
195
README.md
@@ -2,15 +2,15 @@
|
||||
|
||||
Minimal Delegated License Service (DLS).
|
||||
|
||||
> [!warning] Branch support \
|
||||
> [!warning] Branch support
|
||||
> FastAPI-DLS Version 1.x supports up to **`17.x`** releases. \
|
||||
> FastAPI-DLS Version 2.x is backwards compatible to `17.x` and supports **`18.x`** releases in combination
|
||||
> with [gridd-unlock-patcher](https://git.collinwebdesigns.de/oscar.krause/gridd-unlock-patcher).
|
||||
> with [gridd-unlock-patcher](https://git.collinwebdesigns.de/vgpu/gridd-unlock-patcher).
|
||||
> Other combinations of FastAPI-DLS and Driver-Branches may work but are not tested.
|
||||
|
||||
> [!note] Compatibility
|
||||
> Compatibility tested with official NLS 2.0.1, 2.1.0, 3.1.0, 3.3.1, 3.4.0. For Driver compatibility
|
||||
> see [compatibility matrix](#vgpu-software-compatibility-matrix).
|
||||
> Compatibility tested with official NLS 2.0.1, 2.1.0, 3.1.0, 3.3.1, 3.4.0. **For Driver compatibility
|
||||
> see [compatibility matrix](#vgpu-software-compatibility-matrix)**.
|
||||
|
||||
This service can be used without internet connection.
|
||||
Only the clients need a connection to this service on configured port.
|
||||
@@ -18,7 +18,6 @@ Only the clients need a connection to this service on configured port.
|
||||
**Official Links**
|
||||
|
||||
* https://git.collinwebdesigns.de/oscar.krause/fastapi-dls (Private Git)
|
||||
* https://gitea.publichub.eu/oscar.krause/fastapi-dls (Public Git)
|
||||
* https://hub.docker.com/r/collinwebdesigns/fastapi-dls (Docker-Hub `collinwebdesigns/fastapi-dls:latest`)
|
||||
|
||||
*All other repositories are forks! (which is no bad - just for information and bug reports)*
|
||||
@@ -334,12 +333,13 @@ Successful tested with (**LTS Version**):
|
||||
- *Ubuntu 23.04 (Lunar Lobster)* (EOL: January 2024)
|
||||
- *Ubuntu 23.10 (Mantic Minotaur)* (EOL: July 2024)
|
||||
- **Ubuntu 24.04 (Noble Numbat)** (EOL: Apr 2029)
|
||||
- *Ubuntu 24.10 (Oracular Oriole)* (EOL: Jul 2025)
|
||||
|
||||
Not working with:
|
||||
|
||||
- Debian 11 (Bullseye) and lower (missing `python-jose` dependency)
|
||||
- Debian 13 (Trixie) (missing `python-jose` dependency)
|
||||
- Ubuntu 22.04 (Jammy Jellyfish) (not supported as for 15.01.2023 due to [fastapi - uvicorn version missmatch](https://bugs.launchpad.net/ubuntu/+source/fastapi/+bug/1970557))
|
||||
- Ubuntu 24.10 (Oracular Oriole) (missing `python-jose` dependency)
|
||||
|
||||
**Run this on your server instance**
|
||||
|
||||
@@ -415,21 +415,156 @@ acme.sh --issue -d example.com \
|
||||
|
||||
After first success you have to replace `--issue` with `--renew`.
|
||||
|
||||
# Configuration
|
||||
## Nginx Reverse Proxy (experimental)
|
||||
|
||||
| Variable | Default | Usage |
|
||||
|--------------------------|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `DEBUG` | `false` | Toggles `fastapi` debug mode |
|
||||
| `DLS_URL` | `localhost` | Used in client-token to tell guest driver where dls instance is reachable |
|
||||
| `DLS_PORT` | `443` | Used in client-token to tell guest driver where dls instance is reachable |
|
||||
| `TOKEN_EXPIRE_DAYS` | `1` | Client auth-token validity (used for authenticate client against api, **not `.tok` file!**) |
|
||||
| `LEASE_EXPIRE_DAYS` | `90` | Lease time in days |
|
||||
| `LEASE_RENEWAL_PERIOD` | `0.15` | The percentage of the lease period that must elapse before a licensed client can renew a license \*1 |
|
||||
| `DATABASE` | `sqlite:///db.sqlite` | See [official SQLAlchemy docs](https://docs.sqlalchemy.org/en/14/core/engines.html) |
|
||||
| `CORS_ORIGINS` | `https://{DLS_URL}` | Sets `Access-Control-Allow-Origin` header (comma separated string) \*2 |
|
||||
| `SITE_KEY_XID` | `00000000-0000-0000-0000-000000000000` | Site identification uuid |
|
||||
| `INSTANCE_REF` | `10000000-0000-0000-0000-000000000001` | Instance identification uuid |
|
||||
| `ALLOTMENT_REF` | `20000000-0000-0000-0000-000000000001` | Allotment identification uuid | |
|
||||
- This guide is written for Debian/Ubuntu systems, other may work, but you have to do your setup on your own
|
||||
- Uvicorn does no longer serve requests directly
|
||||
- NGINX is used as HTTP & HTTPS entrypoint
|
||||
- Assumes you already have set up webserver certificate and private-key
|
||||
|
||||
**Install Nginx Webserver**
|
||||
|
||||
```shell
|
||||
apt-get install nginx-light
|
||||
```
|
||||
|
||||
**Remove default vhost**
|
||||
|
||||
```shell
|
||||
rm /etc/nginx/sites-enabled/default
|
||||
```
|
||||
|
||||
**Create fastapi-dls vhost**
|
||||
|
||||
<details>
|
||||
<summary>`/etc/nginx/sites-available/fastapi-dls`</summary>
|
||||
|
||||
```
|
||||
upstream dls-backend {
|
||||
server 127.0.0.1:8000; # must match dls listen port
|
||||
}
|
||||
|
||||
server {
|
||||
listen 443 ssl http2 default_server;
|
||||
listen [::]:443 ssl http2 default_server;
|
||||
|
||||
root /var/www/html;
|
||||
index index.html;
|
||||
server_name _;
|
||||
|
||||
ssl_certificate "/etc/fastapi-dls/cert/webserver.crt";
|
||||
ssl_certificate_key "/etc/fastapi-dls/cert/webserver.key";
|
||||
ssl_session_cache shared:SSL:1m;
|
||||
ssl_session_timeout 10m;
|
||||
ssl_protocols TLSv1.3 TLSv1.2;
|
||||
# ssl_ciphers "ECDHE-ECDSA-CHACHA20-POLY1305";
|
||||
# ssl_ciphers PROFILE=SYSTEM;
|
||||
ssl_prefer_server_ciphers on;
|
||||
|
||||
location / {
|
||||
# https://www.uvicorn.org/deployment/
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection $connection_upgrade;
|
||||
proxy_redirect off;
|
||||
proxy_buffering off;
|
||||
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
|
||||
proxy_pass http://dls-backend$request_uri;
|
||||
}
|
||||
|
||||
location = /-/health {
|
||||
access_log off;
|
||||
add_header 'Content-Type' 'application/json';
|
||||
return 200 '{\"status\":\"up\",\"service\":\"nginx\"}';
|
||||
}
|
||||
}
|
||||
|
||||
map $http_upgrade $connection_upgrade {
|
||||
default upgrade;
|
||||
'' close;
|
||||
}
|
||||
|
||||
server {
|
||||
listen 80;
|
||||
listen [::]:80;
|
||||
|
||||
root /var/www/html;
|
||||
index index.html;
|
||||
server_name _;
|
||||
|
||||
location /leasing/v1/lessor/shutdown {
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_pass http://dls-backend/leasing/v1/lessor/shutdown;
|
||||
}
|
||||
|
||||
location / {
|
||||
return 301 https://$host$request_uri;
|
||||
}
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
**Enable and test vhost**
|
||||
|
||||
```shell
|
||||
ln -s /etc/nginx/sites-available/fastapi-dls /etc/nginx/sites-enabled/fastapi-dls
|
||||
|
||||
nginx -t
|
||||
# nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
|
||||
# nginx: configuration file /etc/nginx/nginx.conf test is successful
|
||||
```
|
||||
|
||||
**Override default fastapi-dls systemd service**
|
||||
|
||||
```shell
|
||||
mkdir /etc/systemd/system/fastapi-dls.service.d
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>`/etc/systemd/system/fastapi-dls.service.d/override.conf`</summary>
|
||||
|
||||
```
|
||||
[Service]
|
||||
ExecStart=
|
||||
ExecStart=uvicorn main:app \
|
||||
--env-file /etc/fastapi-dls/env \
|
||||
--host 127.0.0.1 --port 8000 \
|
||||
--app-dir /usr/share/fastapi-dls/app \
|
||||
--proxy-headers
|
||||
```
|
||||
</details>
|
||||
|
||||
**Run**
|
||||
|
||||
```shell
|
||||
systemctl daemon-reload
|
||||
service nginx start
|
||||
service fastapi-dls start
|
||||
```
|
||||
|
||||
# Configuration (Service)
|
||||
|
||||
| Variable | Default | Usage |
|
||||
|------------------------|----------------------------------------|------------------------------------------------------------------------------------------------------|
|
||||
| `DEBUG` | `false` | Toggles `fastapi` debug mode |
|
||||
| `DLS_URL` | `localhost` | Used in client-token to tell guest driver where dls instance is reachable |
|
||||
| `DLS_PORT` | `443` | Used in client-token to tell guest driver where dls instance is reachable |
|
||||
| `CERT_PATH` | `None` | Path to a Directory where generated Certificates are stored. Defaults to `/<app-dir>/cert`. |
|
||||
| `TOKEN_EXPIRE_DAYS` | `1` | Client auth-token validity (used for authenticate client against api, **not `.tok` file!**) |
|
||||
| `LEASE_EXPIRE_DAYS` | `90` | Lease time in days |
|
||||
| `LEASE_RENEWAL_PERIOD` | `0.15` | The percentage of the lease period that must elapse before a licensed client can renew a license \*1 |
|
||||
| `DATABASE` | `sqlite:///db.sqlite` | See [official SQLAlchemy docs](https://docs.sqlalchemy.org/en/14/core/engines.html) |
|
||||
| `CORS_ORIGINS` | `https://{DLS_URL}` | Sets `Access-Control-Allow-Origin` header (comma separated string) \*2 |
|
||||
| `SITE_KEY_XID` | `00000000-0000-0000-0000-000000000000` | Site identification uuid |
|
||||
| `INSTANCE_REF` | `10000000-0000-0000-0000-000000000001` | Instance identification uuid |
|
||||
| `ALLOTMENT_REF` | `20000000-0000-0000-0000-000000000001` | Allotment identification uuid |
|
||||
|
||||
\*1 For example, if the lease period is one day and the renewal period is 20%, the client attempts to renew its license
|
||||
every 4.8 hours. If network connectivity is lost, the loss of connectivity is detected during license renewal and the
|
||||
@@ -535,9 +670,9 @@ Status endpoint, used for *healthcheck*.
|
||||
|
||||
Shows current runtime environment variables and their values.
|
||||
|
||||
**`GET /-/config/root-ca`**
|
||||
**`GET /-/config/root-certificate`**
|
||||
|
||||
Returns the Root-CA Certificate which is used. This is required for patching `nvidia-gridd` on 18.x releases.
|
||||
Returns the Root-Certificate Certificate which is used. This is required for patching `nvidia-gridd` on 18.x releases.
|
||||
|
||||
**`GET /-/readme`**
|
||||
|
||||
@@ -748,20 +883,22 @@ The error message can safely be ignored (since we have no license limitation :P)
|
||||
# vGPU Software Compatibility Matrix
|
||||
|
||||
<details>
|
||||
<summary>Show Table</summary>
|
||||
|
||||
Successfully tested with this package versions.
|
||||
<summary>Successfully tested with this package versions: Show Table</summary>
|
||||
|
||||
| FastAPI-DLS Version | vGPU Suftware | Driver Branch | Linux vGPU Manager | Linux Driver | Windows Driver | Release Date | EOL Date |
|
||||
|---------------------|:-------------:|:-------------:|--------------------|--------------|----------------|--------------:|--------------:|
|
||||
| `2.x` | `18.0` | **R570** | `570.124.03` | `570.124.06` | `572.60` | March 2025 | March 2026 |
|
||||
| `1.x` & `2.x` | `17.5` | | `550.144.02` | `550.144.03` | `553.62` | January 2025 | June 2025 |
|
||||
| `2.x` | `18.3` | **R570** | `570.158.02` | `570.158.01` | `573.36` | June 2025 | March 2026 |
|
||||
| | `18.2` | **R570** | `570.148.06` | `570.148.08` | `573.07` | May 2025 | |
|
||||
| | `18.1` | **R570** | `570.133.08` | `570.133.07` | `572.83` | April 2025 | |
|
||||
| | `18.0` | **R570** | `570.124.03` | `570.124.06` | `572.60` | March 2025 | |
|
||||
| `1.x` & `2.x` | `17.6` | **R550** | `550.163.02` | `550.63.01` | `553.74` | April 2025 | June 2025 |
|
||||
| | `17.5` | | `550.144.02` | `550.144.03` | `553.62` | January 2025 | |
|
||||
| | `17.4` | | `550.127.06` | `550.127.05` | `553.24` | October 2024 | |
|
||||
| | `17.3` | | `550.90.05` | `550.90.07` | `552.74` | July 2024 | |
|
||||
| | `17.2` | | `550.90.05` | `550.90.07` | `552.55` | June 2024 | |
|
||||
| | `17.1` | | `550.54.16` | `550.54.15` | `551.78` | March 2024 | |
|
||||
| | `17.0` | **R550** | `550.54.10` | `550.54.14` | `551.61` | February 2024 | |
|
||||
| `1.x` | `16.9` | **R535** | `535.230.02` | `535.216.01` | `539.19` | October 2024 | July 2026 |
|
||||
| `1.x` | `16.10` | **R535** | `535.247.02` | `535.247.01` | `539.28` | April 2025 | July 2026 |
|
||||
| `1.x` | `15.4` | **R525** | `525.147.01` | `525.147.05` | `529.19` | June 2023 | December 2023 |
|
||||
| `1.x` | `14.4` | **R510** | `510.108.03` | `510.108.03` | `514.08` | December 2022 | February 2023 |
|
||||
|
||||
@@ -787,6 +924,6 @@ Special thanks to:
|
||||
- `Krutav Shah` who wrote the [vGPU_Unlock Wiki](https://docs.google.com/document/d/1pzrWJ9h-zANCtyqRgS7Vzla0Y8Ea2-5z2HEi4X75d2Q/)
|
||||
- `Wim van 't Hoog` for the [Proxmox All-In-One Installer Script](https://wvthoog.nl/proxmox-vgpu-v3/)
|
||||
- `mrzenc` who wrote [fastapi-dls-nixos](https://github.com/mrzenc/fastapi-dls-nixos)
|
||||
- `electricsheep49` who wrote [gridd-unlock-patcher](https://git.collinwebdesigns.de/oscar.krause/gridd-unlock-patcher)
|
||||
- `electricsheep49` who wrote [gridd-unlock-patcher](https://git.collinwebdesigns.de/vgpu/gridd-unlock-patcher)
|
||||
|
||||
And thanks to all people who contributed to all these libraries!
|
||||
|
||||
11
ROADMAP.md
11
ROADMAP.md
@@ -2,6 +2,17 @@
|
||||
|
||||
I am planning to implement the following features in the future.
|
||||
|
||||
## Patching Endpoint
|
||||
|
||||
A (optional) Path-Variable to `gridd-unlock-patcher` which enables an additional endpoint.
|
||||
Here you can upload your `nvidia-gridd` binary or `nvxdapix.dll` which then will be patched and responded.
|
||||
|
||||
## All-In-One Installer Script Endpoint
|
||||
|
||||
A new all-in-one installer endpoint
|
||||
(here a script is returned for linux or windows which then could be called like
|
||||
curl https://<fastapi-dls>/-/install/deb | sh which then
|
||||
download and place a client-token in the right directory, patch your girdd / dll and restart nvidia-gridd service)
|
||||
|
||||
## HA - High Availability
|
||||
|
||||
|
||||
73
app/main.py
73
app/main.py
@@ -6,7 +6,8 @@ from datetime import datetime, timedelta, UTC
|
||||
from hashlib import sha256
|
||||
from json import loads as json_loads, dumps as json_dumps
|
||||
from os import getenv as env
|
||||
from os.path import join, dirname
|
||||
from os.path import join, dirname, exists, isdir, isfile
|
||||
from textwrap import wrap
|
||||
from uuid import uuid4
|
||||
|
||||
from dateutil.relativedelta import relativedelta
|
||||
@@ -19,6 +20,7 @@ from jose.constants import ALGORITHMS
|
||||
from sqlalchemy import create_engine
|
||||
from sqlalchemy.orm import sessionmaker
|
||||
from starlette.middleware.cors import CORSMiddleware
|
||||
from starlette.staticfiles import StaticFiles
|
||||
|
||||
from orm import Origin, Lease, init as db_init, migrate
|
||||
from util import CASetup, PrivateKey, Cert, ProductMapping, load_file
|
||||
@@ -39,6 +41,7 @@ db_init(db), migrate(db)
|
||||
# Load DLS variables (all prefixed with "INSTANCE_*" is used as "SERVICE_INSTANCE_*" or "SI_*" in official dls service)
|
||||
DLS_URL = str(env('DLS_URL', 'localhost'))
|
||||
DLS_PORT = int(env('DLS_PORT', '443'))
|
||||
CERT_PATH = str(env('CERT_PATH', None))
|
||||
SITE_KEY_XID = str(env('SITE_KEY_XID', '00000000-0000-0000-0000-000000000000'))
|
||||
INSTANCE_REF = str(env('INSTANCE_REF', '10000000-0000-0000-0000-000000000001'))
|
||||
ALLOTMENT_REF = str(env('ALLOTMENT_REF', '20000000-0000-0000-0000-000000000001'))
|
||||
@@ -48,11 +51,14 @@ LEASE_RENEWAL_PERIOD = float(env('LEASE_RENEWAL_PERIOD', 0.15))
|
||||
LEASE_RENEWAL_DELTA = timedelta(days=int(env('LEASE_EXPIRE_DAYS', 90)), hours=int(env('LEASE_EXPIRE_HOURS', 0)))
|
||||
CLIENT_TOKEN_EXPIRE_DELTA = relativedelta(years=12)
|
||||
CORS_ORIGINS = str(env('CORS_ORIGINS', '')).split(',') if (env('CORS_ORIGINS')) else [f'https://{DLS_URL}']
|
||||
DRIVERS_DIR = env('DRIVERS_DIR', None)
|
||||
DT_FORMAT = '%Y-%m-%dT%H:%M:%S.%fZ'
|
||||
PRODUCT_MAPPING = ProductMapping(filename=join(dirname(__file__), 'static/product_mapping.json'))
|
||||
|
||||
# Create certificate chain and signing keys
|
||||
ca_setup = CASetup(service_instance_ref=INSTANCE_REF)
|
||||
ca_setup = CASetup(service_instance_ref=INSTANCE_REF, cert_path=CERT_PATH)
|
||||
my_root_private_key = PrivateKey.from_file(ca_setup.root_private_key_filename)
|
||||
my_root_public_key = my_root_private_key.public_key()
|
||||
my_root_certificate = Cert.from_file(ca_setup.root_certificate_filename)
|
||||
my_ca_certificate = Cert.from_file(ca_setup.ca_certificate_filename)
|
||||
my_si_certificate = Cert.from_file(ca_setup.si_certificate_filename)
|
||||
@@ -96,6 +102,9 @@ async def lifespan(_: FastAPI):
|
||||
config = dict(openapi_url=None, docs_url=None, redoc_url=None) # dict(openapi_url='/-/openapi.json', docs_url='/-/docs', redoc_url='/-/redoc')
|
||||
app = FastAPI(title='FastAPI-DLS', description='Minimal Delegated License Service (DLS).', version=VERSION, lifespan=lifespan, **config)
|
||||
|
||||
if DRIVERS_DIR is not None:
|
||||
app.mount('/-/static-drivers', StaticFiles(directory=str(DRIVERS_DIR), html=False), name='drivers')
|
||||
|
||||
app.debug = DEBUG
|
||||
app.add_middleware(
|
||||
CORSMiddleware,
|
||||
@@ -151,10 +160,9 @@ async def _config():
|
||||
return Response(content=json_dumps(response), media_type='application/json', status_code=200)
|
||||
|
||||
|
||||
|
||||
@app.get('/-/config/root-ca', summary='* Root CA', description='returns Root-CA needed for patching nvidia-gridd')
|
||||
@app.get('/-/config/root-certificate', summary='* Root Certificate', description='returns Root--Certificate needed for patching nvidia-gridd')
|
||||
async def _config():
|
||||
return Response(content=my_root_certificate.pem().decode('utf-8'), media_type='text/plain')
|
||||
return Response(content=my_root_certificate.pem().decode('utf-8').strip(), media_type='text/plain')
|
||||
|
||||
|
||||
@app.get('/-/readme', summary='* Readme')
|
||||
@@ -203,6 +211,25 @@ async def _manage(request: Request):
|
||||
return Response(response, media_type='text/html', status_code=200)
|
||||
|
||||
|
||||
@app.get('/-/drivers/{directory:path}', summary='* List drivers directory')
|
||||
async def _drivers(request: Request, directory: str | None):
|
||||
if DRIVERS_DIR is None:
|
||||
return Response(status_code=404, content=f'Variable "DRIVERS_DIR" not set.')
|
||||
|
||||
path = join(DRIVERS_DIR, directory)
|
||||
|
||||
if not exists(path) and not isfile(path):
|
||||
return Response(status_code=404, content=f'Resource "{path}" not found!')
|
||||
|
||||
content = [{
|
||||
"type": "file" if isfile(f'{path}/{_}') else "folder" if isdir(f'{path}/{_}') else "unknown",
|
||||
"name": _,
|
||||
"link": f'/-/static-drivers/{directory}{_}',
|
||||
} for _ in listdir(path)]
|
||||
|
||||
return Response(content=json_dumps({"directory": path, "content": content}), media_type='application/json', status_code=200)
|
||||
|
||||
|
||||
@app.get('/-/origins', summary='* Origins')
|
||||
async def _origins(request: Request, leases: bool = False):
|
||||
session = sessionmaker(bind=db)()
|
||||
@@ -287,7 +314,7 @@ async def _client_token():
|
||||
"mod": my_si_public_key.mod(),
|
||||
"exp": my_si_public_key.exp(),
|
||||
},
|
||||
"service_instance_public_key_pem": my_si_private_key.public_key().pem().decode('utf-8'),
|
||||
"service_instance_public_key_pem": my_si_public_key.pem().decode('utf-8').strip(),
|
||||
"key_retention_mode": "LATEST_ONLY"
|
||||
},
|
||||
}
|
||||
@@ -462,8 +489,7 @@ async def leasing_v1_config_token(request: Request):
|
||||
"mod": my_si_public_key.mod(),
|
||||
"exp": my_si_public_key.exp(),
|
||||
},
|
||||
# 64 chars per line (pem default)
|
||||
"service_instance_public_key_pem": my_si_private_key.public_key().pem().decode('utf-8').strip(),
|
||||
"service_instance_public_key_pem": my_si_public_key.pem().decode('utf-8').strip(),
|
||||
"key_retention_mode": "LATEST_ONLY"
|
||||
},
|
||||
}
|
||||
@@ -471,18 +497,37 @@ async def leasing_v1_config_token(request: Request):
|
||||
my_jwt_encode_key = jwk.construct(my_si_private_key.pem().decode('utf-8'), algorithm=ALGORITHMS.RS256)
|
||||
config_token = jws.sign(payload, key=my_jwt_encode_key, headers=None, algorithm=ALGORITHMS.RS256)
|
||||
|
||||
response_ca_chain = my_ca_certificate.pem().decode('utf-8')
|
||||
response_si_certificate = my_si_certificate.pem().decode('utf-8')
|
||||
response_ca_chain = my_ca_certificate.pem().decode('utf-8').strip()
|
||||
|
||||
# 76 chars per line on original response with "\r\n"
|
||||
"""
|
||||
response_ca_chain = my_ca_certificate.pem().decode('utf-8').strip()
|
||||
response_ca_chain = response_ca_chain.replace('-----BEGIN CERTIFICATE-----', '')
|
||||
response_ca_chain = response_ca_chain.replace('-----END CERTIFICATE-----', '')
|
||||
response_ca_chain = response_ca_chain.replace('\n', '')
|
||||
response_ca_chain = wrap(response_ca_chain, 76)
|
||||
response_ca_chain = '\r\n'.join(response_ca_chain)
|
||||
response_ca_chain = f'-----BEGIN CERTIFICATE-----\r\n{response_ca_chain}\r\n-----END CERTIFICATE-----'
|
||||
"""
|
||||
response_si_certificate = my_si_certificate.pem().decode('utf-8').strip()
|
||||
|
||||
# 76 chars per line on original response with "\r\n"
|
||||
"""
|
||||
response_si_certificate = my_si_certificate.pem().decode('utf-8').strip()
|
||||
response_si_certificate = response_si_certificate.replace('-----BEGIN CERTIFICATE-----', '')
|
||||
response_si_certificate = response_si_certificate.replace('-----END CERTIFICATE-----', '')
|
||||
response_si_certificate = response_si_certificate.replace('\n', '')
|
||||
response_si_certificate = wrap(response_si_certificate, 76)
|
||||
response_si_certificate = '\r\n'.join(response_si_certificate)
|
||||
"""
|
||||
|
||||
response = {
|
||||
"certificateConfiguration": {
|
||||
# 76 chars per line
|
||||
"caChain": [response_ca_chain],
|
||||
# 76 chars per line
|
||||
"publicCert": response_si_certificate,
|
||||
"publicKey": {
|
||||
"exp": int(my_si_certificate.raw().public_key().public_numbers().e),
|
||||
"mod": [hex(my_si_certificate.raw().public_key().public_numbers().n)[2:]],
|
||||
"exp": my_si_certificate.public_key().exp(),
|
||||
"mod": [my_si_certificate.public_key().mod()],
|
||||
},
|
||||
},
|
||||
"configToken": config_token,
|
||||
|
||||
52
app/util.py
52
app/util.py
@@ -1,7 +1,7 @@
|
||||
import logging
|
||||
from datetime import datetime, UTC, timedelta
|
||||
from json import loads as json_loads
|
||||
from os.path import join, dirname, isfile
|
||||
from os.path import join, dirname, isfile, isdir
|
||||
|
||||
from cryptography import x509
|
||||
from cryptography.hazmat._oid import NameOID
|
||||
@@ -38,14 +38,18 @@ class CASetup:
|
||||
SI_PRIVATE_KEY_FILENAME = 'si_private_key.pem'
|
||||
SI_CERTIFICATE_FILENAME = 'si_certificate.pem'
|
||||
|
||||
def __init__(self, service_instance_ref: str):
|
||||
def __init__(self, service_instance_ref: str, cert_path: str = None):
|
||||
cert_path_prefix = join(dirname(__file__), 'cert')
|
||||
if cert_path is not None and len(cert_path) > 0 and isdir(cert_path):
|
||||
cert_path_prefix = cert_path
|
||||
|
||||
self.service_instance_ref = service_instance_ref
|
||||
self.root_private_key_filename = join(dirname(__file__), 'cert', CASetup.ROOT_PRIVATE_KEY_FILENAME)
|
||||
self.root_certificate_filename = join(dirname(__file__), 'cert', CASetup.ROOT_CERTIFICATE_FILENAME)
|
||||
self.ca_private_key_filename = join(dirname(__file__), 'cert', CASetup.CA_PRIVATE_KEY_FILENAME)
|
||||
self.ca_certificate_filename = join(dirname(__file__), 'cert', CASetup.CA_CERTIFICATE_FILENAME)
|
||||
self.si_private_key_filename = join(dirname(__file__), 'cert', CASetup.SI_PRIVATE_KEY_FILENAME)
|
||||
self.si_certificate_filename = join(dirname(__file__), 'cert', CASetup.SI_CERTIFICATE_FILENAME)
|
||||
self.root_private_key_filename = join(cert_path_prefix, CASetup.ROOT_PRIVATE_KEY_FILENAME)
|
||||
self.root_certificate_filename = join(cert_path_prefix, CASetup.ROOT_CERTIFICATE_FILENAME)
|
||||
self.ca_private_key_filename = join(cert_path_prefix, CASetup.CA_PRIVATE_KEY_FILENAME)
|
||||
self.ca_certificate_filename = join(cert_path_prefix, CASetup.CA_CERTIFICATE_FILENAME)
|
||||
self.si_private_key_filename = join(cert_path_prefix, CASetup.SI_PRIVATE_KEY_FILENAME)
|
||||
self.si_certificate_filename = join(cert_path_prefix, CASetup.SI_CERTIFICATE_FILENAME)
|
||||
|
||||
if not (isfile(self.root_private_key_filename)
|
||||
and isfile(self.root_certificate_filename)
|
||||
@@ -81,7 +85,20 @@ class CASetup:
|
||||
.not_valid_before(datetime.now(tz=UTC) - timedelta(days=1))
|
||||
.not_valid_after(datetime.now(tz=UTC) + timedelta(days=365 * 10))
|
||||
.add_extension(x509.BasicConstraints(ca=True, path_length=None), critical=True)
|
||||
.add_extension(x509.KeyUsage(
|
||||
digital_signature=False,
|
||||
key_encipherment=False,
|
||||
key_cert_sign=True,
|
||||
key_agreement=False,
|
||||
content_commitment=False,
|
||||
data_encipherment=False,
|
||||
crl_sign=True,
|
||||
encipher_only=False,
|
||||
decipher_only=False),
|
||||
critical=True
|
||||
)
|
||||
.add_extension(x509.SubjectKeyIdentifier.from_public_key(my_root_public_key), critical=False)
|
||||
.add_extension(x509.AuthorityKeyIdentifier.from_issuer_public_key(my_root_public_key), critical=False)
|
||||
.sign(my_root_private_key, hashes.SHA256()))
|
||||
|
||||
my_root_private_key_as_pem = my_root_private_key.private_bytes(
|
||||
@@ -134,7 +151,6 @@ class CASetup:
|
||||
critical=True
|
||||
)
|
||||
.add_extension(x509.SubjectKeyIdentifier.from_public_key(my_ca_public_key), critical=False)
|
||||
# .add_extension(x509.AuthorityKeyIdentifier.from_issuer_public_key(my_root_public_key), critical=False)
|
||||
.add_extension(x509.AuthorityKeyIdentifier.from_issuer_subject_key_identifier(
|
||||
my_root_certificate.extensions.get_extension_for_class(x509.SubjectKeyIdentifier).value
|
||||
), critical=False)
|
||||
@@ -314,16 +330,22 @@ class Cert:
|
||||
def pem(self) -> bytes:
|
||||
return self.__cert.public_bytes(encoding=serialization.Encoding.PEM)
|
||||
|
||||
def public_key(self) -> "PublicKey":
|
||||
data = self.__cert.public_key().public_bytes(
|
||||
encoding=serialization.Encoding.PEM,
|
||||
format=serialization.PublicFormat.SubjectPublicKeyInfo
|
||||
)
|
||||
return PublicKey(data=data)
|
||||
|
||||
def signature(self) -> bytes:
|
||||
return self.__cert.signature
|
||||
|
||||
def subject_key_identifier(self):
|
||||
return self.__cert.extensions.get_extension_for_class(x509.SubjectKeyIdentifier).value.key_identifier
|
||||
|
||||
def authority_key_identifier(self):
|
||||
return self.__cert.extensions.get_extension_for_class(x509.AuthorityKeyIdentifier).value.key_identifier
|
||||
|
||||
def load_file(filename: str) -> bytes:
|
||||
log = logging.getLogger(f'{__name__}')
|
||||
log.debug(f'Loading contents of file "{filename}')
|
||||
with open(filename, 'rb') as file:
|
||||
content = file.read()
|
||||
return content
|
||||
|
||||
class DriverMatrix:
|
||||
__DRIVER_MATRIX_FILENAME = 'static/driver_matrix.json'
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
fastapi==0.115.12
|
||||
uvicorn[standard]==0.34.1
|
||||
python-jose[cryptography]==3.4.0
|
||||
cryptography==44.0.2
|
||||
fastapi==0.115.14
|
||||
uvicorn[standard]==0.35.0
|
||||
python-jose[cryptography]==3.5.0
|
||||
cryptography==45.0.5
|
||||
python-dateutil==2.9.0
|
||||
sqlalchemy==2.0.40
|
||||
markdown==3.8
|
||||
python-dotenv==1.1.0
|
||||
sqlalchemy==2.0.41
|
||||
markdown==3.8.2
|
||||
python-dotenv==1.1.1
|
||||
|
||||
49
test/main.py
49
test/main.py
@@ -6,6 +6,8 @@ from datetime import datetime, UTC
|
||||
from hashlib import sha256
|
||||
from uuid import uuid4, UUID
|
||||
|
||||
from cryptography.hazmat.primitives.asymmetric.padding import PKCS1v15
|
||||
from cryptography.hazmat.primitives.hashes import SHA256
|
||||
from dateutil.relativedelta import relativedelta
|
||||
from jose import jwt, jwk, jws
|
||||
from jose.constants import ALGORITHMS
|
||||
@@ -26,11 +28,15 @@ ORIGIN_REF, ALLOTMENT_REF, SECRET = str(uuid4()), '20000000-0000-0000-0000-00000
|
||||
|
||||
# CA & Signing
|
||||
ca_setup = CASetup(service_instance_ref=INSTANCE_REF)
|
||||
my_root_private_key = PrivateKey.from_file(ca_setup.root_private_key_filename)
|
||||
my_root_certificate = Cert.from_file(ca_setup.root_certificate_filename)
|
||||
my_ca_certificate = Cert.from_file(ca_setup.ca_certificate_filename)
|
||||
my_ca_private_key = PrivateKey.from_file(ca_setup.ca_private_key_filename)
|
||||
my_si_private_key = PrivateKey.from_file(ca_setup.si_private_key_filename)
|
||||
my_si_private_key_as_pem = my_si_private_key.pem()
|
||||
my_si_public_key = my_si_private_key.public_key()
|
||||
my_si_public_key_as_pem = my_si_private_key.public_key().pem()
|
||||
my_si_certificate = Cert.from_file(ca_setup.si_certificate_filename)
|
||||
|
||||
jwt_encode_key = jwk.construct(my_si_private_key_as_pem, algorithm=ALGORITHMS.RS256)
|
||||
jwt_decode_key = jwk.construct(my_si_public_key_as_pem, algorithm=ALGORITHMS.RS256)
|
||||
@@ -59,6 +65,31 @@ def test_signing():
|
||||
my_si_public_key.verify_signature(signature_get_header, b'Hello')
|
||||
|
||||
|
||||
def test_keypair_and_certificates():
|
||||
assert my_root_certificate.public_key().mod() == my_root_private_key.public_key().mod()
|
||||
assert my_ca_certificate.public_key().mod() == my_ca_private_key.public_key().mod()
|
||||
assert my_si_certificate.public_key().mod() == my_si_public_key.mod()
|
||||
|
||||
assert len(my_root_certificate.public_key().mod()) == 1024
|
||||
assert len(my_ca_certificate.public_key().mod()) == 1024
|
||||
assert len(my_si_certificate.public_key().mod()) == 512
|
||||
|
||||
#assert my_si_certificate.public_key().mod() != my_si_public_key.mod()
|
||||
|
||||
my_root_certificate.public_key().raw().verify(
|
||||
my_ca_certificate.raw().signature,
|
||||
my_ca_certificate.raw().tbs_certificate_bytes,
|
||||
PKCS1v15(),
|
||||
SHA256(),
|
||||
)
|
||||
my_ca_certificate.public_key().raw().verify(
|
||||
my_si_certificate.raw().signature,
|
||||
my_si_certificate.raw().tbs_certificate_bytes,
|
||||
PKCS1v15(),
|
||||
SHA256(),
|
||||
)
|
||||
|
||||
|
||||
def test_index():
|
||||
response = client.get('/')
|
||||
assert response.status_code == 200
|
||||
@@ -76,9 +107,9 @@ def test_config():
|
||||
|
||||
|
||||
def test_config_root_ca():
|
||||
response = client.get('/-/config/root-ca')
|
||||
response = client.get('/-/config/root-certificate')
|
||||
assert response.status_code == 200
|
||||
assert response.content.decode('utf-8') == my_root_certificate.pem().decode('utf-8')
|
||||
assert response.content.decode('utf-8').strip() == my_root_certificate.pem().decode('utf-8').strip()
|
||||
|
||||
|
||||
def test_readme():
|
||||
@@ -103,7 +134,17 @@ def test_config_token():
|
||||
assert response.status_code == 200
|
||||
|
||||
nv_response_certificate_configuration = response.json().get('certificateConfiguration')
|
||||
|
||||
nv_ca_chain = nv_response_certificate_configuration.get('caChain')[0].encode('utf-8')
|
||||
nv_ca_chain = Cert(nv_ca_chain)
|
||||
|
||||
nv_response_public_cert = nv_response_certificate_configuration.get('publicCert').encode('utf-8')
|
||||
nv_response_public_key = nv_response_certificate_configuration.get('publicKey')
|
||||
|
||||
nv_si_certificate = Cert(nv_response_public_cert)
|
||||
assert nv_si_certificate.public_key().mod() == nv_response_public_key.get('mod')[0]
|
||||
assert nv_si_certificate.authority_key_identifier() == nv_ca_chain.subject_key_identifier()
|
||||
|
||||
nv_jwt_decode_key = jwk.construct(nv_response_public_cert, algorithm=ALGORITHMS.RS256)
|
||||
|
||||
nv_response_config_token = response.json().get('configToken')
|
||||
@@ -116,8 +157,8 @@ def test_config_token():
|
||||
|
||||
nv_si_public_key_configuration = payload.get('service_instance_public_key_configuration')
|
||||
nv_si_public_key_me = nv_si_public_key_configuration.get('service_instance_public_key_me')
|
||||
# assert nv_si_public_key_me.get('mod') == 1 #nv_si_public_key_mod
|
||||
assert len(nv_si_public_key_me.get('mod')) == 512
|
||||
|
||||
assert len(nv_si_public_key_me.get('mod')) == 512 # nv_si_public_key_mod
|
||||
assert nv_si_public_key_me.get('exp') == 65537 # nv_si_public_key_exp
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user