siopv2-oid4vp-rp-auth

SIOPv2 and OpenID4VP Relying Party

---

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