@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/ssi-sdk.oid4vci-issuer-rest-api @sphereon/ssi-sdk.oid4vci-issuer @sphereon/oid4vci-callback-example @sphereon/oid4vci-issuer-server @sphereon/oid4vci-issuer-token-endpoint @sphereon/oid4vci-issuer-rest

0.16.1-feature.SPRIND.116.228

8 months ago

0.16.1-feature.SPRIND.116.229

8 months ago

0.16.1-feature.SPRIND.113.interop.230

7 months ago

0.16.1-feature.SPRIND.116.242

8 months ago

0.16.1-feature.SPRIND.116.240

8 months ago

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

8 months ago

0.16.1-feature.SPRIND.116.239

8 months ago

0.16.1-feature.SPRIND.116.238

8 months ago

0.16.1-fix.230

7 months ago

0.16.1-feature.SPRIND.116.251

6 months ago

0.17.1-feature.esm.cjs.24

3 months ago

0.17.1-feature.esm.cjs.25

3 months ago

0.17.1-feature.esm.cjs.26

3 months ago

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

8 months ago

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

8 months ago

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

8 months ago

0.16.1-fix.234

6 months ago

0.16.1-feature.SPRIND.137.306

6 months ago

0.16.1-feature.SPRIND.137.305

6 months ago

0.16.1-feature.SPRIND.137.308

6 months ago

0.16.1-feature.SPRIND.137.307

6 months ago

0.16.1-feature.IATAB2B.52.350

5 months ago

0.16.1-feature.IATAB2B.52.344

5 months ago

0.16.1-feature.IATAB2B.52.345

5 months ago

0.16.1-feature.IATAB2B.52.343

5 months ago

0.16.1-feature.IATAB2B.52.355

5 months ago

0.17.1-next.39

2 months ago

0.16.1-feature.SPRIND.89.263

6 months ago

0.17.1-next.40

2 months ago

0.16.1-feature.SPRIND.89.262

6 months ago

0.16.1-feature.SPRIND.89.261

6 months ago

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

7 months ago

0.16.1-feature.SPRIND.137.280

6 months ago

0.16.1-feature.SPRIND.116.190

8 months ago

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

7 months ago

0.16.1-feature.SPRIND.137.254

6 months ago

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

8 months ago

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

8 months ago

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

8 months ago

0.16.1-feature.SPRIND.137.269

6 months ago

0.16.1-feature.SPRIND.137.268

6 months ago

0.16.1-feature.SPRIND.137.266

6 months ago

0.16.1-feature.SPRIND.137.236

7 months ago

0.16.1-feature.SPRIND.89.251

6 months ago

0.16.1-feature.SPRIND.89.250

6 months ago

0.16.1-feature.SPRIND.89.256

6 months ago

0.16.1-feature.SPRIND.89.255

6 months ago

0.16.1-feature.SPRIND.137.239

7 months ago

0.16.1-feature.SPRIND.89.254

6 months ago

0.16.1-feature.SPRIND.89.257

6 months ago

0.16.1-feature.VDX.341.dcql.276

6 months ago

0.16.1-feature.VDX.341.dcql.275

6 months ago

0.16.1-feature.VDX.341.dcql.271

6 months ago

0.16.1-feature.SPRIND.137.243

7 months ago

0.16.1-feature.SPRIND.89.241

6 months ago

0.16.1-feature.SPRIND.137.244

7 months ago

0.16.1-feature.SPRIND.89.245

6 months ago

0.16.1-feature.SPRIND.89.244

6 months ago

0.16.1-feature.SPRIND.89.243

6 months ago

0.16.1-feature.SPRIND.89.242

6 months ago

0.16.1-feature.SPRIND.137.248

7 months ago

0.16.1-feature.SPRIND.89.248

6 months ago

0.16.1-feature.SPRIND.89.247

6 months ago

0.16.1-feature.SPRIND.89.246

6 months ago

0.17.0

4 months ago

0.16.1-feature.MWALL.715.352

6 months ago

0.16.1-feature.MWALL.715.350

6 months ago

0.16.1-next.309

6 months ago

0.16.1-feature.MWALL.715.353

6 months ago

0.16.1-feature.MWALL.715.232

7 months ago

0.16.1-feature.MWALL.715.233

7 months ago

0.16.1-feature.SPRIND.89.338

6 months ago

0.18.2

3 months ago

0.16.1-feature.MWALL.715.389

5 months ago

0.16.1-feature.MWALL.715.386

5 months ago

0.16.1-feature.MWALL.715.387

5 months ago

0.16.1-next.401

4 months ago

0.16.1-next.403

4 months ago

0.16.1-next.402

4 months ago

0.16.1-feature.MWALL.715.258

6 months ago

0.16.1-feature.MWALL.715.259

6 months ago

0.16.1-feature.MWALL.715.281

6 months ago

0.16.1-next.356

5 months ago

0.16.1-next.235

6 months ago

0.16.1-feature.MWALL.715.280

6 months ago

0.16.1-next.237

6 months ago

0.16.1-next.231

7 months ago

0.16.1-next.233

7 months ago

0.16.1-feature.MWALL.715.391

5 months ago

0.16.1-next.225

8 months ago

0.16.1-feature.MWALL.715.392

5 months ago

0.16.1-next.224

8 months ago

0.16.1-feature.MWALL.715.390

5 months ago

0.16.1-next.226

8 months ago

0.16.1-feature.MWALL.715.395

5 months ago

0.16.1-next.229

8 months ago

0.16.1-feature.MWALL.715.396

5 months ago

0.16.1-feature.MWALL.715.393

5 months ago

0.16.1-feature.MWALL.715.394

5 months ago

0.16.1-feature.MWALL.715.397

5 months ago

0.16.1-next.341

6 months ago

0.16.1-next.344

5 months ago

0.16.1-next.339

6 months ago

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

5 months ago

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

5 months ago

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

5 months ago

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

5 months ago

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

5 months ago

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

5 months ago

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

5 months ago

0.17.1-feature.esm.cjs.38

3 months ago

0.17.1-feature.esm.cjs.39

3 months ago

0.17.1-feature.esm.cjs.34

3 months ago

0.17.1-feature.esm.cjs.35

3 months ago

0.17.1-feature.esm.cjs.36

3 months ago

0.17.1-feature.esm.cjs.37

3 months ago

0.17.1-feature.esm.cjs.31

3 months ago

0.17.1-feature.esm.cjs.32

3 months ago

0.17.1-feature.esm.cjs.33

3 months ago

0.16.1-fix.189

8 months ago

0.16.1-next.252

6 months ago

0.16.1-feature.IATAB2B.57.cnf.369

5 months ago

0.19.0

2 months ago

0.16.1-feature.IATAB2B.57.cnf.370

5 months ago

0.16.1-feature.IATAB2B.57.cnf.372

5 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

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

5 months ago

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

5 months ago

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

5 months ago

0.16.1-feature.MWALL.715.349

6 months ago

0.16.1-fix.173

9 months ago

0.16.1-next.172

9 months ago

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

9 months ago

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

9 months ago

0.16.1-next.168

9 months ago

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

9 months ago

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

9 months ago

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

9 months ago

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

9 months ago

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

9 months ago

0.16.1-fix.170

9 months ago

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

9 months ago

0.16.1-next.166

9 months ago

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

9 months ago

0.16.1-next.69

9 months ago

0.16.1-feature.from.funke.103

9 months ago

0.16.1-unstable.86

10 months ago

0.16.1-feature.multi.vp.fixes.111

10 months ago

0.16.1-feature.multi.vp.fixes.112

9 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

0.16.1-feature.from.funke.122

9 months ago

10 months ago

9 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

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

10 months ago

0.16.1-feature.jarm.sdk2.68

10 months ago

0.16.1-feature.jarm.sdk.151

9 months ago

0.16.1-feature.jarm.sdk.152

9 months ago

0.16.1-feature.jarm.sdk.146

9 months ago

0.16.1-feature.jarm.sdk.144

9 months ago

0.16.1-feature.jarm.sdk.145

9 months ago

0.16.1-feature.jarm.sdk.148

9 months ago

0.16.1-feature.jarm.sdk.149

9 months ago

0.16.1-feature.jarm.sdk.136

9 months ago

0.16.1-feature.jarm.sdk.137

9 months ago

0.16.1-feature.jarm.sdk.138

9 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months 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

1 year ago

10 months ago

10 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

10 months ago

1 year ago

12 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

1 year ago

10 months ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months 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

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

10 months ago

10 months ago

1 year ago

1 year ago

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

11 months ago

11 months ago

11 months ago

10 months ago

11 months ago

10 months ago

1 year ago

1 year ago

12 months 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

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

1 year ago

1 year ago

1 year ago

1 year ago

11 months ago

1 year ago

1 year ago

1 year ago

11 months ago

1 year ago

1 year ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months 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

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

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

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

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

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

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

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