코드가 제공하는 암/복호화 모듈 사이퍼(Cipher)에 대한 설명입니다.

CODE-Cipher 는 암호화/복호화/시그니처 모듈입니다. CODE 트래블룰 연동을 더욱 편리하게 할 수 있도록 제공 되고 있습니다. Cipher를 사용하시면 직접 시그니처를 생성하지 않으셔도 되기 때문에 편리하게 개발을 하실 수 있습니다.

Code-Cipher 서버는 암호화/복호화를 직접 구현하지 않고 사용하실 수 있는 모듈로 회원사 인프라에 구축하셔서 사용하시면 됩니다. 이 모듈을 통해 CODE 트래블룰 연동을 더욱 간단히 하실 수 있습니다. 이 모듈은 CODE 서버로 데이터를 전송하거나 데이터를 저장하지 않습니다. 오로지 CODE 프로토콜에 대한 데이터 가공 작업(시그니처 생성, 데이터 암호화 등)만 수행합니다. 이 모듈은 내부 네트워크에서 실행할 수 있으며 귀사의 인프라 구성에 맞게 원하는 대로 격리할 수 있습니다.

시스템 요구사항

  • CPU: 1vCPU, 2vCPU recommended
  • Memory: Minimum 2G, 4G recommended
  • Storage: Minimum 8G, 16G recommended

CODE-Cipher 실행 방법

1. 패스워드 저장 파일 생성

vim code_cipher_password

2. 패스워드 저장 파일에 패스워드 입력

패스워드는 CODE로 부터 대시보드 로그인을 위해 제공 받은 패스워드를 사용하시면 됩니다. (<https://alliances.codevasp.com/ko/login>)

3. 도커 환경변수 파일 생성

파일명은 무관합니다(5번 도커 실행의 env-file에 입력). e.g. local_env

;Code-Cipher
PORT=enter port for the Cipher should be using

;Keys
CODE_ALLIANCE_PRIVATE_KEY=Private key you created to integrate CODE

4. 도커 리포지토리 로그인

ID는 대시보드 로그인을 위해 제공받으신 아이디를 사용하시면 됩니다.

docker login -u <<your id>> --password-stdin aej6xvrqt6.execute-api.ap-northeast-2.amazonaws.com < <<your password location>>

예)
docker login -u code-cipher --password-stdin aej6xvrqt6.execute-api.ap-northeast-2.amazonaws.com < ./code_cipher_password

5. 도커 실행

docker run -d -p <<port>>:<<port>> --env-file=<<your env file location>> --name=code-cipher aej6xvrqt6.execute-api.ap-northeast-2.amazonaws.com/code-cipher:latest

예)
docker run -d -p 8787:8787 --env-file=./local_env --name=code-cipher aej6xvrqt6.execute-api.ap-northeast-2.amazonaws.com/code-cipher:latest

6. 필요 시 로그아웃

docker logout aej6xvrqt6.execute-api.ap-northeast-2.amazonaws.com

Swagger

다음 URL에서 Swagger를 열어 API 정의를 볼 수 있습니다. your-host:port/swagger-ui/index.html.

Prometheus

Prometheus 를 통해 서버의 모니터링이 가능합니다. your-host:port/actuator/prometheus.