AttestationToken.ValidateTokenAsync Method

Reference

Definition

Namespace:: Azure.Security.Attestation

Assembly:: Azure.Security.Attestation.dll

Package:: Azure.Security.Attestation v1.0.0

Source:: AttestationToken.cs

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.

Validate a JSON Web Token returned by the MAA.

If the caller provides a set of signers, than that set of signers will be used as the complete set of candidates for signing. If the caller does not provide a set of signers, then the ValidateTokenAsync(AttestationTokenValidationOptions, IReadOnlyList<AttestationSigner>, CancellationToken) API will a set of callers derived from the contents of the attestation token.

public virtual System.Threading.Tasks.Task<bool> ValidateTokenAsync (Azure.Security.Attestation.AttestationTokenValidationOptions options, System.Collections.Generic.IReadOnlyList<Azure.Security.Attestation.AttestationSigner> attestationSigningCertificates, System.Threading.CancellationToken cancellationToken = default);

abstract member ValidateTokenAsync : Azure.Security.Attestation.AttestationTokenValidationOptions * System.Collections.Generic.IReadOnlyList<Azure.Security.Attestation.AttestationSigner> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
override this.ValidateTokenAsync : Azure.Security.Attestation.AttestationTokenValidationOptions * System.Collections.Generic.IReadOnlyList<Azure.Security.Attestation.AttestationSigner> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Public Overridable Function ValidateTokenAsync (options As AttestationTokenValidationOptions, attestationSigningCertificates As IReadOnlyList(Of AttestationSigner), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)

Parameters

options: AttestationTokenValidationOptions

Options used while validating the attestation token.

attestationSigningCertificates: IReadOnlyList<AttestationSigner>

Signing Certificates used to validate the token.

cancellationToken: CancellationToken

Token used to cancel this operation if necessary.

Returns

Task<Boolean>

true if the token was valid, false otherwise.

Exceptions

ArgumentNullException

Thrown if the signing certificates provided are invalid.

Exception

Thrown if validation fails.

Applies to