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

cleaning PRD PCD doc

Browse Source
This commit is contained in:
NicolasCantu 2024-02-14 16:56:40 +01:00
parent 630b58df3c
commit ab56b30667
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2,17 +2,14 @@
* 1. [Objectif](#Objectif) * 1. [Objectif](#Objectif)
* 2. [Portée](#Porte) * 2. [Portée](#Porte)
* 3. [3. Documents de référence](#Documentsderfrence) * 3. [3. Documents de référence](#Documentsderfrence)
* 3.1. [Worfklows](#Worfklows) * 3.1. [Requetes](#Requetes)
* 3.2. [Transverse](#Transverse) * 3.2. [Structure et Fonction des PCD](#StructureetFonctiondesPCD)
* 3.3. [Structure des PCD et PRD et de leur attribut générique Request](#StructuredesPCDetPRDetdeleurattributgnriqueRequest) * 3.2.1. [L'attribut des listes PcdItemGenericEnc `item_list`](#LattributdeslistesPcdItemGenericEncitem_list)
* 3.4. [Structure et Fonction des PCD](#StructureetFonctiondesPCD) * 3.3. [Types de PRD et Leur Fonction](#TypesdePRDetLeurFonction)
* 3.4.1. [Structure de Base d'un PCD](#StructuredeBasedunPCD) * 3.3.1. [Structure de RequestPrd](#StructuredeRequestPrd)
* 3.4.2. [L'attribut des listes PcdItemGenericEnc `item_list`](#LattributdeslistesPcdItemGenericEncitem_list)
* 3.5. [Types de PRD et Leur Fonction](#TypesdePRDetLeurFonction)
* 3.5.1. [Structure de RequestPrd](#StructuredeRequestPrd)
* 4. [Gestion et Échange des Documents](#GestionetchangedesDocuments) * 4. [Gestion et Échange des Documents](#GestionetchangedesDocuments)
* 4.1. [Création et Distribution](#CrationetDistribution) * 4.1. [Création et Distribution](#CrationetDistribution)
* 4.2. [Validation et Mise à Jour](#ValidationetMiseJour) * 4.2. [Validation et Mise à Jour](#ValidationetMiseJour)
* 5. [Exemples de Code](#ExemplesdeCode) * 5. [Exemples de Code](#ExemplesdeCode)
<!-- vscode-markdown-toc-config <!-- vscode-markdown-toc-config
@ -21,31 +18,31 @@
/vscode-markdown-toc-config --> /vscode-markdown-toc-config -->
<!-- /vscode-markdown-toc --># PRD et PCD - Specs <!-- /vscode-markdown-toc --># PRD et PCD - Specs
## 1. <a name='Objectif'></a>Objectif ## 1. <a name='Objectif'></a>Objectif
Le but de cette section est d'introduire les Portable Contract Document (PCD) et Portable Request Document (PRD) comme éléments fondamentaux du système 4NK. Ces documents jouent un rôle crucial dans la sécurisation des échanges de données et la gestion des identités numériques au sein d'un réseau décentralisé. Ils permettent de définir des contrats numériques, de gérer les permissions d'accès, et de faciliter les communications et les opéraations sécurisées entre les différents acteurs du réseau. Le but de cette section est d'introduire les Portable Contract Document (PCD) et Portable Request Document (PRD) comme éléments fondamentaux du système 4NK. Ces documents jouent un rôle crucial dans la sécurisation des échanges de données et la gestion des identités numériques au sein d'un réseau décentralisé. Ils permettent de définir des contrats numériques, de gérer les permissions d'accès, et de faciliter les communications et les opéraations sécurisées entre les différents acteurs du réseau.
## 2. <a name='Porte'></a>Portée ## 2. <a name='Porte'></a>Portée
La spécification couvre la conception, le développement, et l'application pratique des PCD et PRD. Elle vise à expliquer leur fonctionnement, leur structure, et la manière dont ils contribuent à l'écosystème 4NK en offrant une méthode sécurisée et efficace pour le partage d'informations et la validation des transactions. Les PCD et PRD encapsulent les données contractuelles et les requêtes dans un format standardisé, assurant l'intégrité, la confidentialité, l'authenticité et la validation des informations échangées. La spécification couvre la conception, le développement, et l'application pratique des PCD et PRD. Elle vise à expliquer leur fonctionnement, leur structure, et la manière dont ils contribuent à l'écosystème 4NK en offrant une méthode sécurisée et efficace pour le partage d'informations et la validation des transactions. Les PCD et PRD encapsulent les données contractuelles et les requêtes dans un format standardisé, assurant l'intégrité, la confidentialité, l'authenticité et la validation des informations échangées.
## 3. <a name='Documentsderfrence'></a>3. Documents de référence ## 3. <a name='Documentsderfrence'></a>3. Documents de référence
Voir [Doc_references.md](Doc_references.md). Voir [Doc_references.md](Doc_references.md).
### 3.3. <a name='StructuredesPCDetPRDetdeleurattributgnriqueRequest'></a>Requetes ### 3.1. <a name='Requetes'></a>Requetes
### 3.4. <a name='StructureetFonctiondesPCD'></a>Structure et Fonction des PCD ### 3.2. <a name='StructureetFonctiondesPCD'></a>Structure et Fonction des PCD
#### 3.4.2. <a name='LattributdeslistesPcdItemGenericEncitem_list'></a>L'attribut des listes PcdItemGenericEnc `item_list` #### 3.2.1. <a name='LattributdeslistesPcdItemGenericEncitem_list'></a>L'attribut des listes PcdItemGenericEnc `item_list`
### 3.5. <a name='TypesdePRDetLeurFonction'></a>Types de PRD et Leur Fonction ### 3.3. <a name='TypesdePRDetLeurFonction'></a>Types de PRD et Leur Fonction
`RequestPrd`: Structure de base pour toutes les demandes, contenant des informations chiffrées essentielles pour l'interaction sécurisée entre les parties. `RequestPrd`: Structure de base pour toutes les demandes, contenant des informations chiffrées essentielles pour l'interaction sécurisée entre les parties.
`RequestPrdList`, `RequestPrdMessage`, `RequestPrdUpdate`, etc.: Variations de `PRD` pour différentes actions, telles que l'envoi de messages, la mise à jour des informations contractuelles, ou la confirmation de transactions. `RequestPrdList`, `RequestPrdMessage`, `RequestPrdUpdate`, etc.: Variations de `PRD` pour différentes actions, telles que l'envoi de messages, la mise à jour des informations contractuelles, ou la confirmation de transactions.
#### 3.5.1. <a name='StructuredeRequestPrd'></a>Structure de RequestPrd #### 3.3.1. <a name='StructuredeRequestPrd'></a>Structure de RequestPrd
##### RequestPrdList - Demande de Listes (PCD) ##### RequestPrdList - Demande de Listes (PCD)
@ -99,16 +96,19 @@ RequestPrdKeyHello est conçu pour initier ou répondre à des demandes d'échan
Important pour les processus d'onboarding de nouveaux membres, de réinitialisation des accès, ou de renouvellement des clés, facilitant une intégration sécurisée et la mise à jour des identités dans le réseau. Important pour les processus d'onboarding de nouveaux membres, de réinitialisation des accès, ou de renouvellement des clés, facilitant une intégration sécurisée et la mise à jour des identités dans le réseau.
## 4. <a name='GestionetchangedesDocuments'></a>Gestion et Échange des Documents ## 4. <a name='GestionetchangedesDocuments'></a>Gestion et Échange des Documents
### 4.1. <a name='CrationetDistribution'></a>Création et Distribution ### 4.1. <a name='CrationetDistribution'></a>Création et Distribution
Procédure de création des PCD et PRD, leur chiffrement, et les mécanismes de distribution sécurisée à travers le réseau 4NK. Procédure de création des PCD et PRD, leur chiffrement, et les mécanismes de distribution sécurisée à travers le réseau 4NK.
### 4.2. <a name='ValidationetMiseJour'></a>Validation et Mise à Jour ### 4.2. <a name='ValidationetMiseJour'></a>Validation et Mise à Jour
Processus de validation des informations contenues dans les PCD et PRD, ainsi que les procédures de mise à jour et de versioning des documents. Processus de validation des informations contenues dans les PCD et PRD, ainsi que les procédures de mise à jour et de versioning des documents.
## 5. <a name='ExemplesdeCode'></a>Exemples de Code ## 12. <a name='ExemplesdeCode'></a>Exemples de Code
Extraits de code illustrant l'utilisation des PCD et PRD dans des scénarios réels. ## Todo
* [ ] Extraits de code illustrant l'utilisation des PCD et PRD dans des scénarios réels.
* [ ] Diagrammes de séquences