PrivateCA 개요
- 인쇄
- PDF
PrivateCA 개요
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
Private CA는 표준에 기반한 사설 인증 기관(Certificate Authority, CA)의 구축과 운영을 지원하며 안전하게 사설 인증서를 발급하고 관리, 폐기하는 기능을 제공하는 네이버 클라우드 플랫폼의 서비스입니다. Private CA 서비스에서는 사설 인증 기관(CA) 운영, 사설 인증서 발급 및 관리 기능에 대한 API를 RESTful 형태로 제공합니다.
Private CA 공통 설정
Private CA API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.
요청
공통 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
https://pca.apigw.ntruss.com/api/v1
요청 헤더
헤더에 대한 설명은 다음과 같습니다.
| 필드 | 필수 여부 | 설명 |
|---|---|---|
x-ncp-apigw-timestamp | Required | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간 (밀리초) |
x-ncp-iam-access-key | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key |
x-ncp-apigw-signature-v2 | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 |
Content-type | Required | 요청 데이터의 형식application/json |
응답
공통 응답 형식을 설명합니다.
응답 상태 코드
응답 상태 코드에 대한 설명은 다음과 같습니다.
| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
|---|---|---|---|
| 400 | - | 잘못된 요청입니다. | 요청 구문 오류 |
| 400 | - | ncloudInstanceNo 이(가) 누락되었습니다. | ncloudInstanceNo 값이 입력되지 않음 |
| 400 | - | tenant id 이(가) 누락되었습니다. | tenant id가 입력되지 않음 |
| 400 | - | idNo 이(가) 누락되었습니다. | idNo 값이 입력되지 않음 |
| 400 | - | alias 이(가) 누락되었습니다. | alias 값이 입력되지 않음 |
| 400 | - | common name 이(가) 누락되었습니다. | x509Parameters.commonName 값이 입력되지 않음 |
| 400 | - | x509Parameters 이(가) 누락되었습니다. | 고급 설정 정보(x509Parameters)가 입력되지 않음 |
| 400 | - | csr 이(가) 누락되었습니다. | csrPem 값이 입력되지 않음 |
| 400 | - | cert 이(가) 누락되었습니다. | certPem 값이 입력되지 않음 |
| 400 | - | status 이(가) 누락되었습니다. | status 값이 입력되지 않음 |
| 400 | - | caId 이(가) 누락되었습니다. | caId 값이 입력되지 않음 |
| 400 | - | serial no 이(가) 누락되었습니다. | serialNo 값이 입력되지 않음 |
| 400 | - | token 이(가) 누락되었습니다. | 토큰 값이 입력되지 않음 |
| 400 | - | ca type 이(가) 누락되었습니다. | caType 값이 입력되지 않음 |
| 400 | - | key bits 이(가) 누락되었습니다. | Key Bits 값이 입력되지 않음 |
| 400 | - | request body 이(가) 누락되었습니다. | 요청 바디가 입력되지 않음 |
| 400 | - | caTag 이(가) 누락되었습니다. | caTag 값이 입력되지 않음 |
| 400 | - | caId 혹은 caTag 이(가) 누락되었습니다. | caId 또는 caTag 값이 입력되지 않음 |
| 400 | - | chain 이(가) 누락되었습니다. | caChain 값이 입력되지 않음 |
| 400 | - | expiry 이(가) 누락되었습니다. | expiry 값이 입력되지 않음 |
| 400 | - | ocsp_servers 이(가) 누락되었습니다. | ocsp_servers 값이 입력되지 않음 |
| 400 | - | 잘못된 입력입니다. | 잘못된 요청 입력 |
| 400 | - | certificate 값이 올바르지 않습니다. | 입력된 certificate 값이 올바르지 않음 |
| 400 | - | status 값이 올바르지 않습니다. | 입력된 status 값이 올바르지 않음 |
| 400 | - | period 값이 올바르지 않습니다. | 입력된 period 값이 올바르지 않음 |
| 400 | - | page no 값이 올바르지 않습니다. | 입력된 pageNo 값이 올바르지 않음 |
| 400 | - | serial no 값이 올바르지 않습니다. | 입력된 serialNo 값이 올바르지 않음 |
| 400 | - | ca alias 이(가) 허용 길이를 초과했습니다. | 입력된 alias 값이 허용 길이를 초과 |
| 400 | - | memo 이(가) 허용 길이를 초과했습니다. | 입력된 description 값이 허용 길이를 초과 |
| 400 | - | common name 이(가) 허용 길이를 초과했습니다. | 입력된 x509Parameters.commonName 값이 허용 길이를 초과 |
| 400 | - | organization 이(가) 허용 길이를 초과했습니다. | 입력된 x509Parameters.organization 값이 허용된 길이를 초과 |
| 400 | - | organization unit 이(가) 허용 길이를 초과했습니다. | 입력된 x509Parameters.organicationUnit 값이 허용 길이를 초과 |
| 400 | - | state province 이(가) 허용 길이를 초과했습니다. | 입력된 x509Parameters.stateProvince 값이 허용 길이를 초과 |
| 400 | - | locality 이(가) 허용 길이를 초과했습니다. | 입력된 x509Parameters.locality 값이 허용 길이를 초과 |
| 400 | - | street address 이(가) 허용 길이를 초과했습니다. | 입력된 x509Parameters.streetAddress 값이 허용 길이를 초과 |
| 400 | - | 지원하지 않는 keyBits 입니다. | 유효하지 않은 Key Bits 입력 |
| 400 | - | 올바르지 않은 keyType 입니다. | 입력된 keyType 값이 올바르지 않음 |
| 400 | - | 올바르지 않은 caId 입니다. | 입력된 caId 값이 올바르지 않음 |
| 400 | - | 올바르지 않은 csr 입니다. | 입력된 csrPem 값이 올바르지 않음 |
| 400 | - | tenant id 이(가) 올바르지 않습니다. | 입력된 tenant id가 올바르지 않음 |
| 400 | - | id no 이(가) 올바르지 않습니다. | 입력된 idNo 값이 올바르지 않음 |
| 400 | - | user 이(가) 올바르지 않습니다. | 입력된 user가 올바르지 않음 |
| 400 | - | key type 이(가) 올바르지 않습니다. | 입력된 키 타입이 올바르지 않음 |
| 400 | - | ip 이(가) 올바르지 않습니다. | 입력된 x509Parameters.ip 값이 올바르지 않음 |
| 400 | - | uri 이(가) 올바르지 않습니다. | 입력된 URI가 올바르지 않음 |
| 400 | - | other 이(가) 올바르지 않습니다. | 입력된 other가 올바르지 않음 |
| 400 | - | 인증서 검증에 실패했습니다. ca chain 이(가) 유효하지 않습니다. | 입력된 caChain 값이 올바르지 않음 |
| 400 | - | CA 인증서는 폐기할 수 없습니다. | 잘못된 폐기 요청 |
| 400 | - | CSR 의 keyBits 와(과) 요청바디의 keyBits 이(가) 일치하지 않습니다. | CSR의 Key Bits와 요청 바디의 Key Bits가 일치하지 않음 |
| 400 | - | CSR 의 keyType 와(과) 요청바디의 keyType 이(가) 일치하지 않습니다. | CSR의 키 타입과 요청 바디에 입력된 키 타입이 일치하지 않음 |
| 400 | - | 잘못된 상태입니다. | 유효하지 않은 상태 |
| 400 | - | 잘못된 castore 입니다. | 유효하지 않은 castore |
| 400 | - | ca 상태가 올바르지 않습니다. | 유효하지 않은 CA 상태 |
| 400 | - | issuer ca 상태가 올바르지 않습니다. | 유효하지 않은 issuer ca 상태 |
| 400 | - | 잘못된 ca 입니다. | 유효하지 않은 CA |
| 400 | - | ca type 이(가) 올바르지 않습니다. | 입력된 caType 값이 올바르지 않음 |
| 400 | - | cert 이(가) 올바르지 않습니다. | 입력된 cert 값이 올바르지 않음 |
| 400 | - | 최대 발급 가능수를 초과했습니다. 인증서 발급은 30,000을 초과할 수 없습니다. 추가 발급이 필요한 경우에는 고객센터에 문의하세요. | 발급 가능한 인증서 수 초과 |
| 400 | - | ca 유효 기간을 초과할 수 없습니다. | CSR의 유효 기간이 CA의 유효 기간을 초과 |
| 400 | - | 최대 생성 가능한 ca 수를 초과했습니다. 루트/중간 ca는 10개까지 생성 가능합니다. | 생성 가능한 CA 수 초과 |
| 400 | - | 이미 존재하는 castore 입니다. | 사용 중인 castore가 입력됨 |
| 400 | - | 이미 존재하는 alias 입니다. | 사용 중인 CA 이름이 입력됨 |
| 400 | - | 이미 존재하는 policy 입니다. | 사용 중인 policy가 입력됨 |
| 400 | - | 이미 만료된 cert 입니다. | 만료된 인증서 정보가 입력됨 |
| 400 | - | castore 이(가) 존재하지 않습니다. | 존재하지 않는 castore 입력 |
| 400 | - | policy 이(가) 존재하지 않습니다. | 존재하지 않는 policy 입력 |
| 400 | - | crl configuration 이(가) 존재하지 않습니다. | CRL 업데이트 주기가 설정되지 않음 |
| 400 | - | CA 이(가) 존재하지 않습니다. | 존재하지 않는 CA 입력 |
| 400 | - | 인증서 이(가) 존재하지 않습니다. | 존재하지 않는 인증서 입력 |
| 500 | - | 불편을 드려 죄송합니다. 일시적으로 사용이 원활하지 않습니다. 오류가 계속될 경우 고객센터에 문의하세요. | 서비스 오류 |
참고
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.
Private CA API
Private CA 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| Activate Sub CA | 중간 CA 활성화 |
| Add CA User | 서브 계정에 CA 사용 권한 부여 |
| Create CA | CA 생성 |
| Create OCSP | OCSP URL을 사설 인증서에 배포 |
| Delete CA | CA 삭제 |
| Delete CA User | 서브 계정에 부여된 CA 사용 권한 회수 |
| Delete OCSP | 사설 인증서에서 OCSP URL 제거 |
| Get CA | CA의 상세 정보 조회 |
| Get CA Chain | CA 체인 정보 조회 |
| Get CA CRL | CA CRL 조회 |
| Get CA List | CA의 전체 목록 조회 |
| Get CA User List | CA 사용 권한을 가진 서브 계정 전체 목록 조회 |
| Get CRL Config | CA CRL의 업데이트 주기 조회 |
| Get End Cert | 사설 인증서의 상세 정보 조회 |
| Get End Cert List | 사설 인증서의 전체 목록 조회 |
| Get Sub CSR | 중간 CA의 CSR 조회 |
| Issue End Cert | 사설 인증서 발급 |
| Revoke End Cert | 사설 인증서 폐기 |
| Rotate CRL | CRL 수동 회전으로 갱신 |
| Sign End Csr | CSR로 새 인증서 서명 |
| Sign Sub Csr | 중간 CA 인증서 발급 |
| Trim CA | 만료된 인증서를 삭제하여 CRL 정리 |
| Update CA | CA 상태 변경 |
| Update CRL Config | CA CRL의 업데이트 주기 설정 |
Private CA 연관 리소스
Private CA API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.
- Private CA API 사용 방법
- Sub Account 사용 가이드: 네이버 클라우드 플랫폼에서 발급받은 서브 계정의 Access Key 발급 및 확인 방법
- 서명(시그니처) 생성: 요청 헤더에 필요한 서명 생성 방법
- Ncloud 공통 응답 상태 코드: Private CA 서비스에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보
- Private CA 서비스 사용 방법
- Private CA 사용 가이드: 네이버 클라우드 플랫폼 콘솔에서 Private CA 사용하는 방법
- Ncloud 사용 환경 가이드: VPC, Classic 환경 및 지원 여부에 대한 가이드
- 요금 소개, 특징, 상세 기능: Private CA의 요금 체계, 특징, 상세 기능 요약
- 서비스 최신 소식: Private CA 관련 최신 소식
- 자주 하는 질문: Private CA 사용자들이 자주 하는 질문
- 문의하기: 사용 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의
이 문서가 도움이 되었습니까?