From 907bbadc39c9a7b2a3f0fd736188880afb5c95c7 Mon Sep 17 00:00:00 2001 From: Phil Schneider Date: Mon, 29 Jul 2024 17:35:33 +0200 Subject: [PATCH] docs: add documentation for initial credential creation (#221) Co-authored-by: Evelyn Gurschler Reviewed-by: Evelyn Gurschler Refs: #206 --- charts/ssi-credential-issuer/README.md | 4 +- charts/ssi-credential-issuer/README.md.gotmpl | 4 +- .../initial-credential-setup.md | 60 +++++++++++++++++++ 3 files changed, 66 insertions(+), 2 deletions(-) create mode 100644 docs/technical-documentation/operator-credential-creation/initial-credential-setup.md diff --git a/charts/ssi-credential-issuer/README.md b/charts/ssi-credential-issuer/README.md index fffb6455..b0e34599 100644 --- a/charts/ssi-credential-issuer/README.md +++ b/charts/ssi-credential-issuer/README.md @@ -2,7 +2,9 @@ This helm chart installs the Catena-X SSI Credential Issuer application. -For further information please refer to [Technical Documentation](./docs/technical-documentation). +For further information please refer to [Technical Documentation](/docs/technical-documentation). + +For information about the initial credential creation for the Operator, please refer to [initial credential setup](/docs/technical-documentation/operator-credential-creation/initial-credential-setup.md) The referenced container images are for demonstration purposes only. diff --git a/charts/ssi-credential-issuer/README.md.gotmpl b/charts/ssi-credential-issuer/README.md.gotmpl index e352f42b..f30c4b50 100644 --- a/charts/ssi-credential-issuer/README.md.gotmpl +++ b/charts/ssi-credential-issuer/README.md.gotmpl @@ -2,7 +2,9 @@ This helm chart installs the Catena-X SSI Credential Issuer application. -For further information please refer to [Technical Documentation](./docs/technical-documentation). +For further information please refer to [Technical Documentation](/docs/technical-documentation). + +For information about the initial credential creation for the Operator, please refer to [initial credential setup](/docs/technical-documentation/operator-credential-creation/initial-credential-setup.md) The referenced container images are for demonstration purposes only. diff --git a/docs/technical-documentation/operator-credential-creation/initial-credential-setup.md b/docs/technical-documentation/operator-credential-creation/initial-credential-setup.md new file mode 100644 index 00000000..f99fa604 --- /dev/null +++ b/docs/technical-documentation/operator-credential-creation/initial-credential-setup.md @@ -0,0 +1,60 @@ +# Initial Credential Setup + +After the initial wallet creation which is executed by the portal the process will create the bpn and membership credential. + +The portal will request a bpn credential via the endpoint `POST: api/issuer/bpn` which will create a process and a process step. The process will currently fail at step 4 since the issuer wallet is the same as the holder wallet. This will be fixed in the future. For now you can execute the following query to resolve the issue + +```sql + +SELECT process_id +FROM issuer.company_ssi_details +where bpnl = 'operator bpn' +and verified_credential_type_id = 7 + +``` + +take the process id and insert it into the following query + +```sql + +UPDATE issuer.process_steps +SET process_step_status_id=2 +WHERE process_step_type_id = 4 and process_step_status_id = 4; + +INSERT INTO issuer.process_steps(id, process_step_type_id, process_step_status_id, process_id, date_created, date_last_changed, message) +VALUES ('8ddd7518-4532-409e-920a-c2b5029408a7', 5, 1, 'your process id', now(), null, null); + +``` + +After that the issuer component will do the callback to the portal with the successfully created bpn credential. The portal will than request the creation of the membership credential via `POST: api/issuer/membership`. The same as for the bpn credential applies for the membership credential. The error can be fixed with the following queries + +```sql + +SELECT process_id +FROM issuer.company_ssi_details +where bpnl = 'operator bpn' +and verified_credential_type_id = 4 + +``` + +take the process id and insert it into the following query + +```sql + +UPDATE issuer.process_steps +SET process_step_status_id=2 +WHERE process_step_type_id = 4 and process_step_status_id = 4; + +INSERT INTO issuer.process_steps(id, process_step_type_id, process_step_status_id, process_id, date_created, date_last_changed, message) +VALUES ('8ddd7518-4532-409e-920a-c2b5029408a7', 5, 1, 'your process id', now(), null, null); + +``` + +**Warning**: Currently the application of the wallet must be set to `catena-x-portal`. This value is not configurable and must be existing in the wallet (see [#226](https://github.com/eclipse-tractusx/ssi-credential-issuer/issues/226)). +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/ssi-credential-issuer \ No newline at end of file