sdk_common/doc/PRD-PCD-Specs.md

9.5 KiB

# PRD et PCD - Specs

1. 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.

2. 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.

3. 3. Documents de référence

Voir Doc_references.md.

4. Fonction des PCD

Les Portable Contract Documents (PCD) sont des documents JSON qui encapsulent les listes versionnées d'Item dont les attributs sont chiffrés soit en public, soit en confidentiel par rôles soit en privé (cf. Specs-Security.md).

Les Item ainsi échangés via les PCD sont vérifiés par les PRDResponse afin de vérifier les validations de ces données et leurs conformités avec les process et les members concernés.

5. Fonction des PRD

Les Portable Request Documents (PRD) sont des documents JSON qui encapsulent les valeurs de signatures et les clés de déchiffrement nécessaires à l'interprétation des PCD. Ils sont utilisés pour demander des actions spécifiques, telles que l'envoi de messages, la mise à jour des informations contractuelles, ou la confirmation de transactions.

Les clés de chiffrement des attributs confidentiels par rôles des Item des PCD sont chiffrées dans les PRD avec le chiffrement du PRD par la clé KeyConfidential d'une transaction Silent Payment SP (cf. Specs-Security.md). Ces clés ne sont distribués qu'aux members concernés par les Item des PCD (rôles dans les process).

Les PRD sont de plusieurs types tels que 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.

Fonction des transactions silent payment SP associées aux PRD

La clé KeyConfidential d'une transaction Silent Payment SP est utilisée pour chiffrer les PRD. Cette clé est échangée avec le destinataire via un Diffie-Hellman (cf. Specs-Security.md) dans la transaction. Cette information est parrallèle aux PRD et permet une meilleur sécurité et confidentialité des échanges.

La transaction Silent Payment SP a aussi une fonction d'horodate et de preuve de publication des PRD donc de la validation des données des PCD. Les outputs de la transaction Silent Payment SP contiennent les empreintes cryptographiques des messages et PRD (sauf PRDKeyBackup) et des PCD. Ainsi l'infrastructure blockchain de signet de 4NK permet de vérifier l'intégrité des flux, leur ordre de référence (horodatage) et leur preuve de publication.

Les PRDConfirm qui sont des accusés automatiques de réception des PRD sont aussi associés à une transaction Silent Payment SP, ce qui permet d'ajouter les preuves de réception des demandes et des validations (ou non).

5.1. RequestPrdList - Demande de Listes (PCD)

Utile pour les utilisateurs cherchant à consulter ou à explorer des listes de contrats, de membres, ou d'autres items dans le réseau.

5.2. RequestPrdMessage - Envoi de Messages

Le RequestPrdMessage facilite l'envoi de messages sécurisés entre utilisateurs ou entre utilisateurs et processus/contrats.

Permet la communication directe et sécurisée au sein du réseau, supportant des échanges d'informations critiques ou des notifications entre parties.

Les PRDMessage répondent aux PRDMessage.

5.3. RequestPrdUpdate - Mises à Jour de PCD

RequestPrdUpdate est conçu pour demander des mises à jour des listes via des nouvelles versions de PCD.

Basé sur le RequestPrd. avec des additions pour spécifier les modifications demandées, y compris de nouveaux attributs ou valeurs à mettre à jour :

Essentiel pour les utilisateurs ou les processus nécessitant de mettre à jour des informations contractuelles ou des attributs d'items, assurant la pertinence et l'actualité des données dans le système.

Par exemple, mettre à jour la liste des membres permet d'ajouter de nouveaux utilisateurs sur un process, la mise à jour de la liste des process permettra de leur affecter un nouveau role.

5.4. RequestPrdConfirm - Confirmation de Réception

Le RequestPrdConfirm est utilisé pour confirmer la réception et le traitement de demandes ou de transactions, jouant un rôle crucial dans la validation des actions au sein du réseau.

Les PRDList, PRDUpdate, PRDMessage, PRDResponse et PRDKeyHello reçoivent systématiquement un PRDConfirm depuis leur réception par le destinataire.

code_confirm_enc_by_shared_secret: Un code de confirmation chiffré qui valide l'authenticité et l'intégrité de la réponse, assurant que la confirmation est sécurisée et provient de la source attendue. Dans ce cas un output spécifique chiffré par la clé KeyConfidential précise ce code, à confirmer dans le PRDConfirm.

Crucial pour les processus qui nécessitent une confirmation explicite de réception ou d'acceptation, comme la finalisation d'une transaction ou la validation d'un changement d'état dans un contrat.

5.5. RequestPrdResponse - Répondre à une Demande

Le RequestPrdResponse permet de répondre spécifiquement à des PRD reçus, facilitant un échange interactif d'informations ou de décisions entre les parties.

Les PRDResponse répondent aux PRDList, PRDUpdate, PRDKeyBackup et PRDKeyHello.

Utilisé pour fournir des feedbacks, des confirmations, ou des instructions supplémentaires en réponse à des demandes initiales, supportant une communication bidirectionnelle sécurisée et vérifiable.

Aussi le moyen de demander des moyens de paiement ou de dépot ou de preuve, puis de partager le payload de ces actions.

5.6. RequestPrdKeyHelloBakcup

Le RequestPrdKeyHelloBakcup permet de demander la stockage de nouveaux shards associés à une pre-id .

5.7. RequestPrdKeyHello - Échange de Clés et d'Identités

RequestPrdKeyHello est conçu pour initier ou répondre à des demandes d'échange de clés ou d'informations d'identité, essentiel pour la gestion sécurisée des accès et des identités au sein du 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.

6. Gestion et Échange des Documents

6.1. 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.

6.2. 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.

7. Exemples de Code

8. Todo

  • Extraits de code illustrant l'utilisation des PCD et PRD dans des scénarios réels.
  • Diagrammes de séquences