diff --git a/README.md b/README.md index a95287f..48147f0 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ If you want to contribute, you can clone / fork this repo. - **What can I do?** \ *Search für `todo` and try to figure out whats going on that some of our tests fail.* - **How can I debug my own DLS instance?** \ - *Follow [doc/DockerSetup.md](doc/DockerSetup.md), maybe see [Official Docs](#official-docs).* + *Follow [doc/DockerSetup.md](doc/NLS_DockerSetup), maybe see [Official Docs](#official-docs).* - **How can I let you know when I have found something out?** \ *Create an Issue / Pull-Request or write me on Discord.* - **Can I ask you something, about how something works or how I get specific details from my DLS instance??** \ @@ -33,7 +33,7 @@ are reset after we know how licensing process is working. Docs and current knowledge can be found in [doc's directory](doc/README.md). \* If this is successful, we can try to find a way around this. **I think** we have to completely -rebuild the [LicensingFlow](doc/LicensingFlow.md) on our own, to generate a InstanceToken, exchange with Nvidia, upload +rebuild the [LicensingFlow](doc/NLS_LicensingFlow) on our own, to generate a InstanceToken, exchange with Nvidia, upload the License to **our** instance, and with the included certificate and keypair we can fake our licenses. # Official Docs diff --git a/doc/DockerSetup.md b/doc/NLS_DockerSetup.md similarity index 100% rename from doc/DockerSetup.md rename to doc/NLS_DockerSetup.md diff --git a/doc/LicensingFlow.md b/doc/NLS_LicensingFlow.md similarity index 99% rename from doc/LicensingFlow.md rename to doc/NLS_LicensingFlow.md index 0d835fa..62a85fd 100644 --- a/doc/LicensingFlow.md +++ b/doc/NLS_LicensingFlow.md @@ -1,7 +1,7 @@ # NLS-Instance Debug Information > This file describes the data exchange and shows some payloads. For Code reference -> see [dls_instance_token.md](dls_instance_token.md). +> see [dls_instance_token.md](files/dls_instance_token.md). [TOC] diff --git a/doc/Setup.md b/doc/NLS_Setup.md similarity index 89% rename from doc/Setup.md rename to doc/NLS_Setup.md index 716c331..0c29006 100644 --- a/doc/Setup.md +++ b/doc/NLS_Setup.md @@ -6,7 +6,7 @@ **Docker Setup** -Please follow [DockerSetup](DockerSetup.md)-Guide. +Please follow [DockerSetup](NLS_DockerSetup)-Guide. **External DB Access** @@ -33,7 +33,7 @@ Now you can connect with `:5432` with any Database-Client you - Local Reset Token `28b22cb5-76db-4211-84a7-d2821293fe44` - [`dls_instance_token_03-26-2025-21-06-23.tok`](files/dls_instance_token_03-26-2025-21-06-23.tok) -- See [dls_instance_token.md](dls_instance_token.md) +- See [dls_instance_token.md](files/dls_instance_token.md) # 3. Create License Server (Nvidia Application Hub) @@ -54,11 +54,11 @@ Download your License 2. Click *Download* and confirm - [`license_03-26-2025-21-27-51.bin`](files/license_03-26-2025-21-27-51.bin) -- See [license.md](license.md) +- See [license.md](files/license.md) # 4. Debug Config-Token 1. Call `GET https:///leasing/v1/config-token` to get your config-token - [`config-token.json`](files/config-token.json) -- See [config-token.md](config-token.md) +- See [config-token.md](files/config-token.md) diff --git a/doc/README.md b/doc/README.md index 4a64dc9..bd33743 100644 --- a/doc/README.md +++ b/doc/README.md @@ -2,16 +2,16 @@ ## My Setup documentation -In [Setup.md](Setup.md) I wrote down every step with each file on my setup. +In [Setup.md](NLS_Setup) I wrote down every step with each file on my setup. With this detailed guide I hope to understand licensing process and how data and keys/tokens are handled. ## Read through -- [Installation / Docker Setup](DockerSetup.md) +- [Installation / Docker Setup](NLS_DockerSetup) - [Reverse Engineering Notes](ReverseEngineeringNotes.md) -- [Licensing Flow / Process](LicensingFlow.md) - - [Instance Token](dls_instance_token.md) - - [License File](license.md) - - [Config Token](config-token.md) +- [Licensing Flow / Process](NLS_LicensingFlow) + - [Instance Token](files/dls_instance_token.md) + - [License File](files/license.md) + - [Config Token](files/config-token.md) - [GriddClientRequestFlow](GriddClientRequestFlow.md) diff --git a/doc/database/README.md b/doc/database/README.md index 1b90c70..05bc627 100644 --- a/doc/database/README.md +++ b/doc/database/README.md @@ -6,4 +6,4 @@ This directory contains different states of the database. - `2-after-donwload-instance-token`: after download [`dls_instance_token_03-26-2025-21-06-23.tok`](../files/dls_instance_token_03-26-2025-21-06-23.tok) - `3-after-upload-license`: after upload [`license.bin`](../files/license_03-26-2025-21-27-51.bin) -To reproduce the *after* state, read [Setup.md](../Setup.md). +To reproduce the *after* state, read [Setup.md](../NLS_Setup). diff --git a/doc/config-token.md b/doc/files/config-token.md similarity index 100% rename from doc/config-token.md rename to doc/files/config-token.md diff --git a/doc/dls_instance_token.md b/doc/files/dls_instance_token.md similarity index 92% rename from doc/dls_instance_token.md rename to doc/files/dls_instance_token.md index 7c1a37d..870b98f 100644 --- a/doc/dls_instance_token.md +++ b/doc/files/dls_instance_token.md @@ -4,7 +4,7 @@ - Generated by `GET https:///service_instance_manager/v1/service-instance/identity-token` - Using binary `service_instance_token_manager.cpython-312-x86_64-linux-gnu.so` file -- [Example file](files/dls_instance_token_03-26-2025-21-06-23.tok) +- [Example file](dls_instance_token_03-26-2025-21-06-23.tok) - [Test file](/src/test/test_dls_instance_token.py) This file contains raw JSON with one attribute `identityToken`. diff --git a/doc/license.md b/doc/files/license.md similarity index 99% rename from doc/license.md rename to doc/files/license.md index e873e5d..bed6e24 100644 --- a/doc/license.md +++ b/doc/files/license.md @@ -3,7 +3,7 @@ > TODO: Unknown value / encrypted - Uploaded to `PUT https:///file_installation/v1/license-file` -- [Example file](files/license_03-26-2025-21-27-51.bin) +- [Example file](license_03-26-2025-21-27-51.bin) - [Test file](/src/test/test_license.py) This file contains a base64-decoded JSON with the following payload. @@ -25,7 +25,7 @@ This file contains a base64-decoded JSON with the following payload. For *logs* and *patches* see [src/nls/patches-and-logs](/src/nls/patches-and-logs). -This [Private-Key we have](LicensingFlow.md#public-keys-private-keys-certificates) - in DB-Table +This [Private-Key we have](NLS_LicensingFlow#public-keys-private-keys-certificates) - in DB-Table `service_instance_artifact`, Key `service_instance.identity` `si_identity_private_key = self._get_si_identity_private_key(service_instance_xid=service_instance_xid)`