libsodium.PKI.SigningKey.Export

libsodium.PKI.SigningKey.Export

Method Signatures

 Function Export(Optional Passwd As libsodium.Password) As MemoryBlock
 Function Export(SaveTo As FolderItem, Optional Passwd As libsodium.Password, OverWrite As Boolean = False) As Boolean

Parameters

Export(Password) As MemoryBlock

Name	Type	Comment
Passwd	Password	Optional. A password used to encrypt the exported key

Export(FolderItem, Password, Boolean) As Boolean

Name	Type	Comment
SaveTo	FolderItem	The location to save the exported key to.
Passwd	Password	Optional. A password used to encrypt the exported key
OverWrite	Boolean	Optional. If True, an existing SaveTo file is overwritten.

Return value

Export(Password) As MemoryBlock

The exported key pair.

Export(FolderItem, Password, Boolean) As Boolean

Returns True if the operation succeeded.

Remarks

This method exports the SigningKey in a format that is understood by SigningKey.Import. Pass a Password to encrypt the private half of the key before exporting.

The exported key includes the private half of the key pair. To export only the public half (i.e. share it publicly) create an instance of ForeignKey from your SigningKey, and export the ForeignKey.