Important! Before you proceed, please read the EUDI Wallet Reference Implementation project description
Flask service that checks the validity of one or more Referenced Tokens against a Token Status List, following draft-ietf-oauth-status-list-10.
Given an index (idx), a status list URI (uri), and a validation_context, the service:
- Fetches the Status List Token JWT from the issuer URI.
- Extracts the
x5ccertificate chain from the JWT header. - Validates the chain via an external trust validator API, scoped by the supplied
validation_context. - Verifies the JWT signature using the leaf certificate's public key.
- Decompresses the
lstfield and reads the bit at positionidx. - Returns whether the token is valid or invalid (revoked).
- Caches the verified Status List in memory (TTL driven by the JWT's
ttl/expclaims).
Multiple checks can also be submitted in a single request via a checks array (batch mode, capped at 100 items (default)), with each item processed independently and returned with its own per-item result.
Refer to the installation guide for setup instructions.
The full API specification, including request/response schemas and interactive testing, is available via Swagger UI.
- Swagger UI: Go to
/swagger-uion your running instance (e.g.,http://localhost:5000/swagger-ui) - OpenAPI Spec: The raw specification can be fetched directly from
/static/swagger.json
The released software is a initial development release version:
- The initial development release is an early endeavor reflecting the efforts of a short timeboxed period, and by no means can be considered as the final product.
- The initial development release may be changed substantially over time, might introduce new features but also may change or remove existing ones, potentially breaking compatibility with your existing code.
- The initial development release is limited in functional scope.
- The initial development release may contain errors or design flaws and other problems that could cause system or other failures and data loss.
- The initial development release has reduced security, privacy, availability, and reliability standards relative to future releases. This could make the software slower, less reliable, or more vulnerable to attacks than mature software.
- The initial development release is not yet comprehensively documented.
- Users of the software must perform sufficient engineering and additional testing in order to properly evaluate their application and determine whether any of the open-sourced components is suitable for use in that application.
- We strongly recommend not putting this version of the software into production use.
- Only the latest version of the software will be supported
We welcome contributions to this project. To ensure that the process is smooth for everyone involved, follow the guidelines found in CONTRIBUTING.md.
Copyright (c) 2023 European Commission
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.