-- librerías actualizadas
This commit is contained in:
Binary file not shown.
BIN
Bin/BouncyCastle.Crypto.dll.refresh
Normal file
BIN
Bin/BouncyCastle.Crypto.dll.refresh
Normal file
Binary file not shown.
File diff suppressed because it is too large
Load Diff
BIN
Bin/Microsoft.Bcl.TimeProvider.dll
Normal file
BIN
Bin/Microsoft.Bcl.TimeProvider.dll
Normal file
Binary file not shown.
BIN
Bin/Microsoft.Bcl.TimeProvider.dll.refresh
Normal file
BIN
Bin/Microsoft.Bcl.TimeProvider.dll.refresh
Normal file
Binary file not shown.
415
Bin/Microsoft.Bcl.TimeProvider.xml
Normal file
415
Bin/Microsoft.Bcl.TimeProvider.xml
Normal file
@@ -0,0 +1,415 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Bcl.TimeProvider</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.TimeProvider">
|
||||
<summary>Provides an abstraction for time.</summary>
|
||||
</member>
|
||||
<member name="P:System.TimeProvider.System">
|
||||
<summary>
|
||||
Gets a <see cref="T:System.TimeProvider"/> that provides a clock based on <see cref="P:System.DateTimeOffset.UtcNow"/>,
|
||||
a time zone based on <see cref="P:System.TimeZoneInfo.Local"/>, a high-performance time stamp based on <see cref="T:System.Diagnostics.Stopwatch"/>,
|
||||
and a timer based on <see cref="T:System.Threading.Timer"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
If the <see cref="P:System.TimeZoneInfo.Local"/> changes after the object is returned, the change will be reflected in any subsequent operations that retrieve <see cref="M:System.TimeProvider.GetLocalNow"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.TimeProvider.#ctor">
|
||||
<summary>
|
||||
Initializes the <see cref="T:System.TimeProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.TimeProvider.GetUtcNow">
|
||||
<summary>
|
||||
Gets a <see cref="T:System.DateTimeOffset"/> value whose date and time are set to the current
|
||||
Coordinated Universal Time (UTC) date and time and whose offset is Zero,
|
||||
all according to this <see cref="T:System.TimeProvider"/>'s notion of time.
|
||||
</summary>
|
||||
<remarks>
|
||||
The default implementation returns <see cref="P:System.DateTimeOffset.UtcNow"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.TimeProvider.GetLocalNow">
|
||||
<summary>
|
||||
Gets a <see cref="T:System.DateTimeOffset"/> value that is set to the current date and time according to this <see cref="T:System.TimeProvider"/>'s
|
||||
notion of time based on <see cref="M:System.TimeProvider.GetUtcNow"/>, with the offset set to the <see cref="P:System.TimeProvider.LocalTimeZone"/>'s offset from Coordinated Universal Time (UTC).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.TimeProvider.LocalTimeZone">
|
||||
<summary>
|
||||
Gets a <see cref="T:System.TimeZoneInfo"/> object that represents the local time zone according to this <see cref="T:System.TimeProvider"/>'s notion of time.
|
||||
</summary>
|
||||
<remarks>
|
||||
The default implementation returns <see cref="P:System.TimeZoneInfo.Local"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.TimeProvider.TimestampFrequency">
|
||||
<summary>
|
||||
Gets the frequency of <see cref="M:System.TimeProvider.GetTimestamp"/> of high-frequency value per second.
|
||||
</summary>
|
||||
<remarks>
|
||||
The default implementation returns <see cref="F:System.Diagnostics.Stopwatch.Frequency"/>. For a given TimeProvider instance, the value must be idempotent and remain unchanged.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.TimeProvider.GetTimestamp">
|
||||
<summary>
|
||||
Gets the current high-frequency value designed to measure small time intervals with high accuracy in the timer mechanism.
|
||||
</summary>
|
||||
<returns>A long integer representing the high-frequency counter value of the underlying timer mechanism. </returns>
|
||||
<remarks>
|
||||
The default implementation returns <see cref="M:System.Diagnostics.Stopwatch.GetTimestamp"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.TimeProvider.GetElapsedTime(System.Int64,System.Int64)">
|
||||
<summary>
|
||||
Gets the elapsed time between two timestamps retrieved using <see cref="M:System.TimeProvider.GetTimestamp"/>.
|
||||
</summary>
|
||||
<param name="startingTimestamp">The timestamp marking the beginning of the time period.</param>
|
||||
<param name="endingTimestamp">The timestamp marking the end of the time period.</param>
|
||||
<returns>A <see cref="T:System.TimeSpan"/> for the elapsed time between the starting and ending timestamps.</returns>
|
||||
</member>
|
||||
<member name="M:System.TimeProvider.GetElapsedTime(System.Int64)">
|
||||
<summary>
|
||||
Gets the elapsed time since the <paramref name="startingTimestamp"/> value retrieved using <see cref="M:System.TimeProvider.GetTimestamp"/>.
|
||||
</summary>
|
||||
<param name="startingTimestamp">The timestamp marking the beginning of the time period.</param>
|
||||
<returns>A <see cref="T:System.TimeSpan"/> for the elapsed time between the starting timestamp and the time of this call./></returns>
|
||||
</member>
|
||||
<member name="M:System.TimeProvider.CreateTimer(System.Threading.TimerCallback,System.Object,System.TimeSpan,System.TimeSpan)">
|
||||
<summary>Creates a new <see cref="T:System.Threading.ITimer"/> instance, using <see cref="T:System.TimeSpan"/> values to measure time intervals.</summary>
|
||||
<param name="callback">
|
||||
A delegate representing a method to be executed when the timer fires. The method specified for callback should be reentrant,
|
||||
as it may be invoked simultaneously on two threads if the timer fires again before or while a previous callback is still being handled.
|
||||
</param>
|
||||
<param name="state">An object to be passed to the <paramref name="callback"/>. This may be null.</param>
|
||||
<param name="dueTime">The amount of time to delay before <paramref name="callback"/> is invoked. Specify <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> to prevent the timer from starting. Specify <see cref="F:System.TimeSpan.Zero"/> to start the timer immediately.</param>
|
||||
<param name="period">The time interval between invocations of <paramref name="callback"/>. Specify <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> to disable periodic signaling.</param>
|
||||
<returns>
|
||||
The newly created <see cref="T:System.Threading.ITimer"/> instance.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="callback"/> is null.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">The number of milliseconds in the value of <paramref name="dueTime"/> or <paramref name="period"/> is negative and not equal to <see cref="F:System.Threading.Timeout.Infinite"/>, or is greater than <see cref="F:System.Int32.MaxValue"/>.</exception>
|
||||
<remarks>
|
||||
<para>
|
||||
The delegate specified by the callback parameter is invoked once after <paramref name="dueTime"/> elapses, and thereafter each time the <paramref name="period"/> time interval elapses.
|
||||
</para>
|
||||
<para>
|
||||
If <paramref name="dueTime"/> is zero, the callback is invoked immediately. If <paramref name="dueTime"/> is -1 milliseconds, <paramref name="callback"/> is not invoked; the timer is disabled,
|
||||
but can be re-enabled by calling the <see cref="M:System.Threading.ITimer.Change(System.TimeSpan,System.TimeSpan)"/> method.
|
||||
</para>
|
||||
<para>
|
||||
If <paramref name="period"/> is 0 or -1 milliseconds and <paramref name="dueTime"/> is positive, <paramref name="callback"/> is invoked once; the periodic behavior of the timer is disabled,
|
||||
but can be re-enabled using the <see cref="M:System.Threading.ITimer.Change(System.TimeSpan,System.TimeSpan)"/> method.
|
||||
</para>
|
||||
<para>
|
||||
The return <see cref="T:System.Threading.ITimer"/> instance will be implicitly rooted while the timer is still scheduled.
|
||||
</para>
|
||||
<para>
|
||||
<see cref="M:System.TimeProvider.CreateTimer(System.Threading.TimerCallback,System.Object,System.TimeSpan,System.TimeSpan)"/> captures the <see cref="T:System.Threading.ExecutionContext"/> and stores that with the <see cref="T:System.Threading.ITimer"/> for use in invoking <paramref name="callback"/>
|
||||
each time it's called. That capture can be suppressed with <see cref="M:System.Threading.ExecutionContext.SuppressFlow"/>.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.TimeProvider.SystemTimeProviderTimer">
|
||||
<summary>Thin wrapper for a <see cref="T:System.Threading.Timer"/>.</summary>
|
||||
<remarks>
|
||||
We don't return a TimerQueueTimer directly as it implements IThreadPoolWorkItem and we don't
|
||||
want it exposed in a way that user code could directly queue the timer to the thread pool.
|
||||
We also use this instead of Timer because CreateTimer needs to return a timer that's implicitly
|
||||
rooted while scheduled.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.TimeProvider.SystemTimeProvider">
|
||||
<summary>
|
||||
Used to create a <see cref="T:System.TimeProvider"/> instance returned from <see cref="P:System.TimeProvider.System"/> and uses the default implementation
|
||||
provided by <see cref="T:System.TimeProvider"/> which uses <see cref="P:System.DateTimeOffset.UtcNow"/>, <see cref="P:System.TimeZoneInfo.Local"/>, <see cref="T:System.Diagnostics.Stopwatch"/>, and <see cref="T:System.Threading.Timer"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.TimeProvider.SystemTimeProvider.#ctor">
|
||||
<summary>Initializes the instance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Threading.ITimer">
|
||||
<summary>Represents a timer that can have its due time and period changed.</summary>
|
||||
<remarks>
|
||||
Implementations of <see cref="M:System.Threading.ITimer.Change(System.TimeSpan,System.TimeSpan)"/>, <see cref="M:System.IDisposable.Dispose"/>, and <see cref="M:System.IAsyncDisposable.DisposeAsync"/>
|
||||
must all be thread-safe such that the timer instance may be accessed concurrently from multiple threads.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Threading.ITimer.Change(System.TimeSpan,System.TimeSpan)">
|
||||
<summary>Changes the start time and the interval between method invocations for a timer, using <see cref="T:System.TimeSpan"/> values to measure time intervals.</summary>
|
||||
<param name="dueTime">
|
||||
A <see cref="T:System.TimeSpan"/> representing the amount of time to delay before invoking the callback method specified when the <see cref="T:System.Threading.ITimer"/> was constructed.
|
||||
Specify <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> to prevent the timer from restarting. Specify <see cref="F:System.TimeSpan.Zero"/> to restart the timer immediately.
|
||||
</param>
|
||||
<param name="period">
|
||||
The time interval between invocations of the callback method specified when the Timer was constructed.
|
||||
Specify <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> to disable periodic signaling.
|
||||
</param>
|
||||
<returns><see langword="true"/> if the timer was successfully updated; otherwise, <see langword="false"/>.</returns>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime"/> or <paramref name="period"/> parameter, in milliseconds, is less than -1 or greater than 4294967294.</exception>
|
||||
<remarks>
|
||||
It is the responsibility of the implementer of the ITimer interface to ensure thread safety.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:System.Threading.Tasks.TimeProviderTaskExtensions">
|
||||
<summary>
|
||||
Provide extensions methods for <see cref="T:System.Threading.Tasks.Task"/> operations with <see cref="T:System.TimeProvider"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
The Microsoft.Bcl.TimeProvider library interfaces are intended solely for use in building against pre-.NET 8 surface area.
|
||||
If your code is being built against .NET 8 or higher, then this library should not be utilized.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TimeProviderTaskExtensions.Delay(System.TimeProvider,System.TimeSpan,System.Threading.CancellationToken)">
|
||||
<summary>Creates a task that completes after a specified time interval.</summary>
|
||||
<param name="timeProvider">The <see cref="T:System.TimeProvider"/> with which to interpret <paramref name="delay"/>.</param>
|
||||
<param name="delay">The <see cref="T:System.TimeSpan"/> to wait before completing the returned task, or <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> to wait indefinitely.</param>
|
||||
<param name="cancellationToken">A cancellation token to observe while waiting for the task to complete.</param>
|
||||
<returns>A task that represents the time delay.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">The <paramref name="timeProvider"/> argument is null.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="delay"/> represents a negative time interval other than <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/>.</exception>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TimeProviderTaskExtensions.WaitAsync(System.Threading.Tasks.Task,System.TimeSpan,System.TimeProvider,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Gets a <see cref="T:System.Threading.Tasks.Task"/> that will complete when this <see cref="T:System.Threading.Tasks.Task"/> completes, when the specified timeout expires, or when the specified <see cref="T:System.Threading.CancellationToken"/> has cancellation requested.
|
||||
</summary>
|
||||
<param name="task">The task for which to wait on until completion.</param>
|
||||
<param name="timeout">The timeout after which the <see cref="T:System.Threading.Tasks.Task"/> should be faulted with a <see cref="T:System.TimeoutException"/> if it hasn't otherwise completed.</param>
|
||||
<param name="timeProvider">The <see cref="T:System.TimeProvider"/> with which to interpret <paramref name="timeout"/>.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to monitor for a cancellation request.</param>
|
||||
<returns>The <see cref="T:System.Threading.Tasks.Task"/> representing the asynchronous wait. It may or may not be the same instance as the current instance.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">The <paramref name="task"/> argument is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">The <paramref name="timeProvider"/> argument is null.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout"/> represents a negative time interval other than <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/>.</exception>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TimeProviderTaskExtensions.WaitAsync``1(System.Threading.Tasks.Task{``0},System.TimeSpan,System.TimeProvider,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Gets a <see cref="T:System.Threading.Tasks.Task"/> that will complete when this <see cref="T:System.Threading.Tasks.Task"/> completes, when the specified timeout expires, or when the specified <see cref="T:System.Threading.CancellationToken"/> has cancellation requested.
|
||||
</summary>
|
||||
<param name="task">The task for which to wait on until completion.</param>
|
||||
<param name="timeout">The timeout after which the <see cref="T:System.Threading.Tasks.Task"/> should be faulted with a <see cref="T:System.TimeoutException"/> if it hasn't otherwise completed.</param>
|
||||
<param name="timeProvider">The <see cref="T:System.TimeProvider"/> with which to interpret <paramref name="timeout"/>.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to monitor for a cancellation request.</param>
|
||||
<returns>The <see cref="T:System.Threading.Tasks.Task"/> representing the asynchronous wait. It may or may not be the same instance as the current instance.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">The <paramref name="task"/> argument is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">The <paramref name="timeProvider"/> argument is null.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout"/> represents a negative time interval other than <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/>.</exception>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TimeProviderTaskExtensions.CreateCancellationTokenSource(System.TimeProvider,System.TimeSpan)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Threading.CancellationTokenSource"/> class that will be canceled after the specified <see cref="T:System.TimeSpan"/>. </summary>
|
||||
<param name="timeProvider">The <see cref="T:System.TimeProvider"/> with which to interpret the <paramref name="delay"/>. </param>
|
||||
<param name="delay">The time interval to wait before canceling this <see cref="T:System.Threading.CancellationTokenSource"/>. </param>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException"> The <paramref name="delay"/> is negative and not equal to <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> or greater than maximum allowed timer duration.</exception>
|
||||
<returns><see cref="T:System.Threading.CancellationTokenSource"/> that will be canceled after the specified <paramref name="delay"/>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The countdown for the delay starts during the call to the constructor. When the delay expires,
|
||||
the constructed <see cref="T:System.Threading.CancellationTokenSource"/> is canceled if it has
|
||||
not been canceled already.
|
||||
</para>
|
||||
<para>
|
||||
If running on .NET versions earlier than .NET 8.0, there is a constraint when invoking <see cref="M:System.Threading.CancellationTokenSource.CancelAfter(System.TimeSpan)"/> on the resultant object.
|
||||
This action will not terminate the initial timer indicated by <paramref name="delay"/>. However, this restriction does not apply on .NET 8.0 and later versions.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.SR.ArgumentOutOfRange_Generic_MustBeNonNegativeNonZero">
|
||||
<summary>'{0}' must be a non-negative and non-zero value.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.ArgumentOutOfRange_Generic_MustBeGreaterOrEqual">
|
||||
<summary>'{0}' must be greater than or equal to '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.ArgumentOutOfRange_Generic_MustBeLessOrEqual">
|
||||
<summary>'{0}' must be less than or equal to '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.InvalidOperation_TimeProviderNullLocalTimeZone">
|
||||
<summary>The operation cannot be performed when TimeProvider.LocalTimeZone is null.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.InvalidOperation_TimeProviderInvalidTimestampFrequency">
|
||||
<summary>The operation cannot be performed when TimeProvider.TimestampFrequency is zero or negative.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Bin/Microsoft.IdentityModel.Abstractions.dll
Normal file
BIN
Bin/Microsoft.IdentityModel.Abstractions.dll
Normal file
Binary file not shown.
BIN
Bin/Microsoft.IdentityModel.Abstractions.dll.refresh
Normal file
BIN
Bin/Microsoft.IdentityModel.Abstractions.dll.refresh
Normal file
Binary file not shown.
297
Bin/Microsoft.IdentityModel.Abstractions.xml
Normal file
297
Bin/Microsoft.IdentityModel.Abstractions.xml
Normal file
@@ -0,0 +1,297 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.IdentityModel.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.EventLogLevel">
|
||||
<summary>
|
||||
Defines Event Log Levels.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.LogAlways">
|
||||
<summary>
|
||||
No level filtering is done on this log level. Log messages of all levels will be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Critical">
|
||||
<summary>
|
||||
Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
|
||||
immediate attention.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Error">
|
||||
<summary>
|
||||
Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
|
||||
failure in the current activity, not an application-wide failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Warning">
|
||||
<summary>
|
||||
Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
|
||||
application execution to stop.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Informational">
|
||||
<summary>
|
||||
Logs that track the general flow of the application. These logs should have long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Verbose">
|
||||
<summary>
|
||||
Logs that are used for interactive investigation during development. These logs should primarily contain
|
||||
information useful for debugging and have no long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger">
|
||||
<summary>
|
||||
Interface that needs to be implemented by classes providing logging in Microsoft identity libraries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<summary>
|
||||
Checks to see if logging is enabled at given <paramref name="eventLogLevel"/>.
|
||||
</summary>
|
||||
<param name="eventLogLevel">Log level of a message.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<summary>
|
||||
Writes a log entry.
|
||||
</summary>
|
||||
<param name="entry">Defines a structured message to be logged at the provided <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient">
|
||||
<summary>
|
||||
Interface for Telemetry tracking.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.ITelemetryClient.ClientId">
|
||||
<summary>
|
||||
Gets or sets the application or client ID that telemetry is being sent for.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.Initialize">
|
||||
<summary>
|
||||
Perform any necessary bootstrapping for the telemetry client.
|
||||
</summary>
|
||||
<remarks>
|
||||
The expectation is that this should only be called once for the lifetime of the object however the
|
||||
implementation should be idempotent.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled all up.
|
||||
</summary>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent; <see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled(System.String)">
|
||||
<summary>
|
||||
Checks to see if telemetry is enabled for the named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to check.</param>
|
||||
<returns>
|
||||
Returns <see langword="true"/> if telemetry should be sent for <paramref name="eventName"/>;
|
||||
<see langword="false"/> otherwise.
|
||||
</returns>
|
||||
<remarks>
|
||||
This check should be used to gate any resource intensive operations to generate telemetry as well.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventDetails">Details of the event to track.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<summary>
|
||||
Tracks an instance of a named event.
|
||||
</summary>
|
||||
<param name="eventName">Name of the event to track. Should be unique per scenario.</param>
|
||||
<param name="stringProperties">Key value pair of strings to long with the event.</param>
|
||||
<param name="longProperties">Key value pair of longs to long with the event.</param>
|
||||
<param name="boolProperties">Key value pair of bools to long with the event.</param>
|
||||
<param name="dateTimeProperties">Key value pair of DateTimes to long with the event.</param>
|
||||
<param name="doubleProperties">Key value pair of doubles to long with the event.</param>
|
||||
<param name="guidProperties">Key value pair of Guids to long with the event.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.LogEntry">
|
||||
<summary>
|
||||
Defines the structure of a log entry.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel">
|
||||
<summary>
|
||||
Defines the <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.Message">
|
||||
<summary>
|
||||
Message to be logged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.CorrelationId">
|
||||
<summary>
|
||||
A unique identifier for a request that can help with diagnostics across components.
|
||||
</summary>
|
||||
<remarks>
|
||||
Also referred to as ActivityId in Microsoft.IdentityModel.Tokens.CallContext.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger">
|
||||
<summary>
|
||||
A minimalistic <see cref="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger"/> implementation that is disabled by default and doesn't log.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Instance">
|
||||
<summary>
|
||||
Default instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient">
|
||||
<summary>
|
||||
The default implementation of the <see cref="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient"/> interface which swallows all telemetry signals.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.ClientId">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Instance">
|
||||
<summary>
|
||||
Singleton instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.#ctor">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
Private constructor to prevent the default constructor being exposed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled(System.String)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Initialize">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.ObservabilityConstants">
|
||||
<summary>
|
||||
Common class containing observability constants to be used as well known metric keys.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Succeeded">
|
||||
<summary>
|
||||
String used for the name of the property indicating if the call was successful.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Duration">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call in Duration (ms).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ActivityId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the call's Activity Id/Correlation Id.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ClientId">
|
||||
<summary>
|
||||
String used for the name of the property indicating the caller's ClientId.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails">
|
||||
<summary>
|
||||
Details of the telemetry event.
|
||||
</summary>
|
||||
<remarks>
|
||||
This implementation is not meant to be thread-safe. This implementation would either need to be overridden or
|
||||
usage should not be concurrently operated on.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.PropertyValues">
|
||||
<summary>
|
||||
The underlying properties making up the <see cref="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Name">
|
||||
<summary>
|
||||
Name of the telemetry event, should be unique between events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Properties">
|
||||
<summary>
|
||||
Properties which describe the event.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Int64)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.DateTime)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Double)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Guid)">
|
||||
<summary>
|
||||
Sets a property on the event details.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Property value.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
BIN
Bin/Microsoft.IdentityModel.JsonWebTokens.dll.refresh
Normal file
BIN
Bin/Microsoft.IdentityModel.JsonWebTokens.dll.refresh
Normal file
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Binary file not shown.
BIN
Bin/Microsoft.IdentityModel.Logging.dll.refresh
Normal file
BIN
Bin/Microsoft.IdentityModel.Logging.dll.refresh
Normal file
Binary file not shown.
@@ -19,11 +19,21 @@
|
||||
Flag which indicates whether or not PII is shown in logs. False by default.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.LogCompleteSecurityArtifact">
|
||||
<summary>
|
||||
Flag which indicates whether or not complete <see cref="T:Microsoft.IdentityModel.Logging.SecurityArtifact"/> is shown in logs when <see cref="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.ShowPII"/> is set to true. False by default.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.HiddenPIIString">
|
||||
<summary>
|
||||
String that is used in place of any arguments to log messages if the 'ShowPII' flag is set to false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.HiddenSecurityArtifactString">
|
||||
<summary>
|
||||
String that is used in place of any arguments to log messages if the 'LogCompleteSecurityArtifact' flag is set to false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.HeaderWritten">
|
||||
<summary>
|
||||
Indicates whether or the log message header (contains library version, date/time, and PII debugging information) has been written.
|
||||
@@ -181,11 +191,94 @@
|
||||
<param name="key"> The name of the telemetry.</param>
|
||||
<returns> true if the key is successfully removed; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Logging.ISafeLogSecurityArtifact">
|
||||
<summary>
|
||||
Interface that provides an unsafe method to log a security artifact.
|
||||
</summary>
|
||||
<remarks>
|
||||
SecurityToken and encoded token are considered as SecurityArtifacts.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.ISafeLogSecurityArtifact.UnsafeToString">
|
||||
<summary>
|
||||
Returns a string that represents the complete security artifact.
|
||||
This may include sensitive information and should only be used for debugging purposes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Logging.LoggerContext">
|
||||
<summary>
|
||||
A context class that can be used to store work per request to aid with debugging.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.LoggerContext.#ctor">
|
||||
<summary>
|
||||
Instantiates a new <see cref="T:Microsoft.IdentityModel.Logging.LoggerContext"/> with the default activityId.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.LoggerContext.#ctor(System.Guid)">
|
||||
<summary>
|
||||
Instantiates a new <see cref="T:Microsoft.IdentityModel.Logging.LoggerContext"/> with an activityId.
|
||||
</summary>
|
||||
<param name="activityId"></param>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.LoggerContext.ActivityId">
|
||||
<summary>
|
||||
Gets or set a <see cref="T:System.Guid"/> that will be used in the call to EventSource.SetCurrentThreadActivityId before logging.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.LoggerContext.CaptureLogs">
|
||||
<summary>
|
||||
Gets or sets a boolean controlling if logs are written into the context.
|
||||
Useful when debugging.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.LoggerContext.DebugId">
|
||||
<summary>
|
||||
Gets or sets a string that helps with setting breakpoints when debugging.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.LoggerContext.Logs">
|
||||
<summary>
|
||||
The collection of logs associated with a request. Use <see cref="P:Microsoft.IdentityModel.Logging.LoggerContext.CaptureLogs"/> to control capture.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.LoggerContext.PropertyBag">
|
||||
<summary>
|
||||
Gets or sets an <see cref="T:System.Collections.Generic.IDictionary`2"/> that enables custom extensibility scenarios.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Logging.LogHelper">
|
||||
<summary>
|
||||
Helper class for logging.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.LogHelper.Logger">
|
||||
<summary>
|
||||
Gets or sets a logger to which logs will be written to.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Logging.LogHelper._isHeaderWritten">
|
||||
<summary>
|
||||
Indicates whether the log message header (contains library version, date/time, and PII debugging information) has been written.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Logging.LogHelper._piiOffLogMessage">
|
||||
<summary>
|
||||
The log message that is shown when PII is off.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Logging.LogHelper._piiOnLogMessage">
|
||||
<summary>
|
||||
The log message that is shown when PII is on.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.LogHelper.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
|
||||
<summary>
|
||||
Gets whether logging is enabled at the specified <see cref="T:Microsoft.IdentityModel.Abstractions.EventLogLevel"/>."/>
|
||||
</summary>
|
||||
<param name="level">The log level</param>
|
||||
<returns><see langword="true"/> if logging is enabled at the specified level; otherwise, <see langword="false"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentNullException(System.String)">
|
||||
<summary>
|
||||
Logs an exception using the event source logger and returns new <see cref="T:System.ArgumentNullException"/> exception.
|
||||
@@ -381,11 +474,156 @@
|
||||
<param name="args">Format arguments.</param>
|
||||
<returns>Formatted string.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.LogHelper.MarkAsNonPII(System.Object)">
|
||||
<summary>
|
||||
Marks a log message argument (<paramref name="arg"/>) as NonPII.
|
||||
</summary>
|
||||
<param name="arg">A log message argument to be marked as NonPII.</param>
|
||||
<returns>An argument marked as NonPII.</returns>
|
||||
<remarks>
|
||||
Marking an argument as NonPII in <see cref="M:Microsoft.IdentityModel.Logging.LogHelper.FormatInvariant(System.String,System.Object[])"/> calls will result in logging
|
||||
that argument in cleartext, regardless of the <see cref="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.ShowPII"/> flag value.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.LogHelper.MarkAsSecurityArtifact(System.Object,System.Func{System.Object,System.String})">
|
||||
<summary>
|
||||
Marks a log message argument (<paramref name="arg"/>) as SecurityArtifact.
|
||||
</summary>
|
||||
<param name="arg">A log message argument to be marked as SecurityArtifact.</param>
|
||||
<param name="callback">A callback function to log the security artifact safely.</param>
|
||||
<returns>An argument marked as SecurityArtifact.</returns>
|
||||
<remarks>
|
||||
Since even the payload may sometimes contain security artifacts, naïve disarm algorithms such as removing signatures
|
||||
will not work. For now the <paramref name="callback"/> will only be leveraged if
|
||||
<see cref="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.LogCompleteSecurityArtifact"/> is set and no unsafe callback is provided. Future changes
|
||||
may introduce a support for best effort disarm logging.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.LogHelper.MarkAsSecurityArtifact(System.Object,System.Func{System.Object,System.String},System.Func{System.Object,System.String})">
|
||||
<summary>
|
||||
Marks a log message argument (<paramref name="arg"/>) as SecurityArtifact.
|
||||
</summary>
|
||||
<param name="arg">A log message argument to be marked as SecurityArtifact.</param>
|
||||
<param name="callback">A callback function to log the security artifact safely.</param>
|
||||
<param name="callbackUnsafe">A callback function to log the security artifact without scrubbing.</param>
|
||||
<returns>An argument marked as SecurityArtifact.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">if <paramref name="callback"/> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">if <paramref name="callbackUnsafe"/> is null.</exception>
|
||||
<remarks>
|
||||
Since even the payload may sometimes contain security artifacts, naïve disarm algorithms such as removing signatures
|
||||
will not work. For now the <paramref name="callback"/> is currently unused. Future changes
|
||||
may introduce a support for best effort disarm logging which will leverage <paramref name="callback"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.LogHelper.MarkAsUnsafeSecurityArtifact(System.Object,System.Func{System.Object,System.String})">
|
||||
<summary>
|
||||
Marks a log message argument (<paramref name="arg"/>) as SecurityArtifact.
|
||||
</summary>
|
||||
<param name="arg">A log message argument to be marked as SecurityArtifact.</param>
|
||||
<param name="callbackUnsafe">A callback function to log the security artifact without scrubbing.</param>
|
||||
<returns>An argument marked as SecurityArtifact.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">if <paramref name="callbackUnsafe"/> is null.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.LogHelper.WriteEntry(Microsoft.IdentityModel.Abstractions.EventLogLevel,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Creates a <see cref="T:Microsoft.IdentityModel.Abstractions.LogEntry"/> by using the provided event level, exception argument, string argument and arguments list.
|
||||
</summary>
|
||||
<param name="eventLogLevel"><see cref="T:Microsoft.IdentityModel.Abstractions.EventLogLevel"/></param>
|
||||
<param name="innerException"><see cref="T:System.Exception"/></param>
|
||||
<param name="message">The log message.</param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Logging.LogMessages">
|
||||
<summary>
|
||||
Log messages and codes for Microsoft.IdentityModel.Logging
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Logging.NonPII">
|
||||
<summary>
|
||||
An internal structure that is used to mark an argument as NonPII.
|
||||
Arguments wrapped with a NonPII structure will be considered as NonPII in the message logging process.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.NonPII.Argument">
|
||||
<summary>
|
||||
Argument wrapped with a <see cref="T:Microsoft.IdentityModel.Logging.NonPII"/> structure is considered as NonPII in the message logging process.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.NonPII.#ctor(System.Object)">
|
||||
<summary>
|
||||
Creates an instance of <see cref="T:Microsoft.IdentityModel.Logging.NonPII"/> that wraps the <paramref name="argument"/>.
|
||||
</summary>
|
||||
<param name="argument">An argument that is considered as NonPII.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.NonPII.ToString">
|
||||
<summary>
|
||||
Returns a string that represents the <see cref="P:Microsoft.IdentityModel.Logging.NonPII.Argument"/>.
|
||||
</summary>
|
||||
<returns><c>Null</c> if the <see cref="P:Microsoft.IdentityModel.Logging.NonPII.Argument"/> is <see langword="null"/>, otherwise calls <see cref="M:System.ValueType.ToString"/> method of the <see cref="P:Microsoft.IdentityModel.Logging.NonPII.Argument"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Logging.SecurityArtifact">
|
||||
<summary>
|
||||
An internal structure that is used to mark an argument as SecurityArtifact.
|
||||
Arguments wrapped with a SecurityArtifact structure will be considered as a SecurityArtifact in the message logging process.
|
||||
</summary>
|
||||
<remarks>
|
||||
SecurityToken and encoded token are considered as SecurityArtifacts.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.IdentityModel.Logging.SecurityArtifact.Argument">
|
||||
<summary>
|
||||
Argument wrapped with a <see cref="T:Microsoft.IdentityModel.Logging.SecurityArtifact"/> structure is considered as SecurityArtifact in the message logging process.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Logging.SecurityArtifact._disarmCallback">
|
||||
<summary>
|
||||
The ToString callback delegate that returns a disarmed SecurityArtifact.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.IdentityModel.Logging.SecurityArtifact._callbackUnsafe">
|
||||
<summary>
|
||||
The ToString callback delegate that returns an unscrubbed SecurityArtifact.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.SecurityArtifact.#ctor(System.Object,System.Func{System.Object,System.String})">
|
||||
<summary>
|
||||
Creates an instance of <see cref="T:Microsoft.IdentityModel.Logging.SecurityArtifact"/> that wraps the <paramref name="argument"/>.
|
||||
</summary>
|
||||
<param name="argument">An argument that is considered as SecurityArtifact.</param>
|
||||
<param name="toStringCallback">A callback used to disarm the token.</param>
|
||||
<remarks>
|
||||
Since even the payload may sometimes contain security artifacts, naïve disarm algorithms (such as removing signatures
|
||||
in the case of JWTs) will not work. For now the <paramref name="toStringCallback"/> will only be leveraged if
|
||||
<see cref="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.LogCompleteSecurityArtifact"/> is set and no unsafe callback is provided. Future changes
|
||||
may introduce a support for best effort disarm logging.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.SecurityArtifact.#ctor(System.Object,System.Func{System.Object,System.String},System.Func{System.Object,System.String})">
|
||||
<summary>
|
||||
Creates an instance of <see cref="T:Microsoft.IdentityModel.Logging.SecurityArtifact"/> that wraps the <paramref name="argument"/>.
|
||||
</summary>
|
||||
<param name="argument">An argument that is considered as SecurityArtifact.</param>
|
||||
<param name="toStringCallback">A ToString callback.</param>
|
||||
<param name="toStringCallbackUnsafe">A ToString callback which will return the unscrubbed artifact.</param>
|
||||
<remarks>
|
||||
Since even the payload may sometimes contain security artifacts, naïve disarm algorithms (such as removing signatures
|
||||
in the case of JWTs) will not work. For now the <paramref name="toStringCallback"/> is currently unused. Future changes
|
||||
may introduce a support for best effort disarm logging which will leverage <paramref name="toStringCallback"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.SecurityArtifact.UnknownSafeTokenCallback(System.Object)">
|
||||
<summary>
|
||||
A dummy callback which can be leveraged to return a standard scrubbed token in the case where expected token is unknown.
|
||||
</summary>
|
||||
<param name="_">Ignored token.</param>
|
||||
<returns>The standard scrubbed token string.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.IdentityModel.Logging.SecurityArtifact.ToString">
|
||||
<summary>
|
||||
Returns a string that represents the <see cref="P:Microsoft.IdentityModel.Logging.SecurityArtifact.Argument"/>.
|
||||
</summary>
|
||||
<returns><c>Null</c> if the <see cref="P:Microsoft.IdentityModel.Logging.SecurityArtifact.Argument"/> is <see langword="null"/>, otherwise calls the provided safe callback on <see cref="P:Microsoft.IdentityModel.Logging.SecurityArtifact.Argument"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.IdentityModel.Logging.TextWriterEventListener">
|
||||
<summary>
|
||||
Event listener that writes logs to a file or a fileStream provided by user.
|
||||
@@ -424,5 +662,210 @@
|
||||
Releases all resources used by the current instance of the <see cref="T:Microsoft.IdentityModel.Logging.TextWriterEventListener"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
|
||||
<summary>
|
||||
Indicates that the specified method requires dynamic access to code that is not referenced
|
||||
statically, for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which methods are unsafe to call when removing unreferenced
|
||||
code from an application.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute"/> class
|
||||
with the specified message.
|
||||
</summary>
|
||||
<param name="message">
|
||||
A message that contains information about the usage of unreferenced code.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
|
||||
<summary>
|
||||
Gets a message that contains information about the usage of unreferenced code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
|
||||
<summary>
|
||||
Gets or sets an optional URL that contains more information about the method,
|
||||
why it requires unreferenced code, and what options a consumer has to deal with it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
|
||||
<summary>
|
||||
Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
|
||||
single code artifact.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
|
||||
<see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
|
||||
<see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
|
||||
class, specifying the category of the tool and the identifier for an analysis rule.
|
||||
</summary>
|
||||
<param name="category">The category for the attribute.</param>
|
||||
<param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
|
||||
<summary>
|
||||
Gets the category identifying the classification of the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
|
||||
for which a message suppression attribute applies.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
|
||||
<summary>
|
||||
Gets the identifier of the analysis tool rule to be suppressed.
|
||||
</summary>
|
||||
<remarks>
|
||||
Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
|
||||
properties form a unique check identifier.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
|
||||
<summary>
|
||||
Gets or sets the scope of the code that is relevant for the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The Scope property is an optional argument that specifies the metadata scope for which
|
||||
the attribute is relevant.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
|
||||
<summary>
|
||||
Gets or sets a fully qualified path that represents the target of the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
|
||||
of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
|
||||
Because it is fully qualified, it can be long, particularly for targets such as parameters.
|
||||
The analysis tool user interface should be capable of automatically formatting the parameter.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
|
||||
<summary>
|
||||
Gets or sets an optional argument expanding on exclusion criteria.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
|
||||
exclusion where the literal metadata target is not sufficiently precise. For example,
|
||||
the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
|
||||
and it may be desirable to suppress a violation against a statement in the method that will
|
||||
give a rule violation, but not against all statements in the method.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
|
||||
<summary>
|
||||
Gets or sets the justification for suppressing the code analysis message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
|
||||
with the specified member types.
|
||||
</summary>
|
||||
<param name="memberTypes">The types of members dynamically accessed.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
||||
of members dynamically accessed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
|
||||
<summary>
|
||||
Specifies the types of members that are dynamically accessed.
|
||||
|
||||
This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
|
||||
bitwise combination of its member values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
|
||||
<summary>
|
||||
Specifies no members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
|
||||
<summary>
|
||||
Specifies the default, parameterless public constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
|
||||
<summary>
|
||||
Specifies all public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
|
||||
<summary>
|
||||
Specifies all non-public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
|
||||
<summary>
|
||||
Specifies all public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
|
||||
<summary>
|
||||
Specifies all non-public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
|
||||
<summary>
|
||||
Specifies all public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
|
||||
<summary>
|
||||
Specifies all non-public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all non-public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
|
||||
<summary>
|
||||
Specifies all public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
|
||||
<summary>
|
||||
Specifies all non-public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
|
||||
<summary>
|
||||
Specifies all public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
|
||||
<summary>
|
||||
Specifies all non-public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
|
||||
<summary>
|
||||
Specifies all interfaces implemented by the type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
|
||||
<summary>
|
||||
Specifies all members.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
|
||||
Binary file not shown.
BIN
Bin/Microsoft.IdentityModel.Tokens.dll.refresh
Normal file
BIN
Bin/Microsoft.IdentityModel.Tokens.dll.refresh
Normal file
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Binary file not shown.
BIN
Bin/Microsoft.Owin.dll.refresh
Normal file
BIN
Bin/Microsoft.Owin.dll.refresh
Normal file
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Binary file not shown.
BIN
Bin/System.Drawing.Common.dll.refresh
Normal file
BIN
Bin/System.Drawing.Common.dll.refresh
Normal file
Binary file not shown.
12655
Bin/System.Drawing.Common.xml
Normal file
12655
Bin/System.Drawing.Common.xml
Normal file
File diff suppressed because it is too large
Load Diff
Binary file not shown.
BIN
Bin/System.IdentityModel.Tokens.Jwt.dll.refresh
Normal file
BIN
Bin/System.IdentityModel.Tokens.Jwt.dll.refresh
Normal file
Binary file not shown.
@@ -4,109 +4,31 @@
|
||||
<name>System.IdentityModel.Tokens.Jwt</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.ClaimTypeMapping">
|
||||
<summary>
|
||||
Defines the inbound and outbound mapping for claim claim types from jwt to .net claim
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.ClaimTypeMapping.#cctor">
|
||||
<summary>
|
||||
Initializes static members of the <see cref="T:System.IdentityModel.Tokens.Jwt.ClaimTypeMapping"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.ClaimTypeMapping.InboundClaimTypeMap">
|
||||
<summary>
|
||||
Gets the InboundClaimTypeMap used by JwtSecurityTokenHandler when producing claims from jwt.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.ClaimTypeMapping.OutboundClaimTypeMap">
|
||||
<summary>
|
||||
Gets the OutboundClaimTypeMap is used by JwtSecurityTokenHandler to shorten claim types when creating a jwt.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.JsonClaimValueTypes">
|
||||
<summary>
|
||||
Constants for Json Web tokens.
|
||||
Constants that indicate how the <see cref="P:System.Security.Claims.Claim.Value"/> should be evaluated.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JsonClaimValueTypes.Json">
|
||||
<summary>
|
||||
A URI that represents the JSON XML data type.
|
||||
A value that indicates the <see cref="P:System.Security.Claims.Claim.Value"/> is a Json object.
|
||||
</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>
|
||||
<remarks>When creating a <see cref="T:System.Security.Claims.Claim"/> from Json if the value was not a simple type {String, Null, True, False, Number}
|
||||
then <see cref="P:System.Security.Claims.Claim.Value"/> will contain the Json value. If the Json was a JsonObject, the <see cref="P:System.Security.Claims.Claim.ValueType"/> will be set to "JSON".</remarks>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JsonClaimValueTypes.JsonArray">
|
||||
<summary>
|
||||
A URI that represents the JSON array XML data type.
|
||||
A value that indicates the <see cref="P:System.Security.Claims.Claim.Value"/> is a Json object.
|
||||
</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>
|
||||
<remarks>When creating a <see cref="T:System.Security.Claims.Claim"/> from Json if the value was not a simple type {String, Null, True, False, Number}
|
||||
then <see cref="P:System.Security.Claims.Claim.Value"/> will contain the Json value. If the Json was a JsonArray, the <see cref="P:System.Security.Claims.Claim.ValueType"/> will be set to "JSON_ARRAY".</remarks>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JsonClaimValueTypes.JsonNull">
|
||||
<summary>
|
||||
A URI that represents the JSON null data type
|
||||
A value that indicates the <see cref="P:System.Security.Claims.Claim.Value"/> is Json null.
|
||||
</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="T:System.IdentityModel.Tokens.Jwt.Serializer">
|
||||
<summary>
|
||||
Delegate that can be set on <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Serializer"/> to control serialization of objects into JSON.
|
||||
</summary>
|
||||
<param name="obj">Object to serialize</param>
|
||||
<returns>The serialized object.</returns>
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.Deserializer">
|
||||
<summary>
|
||||
Delegate that can be set on <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Deserializer"/> to control deserialization JSON into objects.
|
||||
</summary>
|
||||
<param name="obj">JSON to deserialize.</param>
|
||||
<param name="targetType">Type expected.</param>
|
||||
<returns>The deserialized object.</returns>
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.JsonExtensions">
|
||||
<summary>
|
||||
Dictionary extensions for serializations
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Serializer">
|
||||
<summary>
|
||||
Gets or sets a <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Serializer"/> to use when serializing objects to JSON.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentNullException">If 'value' is null.</exception>
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Deserializer">
|
||||
<summary>
|
||||
Gets or sets a <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Deserializer"/> to use when deserializing objects from JSON.
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentNullException">If 'value' is null.</exception>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JsonExtensions.SerializeToJson(System.Object)">
|
||||
<summary>
|
||||
Serializes an object to JSON.
|
||||
</summary>
|
||||
<param name="value">The object to serialize</param>
|
||||
<returns>The object as JSON.</returns>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JsonExtensions.DeserializeFromJson``1(System.String)">
|
||||
<summary>
|
||||
Deserialzes JSON into an instance of type T.
|
||||
</summary>
|
||||
<typeparam name="T">The object type.</typeparam>
|
||||
<param name="jsonString">The JSON to deserialze.</param>
|
||||
<returns>A new instance of type T.</returns>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JsonExtensions.DeserializeJwtHeader(System.String)">
|
||||
<summary>
|
||||
Deserialzes JSON into an instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/>.
|
||||
</summary>
|
||||
<param name="jsonString">The JSON to deserialze.</param>
|
||||
<returns>A new instance <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/>.</returns>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JsonExtensions.DeserializeJwtPayload(System.String)">
|
||||
<summary>
|
||||
Deserialzes JSON into an instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/>.
|
||||
</summary>
|
||||
<param name="jsonString">The JSON to deserialze.</param>
|
||||
<returns>A new instance <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/>.</returns>
|
||||
<remarks>When creating a <see cref="T:System.Security.Claims.Claim"/> the <see cref="P:System.Security.Claims.Claim.Value"/> cannot be null. If the Json value was null, then the <see cref="P:System.Security.Claims.Claim.Value"/>
|
||||
will be set to <see cref="F:System.String.Empty"/> and the <see cref="P:System.Security.Claims.Claim.ValueType"/> will be set to "JSON_NULL".</remarks>
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.JwtConstants">
|
||||
<summary>
|
||||
@@ -165,7 +87,7 @@
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.JwtHeader">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/> which contains JSON objects representing the cryptographic operations applied to the JWT and optionally any additional properties of the JWT.
|
||||
Initializes a new instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/> which contains JSON objects representing the cryptographic operations applied to the JWT and optionally any additional properties of the JWT.
|
||||
The member names within the JWT Header are referred to as Header Parameter Names.
|
||||
<para>These names MUST be unique and the values must be <see cref="T:System.String"/>(s). The corresponding values are referred to as Header Parameter Values.</para>
|
||||
</summary>
|
||||
@@ -175,6 +97,11 @@
|
||||
Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/> class. Default string comparer <see cref="P:System.StringComparer.Ordinal"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtHeader.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/> class. Default string comparer <see cref="P:System.StringComparer.Ordinal"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtHeader.#ctor(Microsoft.IdentityModel.Tokens.SigningCredentials)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/>.
|
||||
@@ -211,12 +138,23 @@
|
||||
<param name="outboundAlgorithmMap">provides a mapping for the 'alg' value so that values are within the JWT namespace.</param>
|
||||
<param name="tokenType"> will be added as the value for the 'typ' claim in the header. If it is null or empty <see cref="F:System.IdentityModel.Tokens.Jwt.JwtConstants.HeaderType"/> will be used as token type</param>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtHeader.#ctor(Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtHeader.#ctor(Microsoft.IdentityModel.Tokens.SigningCredentials,System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/>.
|
||||
With the Header Parameters:
|
||||
<para>{ { typ, JWT }, { alg, SigningCredentials.Algorithm } }</para>
|
||||
</summary>
|
||||
<param name="signingCredentials"><see cref="P:System.IdentityModel.Tokens.Jwt.JwtHeader.SigningCredentials"/> used when creating a JWS Compact JSON.</param>
|
||||
<param name="outboundAlgorithmMap">provides a mapping for the 'alg' value so that values are within the JWT namespace.</param>
|
||||
<param name="tokenType"> will be added as the value for the 'typ' claim in the header. If it is null or empty <see cref="F:System.IdentityModel.Tokens.Jwt.JwtConstants.HeaderType"/> will be used as token type</param>
|
||||
<param name="additionalInnerHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the inner JWT token header.</param>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtHeader.#ctor(Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/>.
|
||||
With the Header Parameters:
|
||||
<para>{ { typ, JWT }, { alg, EncryptingCredentials.Algorithm } }</para>
|
||||
</summary>
|
||||
<param name="encryptingCredentials"><see cref="P:System.IdentityModel.Tokens.Jwt.JwtHeader.EncryptingCredentials"/> used when creating a JWS Compact JSON.</param>
|
||||
<param name="outboundAlgorithmMap">provides a mapping for the 'alg' value so that values are within the JWT namespace.</param>
|
||||
<exception cref="T:System.ArgumentNullException">If 'encryptingCredentials' is null.</exception>
|
||||
@@ -225,13 +163,25 @@
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/>.
|
||||
With the Header Parameters:
|
||||
<para>{ { typ, JWT }, { alg, SigningCredentials.Algorithm } }</para>
|
||||
<para>{ { typ, JWT }, { alg, EncryptingCredentials.Algorithm } }</para>
|
||||
</summary>
|
||||
<param name="encryptingCredentials"><see cref="P:System.IdentityModel.Tokens.Jwt.JwtHeader.EncryptingCredentials"/> used when creating a JWS Compact JSON.</param>
|
||||
<param name="outboundAlgorithmMap">provides a mapping for the 'alg' value so that values are within the JWT namespace.</param>
|
||||
<param name="tokenType"> provides the token type</param>
|
||||
<exception cref="T:System.ArgumentNullException">If 'encryptingCredentials' is null.</exception>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtHeader.#ctor(Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/>.
|
||||
With the Header Parameters:
|
||||
<para>{ { typ, JWT }, { alg, EncryptingCredentials.Algorithm } }</para>
|
||||
</summary>
|
||||
<param name="encryptingCredentials"><see cref="P:System.IdentityModel.Tokens.Jwt.JwtHeader.EncryptingCredentials"/> used when creating a JWS Compact JSON.</param>
|
||||
<param name="outboundAlgorithmMap">provides a mapping for the 'alg' value so that values are within the JWT namespace.</param>
|
||||
<param name="tokenType"> provides the token type</param>
|
||||
<param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
|
||||
<exception cref="T:System.ArgumentNullException">If 'encryptingCredentials' is null.</exception>
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JwtHeader.Alg">
|
||||
<summary>
|
||||
Gets the signature algorithm that was used to create the signature.
|
||||
@@ -287,13 +237,13 @@
|
||||
<summary>
|
||||
Gets the certificate used to sign the token
|
||||
</summary>
|
||||
<remarks>If the 'x5c' claim is not found, null is returned.</remarks>
|
||||
<remarks>If the 'x5c' claim is not found, null is returned.</remarks>
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JwtHeader.Zip">
|
||||
<summary>
|
||||
Gets the 'value' of the 'zip' claim { zip, 'value' }.
|
||||
</summary>
|
||||
<remarks>If the 'zip' claim is not found, null is returned.</remarks>
|
||||
<remarks>If the 'zip' claim is not found, null is returned.</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtHeader.Base64UrlDeserialize(System.String)">
|
||||
<summary>
|
||||
@@ -301,22 +251,12 @@
|
||||
</summary>
|
||||
<param name="base64UrlEncodedJsonString">Base64url encoded JSON to deserialize.</param>
|
||||
<returns>An instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/>.</returns>
|
||||
<remarks>Use <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Deserializer"/> to customize JSON serialization.</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtHeader.Base64UrlEncode">
|
||||
<summary>
|
||||
Encodes this instance as Base64UrlEncoded JSON.
|
||||
</summary>
|
||||
<returns>Base64UrlEncoded JSON.</returns>
|
||||
<remarks>Use <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Serializer"/> to customize JSON serialization.</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtHeader.Deserialize(System.String)">
|
||||
<summary>
|
||||
Deserialzes JSON into a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/> instance.
|
||||
</summary>
|
||||
<param name="jsonString"> The JSON to deserialize.</param>
|
||||
<returns>An instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtHeader"/>.</returns>
|
||||
<remarks>Use <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Deserializer"/> to customize JSON serialization.</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtHeader.GetStandardClaim(System.String)">
|
||||
<summary>
|
||||
@@ -331,73 +271,87 @@
|
||||
Serializes this instance to JSON.
|
||||
</summary>
|
||||
<returns>This instance as JSON.</returns>
|
||||
<remarks>Use <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Serializer"/> to customize JSON serialization.</remarks>
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames">
|
||||
<summary>
|
||||
List of header parameter names see: http://tools.ietf.org/html/rfc7519#section-5.
|
||||
List of header parameter names see: https://datatracker.ietf.org/doc/html/rfc7519#section-5.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.Alg">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7515#section-4.1.1
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.1
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.Cty">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7515#section-4.1.10
|
||||
also:https://tools.ietf.org/html/rfc7519#section-5.2
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.10
|
||||
Also: https://datatracker.ietf.org/doc/html/rfc7519#section-5.2
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.Enc">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7516#section-4.1.2
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7516#section-4.1.2
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.IV">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7518#section-4.7.1.1
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7518#section-4.7.1.1
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.Jku">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7515#section-4.1.2
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.2
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.Jwk">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7515#section-4.1.3
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.3
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.Kid">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7515#section-4.1.4
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.4
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.Typ">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7515#section-4.1.9
|
||||
also:https://tools.ietf.org/html/rfc7519#section-5.1
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.9
|
||||
Also: https://datatracker.ietf.org/doc/html/rfc7519#section-5.1
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.X5c">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7515#section-4.1.6
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.6
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.X5t">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7515#page-12
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7515#page-12
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.X5u">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7515#section-4.1.5
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.5
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.Zip">
|
||||
<summary>
|
||||
see:https://tools.ietf.org/html/rfc7516#section-4.1.3
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7516#section-4.1.3
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.Epk">
|
||||
<summary>
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7518#section-4.6.1.1
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.Apu">
|
||||
<summary>
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7518#section-4.6.1.2
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtHeaderParameterNames.Apv">
|
||||
<summary>
|
||||
See: https://datatracker.ietf.org/doc/html/rfc7518#section-4.6.1.3
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.JwtPayload">
|
||||
@@ -441,28 +395,62 @@
|
||||
<para>The 4 parameters: 'issuer', 'audience', 'notBefore', 'expires' take precedence over <see cref="T:System.Security.Claims.Claim"/>(s) in 'claims'. The values will be overridden.</para></remarks>
|
||||
<exception cref="T:System.ArgumentException">If 'expires' <= 'notbefore'.</exception>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.#ctor(System.String,System.String,System.Collections.Generic.IEnumerable{System.Security.Claims.Claim},System.Collections.Generic.IDictionary{System.String,System.Object},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime})">
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.#ctor(System.String,System.Collections.Generic.IList{System.String},System.Collections.Generic.IEnumerable{System.Security.Claims.Claim},System.Collections.Generic.IDictionary{System.String,System.Object},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime})">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/> class with claims added for each parameter specified. Default string comparer <see cref="P:System.StringComparer.Ordinal"/>.
|
||||
</summary>
|
||||
<param name="issuer">If this value is not null, a { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in 'claims' and 'claimCollection' if present.</param>
|
||||
<param name="audience">If this value is not null, a { aud, 'audience' } claim will be added, appending to any 'aud' claims in 'claims' or 'claimCollection' if present.</param>
|
||||
<param name="issuer">If this value is not null, an { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in 'claims' and 'claimCollection' if present.</param>
|
||||
<param name="audiences">If this value is not null, all non-null non-whitespace strings in it will be added to an { aud, 'audience' }, appending to any 'aud' claims in 'claims' or 'claimCollection' if present. </param>
|
||||
<param name="claims">If this value is not null then for each <see cref="T:System.Security.Claims.Claim"/> a { 'Claim.Type', 'Claim.Value' } is added. If duplicate claims are found then a { 'Claim.Type', List<object> } will be created to contain the duplicate values.</param>
|
||||
<param name="claimsCollection">If both <paramref name="claims"/> and <paramref name="claimsCollection"/> are not null then the values in claims will be combined with the values in claimsCollection. The values found in claimCollection take precedence over those found in claims, so any duplicate
|
||||
values will be overridden.</param>
|
||||
<param name="notBefore">If notbefore.HasValue a { nbf, 'value' } claim is added, overwriting any 'nbf' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<param name="expires">If expires.HasValue a { exp, 'value' } claim is added, overwriting any 'exp' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<param name="issuedAt">If issuedAt.HasValue is 'true' a { iat, 'value' } claim is added, overwriting any 'iat' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<param name="notBefore">If notbefore.HasValue an { nbf, 'value' } claim is added, overwriting any 'nbf' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<param name="expires">If expires.HasValue an { exp, 'value' } claim is added, overwriting any 'exp' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<param name="issuedAt">If issuedAt.HasValue is 'true' an { iat, 'value' } claim is added, overwriting any 'iat' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<remarks>Comparison is set to <see cref="P:System.StringComparer.Ordinal"/>
|
||||
<para>The 4 parameters: 'issuer', 'audience', 'notBefore', 'expires' take precedence over <see cref="T:System.Security.Claims.Claim"/>(s) in 'claims' and 'claimcollection'. The values will be overridden.</para></remarks>
|
||||
<exception cref="T:System.ArgumentException">If 'expires' <= 'notbefore'.</exception>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.AddFirstPriorityClaims(System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime})">
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.#ctor(System.String,System.String,System.Collections.Generic.IList{System.String},System.Collections.Generic.IEnumerable{System.Security.Claims.Claim},System.Collections.Generic.IDictionary{System.String,System.Object},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime})">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/> class with claims added for each parameter specified. Default string comparer <see cref="P:System.StringComparer.Ordinal"/>.
|
||||
</summary>
|
||||
<param name="issuer">If this value is not null, an { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in 'claims' and 'claimCollection' if present.</param>
|
||||
<param name="audience">If this value is not null, an { aud, 'audience' } claim will be added, appending to any 'aud' claims in 'claims' or 'claimCollection' if present.</param>
|
||||
<param name="audiences">If this value is not null, all non-null non-whitespace strings in it will be added to an { aud, 'audience' }, appending to any 'aud' claims in 'claims' or 'claimCollection' if present. </param>
|
||||
<param name="claims">If this value is not null then for each <see cref="T:System.Security.Claims.Claim"/> a { 'Claim.Type', 'Claim.Value' } is added. If duplicate claims are found then a { 'Claim.Type', List<object> } will be created to contain the duplicate values.</param>
|
||||
<param name="claimsCollection">If both <paramref name="claims"/> and <paramref name="claimsCollection"/> are not null then the values in claims will be combined with the values in claimsCollection. The values found in claimCollection take precedence over those found in claims, so any duplicate
|
||||
values will be overridden.</param>
|
||||
<param name="notBefore">If notbefore.HasValue an { nbf, 'value' } claim is added, overwriting any 'nbf' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<param name="expires">If expires.HasValue an { exp, 'value' } claim is added, overwriting any 'exp' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<param name="issuedAt">If issuedAt.HasValue is 'true' an { iat, 'value' } claim is added, overwriting any 'iat' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<remarks>Comparison is set to <see cref="P:System.StringComparer.Ordinal"/>
|
||||
<para>The 4 parameters: 'issuer', 'audience', 'notBefore', 'expires' take precedence over <see cref="T:System.Security.Claims.Claim"/>(s) in 'claims' and 'claimcollection'. The values will be overridden.</para></remarks>
|
||||
<exception cref="T:System.ArgumentException">If 'expires' <= 'notbefore'.</exception>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.#ctor(System.String,System.String,System.Collections.Generic.IEnumerable{System.Security.Claims.Claim},System.Collections.Generic.IDictionary{System.String,System.Object},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime})">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/> class with claims added for each parameter specified. Default string comparer <see cref="P:System.StringComparer.Ordinal"/>.
|
||||
</summary>
|
||||
<param name="issuer">If this value is not null, an { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in 'claims' and 'claimCollection' if present.</param>
|
||||
<param name="audience">If this value is not null, an { aud, 'audience' } claim will be added, appending to any 'aud' claims in 'claims' or 'claimCollection' if present.</param>
|
||||
<param name="claims">If this value is not null then for each <see cref="T:System.Security.Claims.Claim"/> a { 'Claim.Type', 'Claim.Value' } is added. If duplicate claims are found then a { 'Claim.Type', List<object> } will be created to contain the duplicate values.</param>
|
||||
<param name="claimsCollection">If both <paramref name="claims"/> and <paramref name="claimsCollection"/> are not null then the values in claims will be combined with the values in claimsCollection. The values found in claimCollection take precedence over those found in claims, so any duplicate
|
||||
values will be overridden.</param>
|
||||
<param name="notBefore">If notbefore.HasValue an { nbf, 'value' } claim is added, overwriting any 'nbf' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<param name="expires">If expires.HasValue an { exp, 'value' } claim is added, overwriting any 'exp' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<param name="issuedAt">If issuedAt.HasValue is 'true' an { iat, 'value' } claim is added, overwriting any 'iat' claim in 'claims' and 'claimcollection' if present.</param>
|
||||
<remarks>Comparison is set to <see cref="P:System.StringComparer.Ordinal"/>
|
||||
<para>The 4 parameters: 'issuer', 'audience', 'notBefore', 'expires' take precedence over <see cref="T:System.Security.Claims.Claim"/>(s) in 'claims' and 'claimcollection'. The values will be overridden.</para></remarks>
|
||||
<exception cref="T:System.ArgumentException">If 'expires' <= 'notbefore'.</exception>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.AddFirstPriorityClaims(System.String,System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime})">
|
||||
<summary>
|
||||
Adds Nbf, Exp, Iat, Iss and Aud claims to payload
|
||||
</summary>
|
||||
<param name="issuer">If this value is not null, a { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/> instance.</param>
|
||||
<param name="audience">If this value is not null, a { aud, 'audience' } claim will be added, appending to any 'aud' claims in <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/> instance.</param>
|
||||
<param name="audiences">If there are strings that are not null or empty append them to any other Aud claims</param>
|
||||
<param name="notBefore">If notbefore.HasValue a { nbf, 'value' } claim is added, overwriting any 'nbf' claim in <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/> instance.</param>
|
||||
<param name="expires">If expires.HasValue a { exp, 'value' } claim is added, overwriting any 'exp' claim in <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/> instance.</param>
|
||||
<param name="issuedAt">If issuedAt.HasValue is 'true' a { iat, 'value' } claim is added, overwriting any 'iat' claim in <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/> instance.</param>
|
||||
@@ -515,6 +503,12 @@
|
||||
</summary>
|
||||
<remarks>If the 'expiration' claim is not found OR could not be converted to <see cref="T:System.Int32"/>, null is returned.</remarks>
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JwtPayload.Expiration">
|
||||
<summary>
|
||||
Gets the 'value' of the 'expiration' claim { exp, 'value' }.
|
||||
</summary>
|
||||
<remarks>If the 'expiration' claim is not found OR could not be converted to <see cref="T:System.Int64"/>, null is returned.</remarks>
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JwtPayload.Jti">
|
||||
<summary>
|
||||
Gets the 'value' of the 'JWT ID' claim { jti, 'value' }.
|
||||
@@ -545,6 +539,12 @@
|
||||
</summary>
|
||||
<remarks>If the 'nonce' claim is not found, null is returned.</remarks>
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JwtPayload.NotBefore">
|
||||
<summary>
|
||||
Gets the 'value' of the 'notebefore' claim { nbf, 'value' }.
|
||||
</summary>
|
||||
<remarks>If the 'notbefore' claim is not found OR could not be converted to <see cref="T:System.Int64"/>, null is returned.</remarks>
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JwtPayload.Sub">
|
||||
<summary>
|
||||
Gets the 'value' of the 'subject' claim { sub, 'value' }.
|
||||
@@ -598,39 +598,26 @@
|
||||
Adds claims from dictionary.
|
||||
</summary>
|
||||
<param name="claimsCollection"> A dictionary of claims.</param>
|
||||
<remark> If a key is already present in target dictionary, its value is overridden by the value of the key in claimsCollection.</remark>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.GetDateTime(System.String)">
|
||||
<summary>
|
||||
Gets the DateTime using the number of seconds from 1970-01-01T0:0:0Z (UTC)
|
||||
</summary>
|
||||
<param name="key">Claim in the payload that should map to an integer.</param>
|
||||
<remarks>If the claim is not found, the function returns: DateTime.MinValue
|
||||
</remarks>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">If an overflow exception is thrown by the runtime.</exception>
|
||||
<returns>The DateTime representation of a claim.</returns>
|
||||
<remark> If a key is already present in target dictionary, its claimValue is overridden by the claimValue of the key in claimsCollection.</remark>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.SerializeToJson">
|
||||
<summary>
|
||||
Serializes this instance to JSON.
|
||||
</summary>
|
||||
<returns>This instance as JSON.</returns>
|
||||
<remarks>Use <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Serializer"/> to customize JSON serialization.</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.Base64UrlDeserialize(System.String)">
|
||||
<summary>
|
||||
Deserializes Base64UrlEncoded JSON into a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/>.
|
||||
</summary>
|
||||
<param name="base64UrlEncodedJsonString">Base64url encoded JSON to deserialize.</param>
|
||||
<returns>An instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/>.</returns>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.Base64UrlEncode">
|
||||
<summary>
|
||||
Encodes this instance as Base64UrlEncoded JSON.
|
||||
</summary>
|
||||
<returns>Base64UrlEncoded JSON.</returns>
|
||||
<remarks>Use <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Serializer"/> to customize JSON serialization.</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.Base64UrlDeserialize(System.String)">
|
||||
<summary>
|
||||
Deserializes Base64UrlEncoded JSON into a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/> instance.
|
||||
</summary>
|
||||
<param name="base64UrlEncodedJsonString">base64url encoded JSON to deserialize.</param>
|
||||
<returns>An instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/>.</returns>
|
||||
<remarks>Use <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Deserializer"/> to customize JSON serialization.</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtPayload.Deserialize(System.String)">
|
||||
<summary>
|
||||
@@ -638,13 +625,13 @@
|
||||
</summary>
|
||||
<param name="jsonString">The JSON to deserialize.</param>
|
||||
<returns>An instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtPayload"/>.</returns>
|
||||
<remarks>Use <see cref="P:System.IdentityModel.Tokens.Jwt.JsonExtensions.Deserializer"/> to customize JSON serialization.</remarks>
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames">
|
||||
<summary>
|
||||
List of registered claims from different sources
|
||||
http://tools.ietf.org/html/rfc7519#section-4
|
||||
https://datatracker.ietf.org/doc/html/rfc7519#section-4
|
||||
http://openid.net/specs/openid-connect-core-1_0.html#IDToken
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Actort">
|
||||
@@ -656,14 +643,29 @@
|
||||
http://openid.net/specs/openid-connect-core-1_0.html#IDToken
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Alg">
|
||||
<summary>
|
||||
https://datatracker.ietf.org/doc/html/rfc7519#section-4
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Amr">
|
||||
<summary>
|
||||
http://openid.net/specs/openid-connect-core-1_0.html#IDToken
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Address">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.AtHash">
|
||||
<summary>
|
||||
http://openid.net/specs/openid-connect-core-1_0.html#CodeIDToken
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Aud">
|
||||
<summary>
|
||||
http://tools.ietf.org/html/rfc7519#section-4
|
||||
https://datatracker.ietf.org/doc/html/rfc7519#section-4
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.AuthTime">
|
||||
@@ -686,19 +688,19 @@
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#HybridIDToken
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.AtHash">
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Email">
|
||||
<summary>
|
||||
http://openid.net/specs/openid-connect-core-1_0.html#CodeIDToken
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Email">
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.EmailVerified">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Exp">
|
||||
<summary>
|
||||
http://tools.ietf.org/html/rfc7519#section-4
|
||||
https://datatracker.ietf.org/doc/html/rfc7519#section-4
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Gender">
|
||||
@@ -718,17 +720,27 @@
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Iat">
|
||||
<summary>
|
||||
http://tools.ietf.org/html/rfc7519#section-4
|
||||
https://datatracker.ietf.org/doc/html/rfc7519#section-4
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Iss">
|
||||
<summary>
|
||||
http://tools.ietf.org/html/rfc7519#section-4
|
||||
https://datatracker.ietf.org/doc/html/rfc7519#section-4
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Jti">
|
||||
<summary>
|
||||
http://tools.ietf.org/html/rfc7519#section-4
|
||||
https://datatracker.ietf.org/doc/html/rfc7519#section-4
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Locale">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.MiddleName">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Name">
|
||||
@@ -740,6 +752,11 @@
|
||||
<summary>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Nickname">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Nonce">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
|
||||
@@ -747,13 +764,38 @@
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Nbf">
|
||||
<summary>
|
||||
http://tools.ietf.org/html/rfc7519#section-4
|
||||
https://datatracker.ietf.org/doc/html/rfc7519#section-4
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.PhoneNumber">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.PhoneNumberVerified">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Picture">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Prn">
|
||||
<summary>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.PreferredUsername">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Profile">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Sid">
|
||||
<summary>
|
||||
http://openid.net/specs/openid-connect-frontchannel-1_0.html#OPLogout
|
||||
@@ -761,22 +803,32 @@
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Sub">
|
||||
<summary>
|
||||
http://tools.ietf.org/html/rfc7519#section-4
|
||||
https://datatracker.ietf.org/doc/html/rfc7519#section-4
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Typ">
|
||||
<summary>
|
||||
http://tools.ietf.org/html/rfc7519#section-5
|
||||
https://datatracker.ietf.org/doc/html/rfc7519#section-5
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.UniqueName">
|
||||
<summary>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.UpdatedAt">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.Website">
|
||||
<summary>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtRegisteredClaimNames.ZoneInfo">
|
||||
<summary>
|
||||
https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken">
|
||||
<summary>
|
||||
A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> designed for representing a JSON Web Token (JWT).
|
||||
@@ -787,9 +839,10 @@
|
||||
Initializes a new instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> from a string in JWS Compact serialized format.
|
||||
</summary>
|
||||
<param name="jwtEncodedString">A JSON Web Token that has been serialized in JWS Compact serialized format.</param>
|
||||
<exception cref="T:System.ArgumentNullException">'jwtEncodedString' is null.</exception>
|
||||
<exception cref="T:System.ArgumentException">'jwtEncodedString' contains only whitespace.</exception>
|
||||
<exception cref="T:System.ArgumentException">'jwtEncodedString' is not in JWS Compact serialized format.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">'jwtEncodedString' is null or contains only whitespace.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException">'jwtEncodedString' contains only whitespace.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException">'jwtEncodedString' is not in JWE format.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException">'jwtEncodedString' is not in JWS or JWE format.</exception>
|
||||
<remarks>
|
||||
The contents of this <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> have not been validated, the JSON Web Token is simply decoded. Validation can be accomplished using <see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.SecurityToken@)"/>
|
||||
</remarks>
|
||||
@@ -885,7 +938,7 @@
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.Id">
|
||||
<summary>
|
||||
Gets the 'value' of the 'JWT ID' claim { jti, ''value' }.
|
||||
Gets the 'value' of the 'JWT ID' claim { jti, 'value' }.
|
||||
</summary>
|
||||
<remarks>If the 'JWT ID' claim is not found, an empty string is returned.</remarks>
|
||||
</member>
|
||||
@@ -1021,6 +1074,9 @@
|
||||
</summary>
|
||||
<returns>A string containing the header and payload in JSON format.</returns>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.UnsafeToString">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.Decode(System.String[],System.String)">
|
||||
<summary>
|
||||
Decodes the string into the header, payload and signature.
|
||||
@@ -1028,12 +1084,11 @@
|
||||
<param name="tokenParts">the tokenized string.</param>
|
||||
<param name="rawData">the original token.</param>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.DecodeJws(System.String[])">
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.DecodeJws(System.String)">
|
||||
<summary>
|
||||
Decodes the payload and signature from the JWS parts.
|
||||
Decodes the base64url encoded payload.
|
||||
</summary>
|
||||
<param name="tokenParts">Parts of the JWS including the header.</param>
|
||||
<remarks>Assumes Header has already been set.</remarks>
|
||||
<param name="payload">the encoded payload.</param>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.DecodeJwe(System.String[])">
|
||||
<summary>
|
||||
@@ -1042,9 +1097,22 @@
|
||||
<param name="tokenParts">Parts of the JWE including the header.</param>
|
||||
<remarks>Assumes Header has already been set.</remarks>
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenConverter">
|
||||
<summary>
|
||||
Static class to convert a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> to a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenConverter.Convert(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken)">
|
||||
<summary>
|
||||
Initializes a new instance of a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> from a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>
|
||||
</summary>
|
||||
<param name="token">A JSON Web Token to convert from.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="token"/> is null</exception>
|
||||
<exception cref="T:System.ArgumentException"><paramref name="token"/> doesn't have <see cref="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedToken"/> set.</exception>
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler">
|
||||
<summary>
|
||||
A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler"/> designed for creating and validating Json Web Tokens. See: http://tools.ietf.org/html/rfc7519 and http://www.rfc-editor.org/info/rfc7515
|
||||
A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler"/> designed for creating and validating Json Web Tokens. See: https://datatracker.ietf.org/doc/html/rfc7519 and http://www.rfc-editor.org/info/rfc7515
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.DefaultInboundClaimTypeMap">
|
||||
@@ -1084,14 +1152,14 @@
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.MapInboundClaims">
|
||||
<summary>
|
||||
Gets or sets the <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.MapInboundClaims"/> property which is used when determining whether or not to map claim types that are extracted when validating a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.
|
||||
Gets or sets the <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.MapInboundClaims"/> property which is used when determining whether or not to map claim types that are extracted when validating a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.
|
||||
<para>If this is set to true, the <see cref="P:System.Security.Claims.Claim.Type"/> is set to the JSON claim 'name' after translating using this mapping. Otherwise, no mapping occurs.</para>
|
||||
<para>The default value is true.</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap">
|
||||
<summary>
|
||||
Gets or sets the <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"/> which is used when setting the <see cref="P:System.Security.Claims.Claim.Type"/> for claims in the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> extracted when validating a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.
|
||||
Gets or sets the <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"/> which is used when setting the <see cref="P:System.Security.Claims.Claim.Type"/> for claims in the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> extracted when validating a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.
|
||||
<para>The <see cref="P:System.Security.Claims.Claim.Type"/> is set to the JSON claim 'name' after translating using this mapping.</para>
|
||||
<para>The default value is ClaimTypeMapping.InboundClaimTypeMap.</para>
|
||||
</summary>
|
||||
@@ -1127,7 +1195,7 @@
|
||||
</member>
|
||||
<member name="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.JsonClaimTypeProperty">
|
||||
<summary>
|
||||
Gets or sets the property name of <see cref="P:System.Security.Claims.Claim.Properties"/> the will contain .Net type that was recognized when JwtPayload.Claims serialized the value to JSON.
|
||||
Gets or sets the property name of <see cref="P:System.Security.Claims.Claim.Properties"/> the will contain .Net type that was recognized when <see cref="P:System.IdentityModel.Tokens.Jwt.JwtPayload.Claims"/> serialized the value to JSON.
|
||||
<para>See <seealso cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.InboundClaimTypeMap"/> for more information.</para>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentException">If <see cref="T:System.String"/>.IsNullOrWhiteSpace('value') is true.</exception>
|
||||
@@ -1153,7 +1221,7 @@
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CanReadToken(System.String)">
|
||||
<summary>
|
||||
Determines if the string is a well formed Json Web Token (JWT).
|
||||
<para>see: http://tools.ietf.org/html/rfc7519 </para>
|
||||
<para>See: https://datatracker.ietf.org/doc/html/rfc7519 </para>
|
||||
</summary>
|
||||
<param name="token">String that should represent a valid JWT.</param>
|
||||
<remarks>Uses <see cref="M:System.Text.RegularExpressions.Regex.IsMatch(System.String,System.String)"/> matching one of:
|
||||
@@ -1266,7 +1334,7 @@
|
||||
<para><see cref="M:Microsoft.IdentityModel.Tokens.EncryptingCredentials.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)"/> is used to encrypt <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.RawData"/> or <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.RawPayload"/> .</para>
|
||||
</remarks>
|
||||
<returns>A <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.</returns>
|
||||
<exception cref="T:System.ArgumentException">If 'expires' <= 'notBefore'.</exception>
|
||||
<exception cref="T:System.ArgumentException">If <paramref name="expires"/> <= <paramref name="notBefore"/>.</exception>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CreateJwtSecurityToken(System.String,System.String,System.Security.Claims.ClaimsIdentity,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime},Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})">
|
||||
<summary>
|
||||
@@ -1290,7 +1358,7 @@
|
||||
<para><see cref="M:Microsoft.IdentityModel.Tokens.EncryptingCredentials.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)"/> is used to encrypt <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.RawData"/> or <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.RawPayload"/> .</para>
|
||||
</remarks>
|
||||
<returns>A <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.</returns>
|
||||
<exception cref="T:System.ArgumentException">If 'expires' <= 'notBefore'.</exception>
|
||||
<exception cref="T:System.ArgumentException">If <paramref name="expires"/> <= <paramref name="notBefore"/>.</exception>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CreateJwtSecurityToken(System.String,System.String,System.Security.Claims.ClaimsIdentity,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime},Microsoft.IdentityModel.Tokens.SigningCredentials)">
|
||||
<summary>
|
||||
@@ -1311,7 +1379,7 @@
|
||||
<para><see cref="M:Microsoft.IdentityModel.Tokens.SigningCredentials.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"/> is used to sign <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.RawData"/>.</para>
|
||||
</remarks>
|
||||
<returns>A <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.</returns>
|
||||
<exception cref="T:System.ArgumentException">If 'expires' <= 'notBefore'.</exception>
|
||||
<exception cref="T:System.ArgumentException">If <paramref name="expires"/> <= <paramref name="notBefore"/>.</exception>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CreateToken(Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor)">
|
||||
<summary>
|
||||
@@ -1326,11 +1394,13 @@
|
||||
</summary>
|
||||
<param name="token">A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.</param>
|
||||
<returns>A <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/></returns>
|
||||
<exception cref="T:System.ArgumentNullException">'token' is null or empty.</exception>
|
||||
<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>
|
||||
<exception cref="T:System.ArgumentException"><see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CanReadToken(System.String)"/></exception>
|
||||
<remarks><para>If the 'token' is in JWE Compact Serialization format, only the protected header will be deserialized.</para>
|
||||
This method is unable to decrypt the payload. Use <see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.SecurityToken@)"/>to obtain the payload.</remarks>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException"><see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CanReadToken(System.String)"/></exception>
|
||||
<remarks><para>If the <paramref name="token"/> is in JWE Compact Serialization format, only the protected header will be deserialized.
|
||||
This method is unable to decrypt the payload. Use <see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.SecurityToken@)"/>to obtain the payload.</para>
|
||||
<para>The token is NOT validated and no security decisions should be made about the contents.
|
||||
Use <see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ValidateTokenAsync(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"/> to ensure the token is acceptable.</para></remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ReadToken(System.String)">
|
||||
<summary>
|
||||
@@ -1338,18 +1408,20 @@
|
||||
</summary>
|
||||
<param name="token">A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.</param>
|
||||
<returns>A <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/></returns>
|
||||
<exception cref="T:System.ArgumentNullException">'token' is null or empty.</exception>
|
||||
<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>
|
||||
<exception cref="T:System.ArgumentException"><see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CanReadToken(System.String)"/></exception>
|
||||
<remarks><para>If the 'token' is in JWE Compact Serialization format, only the protected header will be deserialized.</para>
|
||||
<remarks><para>If the <paramref name="token"/> is in JWE Compact Serialization format, only the protected header will be deserialized.</para>
|
||||
This method is unable to decrypt the payload. Use <see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.SecurityToken@)"/>to obtain the payload.</remarks>
|
||||
<remarks>The token is NOT validated and no security decisions should be made about the contents.
|
||||
<para>Use <see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ValidateTokenAsync(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"/> to ensure the token is acceptable.</para></remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ReadToken(System.Xml.XmlReader,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
|
||||
<summary>
|
||||
Deserializes 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 current <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>.</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.SecurityToken"/></returns>
|
||||
<remarks>This method is not current supported.</remarks>
|
||||
</member>
|
||||
@@ -1358,13 +1430,13 @@
|
||||
Reads and validates a 'JSON Web Token' (JWT) encoded as a JWS or JWE in Compact Serialized Format.
|
||||
</summary>
|
||||
<param name="token">the JWT encoded as JWE or JWS</param>
|
||||
<param name="validationParameters">Contains validation parameters for the <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.</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:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> that was validated.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="token"/> is null or whitespace.</exception>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="validationParameters"/> is null.</exception>
|
||||
<exception cref="T:System.ArgumentException"><paramref name="token"/>.Length is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"/>.</exception>
|
||||
<exception cref="T:System.ArgumentException"><paramref name="token"/> does not have 3 or 5 parts.</exception>
|
||||
<exception cref="T:System.ArgumentException"><see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CanReadToken(System.String)"/> returns false.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException"><paramref name="token"/> does not have 3 or 5 parts.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenMalformedException"><see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CanReadToken(System.String)"/> returns false.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"><paramref name="token"/> was a JWE was not able to be decrypted.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"><paramref name="token"/> 'kid' header claim is not null AND decryption fails.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"><paramref name="token"/> 'enc' header claim is null or empty.</exception>
|
||||
@@ -1379,16 +1451,30 @@
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException"><paramref name="token"/> could not be added to the <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"/>.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException"><paramref name="token"/> is found in the cache.</exception>
|
||||
<returns> A <see cref="T:System.Security.Claims.ClaimsPrincipal"/> from the JWT. Does not include claims found in the JWT header.</returns>
|
||||
<remarks>
|
||||
<remarks>
|
||||
Many of the exceptions listed above are not thrown directly from this method. See <see cref="T:Microsoft.IdentityModel.Tokens.Validators"/> to examine the call graph.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ValidateToken(System.String,System.IdentityModel.Tokens.Jwt.JwtSecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.SecurityToken@)">
|
||||
<summary>
|
||||
Private method for token validation, responsible for:
|
||||
(1) Obtaining a configuration from the <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ConfigurationManager"/>.
|
||||
(2) Revalidating using the Last Known Good Configuration (if present), and obtaining a refreshed configuration (if necessary) and revalidating using it.
|
||||
</summary>
|
||||
<param name="token">The JWS string, or the decrypted token if the token is a JWE.</param>
|
||||
<param name="outerToken">If the token being validated is a JWE, this is the <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> that represents the outer token.
|
||||
If the token is a JWS, the value of this parameter is <see langword="null" />.
|
||||
</param>
|
||||
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validation.</param>
|
||||
<param name="signatureValidatedToken">The <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> that was validated.</param>
|
||||
<returns> A <see cref="T:System.Security.Claims.ClaimsPrincipal"/> from the JWT. Does not include claims found in the JWT header.</returns>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ValidateTokenPayload(System.IdentityModel.Tokens.Jwt.JwtSecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
|
||||
<summary>
|
||||
Validates the JSON payload of a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.
|
||||
</summary>
|
||||
<param name="jwtToken">The token to validate.</param>
|
||||
<param name="validationParameters">Contains validation parameters for the <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.</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:System.Security.Claims.ClaimsPrincipal"/> from the jwt. Does not include the header claims.</returns>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.WriteToken(Microsoft.IdentityModel.Tokens.SecurityToken)">
|
||||
@@ -1402,7 +1488,7 @@
|
||||
<para>If either <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.SigningCredentials"/> or <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.InnerToken"/>.SigningCredentials are set, the JWT will be signed.</para>
|
||||
<para>If <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.EncryptingCredentials"/> is set, a JWE will be created using the JWT above as the plaintext.</para>
|
||||
</remarks>
|
||||
<exception cref="T:System.ArgumentNullException">'token' is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="token"/> is null.</exception>
|
||||
<exception cref="T:System.ArgumentException">'token' is not a not <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">both <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.SigningCredentials"/> and <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.InnerToken"/> are set.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">both <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.InnerToken"/> and <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.InnerToken"/>.EncryptingCredentials are set.</exception>
|
||||
@@ -1426,22 +1512,18 @@
|
||||
Validates that the signature, if found or required, is valid.
|
||||
</summary>
|
||||
<param name="token">A JWS token.</param>
|
||||
<param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> that contains signing keys.</param>
|
||||
<exception cref="T:System.ArgumentNullException">If 'jwt' is null or whitespace.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">If 'validationParameters' is null.</exception>
|
||||
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param>
|
||||
<exception cref="T:System.ArgumentNullException">If <paramref name="token"/> is null or whitespace.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">If <paramref name="validationParameters"/> is null.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException">If a signature is not found and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireSignedTokens"/> is true.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException">
|
||||
If the 'token' has a key identifier and none of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>(s) provided result in a validated signature.
|
||||
If the <paramref name="token"/> has a key identifier and none of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>(s) provided result in a validated signature.
|
||||
This can indicate that a key refresh is required.
|
||||
</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenUnableToValidateException">
|
||||
If the 'token' has a key identifier and none of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>(s) provided result in a validated signature as well as the token
|
||||
had validation errors or lifetime or issuer. This is not intended to be a signal to refresh keys.
|
||||
</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException">If after trying all the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>(s), none result in a validated signature AND the 'token' does not have a key identifier.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException">If after trying all the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>(s), none result in a validated signature AND the <paramref name="token"/> does not have a key identifier.</exception>
|
||||
<returns>A <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> that has the signature validated if token was signed.</returns>
|
||||
<remarks><para>If the 'token' is signed, the signature is validated even if <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireSignedTokens"/> is false.</para>
|
||||
<para>If the 'token' signature is validated, then the <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.SigningKey"/> will be set to the key that signed the 'token'.It is the responsibility of <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.SignatureValidator"/> to set the <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.SigningKey"/></para></remarks>
|
||||
<remarks><para>If the <paramref name="token"/> is signed, the signature is validated even if <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireSignedTokens"/> is false.</para>
|
||||
<para>If the <paramref name="token"/> signature is validated, then the <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.SigningKey"/> will be set to the key that signed the 'token'.It is the responsibility of <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.SignatureValidator"/> to set the <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.SigningKey"/></para></remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CreateClaimsIdentity(System.IdentityModel.Tokens.Jwt.JwtSecurityToken,System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
|
||||
<summary>
|
||||
@@ -1449,7 +1531,7 @@
|
||||
</summary>
|
||||
<param name="jwtToken">The <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> to use as a <see cref="T:System.Security.Claims.Claim"/> source.</param>
|
||||
<param name="issuer">The value to set <see cref="P:System.Security.Claims.Claim.Issuer"/></param>
|
||||
<param name="validationParameters"> Contains parameters for validating the token.</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:System.Security.Claims.ClaimsIdentity"/> containing the <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.Claims"/>.</returns>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CreateActorValue(System.Security.Claims.ClaimsIdentity)">
|
||||
@@ -1461,8 +1543,8 @@
|
||||
<remarks>If <see cref="P:System.Security.Claims.ClaimsIdentity.BootstrapContext"/> is not null:
|
||||
<para>  If 'type' is 'string', return as string.</para>
|
||||
<para>  if 'type' is 'BootstrapContext' and 'BootstrapContext.SecurityToken' is 'JwtSecurityToken'</para>
|
||||
<para>    if 'JwtSecurityToken.RawData' != null, return RawData.</para>
|
||||
<para>    else return <see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.WriteToken(Microsoft.IdentityModel.Tokens.SecurityToken)"/>.</para>
|
||||
<para>    if 'JwtSecurityToken.RawData' != null, return RawData.</para>
|
||||
<para>    else return <see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.WriteToken(Microsoft.IdentityModel.Tokens.SecurityToken)"/>.</para>
|
||||
<para>  if 'BootstrapContext.Token' != null, return 'Token'.</para>
|
||||
<para>default: <see cref="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.WriteToken(Microsoft.IdentityModel.Tokens.SecurityToken)"/> new ( <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>( actor.Claims ).</para>
|
||||
</remarks>
|
||||
@@ -1474,7 +1556,7 @@
|
||||
</summary>
|
||||
<param name="audiences">The audiences found in the <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.</param>
|
||||
<param name="jwtToken">The <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> being validated.</param>
|
||||
<param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
|
||||
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param>
|
||||
<remarks>See <see cref="M:Microsoft.IdentityModel.Tokens.Validators.ValidateAudience(System.Collections.Generic.IEnumerable{System.String},Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"/> for additional details.</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ValidateLifetime(System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.IdentityModel.Tokens.Jwt.JwtSecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
|
||||
@@ -1484,7 +1566,7 @@
|
||||
<param name="notBefore">The <see cref="T:System.DateTime"/> value of the 'nbf' claim if it exists in the 'jwtToken'.</param>
|
||||
<param name="expires">The <see cref="T:System.DateTime"/> value of the 'exp' claim if it exists in the 'jwtToken'.</param>
|
||||
<param name="jwtToken">The <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> being validated.</param>
|
||||
<param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
|
||||
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param>
|
||||
<remarks><see cref="M:Microsoft.IdentityModel.Tokens.Validators.ValidateLifetime(System.Nullable{System.DateTime},System.Nullable{System.DateTime},Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"/> for additional details.</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ValidateIssuer(System.String,System.IdentityModel.Tokens.Jwt.JwtSecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
|
||||
@@ -1493,7 +1575,7 @@
|
||||
</summary>
|
||||
<param name="issuer">The issuer to validate</param>
|
||||
<param name="jwtToken">The <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> that is being validated.</param>
|
||||
<param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
|
||||
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param>
|
||||
<returns>The issuer to use when creating the <see cref="T:System.Security.Claims.Claim"/>(s) in the <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</returns>
|
||||
<remarks><see cref="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuer(System.String,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"/> for additional details.</remarks>
|
||||
</member>
|
||||
@@ -1503,7 +1585,7 @@
|
||||
</summary>
|
||||
<param name="expires">The <see cref="T:System.DateTime"/> value of the 'exp' claim if it exists in the <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>'.</param>
|
||||
<param name="securityToken">The <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> that is being validated.</param>
|
||||
<param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
|
||||
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ResolveIssuerSigningKey(System.String,System.IdentityModel.Tokens.Jwt.JwtSecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
|
||||
<summary>
|
||||
@@ -1511,7 +1593,7 @@
|
||||
</summary>
|
||||
<param name="token">The <see cref="T:System.String"/> representation of the token that is being validated.</param>
|
||||
<param name="jwtToken">The <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> that is being validated.</param>
|
||||
<param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
|
||||
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param>
|
||||
<returns>Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signature validation.</returns>
|
||||
<remarks>If key fails to resolve, then null is returned</remarks>
|
||||
</member>
|
||||
@@ -1521,19 +1603,19 @@
|
||||
</summary>
|
||||
<param name="token">The <see cref="T:System.String"/> the token that is being decrypted.</param>
|
||||
<param name="jwtToken">The <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> that is being decrypted.</param>
|
||||
<param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
|
||||
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param>
|
||||
<returns>Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signature validation.</returns>
|
||||
<remarks>If key fails to resolve, then null is returned</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.DecryptToken(System.IdentityModel.Tokens.Jwt.JwtSecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
|
||||
<summary>
|
||||
Decrypts a JWE and returns the clear text
|
||||
Decrypts a JWE and returns the clear text
|
||||
</summary>
|
||||
<param name="jwtToken">the JWE that contains the cypher text.</param>
|
||||
<param name="validationParameters">contains crypto material.</param>
|
||||
<returns>the decoded / cleartext contents of the JWE.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">if 'jwtToken' is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">if 'validationParameters' is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">if <paramref name="jwtToken"/> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">if <paramref name="validationParameters"/> is null.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">if 'jwtToken.Header.enc' is null or empty.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException">if 'jwtToken.Header.kid' is not null AND decryption fails.</exception>
|
||||
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">if the JWE was not able to be decrypted.</exception>
|
||||
@@ -1544,7 +1626,7 @@
|
||||
</summary>
|
||||
<param name="key">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:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> to validate.</param>
|
||||
<param name="validationParameters">The current <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>.</param>
|
||||
<param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validating the token.</param>
|
||||
<remarks>If the <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityToken.SigningKey"/> is a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> then the X509Certificate2 will be validated using the CertificateValidator.</remarks>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.WriteToken(System.Xml.XmlWriter,Microsoft.IdentityModel.Tokens.SecurityToken)">
|
||||
@@ -1554,6 +1636,9 @@
|
||||
<param name="writer">The XML writer.</param>
|
||||
<param name="token">A token of type <see cref="P:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.TokenType"/>.</param>
|
||||
</member>
|
||||
<member name="M:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.ValidateTokenAsync(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:System.IdentityModel.Tokens.Jwt.LogMessages">
|
||||
<summary>
|
||||
Log messages and codes
|
||||
|
||||
BIN
Bin/System.Security.Cryptography.Xml.dll
Normal file
BIN
Bin/System.Security.Cryptography.Xml.dll
Normal file
Binary file not shown.
BIN
Bin/System.Security.Cryptography.Xml.dll.refresh
Normal file
BIN
Bin/System.Security.Cryptography.Xml.dll.refresh
Normal file
Binary file not shown.
2191
Bin/System.Security.Cryptography.Xml.xml
Normal file
2191
Bin/System.Security.Cryptography.Xml.xml
Normal file
File diff suppressed because it is too large
Load Diff
Binary file not shown.
Binary file not shown.
Binary file not shown.
38512
Bin/itextsharp.xml
38512
Bin/itextsharp.xml
File diff suppressed because it is too large
Load Diff
Binary file not shown.
BIN
Bin/log4net.dll
BIN
Bin/log4net.dll
Binary file not shown.
BIN
Bin/log4net.dll.refresh
Normal file
BIN
Bin/log4net.dll.refresh
Normal file
Binary file not shown.
35788
Bin/log4net.xml
35788
Bin/log4net.xml
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user