Skip to content

Commit

Permalink
feat: update credential_status_validity e credential_status_detail
Browse files Browse the repository at this point in the history
  • Loading branch information
m-basili committed Oct 10, 2024
1 parent 41ef979 commit f759636
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 27 deletions.
6 changes: 0 additions & 6 deletions docs/en/pid-eaa-entity-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,12 +118,6 @@ 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
20 changes: 13 additions & 7 deletions docs/en/revocation-lists.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ The ``revocation_assertion_responses`` object MUST contain the following mandato
- the Revocation Assertions and or the Revocation Assertion Errors related to the request made by the Wallet Instance.
- `OAUTH-STATUS-ASSERTION`_.

The Revocation Assertion object MUST contain the parameter ``credential_status_validity`` with the value set to ``false``.
The Revocation Assertion object MUST contain the parameter ``credential_status_validity`` with the value set to ``1``.
Below a non-normative example of a Revocation Assertion object in JWT format, with the headers and payload represented in JSON and without applying the signature.

.. code::
Expand All @@ -266,7 +266,7 @@ Below a non-normative example of a Revocation Assertion object in JWT format, wi
"jti": "6f204f7e-e453-4dfd-814e-9d155319408c"
"credential_hash": $CREDENTIAL-HASH,
"credential_hash_alg": "sha-256",
"credential_status_validity": false,
"credential_status_validity": 1,
"credential_status_detail": {
"state": "invalid",
"description": "The Credential is no longer usable as it has been revoked. This state is irreversible"
Expand Down Expand Up @@ -411,7 +411,7 @@ A non-normative example of Credential Proof of Possession is provided :ref:`in t
"exp": 1504785536,
"credential_hash": $CREDENTIAL-HASH,
"credential_hash_alg": "sha-256",
"credential_status_validity": true,
"credential_status_validity": 0,
"cnf": {
"jwk": {...}
}
Expand Down Expand Up @@ -650,10 +650,13 @@ When the JWT format is used, the Revocation Assertion MUST contain the following
- Unique identifier for the JWT.
- :rfc:`7519#section-4.1.7`.
* - **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`.
- Numerical value indicating the validity of the Credential linked to the Status Assertion describing its state, mode, condition or stage. It MUST be set with `1` (INVALID status).
- `OAUTH-STATUS-ASSERTION`_.
* - **credential_status_detail**
- Object containing detailed information about the real status of the Credential. It MUST contains ``state`` and related ``description`` parameters that MUST be set with one of the values defined in the *credential_status_detail_supported* mapped in the Credential Issuer metadata.
- Object containing detailed information about the real status of the Credential. IT MUST contains:

- **state**: String value of the Credential status,
- **description**: String containing the description of the Credential status.
- `OAUTH-STATUS-ASSERTION`_.


Expand Down Expand Up @@ -704,10 +707,13 @@ When the JWT format is used, the Status Assertion MUST contain the following cla
- The Algorithm used for hashing the Credential to which the Status Assertion is bound. The value SHOULD be set to ``S256``.
- `OAUTH-STATUS-ASSERTION`_.
* - **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".
- Numerical value indicating the validity of the Credential linked to the Status Assertion describing its state, mode, condition or stage. It MUST be set with values from 0 to 2 with the following meaning: 0-VALID, 1-INVALID, 2-SUSPENDED.
- `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`` parameters that MUST be set with one of the values defined in the *credential_status_detail_supported* mapped in the Credential Issuer metadata.
- REQUIRED if **credential_status_validity** is not set to `0`. Object containing detailed information about the real status of the Credential. IT MUST contains:

- **state**: String value of the Credential status,
- **description**: String containing the description of the Credential status.
- `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.
Expand Down
14 changes: 0 additions & 14 deletions examples/ec-eaa.json
Original file line number Diff line number Diff line change
Expand Up @@ -457,20 +457,6 @@
}
}
},
"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

0 comments on commit f759636

Please sign in to comment.