File Safer 개요

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

File Safer는 웹을 통해 제공되는 파일과 아웃링크의 악성 코드 포함 여부를 검사할 수 있도록 돕는 네이버 클라우드 플랫폼의 서비스입니다. Fail Safer 서비스에서는 Hash Filter, File Filter 기능에 대한 API를 RETSTful 형태로 제공합니다.

File Safer 공통 설정

File Safer API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

요청 API URL은 다음과 같습니다.

Hash Filter: https://filesafer.apigw.gov-ntruss.com/hashfilter/v1
File Filter: https://filesafer.apigw.gov-ntruss.com/filefilter/v1

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
x-ncp-apigw-timestamp Required 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간 (밀리초)
  • API Gateway 서버와 5분 이상 시간차 발생 시 유효하지 않은 요청으로 간주
    		•
    x-ncp-apigw-api-key Required 네이버 클라우드 플랫폼의 API Gateway에서 발급받은 API Key
    x-ncp-iam-access-key Required 네이버 클라우드 플랫폼에서 발급받은 Access Key
  • Access Key 발급 및 확인: 인증키 생성 참조
  • 서브 계정의 Access Key 발급 및 확인: 서브 계정 생성 참조
    		•
    x-ncp-apigw-signature-v2 Required 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명
  • Secret Key 발급 및 확인: 인증키 생성 참조
  • 서명 생성: 시그니처 생성 참조
    		•
    Accept Required 응답 데이터의 형식
  • application/json
    		•

    응답

    공통 응답 형식을 설명합니다.

    응답 상태 코드

    응답 상태 코드는 다음과 같습니다.

    HTTP 상태 코드 코드 메시지
    200 0 success
    200 140000 Unknown Error
    200 140001 Parameter is invalid
    200 140002 Not existent user
    200 140003 Already in use
    200 140004 Not allowed user
    200 140005 Not existing the required parameter
    200 140006 invalid request
    200 140007 file size exceeds the limit
    200 140009 Input file has a problem
    200 140010 Unzip failed
    400 100 Bad Request Exception
    401 200 Authentication Failed
    401 210 Permission Denied
    404 300 Not Found Exception
    429 400 Quota Exceeded
    429 410 Throttle Limited
    429 420 Rate Limited
    413 430 Request Entity Too Large
    503 500 Endpoint Error
    504 510 Endpoint Timeout
    500 900 Unexpected Error
    참고

    네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

    File Safer API

    File Safer 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.

    Hash Filter

    Hash Filter 관련 API는 다음과 같습니다.

    API 설명
    checkHash 파일 또는 URL 스트링의 악성 여부 확인
    getNotiConfig 분석 결과의 통보 설정 조회
    getThresholdNotiConfig 분석 결과의 통보 고급 설정 조회
    removeThresholdNotiConfig 분석 결과의 통보 고급 설정 삭제
    setNotiConfig 분석 결과의 통보 설정
    setThresholdNotiConfig 분석 결과의 통보 고급 설정

    File Filter

    File Filter 관련 API는 다음과 같습니다.

    API 설명
    getInputFileLog InputFile API로 전송한 파일의 분석 결과 조회
    getInputFileLogByParentHash InputFile API로 전송한 압축 파일 내 파일의 분석 결과 조회
    getNotiConfig 분석 결과의 통보 설정 조회
    getThresholdNotiConfig 분석 결과의 통보 고급 설정 조회
    InputFile File Filter로 분석할 파일 전송
    removeThresholdNotiConfig 분석 결과의 통보 고급 설정 삭제
    setNotiConfig 분석 결과의 통보 설정
    setThresholdNotiConfig 분석 결과의 통보 고급 설정

    File Safer 연관 리소스

    File Safer API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.