TGMDK_AuthHashUtil
in package
パラメータ改竄チェック関連ユーティリティクラス。
Tags
Table of Contents
- checkAuthHash() : bool
- リクエストパラメータ内のパラメータ順序(authParams)に従ってハッシュ値を計算し、 リクエストパラメータ内の改竄チェック用ハッシュ値(vAuthInfo)と比較する。<br> リクエストパラメータにパラメータ順序と改竄チェック用ハッシュ値が含まれていない場合、 改竄されているとみなす。<br> <br>
- base64Dec() : false|string
- Base64デコードを行う。
- createAuthHashInfo() : null|string
- ハッシュ値を算出する。
- getFirstValue() : array<string|int, mixed>|mixed|null
- 指定した値に格納された先頭の値を取得する。<br> ・指定した値が配列の場合は、配列の先頭の値を取得する。<br> ・指定した値が配列ではない場合は、指定した値をそのまま返す。<br> ・指定した値が空配列である場合は、NULLを取得する。<br>
Methods
checkAuthHash()
リクエストパラメータ内のパラメータ順序(authParams)に従ってハッシュ値を計算し、 リクエストパラメータ内の改竄チェック用ハッシュ値(vAuthInfo)と比較する。<br> リクエストパラメータにパラメータ順序と改竄チェック用ハッシュ値が含まれていない場合、 改竄されているとみなす。<br> <br>
public
static checkAuthHash(array<string|int, mixed> $request_params, string $merchant_cc_id, string $merchant_pw[, string $charset = null ]) : bool
Parameters
- $request_params : array<string|int, mixed>
-
リクエストパラメータ
- $merchant_cc_id : string
-
マーチャントCCID
- $merchant_pw : string
-
マーチャント認証鍵
- $charset : string = null
-
文字コード (この引数は互換性のために残されています。利用されません)
Return values
bool —一致 or false 不一致(改竄されている)
base64Dec()
Base64デコードを行う。
private
static base64Dec(array<string|int, mixed>|mixed|null $data) : false|string
Parameters
- $data : array<string|int, mixed>|mixed|null
-
デコードする文字列
Return values
false|string —createAuthHashInfo()
ハッシュ値を算出する。
private
static createAuthHashInfo(array<string|int, mixed> $request_params, array<string|int, mixed>|mixed|null $auth_params, string $merchant_cc_id, string $merchant_pw[, string $charset = null ]) : null|string
Parameters
- $request_params : array<string|int, mixed>
-
リクエストパラメータ
- $auth_params : array<string|int, mixed>|mixed|null
-
パラメータ順序
- $merchant_cc_id : string
-
マーチャントCCID
- $merchant_pw : string
-
マーチャント認証鍵
- $charset : string = null
-
文字コード (この引数は互換性のために残されています。利用されません)
Return values
null|string —ハッシュ値
getFirstValue()
指定した値に格納された先頭の値を取得する。<br> ・指定した値が配列の場合は、配列の先頭の値を取得する。<br> ・指定した値が配列ではない場合は、指定した値をそのまま返す。<br> ・指定した値が空配列である場合は、NULLを取得する。<br>
private
static getFirstValue(array<string|int, mixed>|mixed|null $value) : array<string|int, mixed>|mixed|null
Parameters
- $value : array<string|int, mixed>|mixed|null
-
配列もしくは値
Return values
array<string|int, mixed>|mixed|null —先頭の値