checkHash (Hash Filter)

개요

  • chechHash API 는 “File Safer”의 “Hash Filter”에서 제공하는 기능으로 Hash 값을 이용하여 악성여부를 확인하는 API입니다.
  • 해당 API는 네이버 클라우드 플랫폼에서 사용하는 IAM인증 및 API Gateway를 통해 사용하실 수 있습니다.

요청

Method Request URI
GET https://filesafer.apigw.ntruss.com/hashfilter/v1/checkHash

요청 헤더

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것입니다.
API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-apigw-api-key API Gateway에서 발급받은 키
x-ncp-iam-access-key 네이버 클라우드 플랫폼에서 발급받은 API Key 또는 IAM에서 발급받은 AccessKey
x-ncp-apigw-signature-v2 요청 경로 및 헤더를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명으로
HMAC 암호화 알고리즘은 HmacSHA256 사용

IAM 인증이 필요한 API 호출하기를 참조 합니다.
accept json을 명시 합니다.
application/json

요청 파라미터

파라미터명 필수 여부 타입 설명
hashCode Yes string 조회 하려는 Hash 값입니다.
hashType Yes string 조회 하려는 Hash를 추출한 알고리즘 구분 값으로 md5, sha1을 지원합니다.
sha1 or md5

응답

응답 바디

필드명 필수 여부 타입 설명
returnCode Yes string 요청에 대한 처리 결과 코드입니다.
returnMessage Yes string 요청에 대한 처리 결과 메시지입니다.
totalRows Yes int hashCheckResultList의 object 개수입니다.
hashCheckResultList Yes int 질의한 Hash에 해당하는 탐지건에 대한 정보입니다.
리스트에 object가 있을 경우: 악성코드
리스트에 object가 없을 경우: 정상
hashType No string 악성코드로 탐지된 경우에만 포함됩니다
hashcode의 알고리즘 구분이며 MD5, SHA-1을 지원 합니다.
hashCode No string 악성코드로 탐지된 경우에만 포함됩니다
탐지된 Hash 값입니다.
group No String 악성코드로 탐지된 경우에만 포함됩니다
탐지된 Hash 값이 File object의 값인 경우 ‘file’로 표기되며, URL의 스트링인 경우에는 ‘url’로 표기 됩니다.
result No string 악성코드로 탐지된 경우에만 포함됩니다
질의한 Hash가 탐지된 경우에는 “1” 탐지되지 않은 경우에는 “0”의 값을 가집니다.
regDatetime No long 악성코드로 탐지된 경우에만 포함됩니다
Hash 값이 등록된 시간입니다.

예시

요청 예시

curl -X GET "https://filesafer.apigw.ntruss.com/hashfilter/v1/checkHash?hashCode=f093e7767bb63ac973b697d3fd1d40a78b87b8bf&hashType=sha1"
   -H "accept: application/json"
   -H "x-ncp-apigw-api-key: {x-ncp-apigw-api-key}"
   -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
   -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
   -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"

응답 예시 (악성코드로 탐지된 경우)

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

응답 예시 (악성코드로 탐지되지 않은 경우)

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

연관 오퍼레이션