4nk/sdk_common
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tables des matières update (doc)

Browse Source
This commit is contained in:
NicolasCantu 2024-02-16 17:14:35 +01:00
parent 634105d245
commit fcc8d0db15
6 changed files with 129 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/Doc_references.md
View File

@ -1,7 +1,7 @@
<!-- vscode-markdown-toc --> <!-- vscode-markdown-toc -->
* 1. [Worfklows](#Worfklows) * 1. [Worfklows](#Worfklows)
* 2. [Transverse](#Transverse) * 2. [Transverse](#Transverse)
* 3. [3.3. Diagrammes d'architecture](#Diagrammesdarchitecture) * 3. [Diagrammes d'architecture](#Diagrammesdarchitecture)
* 4. [Todo](#Todo) * 4. [Todo](#Todo)
<!-- vscode-markdown-toc-config <!-- vscode-markdown-toc-config
@ -29,7 +29,7 @@
* **Maintenance, environnement de déploiement**: [Specs-Deployment.md] * **Maintenance, environnement de déploiement**: [Specs-Deployment.md]
* **References**: [Specs-References.md](Specs-References.md) * **References**: [Specs-References.md](Specs-References.md)
## 3. <a name='Diagrammesdarchitecture'></a>3.3. Diagrammes d'architecture ## 3. <a name='Diagrammesdarchitecture'></a>Diagrammes d'architecture
* **Diagramme d'architecture montrant les composants principaux du système de login.** * **Diagramme d'architecture montrant les composants principaux du système de login.**
[SheatSheet 4NK](https://cryptpad.fr/diagram/#/2/diagram/view/3UG+7ccutUvJlwJ1-bR40RhgOA+rb5eEmw42wtkN19A) [SheatSheet 4NK](https://cryptpad.fr/diagram/#/2/diagram/view/3UG+7ccutUvJlwJ1-bR40RhgOA+rb5eEmw42wtkN19A)

9
doc/PRD-PCD-Specs.md
View File

@ -10,9 +10,8 @@
* 5.2. [Réception](#Rception-1) * 5.2. [Réception](#Rception-1)
* 6. [Fonction des RequestPrd](#FonctiondesRequestPrd) * 6. [Fonction des RequestPrd](#FonctiondesRequestPrd)
* 6.1. [Fonctionnalités optionnelles](#Fonctionnalitsoptionnelles) * 6.1. [Fonctionnalités optionnelles](#Fonctionnalitsoptionnelles)
* 6.2. [Fonction des`transaction SP` associées aux RequestPrd](#FonctiondestransactionssilentpaymentSPassociesauxRequestPrd) * 6.2. [Création et envoi](#Crationetenvoi-1)
* 6.3. [Création et envoi](#Crationetenvoi-1) * 6.3. [Réception](#Rception-1)
* 6.4. [Réception](#Rception-1)
* 7. [RequestPrdList - Demande de Listes ( RequestPcd)](#RequestPrdList-DemandedeListesRequestPcd) * 7. [RequestPrdList - Demande de Listes ( RequestPcd)](#RequestPrdList-DemandedeListesRequestPcd)
* 7.1. [Création et envoi](#Crationetenvoi-1) * 7.1. [Création et envoi](#Crationetenvoi-1)
* 7.2. [Réception](#Rception-1) * 7.2. [Réception](#Rception-1)
@ -143,7 +142,7 @@ Les adresses et les roles sont précisés en cas d'utilisateurs ayant plusieurs
Tous les échanges sont complétés de l'empreinte du device de l'emetteur envoyée de façon confidentielle via `device_footprint_enc_by_shared_secret`. Tous les échanges sont complétés de l'empreinte du device de l'emetteur envoyée de façon confidentielle via `device_footprint_enc_by_shared_secret`.
### 6.3. <a name='Crationetenvoi-1'></a>Création et envoi ### 6.2. <a name='Crationetenvoi-1'></a>Création et envoi
La création d'un `RequestPrd` suit plusieurs étapes : La création d'un `RequestPrd` suit plusieurs étapes :
@ -159,7 +158,7 @@ La création d'un `RequestPrd` suit plusieurs étapes :
Voir [Silent-Payment-Specs.md](Silent-Payment-Specs.md). Voir [Silent-Payment-Specs.md](Silent-Payment-Specs.md).
### 6.4. <a name='Rception-1'></a>Réception ### 6.3. <a name='Rception-1'></a>Réception
La réception d'un `RequestPcd` suit plusieurs étapes : La réception d'un `RequestPcd` suit plusieurs étapes :

16
doc/Silent-Payment-Specs.md
View File

@ -2,7 +2,11 @@
* 1. [Objectif](#Objectif) * 1. [Objectif](#Objectif)
* 2. [Portée](#Porte) * 2. [Portée](#Porte)
* 3. [Documents de référence](#Documentsderfrence) * 3. [Documents de référence](#Documentsderfrence)
* 4. [Structure des outputs](#Structuredesoutputs) * 4. [Fontion](#Fontion)
* 5. [Structure des outputs](#Structuredesoutputs)
* 6. [Envoi de la transaction SP](#EnvoidelatransactionSP)
* 6.1. [Dans un `RequestPrdMessage`](#DansunRequestPrdMessage)
* 6.2. [Dans un `Message` du `RequestPrdMessage`](#DansunMessageduRequestPrdMessage)
<!-- vscode-markdown-toc-config <!-- vscode-markdown-toc-config
numbering=true numbering=true
@ -17,7 +21,7 @@
Voir [Doc_references.md](Doc_references.md). Voir [Doc_references.md](Doc_references.md).
## 4. <a name='Structuredesoutputs'></a> Fontion ## 4. <a name='Fontion'></a> Fontion
La transaction SP à plusieurs objectifs : La transaction SP à plusieurs objectifs :
@ -34,7 +38,7 @@ Les `RequestPrdConfirm` qui sont des accusés automatiques de réception des `Re
Il y a une `transactions SP` pour tous les types de `RequestPrd` sauf pour les `RequestPrdKeyBackup` et les `RequestPrdKeyMessage` ayant l'attribut `raw_transaction_list` non vide. Il y a une `transactions SP` pour tous les types de `RequestPrd` sauf pour les `RequestPrdKeyBackup` et les `RequestPrdKeyMessage` ayant l'attribut `raw_transaction_list` non vide.
## 4. <a name='Structuredesoutputs'></a> Structure des outputs ## 5. <a name='Structuredesoutputs'></a> Structure des outputs
Une fois le `RequestPrd` finalisé, une transaction SP est réalisée, dans cette transaction plusieurs hashs sont ajoutés sur un outputs aux index suivants: Une fois le `RequestPrd` finalisé, une transaction SP est réalisée, dans cette transaction plusieurs hashs sont ajoutés sur un outputs aux index suivants:
@ -54,19 +58,19 @@ Une fois le `RequestPrd` finalisé, une transaction SP est réalisée, dans cett
Pour des raison de confidentialité, le role associé à l'`item_name` du `RequestPrd` peut définir (option) un salt pour la génération des hashs dans l'attribut `sp_output_salt_enc`. Pour des raison de confidentialité, le role associé à l'`item_name` du `RequestPrd` peut définir (option) un salt pour la génération des hashs dans l'attribut `sp_output_salt_enc`.
## 5. Envoi de la transaction SP ## 6. <a name='EnvoidelatransactionSP'></a>Envoi de la transaction SP
Afin d'améliorer la rélisience du broadcast des transactions, la transaction est envoyée à la fois : Afin d'améliorer la rélisience du broadcast des transactions, la transaction est envoyée à la fois :
1. Dans un `RequestPrdMessage` à un membre du rôle `member` du `ItemProcess` concerné et 1. Dans un `RequestPrdMessage` à un membre du rôle `member` du `ItemProcess` concerné et
2. Dans le `Message` du `RequestPrdMessage` sur les relais 2. Dans le `Message` du `RequestPrdMessage` sur les relais
### Dans un `RequestPrdMessage` ### 6.1. <a name='DansunRequestPrdMessage'></a>Dans un `RequestPrdMessage`
Dans l'attribut `raw_transaction_list` du `RequestPrdMessage` associé à la transaction SP. Dans l'attribut `raw_transaction_list` du `RequestPrdMessage` associé à la transaction SP.
La transaction sera broadcastée par les noeuds de signet du membre du role `member` du `ItemProcess` concerné qui a reçu ce message, il devra alors avoir un noeud de signet pour le broadcast. La transaction sera broadcastée par les noeuds de signet du membre du role `member` du `ItemProcess` concerné qui a reçu ce message, il devra alors avoir un noeud de signet pour le broadcast.
### Dans un `Message` du `RequestPrdMessage` ### 6.2. <a name='DansunMessageduRequestPrdMessage'></a>Dans un `Message` du `RequestPrdMessage`
Dans l'attribut `raw_transaction_list` du `Message` associé à la transaction SP. Dans l'attribut `raw_transaction_list` du `Message` associé à la transaction SP.
La transaction sera broadcastée par les noeuds de signet des relais. La transaction sera broadcastée par les noeuds de signet des relais.