netFramework/Microsoft.IdentityModel.Tokens.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.IdentityModel.Tokens</name> </assembly> <members> <member name="T:Microsoft.IdentityModel.Tokens.AppCompatSwitches"> <summary> Identifiers used for switching between different app compat behaviors within the Microsoft.IdentityModel libraries. </summary> <remarks> The Microsoft.IdentityModel libraries use <see cref="T:System.AppContext" /> to turn on or off certain API behavioral changes that might have an effect on application compatibility. This class defines the set of switches that are available to modify library behavior. Application compatibility is favored as the default - so if your application needs to rely on the new behavior, you will need to enable the switch manually. Setting a switch's value can be done programmatically through the <see cref="M:System.AppContext.SetSwitch(System.String,System.Boolean)" /> method, or through other means such as setting it through MSBuild, app configuration, or registry settings. These alternate methods are described in the <see cref="M:System.AppContext.SetSwitch(System.String,System.Boolean)" /> documentation. </remarks> </member> <member name="F:Microsoft.IdentityModel.Tokens.AppCompatSwitches.UseRfcDefinitionOfEpkAndKid"> <summary> Uses <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.KeyExchangePublicKey"/> for the token's `kid` header parameter. When using ECDH-based key wrap algorithms the public key portion of <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key" /> is also written to the token's `epk` header parameter. </summary> <remarks> Enabling this switch improves the library's conformance to RFC 7518 with regards to how the header values for `kid` and `epk` are set in ECDH key wrap scenarios. The previous behavior erroneously used key ID of <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> as the `kid` parameter, and did not automatically set `epk` as the spec defines. This switch enables the intended behavior where <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.KeyExchangePublicKey"/> is used for `kid` and the public portion of <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> is used for `epk`. </remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.AppContextSwitches"> <summary> AppContext switches for Microsoft.IdentityModel.Tokens and referencing packages. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.AppContextSwitches.UseClaimsIdentityTypeSwitch"> <summary> Enables a fallback to the previous behavior of using <see cref="T:System.Security.Claims.ClaimsIdentity"/> instead of <see cref="T:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity"/> globally. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.AppContextSwitches.DoNotFailOnMissingTidSwitch"> <summary> When validating the issuer signing key, specifies whether to fail if the 'tid' claim is missing. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.AppContextSwitches.TryAllStringClaimsAsDateTimeSwitch"> <summary> When reading claims from the token, specifies whether to try to convert all string claims to DateTime. Some claims are known not to be DateTime, so conversion is skipped. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AppContextSwitches.ResetAllSwitches"> <summary> Used for testing to reset all switches to its default value. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.AsymmetricAdapter"> <summary> This adapter abstracts the 'RSA' differences between versions of .NET targets. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricAdapter.Dispose"> <summary> Calls <see cref="M:Microsoft.IdentityModel.Tokens.AsymmetricAdapter.Dispose(System.Boolean)"/> and <see cref="M:System.GC.SuppressFinalize(System.Object)"/>. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"> <summary> Base class for a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that contains Asymmetric key material. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> class. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey.HasPrivateKey"> <summary> This must be overridden to get a bool indicating if a private key exists. </summary> <return>true if it has a private key; otherwise, false.</return> </member> <member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey.PrivateKeyStatus"> <summary> Gets a value indicating the existence of the private key. </summary> <returns> <see cref="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.Exists"/> if the private key exists. <see cref="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.DoesNotExist"/> if the private key does not exist. <see cref="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.Unknown"/> if the existence of the private key cannot be determined. </returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.PrivateKeyStatus"> <summary> Enum for the existence of private key </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.Exists"> <summary> private key exists for sure </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.DoesNotExist"> <summary> private key doesn't exist for sure </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.Unknown"> <summary> unable to determine the existence of private key </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider"> <summary> Provides signature and verification operations for Asymmetric Algorithms using a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.DefaultMinimumAsymmetricKeySizeInBitsForSigningMap"> <summary> Mapping from algorithm to minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize when creating signatures. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.DefaultMinimumAsymmetricKeySizeInBitsForVerifyingMap"> <summary> Mapping from algorithm to minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize when verifying signatures. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider"/> class used to create and verify signatures. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.</param> <param name="algorithm">The signature algorithm to be used.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider"/> class used for creating and verifying signatures. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.</param> <param name="algorithm">The signature algorithm to be used.</param> <param name="willCreateSignatures">If true, the provider will be used for creating signatures; otherwise, it will be used for verifying signatures.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.InvalidOperationException">Thrown if <paramref name="willCreateSignatures"/> is true and there is no private key available.</exception> <exception cref="T:System.NotSupportedException">Thrown if the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="willCreateSignatures"/> is true and <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.KeySize"/> is less than the required size for signing.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.KeySize"/> is less than the required size for verifying signatures.</exception> <exception cref="T:System.InvalidOperationException">Thrown if the runtime is unable to create a suitable cryptographic provider.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForSigningMap"> <summary> Gets the mapping from algorithm to the minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize for creating signatures. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForVerifyingMap"> <summary> Gets the mapping from algorithm to the minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize for verifying signatures. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.GetHashAlgorithmName(System.String)"> <summary> Creating a Signature requires the use of a <see cref="T:System.Security.Cryptography.HashAlgorithm"/>. This method returns the <see cref="T:System.Security.Cryptography.HashAlgorithmName"/> that describes the <see cref="T:System.Security.Cryptography.HashAlgorithm"/>to use when generating a Signature. </summary> <param name="algorithm">The SignatureAlgorithm in use.</param> <returns>The <see cref="T:System.Security.Cryptography.HashAlgorithmName"/> to use.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or whitespace.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="algorithm"/> is not supported.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.ObjectPoolSize"> <summary> For testing purposes </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Sign(System.Byte[])"> <summary> Produces a signature over the 'input' using the <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> and algorithm passed to <see cref="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)"/>. </summary> <param name="input">The bytes to be signed.</param> <returns>A signature over the input.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="input"/> is null or has length of 0.</exception> <exception cref="T:System.ObjectDisposedException">Thrown If <see cref="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called.</exception> <remarks>Sign is thread safe.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Sign(System.Byte[],System.Int32,System.Int32)"> <inheritdoc/> </member> <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.ValidateAsymmetricSecurityKeySize(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)"> <summary> Validates that an asymmetric key size is of sufficient size for a SignatureAlgorithm. </summary> <param name="key">The asymmetric key to validate.</param> <param name="algorithm">The algorithm for which this key will be used.</param> <param name="willCreateSignatures">If true, the provider will be used for creating signatures.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/>is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="key.KeySize.KeySize"/> is less than the minimum acceptable size.</exception> <remarks> <seealso cref="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForSigningMap"/> for minimum signing sizes. <seealso cref="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForVerifyingMap"/> for minimum verifying sizes. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Verify(System.Byte[],System.Byte[])"> <summary> Verifies that the <paramref name="signature"/> over <paramref name="input"/> using the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.Algorithm"/> specified by this <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> are consistent. </summary> <param name="input">The bytes to generate the signature over.</param> <param name="signature">The value to verify against.</param> <returns>true if signature matches, false otherwise.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="input"/> is null or has length of 0.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="signature"/> is null or has length of 0.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if <see cref="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called.</exception> <remarks>Verify is thread safe.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Verify(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32)"> <inheritdoc/> </member> <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Dispose(System.Boolean)"> <summary> Releases the resources used by the current instance. </summary> <param name="disposing">If true, release both managed and unmanaged resources; otherwise, release only unmanaged resources.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.Base64UrlEncoder"> <summary> Encodes and Decodes strings as base64url encoding. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Encode(System.String)"> <summary> Performs base64url encoding, which differs from regular base64 encoding as follows: * Padding is skipped so the pad character '=' doesn't have to be percent encoded. * The 62nd and 63rd regular base64 encoding characters ('+' and '/') are replaced with ('-' and '_'). This makes the encoding alphabet URL safe. </summary> <param name="arg">The string to encode.</param> <returns>The base64url encoding of the UTF8 bytes.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Encode(System.Byte[])"> <summary> Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation encoded with base64url digits. </summary> <param name="inArray">An array of 8-bit unsigned integers.</param> <returns>The base64url encoded string representation of the elements in inArray.</returns> <exception cref="T:System.ArgumentNullException">Thrown if inArray is null.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if offset or length is negative, or if offset plus length is greater than the length of inArray.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Encode(System.Byte[],System.Int32,System.Int32)"> <summary> Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation encoded with base64url digits. Parameters specify the subset as an offset in the input array and the number of elements in the array to convert. </summary> <param name="inArray">An array of 8-bit unsigned integers.</param> <param name="offset">An offset in inArray.</param> <param name="length">The number of elements of inArray to convert.</param> <returns>The base64url encoded string representation of length elements of inArray, starting at position offset.</returns> <exception cref="T:System.ArgumentNullException">Thrown if inArray is null.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if offset or length is negative, or if offset plus length is greater than the length of inArray.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Encode(System.ReadOnlySpan{System.Byte},System.Span{System.Char})"> <summary> Populates a <see cref="T:System.Span`1"/> with the base64url encoded representation of a <see cref="T:System.ReadOnlySpan`1"/> of bytes. </summary> <param name="inArray">A read-only span of bytes to encode.</param> <param name="output">The span of characters to write the encoded output.</param> <returns>The number of characters written to the output span.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.DecodeBytes(System.String)"> <summary> Converts the specified base64url encoded string to UTF-8 bytes. </summary> <param name="str">The base64url encoded string.</param> <returns>The UTF-8 bytes.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Decode(System.String)"> <summary> Decodes the specified base64url encoded string to UTF-8. </summary> <param name="arg">The base64url encoded string to decode.</param> <returns>The UTF-8 decoded string.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.Base64UrlEncoding"> <summary> Base64 encode/decode implementation for as per https://tools.ietf.org/html/rfc4648#section-5. Uses ArrayPool[T] to minimize memory usage. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.Decode(System.String)"> <summary> Decodes a base64url encoded string into a byte array. </summary> <param name="inputString">The base64url encoded string to decode.</param> <returns>The decoded bytes.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.Decode(System.String,System.Int32,System.Int32)"> <summary> Decodes a base64url encoded substring of a string into a byte array. </summary> <param name="input">The base64url encoded string to decode.</param> <param name="offset">The index of the character in <paramref name="input"/> to start decoding.</param> <param name="length">The number of characters in <paramref name="input"/> to decode.</param> <returns>The decoded bytes.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.Decode``2(System.String,System.Int32,System.Int32,``1,System.Func{System.Byte[],System.Int32,``1,``0})"> <summary> Decodes a base64url encoded substring of a string and then performs an action on the decoded bytes. </summary> <typeparam name="T">The output type of the decoding action.</typeparam> <typeparam name="TX">The type of the input parameter to the action.</typeparam> <param name="input">The base64url encoded string to decode.</param> <param name="offset">The index of the character in <paramref name="input"/> to start decoding.</param> <param name="length">The number of characters in <paramref name="input"/> to decode from <paramref name="offset"/>.</param> <param name="argx">The input parameter to the action.</param> <param name="action">The action to perform on the decoded bytes.</param> <returns>An instance of {T}.</returns> <remarks> The buffer for the decode operation uses a shared memory pool to avoid allocations. The length of the rented array of bytes may be larger than the decoded bytes; therefore, the action needs to know the actual length to use. The result of <see cref="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.ValidateAndGetOutputSize(System.ReadOnlySpan{System.Char},System.Int32,System.Int32)"/> is passed to the action. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.Decode``1(System.String,System.Int32,System.Int32,System.Func{System.Byte[],System.Int32,``0})"> <summary> Decodes a base64url encoded substring of a string and then performs an action on the decoded bytes. </summary> <typeparam name="T">The return type of the operation.</typeparam> <param name="input">The base64url encoded string to decode.</param> <param name="offset">The index of the character in <paramref name="input"/> to start decoding from.</param> <param name="length">The number of characters in <paramref name="input"/> to decode from <paramref name="offset"/>.</param> <param name="action">The action to perform on the decoded bytes.</param> <returns>An instance of {T}.</returns> <remarks> The buffer for the decode operation uses a shared memory pool to avoid allocations. The length of the rented array of bytes may be larger than the decoded bytes; therefore, the action needs to know the actual length to use. The result of <see cref="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.ValidateAndGetOutputSize(System.ReadOnlySpan{System.Char},System.Int32,System.Int32)"/> is passed to the action. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.Decode``4(System.String,System.Int32,System.Int32,``1,``2,``3,System.Func{System.Byte[],System.Int32,``1,``2,``3,``0})"> <summary> Decodes a base64url encoded substring of a string and then performs an action on the decoded bytes. </summary> <typeparam name="T">The return type of the operation.</typeparam> <typeparam name="TX">The type of input parameter 1 to the action.</typeparam> <typeparam name="TY">The type of input parameter 2 to the action.</typeparam> <typeparam name="TZ">The type of input parameter 3 to the action.</typeparam> <param name="input">The base64url encoded string to decode.</param> <param name="offset">The index of the character in <paramref name="input"/> to start decoding from.</param> <param name="length">The number of characters in <paramref name="input"/> to decode from <paramref name="offset"/>.</param> <param name="argx">Input parameter 1 to the action.</param> <param name="argy">Input parameter 2 to the action.</param> <param name="argz">Input parameter 3 to the action.</param> <param name="action">The action to perform on the decoded bytes.</param> <returns>An instance of {T}.</returns> <remarks> The buffer for the decode operation uses a shared memory pool to avoid allocations. The length of the rented array of bytes may be larger than the decoded bytes; therefore, the action needs to know the actual length to use. The result of <see cref="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.ValidateAndGetOutputSize(System.ReadOnlySpan{System.Char},System.Int32,System.Int32)"/> is passed to the action. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.Decode(System.ReadOnlySpan{System.Char},System.Int32,System.Int32,System.Byte[])"> <summary> Decodes a Base64Url encoded substring of a string into a byte array. </summary> <param name="input">The string represented as a span to decode.</param> <param name="offset">The index of the character in <paramref name="input"/> to start decoding from.</param> <param name="length">The number of characters beginning from <paramref name="offset"/> to decode.</param> <param name="output">The byte array to place the decoded results into.</param> <remarks> Changes from Base64UrlEncoder implementation: 1. Padding is optional. 2. '+' and '-' are treated the same. 3. '/' and '_' are treated the same. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.Encode(System.Byte[])"> <summary> Encodes a byte array into a base64url encoded string. </summary> <param name="bytes">The bytes to encode.</param> <returns>base64url encoded string.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.Encode(System.Byte[],System.Int32,System.Int32)"> <summary> Encodes a subset of a byte array into a Base64Url encoded string. </summary> <param name="input">The byte array to encode.</param> <param name="offset">The index into <paramref name="input"/> to start the encode operation.</param> <param name="length">The number of bytes in <paramref name="input"/> to encode, starting from <paramref name="offset"/>.</param> <returns>Base64Url encoded string.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoding.ValidateAndGetOutputSize(System.ReadOnlySpan{System.Char},System.Int32,System.Int32)"> <summary> Validates the input span for a decode operation. </summary> <param name="strSpan">The string represented by a span to validate.</param> <param name="offset">The index of the character in <paramref name="strSpan"/> to start the decode operation.</param> <param name="length">The number of characters in <paramref name="strSpan"/> to decode, starting from <paramref name="offset"/>.</param> <returns>The size of the decoded bytes array.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"> <summary> Represents a generic metadata configuration which is applicable for both XML and JSON based configurations. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfiguration.Issuer"> <summary> Gets the issuer specified via the metadata endpoint. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfiguration.SigningKeys"> <summary> Gets the <see cref="T:System.Collections.Generic.ICollection`1"/> that the IdentityProvider indicates are to be used in order to sign tokens. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfiguration.TokenEndpoint"> <summary> Gets or sets the token endpoint specified via the metadata endpoint. This is the fed:PassiveRequestorEndpoint in WS-Federation (<see href="https://docs.oasis-open.org/wsfed/federation/v1.2/os/ws-federation-1.2-spec-os.html#:~:text=fed%3ASecurityTokenServiceType/fed%3APassiveRequestorEndpoint"/>) or the token_endpoint in the OIDC metadata. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfiguration.ActiveTokenEndpoint"> <summary> Gets or sets the token endpoint specified via the metadata endpoint. This is the fed:SecurityTokenServiceType in WS-Federation (<see href="http://docs.oasis-open.org/wsfed/federation/v1.2/os/ws-federation-1.2-spec-os.html#:~:text=fed%3ASecurityTokenSerivceEndpoint"/>) </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfiguration.TokenDecryptionKeys"> <summary> Gets the <see cref="T:System.Collections.Generic.ICollection`1"/> that the IdentityProvider indicates are to be used in order to decrypt tokens. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.BaseConfigurationComparer"> <summary> Compares instances of <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> for equality. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.BaseConfigurationComparer.Equals(Microsoft.IdentityModel.Tokens.BaseConfiguration,Microsoft.IdentityModel.Tokens.BaseConfiguration)"> <summary> Determines whether the specified objects are equal. </summary> <param name="config1">The first <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> to compare.</param> <param name="config2">The second <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> to compare.</param> <returns>true if the specified objects are equal; otherwise, false.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.BaseConfigurationComparer.GetHashCode(Microsoft.IdentityModel.Tokens.BaseConfiguration)"> <summary> Returns a hash code for the specified object. </summary> <param name="config">The <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> for which a hash code is to be returned.</param> <returns>A hash code for the specified object.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.BaseConfigurationManager"> <summary> Represents a generic configuration manager. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.AutomaticRefreshInterval"> <summary> Gets or sets the <see cref="T:System.TimeSpan"/> that controls how often an automatic metadata refresh should occur. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.DefaultAutomaticRefreshInterval"> <summary> Default time interval (12 hours) after which a new configuration is obtained automatically. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.DefaultLastKnownGoodConfigurationLifetime"> <summary> Default time interval (1 hour) for which the last known good configuration remains valid. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.DefaultRefreshInterval"> <summary> Default time interval (5 minutes) that must pass for <see cref="M:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.RequestRefresh"/> to obtain a new configuration. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfigurationManager"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.#ctor(Microsoft.IdentityModel.Tokens.Configuration.LKGConfigurationCacheOptions)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfigurationManager"/> class. </summary> <param name="options">The event queue task creation option.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.GetBaseConfigurationAsync(System.Threading.CancellationToken)"> <summary> Obtains an updated version of <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> if the appropriate refresh interval has passed. This method may return a cached version of the configuration. </summary> <param name="cancel">A cancellation token that can be used to cancel the asynchronous operation.</param> <returns>Configuration of type Configuration.</returns> <remarks>This method on the base class throws a <see cref="T:System.NotImplementedException"/> as it is meant to be overridden by the class that extends it.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.GetValidLkgConfigurations"> <summary> Gets all valid last known good configurations. </summary> <returns>A collection of all valid last known good configurations.</returns> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.LastKnownGoodConfiguration"> <summary> The last known good configuration or LKG (a configuration retrieved in the past that we were able to successfully validate a token against). </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.LastKnownGoodLifetime"> <summary> The length of time that a last known good configuration is valid for. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.MetadataAddress"> <summary> The metadata address to retrieve the configuration from. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.MinimumAutomaticRefreshInterval"> <summary> Minimum time interval (5 minutes) for automatic refresh. <see cref="P:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.AutomaticRefreshInterval"/> cannot be set to less than this value. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.MinimumRefreshInterval"> <summary> Minimum time interval (1 second) that must pass before calling <see cref="M:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.RequestRefresh"/> to obtain new configuration. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.RefreshInterval"> <summary> The minimum time between retrievals, in the event that a retrieval failed, or that a refresh was explicitly requested. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.UseLastKnownGoodConfiguration"> <summary> Gets or sets a value indicating whether to use the last known good configuration. Default is true. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.IsLastKnownGoodValid"> <summary> Gets a value indicating whether the last known good configuration is still valid, depends on when the LKG was first used and it's lifetime. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.BaseConfigurationManager.RequestRefresh"> <summary> Indicate that the configuration may be stale (as indicated by failing to process incoming tokens). </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.CallContext"> <summary> An opaque context used to store work when working with authentication artifacts. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CallContext.#ctor"> <summary> Instantiates a new <see cref="T:Microsoft.IdentityModel.Tokens.CallContext"/> with a default activity identifier. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CallContext.#ctor(System.Guid)"> <summary> Instantiates a new <see cref="T:Microsoft.IdentityModel.Tokens.CallContext"/> with an activity identifier. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity"> <summary> A derived <see cref="T:System.Security.Claims.ClaimsIdentity"/> where claim retrieval is case-sensitive. The current <see cref="T:System.Security.Claims.ClaimsIdentity"/> retrieves claims in a case-insensitive manner which is different than querying the underlying <see cref="P:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.SecurityToken"/>. The <see cref="T:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity"/> provides consistent retrieval logic between the <see cref="P:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.SecurityToken"/> and <see cref="T:System.Security.Claims.ClaimsIdentity"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.SecurityToken"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.SecurityToken"/> associated with this claims identity. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.#ctor"> <summary> Initializes an instance of <see cref="T:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.#ctor(System.String)"> <summary> Initializes an instance of <see cref="T:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity"/>. </summary> <param name="authenticationType">The authentication method used to establish this identity.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.#ctor(System.Security.Claims.ClaimsIdentity)"> <summary> Initializes an instance of <see cref="T:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity"/>. </summary> <param name="claimsIdentity"><see cref="T:System.Security.Claims.ClaimsIdentity"/> to copy.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.#ctor(System.Collections.Generic.IEnumerable{System.Security.Claims.Claim})"> <summary> Initializes an instance of <see cref="T:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity"/>. </summary> <param name="claims"><see cref="T:System.Collections.Generic.IEnumerable`1"/> associated with this instance.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.#ctor(System.Collections.Generic.IEnumerable{System.Security.Claims.Claim},System.String)"> <summary> Initializes an instance of <see cref="T:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity"/>. </summary> <param name="claims"><see cref="T:System.Collections.Generic.IEnumerable`1"/> associated with this instance.</param> <param name="authenticationType">The authentication method used to establish this identity.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.#ctor(System.Collections.Generic.IEnumerable{System.Security.Claims.Claim},System.String,System.String,System.String)"> <summary> Initializes an instance of <see cref="T:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity"/>. </summary> <param name="claims"><see cref="T:System.Collections.Generic.IEnumerable`1"/> associated with this instance.</param> <param name="authenticationType">The authentication method used to establish this identity.</param> <param name="nameType">The <see cref="P:System.Security.Claims.Claim.Type"/> used when obtaining the value of <see cref="P:System.Security.Claims.ClaimsIdentity.Name"/>.</param> <param name="roleType">The <see cref="P:System.Security.Claims.Claim.Type"/> used when performing logic for <see cref="M:System.Security.Claims.ClaimsPrincipal.IsInRole(System.String)"/>.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.#ctor(System.String,System.String,System.String)"> <summary> Initializes an instance of <see cref="T:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity"/>. </summary> <param name="authenticationType">The authentication method used to establish this identity.</param> <param name="nameType">The <see cref="P:System.Security.Claims.Claim.Type"/> used when obtaining the value of <see cref="P:System.Security.Claims.ClaimsIdentity.Name"/>.</param> <param name="roleType">The <see cref="P:System.Security.Claims.Claim.Type"/> used when performing logic for <see cref="M:System.Security.Claims.ClaimsPrincipal.IsInRole(System.String)"/>.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.FindAll(System.String)"> <summary> Retrieves a <see cref="T:System.Collections.Generic.IEnumerable`1"/> where each <see cref="P:System.Security.Claims.Claim.Type"/> equals <paramref name="type"/>. </summary> <param name="type">The type of the claim to match.</param> <returns>A <see cref="T:System.Collections.Generic.IEnumerable`1"/> of matched claims.</returns> <remarks>Comparison is <see cref="F:System.StringComparison.Ordinal"/>.</remarks> <exception cref="T:System.ArgumentNullException">if <paramref name="type"/> is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.FindFirst(System.String)"> <summary> Retrieves the first <see cref="T:System.Security.Claims.Claim"/> where <see cref="P:System.Security.Claims.Claim.Type"/> equals <paramref name="type"/>. </summary> <param name="type">The type of the claim to match.</param> <returns>A <see cref="T:System.Security.Claims.Claim"/>, <see langword="null"/> if nothing matches.</returns> <remarks>Comparison is <see cref="F:System.StringComparison.Ordinal"/>.</remarks> <exception cref="T:System.ArgumentNullException">if <paramref name="type"/> is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity.HasClaim(System.String,System.String)"> <summary> Determines if a claim with type AND value is contained within this claims identity. </summary> <param name="type">The type of the claim to match.</param> <param name="value">The value of the claim to match.</param> <returns><c>true</c> if a claim is matched, <c>false</c> otherwise.</returns> <remarks>Comparison is <see cref="F:System.StringComparison.Ordinal"/> for <see cref="P:System.Security.Claims.Claim.Type"/> and <see cref="P:System.Security.Claims.Claim.Value"/>.</remarks> <exception cref="T:System.ArgumentNullException">if <paramref name="type"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="value"/> is null.</exception> </member> <member name="T:Microsoft.IdentityModel.Tokens.ClaimsIdentityFactory"> <summary> Facilitates the creation of <see cref="T:System.Security.Claims.ClaimsIdentity"/> and <see cref="T:Microsoft.IdentityModel.Tokens.CaseSensitiveClaimsIdentity"/> instances based on the <see cref="F:Microsoft.IdentityModel.Tokens.AppContextSwitches.UseClaimsIdentityTypeSwitch"/>. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.CollectionUtilities"> <summary> A class which contains useful methods for processing collections. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CollectionUtilities.IsNullOrEmpty``1(System.Collections.Generic.IEnumerable{``0})"> <summary> Checks whether the specified <paramref name="enumerable"/> is null or empty. </summary> <typeparam name="T">The type of the elements in the <paramref name="enumerable"/>.</typeparam> <param name="enumerable">The <see cref="T:System.Collections.Generic.IEnumerable`1"/> to be checked.</param> <returns>True if the <paramref name="enumerable"/> is null or contains no elements; otherwise, false.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.CompressionAlgorithms"> <summary> Constants for compression algorithms. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.CompressionAlgorithms.Deflate"> <summary> See: <see href="https://datatracker.ietf.org/doc/html/rfc1951"/>. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory"> <summary> Compression provider factory for compression and decompression. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.#cctor"> <summary> Static constructor that initializes the default <see cref="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.#ctor(Microsoft.IdentityModel.Tokens.CompressionProviderFactory)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory"/> class. </summary> <param name="other">The <see cref="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory"/> to copy from.</param> </member> <member name="P:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.Default"> <summary> Returns the default <see cref="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory"/> instance. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.CustomCompressionProvider"> <summary> Extensibility point for custom compression support application wide. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.IsSupportedAlgorithm(System.String)"> <summary> Determines whether the specified algorithm is supported. </summary> <param name="algorithm">The name of the cryptographic algorithm.</param> <returns><see langword="true"/> if the algorithm is supported; otherwise, <see langword="false"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.CreateCompressionProvider(System.String)"> <summary> Creates a <see cref="T:Microsoft.IdentityModel.Tokens.ICompressionProvider"/> for a specified compression algorithm. </summary> <param name="algorithm">The compression algorithm.</param> <returns>An instance of <see cref="T:Microsoft.IdentityModel.Tokens.ICompressionProvider"/> for the specified algorithm.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.CreateCompressionProvider(System.String,System.Int32)"> <summary> Creates a <see cref="T:Microsoft.IdentityModel.Tokens.ICompressionProvider"/> for a specific compression algorithm with a maximum deflate size limit. </summary> <param name="algorithm">The compression algorithm.</param> <param name="maximumDeflateSize">The maximum size limit (in characters) for deflate compression processing.</param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.ICompressionProvider"/> instance.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.Configuration.LKGConfigurationCacheOptions"> <summary> Defines the options which can be used to configure the internal LKG configuration cache. See <see cref="T:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2"/> for more details. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.Configuration.LKGConfigurationCacheOptions.DefaultLKGConfigurationSizeLimit"> <summary> 10 is the default size limit of the cache (in number of items) for last known good configuration. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.Configuration.LKGConfigurationCacheOptions.BaseConfigurationComparer"> <summary> Gets or sets the <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> that is used to determine equality of values for <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.Configuration.LKGConfigurationCacheOptions.LastKnownGoodConfigurationSizeLimit"> <summary> Gets or sets the size limit of the cache (in number of items) for last known good configuration. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.Configuration.LKGConfigurationCacheOptions.TaskCreationOptions"> <summary> The event queue task creation option, default to None instead of LongRunning as LongRunning will always start a task on a new thread instead of a thread from ThreadPool. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.Configuration.LKGConfigurationCacheOptions.RemoveExpiredValues"> <summary> Whether or not to remove expired items. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.CryptoProviderCache"> <summary> Abstract definition of a cache for cryptographic providers. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SignatureProvider)"> <summary> Returns the cache key used to look up an entry for a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>. </summary> <param name="signatureProvider">The <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to create the key for.</param> <returns>The cache key used for finding a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)"> <summary> Returns the cache key used to find a cryptographic provider in this cache. </summary> <param name="securityKey">The key used by the cryptographic provider.</param> <param name="algorithm">The algorithm used by the cryptographic provider.</param> <param name="typeofProvider">The type of the cryptographic provider obtained by calling object.GetType().</param> <returns>The cache key used for finding a cryptographic provider.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.TryAdd(Microsoft.IdentityModel.Tokens.SignatureProvider)"> <summary> Tries to add a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to this cache. </summary> <param name="signatureProvider">The <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to cache.</param> <returns>True if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was added; false if the cache already contained the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.TryGetSignatureProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String,System.Boolean,Microsoft.IdentityModel.Tokens.SignatureProvider@)"> <summary> Tries to find a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> in this cache. </summary> <param name="securityKey">The key used by the cryptographic provider.</param> <param name="algorithm">The algorithm used by the cryptographic provider.</param> <param name="typeofProvider">The type of the cryptographic provider obtained by calling object.GetType().</param> <param name="willCreateSignatures">If true, the provider will be used for creating signatures.</param> <param name="signatureProvider">The <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> if found.</param> <returns>True if a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was found; false otherwise.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.TryRemove(Microsoft.IdentityModel.Tokens.SignatureProvider)"> <summary> Tries to remove a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> from this cache. </summary> <param name="signatureProvider">The <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to remove.</param> <returns>True if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was removed; false if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was not found.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions"> <summary> Specifies the CryptoProviderCacheOptions which can be used to configure the internal cryptoprovider cache. We are using our own simple LRU caching implementation across all targets. See <see cref="T:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2"/> for more details. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions.DefaultSizeLimit"> <summary> Default value for the cache size limit (<see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions.SizeLimit"/>). Default is 1000. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions.SizeLimit"> <summary> Gets or sets the size limit of the cache (in number of items). When the cache reaches 95% of this size, 20% of the least recently used items will be evicted. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"> <summary> Creates cryptographic operators by specifying a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>'s and algorithms. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.Default"> <summary> Returns the default <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> instance. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.DefaultCacheSignatureProviders"> <summary> Gets or sets the default value for caching of <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>'s. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.DefaultSignatureProviderObjectPoolCacheSize"> <summary> Gets or sets the maximum size of the object pool used by the SignatureProvider that are used for crypto objects. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.#cctor"> <summary> Static constructor that initializes the default <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.#ctor(Microsoft.IdentityModel.Tokens.CryptoProviderCache)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> class. </summary> <param name="cache">The cache to use for caching CryptoProviders.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.#ctor(Microsoft.IdentityModel.Tokens.CryptoProviderFactory)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> class. </summary> <param name="other">The <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> to copy from.</param> </member> <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CryptoProviderCache"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CryptoProviderCache"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"> <summary> Extensibility point for creating custom cryptographic operators. </summary> <remarks>By default, if set, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> will be called before creating cryptographic operators. If true is returned, then <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> will be called. The <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> will throw if the Cryptographic operator returned is not of the correct type.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CacheSignatureProviders"> <summary> Gets or sets a bool controlling if <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> should be cached. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.SignatureProviderObjectPoolCacheSize"> <summary> Gets or sets the maximum size of the object pool used by the SignatureProvider that are used for crypto objects. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateAuthenticatedEncryptionProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/> for a specific <paramref name="key"/> and <paramref name="algorithm"/>. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param> <param name="algorithm">The algorithm to use.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.ArgumentException">Thrown if the combination of <paramref name="key"/> and <paramref name="algorithm"/> is not supported.</exception> <exception cref="T:System.InvalidOperationException">Thrown if the type returned by <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is not assignable to <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>.</exception> <remarks> <para>If <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is called to obtain the <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/>. </para> <para>Once done with the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>, call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseKeyWrapProvider(Microsoft.IdentityModel.Tokens.KeyWrapProvider)"/>.</para> </remarks> <returns>An instance of <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateKeyWrapProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> for a specific <paramref name="key"/> and <paramref name="algorithm"/>. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param> <param name="algorithm">The algorithm to use.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.NotSupportedException">Thrown if the combination of <paramref name="key"/> and <paramref name="algorithm"/> is not supported.</exception> <exception cref="T:System.InvalidOperationException">Thrown if the type returned by <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is not assignable to <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>.</exception> <remarks> <para>If <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is called to obtain the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>. </para> <para>Once done with the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>, call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseKeyWrapProvider(Microsoft.IdentityModel.Tokens.KeyWrapProvider)"/>.</para> </remarks> <returns>An instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateKeyWrapProviderForUnwrap(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> for a specific <paramref name="key"/> and <paramref name="algorithm"/>. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param> <param name="algorithm">The algorithm to use.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.ArgumentException">Thrown if the combination of <paramref name="key"/> and <paramref name="algorithm"/> is not supported.</exception> <exception cref="T:System.InvalidOperationException">Thrown if the type returned by <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is not assignable to <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>.</exception> <remarks> <para>If <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is called to obtain the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>. </para> <para>Once done with the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>, call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseKeyWrapProvider(Microsoft.IdentityModel.Tokens.KeyWrapProvider)"/>.</para> </remarks> <returns>An instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateForSigning(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Creates a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> for signing with the specified <paramref name="key"/> and <paramref name="algorithm"/>. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signing.</param> <param name="algorithm">The algorithm to use for signing.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.KeySize"/> is too small.</exception> <exception cref="T:System.NotSupportedException">Thrown if <paramref name="key"/> is not assignable from <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> or <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception> <exception cref="T:System.NotSupportedException">Thrown if the key or algorithm combination is not supported.</exception> <exception cref="T:System.InvalidOperationException">Thrown if the type returned by <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is not assignable to <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>.</exception> <remarks> <para>AsymmetricSignatureProviders require access to a PrivateKey for signing.</para> <para>Once done with the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>, call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)"/>.</para> <para>If <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is called to obtain the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>. </para> </remarks> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> instance that can be used to create a signature.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateForSigning(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)"> <summary> Creates a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> for signing with the specified <paramref name="key"/> and <paramref name="algorithm"/>. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signing.</param> <param name="algorithm">The algorithm to use for signing.</param> <param name="cacheProvider">Indicates whether the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> should be cached for reuse.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.KeySize"/> is too small.</exception> <exception cref="T:System.NotSupportedException">Thrown if <paramref name="key"/> is not assignable from <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> or <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception> <exception cref="T:System.NotSupportedException">Thrown if the combination of <paramref name="key"/> and <paramref name="algorithm"/> is not supported.</exception> <exception cref="T:System.InvalidOperationException">Thrown if the type returned by <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is not assignable to <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>.</exception> <remarks> <para>AsymmetricSignatureProviders require access to a PrivateKey for signing.</para> <para>Once done with the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>, call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)"/>.</para> <para>If <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is called to obtain the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>. </para> </remarks> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> instance that can be used to create a signature.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateForVerifying(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Creates a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> for verifying signatures with the specified <paramref name="key"/> and <paramref name="algorithm"/>. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signature verification.</param> <param name="algorithm">The algorithm to use for verifying signatures.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.KeySize"/> is too small.</exception> <exception cref="T:System.NotSupportedException">Thrown if <paramref name="key"/> is not assignable from <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> or <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception> <exception cref="T:System.NotSupportedException">Thrown if the combination of <paramref name="key"/> and <paramref name="algorithm"/> is not supported.</exception> <exception cref="T:System.InvalidOperationException">Thrown if the type returned by <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is not assignable to <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>.</exception> <remarks> <para>Once done with the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>, call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)"/>.</para> <para>If <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is called to obtain the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>. </para> </remarks> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> instance that can be used to validate signatures using the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateForVerifying(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)"> <summary> Creates a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> for verifying signatures with the specified <paramref name="key"/> and <paramref name="algorithm"/>. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signature verification.</param> <param name="algorithm">The algorithm to use for verifying signatures.</param> <param name="cacheProvider">Specifies whether the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> should be cached for reuse.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.KeySize"/> is too small.</exception> <exception cref="T:System.NotSupportedException">Thrown if <paramref name="key"/> is not assignable from <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> or <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception> <exception cref="T:System.NotSupportedException">Thrown if the combination of <paramref name="key"/> and <paramref name="algorithm"/> is not supported.</exception> <exception cref="T:System.InvalidOperationException">Thrown if the type returned by <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is not assignable to <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>.</exception> <remarks> <para>Once done with the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>, call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)"/>.</para> <para>If <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is called to obtain the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>. </para> </remarks> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> instance that can be used to validate signatures using the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateHashAlgorithm(System.Security.Cryptography.HashAlgorithmName)"> <summary> Creates a <see cref="T:System.Security.Cryptography.HashAlgorithm"/> instance for a specific hash algorithm. </summary> <param name="algorithm">The name of the hash algorithm to create.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.InvalidOperationException">Thrown if <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> returns a type that is not assignable to <see cref="T:System.Security.Cryptography.HashAlgorithm"/>.</exception> <exception cref="T:System.NotSupportedException">Thrown if <paramref name="algorithm"/> is not supported.</exception> <remarks> <para>Once done with the <see cref="T:System.Security.Cryptography.HashAlgorithm"/>, call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseHashAlgorithm(System.Security.Cryptography.HashAlgorithm)"/>.</para> <para>If <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is called to obtain the <see cref="T:System.Security.Cryptography.HashAlgorithm"/>. </para> </remarks> <returns>A <see cref="T:System.Security.Cryptography.HashAlgorithm"/> instance that corresponds to the specified <paramref name="algorithm"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateHashAlgorithm(System.String)"> <summary> Creates a <see cref="T:System.Security.Cryptography.HashAlgorithm"/> instance for a specific hash algorithm. </summary> <param name="algorithm">The name of the hash algorithm to create.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.InvalidOperationException">Thrown if <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> returns a type that is not assignable to <see cref="T:System.Security.Cryptography.HashAlgorithm"/>.</exception> <exception cref="T:System.NotSupportedException">Thrown if <paramref name="algorithm"/> is not supported.</exception> <remarks> Once done with the <see cref="T:System.Security.Cryptography.HashAlgorithm"/>, call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseHashAlgorithm(System.Security.Cryptography.HashAlgorithm)"/>. <para>If <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is called to obtain the <see cref="T:System.Security.Cryptography.HashAlgorithm"/>. </para> </remarks> <returns>A <see cref="T:System.Security.Cryptography.HashAlgorithm"/> instance that corresponds to the specified <paramref name="algorithm"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateKeyedHashAlgorithm(System.Byte[],System.String)"> <summary> Creates a <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/> instance for a specific keyed hash algorithm. </summary> <param name="keyBytes">The bytes to use as the key for the keyed hash.</param> <param name="algorithm">The name of the keyed hash algorithm to create.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="keyBytes"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.InvalidOperationException">Thrown if <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> returns a type that is not assignable to <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/>.</exception> <exception cref="T:System.NotSupportedException">Thrown if <paramref name="algorithm"/> is not supported.</exception> <remarks> Once done with the <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/>, call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseHashAlgorithm(System.Security.Cryptography.HashAlgorithm)"/>. <para>If <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> is called to obtain the <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/>. </para> </remarks> <returns>A <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/> instance that corresponds to the specified <paramref name="algorithm"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ShouldCacheSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)"> <summary> For some security key types, in some runtimes, it's not possible to extract public key material and create an <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.InternalId"/>. In these cases, <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.InternalId"/> will be an empty string, and these keys should not be cached. </summary> <param name="signatureProvider"><see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to be examined.</param> <returns><see langword="true"/> if <paramref name="signatureProvider"/> should be cached; otherwise, <see langword="false"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.IsSupportedAlgorithm(System.String)"> <summary> Determines whether the specified hash algorithm is supported. </summary> <param name="algorithm">The name of the hash algorithm.</param> <remarks>Considers only known hash algorithms.</remarks> <returns> <see langword="true"/> if: <list type="bullet"> <item><description><see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true,</description></item> <item><description>The algorithm is supported.</description></item> </list> Otherwise, <see langword="false"/>. </returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.IsSupportedAlgorithm(System.String,Microsoft.IdentityModel.Tokens.SecurityKey)"> <summary> Checks if the specified algorithm and <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> are supported. </summary> <param name="algorithm">The security algorithm to be used.</param> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.</param> <remarks> Algorithms are supported for specific key types. For example: <list type="bullet"> <item><description><see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/> and <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/> will return true.</description></item> <item><description><see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/> and <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> will return false.</description></item> </list> </remarks> <returns> <see langword="true"/> if: <list type="bullet"> <item><description><see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> is set and <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> returns true,</description></item> <item><description>The algorithm / key pair is supported.</description></item> </list> Otherwise, <see langword="false"/>. </returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseHashAlgorithm(System.Security.Cryptography.HashAlgorithm)"> <summary> Releases resources associated with a <see cref="T:System.Security.Cryptography.HashAlgorithm"/> instance. The default behavior is to call <see cref="M:System.Security.Cryptography.HashAlgorithm.Dispose"/>. </summary> <param name="hashAlgorithm">The <see cref="T:System.Security.Cryptography.HashAlgorithm"/> instance to release.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="hashAlgorithm"/> is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseKeyWrapProvider(Microsoft.IdentityModel.Tokens.KeyWrapProvider)"> <summary> Releases resources associated with a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> instance. </summary> <param name="provider">The <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> instance to release.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="provider"/> is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseRsaKeyWrapProvider(Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider)"> <summary> Releases resources associated with an <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> instance. </summary> <param name="provider">The <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> instance to release.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="provider"/> is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)"> <summary> Releases resources associated with a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> instance. </summary> <param name="signatureProvider">The <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> instance to release.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="signatureProvider"/> is null.</exception> </member> <member name="T:Microsoft.IdentityModel.Tokens.DateTimeUtil"> <summary> Utility class for performing operations involving <see cref="T:System.DateTime"/> and <see cref="T:System.TimeSpan"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.Add(System.DateTime,System.TimeSpan)"> <summary> Adds a <see cref="T:System.DateTime"/> and a <see cref="T:System.TimeSpan"/>. If the resulting value exceeds <see cref="F:System.DateTime.MaxValue"/>, returns <see cref="F:System.DateTime.MaxValue"/>. If the resulting value is less than <see cref="F:System.DateTime.MinValue"/>, returns <see cref="F:System.DateTime.MinValue"/>. </summary> <param name="time">Initial <see cref="T:System.DateTime"/> value.</param> <param name="timespan"><see cref="T:System.TimeSpan"/> to add.</param> <returns>The sum of <paramref name="time"/> and <paramref name="timespan"/>, or <see cref="F:System.DateTime.MaxValue"/> if the sum exceeds it, or <see cref="F:System.DateTime.MinValue"/> if the sum is less than it.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.GetMaxValue(System.DateTimeKind)"> <summary> Gets the maximum value for a <see cref="T:System.DateTime"/> with the specified <see cref="T:System.DateTimeKind"/>. </summary> <param name="kind">The <see cref="T:System.DateTimeKind"/>.</param> <returns>The maximum <see cref="T:System.DateTime"/> value of the specified kind.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.GetMinValue(System.DateTimeKind)"> <summary> Gets the minimum value for a <see cref="T:System.DateTime"/> with the specified <see cref="T:System.DateTimeKind"/>. </summary> <param name="kind">The <see cref="T:System.DateTimeKind"/>.</param> <returns>The minimum <see cref="T:System.DateTime"/> value of the specified kind.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.ToUniversalTime(System.Nullable{System.DateTime})"> <summary> Converts the specified <see cref="T:System.DateTime"/> to UTC if it is not already in UTC. </summary> <param name="value">The <see cref="T:System.DateTime"/> to convert.</param> <returns>The converted <see cref="T:System.DateTime"/> in UTC, or null if <paramref name="value"/> is null.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.ToUniversalTime(System.DateTime)"> <summary> Converts the specified <see cref="T:System.DateTime"/> to UTC if it is not already in UTC. </summary> <param name="value">The <see cref="T:System.DateTime"/> to convert.</param> <returns>The converted <see cref="T:System.DateTime"/> in UTC.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider"> <summary> A compression provider that supports compression and decompression using the <see cref="F:Microsoft.IdentityModel.Tokens.CompressionAlgorithms.Deflate"/> algorithm. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider"/> class used to compress and decompress used the <see cref="F:Microsoft.IdentityModel.Tokens.CompressionAlgorithms.Deflate"/> algorithm. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.#ctor(System.IO.Compression.CompressionLevel)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider"/> class used to compress and decompress used the <see cref="F:Microsoft.IdentityModel.Tokens.CompressionAlgorithms.Deflate"/> algorithm. <param name="compressionLevel">The compression level to use when compressing.</param> </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.Algorithm"> <summary> Gets the compression algorithm. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.CompressionLevel"> <summary> Specifies whether compression should emphasize speed or compression size. Set to <see cref="F:System.IO.Compression.CompressionLevel.Optimal"/> by default. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.MaximumDeflateSize"> <summary> Gets and sets the maximum deflate size in chars that will be processed. </summary> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if the value is less than 1.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.Decompress(System.Byte[])"> <summary> Decompresses the value using Deflate algorithm. </summary> <param name="value">The bytes to decompress.</param> <returns>The decompressed bytes.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.Compress(System.Byte[])"> <summary> Compresses the value using the Deflate algorithm. </summary> <param name="value">The bytes to compress.</param> <returns>The compressed bytes.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.IsSupportedAlgorithm(System.String)"> <summary> Determines whether the specified compression algorithm is supported. </summary> <param name="algorithm">The name of the compression algorithm.</param> <returns><see langword="true"/> if the compression algorithm is supported; otherwise, <see langword="false"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.AlgorithmValidator"> <summary> Validates the cryptographic algorithm used. </summary> <param name="algorithm">The algorithm to be validated.</param> <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used to sign the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns><see langword="true"/> if the algorithm is valid; otherwise, <see langword="false"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.AudienceValidator"> <summary> Validates the audiences found in the security token. </summary> <param name="audiences">The audiences found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns><see langword="true"/> if the audience is valid; otherwise, <see langword="false"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyResolver"> <summary> Resolves the signing key used for validating a token's signature. </summary> <param name="token">The string representation of the token being validated.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated, which may be null.</param> <param name="kid">The key identifier, which may be null.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns>The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used to validate the signature.</returns> <remarks>If both <see cref="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyResolverUsingConfiguration"/> and <see cref="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyResolver"/> are set, <see cref="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyResolverUsingConfiguration"/> takes priority.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyResolverUsingConfiguration"> <summary> Resolves the signing key using additional configuration. </summary> <param name="token">The string representation of the token being validated.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated, which may be null.</param> <param name="kid">The key identifier, which may be null.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="configuration">The configuration required for validation.</param> <returns>The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used to validate the signature.</returns> <remarks>If both <see cref="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyResolverUsingConfiguration"/> and <see cref="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyResolver"/> are set, <see cref="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyResolverUsingConfiguration"/> takes priority.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyValidator"> <summary> Validates the signing key used for the security token. </summary> <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used to sign the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns><see langword="true"/> if the signing key is valid; otherwise, <see langword="false"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyValidatorUsingConfiguration"> <summary> Validates the signing key using additional configuration. </summary> <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used to sign the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="configuration">The configuration required for validation.</param> <returns><see langword="true"/> if the signing key is valid; otherwise, <see langword="false"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.IssuerValidator"> <summary> Validates the issuer of the security token. </summary> <param name="issuer">The issuer to be validated.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns>The validated issuer to use when creating claims.</returns> <remarks>The delegate should return a non-null string that represents the issuer. If null, a default value will be used. If both <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidatorUsingConfiguration"/> and <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidator"/> are set, <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidatorUsingConfiguration"/> takes priority.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.IssuerValidatorUsingConfiguration"> <summary> Validates the issuer using additional configuration. </summary> <param name="issuer">The issuer to be validated.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="configuration">The configuration required for validation.</param> <returns>The validated issuer to use when creating claims.</returns> <remarks>The delegate should return a non-null string that represents the issuer. If null, a default value will be used. If both <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidatorUsingConfiguration"/> and <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidator"/> are set, <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidatorUsingConfiguration"/> takes priority.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.IssuerValidatorAsync"> <summary> Asynchronously validates the issuer of the security token. </summary> <param name="issuer">The issuer to be validated.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns>A task that represents the asynchronous operation, containing the validated issuer to use when creating claims.</returns> <remarks>The delegate should return a non-null string that represents the issuer. If null, a default value will be used. <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidatorAsync"/> will be called before <see cref="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyValidatorUsingConfiguration"/> or <see cref="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyValidator"/> if set.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.LifetimeValidator"> <summary> Validates the lifetime of the security token. </summary> <param name="notBefore">The 'not before' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="expires">The 'expiration' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns><see langword="true"/> if the lifetime is valid; otherwise, <see langword="false"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.TokenReplayValidator"> <summary> Validates the replay of the security token. </summary> <param name="expirationTime">The 'expiration' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns><see langword="true"/> if the token replay is valid; otherwise, <see langword="false"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.SignatureValidator"> <summary> Validates the signature of the security token. </summary> <param name="token">The security token with a signature.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns>The validated <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.SignatureValidatorUsingConfiguration"> <summary> Validates the signature using additional configuration. </summary> <param name="token">The security token with a signature.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="configuration">The configuration required for validation.</param> <returns>The validated <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.TokenReader"> <summary> Reads the security token. </summary> <param name="token">The security token.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns>The read <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.TokenDecryptionKeyResolver"> <summary> Resolves the decryption key for the security token. </summary> <param name="token">The string representation of the token to be decrypted.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> to be decrypted, which is null by default.</param> <param name="kid">The key identifier, which may be null.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns>The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used to decrypt the token.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.TypeValidator"> <summary> Validates the type of the security token. </summary> <param name="type">The token type to be validated.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns>The actual token type, which may be the same as <paramref name="type"/> or a different value if the token type was resolved from a different location.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.TransformBeforeSignatureValidation"> <summary> Transforms the security token before signature validation. </summary> <param name="token">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns>The transformed <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.ECDsaAdapter"> <summary> This adapter abstracts the <see cref="T:System.Security.Cryptography.ECDsa"/> differences between versions of .NET targets. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.ECDsaAdapter"/> class. </summary> <exception cref="T:System.PlatformNotSupportedException"> <see cref="T:System.Security.Cryptography.ECDsa"/> creation is not supported by some platforms. For more details, see https://aka.ms/IdentityModel/create-ecdsa. </exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.CreateECDsa(Microsoft.IdentityModel.Tokens.JsonWebKey,System.Boolean)"> <summary> Creates an ECDsa object using the <paramref name="jsonWebKey"/> and <paramref name="usePrivateKey"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.GetKeyByteCount(System.String)"> <summary> Determines the key size in bytes based on the specified ECDSA curve identifier. </summary> <param name="curveId">The identifier of the ECDSA curve (P256, P384, P521).</param> <returns>The size of the key in bytes.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.ECDsaAdapter.KeyBlobMagicNumber"> <summary> Magic numbers identifying ECDSA blob types. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.GetMagicValue(System.String,System.Boolean)"> <summary> Returns the magic value representing the curve corresponding to the curve identifier. </summary> <param name="curveId">The identifier of the ECDSA curve (P256, P384, P521).</param> <param name="willCreateSignatures">If true, the provider will be used for creating signatures.</param> <returns>A <see langword="uint"/> representing the magic number.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.CreateECDsaUsingECParams(Microsoft.IdentityModel.Tokens.JsonWebKey,System.Boolean)"> <summary> Creates an ECDsa object using the <paramref name="jsonWebKey"/> and <paramref name="usePrivateKey"/>. 'ECParameters' structure is available in .NET Framework 4.7+, .NET Standard 1.6+, and .NET Core 1.0+. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.GetNamedECCurve(System.String)"> <summary> Returns the elliptic curve corresponding to the curve identifier. </summary> <param name="curveId">The identifier of the ECDSA curve (P256, P384, P521).</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.SupportsECParameters"> <summary> Determines whether user application's runtime supports <see cref="T:System.Security.Cryptography.ECParameters"/> structure. </summary> <returns><see langword="true"/> if <see cref="T:System.Security.Cryptography.ECParameters"/> structure is supported; Otherwise <see langword="false"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.LoadECParametersType"> <summary> Throws <see cref="T:System.TypeLoadException"/> during runtime if user application's runtime doesn't support <see cref="T:System.Security.Cryptography.ECParameters"/> structure. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey"> <summary> Represents a ECDsa security key. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.#ctor(System.Security.Cryptography.ECDsa)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey"/> class. </summary> <param name="ecdsa">The <see cref="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.ECDsa"/>.</param> </member> <member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.ECDsa"> <summary> The <see cref="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.ECDsa"/> instance used to initialize the key. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.HasPrivateKey"> <summary> Gets a bool indicating if a private key exists. </summary> <return><see langword="true"/> if it has a private key; otherwise, <see langword="false"/>.</return> </member> <member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.PrivateKeyStatus"> <summary> Gets a value indicating the existence of the private key. </summary> <returns> <see cref="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.Exists"/> if the private key exists. <see cref="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.DoesNotExist"/> if the private key does not exist. <see cref="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.Unknown"/> if the existence of the private key cannot be determined. </returns> </member> <member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.KeySize"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.ECDsa"/> key size. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.CanComputeJwkThumbprint"> <summary> Determines whether the <see cref="T:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey"/> can compute a JWK thumbprint. </summary> <returns><see langword="true"/> if JWK thumbprint can be computed; otherwise, <see langword="false"/>.</returns> <remarks>See: <see href="https://datatracker.ietf.org/doc/html/rfc7638"/>.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.ComputeJwkThumbprint"> <summary> Computes a SHA256 hash over the <see cref="T:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey"/>. </summary> <returns>A JWK thumbprint.</returns> <remarks>See: <see href="https://datatracker.ietf.org/doc/html/rfc7638"/>.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.EncodingUtils"> <summary> Collection of text encoding-related helper methods. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EncodingUtils.PerformEncodingDependentOperation``1(System.String,System.Text.Encoding,System.Func{System.Byte[],System.Int32,``0})"> <summary> Obtains bytes from a string using the specified encoding and then performs an action on the resulting byte array. </summary> <typeparam name="T">The return type of the operation.</typeparam> <param name="input">The string to process.</param> <param name="encoding">The encoding used to obtain bytes from the string.</param> <param name="action">The operation to invoke with the result, which is a byte array and the length of useful data in the array (with offset as 0).</param> <returns>An instance of {T}.</returns> <remarks> The encoding operation uses a shared memory pool to avoid allocations. The length of the rented array of bytes may be larger than the actual encoded bytes; therefore, the action needs to know the actual length to use. The result of <see cref="M:System.Text.Encoding.GetBytes(System.String,System.Int32,System.Int32,System.Byte[],System.Int32)"/> is passed to the action. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.EncodingUtils.PerformEncodingDependentOperation``1(System.String,System.Int32,System.Int32,System.Text.Encoding,System.Func{System.Byte[],System.Int32,``0})"> <summary> Obtains bytes from a string using the specified encoding and then performs an action on the resulting byte array. </summary> <typeparam name="T">The return type of the operation.</typeparam> <param name="input">The string to process.</param> <param name="offset">The index to start from in <paramref name="input"/>.</param> <param name="length">The length of characters to operate on in <paramref name="input"/> from <paramref name="offset"/>.</param> <param name="encoding">The encoding used to obtain bytes from the string.</param> <param name="action">The operation to invoke with the result, which is a byte array and the length of useful data in the array (with offset as 0).</param> <returns>An instance of {T}.</returns> <remarks> The encoding operation uses a shared memory pool to avoid allocations. The length of the rented array of bytes may be larger than the actual encoded bytes; therefore, the action needs to know the actual length to use. The result of <see cref="M:System.Text.Encoding.GetBytes(System.String,System.Int32,System.Int32,System.Byte[],System.Int32)"/> is passed to the action. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.EncodingUtils.PerformEncodingDependentOperation``4(System.String,System.Int32,System.Int32,System.Text.Encoding,``1,``2,``3,System.Func{System.Byte[],System.Int32,``1,``2,``3,``0})"> <summary> Obtains bytes from a string using the specified encoding and then performs an action on the resulting byte array. </summary> <typeparam name="T">The return type of the operation.</typeparam> <typeparam name="TX">The type of the first input parameter to the action.</typeparam> <typeparam name="TY">The type of the second input parameter to the action.</typeparam> <typeparam name="TZ">The type of the third input parameter to the action.</typeparam> <param name="input">The string to process.</param> <param name="offset">The index to start from in <paramref name="input"/>.</param> <param name="length">The length of characters to operate on in <paramref name="input"/> from <paramref name="offset"/>.</param> <param name="encoding">The encoding used to obtain bytes from the string.</param> <param name="argx">The first input parameter to the action.</param> <param name="argy">The second input parameter to the action.</param> <param name="argz">The third input parameter to the action.</param> <param name="action">The action to perform with the resulting byte array and the length of useful data in the array.</param> <returns>An instance of {T}.</returns> <remarks> The encoding operation uses a shared memory pool to avoid allocations. The length of the rented array of bytes may be larger than the actual encoded bytes; therefore, the action needs to know the actual length to use. The result of <see cref="M:System.Text.Encoding.GetBytes(System.String,System.Int32,System.Int32,System.Byte[],System.Int32)"/> is passed to the action. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.EncodingUtils.PerformEncodingDependentOperation``2(System.String,System.Text.Encoding,``1,System.Func{System.Byte[],System.Int32,``1,``0})"> <summary> Encodes the string using the given encoding and invokes the operation with the resulting byte array. </summary> <typeparam name="T">The return type of the operation.</typeparam> <typeparam name="TX">The type of the input parameter to the operation.</typeparam> <param name="input">The string to process.</param> <param name="encoding">The encoding used to obtain bytes from the string.</param> <param name="parameter">The additional parameter for the operation.</param> <param name="action">The operation to invoke with the resulting byte array and the length of useful data in the array.</param> <returns>The result of the operation.</returns> <remarks> The encoding operation uses a shared memory pool to avoid allocations. The length of the rented array of bytes may be larger than the actual encoded bytes; therefore, the action needs to know the actual length to use. The result of <see cref="M:System.Text.Encoding.GetBytes(System.String,System.Int32,System.Int32,System.Byte[],System.Int32)"/> is passed to the action. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.EncodingUtils.PerformEncodingDependentOperation``2(System.String,System.Int32,System.Int32,System.Text.Encoding,``1,System.Func{System.Byte[],System.Int32,``1,``0})"> <summary> Obtains bytes from a string using the specified encoding and then performs an action on the resulting byte array. </summary> <typeparam name="T">The return type of the operation.</typeparam> <typeparam name="TX">The type of the input parameter to the operation.</typeparam> <param name="input">The string to process.</param> <param name="offset">The index to start from in <paramref name="input"/>.</param> <param name="length">The length of characters to operate on in <paramref name="input"/> from <paramref name="offset"/>.</param> <param name="encoding">The encoding used to obtain bytes from the string.</param> <param name="parameter">The additional parameter for the operation.</param> <param name="action">The operation to invoke with the resulting byte array and the length of useful data in the array.</param> <returns>An instance of {T}.</returns> <remarks> The encoding operation uses a shared memory pool to avoid allocations. The length of the rented array of bytes may be larger than the actual encoded bytes; therefore, the action needs to know the actual length to use. The result of <see cref="M:System.Text.Encoding.GetBytes(System.String,System.Int32,System.Int32,System.Byte[],System.Int32)"/> is passed to the action. </remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"> <summary> A class for properties that are used for token encryption. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EncryptingCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> class. </summary> <param name="certificate">The <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> used to encrypt data.</param> <param name="alg">A key wrap algorithm to use when encrypting a session key.</param> <param name="enc">The encryption algorithm to be used.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="certificate"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="alg"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="enc"/> is null or empty.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.EncryptingCredentials.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> class. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for encryption.</param> <param name="alg">A key wrap algorithm to use when encrypting a session key.</param> <param name="enc">The encryption algorithm to be used.</param> <exception cref="T:System.ArgumentNullException">if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="alg"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="enc"/> is null or empty.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.EncryptingCredentials.#ctor(Microsoft.IdentityModel.Tokens.SymmetricSecurityKey,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> class. </summary> <remarks> Used in scenarios when a key represents a 'shared' symmetric key. For example, SAML 2.0 Assertion will be encrypted using a provided symmetric key which won't be serialized to a SAML token. </remarks> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> to use for encryption.</param> <param name="enc">The encryption algorithm to be used.</param> <exception cref="T:System.ArgumentException">Thrown if <paramref name="key"/> is not a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="enc"/> is null or empty.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Alg"> <summary> Gets the key wrap algorithm used for session key encryption. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"> <summary> Gets the data encryption algorithm. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.KeyExchangePublicKey"> <summary> Gets or sets the public key used in Key Agreement Algorithms. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"> <summary> Users can override the default <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"/> with this property. This factory will be used for creating encryption providers. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.SetDefaultCtyClaim"> <summary> Gets or sets a bool that controls if the encrypted token creation will set default 'cty' if not specified. </summary> <remarks> Applies to only JWT tokens. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"> <summary> Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used for encryption. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"> <summary> Provides authenticated encryption and decryption services. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/> class used for encryption and decryption. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for crypto operations.</param> <param name="algorithm">The encryption algorithm to be used.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or whitespace.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if the key size is not large enough.</exception> <exception cref="T:System.ArgumentException">Thrown if <paramref name="algorithm"/> is not supported.</exception> <exception cref="T:System.ArgumentException">Thrown if a symmetricSignatureProvider is not created.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Algorithm"> <summary> Gets the encryption algorithm that is being used. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Context"> <summary> Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/>. </summary> <remarks>This is null by default. This can be used by applications for extensibility scenarios.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Key"> <summary> Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[])"> <summary> Encrypts the specified plaintext. </summary> <param name="plaintext">The data to be encrypted.</param> <param name="authenticatedData">Will be combined with the initialization vector and ciphertext to create an authentication tag.</param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult"/> the containing ciphertext, initialization vector, the and authentication tag.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plaintext"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="authenticatedData"/> is null or empty.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">Thrown if AES crypto operation threw. See inner exception for details.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if the internal <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> is disposed.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[],System.Byte[])"> <summary> Encrypts the specified plaintext. </summary> <param name="plaintext">The data to be encrypted.</param> <param name="iv">The initialization vector to be used with the encryption algorithm.</param> <param name="authenticatedData">Will be combined with the initialization vector and ciphertext to create an authentication tag.</param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult"/> containing the ciphertext, initialization vector, and the authentication tag.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plaintext"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="authenticatedData"/> is null or empty.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">Thrown if AES crypto operation threw. See inner exception for details.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if the internal <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> is disposed.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Decrypt(System.Byte[],System.Byte[],System.Byte[],System.Byte[])"> <summary> Decrypts ciphertext into plaintext. </summary> <param name="ciphertext">The encrypted text to be decrypted.</param> <param name="authenticatedData">The authenticate data that is used in verification.</param> <param name="iv">The initialization vector used when creating the ciphertext.</param> <param name="authenticationTag">The authentication tag that was created during the encyption.</param> <returns>The decrypted ciphertext.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="ciphertext"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="authenticatedData"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="iv"/> is null or empty.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="authenticationTag"/> is null or empty.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">Thrown if the signature over the authenticationTag fails to verify.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">Thrown if the AES crypto operation threw. See inner exception for details.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if the internal <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> is disposed.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Dispose"> <summary> Calls <see cref="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Dispose(System.Boolean)"/> and <see cref="M:System.GC.SuppressFinalize(System.Object)"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Dispose(System.Boolean)"> <summary> Releases managed resources. </summary> <param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.IsSupportedAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Checks if the key/algorithm pair is supported. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.</param> <param name="algorithm">The algorithm to check.</param> <returns><see langword="true"/> if the key/algorithm pair is supported.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.GetHmacAlgorithm(System.String)"> <summary> The algorithm parameter logically defines a HMAC algorithm. This method returns the HMAC to use. </summary> <param name="algorithm">The name of the algorithm for HMAC.</param> <returns>The name of the HMAC algorithm.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.GetKeyBytes(Microsoft.IdentityModel.Tokens.SecurityKey)"> <summary> Called to obtain the byte[] needed to create a <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/>. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used to obtain the byte[].</param> <returns><see cref="T:System.Byte"/>[] that is used to populated the KeyedHashAlgorithm.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentException">Thrown if a byte[] can not be obtained from SecurityKey.</exception> <remarks><see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> are supported. <para>For a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>, <see cref="P:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey.Key"/> is returned</para> <para>For a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>, <see cref="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.DecodeBytes(System.String)"/> is called with <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKey.K"/> if <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Kty"/> == JsonWebAlgorithmsKeyTypes.Octet.</para> </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.ValidateKeySize(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Checks that the key has sufficient length. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that contains bytes.</param> <param name="algorithm">The encryption algorithm to be used.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null or empty.</exception> <exception cref="T:System.ArgumentException">Thrown if <paramref name="algorithm"/> is not a supported algorithm.</exception> </member> <member name="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult"> <summary> Contains the results of <see cref="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[])"/> operation. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.Byte[],System.Byte[],System.Byte[])"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult"/> class. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used during <see cref="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[])"/>.</param> <param name="ciphertext">The encrypted text.</param> <param name="iv">The initialization vector used.</param> <param name="authenticationTag">The authentication tag that was created during the encyption and needs <see cref="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Decrypt(System.Byte[],System.Byte[],System.Byte[],System.Byte[])"/>.</param> </member> <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.Key"> <summary> Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.Ciphertext"> <summary> Gets the Ciphertext. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.IV"> <summary> Gets the initialization vector. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.AuthenticationTag"> <summary> Gets the authentication tag. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.EcdhKeyExchangeProvider"> <summary> Provides a Security Key that can be used as Content Encryption Key (CEK) for use with a JWE </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.EcdhKeyExchangeProvider.KeyDataLen"> <summary> Number of bits in the desired output key </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EcdhKeyExchangeProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.EcdhKeyExchangeProvider"/> used for CEKs <param name="privateKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for cryptographic operations and represents the private key.</param> <param name="publicKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for cryptographic operations and represents the public key.</param> <param name="alg">alg header parameter value.</param> <param name="enc">enc header parameter value.</param> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EcdhKeyExchangeProvider.GenerateKdf(System.String,System.String)"> <summary> Generates the KDF </summary> <param name="apu">Agreement PartyUInfo (optional). When used, the PartyVInfo value contains information about the producer, represented as a base64url-encoded string.</param> <param name="apv">Agreement PartyVInfo (optional). When used, the PartyUInfo value contains information about the recipient, represented as a base64url-encoded string.</param> <returns>Returns <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that represents the key generated</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"> <summary> Provides Wrap and Unwrap key services. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Algorithm"> <summary> Gets the KeyWrap algorithm that is being used. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Context"> <summary> Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>. </summary> <remarks>This is null by default. This can be used by runtimes or for extensibility scenarios.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Key"> <summary> Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose"> <summary> Calls <see cref="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)"/> and <see cref="M:System.GC.SuppressFinalize(System.Object)"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)"> <summary> Can be overridden in descendants to dispose of internal components. </summary> <param name="disposing">true if called from Dispose(), false if invoked inside a finalizer.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.UnwrapKey(System.Byte[])"> <summary> Unwraps a key. </summary> <param name="keyBytes">The key to unwrap.</param> <returns>The unwrapped key.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.WrapKey(System.Byte[])"> <summary> Wraps a key. </summary> <param name="keyBytes">The key to be wrapped.</param> <returns>The wrapped key.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"> <summary> Provides RSA Wrap key and Unwrap key services. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> class used for wrapping and unwrapping keys. These keys are usually symmetric session keys that are wrapped using the recipient's public key. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for cryptographic operations.</param> <param name="algorithm">The KeyWrap algorithm to be used.</param> <param name="willUnwrap">Whether this <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> is required to unwrap keys. If true, the private key is required.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null.</exception> <exception cref="T:System.ArgumentException">Thrown if the key size doesn't match the algorithm.</exception> <exception cref="T:System.ArgumentException">Thrown if the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and <paramref name="algorithm"/> pair are not supported.</exception> <exception cref="T:System.NotSupportedException">Thrown if failed to create RSA algorithm with the provided key and algorithm.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Algorithm"> <summary> Gets the KeyWrap algorithm that is being used. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Context"> <summary> Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>. </summary> <remarks>This is null by default. This is for use by the application and not used by this SDK.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Key"> <summary> Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Dispose(System.Boolean)"> <summary> Releases the resources used by the current instance. </summary> <param name="disposing">If true, release both managed and unmanaged resources; otherwise, release only unmanaged resources.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.IsSupportedAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Checks if the specified algorithm is supported. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for cryptographic operations.</param> <param name="algorithm">The KeyWrap algorithm to be used.</param> <returns>true if the algorithm is supported; otherwise, false.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.UnwrapKey(System.Byte[])"> <summary> Unwraps a key using RSA decryption. </summary> <param name="keyBytes">The bytes to unwrap.</param> <returns>The unwrapped key.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="keyBytes"/> is null or has a length of 0.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if <see cref="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Thrown if the key unwrapping operation fails.</exception> <exception cref="T:System.InvalidOperationException">Thrown if the internal RSA algorithm is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.WrapKey(System.Byte[])"> <summary> Wraps a key using RSA encryption. </summary> <param name="keyBytes">The key to be wrapped.</param> <returns>A wrapped key.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="keyBytes"/> is null or has a length of 0.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if <see cref="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Thrown if the key wrapping operation fails.</exception> <exception cref="T:System.InvalidOperationException">Thrown if the internal RSA algorithm is null.</exception> </member> <member name="T:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider"> <summary> Provides Wrap and Unwrap key services. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> class used for wrapping and unwrapping keys. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for cryptographic operations.</param> <param name="algorithm">The KeyWrap algorithm to be used.</param> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm"/> is null.</exception> <exception cref="T:System.ArgumentException">Thrown if the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception> <exception cref="T:System.ArgumentException">Thrown if the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> cannot be converted to a byte array.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if the key size doesn't match the algorithm.</exception> <exception cref="T:System.InvalidOperationException">Thrown if failed to create a symmetric algorithm with the provided key and algorithm.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Algorithm"> <summary> Gets the KeyWrap algorithm that is being used. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Context"> <summary> Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>. </summary> <remarks>This is null by default. This can be used by runtimes or for extensibility scenarios.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Key"> <summary> Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Dispose(System.Boolean)"> <summary> Releases the resources used by the current instance. </summary> <param name="disposing">If true, release both managed and unmanaged resources; otherwise, release only unmanaged resources.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.GetSymmetricAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Returns the <see cref="T:System.Security.Cryptography.SymmetricAlgorithm"/>. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for cryptographic operations.</param> <param name="algorithm">The encryption algorithm to be used.</param> <returns>The initialized <see cref="T:System.Security.Cryptography.SymmetricAlgorithm"/>.</returns> <exception cref="T:System.ArgumentException">Thrown if the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> cannot be converted to a byte array.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if the key size doesn't match the algorithm.</exception> <exception cref="T:System.InvalidOperationException">Thrown if failed to create a symmetric algorithm with the provided key and algorithm.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.IsSupportedAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Determines whether the specified algorithm is supported. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for cryptographic operations.</param> <param name="algorithm">The algorithm to check for support.</param> <returns><see langword="true"/> if the algorithm is supported; otherwise, <see langword="false"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.UnwrapKey(System.Byte[])"> <summary> Unwraps a key using symmetric decryption. </summary> <param name="keyBytes">The bytes to unwrap.</param> <returns>The unwrapped key.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="keyBytes"/> is null or has a length of 0.</exception> <exception cref="T:System.ArgumentException">Thrown if <paramref name="keyBytes"/> is not a multiple of 8.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if <see cref="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Thrown if the key unwrapping operation fails.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.WrapKey(System.Byte[])"> <summary> Wraps a key using symmetric encryption. </summary> <param name="keyBytes">The key to be wrapped.</param> <returns>The wrapped key.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="keyBytes"/> is null or has a length of 0.</exception> <exception cref="T:System.ArgumentException">Thrown if <paramref name="keyBytes"/> is not a multiple of 8.</exception> <exception cref="T:System.ObjectDisposedException">Thrown if <see cref="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Thrown if the key wrapping operation fails.</exception> </member> <member name="T:Microsoft.IdentityModel.Tokens.EpochTime"> <summary> Returns the absolute DateTime or the Seconds since Unix Epoch, where Epoch is UTC 1970-01-01T0:0:0Z. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.EpochTime.UnixEpoch"> <summary> DateTime as UTV for UnixEpoch </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EpochTime.GetIntDate(System.DateTime)"> <summary> Gets the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the desired date/time. </summary> <param name="datetime">The DateTime to convert to seconds.</param> <remarks>If <paramref name="datetime"/> is less than Unix Epoch, returns 0.</remarks> <returns>The number of seconds since Unix Epoch.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.EpochTime.DateTime(System.Int64)"> <summary> Creates a <see cref="M:Microsoft.IdentityModel.Tokens.EpochTime.DateTime(System.Int64)"/> from epoch time. </summary> <param name="secondsSinceUnixEpoch">The number of seconds since Unix Epoch.</param> <returns>The DateTime in UTC.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2"> <summary> This is an LRU cache implementation that relies on an event queue rather than locking to achieve thread safety. This approach has been decided on in order to optimize the performance of the get and set operations on the cache. This cache contains a doubly linked list in order to maintain LRU order, as well as a dictionary (map) to keep track of keys and expiration times. The linked list (a structure which is not thread-safe) is NEVER modified directly inside an API call (e.g. get, set, remove); it is only ever modified sequentially by a background thread. On the other hand, the map is a <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2"/> which may be modified directly inside an API call or through eventual processing of the event queue. This implementation relies on the principle of 'eventual consistency': though the map and it's corresponding linked list may be out of sync at any given point in time, they will eventually line up. See here for more details: https://aka.ms/identitymodel/caching </summary> <typeparam name="TKey">The key type to be used by the cache.</typeparam> <typeparam name="TValue">The value type to be used by the cache</typeparam> </member> <member name="P:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.OnItemRemoved"> <summary> For back compat any friend would be broken, this is the same as OnItemExpired. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.#ctor(System.Int32,System.Threading.Tasks.TaskCreationOptions,System.Collections.Generic.IEqualityComparer{`0},System.Boolean,System.Int32,System.Boolean,System.Int32)"> <summary> Constructor. </summary> <param name="capacity">The capacity of the cache, used to determine if experiencing overflow.</param> <param name="options">The event queue task creation option, default to None instead of LongRunning as LongRunning will always start a task on a new thread instead of ThreadPool.</param> <param name="comparer">The equality comparison implementation to be used by the map when comparing keys.</param> <param name="removeExpiredValues">Whether or not to remove expired items.</param> <param name="removeExpiredValuesIntervalInSeconds">The period to wait to remove expired items, in seconds.</param> <param name="maintainLRU">Whether or not to maintain items in a LRU fashion, moving to front of list when accessed in the cache.</param> <param name="compactIntervalInSeconds">The period to wait to compact items, in seconds.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.DomainProcessExit(System.Object,System.EventArgs)"> <summary> Occurs when the application is ready to exit. </summary> <param name="sender">The sender of the event.</param> <param name="e">The event argument.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.DomainUnload(System.Object,System.EventArgs)"> <summary> Occurs when an AppDomain is about to be unloaded. </summary> <param name="sender">The sender of the event.</param> <param name="e">The event argument.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.StopEventQueueTask"> <summary> Stop the event queue task. This is provided mainly for users who have unit tests that check for running task(s) to stop the task at the end of each test. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.StopEventQueueTaskImmediately"> <summary> Stop the event queue task immediately if it is running. This allows the task/thread to terminate gracefully. Currently there is no unmanaged resource, if any is added in the future it should be disposed of in this method. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.EventQueueTaskAction"> <summary> This is the delegate for the event queue task. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.RemoveExpiredValuesLRU"> <summary> Remove all expired cache items from _doubleLinkedList and _map. </summary> <returns>Number of items removed.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.RemoveExpiredValues"> <summary> Remove all expired cache items from the _map ONLY. This is called for the non-LRU (_maintainLRU = false) scenaro. The enumerator returned from the dictionary is safe to use concurrently with reads and writes to the dictionary, according to the MS document. </summary> <returns>Number of items removed.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.ProcessCompactedValues"> <summary> Remove all compacted items. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.CompactLRU"> <summary> Remove items from the LinkedList by the desired compaction percentage. This should be a private method. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.Compact"> <summary> Remove items from the Dictionary by the desired compaction percentage. Since _map does not have LRU order, items are simply removed from using FirstOrDefault(). </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.CalculateNewCacheSize"> <summary> When the cache is at _maxCapacityPercentage, it needs to be compacted by _compactionPercentage. This method calculates the new size of the cache after being compacted. </summary> <returns>The new target cache size after compaction.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.SetTaskEndTime"> <summary> This is the method that determines the end time for the event queue task. The goal is to be able to track the incoming events and predict how long the task should run in order to avoid a long running task and reduce the overhead costs of restarting tasks. For example, maybe we can track the last three events' time and set the _eventQueueRunDurationInSeconds = 2 * average_time_between_events. Note: tasks are based on thread pool so the overhead should not be huge but we should still try to minimize it. </summary> <returns>the time when the event queue task should end</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.StartEventQueueTaskIfNotRunning"> <summary> This method is called after an item is added to the event queue. It will start the event queue task if one is not already running (_eventQueueTaskState != EventQueueTaskRunning). Using CompareExchange to set the _eventQueueTaskState prevents multiple tasks from being started. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.TryGetValue(`0,`1@)"> Each time a node gets accessed, it gets moved to the beginning (head) of the list if the _maintainLRU == true </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.TryRemove(`0)"> Removes a particular key from the cache. </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.TryRemove(`0,`1@)"> Removes a particular key from the cache. </member> <member name="P:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.LinkedList"> <summary> FOR TESTING ONLY. </summary> <returns></returns> </member> <member name="P:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.LinkedListCount"> <summary> FOR TESTING ONLY. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.MapCount"> <summary> FOR TESTING ONLY. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.MapValues"> <summary> FOR TESTING ONLY. </summary> <returns></returns> </member> <member name="P:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.EventQueueCount"> <summary> FOR TESTING ONLY. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.TaskCount"> <summary> FOR TESTING PURPOSES ONLY. This is for tests to verify all tasks exit at the end of tests if the queue is empty. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.EventBasedLRUCache`2.WaitForProcessing"> <summary> FOR TESTING PURPOSES ONLY. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenArgumentException"> <summary> Throw this exception when a received <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> has invalid arguments. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenArgumentException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenArgumentException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenArgumentException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenArgumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenArgumentException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException"> <summary> Thrown when JWE compression fails. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException.#ctor"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException.#ctor(System.String)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException"> <summary> Thrown when JWE decompression fails. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException.#ctor"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException.#ctor(System.String)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"> <summary> Represents a security token exception when decryption failed. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException"> <summary> Represents a security token exception when encryption failed. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"> <summary> This exception is thrown when a security token contained a key identifier but the key was not found by the runtime when decrypting a token. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"> <summary> Represents a security token exception. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenException.StackTrace"> <summary> Gets the stack trace that is captured when the exception is created. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenException.Source"> <summary> Gets or sets the source of the exception. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> When overridden in a derived class, sets the System.Runtime.Serialization.SerializationInfo with information about the exception. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">thrown if <paramref name="info"/> is null.</exception> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException"> <summary> Throw this exception when a received Security Token has expiration time in the past. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.Expires"> <summary> Gets or sets the Expires value that created the validation exception. This value is always in UTC. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.#ctor"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.#ctor(System.String)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAlgorithmException"> <summary> This exception is thrown when a cryptographic algorithm is invalid. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAlgorithmException.InvalidAlgorithm"> <summary> Gets or sets the invalid algorithm that created the validation exception. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAlgorithmException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAlgorithmException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAlgorithmException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAlgorithmException"/> class. </summary> <param name="message">Additional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAlgorithmException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAlgorithmException"/> class. </summary> <param name="message">Additional information to be included in the exception and displayed to user.</param> <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAlgorithmException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAlgorithmException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException"> <summary> This exception is thrown when 'audience' of a token was not valid. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException.InvalidAudience"> <summary> Gets or sets the InvalidAudience that created the validation exception. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException"> <summary> This exception is thrown when 'issuer' of a token was not valid. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException.InvalidIssuer"> <summary> Gets or sets the InvalidIssuer that created the validation exception. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException"> <summary> This exception is thrown when 'lifetime' of a token was not valid. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.NotBefore"> <summary> Gets or sets the NotBefore value that created the validation exception. This value is always in UTC. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.Expires"> <summary> Gets or sets the Expires value that created the validation exception. This value is always in UTC. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException"> <summary> This exception is thrown when 'signature' of a token was not valid. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException"> <summary> Throw this exception when a received Security Token has an invalid issuer signing key. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException.SigningKey"> <summary> Gets or sets the SigningKey that was found invalid. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException.#ctor"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException.#ctor(System.String)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException"> <summary> This exception is thrown when the token type ('typ' header claim) of a JWT token is invalid. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException.InvalidType"> <summary> Gets or sets the invalid type that created the validation exception. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException"/> class. </summary> <param name="message">Additional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException"/> class. </summary> <param name="message">Additional information to be included in the exception and displayed to user.</param> <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException"> <summary> Represents a key wrap exception when encryption failed. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException"> <summary> Represents a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> exception when the token is malformed. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException"> <summary> This exception is thrown when a security is missing an ExpirationTime. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException"> <summary> Throw this exception when a received Security token has an effective time in the future. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException.NotBefore"> <summary> Gets or sets the NotBefore value that created the validation exception. This value is always in UTC. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException.#ctor"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException.#ctor(System.String)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException"> <summary> This exception is thrown when an add to the TokenReplayCache fails. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException"> <summary> Throw this exception when a received Security Token has been replayed. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException.#ctor"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException.#ctor(System.String)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"> <summary> This exception is thrown when a security token contained a key identifier but the key was not found by the runtime. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenUnableToValidateException"> <summary> This exception is thrown when a security token contained a key identifier but the key was not found by the runtime and when validation errors exist over the security token. This exception is not intended to be used as a signal to refresh keys. </summary> <remarks> This exception type is now considered obsolete and will be removed in the next major version (7.0.0). </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenUnableToValidateException.ValidationFailure"> <summary> Indicates the type of the validation failure. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenUnableToValidateException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenUnableToValidateException.#ctor(Microsoft.IdentityModel.Tokens.ValidationFailure,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class. </summary> <param name="validationFailure">The validation failures.</param> <param name="message">Addtional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenUnableToValidateException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenUnableToValidateException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class. </summary> <param name="message">Addtional information to be included in the exception and displayed to user.</param> <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenUnableToValidateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenUnableToValidateException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException"> <summary> Represents a security token validation exception. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException"/> class. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException"/> class. </summary> <param name="info">the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.ValidationFailure"> <summary> The reason for being unable to validate </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailure.None"> <summary> Indicates no validation failures </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailure.InvalidLifetime"> <summary> Indicates that the lifetime was invalid </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailure.InvalidIssuer"> <summary> Indicates that the issuer was invalid </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.ICompressionProvider"> <summary> Provides methods for compressing and decompressing data. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ICompressionProvider.Algorithm"> <summary> Gets the compression algorithm used by the provider. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ICompressionProvider.IsSupportedAlgorithm(System.String)"> <summary> Determines if a specified algorithm is supported by the provider. </summary> <param name="algorithm">The compression algorithm to check.</param> <returns><see langword="true"/> if the algorithm is supported; otherwise, <see langword="false"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.ICompressionProvider.Decompress(System.Byte[])"> <summary> Decompresses the specified byte array. </summary> <param name="value">The byte array to decompress.</param> <returns>A byte array containing the decompressed data.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.ICompressionProvider.Compress(System.Byte[])"> <summary> Compresses the specified byte array. </summary> <param name="value">The byte array to compress.</param> <returns>A byte array containing the compressed data.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.ICryptoProvider"> <summary> Provides extensibility for cryptographic operators. If custom operators are needed, <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> can be set to return these operators. This property will be checked before each creation. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"> <summary> Determines if a cryptographic operation is supported. </summary> <param name="algorithm">The algorithm that defines the cryptographic operator.</param> <param name="args">The arguments required by the cryptographic operator. May be null.</param> <returns><see langword="true"/> if the algorithm is supported; otherwise, <see langword="false"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"> <summary> Returns a cryptographic operator that supports the specified algorithm. </summary> <param name="algorithm">The algorithm that defines the cryptographic operator.</param> <param name="args">The arguments required by the cryptographic operator. May be null.</param> <returns>An object representing the cryptographic operator.</returns> <remarks>Call <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Release(System.Object)"/> when finished with the object.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Release(System.Object)"> <summary> Releases the object returned from <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/>. </summary> <param name="cryptoInstance">The object returned from <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/>.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache"> <summary> Defines a cache for crypto providers. Current support is limited to <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> only. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.#ctor"> <summary> Creates a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache"/> using the default <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.#ctor(Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions)"> <summary> Creates a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache"/> using the specified <paramref name="cryptoProviderCacheOptions"/>. </summary> <param name="cryptoProviderCacheOptions">The options used to configure the <see cref="T:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache"/>.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SignatureProvider)"> <summary> Returns the cache key to use when looking up an entry into the cache for a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> </summary> <param name="signatureProvider">the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to create the key for.</param> <exception cref="T:System.ArgumentNullException">if signatureProvider is null.</exception> <returns>the cache key to use for finding a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)"> <summary> Returns the 'key' that will be used to find a crypto provider in this cache. </summary> <param name="securityKey">the key that is used to by the crypto provider.</param> <param name="algorithm">the algorithm that is used by the crypto provider.</param> <param name="typeofProvider">the typeof the crypto provider obtained by calling object.GetType().</param> <exception cref="T:System.ArgumentNullException">if securityKey is null.</exception> <exception cref="T:System.ArgumentNullException">if algorithm is null or empty string.</exception> <exception cref="T:System.ArgumentNullException">if typeofProvider is null or empty string.</exception> <returns>the cache key to use for finding a crypto provider.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.TryAdd(Microsoft.IdentityModel.Tokens.SignatureProvider)"> <summary> Trys to adds a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to this cache. </summary> <param name="signatureProvider"><see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to cache.</param> <exception cref="T:System.ArgumentNullException">if signatureProvider is null.</exception> <returns> <c>true</c> if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was added, <c>false</c> if the cache already contained the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> or if <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> should not be cached. </returns> <remarks>if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> is added <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.CryptoProviderCache"/> will be set to 'this'.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.TryGetSignatureProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String,System.Boolean,Microsoft.IdentityModel.Tokens.SignatureProvider@)"> <summary> Trys to find a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to this cache. </summary> <param name="securityKey">the key that is used to by the crypto provider.</param> <param name="algorithm">the algorithm that is used by the crypto provider.</param> <param name="typeofProvider">the typeof the crypto provider obtained by calling object.GetType().</param> <param name="willCreateSignatures">If true, the provider will be used for creating signatures.</param> <param name="signatureProvider">the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> if found.</param> <exception cref="T:System.ArgumentNullException">if securityKey is null.</exception> <exception cref="T:System.ArgumentNullException">if algorithm is null or empty string.</exception> <exception cref="T:System.ArgumentNullException">if typeofProvider is null or empty string.</exception> <returns>true if a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was found, false otherwise.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.TryRemove(Microsoft.IdentityModel.Tokens.SignatureProvider)"> <summary> Trys to remove a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> from this cache. </summary> <param name="signatureProvider"><see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to remove.</param> <exception cref="T:System.ArgumentNullException">if signatureProvider is null.</exception> <returns>true if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was removed, false if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was not found.</returns> <remarks>if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> is removed <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.CryptoProviderCache"/> will be set to null.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.Dispose"> <summary> Calls <see cref="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.Dispose(System.Boolean)"/> and <see cref="M:System.GC.SuppressFinalize(System.Object)"/> Note: the EventBasedLRUCache is no longer being disposed of, but since this is a public class and can be used as base class of custom cache implementations, we need to keep it as some implementations may override Dispose(). </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.Dispose(System.Boolean)"> <summary> If <paramref name="disposing"/> is true, this method disposes of <see cref="F:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache._signingSignatureProviders"/> and <see cref="F:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache._verifyingSignatureProviders"/>. </summary> <param name="disposing">True if called from the <see cref="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.Dispose"/> method, false otherwise.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.LinkedListCountSigning"> <summary> FOR TESTING ONLY. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.LinkedListCountVerifying"> <summary> FOR TESTING ONLY. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.MapCountSigning"> <summary> FOR TESTING ONLY. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.MapCountVerifying"> <summary> FOR TESTING ONLY. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.EventQueueCountSigning"> <summary> FOR TESTING ONLY. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.EventQueueCountVerifying"> <summary> FOR TESTING ONLY. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.TaskCount"> <summary> FOR TESTING PURPOSES ONLY. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.InternalValidators"> <summary> Validators meant to be kept internal </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.InternalValidators.ValidateAfterSignatureFailed(Microsoft.IdentityModel.Tokens.SecurityToken,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Collections.Generic.IEnumerable{System.String},Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.BaseConfiguration)"> <summary> Called after signature validation has failed to avoid a metadata refresh </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator"> <summary> ISecurityTokenValidator </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator.CanReadToken(System.String)"> <summary> Returns true if the token can be read, false otherwise. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator.CanValidateToken"> <summary> Returns true if a token can be validated. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator.MaximumTokenSizeInBytes"> <summary> Gets and sets the maximum size in bytes, that a will be processed. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.SecurityToken@)"> <summary> Validates a token passed as a string using <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.ITokenReplayCache"> <summary> Interface that defines a simple cache for tacking replaying of security tokens. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ITokenReplayCache.TryAdd(System.String,System.DateTime)"> <summary> Try to add a securityToken. </summary> <param name="securityToken">the security token to add.</param> <param name="expiresOn">the time when security token expires.</param> <returns>true if the security token was successfully added.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.ITokenReplayCache.TryFind(System.String)"> <summary> Try to find securityToken </summary> <param name="securityToken">the security token to find.</param> <returns>true if the security token is found.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.JsonWebAlgorithmsKeyTypes"> <summary> Constants for JsonWebAlgorithms "kty" Key Type (sec 6.1) https://datatracker.ietf.org/doc/html/rfc7518#section-6.1 </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKey"> <summary> Represents a JSON Web Key as defined in https://datatracker.ietf.org/doc/html/rfc7517. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.#ctor"> <summary> Initializes an new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.Create(System.String)"> <summary> Returns a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>. </summary> <param name="json">A string that contains JSON Web Key parameters in JSON format.</param> <returns><see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/></returns> <exception cref="T:System.ArgumentNullException">If 'json' is null or empty.</exception> <exception cref="T:System.ArgumentException">If 'json' fails to deserialize.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.#ctor(System.String)"> <summary> Initializes an new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> from a json string. </summary> <param name="json">A string that contains JSON Web Key parameters in JSON format.</param> <exception cref="T:System.ArgumentNullException">If 'json' is null or empty.</exception> <exception cref="T:System.ArgumentException">If 'json' fails to deserialize.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.ConvertedSecurityKey"> <summary> If this was converted to or from a SecurityKey, this field will be set. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.ConvertKeyInfo"> <summary> If this was failed converted to a SecurityKey, this field will be set. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.AdditionalData"> <summary> When deserializing from JSON any properties that are not defined will be placed here. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Alg"> <summary> Gets or sets the 'alg' (KeyType). </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Crv"> <summary> Gets or sets the 'crv' (ECC - Curve). </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.D"> <summary> Gets or sets the 'd' (ECC - Private Key OR RSA - Private Exponent). </summary> <remarks>Value is formated as: Base64urlUInt</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.DP"> <summary> Gets or sets the 'dp' (RSA - First Factor CRT Exponent). </summary> <remarks>Value is formated as: Base64urlUInt</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.DQ"> <summary> Gets or sets the 'dq' (RSA - Second Factor CRT Exponent). </summary> <remarks>Value is formated as: Base64urlUInt</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.E"> <summary> Gets or sets the 'e' (RSA - Exponent). </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.K"> <summary> Gets or sets the 'k' (Symmetric - Key Value). </summary> Base64urlEncoding </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.KeyId"> <summary> Gets the key id of this <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.KeyOps"> <summary> Gets the 'key_ops' (Key Operations). </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Kid"> <summary> Gets or sets the 'kid' (Key ID).. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Kty"> <summary> Gets or sets the 'kty' (Key Type). </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.N"> <summary> Gets or sets the 'n' (RSA - Modulus). </summary> <remarks>Value is formatted as: Base64urlEncoding</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Oth"> <summary> Gets or sets the 'oth' (RSA - Other Primes Info). </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.P"> <summary> Gets or sets the 'p' (RSA - First Prime Factor).. </summary> <remarks>Value is formatted as: Base64urlUInt</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Q"> <summary> Gets or sets the 'q' (RSA - Second Prime Factor).. </summary> <remarks>Value is formatted as: Base64urlUInt</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.QI"> <summary> Gets or sets the 'qi' (RSA - First CRT Coefficient).. </summary> <remarks>Value is formatted as: Base64urlUInt</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Use"> <summary> Gets or sets the 'use' (Public Key Use).. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.X"> <summary> Gets or sets the 'x' (ECC - X Coordinate).. </summary> <remarks>Value is formatted as: Base64urlEncoding</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.X5c"> <summary> Gets the 'x5c' collection (X.509 Certificate Chain).. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.X5t"> <summary> Gets or sets the 'x5t' (X.509 Certificate SHA-1 thumbprint).. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.X5tS256"> <summary> Gets or sets the 'x5t#S256' (X.509 Certificate SHA-256 thumbprint).. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.X5u"> <summary> Gets or sets the 'x5u' (X.509 URL).. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Y"> <summary> Gets or sets the 'y' (ECC - Y Coordinate).. </summary> <remarks>Value is formatted as: Base64urlEncoding</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.KeySize"> <summary> Gets the key size of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.HasPrivateKey"> <summary> Gets a bool indicating if a private key exists. </summary> <return>true if it has a private key; otherwise, false.</return> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.CanComputeJwkThumbprint"> <summary> Determines whether the <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> can compute a JWK thumbprint. </summary> <returns><c>true</c> if JWK thumbprint can be computed; otherwise, <c>false</c>.</returns> <remarks>https://datatracker.ietf.org/doc/html/rfc7638</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.ComputeJwkThumbprint"> <summary> Computes the JWK thumprint per spec: https://datatracker.ietf.org/doc/html/rfc7638 />. </summary> <returns>A the JWK thumbprint.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.RepresentAsAsymmetricPublicJwk"> <summary> Creates a JsonWebKey representation of an asymmetric public key. </summary> <returns>JsonWebKey representation of an asymmetric public key.</returns> <remarks>https://datatracker.ietf.org/doc/html/rfc7800#section-3.2</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.ToString"> <summary> Returns the formatted string: GetType(), Use: 'value', Kid: 'value', Kty: 'value', InternalId: 'value'. </summary> <returns>string</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter"> <summary> Converts a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> Supports: converting to a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> from one of: <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/>, <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/>, and <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter.ConvertFromSecurityKey(Microsoft.IdentityModel.Tokens.SecurityKey)"> <summary> Converts a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> </summary> <param name="key">a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to convert.</param> <returns>a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/></returns> <exception cref="T:System.ArgumentNullException">if <paramref name="key"/>is null.</exception> <exception cref="T:System.NotSupportedException">if <paramref name="key"/>is not a supported type.</exception> <remarks>Supports: <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/>, <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> and <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter.ConvertFromRSASecurityKey(Microsoft.IdentityModel.Tokens.RsaSecurityKey)"> <summary> Converts a <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> </summary> <param name="key">a <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/> to convert.</param> <returns>a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/></returns> <exception cref="T:System.ArgumentNullException">if <paramref name="key"/>is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter.ConvertFromX509SecurityKey(Microsoft.IdentityModel.Tokens.X509SecurityKey)"> <summary> Converts a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> </summary> <param name="key">a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> to convert.</param> <returns>a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/></returns> <exception cref="T:System.ArgumentNullException">if <paramref name="key"/>is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter.ConvertFromX509SecurityKey(Microsoft.IdentityModel.Tokens.X509SecurityKey,System.Boolean)"> <summary> Converts a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>. </summary> <param name="key">a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> to convert.</param> <param name="representAsRsaKey"> <c>true</c> to represent the <paramref name="key"/> as an <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/>, <c>false</c> to represent the <paramref name="key"/> as an <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/>, using the "x5c" parameter. </param> <returns>a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>.</returns> <exception cref="T:System.ArgumentNullException">if <paramref name="key"/>is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter.ConvertFromSymmetricSecurityKey(Microsoft.IdentityModel.Tokens.SymmetricSecurityKey)"> <summary> Converts a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> </summary> <param name="key">a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> to convert.</param> <returns>a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/></returns> <exception cref="T:System.ArgumentNullException">if <paramref name="key"/>is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter.ConvertFromECDsaSecurityKey(Microsoft.IdentityModel.Tokens.ECDsaSecurityKey)"> <summary> Converts a <see cref="T:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> </summary> <param name="key">an <see cref="T:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey"/> to convert.</param> <returns>a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/></returns> <exception cref="T:System.ArgumentNullException">if <paramref name="key"/>is null.</exception> </member> <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeyECTypes"> <summary> Constants for JsonWebKey Elliptical Curve Types https://datatracker.ietf.org/doc/html/rfc7518#section-6.2.1.1 </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeyParameterNames"> <summary> JsonWebKey parameter names see: https://datatracker.ietf.org/doc/html/rfc7517 </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeyParameterUtf8Bytes"> <summary> JsonWebKey parameter names as UTF8 bytes Used by UTF8JsonReader/Writer for performance gains. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet"> <summary> Contains a collection of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> that can be populated from a json string. </summary> <remarks>provides support for https://datatracker.ietf.org/doc/html/rfc7517.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.Create(System.String)"> <summary> Returns a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet"/>. </summary> <param name="json">a string that contains JSON Web Key parameters in JSON format.</param> <returns><see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet"/></returns> <exception cref="T:System.ArgumentNullException">If 'json' is null or empty.</exception> <exception cref="T:System.ArgumentException">If 'json' fails to deserialize.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.#ctor"> <summary> Initializes an new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.#ctor(System.String)"> <summary> Initializes an new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet"/> from a json string. </summary> <param name="json">a json string containing values.</param> <exception cref="T:System.ArgumentNullException">If 'json' is null or empty.</exception> <exception cref="T:System.ArgumentException">If 'json' fails to deserialize.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKeySet.AdditionalData"> <summary> When deserializing from JSON any properties that are not defined will be placed here. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKeySet.Keys"> <summary> Gets the <see cref="T:System.Collections.Generic.IList`1"/>. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.JsonWebKeySet.DefaultSkipUnresolvedJsonWebKeys"> <summary> Default value for the flag that controls whether unresolved JsonWebKeys will be included in the resulting collection of <see cref="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.GetSigningKeys"/> method. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKeySet.SkipUnresolvedJsonWebKeys"> <summary> Flag that controls whether unresolved JsonWebKeys will be included in the resulting collection of <see cref="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.GetSigningKeys"/> method. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.GetSigningKeys"> <summary> Returns the JsonWebKeys as a <see cref="T:System.Collections.Generic.IList`1"/>. </summary> <remarks> To include unresolved JsonWebKeys in the resulting <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> collection, set <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKeySet.SkipUnresolvedJsonWebKeys"/> to <c>false</c>. </remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeySetParameterNames"> <summary> Names for Json Web Key Set Values </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeyUseNames"> <summary> Constants for JsonWebKeyUse (sec 4.2) https://datatracker.ietf.org/doc/html/rfc7517#section-4.2 </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.Json.JsonSerializerPrimitives.CreateJsonReaderException(System.Text.Json.Utf8JsonReader@,System.String,System.String,System.String,System.Exception)"> <summary> Creates a <see cref="T:System.Text.Json.JsonException"/> that provides information on what went wrong. </summary> <param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader"/> instance.</param> <param name="expectedType">The expected type the reader was looking for.</param> <param name="className">The name of the type being read.</param> <param name="propertyName">The property name being read.</param> <param name="innerException">The optional inner exception if available.</param> <returns>A <see cref="T:System.Text.Json.JsonException"/> instance.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Json.JsonSerializerPrimitives.CreateObjectFromJsonElement(System.Text.Json.JsonElement,System.Int32,System.String)"> <remarks> <paramref name="claimType"/> is not considered on recursive calls. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Json.JsonSerializerPrimitives.ReadStringOrNumberAsString(System.Text.Json.Utf8JsonReader@,System.String,System.String,System.Boolean)"> <summary> Reads a JSON token value from a <see cref="T:System.Text.Json.Utf8JsonReader"/>, treating it as a string regardless of its actual type (string or number). </summary> <param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader"/> instance.</param> <param name="propertyName">The property name being read.</param> <param name="className">The type being deserialized.</param> <param name="read">If true, the reader will advance to the next token using <see cref="M:System.Text.Json.Utf8JsonReader.Read"/>.</param> <returns>The JSON token value as a string.</returns> </member> <member name="F:Microsoft.IdentityModel.Tokens.Json.JsonSerializerPrimitives.s_knownNonDateTimeClaimTypes"> <summary> This is a non-exhaustive list of claim types that are not expected to be DateTime values sourced from expected Entra V1 and V2 claims, OpenID Connect claims, and a selection of restricted claim names. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.Json.JsonSerializerPrimitives.ReadPropertyValueAsObject(System.Text.Json.Utf8JsonReader@,System.String,System.String,System.Boolean)"> <summary> Reads a property value from a <see cref="T:System.Text.Json.Utf8JsonReader"/> as an object during deserialization. </summary> <param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader"/> instance.</param> <param name="propertyName">The property name being read.</param> <param name="className">The type being deserialized.</param> <param name="read">If true, the reader will advance to the next token using <see cref="M:System.Text.Json.Utf8JsonReader.Read"/>.</param> <returns>The property value from the reader as an object.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Json.JsonSerializerPrimitives.WriteObject(System.Text.Json.Utf8JsonWriter@,System.String,System.Object)"> <summary> Writes an object as a <see cref="T:System.Text.Json.JsonProperty"/>. This was written to support what IdentityModel6x supported and is not meant to be a general object serializer. If a user needs to serialize a special value, then serialize the value into a <see cref="T:System.Text.Json.JsonElement"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.Json.JsonSerializerPrimitives.WriteObjectValue(System.Text.Json.Utf8JsonWriter@,System.Object)"> <summary> Writes values into an array. Assumes the writer.StartArray() has been called. </summary> <param name="writer"></param> <param name="obj"></param> </member> <member name="M:Microsoft.IdentityModel.Tokens.Json.JsonWebKeySerializer.Read(System.Text.Json.Utf8JsonReader@,Microsoft.IdentityModel.Tokens.JsonWebKey)"> <summary> Reads a JsonWebKey. see: https://datatracker.ietf.org/doc/html/rfc7517 </summary> <param name="reader">a <see cref="T:System.Text.Json.Utf8JsonReader"/> pointing at a StartObject.</param> <param name="jsonWebKey"></param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Json.JsonWebKeySetSerializer.Read(System.Text.Json.Utf8JsonReader@,Microsoft.IdentityModel.Tokens.JsonWebKeySet)"> <summary> Reads a JsonWebKey. see: https://datatracker.ietf.org/doc/html/rfc7517 </summary> <param name="reader">a <see cref="T:System.Text.Json.Utf8JsonReader"/> pointing at a StartObject.</param> <param name="jsonWebKeySet"></param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Json.JsonWebKeySetSerializer.Write(System.Text.Json.Utf8JsonWriter@,Microsoft.IdentityModel.Tokens.JsonWebKeySet)"> <summary> This method will be used when reading OIDC metadata </summary> <param name="writer"></param> <param name="jsonWebKeySet"></param> </member> <member name="T:Microsoft.IdentityModel.Tokens.LogMessages"> <summary> Log messages and codes </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.DisposableObjectPool`1"> <summary> Generic implementation of object pooling pattern with predefined pool size limit. The main purpose is that limited number of frequently used objects can be kept in the pool for further recycling. Notes: 1) it is not the goal to keep all returned objects. Pool is not meant for storage. If there is no space in the pool, extra returned objects will be dropped. 2) it is implied that if object was obtained from a pool, the caller will return it back in a relatively short time. Keeping checked out objects for long durations is ok, but reduces usefulness of pooling. Just new up your own. Not returning objects to the pool in not detrimental to the pool's work, but is a bad practice. Rationale: If there is no intent for reusing the object, do not use pool - just use "new". </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.DisposableObjectPool`1.Allocate"> <summary> Produces an instance. </summary> <remarks> Search strategy is a simple linear probing which is chosen for it cache-friendliness. Note that Free will try to store recycled objects close to the start thus statistically reducing how far we will typically search. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.DisposableObjectPool`1.Free(`0)"> <summary> Returns objects to the pool. </summary> <remarks> Search strategy is a simple linear probing which is chosen for it cache-friendliness. Note that Free will try to store recycled objects close to the start thus statistically reducing how far we will typically search in Allocate. </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Interop.Kernel32.GetMessage(System.Int32)"> <summary> Returns a string message for the specified Win32 error code. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy"> <summary> The purpose of this class is to ensure that we obtain an RsaCryptoServiceProvider that supports SHA-256 signatures. If the original RsaCryptoServiceProvider doesn't support SHA-256, we create a new one using the same KeyContainer. </summary> <remarks> There is no support for <see cref="T:System.Security.Cryptography.CspParameters"/> and <see cref="T:System.Security.Cryptography.CspKeyContainerInfo"/> on non-Windows platforms which makes <see cref="T:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy"/> a Windows-specific class. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.SignatureAlgorithm"> <summary> Gets the SignatureAlgorithm </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.KeyExchangeAlgorithm"> <summary> Gets the KeyExchangeAlgorithm </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.#ctor(System.Security.Cryptography.RSACryptoServiceProvider)"> <summary> Initializes an new instance of <see cref="T:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy"/>. </summary> <param name="rsa"><see cref="T:System.Security.Cryptography.RSACryptoServiceProvider"/></param> <exception cref="T:System.ArgumentNullException">if <paramref name="rsa"/> is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.Decrypt(System.Byte[],System.Boolean)"> <summary> Decrypts data with the System.Security.Cryptography.RSA algorithm. </summary> <param name="input">The data to be decrypted.</param> <param name="fOAEP">true to perform direct System.Security.Cryptography.RSA decryption using OAEP padding (only available on a computer running Microsoft Windows XP or later) otherwise, false to use PKCS#1 v1.5 padding.</param> <returns>decrypted bytes.</returns> <exception cref="T:System.ArgumentNullException">if <paramref name="input"/> is null or has Length == 0.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.DecryptValue(System.Byte[])"> <summary> Decrypts the input. </summary> <param name="input">the bytes to decrypt.</param> <returns>decrypted bytes</returns> <exception cref="T:System.ArgumentNullException">if <paramref name="input"/> is null or Length == 0.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.Encrypt(System.Byte[],System.Boolean)"> <summary> Encrypts data with the System.Security.Cryptography.RSA algorithm. </summary> <param name="input">The data to be encrypted.</param> <param name="fOAEP">true to perform direct System.Security.Cryptography.RSA encryption using OAEP padding (only available on a computer running Microsoft Windows XP or later); otherwise, false to use PKCS#1 v1.5 padding.</param> <returns>encrypted bytes.</returns> <exception cref="T:System.ArgumentNullException">if <paramref name="input"/> is null or has Length == 0.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.EncryptValue(System.Byte[])"> <summary> Encrypts the input. </summary> <param name="input">the bytes to encrypt.</param> <returns>encrypted bytes.</returns> <exception cref="T:System.ArgumentNullException">if <paramref name="input"/> is null or Length == 0.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.SignData(System.Byte[],System.Object)"> <summary> Computes the hash value of the specified byte array using the specified hash algorithm, and signs the resulting hash value. </summary> <param name="input">The input byte array for which to compute the hash.</param> <param name="hash">The hash algorithm to use to create the hash value. </param> <returns>The <see cref="T:System.Security.Cryptography.RSA"/> Signature for the specified data.</returns> <exception cref="T:System.ArgumentNullException">if <paramref name="input"/> is null or Length == 0.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="hash"/> is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.VerifyData(System.Byte[],System.Object,System.Byte[])"> <summary> Verifies that a digital signature is valid by determining the hash value in the signature using the provided public key and comparing it to the hash value of the provided data. </summary> <param name="input">The input byte array.</param> <param name="hash">The hash algorithm to use to create the hash value.</param> <param name="signature">The signature byte array to be verified.</param> <returns>true if the signature is valid; otherwise, false.</returns> <exception cref="T:System.ArgumentNullException">if <paramref name="input"/> is null or Length == 0.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="hash"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="signature"/> is null or Length == 0.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.VerifyDataWithLength(System.Byte[],System.Int32,System.Int32,System.Object,System.Security.Cryptography.HashAlgorithmName,System.Byte[])"> <summary> Verifies that a digital signature is valid by determining the hash value in the signature using the provided public key and comparing it to the hash value of the provided data. </summary> <param name="input">The input byte array.</param> <param name="offset"></param> <param name="length"></param> <param name="hash">The hash algorithm to use to create the hash value.</param> <param name="hashAlgorithmName"></param> <param name="signature">The signature byte array to be verified.</param> <returns>true if the signature is valid; otherwise, false.</returns> <exception cref="T:System.ArgumentNullException">if <paramref name="input"/> is null or Length == 0.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="hash"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="signature"/> is null or Length == 0.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.ExportParameters(System.Boolean)"> <summary> Exports rsa parameters as <see cref="T:System.Security.Cryptography.RSAParameters"/> </summary> <param name="includePrivateParameters">flag to control is private parameters are included.</param> <returns><see cref="T:System.Security.Cryptography.RSAParameters"/></returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.ImportParameters(System.Security.Cryptography.RSAParameters)"> <summary> Imports rsa parameters as <see cref="T:System.Security.Cryptography.RSAParameters"/> </summary> <param name="parameters">to import.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.RSACryptoServiceProviderProxy.Dispose(System.Boolean)"> <summary> Releases the resources used by the current instance. </summary> <param name="disposing">If true, release both managed and unmanaged resources; otherwise, release only unmanaged resources.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"> <summary> Represents a Rsa security key. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.RsaSecurityKey.#ctor(System.Security.Cryptography.RSAParameters)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/> class. </summary> <param name="rsaParameters"><see cref="T:System.Security.Cryptography.RSAParameters"/></param> </member> <member name="M:Microsoft.IdentityModel.Tokens.RsaSecurityKey.#ctor(System.Security.Cryptography.RSA)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/> class. </summary> <param name="rsa"><see cref="T:System.Security.Cryptography.RSA"/></param> </member> <member name="P:Microsoft.IdentityModel.Tokens.RsaSecurityKey.HasPrivateKey"> <summary> Gets a bool indicating if a private key exists. </summary> <return>true if it has a private key; otherwise, false.</return> </member> <member name="P:Microsoft.IdentityModel.Tokens.RsaSecurityKey.PrivateKeyStatus"> <summary> Gets an enum indicating if a private key exists. </summary> <return>'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine.</return> </member> <member name="P:Microsoft.IdentityModel.Tokens.RsaSecurityKey.KeySize"> <summary> Gets RSA key size. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.RsaSecurityKey.Parameters"> <summary> <see cref="T:System.Security.Cryptography.RSAParameters"/> used to initialize the key. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.RsaSecurityKey.Rsa"> <summary> <see cref="T:System.Security.Cryptography.RSA"/> instance used to initialize the key. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.RsaSecurityKey.CanComputeJwkThumbprint"> <summary> Determines whether the <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/> can compute a JWK thumbprint. </summary> <returns><c>true</c> if JWK thumbprint can be computed; otherwise, <c>false</c>.</returns> <remarks>https://datatracker.ietf.org/doc/html/rfc7638</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.RsaSecurityKey.ComputeJwkThumbprint"> <summary> Computes a sha256 hash over the <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/>. </summary> <returns>A JWK thumbprint.</returns> <remarks>https://datatracker.ietf.org/doc/html/rfc7638</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityAlgorithms"> <summary> Constants for Security Algorithm. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityKey"> <summary> Base class for Security Key. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityKey.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityKey.KeySize"> <summary> This must be overridden to get the size of this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityKey.KeyId"> <summary> Gets the key id of this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityKey.CryptoProviderFactory"> <summary> Gets or sets <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityKey.ToString"> <summary> Returns the formatted string: GetType(), KeyId: 'value', InternalId: 'value'. </summary> <returns>string</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityKey.CanComputeJwkThumbprint"> <summary> Determines whether the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> can compute a JWK thumbprint. </summary> <returns><c>true</c> if JWK thumbprint can be computed; otherwise, <c>false</c>.</returns> <remarks>https://datatracker.ietf.org/doc/html/rfc7638</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityKey.ComputeJwkThumbprint"> <summary> Computes a sha256 hash over the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>. </summary> <returns>A JWK thumbprint.</returns> <remarks>https://datatracker.ietf.org/doc/html/rfc7638</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityKey.IsSupportedAlgorithm(System.String)"> <summary> Checks if <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.CryptoProviderFactory"/> can perform the cryptographic operation specified by the <paramref name="algorithm"/> with this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>. </summary> <param name="algorithm">the algorithm to be used.</param> <returns>true if <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.CryptoProviderFactory"/> can perform the cryptographic operation sepecified by the <paramref name="algorithm"/> with this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityKeyIdentifierClause"> <summary> Contains information about the keys inside the tokens. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityToken"> <summary> Base class for security token. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityToken.UnsafeToString"> <inheritdoc/> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.Id"> <summary> This must be overridden to get the Id of this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.Issuer"> <summary> This must be overridden to get the issuer of this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.SecurityKey"> <summary> This must be overridden to get the <see cref="P:Microsoft.IdentityModel.Tokens.SecurityToken.SecurityKey"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.SigningKey"> <summary> This must be overridden to get or set the <see cref="P:Microsoft.IdentityModel.Tokens.SecurityToken.SecurityKey"/> that signed this instance. </summary> <remarks><see cref="T:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator"/>.ValidateToken(...) can this value when a <see cref="P:Microsoft.IdentityModel.Tokens.SecurityToken.SecurityKey"/> is used to successfully validate a signature.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.ValidFrom"> <summary> This must be overridden to get the time when this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> was Valid. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.ValidTo"> <summary> This must be overridden to get the time when this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> is no longer Valid. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor"> <summary> Contains some information which used to create a security token. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Audience"> <summary> Gets or sets the value of the {"": audience} claim. Will be combined with <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Audiences"/> and any "Aud" claims in <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Claims"/> or <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Subject"/> when creating a token. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Audiences"> <summary> Gets the list audiences to include in the token's 'Aud' claim. Will be combined with <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Audiences"/> and any "Aud" claims in <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Claims"/> or <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Subject"/> when creating a token. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.CompressionAlgorithm"> <summary> Defines the compression algorithm that will be used to compress the JWT token payload. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.EncryptingCredentials"> <summary> Gets or sets the <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.EncryptingCredentials"/> used to create a encrypted security token. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Expires"> <summary> Gets or sets the value of the 'expiration' claim. This value should be in UTC. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Issuer"> <summary> Gets or sets the issuer of this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.IssuedAt"> <summary> Gets or sets the time the security token was issued. This value should be in UTC. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.NotBefore"> <summary> Gets or sets the notbefore time for the security token. This value should be in UTC. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.TokenType"> <summary> Gets or sets the token type. <remarks> If provided, this will be added as the value for the 'typ' header parameter. In the case of a JWE, this will be added to both the inner (JWS) and the outer token (JWE) header. By default, the value used is 'JWT'. If <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.AdditionalHeaderClaims"/> also contains 'typ' header claim value, it will override the TokenType provided here. This value is used only for JWT tokens and not for SAML/SAML2 tokens</remarks> </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Claims"> <summary> Gets or sets the <see cref="T:System.Collections.Generic.Dictionary`2"/> which represents the claims that will be used when creating a security token. If both <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Claims"/> and <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Subject"/> are set, the claim values in Subject will be combined with the values in Claims. The values found in Claims take precedence over those found in Subject, so any duplicate values will be overridden. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.AdditionalHeaderClaims"> <summary> Gets or sets the <see cref="T:System.Collections.Generic.Dictionary`2"/> which contains any custom header claims that need to be added to the JWT token header. The 'alg', 'kid', 'x5t', 'enc', and 'zip' claims are added by default based on the <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.SigningCredentials"/>, <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.EncryptingCredentials"/>, and/or <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.CompressionAlgorithm"/> provided and SHOULD NOT be included in this dictionary as this will result in an exception being thrown. <remarks> These claims are only added to the outer header (in case of a JWE).</remarks> </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.AdditionalInnerHeaderClaims"> <summary> Gets or sets the <see cref="T:System.Collections.Generic.Dictionary`2"/> which contains any custom header claims that need to be added to the inner JWT token header. The 'alg', 'kid', 'x5t', 'enc', and 'zip' claims are added by default based on the <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.SigningCredentials"/>, <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.EncryptingCredentials"/>, and/or <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.CompressionAlgorithm"/> provided and SHOULD NOT be included in this dictionary as this will result in an exception being thrown. <remarks> For JsonWebTokenHandler, these claims are merged with <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.AdditionalHeaderClaims"/> while adding to the inner JWT header. </remarks> </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.SigningCredentials"> <summary> Gets or sets the <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.SigningCredentials"/> used to create a security token. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Subject"> <summary> Gets or sets the <see cref="T:System.Security.Claims.ClaimsIdentity"/>. If both <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Claims"/> and <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Subject"/> are set, the claim values in Subject will be combined with the values in Claims. The values found in Claims take precedence over those found in Subject, so any duplicate values will be overridden. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler"> <summary> Defines the interface for a Security Token Handler. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.#ctor"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CreateSecurityTokenReference(Microsoft.IdentityModel.Tokens.SecurityToken,System.Boolean)"> <summary> Returns <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKeyIdentifierClause"/>. </summary> <param name="token"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/></param> <param name="attached">true if attached; otherwise, false.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CreateToken(Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor)"> <summary> Returns <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <param name="tokenDescriptor"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor"/></param> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CanValidateToken"> <summary> Gets a value indicating whether this handler supports validation of tokens handled by this instance. </summary>v <returns>'True' if the instance is capable of SecurityToken validation.</returns> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CanWriteToken"> <summary> Gets a value indicating whether the class provides serialization functionality to serialize token handled by this instance. </summary> <returns>true if the WriteToken method can serialize this token.</returns> </member> <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.TokenType"> <summary> This must be overridden to get the System.Type of the SecurityToken this instance handles. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CanReadToken(System.Xml.XmlReader)"> <summary> Indicates whether the <see cref="T:System.Xml.XmlReader"/> is positioned at an element that can be read. </summary> <param name="reader">An <see cref="T:System.Xml.XmlReader"/> reader positioned at a start element. The reader should not be advanced.</param> <returns>'true' if the token can be read.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CanReadToken(System.String)"> <summary> Indicates whether the current token string can be read as a token of the type handled by this instance. </summary> <param name="tokenString">The token string thats needs to be read.</param> <returns>'True' if the ReadToken method can parse the token string.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.ReadToken(System.Xml.XmlReader)"> <summary> Gets security token. </summary> <param name="reader"><see cref="T:System.Xml.XmlReader"/>.</param> <remarks>SecurityToken instance which represents the serialized token.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.WriteToken(Microsoft.IdentityModel.Tokens.SecurityToken)"> <summary> Serializes to string a token of the type handled by this instance. </summary> <param name="token">A token of type TokenType.</param> <returns>The serialized token.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.WriteToken(System.Xml.XmlWriter,Microsoft.IdentityModel.Tokens.SecurityToken)"> <summary> This must be overridden to serialize to XML a token of the type handled by this instance. </summary> <param name="writer">The XML writer.</param> <param name="token">A token of type <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.TokenType"/>.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.ReadToken(System.Xml.XmlReader,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> This must be overridden to deserialize token with the provided <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>. </summary> <param name="reader"><see cref="T:System.Xml.XmlReader"/>.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <remarks>SecurityToken instance which represents the serialized token.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.SecurityToken@)"> <summary> This must be overridden to validate a token passed as a string using <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> </summary> <param name="securityToken">A token of type <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.TokenType"/>.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="validatedToken">The token of type <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.TokenType"/> that was validated.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.ValidateToken(System.Xml.XmlReader,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.SecurityToken@)"> <summary> Reads and validates a token using a xmlReader and <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> </summary> <param name="reader">A <see cref="T:System.Xml.XmlReader"/> pointing at the start element of the token.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="validatedToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that was validated.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.SignatureProvider"> <summary> Provides signature services, signing and verifying. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.SignatureProvider._referenceCount"> <summary> Maintains the number of external references see: <see cref="M:Microsoft.IdentityModel.Tokens.SignatureProvider.AddRef"/>, <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.RefCount"/>, <see cref="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Release"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> class used to create and verify signatures. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.</param> <param name="algorithm">The signature algorithm to be used.</param> <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is null.</exception> <exception cref="T:System.ArgumentNullException"><paramref name="algorithm"/> is null or empty.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.SignatureProvider.Algorithm"> <summary> Gets the signature algorithm. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SignatureProvider.Context"> <summary> Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>. </summary> <remarks>This is null by default. This is for use by the application and not used by this SDK.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.SignatureProvider.CryptoProviderCache"> <summary> Gets or sets the <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.CryptoProviderCache"/> that is associated with this <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Dispose"> <summary> Calls <see cref="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Dispose(System.Boolean)"/> and <see cref="M:System.GC.SuppressFinalize(System.Object)"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Dispose(System.Boolean)"> <summary> Can be over written in descendants to dispose of internal components. </summary> <param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer</param> </member> <member name="P:Microsoft.IdentityModel.Tokens.SignatureProvider.Key"> <summary> Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SignatureProvider.ObjectPoolSize"> <summary> For testing purposes </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Sign(System.Byte[])"> <summary> This must be overridden to produce a signature over the 'input'. </summary> <param name="input">bytes to sign.</param> <returns>signed bytes</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Sign(System.Byte[],System.Int32,System.Int32)"> <summary> Produces a signature over the specified region of the <paramref name="input"/>. </summary> <param name="input">The bytes to produce a signature over.</param> <param name="offset">The offset to specify the beginning of the region.</param> <param name="count">The count to specify the end of the region.</param> <returns>The signature bytes.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Verify(System.Byte[],System.Byte[])"> <summary> Verifies that the <paramref name="signature"/> over <paramref name="input"/> using the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.Algorithm"/> specified by this <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> are consistent. </summary> <param name="input">the bytes that were signed.</param> <param name="signature">signature to compare against.</param> <returns>true if the computed signature matches the signature parameter, false otherwise.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Verify(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32)"> <summary> Verifies that a signature created over the 'input' matches the signature. Using <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and 'algorithm' passed to <see cref="M:Microsoft.IdentityModel.Tokens.SignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"/>. </summary> <param name="input">The bytes to verify.</param> <param name="inputOffset">offset in to input bytes to caculate hash.</param> <param name="inputLength">number of bytes of signature to use.</param> <param name="signature">signature to compare against.</param> <param name="signatureOffset">offset into signature array.</param> <param name="signatureLength">how many bytes to verfiy.</param> <returns>true if computed signature matches the signature parameter, false otherwise.</returns> <exception cref="T:System.ArgumentNullException">'input' is null.</exception> <exception cref="T:System.ArgumentNullException">'signature' is null.</exception> <exception cref="T:System.ArgumentException">'input.Length' == 0.</exception> <exception cref="T:System.ArgumentException">'signature.Length' == 0. </exception> <exception cref="T:System.ArgumentException">'length < 1'</exception> <exception cref="T:System.ArgumentException">'offset + length > input.Length'</exception> <exception cref="T:System.ObjectDisposedException"><see cref="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Dispose(System.Boolean)"/> has been called.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.SignatureProvider.WillCreateSignatures"> <summary> Gets or sets a bool indicating if this <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> is expected to create signatures. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.SigningCredentials"> <summary> Defines the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>, algorithm and digest for digital signatures. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SigningCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> class. </summary> <param name="certificate"><see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that will be used for signing.</param> <remarks>Algorithm will be set to <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/>. the 'digest method' if needed may be implied from the algorithm. For example <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/> implies Sha256.</remarks> <exception cref="T:System.ArgumentNullException">if 'key' is null.</exception> <exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.SigningCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> class. </summary> <param name="certificate"><see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that will be used for signing.</param> <param name="algorithm">The signature algorithm to be used.</param> <remarks>the 'digest method' if needed may be implied from the algorithm. For example <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/> implies Sha256.</remarks> <exception cref="T:System.ArgumentNullException">if 'certificate' is null.</exception> <exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.SigningCredentials.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> class. </summary> <param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.</param> <param name="algorithm">The signature algorithm to be used.</param> <remarks>the 'digest method' if needed may be implied from the algorithm. For example <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.HmacSha256Signature"/> implies Sha256.</remarks> <exception cref="T:System.ArgumentNullException">if 'key' is null.</exception> <exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.SigningCredentials.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> class. </summary> <param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.</param> <param name="algorithm">The signature algorithm to be used.</param> <param name="digest">The digest algorithm to be used.</param> <exception cref="T:System.ArgumentNullException">if 'key' is null.</exception> <exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception> <exception cref="T:System.ArgumentNullException">if 'digest' is null or empty.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.SigningCredentials.Algorithm"> <summary> Gets the signature algorithm. </summary> <exception cref="T:System.ArgumentNullException">if 'value' is null or empty.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.SigningCredentials.Digest"> <summary> Gets the digest algorithm. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SigningCredentials.CryptoProviderFactory"> <summary> Users can override the default <see cref="P:Microsoft.IdentityModel.Tokens.SigningCredentials.CryptoProviderFactory"/> with this property. This factory will be used for creating signature providers. </summary> <remarks>This will have precedence over <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.CryptoProviderFactory"/></remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.SigningCredentials.Key"> <summary> Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used for signature creation or validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SigningCredentials.Kid"> <summary> Gets the key id associated with <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.SupportedAlgorithms"> <summary> Defines the default set of algorithms this library supports </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SupportedAlgorithms.GetHashAlgorithmName(System.String)"> <summary> Creating a Signature requires the use of a <see cref="T:System.Security.Cryptography.HashAlgorithm"/>. This method returns the <see cref="T:System.Security.Cryptography.HashAlgorithmName"/> that describes the <see cref="T:System.Security.Cryptography.HashAlgorithm"/>to use when generating a Signature. </summary> <param name="algorithm">The SignatureAlgorithm in use.</param> <returns>The <see cref="T:System.Security.Cryptography.HashAlgorithmName"/> to use.</returns> <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/> is null or whitespace.</exception> <exception cref="T:System.ArgumentOutOfRangeException">if <paramref name="algorithm"/> is not supported.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.SupportedAlgorithms.GetDigestFromSignatureAlgorithm(System.String)"> <summary> Creating a Signature requires the use of a <see cref="T:System.Security.Cryptography.HashAlgorithm"/>. This method returns the HashAlgorithm string that is associated with a SignatureAlgorithm. </summary> <param name="algorithm">The SignatureAlgorithm of interest.</param> <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/>is null or whitespace.</exception> <exception cref="T:System.ArgumentException">if <paramref name="algorithm"/> is not supported.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.SupportedAlgorithms.IsSupportedAlgorithm(System.String,Microsoft.IdentityModel.Tokens.SecurityKey)"> <summary> Checks if an 'algorithm, key' pair is supported. </summary> <param name="algorithm">the algorithm to check.</param> <param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.</param> <returns>true if 'algorithm, key' pair is supported.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.SupportedAlgorithms.GetMaxByteCount(System.String)"> <summary> Returns the maximum size in bytes for a supported signature algorithms. The key size affects the signature size for asymmetric algorithms. </summary> <param name="algorithm">The security algorithm to find the maximum size.</param> <returns>Set size for known algorithms, 2K default.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"> <summary> Represents a symmetric security key. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey.#ctor(System.Byte[])"> <summary> Returns a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> instance. </summary> <param name="key">The byte array of the key.</param> </member> <member name="P:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey.KeySize"> <summary> Gets the key size. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey.Key"> <summary> Gets the byte array of the key. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey.CanComputeJwkThumbprint"> <summary> Determines whether the <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> can compute a JWK thumbprint. </summary> <returns><c>true</c> if JWK thumbprint can be computed; otherwise, <c>false</c>.</returns> <remarks>https://datatracker.ietf.org/doc/html/rfc7638</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey.ComputeJwkThumbprint"> <summary> Computes a sha256 hash over the <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>. </summary> <returns>A JWK thumbprint.</returns> <remarks>https://datatracker.ietf.org/doc/html/rfc7638</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider"> <summary> Provides signing and verifying operations using a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and specifying an algorithm. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.ExpectedSignatureSizeInBytes"> <summary> Mapping from algorithm to the expected signature size in bytes. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.DefaultMinimumSymmetricKeySizeInBits"> <summary> This is the minimum <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.KeySize when creating and verifying signatures. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider"/> class that uses an <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to create and / or verify signatures over a array of bytes. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.</param> <param name="algorithm">The signature algorithm to use.</param> <exception cref="T:System.ArgumentNullException">'key' is null.</exception> <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception> <exception cref="T:System.NotSupportedException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception> <exception cref="T:System.ArgumentOutOfRangeException">'<see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.KeySize' is smaller than <see cref="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.MinimumSymmetricKeySizeInBits"/>.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider"/> class that uses an <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to create and / or verify signatures over a array of bytes. </summary> <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.</param> <param name="algorithm">The signature algorithm to use.</param> <param name="willCreateSignatures">If true, the provider will be used for creating signatures.</param> <exception cref="T:System.ArgumentNullException">'key' is null.</exception> <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception> <exception cref="T:System.NotSupportedException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception> <exception cref="T:System.ArgumentOutOfRangeException">'<see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.KeySize' is smaller than <see cref="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.MinimumSymmetricKeySizeInBits"/>.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.MinimumSymmetricKeySizeInBits"> <summary> Gets or sets the minimum <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.KeySize"/>. </summary> <exception cref="T:System.ArgumentOutOfRangeException">'value' is smaller than <see cref="F:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.DefaultMinimumSymmetricKeySizeInBits"/>.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.GetKeyBytes(Microsoft.IdentityModel.Tokens.SecurityKey)"> <summary> Called to obtain the byte[] needed to create a <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/> </summary> <param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>that will be used to obtain the byte[].</param> <returns><see cref="T:System.Byte"/>[] that is used to populated the KeyedHashAlgorithm.</returns> <exception cref="T:System.ArgumentNullException">if key is null.</exception> <exception cref="T:System.ArgumentException">if a byte[] can not be obtained from SecurityKey.</exception> <remarks><see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> are supported. <para>For a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> .Key is returned</para> <para>For a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>Base64UrlEncoder.DecodeBytes is called with <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKey.K"/> if <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Kty"/> == JsonWebAlgorithmsKeyTypes.Octet</para> </remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.GetKeyedHashAlgorithm(System.Byte[],System.String)"> <summary> Returns a <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/>. This method is called just before a cryptographic operation. This provides the opportunity to obtain the <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/> from an object pool. If this method is overridden, it is importont to override <see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.ReleaseKeyedHashAlgorithm(System.Security.Cryptography.KeyedHashAlgorithm)"/> if custom releasing of the <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/> is desired. </summary> <param name="algorithm">The hash algorithm to use to create the hash value.</param> <param name="keyBytes">The byte array of the key.</param> <returns>An instance of <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/></returns> </member> <member name="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.ObjectPoolSize"> <summary> For testing purposes </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.ReleaseKeyedHashAlgorithm(System.Security.Cryptography.KeyedHashAlgorithm)"> <summary> This method is called just after the cryptographic operation. If <see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.GetKeyedHashAlgorithm(System.Byte[],System.String)"/> was overridden this method can be overridden for any custom handling such as returning the <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/> to an object pool. </summary> <param name="keyedHashAlgorithm">The <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/>" in use.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Sign(System.Byte[])"> <summary> Produces a signature over the 'input' using the <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and 'algorithm' passed to <see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"/>. </summary> <param name="input">The bytes to sign.</param> <returns>Signed bytes</returns> <exception cref="T:System.ArgumentNullException">'input' is null. </exception> <exception cref="T:System.ArgumentException">'input.Length' == 0. </exception> <exception cref="T:System.ObjectDisposedException"><see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called.</exception> <exception cref="T:System.InvalidOperationException"><see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/> is null. This can occur if a derived type deletes it or does not create it.</exception> <remarks>Sign is thread safe.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Sign(System.Byte[],System.Int32,System.Int32)"> <inheritdoc/> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Verify(System.Byte[],System.Byte[])"> <summary> Verifies that a signature created over the 'input' matches the signature. Using <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and 'algorithm' passed to <see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"/>. </summary> <param name="input">The bytes to verify.</param> <param name="signature">signature to compare against.</param> <returns>true if computed signature matches the signature parameter, false otherwise.</returns> <exception cref="T:System.ArgumentNullException">'input' is null.</exception> <exception cref="T:System.ArgumentNullException">'signature' is null.</exception> <exception cref="T:System.ArgumentException">'input.Length' == 0.</exception> <exception cref="T:System.ArgumentException">'signature.Length' == 0. </exception> <exception cref="T:System.ObjectDisposedException"><see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called.</exception> <exception cref="T:System.InvalidOperationException">If the internal <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/> is null. This can occur if a derived type deletes it or does not create it.</exception> <remarks>Verify is thread safe.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Verify(System.Byte[],System.Byte[],System.Int32)"> <summary> Verifies that a signature created over the 'input' matches the signature. Using <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and 'algorithm' passed to <see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"/>. </summary> <param name="input">The bytes to verify.</param> <param name="signature">signature to compare against.</param> <param name="length">number of bytes of signature to use.</param> <returns>true if computed signature matches the signature parameter, false otherwise.</returns> <exception cref="T:System.ArgumentNullException">'input' is null.</exception> <exception cref="T:System.ArgumentNullException">'signature' is null.</exception> <exception cref="T:System.ArgumentException">'input.Length' == 0.</exception> <exception cref="T:System.ArgumentException">'signature.Length' == 0. </exception> <exception cref="T:System.ArgumentException">'length < 1'</exception> <exception cref="T:System.ObjectDisposedException"><see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called.</exception> <exception cref="T:System.InvalidOperationException">If the internal <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/> is null. This can occur if a derived type deletes it or does not create it.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Verify(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32)"> <inheritdoc/> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Verify(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,System.String)"> <summary> This internal method is called from the AuthenticatedEncryptionProvider which passes in the algorithm that defines the size expected for the signature. The reason is the way the AuthenticationTag is validated. For example when "A128CBC-HS256" is specified, SHA256 will used to create the HMAC and 32 bytes will be generated, but only the first 16 will be validated. </summary> <param name="input">The bytes to verify.</param> <param name="inputOffset">offset in to input bytes to caculate hash.</param> <param name="inputLength">number of bytes of signature to use.</param> <param name="signature">signature to compare against.</param> <param name="signatureOffset">offset into signature array.</param> <param name="signatureLength">how many bytes to verfiy.</param> <param name="algorithm">algorithm passed by AuthenticatedEncryptionProvider.</param> <returns>true if computed signature matches the signature parameter, false otherwise.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Dispose(System.Boolean)"> <summary> Releases the resources used by the current instance. </summary> <param name="disposing">If true, release both managed and unmanaged resources; otherwise, release only unmanaged resources.</param> </member> <member name="T:Microsoft.IdentityModel.Tokens.TokenContext"> <summary> An opaque context used to store work when working with authentication artifacts. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenContext.#ctor"> <summary> Instantiates a new <see cref="T:Microsoft.IdentityModel.Tokens.TokenContext"/> with a default activity ID. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenContext.#ctor(System.Guid)"> <summary> Instantiates a new <see cref="T:Microsoft.IdentityModel.Tokens.TokenContext"/> with an activity ID. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.TokenHandler"> <summary> Defines properties shared across all security token handlers. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.TokenHandler.DefaultTokenLifetimeInMinutes"> <summary> Default lifetime of tokens created. When creating tokens, if 'expires', 'notbefore' or 'issuedat' are null, then a default will be set to: issuedat = DateTime.UtcNow, notbefore = DateTime.UtcNow, expires = DateTime.UtcNow + TimeSpan.FromMinutes(TokenLifetimeInMinutes). </summary> <remarks>See: <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.SetDefaultTimesOnTokenCreation"/> for configuration.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"> <summary> Gets and sets the maximum token size in bytes that will be processed. </summary> <exception cref="T:System.ArgumentOutOfRangeException">'value' less than 1.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenHandler.SetDefaultTimesOnTokenCreation"> <summary> Gets or sets a bool that controls if token creation will set default 'exp', 'nbf' and 'iat' if not specified. </summary> <remarks>See: <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.TokenLifetimeInMinutes"/> for configuration.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenHandler.TokenLifetimeInMinutes"> <summary> Gets or sets the token lifetime in minutes. </summary> <remarks>Used during token creation to set the default expiration ('exp'). </remarks> <exception cref="T:System.ArgumentOutOfRangeException">'value' less than 1.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenHandler.ValidateTokenAsync(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Validates a token. On a validation failure, no exception will be thrown; instead, the exception will be set in the returned TokenValidationResult.Exception property. Callers should always check the TokenValidationResult.IsValid property to verify the validity of the result. </summary> <param name="token">The token to be validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/></returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenHandler.ValidateTokenAsync(Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Validates a token. On a validation failure, no exception will be thrown; instead, the exception will be set in the returned TokenValidationResult.Exception property. Callers should always check the TokenValidationResult.IsValid property to verify the validity of the result. </summary> <param name="token">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> to be validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/></returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenHandler.ReadToken(System.String)"> <summary> Converts a string into an instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <param name="token">The string to be deserialized.</param> <exception cref="T:System.ArgumentNullException"><paramref name="token"/> is null or empty.</exception> <exception cref="T:System.ArgumentException">'token.Length' is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"/>.</exception> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenHandler.CreateClaimsIdentityInternal(Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,System.String)"> <summary> Called by base class to create a <see cref="T:System.Security.Claims.ClaimsIdentity"/>. Currently only used by the JsonWebTokenHandler to allow for a Lazy creation. </summary> <param name="securityToken">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that has the Claims.</param> <param name="tokenValidationParameters">the <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> that was used to validate the token.</param> <param name="issuer">the 'issuer' to use by default when creating a Claim.</param> <returns>A <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</returns> <exception cref="T:System.NotImplementedException"></exception> </member> <member name="T:Microsoft.IdentityModel.Tokens.TokenUtilities"> <summary> A class which contains useful methods for processing tokens. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.TokenUtilities.Json"> <summary> A URI that represents the JSON XML data type. </summary> <remarks>When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'.</remarks> </member> <member name="F:Microsoft.IdentityModel.Tokens.TokenUtilities.JsonArray"> <summary> A URI that represents the JSON array XML data type. </summary> <remarks>When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'.</remarks> </member> <member name="F:Microsoft.IdentityModel.Tokens.TokenUtilities.JsonNull"> <summary> A URI that represents the JSON null data type </summary> <remarks>When mapping json to .Net Claim(s), we use empty string to represent the claim value and set the ClaimValueType to JsonNull</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenUtilities.CreateDictionaryFromClaims(System.Collections.Generic.IEnumerable{System.Security.Claims.Claim})"> <summary> Creates a dictionary from a list of Claim's. </summary> <param name="claims"> A list of claims.</param> <returns> A Dictionary representing claims.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenUtilities.GetAllSigningKeys(Microsoft.IdentityModel.Tokens.BaseConfiguration,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Returns all <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> provided in <paramref name="configuration"/> and <paramref name="validationParameters"/>. </summary> <param name="configuration">The <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> that contains signing keys used for validation.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <returns>Returns all <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> provided in provided in <paramref name="configuration"/> and <paramref name="validationParameters"/>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenUtilities.MergeClaims(System.Collections.Generic.IEnumerable{System.Security.Claims.Claim},System.Collections.Generic.IEnumerable{System.Security.Claims.Claim})"> <summary> Merges claims. If a claim with same type exists in both <paramref name="claims"/> and <paramref name="subjectClaims"/>, the one in claims will be kept. </summary> <param name="claims"> Collection of <see cref="T:System.Security.Claims.Claim"/>'s.</param> <param name="subjectClaims"> Collection of <see cref="T:System.Security.Claims.Claim"/>'s.</param> <returns> A Merged list of <see cref="T:System.Security.Claims.Claim"/>'s.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenUtilities.IsRecoverableException(System.Exception)"> <summary> Check whether the given exception type is recoverable by LKG. </summary> <param name="exception">The exception to check.</param> <returns><c>true</c> if the exception is certain types of exceptions otherwise, <c>false</c>.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenUtilities.IsRecoverableConfiguration(System.String,Microsoft.IdentityModel.Tokens.BaseConfiguration,Microsoft.IdentityModel.Tokens.BaseConfiguration,System.Exception)"> <summary> Check whether the given configuration is recoverable by LKG. </summary> <param name="kid">The kid from token."/></param> <param name="currentConfiguration">The <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> to check.</param> <param name="lkgConfiguration">The LKG exception to check.</param> <param name="currentException">The exception to check.</param> <returns><c>true</c> if the configuration is recoverable otherwise, <c>false</c>.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"> <summary> Contains a set of parameters that are used by a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler"/> when validating a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <summary> partial class for the IssuerValidation delegate. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.TokenValidationParameters.DefaultAuthenticationType"> <summary> This is the default value of <see cref="P:System.Security.Claims.ClaimsIdentity.AuthenticationType"/> when creating a <see cref="T:System.Security.Claims.ClaimsIdentity"/>. The value is <c>"AuthenticationTypes.Federation"</c>. To change the value, set <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.AuthenticationType"/> to a different value. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.TokenValidationParameters.DefaultClockSkew"> <summary> Default for the clock skew. </summary> <remarks>300 seconds (5 minutes).</remarks> </member> <member name="F:Microsoft.IdentityModel.Tokens.TokenValidationParameters.DefaultMaximumTokenSizeInBytes"> <summary> Default for the maximum token size. </summary> <remarks>250 KB (kilobytes).</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenValidationParameters.#ctor(Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Copy constructor for <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenValidationParameters.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> class. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ActorValidationParameters"> <summary> Gets or sets <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.AlgorithmValidator"> <summary> Gets or sets a delegate used to validate the cryptographic algorithm used. </summary> <remarks> If set, this delegate will validate the cryptographic algorithm used and the algorithm will not be checked against <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAlgorithms"/>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.AudienceValidator"> <summary> Gets or sets a delegate that will be used to validate the audience. </summary> <remarks> If set, this delegate will be called to validate the 'audience', instead of default processing. This means that no default 'audience' validation will occur. Even if <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateAudience"/> is false, this delegate will still be called. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.AuthenticationType"> <summary> Gets or sets the AuthenticationType when creating a <see cref="T:System.Security.Claims.ClaimsIdentity"/>. </summary> <exception cref="T:System.ArgumentNullException">If 'value' is null or whitespace.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ClockSkew"> <summary> Gets or sets the clock skew to apply when validating a time. </summary> <exception cref="T:System.ArgumentOutOfRangeException">If 'value' is less than 0.</exception> The default is <c>300</c> seconds (5 minutes). </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenValidationParameters.Clone"> <summary> Returns a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> with values copied from this object. </summary> <returns>A new <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> object copied from this object</returns> <remarks>This is a shallow Clone.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenValidationParameters.CreateClaimsIdentity(Microsoft.IdentityModel.Tokens.SecurityToken,System.String)"> <summary> Creates a <see cref="T:System.Security.Claims.ClaimsIdentity"/> using: <para><see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.AuthenticationType"/></para> <para>'NameClaimType': If NameClaimTypeRetriever is set, call delegate, else call NameClaimType. If the result is a null or empty string, use <see cref="F:System.Security.Claims.ClaimsIdentity.DefaultNameClaimType"/></para>. <para>'RoleClaimType': If RoleClaimTypeRetriever is set, call delegate, else call RoleClaimType. If the result is a null or empty string, use <see cref="F:System.Security.Claims.ClaimsIdentity.DefaultRoleClaimType"/></para>. </summary> <returns>A <see cref="T:System.Security.Claims.ClaimsIdentity"/> with Authentication, NameClaimType and RoleClaimType set.</returns> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ConfigurationManager"> <summary> If set, this property will be used to obtain the issuer and signing keys associated with the metadata endpoint of <see cref="P:Microsoft.IdentityModel.Tokens.BaseConfiguration.Issuer"/>. The obtained issuer and signing keys will then be used along with those present on the TokenValidationParameters for validation of the incoming token. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.CryptoProviderFactory"> <summary> Users can override the default <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.CryptoProviderFactory"/> with this property. This factory will be used for creating signature providers. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.DebugId"> <summary> Gets or sets a string that helps with setting breakpoints when debugging. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IgnoreTrailingSlashWhenValidatingAudience"> <summary> Gets or sets a boolean that controls if a '/' is significant at the end of the audience. The default is <c>true</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IncludeTokenOnFailedValidation"> <summary> Gets or sets the flag that indicates whether to include the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> when the validation fails. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyValidator"> <summary> Gets or sets a delegate for validating the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the token. </summary> <remarks> If set, this delegate will be called to validate the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the token, instead of default processing. This means that no default <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> validation will occur. Even if <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuerSigningKey"/> is false, this delegate will still be called. If both <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyValidatorUsingConfiguration"/> and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyValidator"/> are set, IssuerSigningKeyResolverUsingConfiguration takes priority. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyValidatorUsingConfiguration"> <summary> Gets or sets a delegate for validating the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the token. </summary> <remarks> If set, this delegate will be called to validate the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the token, instead of default processing. This means that no default <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> validation will occur. Even if <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuerSigningKey"/> is false, this delegate will still be called. This delegate should be used if properties from the configuration retrieved from the authority are necessary to validate the issuer signing key. If both <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyValidatorUsingConfiguration"/> and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyValidator"/> are set, IssuerSigningKeyValidatorUsingConfiguration takes priority. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.InstancePropertyBag"> <summary> Gets a <see cref="T:System.Collections.Generic.IDictionary`2"/> that is unique to this instance. Calling <see cref="M:Microsoft.IdentityModel.Tokens.TokenValidationParameters.Clone"/> will result in a new instance of this IDictionary. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IsClone"> <summary> Gets a value indicating if <see cref="M:Microsoft.IdentityModel.Tokens.TokenValidationParameters.Clone"/> was called to obtain this instance. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKey"> <summary> Gets or sets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is to be used for signature validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyResolver"> <summary> Gets or sets a delegate that will be called to retrieve a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used for signature validation. </summary> <remarks> This <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> will be used to check the signature. This can be helpful when the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> does not contain a key identifier. If both <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyResolverUsingConfiguration"/> and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyResolver"/> are set, IssuerSigningKeyResolverUsingConfiguration takes priority. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyResolverUsingConfiguration"> <summary> Gets or sets a delegate that will be called to retrieve a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used for signature validation using the <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> and <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/>. </summary> <remarks> This <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> will be used to check the signature. This can be helpful when the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> does not contain a key identifier. This delegate should be used if properties from the configuration retrieved from the authority are necessary to resolve the issuer signing key. If both <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyResolverUsingConfiguration"/> and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyResolver"/> are set, IssuerSigningKeyResolverUsingConfiguration takes priority. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeys"> <summary> Gets or sets an <see cref="T:System.Collections.Generic.IEnumerable`1"/> used for signature validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidator"> <summary> Gets or sets a delegate that will be used to validate the issuer of the token. </summary> <remarks> If set, this delegate will be called to validate the 'issuer' of the token, instead of default processing. This means that no default 'issuer' validation will occur. Even if <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuer"/> is false, this delegate will still be called. If both <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidatorUsingConfiguration"/> and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidator"/> are set, IssuerValidatorUsingConfiguration takes priority. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidatorAsync"> <summary> Gets or sets a delegate that will be used to validate the issuer of the token. </summary> <remarks> If set, this delegate will be called to validate the 'issuer' of the token, instead of default processing. This means that no default 'issuer' validation will occur. Even if <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuer"/> is false, this delegate will still be called. IssuerValidatorAsync takes precedence over <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidatorUsingConfiguration"/> and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidator"/>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidatorUsingConfiguration"> <summary> Gets or sets a delegate that will be used to validate the issuer of the token. </summary> <remarks> If set, this delegate will be called to validate the 'issuer' of the token, instead of default processing. This means that no default 'issuer' validation will occur. Even if <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuer"/> is false, this delegate will still be called. This delegate should be used if properties from the configuration retrieved from the authority are necessary to validate the issuer. If both <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidatorUsingConfiguration"/> and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidator"/> are set, IssuerValidatorUsingConfiguration takes priority. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TransformBeforeSignatureValidation"> <summary> Gets or sets a delegate that will be called to transform a token to a supported format before validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.LifetimeValidator"> <summary> Gets or sets a delegate that will be used to validate the lifetime of the token </summary> <remarks> If set, this delegate will be called to validate the lifetime of the token, instead of default processing. This means that no default lifetime validation will occur. Even if <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateLifetime"/> is false, this delegate will still be called. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.LogTokenId"> <summary> Gets or sets a <see cref="T:System.Boolean"/> that will decide if the token identifier claim needs to be logged. Default value is <c>true</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.LogValidationExceptions"> <summary> Gets or sets a <see cref="T:System.Boolean"/> that will decide if validation failure needs to be logged as an error. Default value is <c>true</c> for backward compatibility of the behavior. If set to false, validation failures are logged as Information and then thrown. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.NameClaimType"> <summary> Gets or sets a <see cref="T:System.String"/> that defines the <see cref="P:System.Security.Claims.ClaimsIdentity.NameClaimType"/>. </summary> <remarks> Controls the value <see cref="P:System.Security.Claims.ClaimsIdentity.Name"/> returns. It will return the first <see cref="P:System.Security.Claims.Claim.Value"/> where the <see cref="P:System.Security.Claims.Claim.Type"/> equals <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.NameClaimType"/>. The default is <see cref="F:System.Security.Claims.ClaimsIdentity.DefaultNameClaimType"/>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.NameClaimTypeRetriever"> <summary> Gets or sets a delegate that will be called to set the property <see cref="P:System.Security.Claims.ClaimsIdentity.NameClaimType"/> after validating a token. </summary> <remarks> The function will be passed: <para>The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</para> <para>The issuer associated with the token.</para> <para>Returns the value that will set the property <see cref="P:System.Security.Claims.ClaimsIdentity.NameClaimType"/>.</para> </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.PropertyBag"> <summary> Gets or sets the <see cref="T:System.Collections.Generic.IDictionary`2"/> that contains a collection of custom key/value pairs. This allows addition of parameters that could be used in custom token validation scenarios. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RefreshBeforeValidation"> <summary> Gets or sets a boolean to control if configuration required to be refreshed before token validation. </summary> <remarks> The default is <c>false</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireAudience"> <summary> Gets or sets a value indicating whether SAML tokens must have at least one AudienceRestriction. The default is <c>true</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireExpirationTime"> <summary> Gets or sets a value indicating whether tokens must have an 'expiration' value. The default is <c>true</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireSignedTokens"> <summary> Gets or sets a value indicating whether a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> can be considered valid if not signed. The default is <c>true</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RoleClaimType"> <summary> Gets or sets the <see cref="T:System.String"/> that defines the <see cref="P:System.Security.Claims.ClaimsIdentity.RoleClaimType"/>. </summary> <remarks> <para>Controls the results of <see cref="M:System.Security.Claims.ClaimsPrincipal.IsInRole(System.String)"/>.</para> <para>Each <see cref="T:System.Security.Claims.Claim"/> where <see cref="P:System.Security.Claims.Claim.Type"/> == <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RoleClaimType"/> will be checked for a match against the 'string' passed to <see cref="M:System.Security.Claims.ClaimsPrincipal.IsInRole(System.String)"/>.</para> The default is <see cref="F:System.Security.Claims.ClaimsIdentity.DefaultRoleClaimType"/>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RoleClaimTypeRetriever"> <summary> Gets or sets a delegate that will be called to set the property <see cref="P:System.Security.Claims.ClaimsIdentity.RoleClaimType"/> after validating a token. </summary> <remarks> The function will be passed: <para>The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</para> <para>The issuer associated with the token.</para> <para>Returns the value that will set the property <see cref="P:System.Security.Claims.ClaimsIdentity.RoleClaimType"/>.</para> </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.SaveSigninToken"> <summary> Gets or sets a boolean to control if the original token should be saved after the security token is validated. </summary> <remarks>The runtime will consult this value and save the original token that was validated. The default is <c>false</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.SignatureValidator"> <summary> Gets or sets a delegate that will be used to validate the signature of the token. </summary> <remarks> If set, this delegate will be called to validate the signature of the token, instead of default processing. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.SignatureValidatorUsingConfiguration"> <summary> Gets or sets a delegate that will be used to validate the signature of the token using the <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> and the <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/>. </summary> <remarks> If set, this delegate will be called to validate the signature of the token, instead of default processing. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenDecryptionKey"> <summary> Gets or sets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is to be used for decryption. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenDecryptionKeyResolver"> <summary> Gets or sets a delegate that will be called to retreive a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used for decryption. </summary> <remarks> This <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> will be used to decrypt the token. This can be helpful when the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> does not contain a key identifier. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenDecryptionKeys"> <summary> Gets or sets the <see cref="T:System.Collections.Generic.IEnumerable`1"/> that is to be used for decrypting inbound tokens. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReader"> <summary> Gets or sets a delegate that will be used to read the token. </summary> <remarks> If set, this delegate will be called to read the token instead of default processing. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"> <summary> Gets or set the <see cref="T:Microsoft.IdentityModel.Tokens.ITokenReplayCache"/> that store tokens that can be checked to help detect token replay. </summary> <remarks>If set, then tokens must have an expiration time or the runtime will fault.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayValidator"> <summary> Gets or sets a delegate that will be used to validate the token replay of the token </summary> <remarks> If set, this delegate will be called to validate the token replay of the token, instead of default processing. This means no default token replay validation will occur. Even if <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateTokenReplay"/> is false, this delegate will still be called. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TryAllIssuerSigningKeys"> <summary> Gets or sets a value indicating whether all <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeys"/> should be tried during signature validation when a key is not matched to token kid or if token kid is empty. The default is <c>true</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TypeValidator"> <summary> Gets or sets a delegate that will be used to validate the type of the token. If the token type cannot be validated, an exception MUST be thrown by the delegate. Note: the 'type' parameter may be null if it couldn't be extracted from its usual location. Implementations that need to resolve it from a different location can use the 'token' parameter. </summary> <remarks> If set, this delegate will be called to validate the 'type' of the token, instead of default processing. This means that no default 'type' validation will occur. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateActor"> <summary> Gets or sets a value indicating if an actor token is detected, whether it should be validated. The default is <c>false</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateAudience"> <summary> Gets or sets a boolean to control if the audience will be validated during token validation. </summary> <remarks>Validation of the audience, mitigates forwarding attacks. For example, a site that receives a token, could not replay it to another site. A forwarded token would contain the audience of the original site. This boolean only applies to default audience validation. If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.AudienceValidator"/> is set, it will be called regardless of whether this property is true or false. The default is <c>true</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuer"> <summary> Gets or sets a boolean to control if the issuer will be validated during token validation. </summary> <remarks> Validation of the issuer mitigates forwarding attacks that can occur when an IdentityProvider represents multiple tenants and signs tokens with the same keys. It is possible that a token issued for the same audience could be from a different tenant. For example an application could accept users from contoso.onmicrosoft.com but not fabrikam.onmicrosoft.com, both valid tenants. An application that accepts tokens from fabrikam could forward them to the application that accepts tokens for contoso. This boolean only applies to default issuer validation. If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidator"/> is set, it will be called regardless of whether this property is true or false. The default is <c>true</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateWithLKG"> <summary> Gets or sets a boolean to control if the LKG configuration will be used for token validation. </summary> <remarks> The default is <c>false</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuerSigningKey"> <summary> Gets or sets a boolean that controls if validation of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the securityToken is called. </summary> <remarks>It is possible for tokens to contain the public key needed to check the signature. For example, X509Data can be hydrated into an X509Certificate, which can be used to validate the signature. In these cases it is important to validate the SigningKey that was used to validate the signature. This boolean only applies to default signing key validation. If <see cref= "P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyValidator" /> is set, it will be called regardless of whether this property is true or false. The default is <c>false</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateLifetime"> <summary> Gets or sets a boolean to control if the lifetime will be validated during token validation. </summary> <remarks> This boolean only applies to default lifetime validation. If <see cref= "P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.LifetimeValidator" /> is set, it will be called regardless of whether this property is true or false. The default is <c>true</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateSignatureLast"> <summary> Gets or sets a boolean that controls the validation order of the payload and signature during token validation. </summary> <remarks>If <see cref= "P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateSignatureLast" /> is set to true, it will validate payload ahead of signature. The default is <c>false</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateTokenReplay"> <summary> Gets or sets a boolean to control if the token replay will be validated during token validation. </summary> <remarks> This boolean only applies to default token replay validation. If <see cref= "P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayValidator" /> is set, it will be called regardless of whether this property is true or false. The default is <c>false</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAlgorithms"> <summary> Gets or sets the valid algorithms for cryptographic operations. </summary> <remarks> If set to a non-empty collection, only the algorithms listed will be considered valid. The default is <c>null</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudience"> <summary> Gets or sets a string that represents a valid audience that will be used to check against the token's audience. The default is <c>null</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudiences"> <summary> Gets or sets the <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains valid audiences that will be used to check against the token's audience. The default is <c>null</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer"> <summary> Gets or sets a <see cref="T:System.String"/> that represents a valid issuer that will be used to check against the token's issuer. The default is <c>null</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers"> <summary> Gets or sets the <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains valid issuers that will be used to check against the token's issuer. The default is <c>null</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidTypes"> <summary> Gets or sets the <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains valid types that will be used to check against the JWT header's 'typ' claim. If this property is not set, the 'typ' header claim will not be validated and all types will be accepted. In the case of a JWE, this property will ONLY apply to the inner token header. The default is <c>null</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidationDelegateAsync"> <summary> Gets or sets a delegate that will be used to validate the issuer of a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.UniqueId"> <summary> Generates unique IDs. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.UniqueId.CreateUniqueId"> <summary> Creates a unique ID suitable for use in an xml:id field. The value is not hard to guess but is unique. </summary> <returns>The unique ID.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.UniqueId.CreateUniqueId(System.String)"> <summary> Creates a unique ID similar to that created by CreateNonRandomId, but instead of an underscore, the supplied prefix is used. </summary> <param name="prefix">The prefix to use.</param> <returns>The unique ID, with the given prefix.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.UniqueId.CreateRandomId"> <summary> Creates a unique, random ID suitable for use in an xml:id field. The value is hard to guess and unique. </summary> <returns>The unique ID.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.UniqueId.CreateRandomId(System.String)"> <summary> Creates a unique, random ID similar to that created by CreateRandomId, but instead of an underscore, the supplied prefix is used. </summary> <param name="prefix">The prefix to use.</param> <returns>The random URI.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.UniqueId.CreateRandomUri"> <summary> Creates a unique, random ID suitable for use as a URI. The value is hard to guess and unique. The URI is in the urn:uuid: namespace. </summary> <returns>The random URI.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.Utility"> <summary> Contains some utility methods. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.Utility.Empty"> <summary> A string with "empty" value. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.Utility.Null"> <summary> A string with "null" value. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.Utility.CloneByteArray(System.Byte[])"> <summary> Creates a copy of the byte array. </summary> <param name="src">The resource array.</param> <returns>A copy of the byte array.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Utility.SerializeAsSingleCommaDelimitedString(System.Collections.Generic.IEnumerable{System.String})"> <summary> Serializes the list of strings into string as follows: 'str1','str2','str3' ... </summary> <param name="strings"> The strings used to build a comma delimited string. </param> <returns> The single <see cref="T:System.String"/>. </returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Utility.IsHttps(System.String)"> <summary> Returns whether the input string is https. </summary> <param name="address">The input string.</param> <remarks>true if the input string is https; otherwise, false.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Utility.IsHttps(System.Uri)"> <summary> Returns whether the input uri is https. </summary> <param name="uri"><see cref="T:System.Uri"/>.</param> <returns>true if the input uri is https; otherwise, false.</returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Utility.AreEqual(System.Byte[],System.Byte[])"> <summary> Compares two byte arrays for equality. Hash size is fixed normally it is 32 bytes. The attempt here is to take the same time if an attacker shortens the signature OR changes some of the signed contents. </summary> <param name="a"> One set of bytes to compare. </param> <param name="b"> The other set of bytes to compare with. </param> <returns> true if the bytes are equal, false otherwise. </returns> </member> <member name="M:Microsoft.IdentityModel.Tokens.Utility.AreEqual(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte},System.Int32)"> <summary> Compares two byte spans for equality. Hash size is fixed normally it is 32 bytes. The attempt here is to take the same time if an attacker shortens the signature OR changes some of the signed contents. </summary> <param name="a"> One set of bytes to compare. </param> <param name="b"> The other set of bytes to compare with. </param> <param name="length">length of spans to check</param> <returns> true if the bytes are equal, false otherwise. </returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.AlgorithmValidationResult"> <summary> Contains the result of validating the Algorithm of a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/> contains a collection of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> for each step in the token validation. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AlgorithmValidationResult.#ctor(System.String)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.AlgorithmValidationResult"/>. </summary> <paramref name="algorithm"/>The algorithm to be validated. </member> <member name="M:Microsoft.IdentityModel.Tokens.AlgorithmValidationResult.#ctor(System.String,Microsoft.IdentityModel.Tokens.ValidationFailureType,Microsoft.IdentityModel.Tokens.ExceptionDetail)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.AlgorithmValidationResult"/> </summary> <paramref name="algorithm"/>The algorithm to be validated. <paramref name="validationFailure"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ValidationFailureType"/> that occurred during validation. <paramref name="exceptionDetail"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"/> that occurred during validation. </member> <member name="P:Microsoft.IdentityModel.Tokens.AlgorithmValidationResult.Exception"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.AlgorithmValidationResult.Exception"/> that occurred during validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.AlgorithmValidationResult.Algorithm"> <summary> Gets the algorithm used to sign the token. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.AudienceValidationResult"> <summary> Contains the result of validating the audiences from a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/> contains a collection of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> for each step in the token validation. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.AudienceValidationResult.#ctor(System.String)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.AudienceValidationResult"/>. </summary> <paramref name="audience"/> is the audience that was validated successfully. </member> <member name="M:Microsoft.IdentityModel.Tokens.AudienceValidationResult.#ctor(System.String,Microsoft.IdentityModel.Tokens.ValidationFailureType,Microsoft.IdentityModel.Tokens.ExceptionDetail)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidationResult"/> </summary> <paramref name="audience"/> is the audience that was intended to be validated. <paramref name="validationFailure"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ValidationFailureType"/> that occurred during validation. <paramref name="exceptionDetail"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"/> that occurred during validation. </member> <member name="P:Microsoft.IdentityModel.Tokens.AudienceValidationResult.Exception"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.AudienceValidationResult.Exception"/> that occurred during validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.AudienceValidationResult.Audience"> <summary> Gets the audience that was validated or intended to be validated. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"> <summary> Contains information so that Exceptions can be logged or thrown written as required. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ExceptionDetail.#ctor(Microsoft.IdentityModel.Tokens.MessageDetail,System.Type,System.Diagnostics.StackFrame)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"/> </summary> <paramref name="messageDetail"/> contains information about the exception that is used to generate the exception message. <paramref name="exceptionType"/> is the type of exception that occurred. <paramref name="stackFrame"/> contains information about the stack frame where the exception occurred. </member> <member name="M:Microsoft.IdentityModel.Tokens.ExceptionDetail.#ctor(Microsoft.IdentityModel.Tokens.MessageDetail,System.Type,System.Diagnostics.StackFrame,System.Exception)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"/> </summary> <paramref name="messageDetail"/> contains information about the exception that is used to generate the exception message. <paramref name="exceptionType"/> is the type of exception that occurred. <paramref name="stackFrame"/> contains information about the stack frame where the exception occurred. <paramref name="innerException"/> is the inner exception that occurred. </member> <member name="M:Microsoft.IdentityModel.Tokens.ExceptionDetail.GetException"> <summary> Creates an instance of an <see cref="T:System.Exception"/> using <see cref="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"/> </summary> <returns>An instantance of an Exception.</returns> </member> <member name="P:Microsoft.IdentityModel.Tokens.ExceptionDetail.ExceptionType"> <summary> Gets the type of exception that occurred. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ExceptionDetail.InnerException"> <summary> Gets the inner exception that occurred. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ExceptionDetail.MessageDetail"> <summary> Gets the message details that are used to generate the exception message. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ExceptionDetail.StackFrames"> <summary> Gets the stack frames where the exception occurred. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.IssuerValidationResult"> <summary> Contains the result of validating a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> issuer. The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/> contains a collection of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> for each step in the token validation. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.IssuerValidationResult.#ctor(System.String,Microsoft.IdentityModel.Tokens.IssuerValidationResult.ValidationSource)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidationResult"/> </summary> <paramref name="issuer"/> is the issuer that was validated successfully. <paramref name="source"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidationResult.ValidationSource"/> indicating how this issuer was validated. </member> <member name="M:Microsoft.IdentityModel.Tokens.IssuerValidationResult.#ctor(System.String,Microsoft.IdentityModel.Tokens.ValidationFailureType,Microsoft.IdentityModel.Tokens.ExceptionDetail,Microsoft.IdentityModel.Tokens.IssuerValidationResult.ValidationSource)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidationResult"/> </summary> <paramref name="issuer"/> is the issuer that was intended to be validated. <paramref name="validationFailure"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ValidationFailureType"/> that occurred during validation. <paramref name="exceptionDetail"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"/> that occurred during validation. <paramref name="source"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidationResult.ValidationSource"/> indicating how this issuer was validated. </member> <member name="P:Microsoft.IdentityModel.Tokens.IssuerValidationResult.Exception"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.IssuerValidationResult.Exception"/> that occurred during validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.IssuerValidationResult.Issuer"> <summary> Gets the issuer that was validated or intended to be validated. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.LifetimeValidationResult"> <summary> Contains the result of validating the lifetime of a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/> contains a collection of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> for each step in the token validation. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.LifetimeValidationResult.#ctor(System.Nullable{System.DateTime},System.Nullable{System.DateTime})"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.LifetimeValidationResult"/> </summary> <paramref name="notBefore"/> is the date from which the token that was validated successfully is valid. <paramref name="expires"/> is the expiration date for the token that was validated successfully. </member> <member name="M:Microsoft.IdentityModel.Tokens.LifetimeValidationResult.#ctor(System.Nullable{System.DateTime},System.Nullable{System.DateTime},Microsoft.IdentityModel.Tokens.ValidationFailureType,Microsoft.IdentityModel.Tokens.ExceptionDetail)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.LifetimeValidationResult"/> </summary> <paramref name="notBefore"/> is the date from which the token is valid. <paramref name="expires"/> is the expiration date for the token. <paramref name="validationFailure"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ValidationFailureType"/> that occurred during validation. <paramref name="exceptionDetail"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"/> that occurred during validation. </member> <member name="P:Microsoft.IdentityModel.Tokens.LifetimeValidationResult.Exception"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.LifetimeValidationResult.Exception"/> that occurred during validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.LifetimeValidationResult.NotBefore"> <summary> Gets the date from which the token is valid. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.LifetimeValidationResult.Expires"> <summary> Gets the expiration date for the token. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.LogDetail"> <summary> Contains information so that logs can be written when needed. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.LogDetail.#ctor(Microsoft.IdentityModel.Tokens.MessageDetail,Microsoft.IdentityModel.Abstractions.EventLogLevel)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.LogDetail"/> </summary> <paramref name="messageDetail"/> contains information about the exception that is used to generate the exception message. <paramref name="eventLogLevel"/> is the level of the event log. </member> <member name="P:Microsoft.IdentityModel.Tokens.LogDetail.EventLogLevel"> <summary> Gets the level of the event log. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.LogDetail.MessageDetail"> <summary> Gets the message detail. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.MessageDetail"> <summary> Contains information about a message that is used to generate a message for logging or exceptions. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.MessageDetail.#ctor(System.String,System.Object[])"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.MessageDetail"/> </summary> <param name="formatString">The message to be formated.</param> <param name="parameters">The parameters for formatting.</param> </member> <member name="P:Microsoft.IdentityModel.Tokens.MessageDetail.Message"> <summary> Gets the formatted message. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.ReplayValidationResult"> <summary> Contains the result of validating that a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> has not been replayed. The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/> contains a collection of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> for each step in the token validation. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ReplayValidationResult.#ctor(System.Nullable{System.DateTime})"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.ReplayValidationResult"/>. </summary> <paramref name="expirationTime"/> is the expiration date against which the token was validated. </member> <member name="M:Microsoft.IdentityModel.Tokens.ReplayValidationResult.#ctor(System.Nullable{System.DateTime},Microsoft.IdentityModel.Tokens.ValidationFailureType,Microsoft.IdentityModel.Tokens.ExceptionDetail)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.ReplayValidationResult"/> </summary> <paramref name="expirationTime"/> is the expiration date against which the token was validated. <paramref name="validationFailure"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ValidationFailureType"/> that occurred during validation. <paramref name="exceptionDetail"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"/> that occurred during validation. </member> <member name="P:Microsoft.IdentityModel.Tokens.ReplayValidationResult.Exception"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.ReplayValidationResult.Exception"/> that occurred during validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ReplayValidationResult.ExpirationTime"> <summary> Gets the expiration date against which the token was validated. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.SigningKeyValidationResult"> <summary> Contains the result of validating the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used to sign a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/> contains a collection of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> for each step in the token validation. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.SigningKeyValidationResult.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.SigningKeyValidationResult"/> </summary> <paramref name="signingKey"/> is the security key that was validated successfully. </member> <member name="M:Microsoft.IdentityModel.Tokens.SigningKeyValidationResult.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,Microsoft.IdentityModel.Tokens.ValidationFailureType,Microsoft.IdentityModel.Tokens.ExceptionDetail)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.SigningKeyValidationResult"/> </summary> <paramref name="signingKey"/> is the security key that was intended to be validated. <paramref name="validationFailure"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ValidationFailureType"/> that occurred during validation. <paramref name="exceptionDetail"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"/> that occurred during validation. </member> <member name="P:Microsoft.IdentityModel.Tokens.SigningKeyValidationResult.Exception"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.SigningKeyValidationResult.Exception"/> that occurred during validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.SigningKeyValidationResult.SigningKey"> <summary> Gets the security key that was validated or intended to be validated. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.TokenReadingResult"> <summary> Contains the result of reading a <see cref="M:Microsoft.IdentityModel.Tokens.TokenReadingResult.SecurityToken"/>. The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/> contains a collection of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> for each step in the token validation. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenReadingResult.#ctor(Microsoft.IdentityModel.Tokens.SecurityToken,System.String)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.TokenReadingResult"/>. </summary> <paramref name="tokenInput"/> is the string from which the <see cref="M:Microsoft.IdentityModel.Tokens.TokenReadingResult.SecurityToken"/> was created. <paramref name="securityToken"/> is the <see cref="M:Microsoft.IdentityModel.Tokens.TokenReadingResult.SecurityToken"/> that was created. </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenReadingResult.#ctor(System.String,Microsoft.IdentityModel.Tokens.ValidationFailureType,Microsoft.IdentityModel.Tokens.ExceptionDetail)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.TokenReadingResult"/> </summary> <paramref name="tokenInput"/> is the string that failed to create a <see cref="M:Microsoft.IdentityModel.Tokens.TokenReadingResult.SecurityToken"/>. <paramref name="validationFailure"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ValidationFailureType"/> that occurred during reading. <paramref name="exceptionDetail"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"/> that occurred during reading. </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenReadingResult.SecurityToken"> <summary> Gets the <see cref="M:Microsoft.IdentityModel.Tokens.TokenReadingResult.SecurityToken"/> that was read. </summary> <exception cref="T:System.InvalidOperationException"/> if the <see cref="M:Microsoft.IdentityModel.Tokens.TokenReadingResult.SecurityToken"/> is null. <remarks>It is expected that the caller would check <see cref="P:Microsoft.IdentityModel.Tokens.ValidationResult.IsValid"/> returns true before accessing this.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenReadingResult.Exception"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.TokenReadingResult.Exception"/> that occurred during reading. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenReadingResult.TokenInput"> <summary> Gets the string from which the <see cref="M:Microsoft.IdentityModel.Tokens.TokenReadingResult.SecurityToken"/> was read. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.TokenTypeValidationResult"> <summary> Contains the result of validating the TokenType of a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/> contains a collection of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> for each step in the token validation. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenTypeValidationResult.#ctor(System.String)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.TokenTypeValidationResult"/>. </summary> <paramref name="type"/> is the type against which the token was validated. </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenTypeValidationResult.#ctor(System.String,Microsoft.IdentityModel.Tokens.ValidationFailureType,Microsoft.IdentityModel.Tokens.ExceptionDetail)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.TokenTypeValidationResult"/> </summary> <paramref name="type"/> is the type against which the token was validated. <paramref name="validationFailure"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ValidationFailureType"/> that occurred during validation. <paramref name="exceptionDetail"/> is the <see cref="T:Microsoft.IdentityModel.Tokens.ExceptionDetail"/> that occurred during validation. </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenTypeValidationResult.Exception"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.TokenTypeValidationResult.Exception"/> that occurred during validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenTypeValidationResult.Type"> <summary> Gets the security token type. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"> <summary> Contains artifacts obtained when a SecurityToken is validated. A SecurityTokenHandler returns an instance that captures the results of validating a token. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenValidationResult.#ctor"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenValidationResult.#ctor(Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenHandler,Microsoft.IdentityModel.Tokens.TokenValidationParameters,System.String)"> <summary> This ctor is used by the JsonWebTokenHandler as part of delaying creation of ClaimsIdentity. </summary> <param name="securityToken"></param> <param name="tokenHandler"></param> <param name="validationParameters"></param> <param name="issuer"></param> </member> <member name="M:Microsoft.IdentityModel.Tokens.TokenValidationResult.AddValidationResult(Microsoft.IdentityModel.Tokens.ValidationResult)"> <summary> Adds a <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> to the list of <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.ValidationResults"/>. </summary> <param name="validationResult"> the <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> associated with one of the validation steps. For example <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidationResult"/>.</param> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.Claims"> <summary> The <see cref="T:System.Collections.Generic.Dictionary`2"/> created from the validated security token. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.ClaimsIdentity"> <summary> The <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.ClaimsIdentity"/> created from the validated security token. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.ClaimsIdentityNoLocking"> <summary> Gets or sets the <see cref="F:Microsoft.IdentityModel.Tokens.TokenValidationResult._claimsIdentity"/> without synchronization. All accesses must either be protected or used when the caller knows access is serialized. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.ClaimsIdentitySyncObj"> <summary>Gets the object to use in <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.ClaimsIdentity"/> for double-checked locking.</summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.Exception"> <summary> Gets or sets the <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.Exception"/> that occurred during validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.Issuer"> <summary> Gets or sets the issuer that was found in the token. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.IsValid"> <summary> True if the token was successfully validated, false otherwise. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.PropertyBag"> <summary> Gets or sets the <see cref="T:System.Collections.Generic.IDictionary`2"/> that contains a collection of custom key/value pairs. This allows addition of data that could be used in custom scenarios. This uses <see cref="P:System.StringComparer.Ordinal"/> for case-sensitive comparison of keys. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.SecurityToken"> <summary> Gets or sets the <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.SecurityToken"/> that was validated. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.TokenOnFailedValidation"> <summary> The <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.SecurityToken"/> to be returned when validation fails. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.TokenContext"> <summary> Gets or sets the <see cref="T:Microsoft.IdentityModel.Tokens.CallContext"/> that contains call information. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.TokenType"> <summary> Gets or sets the token type of the <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.SecurityToken"/> that was validated. When a <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TypeValidator"/> is registered, the type returned by the delegate is used to populate this property. Otherwise, the type is resolved from the token itself, if available (e.g for a JSON Web Token, from the "typ" header). </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationResult.ValidationResults"> <summary> Gets the list of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> that contains the result of validating the token. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.ValidationFailureType"> <summary> The type of the failure that occurred when validating a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ValidationFailureType.#ctor(System.String)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/> </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationFailureType.Name"> <summary> Gets the name of the <see cref="T:Microsoft.IdentityModel.Tokens.ValidationFailureType"/>. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailureType.NullArgument"> <summary> Defines a type that represents a required parameter was null. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailureType.IssuerValidationFailed"> <summary> Defines a type that represents that issuer validation failed. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailureType.AlgorithmValidationFailed"> <summary> Defines a type that represents an algorithm validation failed. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailureType.AudienceValidationFailed"> <summary> Defines a type that represents that audience validation failed. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailureType.TokenTypeValidationFailed"> <summary> Defines a type that represents that token type validation failed. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailureType.SigningKeyValidationFailed"> <summary> Defines a type that represents that signing key validation failed. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailureType.LifetimeValidationFailed"> <summary> Defines a type that represents that lifetime validation failed. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailureType.TokenReplayValidationFailed"> <summary> Defines a type that represents that token replay validation failed. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailureType.TokenReadingFailed"> <summary> Defines a type that represents that a token could not be read. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailureType.ValidationNotEvaluated"> <summary> Defines a type that represents that no evaluation has taken place. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationFailureType.ValidationSucceeded"> <summary> Defines a type that represents that no evaluation has taken place. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.ValidationParameters"> <summary> Contains a set of parameters that are used by a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler"/> when validating a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationParameters.DefaultAuthenticationType"> <summary> This is the default value of <see cref="P:System.Security.Claims.ClaimsIdentity.AuthenticationType"/> when creating a <see cref="T:System.Security.Claims.ClaimsIdentity"/>. The value is <c>"AuthenticationTypes.Federation"</c>. To change the value, set <see cref="P:Microsoft.IdentityModel.Tokens.ValidationParameters.AuthenticationType"/> to a different value. </summary> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationParameters.DefaultClockSkew"> <summary> Default for the clock skew. </summary> <remarks>300 seconds (5 minutes).</remarks> </member> <member name="F:Microsoft.IdentityModel.Tokens.ValidationParameters.DefaultMaximumTokenSizeInBytes"> <summary> Default for the maximum token size. </summary> <remarks>250 KB (kilobytes).</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.ValidationParameters.#ctor(Microsoft.IdentityModel.Tokens.ValidationParameters)"> <summary> Copy constructor for <see cref="T:Microsoft.IdentityModel.Tokens.ValidationParameters"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ValidationParameters.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.ValidationParameters"/> class. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.ActorValidationParameters"> <summary> Gets or sets <see cref="T:Microsoft.IdentityModel.Tokens.ValidationParameters"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.AlgorithmValidator"> <summary> Gets or sets a delegate used to validate the cryptographic algorithm used. </summary> <remarks> If set, this delegate will validate the cryptographic algorithm used and the algorithm will not be checked against <see cref="P:Microsoft.IdentityModel.Tokens.ValidationParameters.ValidAlgorithms"/>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.AudienceValidator"> <summary> Gets or sets a delegate that will be used to validate the audience. </summary> <remarks> If set, this delegate will be called to validate the 'audience', instead of default processing. This means that no default 'audience' validation will occur. Even if <see cref="T:Microsoft.IdentityModel.Tokens.ValidateAudience"/> is false, this delegate will still be called. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.AuthenticationType"> <summary> Gets or sets the AuthenticationType when creating a <see cref="T:System.Security.Claims.ClaimsIdentity"/>. </summary> <exception cref="T:System.ArgumentNullException">If 'value' is null or whitespace.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.ClockSkew"> <summary> Gets or sets the clock skew to apply when validating a time. </summary> <exception cref="T:System.ArgumentOutOfRangeException">If 'value' is less than 0.</exception> The default is <c>300</c> seconds (5 minutes). </member> <member name="M:Microsoft.IdentityModel.Tokens.ValidationParameters.Clone"> <summary> Returns a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationParameters"/> with values copied from this object. </summary> <returns>A new <see cref="T:Microsoft.IdentityModel.Tokens.ValidationParameters"/> object copied from this object</returns> <remarks>This is a shallow Clone.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.ValidationParameters.CreateClaimsIdentity(Microsoft.IdentityModel.Tokens.SecurityToken,System.String)"> <summary> Creates a <see cref="T:System.Security.Claims.ClaimsIdentity"/> using: <para><see cref="P:Microsoft.IdentityModel.Tokens.ValidationParameters.AuthenticationType"/></para> <para>'NameClaimType': If NameClaimTypeRetriever is set, call delegate, else call NameClaimType. If the result is a null or empty string, use <see cref="F:System.Security.Claims.ClaimsIdentity.DefaultNameClaimType"/></para>. <para>'RoleClaimType': If RoleClaimTypeRetriever is set, call delegate, else call RoleClaimType. If the result is a null or empty string, use <see cref="F:System.Security.Claims.ClaimsIdentity.DefaultRoleClaimType"/></para>. </summary> <returns>A <see cref="T:System.Security.Claims.ClaimsIdentity"/> with Authentication, NameClaimType and RoleClaimType set.</returns> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.ConfigurationManager"> <summary> If set, this property will be used to obtain the issuer and signing keys associated with the metadata endpoint of <see cref="P:Microsoft.IdentityModel.Tokens.BaseConfiguration.Issuer"/>. The obtained issuer and signing keys will then be used along with those present on the ValidationParameters for validation of the incoming token. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.CryptoProviderFactory"> <summary> Users can override the default <see cref="P:Microsoft.IdentityModel.Tokens.ValidationParameters.CryptoProviderFactory"/> with this property. This factory will be used for creating signature providers. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.DebugId"> <summary> Gets or sets a string that helps with setting breakpoints when debugging. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.IgnoreTrailingSlashWhenValidatingAudience"> <summary> Gets or sets a boolean that controls if a '/' is significant at the end of the audience. The default is <c>true</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.IncludeTokenOnFailedValidation"> <summary> Gets or sets the flag that indicates whether to include the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> when the validation fails. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.IssuerSigningKeyValidator"> <summary> Gets or sets a delegate for validating the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the token. </summary> <remarks> If set, this delegate will be called to validate the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the token, instead of default processing. This means that no default <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> validation will occur. If both <see cref="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyValidatorUsingConfiguration"/> and <see cref="P:Microsoft.IdentityModel.Tokens.ValidationParameters.IssuerSigningKeyValidator"/> are set, IssuerSigningKeyResolverUsingConfiguration takes priority. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.InstancePropertyBag"> <summary> Gets a <see cref="T:System.Collections.Generic.IDictionary`2"/> that is unique to this instance. Calling <see cref="M:Microsoft.IdentityModel.Tokens.ValidationParameters.Clone"/> will result in a new instance of this IDictionary. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.IsClone"> <summary> Gets a value indicating if <see cref="M:Microsoft.IdentityModel.Tokens.ValidationParameters.Clone"/> was called to obtain this instance. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.IssuerSigningKeyResolver"> <summary> Gets or sets a delegate that will be called to retrieve a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used for signature validation. </summary> <remarks> This <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> will be used to check the signature. This can be helpful when the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> does not contain a key identifier. If both <see cref="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyResolverUsingConfiguration"/> and <see cref="P:Microsoft.IdentityModel.Tokens.ValidationParameters.IssuerSigningKeyResolver"/> are set, IssuerSigningKeyResolverUsingConfiguration takes priority. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.IssuerSigningKeys"> <summary> Gets or sets an <see cref="T:System.Collections.Generic.IList`1"/> used for signature validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.IssuerValidatorAsync"> <summary> Gets or sets a delegate that will be used to validate the issuer of the token. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.TransformBeforeSignatureValidation"> <summary> Gets or sets a delegate that will be called to transform a token to a supported format before validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.LifetimeValidator"> <summary> Gets or sets a delegate that will be used to validate the lifetime of the token </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.LogTokenId"> <summary> Gets or sets a <see cref="T:System.Boolean"/> that will decide if the token identifier claim needs to be logged. Default value is <c>true</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.NameClaimType"> <summary> Gets or sets a <see cref="T:System.String"/> that defines the <see cref="P:System.Security.Claims.ClaimsIdentity.NameClaimType"/>. </summary> <remarks> Controls the value <see cref="P:System.Security.Claims.ClaimsIdentity.Name"/> returns. It will return the first <see cref="P:System.Security.Claims.Claim.Value"/> where the <see cref="P:System.Security.Claims.Claim.Type"/> equals <see cref="P:Microsoft.IdentityModel.Tokens.ValidationParameters.NameClaimType"/>. The default is <see cref="F:System.Security.Claims.ClaimsIdentity.DefaultNameClaimType"/>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.NameClaimTypeRetriever"> <summary> Gets or sets a delegate that will be called to set the property <see cref="P:System.Security.Claims.ClaimsIdentity.NameClaimType"/> after validating a token. </summary> <remarks> The function will be passed: <para>The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</para> <para>The issuer associated with the token.</para> <para>Returns the value that will set the property <see cref="P:System.Security.Claims.ClaimsIdentity.NameClaimType"/>.</para> </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.PropertyBag"> <summary> Gets or sets the <see cref="T:System.Collections.Generic.IDictionary`2"/> that contains a collection of custom key/value pairs. This allows addition of parameters that could be used in custom token validation scenarios. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.RefreshBeforeValidation"> <summary> Gets or sets a boolean to control if configuration required to be refreshed before token validation. </summary> <remarks> The default is <c>false</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.RoleClaimType"> <summary> Gets or sets the <see cref="T:System.String"/> that defines the <see cref="P:System.Security.Claims.ClaimsIdentity.RoleClaimType"/>. </summary> <remarks> <para>Controls the results of <see cref="M:System.Security.Claims.ClaimsPrincipal.IsInRole(System.String)"/>.</para> <para>Each <see cref="T:System.Security.Claims.Claim"/> where <see cref="P:System.Security.Claims.Claim.Type"/> == <see cref="P:Microsoft.IdentityModel.Tokens.ValidationParameters.RoleClaimType"/> will be checked for a match against the 'string' passed to <see cref="M:System.Security.Claims.ClaimsPrincipal.IsInRole(System.String)"/>.</para> The default is <see cref="F:System.Security.Claims.ClaimsIdentity.DefaultRoleClaimType"/>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.RoleClaimTypeRetriever"> <summary> Gets or sets a delegate that will be called to set the property <see cref="P:System.Security.Claims.ClaimsIdentity.RoleClaimType"/> after validating a token. </summary> <remarks> The function will be passed: <para>The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</para> <para>The issuer associated with the token.</para> <para>Returns the value that will set the property <see cref="P:System.Security.Claims.ClaimsIdentity.RoleClaimType"/>.</para> </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.SaveSigninToken"> <summary> Gets or sets a boolean to control if the original token should be saved after the security token is validated. </summary> <remarks>The runtime will consult this value and save the original token that was validated. The default is <c>false</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.SignatureValidator"> <summary> Gets or sets a delegate that will be used to validate the signature of the token. </summary> <remarks> If set, this delegate will be called to validate the signature of the token, instead of default processing. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.TokenDecryptionKeyResolver"> <summary> Gets or sets a delegate that will be called to retreive a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used for decryption. </summary> <remarks> This <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> will be used to decrypt the token. This can be helpful when the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> does not contain a key identifier. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.TokenDecryptionKeys"> <summary> Gets the <see cref="T:System.Collections.Generic.IList`1"/> that is to be used for decrypting inbound tokens. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.TokenReplayCache"> <summary> Gets or set the <see cref="T:Microsoft.IdentityModel.Tokens.ITokenReplayCache"/> that store tokens that can be checked to help detect token replay. </summary> <remarks>If set, then tokens must have an expiration time or the runtime will fault.</remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.TokenReplayValidator"> <summary> Gets or sets a delegate that will be used to validate the token replay of the token </summary> <remarks> If set, this delegate will be called to validate the token replay of the token, instead of default processing. This means no default token replay validation will occur. Even if <see cref="T:Microsoft.IdentityModel.Tokens.ValidateTokenReplay"/> is false, this delegate will still be called. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.TypeValidator"> <summary> Gets or sets a delegate that will be used to validate the type of the token. If the token type cannot be validated, an exception MUST be thrown by the delegate. Note: the 'type' parameter may be null if it couldn't be extracted from its usual location. Implementations that need to resolve it from a different location can use the 'token' parameter. </summary> <remarks> If set, this delegate will be called to validate the 'type' of the token, instead of default processing. This means that no default 'type' validation will occur. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.ValidateWithLKG"> <summary> Gets or sets a boolean to control if the LKG configuration will be used for token validation. </summary> <remarks> The default is <c>false</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.ValidateSignatureLast"> <summary> Gets or sets a boolean that controls the validation order of the payload and signature during token validation. </summary> <remarks>If <see cref= "P:Microsoft.IdentityModel.Tokens.ValidationParameters.ValidateSignatureLast" /> is set to true, it will validate payload ahead of signature. The default is <c>false</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.ValidAlgorithms"> <summary> Gets or sets the valid algorithms for cryptographic operations. </summary> <remarks> If set to a non-empty collection, only the algorithms listed will be considered valid. The default is <c>null</c>. </remarks> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.ValidAudiences"> <summary> Gets the <see cref="T:System.Collections.Generic.IList`1"/> that contains valid audiences that will be used to check against the token's audience. The default is <c>null</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.ValidIssuers"> <summary> Gets the <see cref="T:System.Collections.Generic.IList`1"/> that contains valid issuers that will be used to check against the token's issuer. The default is <c>null</c>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationParameters.ValidTypes"> <summary> Gets the <see cref="T:System.Collections.Generic.IList`1"/> that contains valid types that will be used to check against the JWT header's 'typ' claim. If this property is not set, the 'typ' header claim will not be validated and all types will be accepted. In the case of a JWE, this property will ONLY apply to the inner token header. The default is <c>null</c>. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.ValidationResult"> <summary> Contains results of a single step in validating a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/> maintains a list of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> for each step in the token validation. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ValidationResult.#ctor"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ValidationResult.#ctor(Microsoft.IdentityModel.Tokens.ValidationFailureType)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> </summary> <param name="validationFailureType">The <see cref="P:Microsoft.IdentityModel.Tokens.ValidationResult.ValidationFailureType"/> that occurred during validation.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.ValidationResult.#ctor(Microsoft.IdentityModel.Tokens.ValidationFailureType,Microsoft.IdentityModel.Tokens.ExceptionDetail)"> <summary> Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.ValidationResult"/> </summary> <param name="validationFailureType">The <see cref="P:Microsoft.IdentityModel.Tokens.ValidationResult.ValidationFailureType"/> that occurred during validation.</param> <param name="exceptionDetail"> The <see cref="P:Microsoft.IdentityModel.Tokens.ValidationResult.ExceptionDetail"/> representing the <see cref="P:Microsoft.IdentityModel.Tokens.ValidationResult.Exception"/> that occurred during validation.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.ValidationResult.AddStackFrame(System.Diagnostics.StackFrame)"> <summary> Adds a new stack frame to the exception details. </summary> <param name="stackFrame"></param> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationResult.Exception"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.ValidationResult.Exception"/> that occurred during validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationResult.ExceptionDetail"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.ValidationResult.ExceptionDetail"/> that occurred during validation. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationResult.IsValid"> <summary> True if the token was successfully validated, false otherwise. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationResult.HasValidOrExceptionWasRead"> <summary> Gets or sets a boolean recording if IsValid or Exception was called. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ValidationResult.Log"> <summary> Logs the validation result. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationResult.LogDetails"> <summary> Contains any logs that would have been written. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.ValidationResult.ValidationFailureType"> <summary> Gets the <see cref="P:Microsoft.IdentityModel.Tokens.ValidationResult.ValidationFailureType"/> indicating why the validation was not satisfied. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.Validators"> <summary> Partial class for Audience Validation. </summary> <summary> IssuerValidation </summary> <summary> SigningKeyValidation </summary> <summary> IssuerValidation </summary> <summary> Partial class for Token Replay validation. </summary> <summary> AudienceValidator </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateAlgorithm(System.String,Microsoft.IdentityModel.Tokens.SecurityKey,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.ValidationParameters,Microsoft.IdentityModel.Tokens.CallContext)"> <summary> Validates a given algorithm for a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>. </summary> <param name="algorithm">The algorithm to be validated.</param> <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <param name="callContext"></param> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateAudience(System.Collections.Generic.IEnumerable{System.String},Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.CallContext)"> <summary> Determines if the audiences found in a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> are valid. </summary> <param name="audiences">The audiences found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="callContext"></param> <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null.</exception> <exception cref="T:System.ArgumentNullException">If 'audiences' is null and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateAudience"/> is true.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudience"/> is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudiences"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException">If none of the 'audiences' matched either <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudience"/> or one of <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudiences"/>.</exception> <remarks>An EXACT match is required.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuerAsync(System.String,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.CallContext,System.Threading.CancellationToken)"> <summary> Determines if an issuer found in a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> is valid. </summary> <param name="issuer">The issuer to validate</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="callContext"></param> <param name="cancellationToken"></param> <returns>The issuer to use when creating the "Claim"(s) in a "ClaimsIdentity".</returns> <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null.</exception> <exception cref="T:System.ArgumentNullException">If 'issuer' is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuer"/> is true.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer"/> is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">If 'issuer' failed to matched either <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer"/> or one of <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers"/>.</exception> <remarks>An EXACT match is required.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuerSecurityKey(Microsoft.IdentityModel.Tokens.SecurityKey,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.CallContext)"> <summary> Validates the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="callContext"></param> <exception cref="T:System.ArgumentNullException"> if 'securityKey' is null and ValidateIssuerSigningKey is true.</exception> <exception cref="T:System.ArgumentNullException"> if 'securityToken' is null and ValidateIssuerSigningKey is true.</exception> <exception cref="T:System.ArgumentNullException"> if 'validationParameters' is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuerSecurityKey(Microsoft.IdentityModel.Tokens.SecurityKey,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.BaseConfiguration,Microsoft.IdentityModel.Tokens.CallContext)"> <summary> Validates the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="configuration">The <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> required for issuer and signing key validation.</param> <param name="callContext"></param> <exception cref="T:System.ArgumentNullException"> if 'securityKey' is null and ValidateIssuerSigningKey is true.</exception> <exception cref="T:System.ArgumentNullException"> if 'securityToken' is null and ValidateIssuerSigningKey is true.</exception> <exception cref="T:System.ArgumentNullException"> if 'validationParameters' is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuerSigningKeyLifeTime(Microsoft.IdentityModel.Tokens.SecurityKey,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.CallContext)"> <summary> Given a signing key, when it's derived from a certificate, validates that the certificate is already active and non-expired </summary> <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="callContext"></param> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateLifetime(System.Nullable{System.DateTime},System.Nullable{System.DateTime},Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.CallContext)"> <summary> Validates the lifetime of a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <param name="notBefore">The 'notBefore' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="expires">The 'expiration' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="callContext"></param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.LifetimeValidationResult"/> indicating whether validation was successful, and providing a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException"/> if it was not.</returns> <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException">If 'expires.HasValue' is false and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireExpirationTime"/> is true.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException">If 'notBefore' is > 'expires'.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException">If 'notBefore' is > DateTime.UtcNow.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException">If 'expires' is < DateTime.UtcNow.</exception> <remarks>All time comparisons apply <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ClockSkew"/>.</remarks> <remarks>Exceptions are not thrown, but embedded in <see cref="P:Microsoft.IdentityModel.Tokens.LifetimeValidationResult.Exception"/>.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateTokenReplay(System.Nullable{System.DateTime},System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.CallContext)"> <summary> Validates if a token has been replayed. </summary> <param name="expirationTime">When does the security token expire.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="callContext"></param> <exception cref="T:System.ArgumentNullException">If 'securityToken' is null or whitespace.</exception> <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null or whitespace.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"/> is not null and expirationTime.HasValue is false. When a TokenReplayCache is set, tokens require an expiration time.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException">If the 'securityToken' is found in the cache.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException">If the 'securityToken' could not be added to the <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"/>.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateTokenType(System.String,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.CallContext)"> <summary> Validates the type of the token. </summary> <param name="type">The token type or <c>null</c> if it couldn't be resolved (e.g from the 'typ' header for a JWT).</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <param name="callContext"></param> <exception cref="T:System.ArgumentNullException">If <paramref name="validationParameters"/> is null.</exception> <exception cref="T:System.ArgumentNullException">If <paramref name="securityToken"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException">If <paramref name="type"/> is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidTypes"/> is not null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException">If <paramref name="type"/> failed to match <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidTypes"/>.</exception> <remarks>An EXACT match is required. <see cref="F:System.StringComparison.Ordinal"/> (case sensitive) is used for comparing <paramref name="type"/> against <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidTypes"/>.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateAlgorithm(System.String,Microsoft.IdentityModel.Tokens.SecurityKey,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Validates if a given algorithm for a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> is valid. </summary> <param name="algorithm">The algorithm to be validated.</param> <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateAudience(System.Collections.Generic.IEnumerable{System.String},Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Determines if the audiences found in a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> are valid. </summary> <param name="audiences">The audiences found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null.</exception> <exception cref="T:System.ArgumentNullException">If 'audiences' is null and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateAudience"/> is true.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudience"/> is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudiences"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException">If none of the 'audiences' matched either <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudience"/> or one of <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudiences"/>.</exception> <remarks>An EXACT match is required.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuer(System.String,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Determines if an issuer found in a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> is valid. </summary> <param name="issuer">The issuer to validate</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <returns>The issuer to use when creating the "Claim"(s) in a "ClaimsIdentity".</returns> <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null.</exception> <exception cref="T:System.ArgumentNullException">If 'issuer' is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuer"/> is true.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer"/> is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">If 'issuer' failed to matched either <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer"/> or one of <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers"/>.</exception> <remarks>An EXACT match is required.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuer(System.String,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.BaseConfiguration)"> <summary> Determines if an issuer found in a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> is valid. </summary> <param name="issuer">The issuer to validate</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <param name="configuration">The <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> required for issuer and signing key validation.</param> <returns>The issuer to use when creating the "Claim"(s) in a "ClaimsIdentity".</returns> <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null.</exception> <exception cref="T:System.ArgumentNullException">If 'issuer' is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuer"/> is true.</exception> <exception cref="T:System.ArgumentNullException">If ' configuration' is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer"/> is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers"/> is null and <see cref="P:Microsoft.IdentityModel.Tokens.BaseConfiguration.Issuer"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">If 'issuer' failed to matched either <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer"/> or one of <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers"/> or <see cref="P:Microsoft.IdentityModel.Tokens.BaseConfiguration.Issuer"/>.</exception> <remarks>An EXACT match is required.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuerAsync(System.String,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.BaseConfiguration)"> <summary> Determines if an issuer found in a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> is valid. </summary> <param name="issuer">The issuer to validate</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <param name="configuration">The <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> required for issuer and signing key validation.</param> <returns>The issuer to use when creating the "Claim"(s) in a "ClaimsIdentity".</returns> <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null.</exception> <exception cref="T:System.ArgumentNullException">If 'issuer' is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuer"/> is true.</exception> <exception cref="T:System.ArgumentNullException">If ' configuration' is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer"/> is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers"/> is null and <see cref="P:Microsoft.IdentityModel.Tokens.BaseConfiguration.Issuer"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">If 'issuer' failed to matched either <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer"/> or one of <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers"/> or <see cref="P:Microsoft.IdentityModel.Tokens.BaseConfiguration.Issuer"/>.</exception> <remarks>An EXACT match is required.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuerSecurityKey(Microsoft.IdentityModel.Tokens.SecurityKey,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Validates the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <exception cref="T:System.ArgumentNullException"> if 'securityKey' is null and ValidateIssuerSigningKey is true.</exception> <exception cref="T:System.ArgumentNullException"> if 'securityToken' is null and ValidateIssuerSigningKey is true.</exception> <exception cref="T:System.ArgumentNullException"> if 'validationParameters' is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuerSecurityKey(Microsoft.IdentityModel.Tokens.SecurityKey,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.BaseConfiguration)"> <summary> Validates the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <param name="configuration">The <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> required for issuer and signing key validation.</param> <exception cref="T:System.ArgumentNullException"> if 'securityKey' is null and ValidateIssuerSigningKey is true.</exception> <exception cref="T:System.ArgumentNullException"> if 'securityToken' is null and ValidateIssuerSigningKey is true.</exception> <exception cref="T:System.ArgumentNullException"> if 'validationParameters' is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuerSigningKeyLifeTime(Microsoft.IdentityModel.Tokens.SecurityKey,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Given a signing key, when it's derived from a certificate, validates that the certificate is already active and non-expired </summary> <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> that are used to validate the token.</param> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateLifetime(System.Nullable{System.DateTime},System.Nullable{System.DateTime},Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Validates the lifetime of a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <param name="notBefore">The 'notBefore' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="expires">The 'expiration' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException">If 'expires.HasValue' is false and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireExpirationTime"/> is true.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException">If 'notBefore' is > 'expires'.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException">If 'notBefore' is > DateTime.UtcNow.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException">If 'expires' is < DateTime.UtcNow.</exception> <remarks>All time comparisons apply <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ClockSkew"/>.</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateTokenReplay(System.Nullable{System.DateTime},System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Validates if a token has been replayed. </summary> <param name="expirationTime">When does the security token expire.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <exception cref="T:System.ArgumentNullException">If 'securityToken' is null or whitespace.</exception> <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null or whitespace.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"/> is not null and expirationTime.HasValue is false. When a TokenReplayCache is set, tokens require an expiration time.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException">If the 'securityToken' is found in the cache.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException">If the 'securityToken' could not be added to the <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"/>.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateTokenReplay(System.String,System.Nullable{System.DateTime},Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Validates if a token has been replayed. </summary> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="expirationTime">When does the security token expire.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <exception cref="T:System.ArgumentNullException">If 'securityToken' is null or whitespace.</exception> <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null or whitespace.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"/> is not null and expirationTime.HasValue is false. When a TokenReplayCache is set, tokens require an expiration time.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException">If the 'securityToken' is found in the cache.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException">If the 'securityToken' could not be added to the <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"/>.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateTokenType(System.String,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Validates the type of the token. </summary> <param name="type">The token type or <c>null</c> if it couldn't be resolved (e.g from the 'typ' header for a JWT).</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param> <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param> <exception cref="T:System.ArgumentNullException">If <paramref name="validationParameters"/> is null.</exception> <exception cref="T:System.ArgumentNullException">If <paramref name="securityToken"/> is null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException">If <paramref name="type"/> is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidTypes"/> is not null.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidTypeException">If <paramref name="type"/> failed to match <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidTypes"/>.</exception> <remarks>An EXACT match is required. <see cref="F:System.StringComparison.Ordinal"/> (case sensitive) is used for comparing <paramref name="type"/> against <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidTypes"/>.</remarks> <returns>The actual token type, that may be the same as <paramref name="type"/> or a different value if the token type was resolved from a different location.</returns> </member> <member name="T:Microsoft.IdentityModel.Tokens.ValidateAudience"> <summary> Definition for delegate that will validate the audiences value in a token. </summary> <param name="audiences">The audiences to validate.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="callContext"></param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidationResult"/>that contains the results of validating the issuer.</returns> <remarks>This delegate is not expected to throw.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.IssuerValidationDelegateAsync"> <summary> Definition for delegate that will validate the issuer value in a token. </summary> <param name="issuer">The issuer to validate.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="callContext"></param> <param name="cancellationToken"></param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidationResult"/>that contains the results of validating the issuer.</returns> <remarks>This delegate is not expected to throw.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.IssuerSecurityKeyValidationDelegate"> <summary> Definition for delegate that will validate the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <param name="signingKey">The security key to validate.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="callContext"></param> <param name="cancellationToken"></param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.SigningKeyValidationResult"/>that contains the results of validating the issuer.</returns> <remarks>This delegate is not expected to throw.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.LifetimeValidationDelegate"> <summary> Definition for delegate that will validate the lifetime of a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <param name="notBefore">The 'notBefore' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="expires">The 'expiration' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="callContext"></param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.IssuerValidationResult"/>that contains the results of validating the issuer.</returns> <remarks>This delegate is not expected to throw.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.ValidateTokenReplay"> <summary> Definition for delegate that will validate that a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> has not been replayed. </summary> <param name="expirationTime">When does the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> expire..</param> <param name="securityToken">The security token that is being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <param name="callContext"></param> <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.ReplayValidationResult"/>that contains the results of validating the token.</returns> <remarks>This delegate is not expected to throw.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.ValidatorUtilities"> <summary> Internal Validator Utilities </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.ValidatorUtilities.ValidateLifetime(System.Nullable{System.DateTime},System.Nullable{System.DateTime},Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"> <summary> Validates the lifetime of a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>. </summary> <param name="notBefore">The 'notBefore' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="expires">The 'expiration' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param> <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param> <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException">If 'expires.HasValue' is false and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireExpirationTime"/> is true.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException">If 'notBefore' is > 'expires'.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException">If 'notBefore' is > DateTime.UtcNow.</exception> <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException">If 'expires' is < DateTime.UtcNow.</exception> <remarks>All time comparisons apply <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ClockSkew"/>.</remarks> </member> <member name="T:Microsoft.IdentityModel.Tokens.X509EncryptingCredentials"> <summary> An <see cref="T:Microsoft.IdentityModel.Tokens.X509EncryptingCredentials"/> designed to construct <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> based on a x509 certificate. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.X509EncryptingCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Designed to construct <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> based on a x509 certificate. </summary> <param name="certificate">A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/></param> <remarks> <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.DefaultAsymmetricKeyWrapAlgorithm"/> will be used as the key wrap algorithm <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.DefaultSymmetricEncryptionAlgorithm"/> will be used as the data encryption algorithm </remarks> <exception cref="T:System.ArgumentNullException">if 'certificate' is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.X509EncryptingCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String,System.String)"> <summary> Designed to construct <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> based on the x509 certificate, a key wrap algorithm, and data encryption algorithm. </summary> <param name="certificate">A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/></param> <param name="keyWrapAlgorithm">A key wrap algorithm</param> <param name="dataEncryptionAlgorithm">Data encryption algorithm</param> <exception cref="T:System.ArgumentNullException">if 'certificate' is null.</exception> <exception cref="T:System.ArgumentNullException">if 'keyWrapAlgorithm' is null or empty.</exception> <exception cref="T:System.ArgumentNullException">if 'dataEncryptionAlgorithm' is null or empty.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.X509EncryptingCredentials.Certificate"> <summary> Gets the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> used by this instance. </summary> </member> <member name="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"> <summary> An <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> that is backed by a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Instantiates a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> using a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> </summary> <param name="certificate">The <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> to use.</param> <exception cref="T:System.ArgumentNullException">if <paramref name="certificate"/> is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String)"> <summary> Instantiates a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> using a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>. </summary> <param name="certificate">The <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> to use.</param> <param name="keyId">The value to set for the KeyId</param> <exception cref="T:System.ArgumentNullException">if <paramref name="certificate"/> is null.</exception> <exception cref="T:System.ArgumentNullException">if <paramref name="keyId"/> is null or empty.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.KeySize"> <summary> Gets the key size. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.X5t"> <summary> Gets the X5t of this <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.PrivateKey"> <summary> Returns the private key from the <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.PublicKey"> <summary> Gets the public key from the <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/>. </summary> </member> <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.HasPrivateKey"> <summary> Gets a bool indicating if a private key exists. </summary> <return>true if it has a private key; otherwise, false.</return> </member> <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.PrivateKeyStatus"> <summary> Gets an enum indicating if a private key exists. </summary> <return>'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine.</return> </member> <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.Certificate"> <summary> Gets the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.CanComputeJwkThumbprint"> <summary> Determines whether the <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> can compute a JWK thumbprint. </summary> <returns><c>true</c> if JWK thumbprint can be computed; otherwise, <c>false</c>.</returns> <remarks>https://datatracker.ietf.org/doc/html/rfc7638</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.ComputeJwkThumbprint"> <summary> Computes a sha256 hash over the <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/>. </summary> <returns>A JWK thumbprint.</returns> <remarks>https://datatracker.ietf.org/doc/html/rfc7638</remarks> </member> <member name="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.Equals(System.Object)"> <summary> Returns a bool indicating if this key is equivalent to another key. </summary> <return>true if the keys are equal; otherwise, false.</return> </member> <member name="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.GetHashCode"> <summary> Returns an int hash code. </summary> <return>An int hash code</return> </member> <member name="T:Microsoft.IdentityModel.Tokens.X509SigningCredentials"> <summary> Defines the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>, algorithm and digest for digital signatures. </summary> </member> <member name="M:Microsoft.IdentityModel.Tokens.X509SigningCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.X509SigningCredentials"/> class. </summary> <param name="certificate"><see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that will be used for signing.</param> <remarks>Algorithm will be set to <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/>. the 'digest method' if needed may be implied from the algorithm. For example <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/> implies Sha256.</remarks> <exception cref="T:System.ArgumentNullException">if 'certificate' is null.</exception> </member> <member name="M:Microsoft.IdentityModel.Tokens.X509SigningCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.X509SigningCredentials"/> class. </summary> <param name="certificate">A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that will be used for signing.</param> <param name="algorithm">The signature algorithm to be used.</param> <remarks>the 'digest method' if needed may be implied from the algorithm. For example <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/> implies Sha256.</remarks> <exception cref="T:System.ArgumentNullException">if 'certificate' is null.</exception> <exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception> </member> <member name="P:Microsoft.IdentityModel.Tokens.X509SigningCredentials.Certificate"> <summary> Gets the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> used by this instance. </summary> </member> </members> </doc> |