Skip to content

Files

Latest commit

2165b37 · Jan 29, 2025

History

History

siopv2-oid4vp-rp-rest-api

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Oct 4, 2024
Jan 27, 2025
Dec 5, 2024
May 29, 2024
Apr 13, 2023
Apr 13, 2023
Apr 13, 2023
Jan 29, 2025
Jan 24, 2025
Jun 13, 2024


Sphereon
SIOPv2 and OpenID4VP Relying Party REST endpoints


Warning: This package still is in very early development. Breaking changes without notice will happen at this point!


An authentication plugin using the Self Issued OpenID Provider v2 (SIOP) authentication library for having Relying Parties conforming to the Self Issued OpenID Provider v2 (SIOPv2) and OpenID Connect for Verifiable Presentations (OIDC4VP) as specified in the OpenID Connect working group.

Self Issued OpenID Provider v2 (SIOPv2)

For more information about Self Issued OpenID Provider v2 (SIOP), see the documentation in the readme.

Requirements

For this plugin a DID resolver is also required. A DID resolver can be added to the agent as plugin as seen in the example below.

Available functions

Usage

Adding the plugin to an agent:

import { IDidAuthSiopOpAuthenticator } from '@sphereon/ssi-sdk-did-auth-siop-authenticator'
import { Resolver } from 'did-resolver'
import { getDidKeyResolver } from '@veramo/did-provider-key'
import { DIDResolverPlugin } from '@veramo/did-resolver'
import { getUniResolver } from '@sphereon/did-uni-client'

const agent = createAgent<IDidAuthSiopOpAuthenticator & IResolver>({
  plugins: [
    new DidAuthSiopOpAuthenticator(),
    new DIDResolverPlugin({
      resolver: new Resolver({
        ...getDidKeyResolver(),
        ...getUniResolver('web'),
        ...getUniResolver('jwk'),
      }),
    }),
  ],
})

Installation

yarn add @sphereon/ssi-sdk-siopv2-openid4vp-rp

Build

yarn build