Interface HSMSignerFactory

Factory to create HSM Signers.

interface HSMSignerFactory {
dispose(): void;
newSigner(hsmSignerOptions: HSMSignerOptions): HSMSigner;
}

Index

Methods

dispose newSigner

Methods

dispose

dispose(): void
Dispose of the factory when it, and any HSM signers created by it, are no longer required.

Returns void
- Defined in src/identity/hsmsigner.ts:64

newSigner

newSigner(hsmSignerOptions: HSMSignerOptions): HSMSigner
Create a new HSM signing implementation based on provided HSM options.

This returns an object with two properties:
1. the signer function.
2. a close function to be called when the signer is no longer required.
Parameters
- hsmSignerOptions: HSMSignerOptions
  The HSM signer options.
Returns HSMSigner
an HSM Signer implementation.
- Defined in src/identity/hsmsigner.ts:59