CsrfMiddleware
in package
implements
IMiddleware
CSRFミドルウェア。
Table of Contents
Interfaces
- IMiddleware
- ミドルウェア。
Constants
- MODE_BODY = 1
- MODE_HEADER = 0
Properties
Methods
- __construct() : mixed
- handleAfter() : MiddlewareResult
- 後処理。
- handleBefore() : MiddlewareResult
- 前処理。
- getErrorHttpStatus() : HttpStatus
- CSRFトークン不正時のHTTP応答ステータス。
- getHeaderName() : non-empty-string
- CSRFとして有効なHTTPヘッダ名を返す。
- getRequestKey() : non-empty-string
- CSRFとして有効なリクエストキーを返す。
- getRequestMode() : int
- getSessionKey() : non-empty-string
- CSRFとして有効なセッションキーを返す。
- handleBeforeBody() : MiddlewareResult
- handleBeforeHeader() : MiddlewareResult
Constants
MODE_BODY
protected
mixed
MODE_BODY
= 1
MODE_HEADER
protected
mixed
MODE_HEADER
= 0
Properties
$regex
protected
Regex
$regex
$logger
private
ILogger
$logger
$webSecurity
private
WebSecurity
$webSecurity
Methods
__construct()
public
__construct(WebSecurity $webSecurity, ILogger $logger) : mixed
Parameters
- $webSecurity : WebSecurity
- $logger : ILogger
handleAfter()
後処理。
public
final handleAfter(MiddlewareArgument $argument, HttpResponse $response) : MiddlewareResult
Parameters
- $argument : MiddlewareArgument
-
ミドルウェアの入力パラメータ。
- $response : HttpResponse
Return values
MiddlewareResult —ミドルウェア結果。
handleBefore()
前処理。
public
handleBefore(MiddlewareArgument $argument) : MiddlewareResult
Parameters
- $argument : MiddlewareArgument
-
ミドルウェアの入力パラメータ。
Return values
MiddlewareResult —ミドルウェア結果。
getErrorHttpStatus()
CSRFトークン不正時のHTTP応答ステータス。
protected
getErrorHttpStatus() : HttpStatus
Return values
HttpStatusgetHeaderName()
CSRFとして有効なHTTPヘッダ名を返す。
protected
getHeaderName() : non-empty-string
Return values
non-empty-stringgetRequestKey()
CSRFとして有効なリクエストキーを返す。
protected
getRequestKey() : non-empty-string
Return values
non-empty-stringgetRequestMode()
protected
getRequestMode(MiddlewareArgument $argument) : int
Parameters
- $argument : MiddlewareArgument
Return values
intgetSessionKey()
CSRFとして有効なセッションキーを返す。
protected
getSessionKey() : non-empty-string
Return values
non-empty-stringhandleBeforeBody()
protected
handleBeforeBody(MiddlewareArgument $argument) : MiddlewareResult
Parameters
- $argument : MiddlewareArgument
Return values
MiddlewareResulthandleBeforeHeader()
protected
handleBeforeHeader(MiddlewareArgument $argument) : MiddlewareResult
Parameters
- $argument : MiddlewareArgument