Security > Secure Key Manager > API v1.0 가이드

Secure Key Manager는 사용자 데이터에 접근할 수 있는 다양한 API를 제공합니다. 클라이언트는 키 저장소에 설정한 인증을 통과한 후 Secure Key Manager에 저장한 데이터를 사용할 수 있습니다.

기본 정보

EndPoint

https://api-keymanager.gov-nhncloudservice.com

API 목록

Method URI 설명
GET /keymanager/v1.0/appkey/{appkey}/confirm API를 호출한 클라이언트 정보를 제공합니다.
GET /keymanager/v1.0/appkey/{appkey}/secrets/{keyid} Secure Key Manager에 저장한 기밀 데이터를 조회합니다.
POST /keymanager/v1.0/appkey/{appkey}/symmetric-keys/{keyid}/encrypt Secure Key Manager에 저장한 대칭 키로 데이터를 암호화합니다.
POST /keymanager/v1.0/appkey/{appkey}/symmetric-keys/{keyid}/decrypt Secure Key Manager에 저장한 대칭 키로 데이터를 복호화합니다.
POST /keymanager/v1.0/appkey/{appkey}/symmetric-keys/{keyid}/create-local-key 클라이언트가 로컬 환경에서 데이터 암/복호화에 사용할 수 있는 ARIA-256 대칭 키를 생성합니다.
GET /keymanager/{v1.0|v1.1}/appkey/{appkey}/symmetric-keys/{keyid}/symmetric-key Secure Key Manager에 저장한 대칭 키를 조회합니다.
POST /keymanager/v1.0/appkey/{appkey}/asymmetric-keys/{keyid}/sign Secure Key Manager에 저장한 비대칭 키로 데이터를 서명합니다.
POST /keymanager/v1.0/appkey/{appkey}/asymmetric-keys/{keyid}/verify Secure Key Manager에 저장한 비대칭 키로 데이터와 서명을 검증합니다.
GET /keymanager/v1.0/appkey/{appkey}/asymmetric-keys/{keyid}/privateKey Secure Key Manager에 저장한 개인 키를 조회합니다.
GET /keymanager/v1.0/appkey/{appkey}/asymmetric-keys/{keyid}/publicKey Secure Key Manager에 저장한 공개 키를 조회합니다.

[API 요청의 HTTP 헤더]

Secure Key Manager의 MAC 주소 인증을 사용하려면 HTTP 헤더에 클라이언트 MAC 주소를 설정해서 요청해야 합니다.

X-TOAST-CLIENT-MAC-ADDR: {MAC 주소}

[API 요청의 경로 변수]

이름 타입 설명
appkey String 사용하려는 데이터를 저장하고 있는 NHN Cloud 프로젝트의 앱키
keyid String 사용하려는 데이터의 식별자

[API 응답의 데이터 공통 헤더]

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "body": {
        ...
    }
}
이름 타입 설명
resultCode Number API 호출 결과 코드값
resultMessage String API 호출 결과 메시지
isSuccessful Boolean API 호출 성공 여부

클라이언트 정보 조회

API를 호출한 클라이언트 정보를 조회할 때 사용합니다.

GET https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/confirm

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "clientIp": "0.0.0.0",
        "clientMacHeader": "00:00:00:00:00:00",
        "clientSentCerfificate": false
    }
}
이름 타입 설명
clientIp String API를 호출한 클라이언트의 IP 주소
clientMacHeader String API를 호출한 클라이언트의 MAC 주소 헤더값
clientSentCertificate Boolean API를 호출한 클라이언트가 인증서를 사용하고 있는지 여부

기밀 데이터

기밀 데이터 조회

Secure Key Manager에 저장한 기밀 데이터를 조회할 때 사용합니다.

GET https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/secrets/{keyid}

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "secret": "data"
    }
}
이름 타입 설명
secret String 기밀 데이터 조회 결과

대칭 키

대칭 키 암호화

Secure Key Manager에 생성한 대칭 키로 데이터를 암호화할 때 사용합니다. 사용자는 32KB 이하의 텍스트 데이터를 전달해서 Secure Key Manager에 저장한 대칭 키로 암호화할 수 있습니다.

POST https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/symmetric-keys/{keyid}/encrypt

[Request Body]

{
    "plaintext": "data"
}
이름 타입 설명
plaintext String 대칭 키로 암호화할 데이터

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "ciphertext": "AAAAABzGwQniNneKXmcOLhWnxEqC1rNY+UdVb3lyeX/4wSrP",
        "keyVersion": 1
    }
}
이름 타입 설명
ciphertext String 대칭 키로 데이터를 암호화한 결과
keyVersion Number API 요청 처리에 사용한 대칭 키 버전

대칭 키 복호화

Secure Key Manager에 생성한 대칭 키로 데이터를 복호화할 때 사용합니다. 사용자는 암호화된 텍스트를 전달해서 Secure Key Manager에 저장한 대칭 키로 복호화할 수 있습니다.

POST https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/symmetric-keys/{keyid}/decrypt

[Request Body]

{
    "ciphertext": "AAAAABzGwQniNneKXmcOLhWnxEqC1rNY+UdVb3lyeX/4wSrP"
}
이름 타입 설명
ciphertext String 대칭 키로 복호화할 데이터

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "plaintext": "data",
        "keyVersion": 1
    }
}
이름 타입 설명
plaintext String 대칭 키로 데이터를 복호화한 결과
keyVersion Number API 요청 처리에 사용한 대칭 키 버전

대칭 키로 암호화한 로컬 대칭 키 생성

클라이언트가 로컬 환경에서 사용할 수 있는 ARIA-256 대칭 키를 생성할 때 사용합니다. localKeyPlaintext는 생성한 대칭 키를 Base64 인코딩한 형태이며 Base64 디코딩 후 바로 사용할 수 있습니다. localKeyCiphertext는 생성한 대칭 키를 Secure Key Manager에 저장한 대칭 키로 암호화한 후 Base64 인코딩한 형태이며 스토리지에 저장할 때 사용합니다. 스토리지에 저장한 대칭 키는 복호화 API를 사용해서 복호화한 후 사용할 수 있습니다.

POST https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/symmetric-keys/{keyid}/create-local-key

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "localKeyPlaintext": "srV7MWkYIfYBknkASzwSEK1Z1y9Nx0f/RMZ3MSVIjm8=",
        "localKeyCiphertext": "v1s1WkiIj3KR+AafnupNv9xcX/JhL4GUzUr8mzLRpjbGuoAwU/GgboM/6QdRRY24",
        "keyVersion": 1
    }
}
이름 타입 설명
localKeyPlaintext String Base64 인코딩한 ARIA-256 대칭 키
localKeyCiphertext String Secure Key Manager에 저장한 대칭 키로 암호화한 후 Base64 인코딩한 ARIA-256 대칭 키
keyVersion Number API 요청 처리에 사용한 대칭 키 버전

대칭 키 조회

Secure Key Manager에 저장한 대칭 키(ARIA-256)를 조회할 수 있습니다.

v1.0

GET https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/symmetric-keys/{keyid}/symmetric-key

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "symmetricKey": "0x00, 0x20, 0x00, 0x41, 0x00, 0x20, 0x00, 0x73, 0x00, 0x69, 0x00, 0x6d, 0x00, 0x70, 0x00, 0x6c, 0x00, 0x65, 0x00, 0x20, 0x00, 0x4a, 0x00, 0x61, 0x00, 0x76, 0x00, 0x61, 0x00, 0x2e, 0x00, 0x20"
    }
}
이름 타입 설명
symmetricKey String 대칭 키 데이터(16진수 문자열 형태)

v1.1

GET https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.1/appkey/{appkey}/symmetric-keys/{keyid}/symmetric-key?keyVersion={keyVersion}

[Request Parameter]

이름 타입 설명
keyVersion Number 조회하려는 대칭 키 버전

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "symmetricKey": "0x00, 0x20, 0x00, 0x41, 0x00, 0x20, 0x00, 0x73, 0x00, 0x69, 0x00, 0x6d, 0x00, 0x70, 0x00, 0x6c, 0x00, 0x65, 0x00, 0x20, 0x00, 0x4a, 0x00, 0x61, 0x00, 0x76, 0x00, 0x61, 0x00, 0x2e, 0x00, 0x20",
        "keyVersion": 1
    }
}
이름 타입 설명
symmetricKey String 대칭 키 데이터(16진수 문자열 형태)
keyVersion Number API 요청 처리에 사용한 대칭 키 버전

비대칭 키

비대칭 키로 서명

Secure Key Manager에 생성한 비대칭 키로 데이터를 서명할 때 사용합니다. 사용자는 245 Byte 이하의 텍스트 데이터를 전달해서 Secure Key Manager에 저장한 비대칭 키로 서명할 수 있습니다.

POST https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/asymmetric-keys/{keyid}/sign

[Request Body]

{
    "plaintext": "data"
}
이름 타입 설명
plaintext String 비대칭 키로 서명할 데이터

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "signature": "AAAAAGI9zf831DX...",
        "keyVersion": 1
    }
}
이름 타입 설명
signature String 비대칭 키로 데이터를 서명한 서명값
keyVersion Number API 요청 처리에 사용한 비대칭 키 버전

비대칭 키로 데이터 검증

Secure Key Manager에 생성한 비대칭 키로 데이터를 검증할 때 사용합니다. 사용자는 데이터와 서명값을 전달해서 Secure Key Manager에 저장한 비대칭 키로 데이터가 위변조되지 않았음을 검증할 수 있습니다.

POST https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/asymmetric-keys/{keyid}/verify

[Request Body]

{
    "plaintext": "data",
    "signature": "AAAAAGI9zf831DX..."
}
이름 타입 설명
plaintext String 비대칭 키로 검증할 데이터
signature String 비대칭 키로 데이터를 서명한 서명값

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "result": true,
        "keyVersion": 1
    }
}
이름 타입 설명
result Boolean 비대칭 키로 데이터와 서명값을 검증한 결과
keyVersion Number API 요청 처리에 사용한 비대칭 키 버전

개인 키 조회

Secure Key Manager에 저장한 비대칭 키 중 개인 키를 조회할 수 있습니다.

GET https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/asymmetric-keys/{keyid}/privateKey?keyVersion={keyVersion}

[Request Parameter]

이름 타입 설명
keyVersion Number 조회하려는 비대칭 키 버전

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "keyType": "PrivateKey",
        "key": "0x30, 0x82, 0x04, 0xbe, 0x02, 0x01, 0x00, 0x30, 0x0d, 0x06, 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x01, 0x01, 0x01, 0x05, 0x00, 0x04, 0x82, 0x04, 0xa8, 0x30, 0x82, 0x04, 0xa4, 0x02, 0x01, 0x00, 0x02, 0x82, 0x01, 0x01, 0x00, 0x8b, 0x07, 0x8e, 0xda, 0xc7, 0x83, 0x95, 0xc8, 0x43, 0xa7, 0xb8, 0x31, 0x6f, 0xf6, 0x25, 0x36, 0x89, 0x64, 0xc5, 0x38, 0x75, 0x4b, 0xa6, 0x80, 0xfe, 0x7c, 0xc5, 0x6a, 0x94, 0xf2,
                ... 후략 ...",
        "encodedKey": "MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCLB47ax4OVyEOnuDFv9iU2iWTFOHVLpoD+fMVqlPJiiuJSwi5x/zd3LojWuUyr+dZ9Icxl23Alu4GwwKgUi4DL8qo8jD14THJoeUgIZ56wmYMvN+CkNnmkyqcGn6yT+AXtBJVGqS/2lssHLIGELi8XXkWdf6OBfig6HgsJAnix8Z+T/QdikEFUI5ZiuUWyHw2Bag9B4CoPF2EgXfu5HcW4GA4KH2PI92O4vNg8AmFVDk2E+ma2quSau7LjS3KY9s3Sq+JqvTPZmqHQJudv9ZYcnbyDG/
                       ... 후략 ...",
        "keyVersion": 0
    }
}
이름 타입 설명
keyType String 비대칭 키 형태
key String 개인 키 데이터(16진수 문자열 형태)
encodedKey String 개인 키 데이터(Base64 인코딩 형태)
keyVersion Number API 요청 처리에 사용한 비대칭 키 버전

공개 키 조회

Secure Key Manager에 저장한 비대칭 키 중 공개 키를 조회할 수 있습니다. 인증에 상관없이 조회할 수 있습니다.

GET https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/asymmetric-keys/{keyid}/publicKey?keyVersion={keyVersion}

[Request Parameter]

이름 타입 설명
keyVersion Number 조회하려는 비대칭 키 버전

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "keyType": "PublicKey",
        "key": "0x30, 0x82, 0x01, 0x22, 0x30, 0x0d, 0x06, 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x01, 0x01, 0x01, 0x05, 0x00, 0x03, 0x82, 0x01, 0x0f, 0x00, 0x30, 0x82, 0x01, 0x0a, 0x02, 0x82, 0x01, 0x01, 0x00, 0x8b, 0x07, 0x8e, 0xda, 0xc7, 0x83, 0x95, 0xc8, 0x43, 0xa7, 0xb8, 0x31, 0x6f, 0xf6, 0x25, 0x36, 0x89, 0x64, 0xc5, 0x38, 0x75, 0x4b, 0xa6, 0x80, 0xfe, 0x7c, 0xc5, 0x6a, 0x94, 0xf2, 0x62, 0x8a, 0xe2, 0x52, 0xc2,
                ... 후략 ...",
        "encodedKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAiweO2seDlchDp7gxb/YlNolkxTh1S6aA/nzFapTyYoriUsIucf83dy6I1rlMq/nWfSHMZdtwJbuBsMCoFIuAy/KqPIw9eExyaHlICGeesJmDLzfgpDZ5pMqnBp+sk/gF7QSVRqkv9pbLByyBhC4vF15FnX+jgX4oOh4LCQJ4sfGfk/0HYpBBVCOWYrlFsh8NgWoPQeAqDxdhIF37uR3FuBgOCh9jyPdjuLzYPAJhVQ5NhPpmtqrkmruy40tymPbN0qviar0z2Zqh0Cbnb/WWHJ28gxv+d+iJCXJvm+fIg7hRYJ5C+mun/N6FB8QHv/
                       ... 후략 ...",
        "keyVersion": 0
    }
}
이름 타입 설명
keyType String 비대칭 키 형태
key String 공개 키 데이터(16진수 문자열 형태)
encodedKey String 공개 키 데이터(Base64 인코딩 형태)
keyVersion Number API 요청 처리에 사용한 비대칭 키 버전

키 추가/삭제

키 추가

Secure Key Manager에 신규 키를 추가할 수 있습니다.

기밀 데이터 추가

POST https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/keys/secrets/create

[Http Header]

X-TC-AUTHENTICATION: {User Access Key ID}:{Secret Access Key}를 Base64 인코딩한 값

[Request Body]

{
    "keyStoreName" : "Store #1",
    "name" : "Key Sample #1",
    "description" : "Description #1",
    "secretValue" : "data"
}
이름 타입 설명
keyStoreName String 키를 저장할 키 저장소 이름
name String 키 이름
description String 키 설명
secretValue String 기밀 데이터 값

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "keyId": "071dcc5c25614dffa52357e5cae3471f",
        "keyStatus": "ACTIVE"
    }
}
이름 타입 설명
keyId String 생성된 키 ID
keyStatus String 키 상태 메시지

대칭 키 추가

POST https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/keys/symmetric-key/create

[Http Header]

X-TC-AUTHENTICATION: {User Access Key ID}:{Secret Access Key}를 Base64 인코딩한 값

[Request Body]

{
    "keyStoreName" : "Store #1",
    "name" : "Key Sample #2",
    "description" : "Description #2",
    "autoRotationPeriod" : 0
}
이름 타입 설명
keyStoreName String 키를 저장할 키 저장소 이름
name String 키 이름
description String 키 설명
autoRotationPeriod Integer 회전 주기

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "keyId": "c2c49d986dfb4ca6afeaf67c39354c12",
        "keyStatus": "ACTIVE"
    }
}
이름 타입 설명
keyId String 생성된 키 ID
keyStatus String 키 상태 메시지

비대칭 키 추가

POST https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/keys/asymmetric-key/create

[Http Header]

X-TC-AUTHENTICATION: {User Access Key ID}:{Secret Access Key}를 Base64 인코딩한 값

[Request Body]

{
    "keyStoreName" : "Store #1",
    "name" : "Key Sample #3",
    "description" : "Description #3",
    "autoRotationPeriod" : 0
}
이름 타입 설명
keyStoreName String 키를 저장할 키 저장소 이름
name String 키 이름
description String 키 설명
autoRotationPeriod Integer 회전 주기

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "keyId": "ddd7d5275dfa462799418062bd25b49d",
        "keyStatus": "ACTIVE"
    }
}
이름 타입 설명
keyId String 생성된 키 ID
keyStatus String 키 상태 메시지

키 삭제

Secure Key Manager에 저장된 키의 상태를 삭제 예정 상태로 변경하거나, 즉시 삭제할 수 있습니다.

키 삭제 요청

키를 삭제 예정 상태로 변경합니다. 키는 7일 후 자동으로 삭제되며, 삭제 예정 상태의 키는 조회할 수 없습니다.

PUT https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/keys/{keyid}/delete

[Http Header]

X-TC-AUTHENTICATION: {User Access Key ID}:{Secret Access Key}를 Base64 인코딩한 값

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "keyId": "071dcc5c25614dffa52357e5cae3471f",
        "deletionDateTime": "2023-11-20T22:00:00.00"
    }
}
이름 타입 설명
keyId String 생성된 키 ID
deletionDateTime String 키 삭제 예정일

키 즉시 삭제

즉시 삭제할 키의 상태는 삭제 예정 상태여야 합니다. 사용 중 상태인 키는 즉시 삭제할 수 없습니다.

DELETE https://api-keymanager.gov-nhncloudservice.com/keymanager/v1.0/appkey/{appkey}/keys/{keyid}

[Http Header]

X-TC-AUTHENTICATION: {User Access Key ID}:{Secret Access Key}를 Base64 인코딩한 값

[Response Body]

{
    "header": {
        ...
    },
    "body": {
        "keyId": "071dcc5c25614dffa52357e5cae3471f",
        "deletionDateTime": "2023-11-14T10:05:24.312"
    }
}
이름 타입 설명
keyId String 생성된 키 ID
deletionDateTime String 키 삭제 시각
목차
TOP