Making docs more inclusive (#14607)
This commit is contained in:
parent
387bd1a404
commit
b3599b6cfa
|
|
@ -8,7 +8,7 @@ namespace Microsoft.AspNetCore.Antiforgery
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Allows providing or validating additional custom data for antiforgery tokens.
|
/// Allows providing or validating additional custom data for antiforgery tokens.
|
||||||
/// For example, the developer could use this to supply a nonce when the token is
|
/// For example, the developer could use this to supply a nonce when the token is
|
||||||
/// generated, then he could validate the nonce when the token is validated.
|
/// generated, then validate it when the token is validated.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <remarks>
|
/// <remarks>
|
||||||
/// The antiforgery system already embeds the client's username within the
|
/// The antiforgery system already embeds the client's username within the
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@ namespace Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption
|
||||||
/// This method allows for a slight performance improvement over IAuthenticatedEncryptor.Encrypt
|
/// This method allows for a slight performance improvement over IAuthenticatedEncryptor.Encrypt
|
||||||
/// in the case where the caller needs to prepend or append some data to the resulting ciphertext.
|
/// in the case where the caller needs to prepend or append some data to the resulting ciphertext.
|
||||||
/// For instance, if the caller needs to append a 32-bit header to the resulting ciphertext, then
|
/// For instance, if the caller needs to append a 32-bit header to the resulting ciphertext, then
|
||||||
/// he can specify 4 for 'preBufferSize' and overwrite the first 32 bits of the buffer returned
|
/// specify 4 for 'preBufferSize' and overwrite the first 32 bits of the buffer returned
|
||||||
/// by this function. This saves the caller from having to allocate a new buffer to hold the final
|
/// by this function. This saves the caller from having to allocate a new buffer to hold the final
|
||||||
/// transformed result.
|
/// transformed result.
|
||||||
///
|
///
|
||||||
|
|
|
||||||
|
|
@ -15,14 +15,14 @@ namespace Microsoft.AspNetCore.DataProtection
|
||||||
/// <remarks>
|
/// <remarks>
|
||||||
/// <para>
|
/// <para>
|
||||||
/// If the developer changes the at-rest key protection mechanism, it is intended that
|
/// If the developer changes the at-rest key protection mechanism, it is intended that
|
||||||
/// he also change the key storage location, and vice versa. For instance, a call to
|
/// they also change the key storage location, and vice versa. For instance, a call to
|
||||||
/// <see cref="DataProtectionBuilderExtensions.ProtectKeysWithCertificate(IDataProtectionBuilder,string)" /> should generally be accompanied by
|
/// <see cref="DataProtectionBuilderExtensions.ProtectKeysWithCertificate(IDataProtectionBuilder,string)" /> should generally be accompanied by
|
||||||
/// a call to <see cref="DataProtectionBuilderExtensions.PersistKeysToFileSystem(IDataProtectionBuilder,DirectoryInfo)"/>, or exceptions may
|
/// a call to <see cref="DataProtectionBuilderExtensions.PersistKeysToFileSystem(IDataProtectionBuilder,DirectoryInfo)"/>, or exceptions may
|
||||||
/// occur at runtime due to the data protection system not knowing where to persist keys.
|
/// occur at runtime due to the data protection system not knowing where to persist keys.
|
||||||
/// </para>
|
/// </para>
|
||||||
/// <para>
|
/// <para>
|
||||||
/// Similarly, when a developer modifies the default protected payload cryptographic
|
/// Similarly, when a developer modifies the default protected payload cryptographic
|
||||||
/// algorithms, it is intended that he also select an explitiy key storage location.
|
/// algorithms, they should also set an explicit key storage location.
|
||||||
/// A call to <see cref="DataProtectionBuilderExtensions.UseCryptographicAlgorithms(IDataProtectionBuilder,AuthenticatedEncryptorConfiguration)"/>
|
/// A call to <see cref="DataProtectionBuilderExtensions.UseCryptographicAlgorithms(IDataProtectionBuilder,AuthenticatedEncryptorConfiguration)"/>
|
||||||
/// should therefore generally be paired with a call to <see cref="DataProtectionBuilderExtensions.PersistKeysToFileSystem(IDataProtectionBuilder,DirectoryInfo)"/>,
|
/// should therefore generally be paired with a call to <see cref="DataProtectionBuilderExtensions.PersistKeysToFileSystem(IDataProtectionBuilder,DirectoryInfo)"/>,
|
||||||
/// for example.
|
/// for example.
|
||||||
|
|
|
||||||
|
|
@ -253,7 +253,7 @@ namespace Microsoft.AspNetCore.DataProtection.KeyManagement
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Do we need to notify the caller that he should reprotect the data?
|
// Do we need to notify the caller that they should reprotect the data?
|
||||||
status = UnprotectStatus.Ok;
|
status = UnprotectStatus.Ok;
|
||||||
if (keyIdFromPayload != currentKeyRing.DefaultKeyId)
|
if (keyIdFromPayload != currentKeyRing.DefaultKeyId)
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -226,9 +226,9 @@ namespace Microsoft.AspNetCore.DataProtection.KeyManagement
|
||||||
Volatile.Write(ref _cacheableKeyRing, existingCacheableKeyRing.WithTemporaryExtendedLifetime(utcNow));
|
Volatile.Write(ref _cacheableKeyRing, existingCacheableKeyRing.WithTemporaryExtendedLifetime(utcNow));
|
||||||
}
|
}
|
||||||
|
|
||||||
// The immediate caller should fail so that he can report the error up his chain. This makes it more likely
|
// The immediate caller should fail so that they can report the error up the chain. This makes it more likely
|
||||||
// that an administrator can see the error and react to it as appropriate. The caller can retry the operation
|
// that an administrator can see the error and react to it as appropriate. The caller can retry the operation
|
||||||
// and will probably have success as long as he falls within the temporary extension mentioned above.
|
// and will probably have success as long as they fall within the temporary extension mentioned above.
|
||||||
throw;
|
throw;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -93,7 +93,7 @@ namespace Microsoft.AspNetCore.JsonPatch.Adapters
|
||||||
void Remove(Operation operation, object objectToApplyTo);
|
void Remove(Operation operation, object objectToApplyTo);
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Using the "replace" operation he value at the target location is replaced
|
/// Using the "replace" operation the value at the target location is replaced
|
||||||
/// with a new value. The operation object MUST contain a "value" member
|
/// with a new value. The operation object MUST contain a "value" member
|
||||||
/// which specifies the replacement value.
|
/// which specifies the replacement value.
|
||||||
///
|
///
|
||||||
|
|
|
||||||
|
|
@ -53,7 +53,7 @@ namespace Microsoft.Net.Http.Headers
|
||||||
(length != tag.Length))
|
(length != tag.Length))
|
||||||
{
|
{
|
||||||
// Note that we don't allow 'W/' prefixes for weak ETags in the 'tag' parameter. If the user wants to
|
// Note that we don't allow 'W/' prefixes for weak ETags in the 'tag' parameter. If the user wants to
|
||||||
// add a weak ETag, he can set 'isWeak' to true.
|
// add a weak ETag, they can set 'isWeak' to true.
|
||||||
throw new FormatException("Invalid ETag name");
|
throw new FormatException("Invalid ETag name");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ namespace Microsoft.Net.Http.Headers
|
||||||
{
|
{
|
||||||
// Note that even if we check the value here, we can't prevent a user from adding an invalid quality
|
// Note that even if we check the value here, we can't prevent a user from adding an invalid quality
|
||||||
// value using Parameters.Add(). Even if we would prevent the user from adding an invalid value
|
// value using Parameters.Add(). Even if we would prevent the user from adding an invalid value
|
||||||
// using Parameters.Add() he could always add invalid values using HttpHeaders.AddWithoutValidation().
|
// using Parameters.Add() they could always add invalid values using HttpHeaders.AddWithoutValidation().
|
||||||
// So this check is really for convenience to show users that they're trying to add an invalid
|
// So this check is really for convenience to show users that they're trying to add an invalid
|
||||||
// value.
|
// value.
|
||||||
if ((value < 0) || (value > 1))
|
if ((value < 0) || (value > 1))
|
||||||
|
|
|
||||||
|
|
@ -73,7 +73,7 @@ namespace Microsoft.AspNetCore.Routing.Constraints
|
||||||
// the HTTP GET-specific route will be used for URI generation, which might have undesired behavior.
|
// the HTTP GET-specific route will be used for URI generation, which might have undesired behavior.
|
||||||
//
|
//
|
||||||
// To prevent this, a user might call GetVirtualPath(..., { httpMethod = "POST" }) to
|
// To prevent this, a user might call GetVirtualPath(..., { httpMethod = "POST" }) to
|
||||||
// signal that he is generating a URI that will be used for an HTTP POST, so he wants the URI
|
// signal that they are generating a URI that will be used for an HTTP POST, so they want the URI
|
||||||
// generation to be performed by the (b) route instead of the (a) route, consistent with what would
|
// generation to be performed by the (b) route instead of the (a) route, consistent with what would
|
||||||
// happen on incoming requests.
|
// happen on incoming requests.
|
||||||
if (!values.TryGetValue(routeKey, out var obj))
|
if (!values.TryGetValue(routeKey, out var obj))
|
||||||
|
|
|
||||||
|
|
@ -1898,7 +1898,7 @@ namespace Microsoft.AspNetCore.Identity
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Returns a flag indicating whether the specified <paramref name="user"/> his locked out,
|
/// Returns a flag indicating whether the specified <paramref name="user"/> is locked out,
|
||||||
/// as an asynchronous operation.
|
/// as an asynchronous operation.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="user">The user whose locked out status should be retrieved.</param>
|
/// <param name="user">The user whose locked out status should be retrieved.</param>
|
||||||
|
|
|
||||||
|
|
@ -242,7 +242,7 @@ namespace Microsoft.AspNetCore.Mvc.ApplicationModels
|
||||||
// we compare it against the rest of the templates that have that same name
|
// we compare it against the rest of the templates that have that same name
|
||||||
// associated.
|
// associated.
|
||||||
// The moment we find one that is different we report the whole group to the
|
// The moment we find one that is different we report the whole group to the
|
||||||
// user in the error message so that he can see the different actions and the
|
// user in the error message so that they can see the different actions and the
|
||||||
// different templates for a given named attribute route.
|
// different templates for a given named attribute route.
|
||||||
var template = actions[0].selector.AttributeRouteModel.Template;
|
var template = actions[0].selector.AttributeRouteModel.Template;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -120,7 +120,7 @@ export class Login extends Component {
|
||||||
redirectToApiAuthorizationPath(apiAuthorizationPath) {
|
redirectToApiAuthorizationPath(apiAuthorizationPath) {
|
||||||
const redirectUrl = `${window.location.origin}${apiAuthorizationPath}`;
|
const redirectUrl = `${window.location.origin}${apiAuthorizationPath}`;
|
||||||
// It's important that we do a replace here so that when the user hits the back arrow on the
|
// It's important that we do a replace here so that when the user hits the back arrow on the
|
||||||
// browser he gets sent back to where it was on the app instead of to an endpoint on this
|
// browser they get sent back to where it was on the app instead of to an endpoint on this
|
||||||
// component.
|
// component.
|
||||||
window.location.replace(redirectUrl);
|
window.location.replace(redirectUrl);
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue