VirgilPrivateKeyExporter | virgil-crypto

Class implementing operations required to convert between raw private key material and private key objects and vice versa (i.e. the IPrivateKeyExporter interface from virgil-sdk), using VirgilCrypto.

Hierarchy

VirgilPrivateKeyExporter

Index

Constructors

constructor

Properties

password

Methods

Constructors

constructor

new VirgilPrivateKeyExporter(virgilCrypto: VirgilCrypto, password?: undefined | string): VirgilPrivateKeyExporter

- Defined in VirgilPrivateKeyExporter.ts:11
Initializes the new VirgilPrivateKeyExporter

Parameters
- virgilCrypto: VirgilCrypto
  
  VirgilCrypto instance, providing implementation of crypto operations.
- Optional password: undefined | string
Returns VirgilPrivateKeyExporter

Properties

Optional password

password: undefined | string

Methods

exportPrivateKey

exportPrivateKey(key: IPrivateKey): Buffer

- Defined in VirgilPrivateKeyExporter.ts:32
Exports private key material in DER format from the given private key object.

Parameters
- key: IPrivateKey
  
  The private key object to export the key material from.
Returns Buffer
- The private key material in DER format.

importPrivateKey

importPrivateKey(keyData: Buffer | string): VirgilPrivateKey

- Defined in VirgilPrivateKeyExporter.ts:43
Creates a VirgilPrivateKey object from private key material in PEM or DER format.

Parameters
- keyData: Buffer | string
  
  The private key material. If keyData is a string, base64 encoding is assumed.
Returns VirgilPrivateKey

The private key object.