Skip to content

Initialize-PodeCsrf

SYNOPSIS

Initialises CSRF within Pode for adhoc usage.

SYNTAX

Initialize-PodeCsrf [[-IgnoreMethods] <String[]>] [[-Secret] <String>] [-UseCookies] [<CommonParameters>]

DESCRIPTION

Initialises CSRF within Pode for adhoc usage, with configurable HTTP methods to ignore verification.

EXAMPLES

EXAMPLE 1

Initialize-PodeCsrf -IgnoreMethods @('Get', 'Trace')

EXAMPLE 2

Initialize-PodeCsrf -Secret 'some-secret' -UseCookies

PARAMETERS

-IgnoreMethods

An array of HTTP methods to ignore CSRF verification.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: @('Get', 'Head', 'Options', 'Trace')
Accept pipeline input: False
Accept wildcard characters: False

-Secret

A secret to use when signing cookies - for when using CSRF with cookies.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseCookies

If supplied, CSRF will used cookies rather than sessions.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Back to top