Menu

## TGMDK_MerchantUtility
in package

TGMDK_MerchantUtility.php : 15

マーチャント向けセキュリティ関連ユーティリティクラス

##### Tags

category

  Veritrans

copyright

  VeriTrans Inc.

access

  public

author

  VeriTrans Inc.

### Table of Contents

analyzeMerchantData() : array<string|int, mixed>|null
  マーチャントデータ（MD）の解析をする。
checkMessage() : bool
  署名を検証する。
checkMessageBySecretKey() : bool
  署名を検証する。
createMerchantData() : string
  マーチャントデータ（MD）を生成する。
getSecret() : bool|string
  Content-HMAC文字列からマーチャントシークレットを取得する。
getTripartiteAuthHash() : string
  ３者間通信用にメッセージダイジェストを取得する
sign() : string
  引数文字列よりメッセージダイジェストを算出する。
verifySign() : bool
  valueで指定された文字列からダイジェスト値を算出し、originalDigest値と比較する。
calcHmac() : string
  Hmacのハッシュを求める。
calcHmacBySecretKey() : string
  Hmacのハッシュを求める
checkParametersEmpty() : bool
  引数がすべてempty()でなければtrueを返す。1つでもemptyがあればfalseを返す。

### Methods

#### analyzeMerchantData()

TGMDK_MerchantUtility.php : 359

マーチャントデータ（MD）の解析をする。

`public static analyzeMerchantData(string $md) : array<string|int, mixed>|null`

##### Parameters

$md : string

  マーチャントデータ

##### Tags

throws
  TGMDK_Exception

##### Return values

array<string|int, mixed>|null —

マーチャントデータの元情報
ハッシュコードが一致しなかった場合はNULLを返す

#### checkMessage()

TGMDK_MerchantUtility.php : 90

署名を検証する。

`public static checkMessage(string $msgBody, string $sContentHmac) : bool`

##### Parameters

$msgBody : string

  署名の元となる文字列

$sContentHmac : string

  検証の対象となる署名文字列

##### Tags

throws
  TGMDK_Exception

##### Return values

bool —

検証の対象となる署名文字列

#### checkMessageBySecretKey()

TGMDK_MerchantUtility.php : 151

署名を検証する。

`public static checkMessageBySecretKey(string $secretKey, string $msgBody, string $sContentHmac) : bool`

##### Parameters

$secretKey : string

  マーチャント認証鍵

$msgBody : string

  署名の元となる文字列

$sContentHmac : string

  検証の対象となる署名文字列

##### Tags

throws
  TGMDK_Exception

##### Return values

bool —

#### createMerchantData()

TGMDK_MerchantUtility.php : 308

マーチャントデータ（MD）を生成する。

`public static createMerchantData(array<string|int, mixed> $data) : string`

##### Parameters

$data : array<string|int, mixed>

  マーチャントデータを生成するためにマーチャントが設定したデータ

##### Tags

throws
  TGMDK_Exception

##### Return values

string —

マーチャントデータ

#### getSecret()

TGMDK_MerchantUtility.php : 54

Content-HMAC文字列からマーチャントシークレットを取得する。

`public static getSecret(string $sContentHmac) : bool|string`

##### Parameters

$sContentHmac : string

  検証の対象となる署名文字列

##### Tags

access

  public

static

##### Return values

bool|string —

マーチャントシークレット文字列

#### getTripartiteAuthHash()

TGMDK_MerchantUtility.php : 22

３者間通信用にメッセージダイジェストを取得する

`public static getTripartiteAuthHash() : string`

##### Tags

throws
  TGMDK_Exception

##### Return values

string —

３者間通信用にメッセージダイジェスト

#### sign()

TGMDK_MerchantUtility.php : 256

引数文字列よりメッセージダイジェストを算出する。

`public static sign(string $value, string $key) : string`

##### Parameters

$value : string

  メッセージダイジェスト算出の対象となる文字列

$key : string

  メッセージダイジェスト算出キー

##### Tags

access

  public

static
throws
  TGMDK_Exception

##### Return values

string —

ダイジェスト値

#### verifySign()

TGMDK_MerchantUtility.php : 289

valueで指定された文字列からダイジェスト値を算出し、originalDigest値と比較する。

`public static verifySign(string $value, string $key, string $originalDigest) : bool`

##### Parameters

$value : string

  メッセージダイジェスト算出の基になる文字列

$key : string

  メッセージダイジェスト算出キー

$originalDigest : string

  事前に算出済のダイジェスト値

##### Tags

throws
  TGMDK_Exception

##### Return values

bool —

true 一致 or false 不一致

#### calcHmac()

TGMDK_MerchantUtility.php : 198

Hmacのハッシュを求める。

`private static calcHmac(string $msgBody) : string`

##### Parameters

$msgBody : string

##### Tags

access

  private

static
throws
  TGMDK_Exception

##### Return values

string —

求めたHmacハッシュ値

#### calcHmacBySecretKey()

TGMDK_MerchantUtility.php : 228

Hmacのハッシュを求める

`private static calcHmacBySecretKey(string $secretKey, string $msgBody) : string`

##### Parameters

$secretKey : string
$msgBody : string

##### Tags

access

  private

static
throws
  TGMDK_Exception

##### Return values

string —

求めたHmacハッシュ値

#### checkParametersEmpty()

TGMDK_MerchantUtility.php : 133

引数がすべてempty()でなければtrueを返す。1つでもemptyがあればfalseを返す。

`private static checkParametersEmpty(string ...$parameters) : bool`

##### Parameters

$parameters : string

##### Return values

bool —

## Search results