@sphereon/oid4vci-issuer NPM

IMPORTANT the packages are in an early development stage and currently only supports the pre-authorized code flow of OpenID4VCI! Work is underway for the Authorized Flows as well, but not fully supported yet

Background

The OpenID4VCI issuer is used in issuer type applications, where an organization is issuing the credential(s)

Credential Offer State Manager

The CredentialOfferState is used to track of the creation date of the credential offer:

export interface CredentialOfferState {
  credentialOffer: CredentialOfferPayloadV1_0_11
  createdOn: number
}

The ICredentialOfferStateManager allows to have a custom implementation of the state manager:

export interface ICredentialOfferStateManager {
  setState(state: string, payload: CredentialOfferState): Promise<Map<string, CredentialOfferState>>

  getState(state: string): Promise<CredentialOfferState | undefined>

  hasState(state: string): Promise<boolean>

  deleteState(state: string): Promise<boolean>

  clearExpiredStates(timestamp?: number): Promise<void> // clears all expired states compared against timestamp if provided, otherwise current timestamp

  clearAllStates(): Promise<void> // clears all states
}

Here is an example, an in-memory implementation of the ICredentialOfferStateManager

export class MemoryCredentialOfferStateManager implements ICredentialOfferStateManager {
  private readonly credentialOfferStateManager: Map<string, CredentialOfferState>
  constructor() {
    this.credentialOfferStateManager = new Map()
  }

  async clearAllStates(): Promise<void> {
    this.credentialOfferStateManager.clear()
  }

  async clearExpiredStates(timestamp?: number): Promise<void> {
    const states = Array.from(this.credentialOfferStateManager.entries())
    timestamp = timestamp ?? +new Date()
    for (const [issuerState, state] of states) {
      if (state.createdOn < timestamp) {
        this.credentialOfferStateManager.delete(issuerState)
      }
    }
  }

  async deleteState(state: string): Promise<boolean> {
    return this.credentialOfferStateManager.delete(state)
  }

  async getState(state: string): Promise<CredentialOfferState | undefined> {
    return this.credentialOfferStateManager.get(state)
  }

  async hasState(state: string): Promise<boolean> {
    return this.credentialOfferStateManager.has(state)
  }

  async setState(state: string, payload: CredentialOfferState): Promise<Map<string, CredentialOfferState>> {
    return this.credentialOfferStateManager.set(state, payload)
  }
}

Usage

Pass an instance of the state manager to the VC Issuer Builder

const vcIssuer = new VcIssuerBuilder()
  .withAuthorizationServer('https://authorization-server')
  .withCredentialEndpoint('https://credential-endpoint')
  .withCredentialIssuer('https://credential-issuer')
  .withIssuerDisplay({
    name: 'example issuer',
    locale: 'en-US',
  })
  .withCredentialsSupported(credentialsSupported)
  .withInMemoryCredentialOfferStates(new MemoryCredentialOfferStateManager())
  .build()

Sphereon Verifiable Credentials OpenID OpenID for Verifiable Credential Issuance OAuth2 SSI OpenID4VCI OIDC4VCI OID4VCI

@sphereon/oid4vc-common @sphereon/oid4vci-common @sphereon/ssi-express-support @sphereon/ssi-types short-uuid uuid

@everything-registry/sub-chunk-857 @credo-ts/openid4vc @gaia-x/oidc4vc @sphereon/oid4vci-callback-example @sphereon/ssi-sdk.oid4vci-issuer-rest-api @sphereon/ssi-sdk.oid4vci-issuer @sphereon/oid4vci-issuer-server @sphereon/oid4vci-issuer-token-endpoint @sphereon/oid4vci-issuer-rest

0.16.1-feature.SPRIND.116.228

1 year ago

0.16.1-feature.SPRIND.116.229

1 year ago

0.16.1-feature.SPRIND.113.interop.230

1 year ago

0.16.1-feature.SPRIND.116.242

1 year ago

0.16.1-feature.SPRIND.116.240

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.217

1 year ago

0.16.1-feature.SPRIND.116.239

1 year ago

0.16.1-feature.SPRIND.116.238

1 year ago

0.16.1-fix.230

1 year ago

0.16.1-feature.SPRIND.116.251

12 months ago

0.17.1-feature.esm.cjs.24

9 months ago

0.17.1-feature.esm.cjs.25

9 months ago

0.17.1-feature.esm.cjs.26

9 months ago

0.16.1-feature.SDK.39.well.known.oidf.221

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.222

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.223

1 year ago

0.16.1-fix.234

12 months ago

0.16.1-feature.SPRIND.137.306

12 months ago

0.16.1-feature.SPRIND.137.305

12 months ago

0.16.1-feature.SPRIND.137.308

12 months ago

0.16.1-feature.SPRIND.137.307

12 months ago

0.16.1-feature.IATAB2B.52.350

11 months ago

0.16.1-feature.IATAB2B.52.344

11 months ago

0.16.1-feature.IATAB2B.52.345

11 months ago

0.16.1-feature.IATAB2B.52.343

11 months ago

0.16.1-feature.IATAB2B.52.355

11 months ago

0.17.1-next.39

8 months ago

0.16.1-feature.SPRIND.89.263

12 months ago

0.17.1-next.40

8 months ago

0.16.1-feature.SPRIND.89.262

12 months ago

0.16.1-feature.SPRIND.89.261

12 months ago

0.16.1-feature.SPRIND.137.plus.fixes.245

1 year ago

0.16.1-feature.SPRIND.137.280

12 months ago

0.16.1-feature.SPRIND.116.190

1 year ago

0.16.1-feature.MWALL.717.jwt.decode.crash.230

1 year ago

0.16.1-feature.SPRIND.137.254

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.187

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.188

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.189

1 year ago

0.16.1-feature.SPRIND.137.269

12 months ago

0.16.1-feature.SPRIND.137.268

12 months ago

0.16.1-feature.SPRIND.137.266

1 year ago

0.16.1-feature.SPRIND.137.236

1 year ago

0.16.1-feature.SPRIND.89.251

12 months ago

0.16.1-feature.SPRIND.89.250

12 months ago

0.16.1-feature.SPRIND.89.256

12 months ago

0.16.1-feature.SPRIND.89.255

12 months ago

0.16.1-feature.SPRIND.137.239

1 year ago

0.16.1-feature.SPRIND.89.254

12 months ago

0.16.1-feature.SPRIND.89.257

12 months ago

0.16.1-feature.VDX.341.dcql.276

12 months ago

0.16.1-feature.VDX.341.dcql.275

12 months ago

0.16.1-feature.VDX.341.dcql.271

12 months ago

0.16.1-feature.SPRIND.137.243

1 year ago

0.16.1-feature.SPRIND.89.241

1 year ago

0.16.1-feature.SPRIND.137.244

1 year ago

0.16.1-feature.SPRIND.89.245

12 months ago

0.16.1-feature.SPRIND.89.244

12 months ago

0.16.1-feature.SPRIND.89.243

12 months ago

0.16.1-feature.SPRIND.89.242

12 months ago

0.16.1-feature.SPRIND.137.248

1 year ago

0.16.1-feature.SPRIND.89.248

12 months ago

0.16.1-feature.SPRIND.89.247

12 months ago

0.16.1-feature.SPRIND.89.246

12 months ago

0.17.0

10 months ago

0.16.1-feature.MWALL.715.352

12 months ago

0.16.1-feature.MWALL.715.350

12 months ago

0.16.1-next.309

12 months ago

0.16.1-feature.MWALL.715.353

12 months ago

0.16.1-feature.MWALL.715.232

1 year ago

0.16.1-feature.MWALL.715.233

1 year ago

0.16.1-feature.SPRIND.89.338

12 months ago

0.18.2

9 months ago

0.16.1-feature.MWALL.715.389

11 months ago

0.16.1-feature.MWALL.715.386

11 months ago

0.16.1-feature.MWALL.715.387

11 months ago

0.16.1-next.401

10 months ago

0.16.1-next.403

10 months ago

0.16.1-next.402

10 months ago

0.16.1-feature.MWALL.715.258

1 year ago

0.16.1-feature.MWALL.715.259

1 year ago

0.16.1-feature.MWALL.715.281

12 months ago

0.16.1-next.356

11 months ago

0.16.1-next.235

1 year ago

0.16.1-feature.MWALL.715.280

12 months ago

0.16.1-next.237

12 months ago

0.16.1-next.231

1 year ago

0.16.1-next.233

1 year ago

0.16.1-feature.MWALL.715.391

11 months ago

0.16.1-next.225

1 year ago

0.16.1-feature.MWALL.715.392

11 months ago

0.16.1-next.224

1 year ago

0.16.1-feature.MWALL.715.390

11 months ago

0.16.1-next.226

1 year ago

0.16.1-feature.MWALL.715.395

11 months ago

0.16.1-next.229

1 year ago

0.16.1-feature.MWALL.715.396

11 months ago

0.16.1-feature.MWALL.715.393

11 months ago

0.16.1-feature.MWALL.715.394

11 months ago

0.16.1-feature.MWALL.715.397

11 months ago

0.16.1-next.341

12 months ago

0.16.1-next.344

11 months ago

0.16.1-next.339

12 months ago

0.16.1-feature.SSISDK.5.credential.offer.uri.360

11 months ago

0.16.1-feature.SSISDK.5.credential.offer.uri.363

11 months ago

0.16.1-feature.SSISDK.5.credential.offer.uri.364

11 months ago

0.16.1-feature.SSISDK.5.credential.offer.uri.365

11 months ago

0.16.1-feature.SSISDK.5.credential.offer.uri.366

11 months ago

0.16.1-feature.SSISDK.5.credential.offer.uri.358

11 months ago

0.16.1-feature.SSISDK.5.credential.offer.uri.359

11 months ago

0.17.1-feature.esm.cjs.38

9 months ago

0.17.1-feature.esm.cjs.39

9 months ago

0.17.1-feature.esm.cjs.34

9 months ago

0.17.1-feature.esm.cjs.35

9 months ago

0.17.1-feature.esm.cjs.36

9 months ago

0.17.1-feature.esm.cjs.37

9 months ago

0.17.1-feature.esm.cjs.31

9 months ago

0.17.1-feature.esm.cjs.32

9 months ago

0.17.1-feature.esm.cjs.33

9 months ago

0.16.1-fix.189

1 year ago

0.16.1-next.252

12 months ago

0.16.1-feature.IATAB2B.57.cnf.369

11 months ago

0.19.0

8 months ago

0.16.1-feature.IATAB2B.57.cnf.370

11 months ago

0.16.1-feature.IATAB2B.57.cnf.372

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.16.1-feature.SSISDK.5.credential.offer.uri.367

11 months ago

0.16.1-feature.SSISDK.5.credential.offer.uri.368

11 months ago

0.16.1-feature.SSISDK.5.credential.offer.uri.369

11 months ago

0.16.1-feature.MWALL.715.349

12 months ago

0.16.1-fix.173

1 year ago

0.16.1-next.172

1 year ago

0.16.1-feature.sdk.38.rfc8414.auth.server.metadata.177

1 year ago

0.16.1-feature.sdk.38.rfc8414.auth.server.metadata.172

1 year ago

0.16.1-next.168

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.176

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.178

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.173

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.174

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.175

1 year ago

0.16.1-fix.170

1 year ago

0.16.1-feature.SDK.39.well.known.oidf.180

1 year ago

0.16.1-next.166

1 year ago

0.16.1-feature.sdk.38.rfc8414.auth.server.metadata.161

1 year ago

0.16.1-next.69

1 year ago

0.16.1-feature.from.funke.103

1 year ago

0.16.1-unstable.86

1 year ago

0.16.1-feature.multi.vp.fixes.111

1 year ago

0.16.1-feature.multi.vp.fixes.112

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.16.1-feature.from.funke.122

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.16.1-feature.SDK.35.redirect.uri.102

1 year ago

0.16.1-feature.jarm.sdk2.68

1 year ago

0.16.1-feature.jarm.sdk.151

1 year ago

0.16.1-feature.jarm.sdk.152

1 year ago

0.16.1-feature.jarm.sdk.146

1 year ago

0.16.1-feature.jarm.sdk.144

1 year ago

0.16.1-feature.jarm.sdk.145

1 year ago

0.16.1-feature.jarm.sdk.148

1 year ago

0.16.1-feature.jarm.sdk.149

1 year ago

0.16.1-feature.jarm.sdk.136

1 year ago

0.16.1-feature.jarm.sdk.137

1 year ago

0.16.1-feature.jarm.sdk.138

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

1 year ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

1 year ago

2 years ago

2 years ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago