addCsrf

mach::AppBuilder::addCsrf

Adds CSRF protection.

Description

Adds CSRF protection to the application.

Syntax

// (1)
AppBuilder& addCsrf();

// (2)
template <typename TConfigure>
    requires std::invocable<TConfigure, CsrfBuilder&>
AppBuilder& addCsrf(TConfigure&& configure);

Return Value

A reference to the current AppBuilder instance.

Template Parameters

Overload (2)

Parameter	Description
TConfigure	The type of the callable used to configure CSRF.

Parameters

Overload (2)

Parameter	Description
configure	A callable that receives a CsrfBuilder used to configure CSRF.

Remarks

• In overload (2), the configuration callable is invoked immediately and receives a CsrfBuilder by reference.
• Changes made after App::run() has been called do not take effect.

Thread Safety

This method is not thread-safe and should only be called during application configuration, before the application starts handling requests.

Examples

Overload (1)

builder.addCsrf();

Overload (2)

builder.addCsrf([](mach::CsrfBuilder& csrf) {
    csrf.cookieName("csrf-token")
        .headerName("X-CSRF-Token");
});

See Also

Name	Description
CsrfBuilder	Configures CSRF.