Skip to content

Commit

Permalink
chore: README usage section
Browse files Browse the repository at this point in the history
  • Loading branch information
peppelinux committed Aug 24, 2023
1 parent 36da062 commit f3af83e
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 5 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,24 @@ Install using github:
`pip install git+https://github.com/italia/eudi-wallet-it-python`


## Usage

TBD. Here a section that points to the documentation of each single package and some common example about their usage for some specific tasks.

| Name | Description |
| :--- | --- |
| __jwk__ | link to the API documentation [](). |
| __jwt__ | link to the API documentation [](). |
| __tools.qrcode__ | QRCodes creation. |
| __oauth2.dpop__ | link to the API documentation [](). |
| __federation__ | link to the API documentation [](). |
| __trust__ | link to the API documentation [](). |
| __satosa.backend__ | link to the API documentation [](). |
| __openid4vp__ | link to the API documentation [](). |
| __presentation_exchange__ | link to the API documentation [](). |
| __sd_jwt__ | link to the API documentation [](). |


## Example project

The example project is a docker-compose that runs a demo composed by the following component:
Expand All @@ -61,6 +79,7 @@ The example project is a docker-compose that runs a demo composed by the followi

Please read [this README](example/README.md) to get a fully working demo setup.


## SatoSa configuration

[SaToSa](https://github.com/IdentityPython/SATOSA) is a general purpose IAM
Expand All @@ -70,9 +89,6 @@ backend to enable the OpenID4VP protocol.

Please read [README-SATOSA.md](README-SATOSA.md) for details.

## API

TBD. Here a section that points to the documentation of each single package and some common example about their usage for some specific tasks.

## Contribute

Expand Down
2 changes: 1 addition & 1 deletion pyeudiw/federation/statements.py
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ def validate_descendant_statement(self, jwt: str) -> bool:
if header.get("kid") not in self.kids:
raise UnknownKid(
f"{self.header.get('kid')} not found in {self.jwks}")

# verify signature
jwsh = JWSHelper(self.jwks[self.kids.index(header["kid"])])
payload = jwsh.verify(jwt)
Expand Down
1 change: 0 additions & 1 deletion pyeudiw/tools/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,3 @@ def get_jwks(httpc_params: dict, metadata: dict, federation_jwks: list = []) ->

def random_token(n=254):
return token_hex(n)

0 comments on commit f3af83e

Please sign in to comment.