CryptographyClient.VerifyAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| VerifyAsync(SignatureAlgorithm, Byte[], Byte[], CancellationToken) |
Verifies the specified signature. |
| VerifyAsync(MLDsaVerifyOptions, CancellationToken) |
Verifies a signature using a post-quantum ML-DSA (AKP) key. |
VerifyAsync(SignatureAlgorithm, Byte[], Byte[], CancellationToken)
- Source:
- CryptographyClient.cs
- Source:
- CryptographyClient.cs
Verifies the specified signature.
public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.VerifyResult> VerifyAsync(Azure.Security.KeyVault.Keys.Cryptography.SignatureAlgorithm algorithm, byte[] digest, byte[] signature, System.Threading.CancellationToken cancellationToken = default);abstract member VerifyAsync : Azure.Security.KeyVault.Keys.Cryptography.SignatureAlgorithm * byte[] * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.VerifyResult>
override this.VerifyAsync : Azure.Security.KeyVault.Keys.Cryptography.SignatureAlgorithm * byte[] * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.VerifyResult>Public Overridable Function VerifyAsync (algorithm As SignatureAlgorithm, digest As Byte(), signature As Byte(), Optional cancellationToken As CancellationToken = Nothing) As Task(Of VerifyResult)Parameters
- algorithm
- SignatureAlgorithm
The SignatureAlgorithm to use. This must be the same algorithm used to sign the digest.
- digest
- Byte[]
The pre-hashed digest corresponding to the signature. The hash algorithm used to compute the digest must be compatible with the specified algorithm.
- signature
- Byte[]
The signature to verify.
- cancellationToken
- CancellationToken
A CancellationToken to cancel the operation.
Returns
The result of the verify operation. If the signature is valid the IsValid property of the returned VerifyResult will be set to true.
Exceptions
The specified algorithm does not match the key corresponding to the key identifier.
The local cryptographic provider threw an exception.
The key is invalid for the current operation.
The operation is not supported with the specified key.
The server returned an error. See Message for details returned from the server.
Applies to
VerifyAsync(MLDsaVerifyOptions, CancellationToken)
- Source:
- CryptographyClient.cs
Verifies a signature using a post-quantum ML-DSA (AKP) key.
public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.VerifyResult> VerifyAsync(Azure.Security.KeyVault.Keys.Cryptography.MLDsaVerifyOptions options, System.Threading.CancellationToken cancellationToken = default);abstract member VerifyAsync : Azure.Security.KeyVault.Keys.Cryptography.MLDsaVerifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.VerifyResult>
override this.VerifyAsync : Azure.Security.KeyVault.Keys.Cryptography.MLDsaVerifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.VerifyResult>Public Overridable Function VerifyAsync (options As MLDsaVerifyOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of VerifyResult)Parameters
- options
- MLDsaVerifyOptions
The MLDsaVerifyOptions describing the signature to verify, the message or external mu, and any optional context.
- cancellationToken
- CancellationToken
A CancellationToken to cancel the operation.
Returns
The result of the verify operation. If the signature is valid the IsValid property of the returned VerifyResult will be set to true.
Exceptions
options is null.
The client was constructed with a local key and cannot perform this operation.
The server returned an error. See Message for details returned from the server.
Remarks
The algorithm is inferred from the key and is not specified by the caller. This operation is always performed by the vault and is not supported by local-only clients.
