GPKI 표준 API HTML 5 전환 삽질기

• 최근 Internet Explorer 11 기술 지원 종료 때문에 담당하던 프로젝트에서 Active X를 걷어내는 작업을 진행 중이다.
• 그 중에서도 GPKI 표준 API를 Active X → HTML 방식으로 전환하면서 겪은 삽질기를 공유해 보겠다.
• 나는 GPKI를 이용한 개발을 한 적이 없고 무수한 삽질을 하면서 전환 작업을 한 것일 뿐 GPKI에 대하여 아는 게 없기 때문에 질문에 답변할 수 없다는 점 미리 밝힌다.

개발 환경

• 참고로 내가 담당하는 프로젝트의 개발환경은 다음과 같다. 프로젝트가 오래된 만큼 사용 환경과 툴이 매우 구식이다. -_-
  • 개발 언어: Java 1.7, JSP
  • 개발 툴: 전자정부프레임워크가 세팅된 Eclipse
  • 서버: Tomcat 7.0

1. GPKI 표준 API 모듈 신청

• GPKI 표준 API 모듈이 있어야 개발이 가능한데 이 모듈 파일은 담당 공무원이 api.gpki.go.kr에 접속하여 서류 작성을 하고 신청을 해야 얻을 수 있다.
• 모듈 신청 완료 후 모듈 압축 파일을 담당 공무원으로부터 받을 수 있고 압축을 풀면 다음의 파일을 확인할 수 있다.
  • 표준API 보급관리시스템 설치가이드 V1.3(브라우저).pdf
    • 가이드 문서이다. 이걸 보면서 개발을 시작하면 된다.
  • gpkiapiJava_v1.5.1.0_Windows_x86_32bit.zip
    • 표준 API가 들어있는 압축 파일이다. 파일 이름에서 알 수 있듯이 32비트 버전이다.
  • gpkiapiJava_v1.5.1.0_Windows_x86_64bit.zip
    • 위와 동일하고 64비트 버전이다. 내가 운영 중인 서버는 64비트이므로 이 버전을 사용했다.
  • GPKISecureWeb_PACKAGE_1.2.0.0_20210917(UTF-8).zip
    • gpkisecureweb 또는 웹보안API라고 부르는 모듈이고 UTF-8 버전이다. 특별한 일이 없으면 이걸 쓰면 된다.
  • GPKISecureWeb_PACKAGE_1.2.0.0_20210917(EUC-KR).zip
    • 위와 동일한데 서버 인코딩을 EUC-KR로 사용하는 경우 이 버전을 쓰면 될 것으로 판단된다.
  • gpkiapi.lic
    • 임시 라이센스 파일이다.

2. 폴더 세팅

• api 폴더는 다음과 같이 세팅하였다.

  • D:\gpki\gpkiapi → GPKIAPI 폴더
  • D:\gpki\gpkisecureweb → gpkisecureweb 설정 폴더

• D:\gpki\gpkiapi 안에 gpkiapiJava_v1.5.1.0_Windows_x86_64bit.zip 파일의 압축을 풀어 넣었다.

• D:\gpki\gpkisecureweb 안에 GPKISecureWeb_PACKAGE_1.2.0.0_20210917(UTF-8).zip 파일의 압축을 풀어 넣어야 하는데 압축 파일 안을 보면 GPKISecureWeb_PACKAGE_1.2.0.0_20210917(UTF-8)\WEB-INF가 있고 이 안에 certs와 conf가 있다. 이것을 D:\gpki\gpkisecureweb 안에 넣어주면 된다.
• 굉장히 헷갈리게 압축 파일 안에 WEB-INF 폴더가 2개가 들어있다. -_-; conf 폴더 안에 dsjdf.properties 파일이 들어있어야 하므로 꼭 확인하자.
• 로그가 쌓일 폴더를 만들어 준다. → D:\gpki\gpkisecureweb\log
• D:\gpki\gpkisecureweb\conf 안에 gpkiapi.lic 라이센스 파일을 넣어준다.
• 전체 폴더 구조는 다음과 같다.

3. gpkisecureweb 설정 폴더의 properties 파일 세팅

• 메모장 등 에디터로 다음의 파일을 열고 수정을 한다.
  • D:\gpki\gpkisecureweb\conf\dsjdf.properties
  • D:\gpki\gpkisecureweb\conf\gpkisecureweb.properties
• 각 설정 파일에 경로가 D:/Projects/GPKI/GPKISecureWebHTML/WebContent 이런 식으로 세팅되어 있는데 자신의 환경에 맞게 경로를 변경하고 저장한다.
• 내 경우 설정 폴더의 경로는 드라이브명(C:나 D:)이 있는 경우 D:\gpki\gpkisecureweb로 수정하였고, 드라이브명이 없는 경우는 /gpkisecureweb으로 수정하였다.
• 경로에 / 기호와 \ 기호가 혼재되어 있는데 기호는 그대로 두고 경로명만 바꿔주면 된다.

4. 프로젝트에 gpkisecureweb 추가

• 이클립스를 열고 본인이 진행하는 프로젝트의 webapp 안에 gpkisecureweb을 추가하자.
• gpkisecureweb은 GPKISecureWeb_PACKAGE_1.2.0.0_20210917(UTF-8).zip 파일 안에 들어있고 가이드 문서에 의하면 gpkisecureweb\WEB-INF는 제외하라고 나와 있다.
• 프로젝트에 gpkisecureweb을 추가한 후 다음과 같이 확인할 수 있다.

5. gpkisecureweb 설정

• 다음 파일들을 열어 gpkisecureweb 폴더의 경로를 수정해준다.
• 내 경우 webapp 하위에 gpkisecureweb를 세팅해 두었으므로 절대경로인 /gpkisecureweb으로 수정해 주었다.
• 경로 외에 자신의 환경에 뭔가 세팅할 게 더 있다면 가이드 문서를 참고하여 수정한다.

  /gpkisecureweb/client/var.js → /gpkisecureweb 절대경로 수정
  /gpkisecureweb/GPKI_Config.js → 내 경우 세팅할 게 없음
  /gpkisecureweb/client/GPKIWeb/js/GPKIWeb_Config.js → /gpkisecureweb 절대경로 수정
  /gpkisecureweb/jsp/header.jsp → /gpkisecureweb 절대경로 수정
  /gpkisecureweb/client/GPKISecureWebNP2.js → /gpkisecureweb 절대경로 수정

6. 예제 파일 수정

• 예제 파일 /gpkisecureweb/jsp/createSecureSession_1_1.jsp의 내용을 보면 initSecureSession();라는 키보드 보안 관련 함수를 호출하는 부분이 있는데 실행해보면 이 부분에서 에러가 발생한다.
• 내 경우 키보드 보안을 사용하지 않기 때문에 해당 라인은 주석 처리하였다.

7. 예제 테스트

• 여기까지 세팅을 했다면 예제 웹페이지를 테스트 해 볼 수 있게 된다.
• 톰캣 서버를 기동시키고 웹브라우저를 열어 주소창에 http://localhost:포트번호/gpkisecureweb/index.html 입력을 해 본다.
• 사용자와 서버 인증서 인증 후 보안 세션 만들기 (인증서 로그인) → 선택하면 다음 화면으로 이동한다.
• Form 객체를 이용한 팝업 로그인 (Login) → 선택하면 파라미터 3개와 주민등록번호 입력폼, 공인인증서 선택창 버튼이 나타난다.
• 본인의 인증서를 하드에 설치한 후 공인인증서 로그인이 되는지 확인한다.
• 파라미터 3개는 아무거나 입력해도 된다.
• 정상적으로 로그인이 되면 다음과 같이 결과가 나타난다.

• 이제 예제를 참고하면서 본인의 프로젝트에 맞게 로그인 등 세팅 및 개발을 하면 된다.
• 참고로 공인인증서를 띄우는 함수는 Login(target, form, isEmbedded)이다. 사용법은 createSecureSession_1_1.jsp의 내용을 참고하면 된다.

참고 사항

공인인증서 선택창에서 비밀번호가 계속 틀렸다고 나오는 경우

• /gpkisecureweb/client/GPKIWeb/js/GPKIWeb_Config.js 파일을 열어보면 GPKIJS_LIC 라는 key가 보일 것이다. 이 key의 String 값이 "Ma2132AbaSdfiQxai..." 이런 식으로 긴 암호화 문자열로 되어 있는데, 라이센스 파일 gpkiapi.lic 파일을 메모장 등 에디터로 열고 내용을 복사한 후 붙여넣는다.
• [주의] 이 설정은 운영서버가 아닌 테스트 환경에서만 사용해야 한다. 개발이 끝나고 정식 라이센스를 받으면 gpkijs.lic 파일을 추가로 받는데 실제 운영 서버에는 이 파일의 내용을 붙여넣기 해야 한다.
• 가이드 문서에 라이센스에 대한 언급은 되어 있으나 이렇게 세팅해야 한다고 자세히 나와 있지 않아서 실제 세팅 방법을 알아내기 무척 어렵다. 제발 이런 건 좀 자세히 써주었으면... -_-

서버에서 인증서 검증에 실패하였습니다 → 에러가 발생하는 경우

• 인증서 선택창이 떠야 할 화면에서 다음과 같이 Server 단의 에러가 발생하는 경우 properties 파일을 수정해야 한다.

  com.gpki.secureweb.GPKISecureWEBException: CRL| 를 이용한 인증서 검증에 실패하였습니다.
    at com.gpki.servlet.GPKIHttpServletRequest.init(GPKIHttpServletRequest.java:475)
    at com.gpki.servlet.GPKIHttpServletRequest.<init>(GPKIHttpServletRequest.java:134)

• D:\gpki\gpkisecureweb\conf\gpkisecureweb.properties 파일을 열고 다음과 같이 NONE으로 수정한다.

  GPKISecureWeb.VerifyCertMethod = NONE

gpkiapi.dll 찾을 수 없다는 에러가 발생할 경우

• gpkiapiJava_v1.5.1.0_Windows_x86_64bit_20170501.zip 파일 내 lib64 폴더 안을 보면 gpkiapi.dll, LDAPSDK.DLL 2개의 파일이 있다.
• 이 파일들을 C:\Windows\System32에 복사하여 넣어주면 된다.
• 다른 OS의 경우 Path를 잡아주면 된다고 한다.

여담

• gpki 고객센터에 전화 문의하라고 되어 있는데 문의할 게 있어서 전화해도 연결이 안 된다. -_- 어쩔 수 없이 무한 삽질을 할 수 밖에 없었다.
• 관련 문의가 꽤 많을 것 같은데 공개 게시판 같은 거라도 운영하면 검색으로 확인할 수 있는 것들이 꽤 많을텐데 왜 안 하는지 모르겠다.

Atom

오픈소스 에디터 이 한 마디로 모든 설명이 끝난다. 조금 쓸만한 에디터라고 하면 상용 에디터일 경우가 많고, 대부분 직장인인 개발자들은 이러한 경우 회사에서 지원하지 않으면 사용하기 어려운 부분이 있다. 아톰 에디터는 오픈소스이기 때문에 어디서든 마음껏 사용할 수 있다. 게다가 오픈소스를 사랑하는 개발자들의 지원으로 수많은 플러그인을 통해 에디터 자체의 기능을 무한대로 확장해 쓸 수 있다. 예를 들어, 글쓰기를 좋아하는 블로거라면 마크다운 플러그인으로 블로그용 글을 작성하거나 이미 작성한 글을 pdf로 변환해 볼 수도 있다.

또한 멀티 플랫폼이라 macOS, Windows, Linux에서 모두 사용할 수 있다. 플러그인을 이용하면 세팅한 환경을 모든 플랫폼에서 동기화하여 사용할 수도 있다.

단 하나 아쉬운 단점이 있는데, 에디터 치고는 무겁다는 점이다. 그래도 꾸준한 업데이트를 통해 계속 보완이 되고 있는 점은 다행이다. 사실 아톰의 초기 버전은 실사용하기에는 좀 어려울 정도였다. ;)

웹사이트: Atom

Sublime Text

아톰 에디터 이전 에디터계를 평정(?)할 뻔한 툴이다. 사실 아톰 에디터가 이 에디터를 참고해서 만든 것이 아닌가 싶을 정도로, 두 에디터는 서로 닮았다. 예를 들어 아톰 에디터의 플러그인에 대응하는 것이 패키지라는 것인데, 이것으로 본체의 기능을 확장해 쓸 수 있다. 또한 아톰과 마찬가지로 다양한 플랫폼을 지원한다.

그리고 아톰과는 달리 매우 가볍고 빠르다. 내 경우 빠르게 무언가를 작성해야 할 일이 있다면 서브라임을 바로 열어 쓴다.

단점은 역시 상용 툴이라는 점이다. 그렇지만 구입하지 않아도 Unregisted 마크가 찍히는 것 외에 기능상의 제한은 없기 때문에 집에서 혼자 사용하는 것이라면 부담없이 쓸 수 있다.

웹사이트: Sublime Text

Evernote

에버노트는 마치 아이폰의 메모와 비슷하면서도 분류, 태그, 검색 등 기능적인 면에서는 더 파워풀한 툴이다. 노트 클라우드 서비스이기 때문에 멀티 플랫폼이 기본이다. 그리고 웹의 내용을 그대로 긁어오는 클리핑 기능은 이 분야에서 최고이다. 어떠한 내용도 즉각 작성하여 PC나 핸드폰을 통해 볼 수 있고, 다이어리, 작업일지, 할일 관리 등 못하는 게 없다. 이러한 특성 때문에 활용성만큼은 무궁무진하다. 내 경우, 그 동안은 블로그를 통해 정보 공유를 했었는데, 이제는 에버노트만 쓴다. 만약 공유할 내용이 있다면 '공유' 버튼을 한 번 눌러주면 끝이다.

에버노트의 단점은 무료 유저의 경우 용량 및 기기수 제한이 있다는 것이다. 그렇지만 아예 못 쓸 정도는 아니고, 텍스트 자료 위주로 쓴다면 무료 기능만으로도 충분하다.

웹사이트: Evernote

각각의 툴에 대한 보다 자세한 내용은 웹사이트나 블로그 등을 참고하면 좋을 것이다.