Click or drag to resize
MimeKit

OpenPgpContextSignAsync(PgpSecretKey, DigestAlgorithm, Stream, CancellationToken) Method

Asynchronously sign the content using the specified signer and digest algorithm.

Namespace: MimeKit.Cryptography
Assembly: MimeKit (in MimeKit.dll) Version: 4.12.0
Syntax
C#
Copy
public Task<ApplicationPgpSignature> SignAsync(
	PgpSecretKey signer,
	DigestAlgorithm digestAlgo,
	Stream content,
	CancellationToken cancellationToken = default
)

Parameters

signer  PgpSecretKey
The signer.
digestAlgo  DigestAlgorithm
The digest algorithm to use for signing.
content  Stream
The content.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskApplicationPgpSignature
A new MimePart instance containing the detached signature data.
Exceptions
ExceptionCondition
ArgumentNullException

signer is .

-or-

content is .

ArgumentExceptionsigner cannot be used for signing.
ArgumentOutOfRangeException The digestAlgo was out of range.
NotSupportedException The digestAlgo is not supported.
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.
Remarks
Asynchronously signs the content using the specified signer and digest algorithm.
See Also