본문으로 건너뛰기

3) 보안문서 암호화

일반 문서를 보안 문서로 암호화​

API​

MethodURL
POST/api/encryption

Request Body​

NameRequiredTypeDescription
licenseKeyrequiredstringSHIELDRM 관리자 페이지의 연동 앱 관리 메뉴에서 발급 받은 라이선스 입력
encTyperequiredstring문서 타입
D : DAC 문서
M : MAC 문서
G : GRADE 문서
docListrequiredstringencType에 따라 적절한 권한 리스트 입력
D : SECURITYDOMAIN^111001100|USER01^011001100
M : 0000001
G : 0000001|RND1^110001111|dev04^010001111
※ G 및 D인 경우 아래의 "권한 문자열" 표를 참고하여 입력
srcFilePathrequiredstring원본 일반 문서 경로
srcFileNameoptionalstring보안문서 헤더에 저장될 원본 문서 이름
- 미사용 시 srcFilePath 의 파일명이 저장됨
dstFilePathrequiredstring암호화된 보안 문서 경로
algorithmoptionalstringAES / ARIA
기본값 : AES
sciServerIdoptional/requiredstring암호화 할 SCI 서버 아이디
- 멀티 SCI 서버 사용 시 필수
extraInfooptionalstringJSON 형식의 추가 정보 입력(아래의 extraInfo 데이터 설명표 및 샘플 데이터 참고)
extraInfo 데이터 설명표​
KeyRequiredTypeDescription
sourcerequiredjson
namerequiredstring호출 시스템 이름
fromrequiredstring호출 시스템 URL
userjson
idstring사용자 아이디
namestring사용자 이름
departstring사용자 전체 부서 (상위그룹/중위그룹/하위그룹)
dutystring사용자 직책 이름
docUidstring암호화 파일의 DOC_UID
parentUidstring부모 문서의 UID
branchUidstring현재 자신의 UID
  • 샘플 데이터
{
  "source": {
    "name": "EKMS",
    "from": "https://devekms.softcamp.co.kr"
  },
  "user": {
    "id": "ekmsTest@softcamp.co.kr",
    "name": "ekmsTest",
    "depart": "임직원/연구소/개발실/개발1팀",
    "duty": "과장"
  },
  "docUid": "77*9Sw5WOOq1hO*_vQ7vv70D77*9Oei_",
  "parentUid": "88*9Sw5WOOq1hO*_vQ7vv70D77*9Oei_",
  "branchUid": "99*9Sw5WOOq1hO*_vQ7vv70D77*9Oei_"
}
권한 문자열 : 문서 타입이 D 또는 G일때 포함되는 9자리 문자열 설명​
1열2열3열4열5열6열7열8열9열
키구분읽기 권한수정 권한복호화 권한외부전송권한프린트권한마킹유무자동파기권한변경
1 : 그룹
0 : 개인		1 : 권한있음
0 : 권한없음		1 : 권한있음
0 : 권한없음		1 : 권한있음
0 : 권한없음		1 : 권한있음
0 : 권한없음		1 : 권한있음
0 : 권한없음		1 : 마킹있음
0 : 마킹없음		4 : 유효기간
2 : 출력횟수
1 : 읽기횟수
0 : 영향없음		1 : 변경가능
0 : 변경못함
  • 예) 개인이고 읽기권한, 복호화 권한, 외부전송권한이 있고 나머지 권한은 없을 경우의 권한문자열 => "010110000"

Response​

NameTypeDescription
codeint0 : 성공
0 이외의 값 : 에러
messagestring"OK" : 성공
이외의 값 에러 메시지

Examples​

Request​

  • Body
[단일 서버]
{
  "licenseKey": "FEFF-0C448-B1D8-A1A9A",
  "encType": "D",
  "docList": "SECURITYDOMAIN^110001111",
  "srcFilePath" : "/opt/shieldrm/data/test.xlsx",
  "dstFilePath" : "/opt/shieldrm/dataout_test.xlsx",
  "extraInfo": "{\"source\":{\"name\":\"EKMS\",\"from\":\"https://devekms.softcamp.co.kr\"}}"
}

[멀티 서버]
{
  "sciServerId": "SCAM-ED72-262C-433A-0004",
  "licenseKey": "FEFF-0C448-B1D8-A1A9A",
  "encType": "D",
  "docList": "SECURITYDOMAIN^110001111",
  "srcFilePath" : "/opt/shieldrm/data/test.xlsx",
  "dstFilePath" : "/opt/shieldrm/dataout_test.xlsx",
  "extraInfo": "{\"source\":{\"name\":\"EKMS\",\"from\":\"https://devekms.softcamp.co.kr\"}}"
}

[헤더의 원본 문서 이름 변경 시]
{
  "sciServerId": "SCAM-ED72-262C-433A-0004",
  "licenseKey": "FEFF-0C448-B1D8-A1A9A",
  "encType": "D",
  "docList": "SECURITYDOMAIN^110001111",
  "srcFilePath" : "/opt/shieldrm/data/test.xlsx",
  "srcFileName" : "original.xlsx",
  "dstFilePath" : "/opt/shieldrm/dataout_test.xlsx",
  "extraInfo": "{\"source\":{\"name\":\"EKMS\",\"from\":\"https://devekms.softcamp.co.kr\"}}"
}

Response​

  • 성공
{
    "code": 0,
    "message" : "OK"
}
  • 실패
  • SDF 컨테이너 에러
  • Status code : 400 Bad Request
{
    "code": 40010,
    "message": "File is already encrypted."
}
  • SDF 컨테이너 모듈(SCSL) 에러
  • Status code : 500 INTERNAL_SERVER_ERROR
{
    "code": -61,
    "message" : "EXCEPTION error"
}
[토큰 검증 실패]
{
    "code": 50001,
    "message": "{\"code\":40101,\"message\":\"Invalid token\",\"detail\":\"invalid_token\"}"
}

[KMS 연결 실패]
{
    "code": 50001,
    "message": "An unexpected error has occurred in the internal system",
    "detail": "I/O error on GET request for \"https://devkms.softcamp.co.kr:8080/drm/7FDKQsEK-QVGKyXA2-fx1LxIzy-SNIre0s9/key/0000003\": Connect to devkms.softcamp.co.kr:8080 [devkms.softcamp.co.kr/10.14.10.171] failed: Connection timed out: connect; nested exception is org.apache.http.conn.HttpHostConnectException: Connect to devkms.softcamp.co.kr:8080 [devkms.softcamp.co.kr/10.14.10.171] failed: Connection timed out: connect"
}

[KMS 키조회 실패]
{
    "code": 40013,
    "message": "Key not found in the keyVault",
    "detail": "keyId : 0000011"
}
  • SKMS 모듈(SCKE) 에러
  • Status code : 500 INTERNAL_SERVER_ERROR
{
    "code": 40003,
    "message": "Failed create header",
    "detail": "4020"
}

API 내부에서 호출하는 SKMS API 및 SCSL 함수정리​

호출 순서API 및 함수명
1SKMS JWT 발급 API 호출 : /api/oauth/token
2SCSL 암호화 함수 호출 : CloudAPIEncrypt()
3헤더키 조회 API 호출 : /api/docu/headerKey
4SCSL 헤더정보 조회 함수 호출 : dsGetFullHeaderEx()
5통합로그 전송 API 호출 : /log/container-linker