diff --git a/src/Microsoft.AspNetCore.Authentication.Cookies/CookieAuthenticationOptions.cs b/src/Microsoft.AspNetCore.Authentication.Cookies/CookieAuthenticationOptions.cs
index dc1a63bbf3..51cf43a0f1 100644
--- a/src/Microsoft.AspNetCore.Authentication.Cookies/CookieAuthenticationOptions.cs
+++ b/src/Microsoft.AspNetCore.Authentication.Cookies/CookieAuthenticationOptions.cs
@@ -13,7 +13,7 @@ using Microsoft.Extensions.Options;
namespace Microsoft.AspNetCore.Builder
{
///
- /// Contains the options used by the CookiesAuthenticationMiddleware
+ /// Configuration options for .
///
public class CookieAuthenticationOptions : AuthenticationOptions, IOptions
{
diff --git a/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectOptions.cs b/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectOptions.cs
index de7bee1633..1b179c3369 100644
--- a/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectOptions.cs
+++ b/src/Microsoft.AspNetCore.Authentication.OpenIdConnect/OpenIdConnectOptions.cs
@@ -17,7 +17,7 @@ using Microsoft.IdentityModel.Tokens;
namespace Microsoft.AspNetCore.Builder
{
///
- /// Configuration options for
+ /// Configuration options for
///
public class OpenIdConnectOptions : RemoteAuthenticationOptions
{
diff --git a/src/Microsoft.AspNetCore.Authentication/AuthenticationOptions.cs b/src/Microsoft.AspNetCore.Authentication/AuthenticationOptions.cs
index 8f1fb06912..04d050b06e 100644
--- a/src/Microsoft.AspNetCore.Authentication/AuthenticationOptions.cs
+++ b/src/Microsoft.AspNetCore.Authentication/AuthenticationOptions.cs
@@ -6,7 +6,7 @@ using Microsoft.AspNetCore.Http.Authentication;
namespace Microsoft.AspNetCore.Builder
{
///
- /// Base Options for all authentication middleware
+ /// Base Options for all authentication middleware.
///
public abstract class AuthenticationOptions
{
diff --git a/src/Microsoft.AspNetCore.Authentication/ClaimsTransformationOptions.cs b/src/Microsoft.AspNetCore.Authentication/ClaimsTransformationOptions.cs
index 7772457a02..70a76f27c6 100644
--- a/src/Microsoft.AspNetCore.Authentication/ClaimsTransformationOptions.cs
+++ b/src/Microsoft.AspNetCore.Authentication/ClaimsTransformationOptions.cs
@@ -5,8 +5,14 @@ using Microsoft.AspNetCore.Authentication;
namespace Microsoft.AspNetCore.Builder
{
+ ///
+ /// Contains the options used by the .
+ ///
public class ClaimsTransformationOptions
{
+ ///
+ /// Responsible for transforming the claims principal.
+ ///
public IClaimsTransformer Transformer { get; set; }
}
}
diff --git a/src/Microsoft.AspNetCore.Authentication/IClaimsTransformer.cs b/src/Microsoft.AspNetCore.Authentication/IClaimsTransformer.cs
index 03eece9318..5111c79714 100644
--- a/src/Microsoft.AspNetCore.Authentication/IClaimsTransformer.cs
+++ b/src/Microsoft.AspNetCore.Authentication/IClaimsTransformer.cs
@@ -6,8 +6,16 @@ using System.Threading.Tasks;
namespace Microsoft.AspNetCore.Authentication
{
+ ///
+ /// Used for claims transformation.
+ ///
public interface IClaimsTransformer
{
+ ///
+ /// Provides a central transformation point to change the specified principal.
+ ///
+ /// The principal to transform.
+ /// The transformed principal.
Task TransformAsync(ClaimsPrincipal principal);
}
}
diff --git a/src/Microsoft.AspNetCore.Authentication/RemoteAuthenticationOptions.cs b/src/Microsoft.AspNetCore.Authentication/RemoteAuthenticationOptions.cs
index 0388c04bda..43e011c40e 100644
--- a/src/Microsoft.AspNetCore.Authentication/RemoteAuthenticationOptions.cs
+++ b/src/Microsoft.AspNetCore.Authentication/RemoteAuthenticationOptions.cs
@@ -8,6 +8,9 @@ using Microsoft.AspNetCore.Authentication;
namespace Microsoft.AspNetCore.Builder
{
+ ///
+ /// Contains the options used by the .
+ ///
public class RemoteAuthenticationOptions : AuthenticationOptions
{
///
diff --git a/src/Microsoft.AspNetCore.Authorization/AuthorizationOptions.cs b/src/Microsoft.AspNetCore.Authorization/AuthorizationOptions.cs
index c3019c907f..94799af29b 100644
--- a/src/Microsoft.AspNetCore.Authorization/AuthorizationOptions.cs
+++ b/src/Microsoft.AspNetCore.Authorization/AuthorizationOptions.cs
@@ -6,6 +6,9 @@ using System.Collections.Generic;
namespace Microsoft.AspNetCore.Authorization
{
+ ///
+ /// Provides programmatic configuration used by and .
+ ///
public class AuthorizationOptions
{
private IDictionary PolicyMap { get; } = new Dictionary(StringComparer.OrdinalIgnoreCase);
@@ -15,6 +18,11 @@ namespace Microsoft.AspNetCore.Authorization
///
public AuthorizationPolicy DefaultPolicy { get; set; } = new AuthorizationPolicyBuilder().RequireAuthenticatedUser().Build();
+ ///
+ /// Add an authorization policy with the provided name.
+ ///
+ /// The name of the policy.
+ /// The authorization policy.
public void AddPolicy(string name, AuthorizationPolicy policy)
{
if (name == null)
@@ -30,6 +38,11 @@ namespace Microsoft.AspNetCore.Authorization
PolicyMap[name] = policy;
}
+ ///
+ /// Add a policy that is built from a delegate with the provided name.
+ ///
+ /// The name of the policy.
+ /// The delegate that will be used to build the policy.
public void AddPolicy(string name, Action configurePolicy)
{
if (name == null)
@@ -47,6 +60,11 @@ namespace Microsoft.AspNetCore.Authorization
PolicyMap[name] = policyBuilder.Build();
}
+ ///
+ /// Returns the policy for the specified name, or null if a policy with the name does not exist.
+ ///
+ /// The name of the policy to return.
+ /// The policy for the specified name, or null if a policy with the name does not exist.
public AuthorizationPolicy GetPolicy(string name)
{
if (name == null)
diff --git a/src/Microsoft.AspNetCore.CookiePolicy/CookiePolicyOptions.cs b/src/Microsoft.AspNetCore.CookiePolicy/CookiePolicyOptions.cs
index 812c714288..8201b58639 100644
--- a/src/Microsoft.AspNetCore.CookiePolicy/CookiePolicyOptions.cs
+++ b/src/Microsoft.AspNetCore.CookiePolicy/CookiePolicyOptions.cs
@@ -6,12 +6,28 @@ using Microsoft.AspNetCore.CookiePolicy;
namespace Microsoft.AspNetCore.Builder
{
+ ///
+ /// Provides programmatic configuration for the .
+ ///
public class CookiePolicyOptions
{
+ ///
+ /// Affects whether cookies must be HttpOnly.
+ ///
public HttpOnlyPolicy HttpOnly { get; set; } = HttpOnlyPolicy.None;
+ ///
+ /// Affects whether cookies must be Secure.
+ ///
public SecurePolicy Secure { get; set; } = SecurePolicy.None;
+ ///
+ /// Called when a cookie is appended.
+ ///
public Action OnAppendCookie { get; set; }
+
+ ///
+ /// Called when a cookie is deleted.
+ ///
public Action OnDeleteCookie { get; set; }
}
}
\ No newline at end of file