zero-auth

Appearance

zero-auth API Documentation v1.6.0

zero-auth API Documentation / CsrfConfig

Interface: CsrfConfig ​

Defined in: packages/zero-auth/src/types/auth.ts:204

Configuration for the signed double-submit CSRF middleware.

Properties ​

cookieName? ​

optional cookieName?: string

Defined in: packages/zero-auth/src/types/auth.ts:206

Client-readable CSRF cookie name.

Default ​

ts
"csrf_token"

headerName? ​

optional headerName?: string

Defined in: packages/zero-auth/src/types/auth.ts:208

Header carrying the token copied from the CSRF cookie.

Default ​

ts
"x-csrf-token"

methods? ​

optional methods?: string[]

Defined in: packages/zero-auth/src/types/auth.ts:210

HTTP methods to protect.

Default ​

ts
["POST", "PUT", "PATCH", "DELETE"]

secret? ​

optional secret?: string

Defined in: packages/zero-auth/src/types/auth.ts:212

Optional symmetric secret for signing CSRF tokens.