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.

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

breaking change: added credential_status_detail in the status assertion #432

Merged
merged 7 commits into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
5 changes: 5 additions & 0 deletions docs/en/pid-eaa-entity-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,12 @@ The *openid_credential_issuer* metadata MUST contain the following claims.

- **name**: String value of a display name for the claim.
- **locale**: String value that identifies the language of this object represented as a language tag taken from values defined in *BCP47* :rfc:`5646`. There MUST be only one object for each language identifier.
* - **credential_status_detail_supported**
- JSON object that outlines the details of each validity status supported by the PID/(Q)EAA Provider related to the Credentials issued. It contains ``Display`` array containing a list of states with the corresponding descriptions and language identifiers. The parameter that MUST be included are:

- **state**: String value of a Credential status supported.
- **description**: String containing the description of the status related to this object.
- **locale**: String value that identifies the language of this object represented as a language tag taken from values defined in *BCP47* :rfc:`5646`. There MUST be only one object for each language identifier.
* - **jwks**
- JSON Web Key Set document, passed by value, containing the protocol specific keys for the Credential Issuer. See `OID-FED`_ Section 5.2.1 and `JWK`_.

Expand Down
10 changes: 10 additions & 0 deletions docs/en/revocation-lists.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,10 @@ Below a non-normative example of a Revocation Assertion object in JWT format, wi
"credential_hash": $CREDENTIAL-HASH,
"credential_hash_alg": "sha-256",
"credential_status_validity": false,
"credential_status_detail": {
"state": "invalid",
"description": "The Credential is no longer usable as it has been revoked. This state is irreversible"
},
"cnf": {
"jwk": {
"kty": "EC",
Expand Down Expand Up @@ -648,6 +652,9 @@ When the JWT format is used, the Revocation Assertion MUST contain the following
* - **credential_status_validity**
- Boolean value indicating the absolute validity of the Credential linked to the Status Assertion. It MUST be set with the value `false`.
- `OAUTH-STATUS-ASSERTION`_.
* - **credential_status_detail**
- Object containing detailed information about the real status of the Credential. It MUST contains ``state`` and related ``description`` claims that MUST be set with one of the values defined in the *credential_status_detail_supported* mapped in the Credential Issuer Metadata.
m-basili marked this conversation as resolved.
Show resolved Hide resolved
- `OAUTH-STATUS-ASSERTION`_.


Status Assertion
Expand Down Expand Up @@ -699,6 +706,9 @@ When the JWT format is used, the Status Assertion MUST contain the following cla
* - **credential_status_validity**
- Boolean value indicating the absolute validity of the Credential linked to the Status Assertion. It is REQUIRED and it MUST be set with the value "false" or "true".
- `OAUTH-STATUS-ASSERTION`_.
* - **credential_status_detail**
- REQUIRED if **credential_status_validity** is set to `false`. Object containing detailed information about the real status of the Credential. IT MUST contains ``state`` and related ``description`` claims that MUST be set with one of the values defined in the *credential_status_detail_supported* mapped in the Credential Issuer Metadata.
m-basili marked this conversation as resolved.
Show resolved Hide resolved
- `OAUTH-STATUS-ASSERTION`_.
* - **cnf**
- JSON object containing confirmation methods. The sub-member contained within `cnf` member, such as `jwk` for JWT, MUST match with the one provided within the related Digital Credential. Other confirmation methods can be utilized when the referenced Digital Credential supports them, in accordance with the relevant standards.
- `[RFC7800, Section 3.1] <https://www.iana.org/go/rfc7800>`_ and `[RFC8747, Section 3.1] <https://www.iana.org/go/rfc7800>`_.
Expand Down
14 changes: 14 additions & 0 deletions examples/ec-eaa.json
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,20 @@
}
}
},
"credential_status_detail_supported": {
"display": [
{
"state": "Invalida",
"description": "La Credenziale non è più utilizzabile in quanto è stata revocata. Questo stato è irreversibile",
"locale": "it-IT"
},
{
"state": "Invalid",
"description": "The Credential is no longer usable as it has been revoked. This state is irreversible",
"locale": "en-US"
}
]
},
"jwks": {
"keys": [
{
Expand Down
Loading