checkHash

Classic/VPC環境で利用できます。

Hash値を利用して、ファイルまたは URLストリングが悪性かどうかを Hash Filterを通じて確認します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/checkHash

リクエストヘッダ

File Safer APIで共通して使用されるヘッダの詳細は、File Safer APIの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`hashCode`	String	Required	照会対象の Hash
`hashType`	String	Required	照会対象の Hashの作成に使用したアルゴリズム `sha1` \| `md5`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://filesafer.apigw.ntruss.com/hashfilter/v1/checkHash
?hashCode=f093e7767bb63ac973b697d3fd1d40a78b87b8bf
&hashType=sha1' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-api-key: {API Gateway API Key}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`returnCode`	String	Required	リクエストの処理結果コード
`returnMessage`	String	Required	リクエストの処理結果メッセージ
`totalRows`	Integer	Required	`hashCheckResultList`のオブジェクト数
`hashCheckResultList[]`	Array	Required	照会した Hashの検出結果リストにオブジェクトがある場合: マルウェアリストにオブジェクトがない場合: 正常
`hashCheckResultList[].hashType`	String	Conditional	`hashCode`の作成に使用されたアルゴリズム `sha1` \| `md5` マルウェアとして検出された場合にのみ含む
`hashCheckResultList[].hashCode`	String	Conditional	マルウェアとして検出された Hash マルウェアとして検出された場合にのみ含む
`hashCheckResultList[].group`	String	Conditional	マルウェアとして検出された Hash値のタイプ `file` \| `url` `file`: Hash値がファイルオブジェクトの場合 `url`: Hash値が URLストリングの場合マルウェアとして検出された場合にのみ含む
`hashCheckResultList[].result`	String	Conditional	照会した Hashがマルウェアとして検出されたかどうか `1` `1`: マルウェアとして検出マルウェアとして検出された場合にのみ含む
`hashCheckResultList[].regDatetime`	Long	Conditional	Hashが登録された時間マルウェアとして検出された場合にのみ含む

レスポンスステータスコード

File Safer APIで共通して使用されるレスポンスステータスコードの詳細は、File Saferのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

マルウェアが検出された場合

マルウェアが検出された場合、レスポンスのサンプルコードは次の通りです。

{
     "returnCode": "0",
     "returnMessage": "success",
     "totalRows": 1,
     "hashCheckResultList": [
        {
            "hashType": "sha1",
            "hashCode": "f093e7767bb63ac973b697d3fd1d40a78b87b8bf",
            "group": "file",
            "result": "1",
            "regDatetime": 1497409737000
         }
     ]
}

マルウェアが検出されなかった場合

マルウェアが検出されなかった場合、レスポンスのサンプルコードは次の通りです。

{
     "returnCode": "0",
     "returnMessage": "success",
     "totalRows": 0,
     "hashCheckResultList": [
     ]
}