Skip to main content

Python toolchain for building an OpenID4VP RP with a SATOSA backend compliant to the Italian Wallet Solution.

Project description

eudi-wallet-it-python

CI build Python version py-versions GitHub issues Get invited Join the #spid openid

The EUDI Wallet Python toolchain is a suite of Python libraries designed to make it easy the implementation of an EUDI Wallet Relying Party according to the Italian Wallet implementation profile.

The toolchain contains the following components:

Name Description
jwk JSON Web Key (JWK) according to RFC7517.
jwt Signed and encrypted JSON Web Token (JWT) according to RFC7519, RFC7515 and RFC7516
tools.qrcode QRCodes creation
oauth2.dpop Tools for issuing and parsing DPoP artifacts, according to OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)
federation Trust evaluation mechanisms, according to OpenID Connect Federation 1.0
trust Helper classes to handle both X.509 and OIDC Federation trust evaluation mechanisms
satosa.backend SATOSA Relying Party backend, according to OpenID for Verifiable Presentations
openid4vp Classes and schemas related to OpenID for Verifiable Presentations
presentation_exchange Resources related to DiF Presentation Exchange
sd_jwt Issuance and verification of SD-JWT according to Selective Disclosure for JWTs (SD-JWT)

Setup

Install enviroment and dependencies

sudo apt install python3-dev python3-pip git
sudo python3 -m pip install --upgrade pip
sudo python3 -m pip install virtualenv

Activate the environment. It's optional and up to you if you want to install in a separate env or system wide

virtualenv -p python3 env
source env/bin/activate

Install using pip:

pip install pyeudiw or pip install pyeudiw[satosa] for the satosa backend.

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:

  • Wordpress with SAML2 support and Bootstrap Italia template preregistered to the IAM Proxy.
  • Satosa-Saml2Spid IAM Proxy with a preconfigured OpenID4VP backend.

Please read this README to get a fully working Wordpress setup with SAML2 support.

SatoSa configuration

SaToSa is a general purpose IAM proxy solution that allows interoperability between different entities that implements different authentication protocols such as SAML2, OpenID Connect and OAuth2. This project offers a SaToSa backend to enable the OpenID4VP protocol.

Please read this README any details about how to configure SaToSa with the OpenID4VP Relying Party backend.

Contribute

Your contribution is welcome, no question is useless and no answer is obvious, we need you.

Contribute as end user

Please open an issue if you've found a bug or if you want to ask some features.

Contribute as developer

Please open your Pull Requests on the dev branch. Please consider the following branches:

  • main: where we merge the code before tag a new stable release.
  • dev: where we push our code during development.
  • other-custom-name: where a new feature/contribution/bugfix will be handled, revisioned and then merged to dev branch.

Authors

  • Giuseppe De Marco
  • Pasquale De Rose
  • Alessio Murru
  • Salvatore Laiso
  • Nicola Saitto

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyeudiw-0.7.0.tar.gz (74.8 kB view details)

Uploaded Source

Built Distribution

pyeudiw-0.7.0-py3-none-any.whl (100.4 kB view details)

Uploaded Python 3

File details

Details for the file pyeudiw-0.7.0.tar.gz.

File metadata

  • Download URL: pyeudiw-0.7.0.tar.gz
  • Upload date:
  • Size: 74.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for pyeudiw-0.7.0.tar.gz
Algorithm Hash digest
SHA256 67e099794124be52f857af75a7ca11bef1c5dfc6c5851263abdce5370b29912b
MD5 c753dbce4ebf09801587ade0fd8cfeae
BLAKE2b-256 44bf8404d71f8da9d1f382f90aed3befbf1c11d468003a05d5097f2a11b32ef7

See more details on using hashes here.

File details

Details for the file pyeudiw-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: pyeudiw-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 100.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for pyeudiw-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae8975dddb4a3bbd09d4498f4ba3d148076a92e106e3af69dba887f4c060f6e7
MD5 289855b5072dcea6d577369a7dd660e1
BLAKE2b-256 c320dac0b995919ddfafc70b635ec342a055aa0456a18adfa29368796f207ec8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page