Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): adds more information on MIW credential module #576

Merged
merged 1 commit into from
Jul 6, 2023
Merged

feat(docs): adds more information on MIW credential module #576

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions edc-extensions/ssi/ssi-miw-credential-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ just call the MIW for checking that the token and the VP claim inside are correc

For obtaining a `JWT` token also it reaches the MIW, that will create a token with the `VP` claim inside.

This module also contains two additional validation rules of VP/VC on the provider side.

- `SsiCredentialIssuerValidationRule` checks if the issuer of the Verifiable Credential matches `tx.ssi.miw.authority.issuer`
- `SsiCredentialSubjectIdValidationRule` checks if the issuer of the JWT/VP matches the credential subject id in the Verifiable Credential

## Configuration

| Key | Required | Example | Description |
Expand All @@ -23,3 +28,7 @@ For obtaining a `JWT` token also it reaches the MIW, that will create a token wi
| tx.ssi.oauth.client.secret.alias | X | | Vault alias for the client secret |

By default, the `tx.ssi.miw.authority.issuer` is composed with `did:web:<tx.ssi.miw.url>:<tx.ssi.miw.authority.id>

Another mandatory settings is `tx.ssi.endpoint.audience` which is described [here](../ssi-identity-core/README.md)

> Note: the `edc.participant.id` should match the BPN number contained in the OAuth2/Keycloak token and the one assigned by the portal to the user's organization.