Uwn.Razor.Common 10.26.6.1109

Uwn.Razor.Common

A common class library for Razor.

Providers

AuthorizationPolicies

Provides common authorization policies:

• User
• Moderator
• Administrator

See Microsoft.AspNetCore.Authorization.AuthorizationPolicy.

IIdentityClaimProvider

An interface for providing claims for a user identity.

Services

AuthenticationEndpointRouteBuilderExtensions

Provides extension methods for Microsoft.AspNetCore.Routing.IEndpointRouteBuilder to add authentication endpoints for use with OpenIdConnect.

These include:

• ResetPassword
• SignUp
• SignIn
• Validate
• EditProfile
• SignOut

Validation also ensures the existance of the Identity in an Uwn.Authentication.AuthenticationDbContext.

ServiceCollectionExtensions

Provides extension methods for Microsoft.Extensions.DependencyInjection.IServiceCollection to add services for Razor.

Configuration is provided by Uwn.Razor.Common.Models.ServiceCollectionOptions (see below).

WebApplicationExtensions

Provides extension methods for Microsoft.AspNetCore.Builder.WebApplication to add middleware for Razor.

Configuration is provided by Uwn.Razor.Common.Models.WebAppOptions (see below).

WebAppBuilder

Provides a builder for Microsoft.AspNetCore.Builder.WebApplication that adds services and endpoints for Razor, using ServiceCollectionExtensions and WebApplicationExtensions.

Configuration is provided by Uwn.Razor.Common.Models.ServiceCollectionOptions and Uwn.Razor.Common.Models.WebAppOptions (see below).

Models

ServiceCollectionOptions

• IncludeAntiforgery: Whether to include antiforgery services. Default is false.
• IncludeCookieOptions: Whether to include cookie options. Default is false.
• IncludeHttpClient: Whether to include HttpClient services. Default is false.
• IncludeHttpContextAccessor: Whether to include HttpContextAccessor services. Default is false.
• IncludeLocalization: Whether to include localization services. Default is false.
• IncludeMicrosoftIdentityWebApp: Whether to include Microsoft Identity Web App services. Default is false.
• IncludeUwRazor: Whether to include Uwn.Razor services. Default is false.
• AuthorizationOptions: Includes configuration for access control policies. Default is null.
• AuthorizationPolicies: A list of authorization policies to add. Default is null.
• CookiePolicyOptions: Configuration for cookie policies. Default is null.
• SqlServerDbContexts: A list of SQL Server DbContexts to add. Default is null.
• MicrosoftIdentityConfigurationSectionName: The name of the configuration section for Microsoft Identity. Default is null.
• SupportedCultureNames: A list of supported culture names for localization. Default is null.
• SingletonServices: A list of services to register as Singleton. Default is null.
• ScopedServices: A list of services to register as Scoped. Default is null.
• TransientServices: A list of services to register as Transient. Default is null.
• FinalizeCallback: A callback to finalize service collection configuration. Default is null.

WebAppOptions

• IncludeExceptionHandler: Whether to include an exception handler middleware. Default is false.
• IncludeHsts: Whether to include HSTS middleware. Default is false.
• IncludeRequestLocalization: Whether to include request localization middleware. Default is false.
• IncludeHttpsRedirection: Whether to include HTTPS redirection middleware. Default is false.
• IncludeStaticFiles: Whether to include static files middleware. Default is false.
• IncludeCookiePolicy: Whether to include cookie policy middleware. Default is false.
• IncludeRouting: Whether to include routing middleware. Default is false.
• IncludeAuthentication: Whether to include authentication middleware. Default is false.
• IncludeAuthorization: Whether to include authorization middleware. Default is false.
• IncludeAntiforgery: Whether to include antiforgery middleware. Default is false.
• IncludeOpenIdAuthenticationEndpoints: Whether to include OpenId authentication endpoints. Default is false.
• AuthenticationEndpointRouteBuilderOptions: Configuration for authentication endpoint routes. Default is null.

AuthenticationEndpointRouteBuilderOptions

• Prefix: The prefix for authentication endpoint routes. Default is Identity.
• StatusPattern: The pattern for the status endpoint. Default is Status.
• ResetPasswordPattern: The pattern for the reset password endpoint. Default is ResetPassword.
• SignUpPattern: The pattern for the sign-up endpoint. Default is SignUp.
• SignInPattern: The pattern for the sign-in endpoint. Default is SignIn.
• ValidatePattern: The pattern for the validate endpoint. Default is Validate.
• EditProfilePattern: The pattern for the edit profile endpoint. Default is EditProfile.
• SignOutPattern: The pattern for the sign-out endpoint. Default is SignOut.