libsodium.SKI.SecretStream.Open

libsodium.SKI.SecretStream.Open

Method Signatures

 Shared Function Open(Key As libsodium.SKI.SecretKey, InputStream As Readable, DecryptHeader As FolderItem, HeaderPassword As libsodium.Password = Nil) As libsodium.SKI.SecretStream
 Shared Function Open(Key As libsodium.SKI.SecretKey, InputStream As Readable, DecryptHeader As MemoryBlock, HeaderPassword As libsodium.Password = Nil) As libsodium.SKI.SecretStream
 Shared Function Open(Key As libsodium.PKI.SharedSecret, InputStream As Readable, DecryptHeader As FolderItem, HeaderPassword As libsodium.Password = Nil) As libsodium.SKI.SecretStream
 Shared Function Open(Key As libsodium.PKI.SharedSecret, InputStream As Readable, DecryptHeader As MemoryBlock, HeaderPassword As libsodium.Password = Nil) As libsodium.SKI.SecretStream

Parameters

Name	Type	Comment
Key	SecretKey or SharedSecret	A secret or shared key.
InputStream	Readable	The input stream from which encrypted data will be read.
DecryptHeader	FolderItem or MemoryBlock	The decryption header (initialization vector).
HeaderPassword	Password	Optional. The password to decrypt the exported DecryptHeader.

Return value

An instance of SecretStream, or Nil on error.

Remarks

Creates a SecretStream in decryption mode.