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

prd storage format (doc)

Browse Source
This commit is contained in:
NicolasCantu 2024-03-08 12:06:23 +01:00
parent 48691b7abe
commit 8b34cd39eb
2 changed files with 88 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
doc/Data-Specs.md
View File

@ -39,6 +39,7 @@ pseudo-code:
```json ```json
[ [
{ {
"hash": "",
"label": "", "label": "",
"device_footprint": "", "device_footprint": "",
"third_party_list": [ "third_party_list": [
@ -59,6 +60,7 @@ pseudo-code:
```json ```json
[ [
{ {
"hash": "",
"shared_peer": { "shared_peer": {
"domain": "String", "domain": "String",
"address_ip": "String", "address_ip": "String",
@ -624,6 +626,7 @@ pseudo-code:
```json ```json
[{ [{
"hash": "",
"me_sender": false, "me_sender": false,
"process_hash": "", "process_hash": "",
"item_name": "", "item_name": "",
@ -661,6 +664,7 @@ pseudo-code:
```json ```json
[ [
{ {
"hash": "",
"request": { "request": {
"item_name": "", "item_name": "",
"request_type": "", "request_type": "",
@ -707,6 +711,7 @@ pseudo-code:
```json ```json
[ [
{ {
"hash": "",
"request": { "request": {
"item_name": "", "item_name": "",
"request_type": "", "request_type": "",
@ -718,43 +723,31 @@ pseudo-code:
"request_prd_origin_hash": "", "request_prd_origin_hash": "",
"item_reference_hash": "" "item_reference_hash": ""
}, },
"": "", "request_pcd_reference_keys_role_confidential_list_enc_by_shared_secret": "",
"": "", "request_pcd_origin_hash_keys_role_confidential_list_enc_by_shared_secret": "",
"": "", "message_public": "",
"": "", "message_confidential": "",
"": "", "message_private": "",
"": "", "sp_address_to": "",
"": "", "sp_address_from": "",
"": "", "sp_address_reply": "",
"": "", "timestamp_declared": 0,
"": "", "role_name_from": "",
"": "", "role_name_to": "",
"": "", "payment_method_enc_by_shared_secret": "",
"": "", "deposit_method_enc_by_shared_secret": "",
"": "", "commitment_method_enc_by_shared_secret": "",
"": "", "payment_request_pcd_hash_list_enc_by_shared_secret": [""],
"": "", "cap_request_pcd_hash_list_enc_by_shared_secret": [""],
"": "", "deposit_request_pcd_hash_list_enc_by_shared_secret": [""],
"": "", "commitment_request_pcd_hash_list_enc_by_shared_secret": [""],
"": "", "ask_payment_method_enc_by_shared_secret": "",
"": "", "ask_deposit_method_enc_by_shared_secret": "",
"": "", "ask_commitment_method_enc_by_shared_secret": "",
"": "", "certif_key_enc_by_shared_secret": "",
"": "", "device_footprint_enc_by_sp_shared_secret": "",
"": "", "validation_status": "pending|ok|ko"
"": "", }
"": "",
"": "",
"": "",
"": "",
"": "",
"": "",
"": "",
"": "",
"": "",
"": "",
"": "",
"": "",
] ]
``` ```
@ -767,6 +760,7 @@ pseudo-code:
```json ```json
[ [
{ {
"hash_public": "",
"label": "", "label": "",
"keyrecoverSpend": { "keyrecoverSpend": {
"seed_rand_1": "", "seed_rand_1": "",
@ -791,6 +785,7 @@ pseudo-code:
```json ```json
[ [
{ {
"hash_public": "",
"shared_peer": { "shared_peer": {
"domain": "", "domain": "",
"address_ip": "", "address_ip": "",
@ -841,7 +836,7 @@ pseudo-code:
```json ```json
[ [
{ {
"hash": "", "hash_public": "",
"item": { "item": {
"metadata_private": { "metadata_private": {
"metadata": { "metadata": {
@ -949,9 +944,35 @@ pseudo-code:
```json ```json
[{ [{
"pcd_hash": "", "hash_public": "",
"pcd_aes_key_decrypted_list": [""] "pcd_aes_key_list_decrypted": [""]
}] }]
``` ```
### 5.5. <a name='RequestPrd-1'></a>RequestPrd ### 5.5. <a name='RequestPrd-1'></a>RequestPrd
```json
[
{
"hash_public": "",
"sig_value": "",
"request_pcd_reference_keys_role_confidential_list_decrypted": "",
"request_pcd_origin_hash_keys_role_confidential_listdecrypted": "",
"message_public_decrypted": "",
"message_confidential_decrypted": "",
"message_private_decrypted": "",
"payment_method_decrypted": "",
"deposit_method_decrypted": "",
"commitment_method_decrypted": "",
"payment_request_pcd_hash_list_decrypted": [""],
"cap_request_pcd_hash_list_decrypted": [""],
"deposit_request_pcd_hash_list_decrypted": [""],
"commitment_request_pcd_hash_list_decrypted": [""],
"ask_payment_method_decryptedt": "",
"ask_deposit_method_decrypted": "",
"ask_commitment_method_decrypted": "",
"certif_key_decrypted": "",
"device_footprint_decrypted": ""
}
]
```

53
doc/Specs-Datamodel.md
View File

@ -721,32 +721,33 @@ It specifies private encrypted attributes for `request_pcd` items, protecting th
Encapsulates a detailed request within the system, focusing on the interaction with Portable Request Documents ( RequestPrd) and specifying various levels of message confidentiality and intended service provider (SP) communication details. Encapsulates a detailed request within the system, focusing on the interaction with Portable Request Documents ( RequestPrd) and specifying various levels of message confidentiality and intended service provider (SP) communication details.
| Attribute Name | Type | Option | Description | | Attribute Name | Type | Option | Description |
|----------------------------------------------------------------|-------------------|--------|-----------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------|-------------------|--------|--------------------------------------------------------------------------|
| `request` | ```Request``` | | A predefined struct representing the basic request information. | | `request` | ```Request``` | | A predefined struct representing the basic request information. |
| `sig_value` | ```String``` | | Valeur associée à la signature | | `sig_value` | ```String``` | | Valeur associée à la signature |
| `request_pcd_keys_role_confidential_list_enc_by_shared_secret` | ```String``` | | Encrypted list of RequestPcd keys for role-confidential data, encrypted with a shared secret. | | `request_pcd_reference_keys_role_confidential_list_enc_by_shared_secret` | ```Vec<String>``` | | |
| `message_public` | ```String``` | Yes | Optionally specifies a public message associated with the request. | | `request_pcd_origin_hash_keys_role_confidential_list_enc_by_shared_secret` | ```Vec<String>``` | | |
| `message_confidential` | ```String``` | Yes | Optionally specifies a confidential message associated with the request. | | `message_public` | ```String``` | Yes | Optionally specifies a public message associated with the request. |
| `message_private` | ```String``` | Yes | Optionally specifies a private message associated with the request. | | `message_confidential` | ```String``` | Yes | Optionally specifies a confidential message associated with the request. |
| `sp_address_to` | ```String``` | | The service provider address to which the request is directed. | | `message_private` | ```String``` | Yes | Optionally specifies a private message associated with the request. |
| `sp_address_from` | ```String``` | | The service provider address from which the request originates. | | `sp_address_to` | ```String``` | | The service provider address to which the request is directed. |
| `sp_address_reply` | ```String``` | | The service provider address for replies to the request. | | `sp_address_from` | ```String``` | | The service provider address from which the request originates. |
| `timestamp_declared` | ```u64``` | | A Unix timestamp indicating when the request was declared. | | `sp_address_reply` | ```String``` | | The service provider address for replies to the request. |
| `role_name_from` | ```String``` | | The name of the role from which the request originates. | | `timestamp_declared` | ```u64``` | | A Unix timestamp indicating when the request was declared. |
| `role_name_to` | ```String``` | | The name of the role to which the request is directed. | | `role_name_from` | ```String``` | | The name of the role from which the request originates. |
| `payment_method_enc_by_shared_secret` | ```String``` | Yes | Encrypted payment method, encrypted with a shared secret. | | `role_name_to` | ```String``` | | The name of the role to which the request is directed. |
| `deposit_method_enc_by_shared_secret` | ```String``` | Yes | Encrypted deposit method, encrypted with a shared secret. | | `payment_method_enc_by_shared_secret` | ```String``` | Yes | Encrypted payment method, encrypted with a shared secret. |
| `commitment_method_enc_by_shared_secret` | ```String``` | Yes | Encrypted commitment method, encrypted with a shared secret. | | `deposit_method_enc_by_shared_secret` | ```String``` | Yes | Encrypted deposit method, encrypted with a shared secret. |
| `payment_request_pcd_hash_list_enc_by_shared_secret` | ```Vec<String>``` | Yes | A list of hashes for payment-related RequestPcds. | | `commitment_method_enc_by_shared_secret` | ```String``` | Yes | Encrypted commitment method, encrypted with a shared secret. |
| `cap_request_pcd_hash_list_enc_by_shared_secret` | ```Vec<String>``` | Yes | A list of hashes for capability-related RequestPcds. | | `payment_request_pcd_hash_list_enc_by_shared_secret` | ```Vec<String>``` | Yes | A list of hashes for payment-related RequestPcds. |
| `deposit_request_pcd_hash_list_enc_by_shared_secret` | ```Vec<String>``` | Yes | A list of hashes for deposit-related RequestPcds. | | `cap_request_pcd_hash_list_enc_by_shared_secret` | ```Vec<String>``` | Yes | A list of hashes for capability-related RequestPcds. |
| `commitment_request_pcd_hash_list_enc_by_shared_secret` | ```Vec<String>``` | Yes | A list of hashes for commitment-related RequestPcds. | | `deposit_request_pcd_hash_list_enc_by_shared_secret` | ```Vec<String>``` | Yes | A list of hashes for deposit-related RequestPcds. |
| `ask_payment_method_enc_by_shared_secret` | ```String``` | Yes | The requested payment method. | | `commitment_request_pcd_hash_list_enc_by_shared_secret` | ```Vec<String>``` | Yes | A list of hashes for commitment-related RequestPcds. |
| `ask_deposit_method_enc_by_shared_secret` | ```String``` | Yes | The requested deposit method. | | `ask_payment_method_enc_by_shared_secret` | ```String``` | Yes | The requested payment method. |
| `ask_commitment_method_enc_by_shared_secret` | ```String``` | Yes | The requested commitment method. | | `ask_deposit_method_enc_by_shared_secret` | ```String``` | Yes | The requested deposit method. |
| `certif_key_enc_by_shared_secret` | ```String``` | Yes | Encrypted certification key, encrypted with a shared secret. | | `ask_commitment_method_enc_by_shared_secret` | ```String``` | Yes | The requested commitment method. |
| `device_footprint_enc_by_sp_shared_secret` | ```String``` | | The device footprint encrypted by a service provider's shared secret. | | `certif_key_enc_by_shared_secret` | ```String``` | Yes | Encrypted certification key, encrypted with a shared secret. |
| `device_footprint_enc_by_sp_shared_secret` | ```String``` | | The device footprint encrypted by a service provider's shared secret. |
### 11.1. <a name='RequestPrdResponse'></a>RequestPrdResponse ### 11.1. <a name='RequestPrdResponse'></a>RequestPrdResponse