SecurityCSRFOptions

Hierarchy

• SecurityEnableOptions
  • SecurityCSRFOptions

Index

Properties

• bodyName
• cookieDomain
• cookieName
• enable
• headerName
• ignore
• match
• queryName
• refererWhiteList
• sessionName
• type
• useSession

Properties

bodyName

bodyName: string

The name of the csrf token in the body.

cookieDomain

cookieDomain: (context: any) => string

cookieName

cookieName: string | string[]

The key name stored in the cookie by the token of csrf

enable

enable: boolean

Inherited from SecurityEnableOptions.enable

headerName

headerName: string

The name of the csrf token in the header

optionalignore

ignore?: IgnoreMatcher<any> | IgnoreMatcher<any>[]

Inherited from SecurityEnableOptions.ignore

optionalmatch

match?: IgnoreMatcher<any> | IgnoreMatcher<any>[]

Inherited from SecurityEnableOptions.match

queryName

queryName: string

The name of the csrf token in the query.

refererWhiteList

refererWhiteList: string[]

sessionName

sessionName: string

The key name of the CSRF token stored in the session.

type

type: SecurityCSRFType

useSession

useSession: boolean

If set to true, the secret will be stored in the session instead of the cookie.