Verify

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

최대8 KB 크기로 서명된 데이터와 서명값을 비교하여 검증된 결과를 반환합니다. RSA2048 또는 ECDSA 키 타입으로만 요청할 수 있습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	API Gateway request signature v1: /keys/v1/{keyTag}/verify API Gateway request signature v2: /keys/v2/{keyTag}/verify

요청 헤더

Key Management Service API에서 공통으로 사용하는 헤더에 대한 정보는 Key Management Service 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`keyTag`	String	Required	키 태그 키 이름에서 파생된 키의 고유 식별자 콘솔의 키 상세 정보에서 확인 REST API로 암호화 또는 복호화 요청 시 사용 키 태그는 기밀 정보로 취급되지 않음

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`data`	String	Required	서명할 때 사용한 데이터를 Base64로 인코딩한 문자열 최대 8KB 입력 가능 Sign 요청의 `data`와 동일한 값 입력
`signature`	String	Required	비교할 서명값 Sign 응답의 `data.signature` 값을 그대로 입력 `ncpkms:v{키 버전}:{Base64로 인코딩된 서명값}` 형식 접두사를 제거한 서명값만 입력할 경우 검증 불가 서명할 때 사용한 키 버전으로 검증하며, 해당 키 버전이 비활성화된 경우 검증 불가

참고

Verify API는 서명할 때 사용한 파라미터로 검증하므로 서명 알고리즘 파라미터를 따로 지정하지 않아도 됩니다. 공개 키를 조회해 직접 검증할 때는 Sign의 서명 파라미터와 같은 값을 지정해 주십시오.

요청 예시

요청 예시는 다음과 같습니다.

API Gateway request signature v1 요청

curl --location --request POST 'https://kms.apigw.gov-ntruss.com/keys/v1/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/verify' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-api-key: {API Gateway API Key}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v1: {API Gateway Signature}' \
--data '{
  "data": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==",
  "signature": "ncpkms:v1:{BASE64_SIGNATURE}"
}'

API Gateway request signature v2 요청

curl --location --request POST 'https://kms.apigw.gov-ntruss.com/keys/v2/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/verify' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "data": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==",
  "signature": "ncpkms:v1:{BASE64_SIGNATURE}"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`code`	String	-	성공 여부
`msg`	String	-	응답 코드(`code`) 설명 요청 성공(`SUCCESS`) 시 빈 값(`""`)으로 표시
`data`	Object	-	응답 결과
`data.valid`	String	-	서명된 데이터와 서명값 일치 여부 `true` \| `false` `true`: 일치 `false`: 미일치

응답 상태 코드

Key Management Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Key Management Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": "SUCCESS",
    "msg": "",
    "data": {
        "valid": true
    }
}