TGMDK_MerchantUtility
in package
マーチャント向けセキュリティ関連ユーティリティクラス
Tags
Table of Contents
- analyzeMerchantData() : array<string|int, mixed>|null
- マーチャントデータ(MD)の解析をする。
- checkMessage() : bool
- 署名を検証する。
- checkMessageBySecretKey() : bool
- 署名を検証する。
- createMerchantData() : string
- マーチャントデータ(MD)を生成する。
- getSecret() : bool|string
- Content-HMAC文字列からマーチャントシークレットを取得する。
- getTripartiteAuthHash() : string
- 3者間通信用にメッセージダイジェストを取得する
- sign() : string
- 引数文字列よりメッセージダイジェストを算出する。
- verifySign() : bool
- valueで指定された文字列からダイジェスト値を算出し、originalDigest値と比較する。
- calcHmac() : string
- Hmacのハッシュを求める。
- calcHmacBySecretKey() : string
- Hmacのハッシュを求める
- checkParametersEmpty() : bool
- 引数がすべてempty()でなければtrueを返す。1つでもemptyがあればfalseを返す。
Methods
analyzeMerchantData()
マーチャントデータ(MD)の解析をする。
public
static analyzeMerchantData(string $md) : array<string|int, mixed>|null
Parameters
- $md : string
-
マーチャントデータ
Tags
Return values
array<string|int, mixed>|null —マーチャントデータの元情報
ハッシュコードが一致しなかった場合はNULLを返す
checkMessage()
署名を検証する。
public
static checkMessage(string $msgBody, string $sContentHmac) : bool
Parameters
- $msgBody : string
-
署名の元となる文字列
- $sContentHmac : string
-
検証の対象となる署名文字列
Tags
Return values
bool —検証の対象となる署名文字列
checkMessageBySecretKey()
署名を検証する。
public
static checkMessageBySecretKey(string $secretKey, string $msgBody, string $sContentHmac) : bool
Parameters
- $secretKey : string
-
マーチャント認証鍵
- $msgBody : string
-
署名の元となる文字列
- $sContentHmac : string
-
検証の対象となる署名文字列
Tags
Return values
bool —createMerchantData()
マーチャントデータ(MD)を生成する。
public
static createMerchantData(array<string|int, mixed> $data) : string
Parameters
- $data : array<string|int, mixed>
-
マーチャントデータを生成するためにマーチャントが設定したデータ
Tags
Return values
string —マーチャントデータ
getSecret()
Content-HMAC文字列からマーチャントシークレットを取得する。
public
static getSecret(string $sContentHmac) : bool|string
Parameters
- $sContentHmac : string
-
検証の対象となる署名文字列
Tags
Return values
bool|string —マーチャントシークレット文字列
getTripartiteAuthHash()
3者間通信用にメッセージダイジェストを取得する
public
static getTripartiteAuthHash() : string
Tags
Return values
string —3者間通信用にメッセージダイジェスト
sign()
引数文字列よりメッセージダイジェストを算出する。
public
static sign(string $value, string $key) : string
Parameters
- $value : string
-
メッセージダイジェスト算出の対象となる文字列
- $key : string
-
メッセージダイジェスト算出キー
Tags
Return values
string —ダイジェスト値
verifySign()
valueで指定された文字列からダイジェスト値を算出し、originalDigest値と比較する。
public
static verifySign(string $value, string $key, string $originalDigest) : bool
Parameters
- $value : string
-
メッセージダイジェスト算出の基になる文字列
- $key : string
-
メッセージダイジェスト算出キー
- $originalDigest : string
-
事前に算出済のダイジェスト値
Tags
Return values
bool —true 一致 or false 不一致
calcHmac()
Hmacのハッシュを求める。
private
static calcHmac(string $msgBody) : string
Parameters
- $msgBody : string
Tags
Return values
string —求めたHmacハッシュ値
calcHmacBySecretKey()
Hmacのハッシュを求める
private
static calcHmacBySecretKey(string $secretKey, string $msgBody) : string
Parameters
- $secretKey : string
- $msgBody : string
Tags
Return values
string —求めたHmacハッシュ値
checkParametersEmpty()
引数がすべてempty()でなければtrueを返す。1つでもemptyがあればfalseを返す。
private
static checkParametersEmpty(string ...$parameters) : bool
Parameters
- $parameters : string