RSA 키 생성
코드 예제: auth-jwt-rs256
RSA(Rivest–Shamir–Adleman)는 안전한 데이터 전송, 디지털 서명 및 키 교환을 가능하게 하는 널리 사용되는 공개 키 암호화 시스템입니다.
RSA 암호화 알고리즘의 일부인 RS256은 해싱에 SHA-256을 사용하며, 키(주로 2048비트, 4096비트 이상)를 활용하여 디지털 통신을 보호합니다.
JSON Web Token 인증 영역에서 RS256은 결정적인 역할을 합니다. 공개 키/개인 키 쌍을 사용하는 RS256과 같은 서명 메커니즘을 통해 JWT의 무결성과 신뢰성을 검증할 수 있기 때문입니다. 이를 통해 토큰에 포함된 정보가 위변조되지 않고 신뢰할 수 있음을 보장합니다.
이 섹션에서는 이러한 키를 생성하고 Ktor에서 제공하는 Authentication JWT 플러그인과 함께 사용하는 방법을 배웁니다.
프로덕션 환경에서는 RSA에 비해 더 효율적이고 안전한 암호화 기술을 기반으로 하는 ES256과 같은 최신 대안을 선택하는 것이 좋습니다.
RSA 개인 키 생성
개인 키를 생성하려면 OpenSSL, ssh-keygen 또는 인증 키 쌍을 생성할 수 있는 원하는 다른 도구를 사용할 수 있습니다. 여기서는 데모를 위해 OpenSSL을 사용합니다.
새 터미널 창에서 다음 명령을 실행합니다:
openssl genpkey -algorithm rsa -pkeyopt rsa_keygen_bits:2048 > ktor.pk8openssl genpkey 명령은 RSA 알고리즘을 사용하여 2048비트 개인 키를 생성하고 지정된 파일(여기서는 ktor.pk8)에 저장합니다. 파일의 내용은 Base64로 인코딩되어 있으므로 공개 키를 도출하기 전에 디코딩해야 합니다.
코드 예제의 개인 키를 사용하려면, src/main/resources 내의 application.conf 파일로 이동하여 개인 키를 새 .pk8 파일로 추출하세요.
공개 키 도출
이전에 생성한 개인 키에서 공개 키를 도출하려면 다음 단계를 수행해야 합니다:
- 개인 키를 디코딩합니다.
- 공개 키를 추출합니다.
- 공개 키를 PEM 형식으로 저장합니다.
OpenSSL을 사용하여 이 작업을 수행하려면 다음 명령을 실행합니다:
openssl rsa -in ktor.pk8 -pubout | tee ktor.spkiopenssl rsa: RSA 키를 다루기 위한OpenSSL명령입니다. 이 맥락에서는 RSA 키와 관련된 작업을 수행하는 데 사용됩니다.-in ktor.pk8: OpenSSL이 RSA 개인 키를 읽어올 입력 파일(ktor.pk8)을 지정합니다.-pubout: 입력 파일에 제공된 개인 키에 해당하는 공개 키를 출력하도록 OpenSSL에 지시합니다.|: 파이프(|) 기호는 이전 명령의 출력(openssl rsa에 의해 생성된 공개 키)을 tee 명령으로 전달(리디렉션)하는 데 사용됩니다.tee ktor.spki:tee는 표준 입력에서 읽어 표준 출력과 하나 이상의 파일 모두에 쓰는 명령줄 유틸리티입니다. 명령의 이 부분은 받은 입력을ktor.spki라는 파일에 쓰도록 tee에 지시합니다. 따라서 공개 키가 터미널에 표시되는 동시에ktor.spki파일에도 저장됩니다.
공개 키가 준비되었으므로, 이제 지수(exponent)와 모듈러스(modulus) 값을 도출할 수 있습니다.
모듈러스 및 지수 속성 추출
이제 키 쌍이 준비되었으므로, jwks.json 파일에서 사용하기 위해 공개 키의 e(지수) 및 n(모듈러스) 속성을 추출해야 합니다. 이를 위해 다음 단계가 필요합니다:
- 생성한
.spki파일에서 공개 키를 읽습니다. - 사람이 읽을 수 있는 형식으로 키에 대한 정보를 표시합니다.
OpenSSL을 사용하여 이 작업을 수행하려면 다음 명령을 실행합니다:
openssl pkey -in ktor.spki -pubin -noout -textpkey: 개인 키와 공개 키를 처리하기 위한 OpenSSL 명령줄 유틸리티입니다.-in ktor.spki: PEM 형식의 공개 키가 포함된 입력 파일을 지정합니다. 이 경우 입력 파일은ktor.spki입니다.-pubin: 입력 파일에 공개 키가 포함되어 있음을 나타냅니다. 이 옵션이 없으면 OpenSSL은 입력 파일에 개인 키가 포함되어 있다고 간주합니다.-noout: OpenSSL이 인코딩된 공개 키를 출력하지 않도록 방지합니다. 이 명령은 공개 키에 대한 정보만 표시하며 실제 키는 콘솔에 출력되지 않습니다.-text: OpenSSL에 키의 텍스트 표현을 표시하도록 요청합니다. 여기에는 키 유형, 크기 및 사람이 읽을 수 있는 형식의 실제 키 데이터와 같은 세부 정보가 포함됩니다.
예상 출력은 다음과 같습니다:
$ openssl pkey -in ktor.spki -pubin -noout -text
RSA Public-Key: (512 bit)
Modulus:
00:b5:f2:5a:2e:bc:d7:20:b5:20:d5:4d:cd:d4:a5:
7c:c8:9a:fd:d8:61:e7:e4:eb:58:65:1e:ea:5a:4d:
4c:73:87:32:e0:91:a3:92:56:2e:a7:bc:1e:32:30:
43:f5:fd:db:05:5a:08:b2:25:15:5f:ac:4d:71:82:
2b:d0:87:b4:01
Exponent: 65537 (0x10001)이 예제에서 공개 키는 안전하지 않은 512비트를 사용하고 있습니다. 실제 환경에서는 2048비트 또는 4096비트 키를 선택해야 합니다.
모듈러스 및 지수 속성 변환 및 인코딩
이전 단계에서 jwks.json 파일에 필요한 n 및 e 속성을 추출했습니다. 하지만 이 값들은 16진수(hexadecimal) 형식입니다. 이제 지수와 모듈러스의 16진수 표현을 각각의 Base64URL 인코딩으로 변환해야 합니다.
지수(Exponent)
지수 속성의 16진수(HEX) 값은 0x10001입니다. 이 값을 Base64URL로 변환하려면 다음 명령을 사용합니다:
echo 010001 | xxd -p -r | base64echo 010001: 명령의 이 부분은echo명령을 사용하여 RSA 키의 공개 지수(e)를 나타내는 "010001" 문자열을 표준 출력으로 출력합니다.|:|문자는 이전 명령의 출력을 가져와 다음 명령의 입력으로 전달하는 파이프입니다.xxd -p -r: 16진수를 바이너리로 변환하는 데 사용되는 명령입니다. 16진수 입력을 받아 해당하는 바이너리 출력을 생성합니다.| base64: 명령의 이 부분은 이전 단계의 바이너리 출력을 가져와base64명령을 사용하여 Base64 형식으로 인코딩합니다.
왼쪽에 0을 추가하여 짝수 자리의 16진수 숫자를 사용했다는 점에 유의하세요.
앞서 언급한 지수 값에 대한 예상 출력은 다음과 같습니다:
$ echo 010001 | xxd -p -r | base64
AQAB지수의 Base64URL 인코딩된 값은 AQAB이며 이 경우에는 추가 처리가 필요하지 않습니다. 다른 경우에는 다음 단계에 표시된 것처럼 tr 명령을 사용해야 할 수 있습니다.
모듈러스(Modulus)
n 속성의 경우, tr 유틸리티를 사용하여 모듈러스의 16진수 표현을 추가로 처리합니다.
echo "b5:f2:5a:2e:bc:d7:20:b5:20:d5:4d:cd:d4:a5:
7c:c8:9a:fd:d8:61:e7:e4:eb:58:65:1e:ea:5a:4d:
4c:73:87:32:e0:91:a3:92:56:2e:a7:bc:1e:32:30:
43:f5:fd:db:05:5a:08:b2:25:15:5f:ac:4d:71:82:
2b:d0:87:b4:01" | tr -d ": \n" | xxd -p -r | base64 | tr +/ -_ | tr -d "=\n"맨 앞의 00 바이트가 생략되었음에 유의하세요. 모듈러스 맨 앞의 00 바이트는 RSA 공개 키의 ASN.1 인코딩과 관련이 있습니다. 정수의 ASN.1 DER 인코딩에서는 정수의 최상위 비트가 0이면 맨 앞의 0 바이트가 제거됩니다. 이는 ASN.1 인코딩 규칙의 표준 부분입니다. RSA 공개 키의 맥락에서 모듈러스는 빅 엔디언(big-endian) 정수이며, DER 인코딩으로 표현될 때 이러한 규칙을 따릅니다. 맨 앞의 0 바이트 제거는 DER 규칙에 따라 정수가 올바르게 해석되도록 하기 위함입니다.
echo "b5:f2:5a:2e:bc:d7:20:b5:20:d5:4d:cd:d4:a5: \ ... ": 명령의 이 부분은 일련의 바이트를 나타내는 여러 줄의 16진수 문자열을 출력합니다. 각 줄 끝의 백슬래시는 줄 바꿈을 나타냅니다.tr -d ": \n":tr명령은 인수 목록에 지정된 문자를 삭제하는 데 사용됩니다. 여기서는 16진수 문자열에서 콜론, 공백 및 줄 바꿈 문자를 제거하여 연속된 16진수 문자열로 만듭니다.xxd -p -r:xxd는 바이너리 파일의 헥스 덤프(hex dump)를 생성하거나 헥스 덤프를 다시 바이너리로 변환하는 유틸리티입니다.-p옵션은 줄 번호나 ASCII 문자 열이 없는 순수 헥스 덤프를 지정합니다.-r옵션은 작업을 역으로 수행하여 16진수를 다시 바이너리로 변환합니다.base64: 이전 단계의 바이너리 출력을 Base64 형식으로 인코딩합니다.tr +/ -_: Base64 출력의+및/문자를 각각-및_로 변환합니다. 이는 URL-safe Base64 인코딩을 위한 일반적인 변환입니다.tr -d "=\n": 최종 Base64 인코딩 문자열에서 등호(=)와 줄 바꿈 문자를 제거합니다.
위 명령의 출력은 다음과 같습니다:
$ echo "b5:f2:5a:2e:bc:d7:20:b5:20:d5:4d:cd:d4:a5:
7c:c8:9a:fd:d8:61:e7:e4:eb:58:65:1e:ea:5a:4d:
4c:73:87:32:e0:91:a3:92:56:2e:a7:bc:1e:32:30:
43:f5:fd:db:05:5a:08:b2:25:15:5f:ac:4d:71:82:
2b:d0:87:b4:01" | tr -d ": \n" | xxd -p -r | base64 | tr +/ -_ | tr -d "=\n"
tfJaLrzXILUg1U3N1KV8yJr92GHn5OtYZR7qWk1Mc4cy4JGjklYup7weMjBD9f3bBVoIsiUVX6xNcYIr0Ie0AQtr 명령을 적절히 활용하여 모듈러스 필드가 jwks.json 파일에서 사용할 수 있는 Base64URL 문자열로 인코딩되었습니다.
jwks.json 파일 채우기
이전 단계에서 다음의 필요한 정보를 수집했습니다:
- RSA 키 쌍.
- Base64URL 형식의 RSA 공개 키 모듈러스.
- Base64URL 형식의 RSA 공개 키 지수.
이 정보들이 준비되었으므로, 이제 Ktor 프로젝트의 jwks.json 파일에 다음 속성들을 입력할 수 있습니다:
- 이전 단계에서 생성한 Base64URL 인코딩된 값으로 채운
e및n값. - 키 ID(이 경우
kid는 샘플 프로젝트에서 가져옴). RSA로 지정된kty속성.
{
"keys": [
{
"kty": "RSA",
"e": "AQAB",
"kid": "6f8856ed-9189-488f-9011-0ff4b6c08edc",
"n":"tfJaLrzXILUg1U3N1KV8yJr92GHn5OtYZR7qWk1Mc4cy4JGjklYup7weMjBD9f3bBVoIsiUVX6xNcYIr0Ie0AQ"
}
]
}이제 Ktor 프로젝트가 인증에 사용할 수 있도록 개인 키를 지정하는 단계만 남았습니다.
개인 키 정의
공개 키 정보가 설정되었으므로, 마지막 단계는 Ktor 프로젝트가 개인 키에 액세스할 수 있도록 하는 것입니다.
처음에 .pk8 파일로 생성한 개인 키를 시스템의 환경 변수(이 경우 jwt_pk)로 추출했다고 가정하면, resources/application.conf 파일의 jwt 섹션은 다음과 유사해야 합니다:
jwt {
privateKey = ${jwt_pk}
issuer = "http://0.0.0.0:8080/"
audience = "http://0.0.0.0:8080/login"
realm = "MyProject"
}개인 키는 민감한 정보로 간주되므로 코드에 직접 저장해서는 안 됩니다. 민감한 데이터에는 환경 변수 또는 비밀 저장소(secret store)를 사용하는 것을 고려하세요.
