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.gov-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": [
     ]
}