Attributes

Every attribute in the framework, by the package it comes from.

Modules and application

Hardened.Shared.Runtime.Attributes

Attribute	Target	Purpose
`[HardenedModule]`	Class	Marks a `partial class` as a module entry point. Generates the module and a companion attribute named after it
`[ConfigurationModel]`	Class	Marks a `partial class` as a configuration model. Generates the interface, the properties and the registration
`[FromEnvironmentVariable(name)]`	Field	Populates a configuration field from an environment variable
`[HideConfigurationField]`	Field	Excludes a field from the generated interface
`[ConfigurationProvider]`	Class	Marks a configuration provider

Every [HardenedModule] class also produces <Name>Attribute, which is how one module imports another — [AspNetCoreRuntime], [HardenedWebModule], [DynamoDbModule] and the rest are all generated this way. See Modules.

Service registration

DependencyModules.Runtime.Attributes, from DependencyModules

Attribute	Target	Purpose
`[SingletonService]`	Class	One instance for the application
`[ScopedService]`	Class	One instance per scope
`[TransientService]`	Class	A new instance per resolution
`[DependencyModule]`	Class	The DependencyModules module attribute `[HardenedModule]` builds on
`[Decorator]`	Class	Wraps a registered service
`[Decorate]`	Class	Applies a decorator to a service you do not control
`[Intercept]`	Class	Routes members through generated interceptors
`[IfEnvironment]` / `[IfNotEnvironment]`	Class	Registers only in (or outside) named environments
`[IfEnvironmentValue]` / `[IfNotEnvironmentValue]`	Class	Registers based on an environment variable
`[CrossWireService]`	Class	Cross-wires a registration between modules

All take As to narrow the service type, and Using to choose the registration semantics.

Requests

Hardened.Requests.Abstract.Attributes

Attribute	Target	Purpose
`[HardenedFunction(name?)]`	Method	A function handler, addressed by name
`[Handler]`	Class	Marks an implementation of a generated OpenAPI service interface
`[FromBody]`	Parameter	Binds from the request body
`[FromServices]`	Parameter	Binds from the container
`[Output<T>]`	Method	Hands the response to a view or other output instead of serialising it. Takes the response out of negotiation: unsupported `Accept` is a `406`
`[RawResponse(contentType?)]`	Method	Commits the response to a content type and writes the value unstructured. Defaults to `text/plain`

ICustomBindingAttribute is the interface an attribute implements to bind a parameter itself — see Parameter binding.

Hardened.Requests.Runtime.Filters

Attribute	Target	Purpose
`[Retry(Retries, SleepTime)]`	Method	Retries the handler. Defaults: 3 retries, 500 ms

Authorization

Hardened.Requests.Runtime.Authorization

Attribute	Target	Purpose
`[AuthorizeGrants(grants)]`	Class, method	Requires every grant named. What a generator emits from a specification
`[AuthorizeGrants<T>]`	Class, method	Requires every grant in the `IGrantProvider` `T` names. The typed spelling
`[Authorize<TPolicy>]`	Class, method	Requires the policy's requirement. The only form that can express or
`[AllowAnonymous]`	Class, method	Makes an operation public on purpose. Beats every requirement on the same handler, including a convention
`[RequireAuthorization]`	Class, assembly	On the module: a handler declaring nothing is denied rather than public, and reported as `HAUTH001` at build

Every one of these stacks as and. Attributes on a method, attributes on its controller, attributes inherited from a base attribute and requirements added by an IAuthorizationConvention are all conjoined into the single Requirement the pipeline reads. Alternatives are expressible only inside a single policy.

[AuthorizeGrants] is not sealed — deriving from it is one of the two ways to require grants without writing strings. IAuthorizeAttribute is the interface anything the pipeline honours implements, including attributes of your own, and it is what the HAUTH001 diagnostic tests.

See Authorization.

Web

Hardened.Web.Runtime.Attributes

Attribute	Target	Purpose
`[Get(path)]`	Method	A `GET` route
`[Post(path)]`	Method	A `POST` route
`[Put(path)]`	Method	A `PUT` route
`[Delete(path)]`	Method	A `DELETE` route
`[Patch(path)]`	Method	A `PATCH` route
`[BasePath(path)]`	Class, assembly	Prefixes every route beneath it
`[FromQueryString(name?)]`	Parameter	Binds from the query string
`[FromHeader(name?)]`	Parameter	Binds from a request header
`[CacheControl]`	Method	Sets cache headers. `MaxAge`, `Type`
`[WebLibrary]`	Class	Marks a web library entry point
`[Tag(name)]`	Class	The OpenAPI tag this controller's operations group under. Defaults to the class name minus `Controller`
`[Server(url, description?)]`	Class, assembly	A base URL the generated document lists under `servers`
`[CaseInsensitiveRoutes]`	Class	Matches this module's routes without regard to case
`[RouteConstraint(name)]`	Method	Declares a route constraint. `static bool(ReadOnlySpan<char>)`

The verb attributes also declare SuccessStatus, the status a successful response answers with and the document publishes; unset means 200. The NullReturnStatus, ValidationErrorStatus and ErrorStatus properties they once carried are gone. See Returning null for what decides those statuses.

Templates

Hardened.Templates.RazorBlade

Attribute	Target	Purpose
`[Enable<HardenedRazorTemplates>]`	Class	Generates a RazorBlade template base for a module
`[TemplateBase(typeof(T<>))]`	Class	On an engine's marker: the class a generated base derives from
`[TemplateContentType(type)]`	Class	On an engine's marker: what views on that base produce

[Enable<T>] itself lives in Hardened.Shared.Runtime.Attributes and is the framework's one name for every optional generated feature. It requires new(), and a marker that is also a DependencyModules module has its registrations applied too. A view is named on a handler with [Output<T>].

Console

Hardened.Commands.Attributes

Attribute	Target	Purpose
`[Command(command)]`	Class	A command. `ParentCommand`, `Description`
`[Option]`	Property	Renames an option or gives it help text
`[FileOption]`	Property	An option whose value is a path
`[ExcludeOption]`	Property	A property that is not an option

Testing

Hardened.Shared.Testing.Attributes

Attribute	Target	Purpose
`[HardenedTest]`	Method	An xUnit fact that boots the application and injects the parameters
`[HardenedTestEntryPoint(type)]`	Assembly, class, method	Names the application module under test
`[Mock]`	Parameter	Substitutes an NSubstitute mock and hands it to the test
`[EnvironmentName(name)]`	Assembly, class, method	The environment name for the test. Defaults to `test`
`[EnvironmentValue(variable, value)]`	Assembly, class, method	Sets an environment value for the test

Hardened.Web.Testing

Attribute	Target	Purpose
`[WebTesting]`	Assembly	Installs `ITestWebApp`

AWS

From Hardened.Amz.

Attribute	Namespace	Purpose
`[LambdaFunctionModule]`	`Hardened.Amz.Function.Lambda.Runtime.DependencyInjection`	Lambda invocation runtime and the request pipeline. Required by every function application
`[LambdaWebModule]`	`Hardened.Amz.Web.Lambda.Runtime.DependencyInjection`	API Gateway runtime and the web pipeline. Required by every Lambda web application
`[LambdaWebApplication(Version)]`	`Hardened.Amz.Web.Lambda.Runtime`	States the payload format. `ProxyIntegrationType.HttpApiV2` is the default and the only implemented value; `.ApiGateway` is `HRDAWS001`
`[StreamingLambdaWebModule]`	`Hardened.Amz.Web.Lambda.Streaming`	Response-streaming web runtime
`[StreamingLambdaFunctionModule]`	`Hardened.Amz.Function.Lambda.Streaming`	Response-streaming function runtime
`[SqsLambda]`	`Hardened.Amz.Function.Sqs.Runtime`	SQS batch runtime. Applied alongside `[LambdaFunctionModule]`
`[DynamoStreamLambda]`	`Hardened.Amz.Function.DDB.Runtime`	DynamoDB Streams runtime. Applied alongside `[LambdaFunctionModule]`
`[DynamoDbModule]`	`Hardened.Amz.DynamoDbClient`	Registers `IDynamoDbClientProvider`
`[HardenedCdk]`	`Hardened.Amz.Cdk`	CDK deployment application
`[NewImage]` / `[OldImage]`	`Hardened.Amz.Function.DDB.Runtime.Attributes`	Binds a stream record's images
`[FromContext(name?)]`	`Hardened.Amz.Function.Lambda.Runtime`	Binds a named value from the invocation's headers
`[ThrowException]`	`Hardened.Amz.Function.Lambda.Runtime`	Rethrows, so the invocation fails instead of returning the error
`[LambdaFunctionTesting]`	`Hardened.Amz.Function.Lambda.Testing`	Installs the Lambda test harnesses
`[LocalDynamoDb(Image?)]`	`Hardened.Amz.DynamoDbClient.Testing`	Points the client provider at DynamoDB Local in a container

Attributes ​

Modules and application ​

Service registration ​

Requests ​

Authorization ​

Web ​

Templates ​

Console ​

Testing ​

AWS ​