Show/Hide TOC

OpenPgpContextDecryptToAsync Method

Asynchronously decrypt an encrypted stream and extract the digital signers if the content was also signed.

Definition

Namespace: MimeKit.Cryptography
Assembly: MimeKit.Cryptography (in MimeKit.Cryptography.dll) Version: 5.0.0

C#

public Task<DigitalSignatureCollection?> DecryptToAsync(
	Stream encryptedData,
	Stream decryptedData,
	CancellationToken cancellationToken = default
)

Parameters

encryptedData Stream: The encrypted data.
decryptedData Stream: The stream to write the decrypted data to.
cancellationToken CancellationToken (Optional): The cancellation token.

Return Value

TaskDigitalSignatureCollection
The list of digital signatures if the data was both signed and encrypted; otherwise, .

Remarks

Decrypts an encrypted stream and extracts the digital signers if the content was also signed.

Output must not be used until this method completes successfully. If integrity validation fails, an exception is thrown, but unauthenticated data may already have been written to the output. Unprotected legacy messages are rejected unless AllowUnauthenticatedDecryption is enabled.

If any of the signatures were made with an unrecognized key and AutoKeyRetrieve is enabled, an attempt will be made to retrieve said key(s). The cancellationToken can be used to cancel key retrieval.

Exceptions

ArgumentNullException	encryptedData is . -or- decryptedData is .
PrivateKeyNotFoundException	The private key could not be found to decrypt the stream.
OperationCanceledException	The user chose to cancel the password prompt. -or- The operation was canceled via the cancellation token.
UnauthorizedAccessException	3 bad attempts were made to unlock the secret key.
PgpException	An OpenPGP error occurred.