C# - ssh-keygen으로 생성한 Public Key 파일 해석과 fingerprint 값(md5, sha256) 생성
ssh-keygen 등으로 생성한 SSH public key의 경우, 다음과 같은 식의 포맷을 가지는데요,
// 여기서는 테스트를 쉽게 하기 위해 암호를 생략하도록 (-N 옵션의 빈 문자열) 지정했습니다. (현업에서는 암호 사용을 권장합니다.)
c:\temp> ssh-keygen -N "" -t rsa -b 4096 -f test_rsa
...[생략]...
c:\temp> type test_rsa.pub
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCvnNE7kvQyCLJIi3i1hZwVmLNheUb8E1oc3R94YLcnOKlisbuXx3hiSGjOPOx9Uedf/Pp73bx8Otu/9VudriZ910cPTzDDR6zJPfUYHyDiltwJ3zcKpkoG6z6ilIJVuX1Cm8S9q+pwkVOm7ij+FSiF8R/WxlblPMZzdTRyCYMCiOJ0KjZXU8as3iGadnQMZD+WUn6t/gPUKfIvCw1uAIPY5KDqp8RJeeMeJJw55RCkkjHzv1ghYvQDMCqpWXQ+OT5n1DQEpbH1994UYBJhpJC/W95+Tn2pqTPmcdobP7+nl3COVwxB77uk9Hxkfr9ldBxoZiEHchhm1qDUCp82QGFbImufQ3A2wYdQIyRTHD11gro17jj+5U7ae5szeRQzlh6RWaxUvPefFvs6nKhCXOE5yT5Ss5QoMBjivyUWdcMPW2X15dB0RAR03HA1GmyTnMj2zVJh/7p0hJR11U5EcOVQ969RfyPf7GvZZlhMSaYNdLiwg4O1f8FjS5wk+O7srimgnSe+K9Mz2qorCosYp4nZq/dduuy56UK2j609JbXXtfRRN0k16/JeDQvP7S1Pv3zQtwDvyBxGRlZ7UKhkAC1R0HRGjqWwqtVOTLtpKND64ENGXSYSddesF9SCBK2dwRjyhSLuv74dkpHzGbNAk0gTW1mnChJN6rHIrBtCA4rFRQ== testusr@TESTPC
이 포맷을 다음의 명령어를 이용해,
// 또는, openssl을 이용.
c:\temp> ssh-keygen -f test_rsa.pub -e -m pem > test_rsa.pub.pkcs1
c:\temp> type test_rsa.pub.pkcs1
-----BEGIN RSA PUBLIC KEY-----
MIICCgKCAgEAr5zRO5L0MgiySIt4tYWcFZizYXlG/BNaHN0feGC3JzipYrG7l8d4
YkhozjzsfVHnX/z6e928fDrbv/Vbna4mfddHD08ww0esyT31GB8g4pbcCd83CqZK
Bus+opSCVbl9QpvEvavqcJFTpu4o/hUohfEf1sZW5TzGc3U0cgmDAojidCo2V1PG
rN4hmnZ0DGQ/llJ+rf4D1CnyLwsNbgCD2OSg6qfESXnjHiScOeUQpJIx879YIWL0
AzAqqVl0Pjk+Z9Q0BKWx9ffeFGASYaSQv1vefk59qakz5nHaGz+/p5dwjlcMQe+7
pPR8ZH6/ZXQcaGYhB3IYZtag1AqfNkBhWyJrn0NwNsGHUCMkUxw9dYK6Ne44/uVO
2nubM3kUM5YekVmsVLz3nxb7OpyoQlzhOck+UrOUKDAY4r8lFnXDD1tl9eXQdEQE
dNxwNRpsk5zI9s1SYf+6dISUddVORHDlUPevUX8j3+xr2WZYTEmmDXS4sIODtX/B
Y0ucJPju7K4poJ0nvivTM9qqKwqLGKeJ2av3XbrsuelCto+tPSW117X0UTdJNevy
Xg0Lz+0tT7980LcA78gcRkZWe1CoZAAtUdB0Ro6lsKrVTky7aSjQ+uBDRl0mEnXX
rBfUggStncEY8oUi7r++HZKR8xmzQJNIE1tZpwoSTeqxyKwbQgOKxUUCAwEAAQ==
-----END RSA PUBLIC KEY-----
PKCS#1 PEM 포맷으로 변환할 수 있습니다. 이런 경우라면 닷넷 5부터 추가된
ImportFromPem /
ImportFromEncryptedPem 메서드로,
C# - PEM 파일을 이용한 RSA 개인키/공개키 설정 방법
; https://www.sysnet.pe.kr/2/0/13245
공개키를 로드하는 것이 가능합니다.
string pemText = File.ReadAllText("test_rsa.pub.pkcs1");
using (RSA rsa = RSA.Create())
{
rsa.ImportFromPem(pemText.ToCharArray()); // 현재 PUBLIC KEY, PRIVATE KEY, RSA PRIVATE KEY, RSA PUBLIC KEY 포맷을 지원합니다.
Console.WriteLine(rsa.ToXmlString(false));
}
혹은, test_rsa.pub.pkcs1 파일 내부의 구분자를 제외한 내용을 ImportRSAPublicKey 메서드로 직접 로드할 수 있습니다.
string pemText = File.ReadAllText("test_rsa.pub.pkcs1");
var publicKeyBase64 = pemText
.Replace("-----BEGIN RSA PUBLIC KEY-----", "")
.Replace("-----END RSA PUBLIC KEY-----", "").Trim();
byte[] publicKeyBytes = Convert.FromBase64String(publicKeyBase64);
using (var rsa = new RSACryptoServiceProvider())
{
rsa.ImportRSAPublicKey(publicKeyBytes, out _);
Console.WriteLine(rsa.ToXmlString(false));
}
그렇다면 PEM 포맷으로 변경 없이 곧바로 읽어들일 수 있는 방법은 없을까요? 검색해 보면, 다음과 같은 글이 나옵니다.
Converting OpenSSH public keys
; https://blog.oddbit.com/post/2011-05-08-converting-openssh-public-keys/
위의 글에 따르면 SSH 공개키 파일 포맷은 다음과 같이 정의돼 있습니다.
[The key type] [A chunk of PEM-encoded data] [A comment]
예)ssh-rsa AAAAB3...[생략]...cQ== testusr@TESTPC
그다음, "[A chunk of PEM-encoded data]"의 포맷은 "key type"이 "ssh-rsa"인 경우 (length, data) 조합의 연속이라고 합니다. 3가지 값이 연속돼 있는데요, 이 형식은 다음과 같습니다.
[4바이트 길이(big endian)] [algorithm name, ("ssh-rsa" | "ssh-dsa")]
[4바이트 길이(big endian)] [RSA exponent (ASN.1)]
[4바이트 길이(big endian)] [RSA modulus (ASN.1)]
따라서 C#으로는 이런 식으로 코드를 만들 수 있는데요,
private static (string algorithmName, byte[] exponent, byte[] modulus) DecodeSSHPublicKey(byte[] bytesEncoded)
{
string algorithmName;
byte[] exponent;
byte[] modulus;
using (var stream = new MemoryStream(bytesEncoded))
using (var reader = new BinaryReader(stream))
{
int algorithmLength = reader.ReadInt32BE();
algorithmName = Encoding.ASCII.GetString(reader.ReadBytes(algorithmLength));
int exponentLength = reader.ReadInt32BE();
exponent = reader.ReadBytes(exponentLength);
int modulusLength = reader.ReadInt32BE();
modulus = reader.ReadMPINT(modulusLength);
}
return (algorithmName, exponent, modulus);
}
public static class BinaryReaderExtension
{
public static Int32 ReadInt32BE(this BinaryReader reader)
{
byte[] bytes = new byte[4];
bytes[3] = (byte)reader.ReadByte();
bytes[2] = (byte)reader.ReadByte();
bytes[1] = (byte)reader.ReadByte();
bytes[0] = (byte)reader.ReadByte();
return BitConverter.ToInt32(bytes);
}
// RSA 공개키 등의 modulus 값에 0x00 선행 바이트가 있는 이유(ASN.1 인코딩)
// https://www.sysnet.pe.kr/2/0/13740
public static byte[] ReadMPINT(this BinaryReader reader, int length)
{
byte leadByte = reader.ReadByte();
if (leadByte == 0)
{
return reader.ReadBytes(length);
}
reader.BaseStream.Seek(-1, SeekOrigin.Current);
return reader.ReadBytes(length);
}
}
그런데, 실제로 해보면 algorithmName, exponent 값은 제대로 읽어들이지만 modulus의 값이 틀립니다. 정상적인 경우와 비교해 보면, exponent를 읽어들인 후에 1바이트를 건너 뛰어야 한다는 차이가 있는데요,
int algorithmLength = reader.ReadInt32BE();
algorithmName = Encoding.ASCII.GetString(reader.ReadBytes(algorithmLength));
int exponentLength = reader.ReadInt32BE();
exponent = reader.ReadBytes(exponentLength);
reader.ReadByte();
int modulusLength = reader.ReadInt32BE();
modulus = reader.ReadBytes(modulusLength);
관련해서 검색해 보면 이런 글이 나옵니다.
Converting an RSA Public Key into a RFC 4716 Public Key with Bouncy Castle
; https://stackoverflow.com/questions/15457710/converting-an-rsa-public-key-into-a-rfc-4716-public-key-with-bouncy-castle
즉, exponent 다음에 1바이트 0x00이 추가된다고 합니다. 이게 4바이트 정렬 때문이라 그런 건지, (글에서처럼 puttygen을 포함해) ssh-keygen와 같은 도구에서만 그런 건지는 잘 모르겠습니다. (혹시 이와 관련해 아시는 분은 덧글 부탁드립니다. ^^)
참고로, "Converting OpenSSH public keys" 글에서 제시한 파이썬 예제 코드에도 딱히 1바이트를 건너 뛰어야 하는 코드가 없습니다.
import sys
import base64
import struct
# get the second field from the public key file.
keydata = base64.b64decode(
open('key.pub').read().split(None)[1])
parts = []
while keydata:
# read the length of the data
dlen = struct.unpack('>I', keydata[:4])[0]
# read in <length> bytes
data, keydata = keydata[4:dlen+4], keydata[4+dlen:]
parts.append(data)
아무튼, 저렇게 해서 로드하면 정상적으로 코드가 잘 동작합니다.
string text = File.ReadAllText("test_rsa.pub");
{
string[] sshKeys = text.Split(' ');
if (sshKeys.Length != 3)
{
throw new Exception("Invalid SSH Key");
}
string keyType = sshKeys[0];
string comment = sshKeys[2];
byte[] bytesEncoded = Convert.FromBase64String(sshKeys[1]);
if (keyType != "ssh-rsa")
{
throw new NotSupportedException($"Unsupported key type: {keyType}");
}
(string algorithmName, byte[] exponent, byte[] modulus) = DecodeSSHPublicKey(bytesEncoded);
}
그리고 이렇게 구한 공개키 정보로부터 RSACryptoServiceProvider까지 초기화가 가능합니다.
RSAParameters rsaParam = new RSAParameters();
rsaParam.Exponent = new byte[exponent.Length];
rsaParam.Modulus = new byte[modulus.Length];
Array.Copy(exponent, rsaParam.Exponent, exponent.Length);
Array.Copy(modulus, rsaParam.Modulus, modulus.Length);
RSACryptoServiceProvider rsa = new RSACryptoServiceProvider();
rsa.ImportParameters(rsaParam);
Console.WriteLine(rsa.ToXmlString(false));
/* 출력 결과:
<RSAKeyValue><Modulus>r5zRO5L0MgiySIt4tYWcFZizYXlG/BNaHN0feGC3JzipYrG7l8d4YkhozjzsfVHnX/z6e928fDrbv/Vbna4mfddHD08ww0esyT31GB8g4pbcCd83CqZKBus+opSCVbl9QpvEvavqcJFTpu4o/hUohfEf1sZW5TzGc3U0cgmDAojidCo2V1PGrN4hmnZ0DGQ/llJ+rf4D1CnyLwsNbgCD2OSg6qfESXnjHiScOeUQpJIx879YIWL0AzAqqVl0Pjk+Z9Q0BKWx9ffeFGASYaSQv1vefk59qakz5nHaGz+/p5dwjlcMQe+7pPR8ZH6/ZXQcaGYhB3IYZtag1AqfNkBhWyJrn0NwNsGHUCMkUxw9dYK6Ne44/uVO2nubM3kUM5YekVmsVLz3nxb7OpyoQlzhOck+UrOUKDAY4r8lFnXDD1tl9eXQdEQEdNxwNRpsk5zI9s1SYf+6dISUddVORHDlUPevUX8j3+xr2WZYTEmmDXS4sIODtX/BY0ucJPju7K4poJ0nvivTM9qqKwqLGKeJ2av3XbrsuelCto+tPSW117X0UTdJNevyXg0Lz+0tT7980LcA78gcRkZWe1CoZAAtUdB0Ro6lsKrVTky7aSjQ+uBDRl0mEnXXrBfUggStncEY8oUi7r++HZKR8xmzQJNIE1tZpwoSTeqxyKwbQgOKxUU=</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>
*/
해본 김에, fingerprint 값도 구해볼까요? ^^ 우선 ssh-keygen을 이용해 보면 공개키 파일의 fingerprint는 다음과 같은 명령어로 구할 수 있습니다.
// What is a SSH key fingerprint and how is it generated?
// ; https://superuser.com/questions/421997/what-is-a-ssh-key-fingerprint-and-how-is-it-generated
c:\temp> ssh-keygen -l -f "test_rsa.pub"
4096 SHA256:FfM9wFpzJqN5shtFtt+rk/0ggZbkGthsbsoZz52YiwQ testusr@TESTPC (RSA)
SHA256 해시를 했다는 것에서 대충 다음과 같은 코드를 작성할 수 있습니다.
string text = File.ReadAllText("test_rsa.pub");
string[] sshKeys = text.Split(' ');
string comment = sshKeys[2];
byte[] bytesEncoded = Convert.FromBase64String(sshKeys[1]);
// ...생략... (DecodeSSHPublicKey, RSACryptoServiceProvider 초기화)
string signature = Convert.ToBase64String(SHA256.Create().ComputeHash(bytesEncoded));
Console.WriteLine($"Fingerprint(sha256): {rsa.KeySize} SHA256:{signature.Replace("=", "")} {comment}");
/* 출력 결과:
Fingerprint(sha256): 4096 SHA256:FfM9wFpzJqN5shtFtt+rk/0ggZbkGthsbsoZz52YiwQ testusr@TESTPC
*/
출력 결과가 동일합니다. ^^ 또한, 예전처럼 md5 방식의 해시를 구하는 것도 가능한데요,
c:\temp> ssh-keygen -l -E md5 -f "test_rsa.pub"
4096 MD5:2e:fc:70:c6:6c:09:91:94:c2:4b:50:f5:75:47:ba:5c testusr@TESTPC (RSA)
C# 코드로는 이렇게 작성할 수 있습니다.
signature = BitConverter.ToString(MD5.Create().ComputeHash(bytesEncoded));
Console.WriteLine($"Fingerprint(md5): MD5:{rsa.KeySize} {signature.ToLower().Replace('-', ':')} {comment}");
/* 출력 결과:
Fingerprint(md5): 4096 MD5:2e:fc:70:c6:6c:09:91:94:c2:4b:50:f5:75:47:ba:5c testusr@TESTPC
*/
참고로, 자신의 코드가 제대로 동작하는지 확인하는 용도로 ^^ (비록 유료지만) 아래의 라이브러리가 쓸 만할 것입니다.
SshKey C# Reference Documentation
; https://www.chilkatsoft.com/refdoc/csSshKeyRef.html
Chilkat 라이브러리로 이번 글의 코드도 대충 다음과 같이 작성할 수 있습니다.
string text = File.ReadAllText("test_rsa.pub");
var sshObj = new Chilkat.SshKey();
sshObj.FromOpenSshPublicKey(text);
string xmlKey = sshObj.ToXml();
Console.WriteLine(xmlKey);
Console.WriteLine($"Fingerprint: {sshObj.GenFingerprint()}");
/* 출력 결과:
<RSAPublicKey><Modulus>r5zRO5L0MgiySIt4tYWcFZizYXlG/BNaHN0feGC3JzipYrG7l8d4YkhozjzsfVHnX/z6e928fDrbv/Vbna4mfddHD08ww0esyT31GB8g4pbcCd83CqZKBus+opSCVbl9QpvEvavqcJFTpu4o/hUohfEf1sZW5TzGc3U0cgmDAojidCo2V1PGrN4hmnZ0DGQ/llJ+rf4D1CnyLwsNbgCD2OSg6qfESXnjHiScOeUQpJIx879YIWL0AzAqqVl0Pjk+Z9Q0BKWx9ffeFGASYaSQv1vefk59qakz5nHaGz+/p5dwjlcMQe+7pPR8ZH6/ZXQcaGYhB3IYZtag1AqfNkBhWyJrn0NwNsGHUCMkUxw9dYK6Ne44/uVO2nubM3kUM5YekVmsVLz3nxb7OpyoQlzhOck+UrOUKDAY4r8lFnXDD1tl9eXQdEQEdNxwNRpsk5zI9s1SYf+6dISUddVORHDlUPevUX8j3+xr2WZYTEmmDXS4sIODtX/BY0ucJPju7K4poJ0nvivTM9qqKwqLGKeJ2av3XbrsuelCto+tPSW117X0UTdJNevyXg0Lz+0tT7980LcA78gcRkZWe1CoZAAtUdB0Ro6lsKrVTky7aSjQ+uBDRl0mEnXXrBfUggStncEY8oUi7r++HZKR8xmzQJNIE1tZpwoSTeqxyKwbQgOKxUU=</Modulus><Exponent>AQAB</Exponent></RSAPublicKey>
Fingerprint: ssh-rsa 4096 2e:fc:70:c6:6c:09:91:94:c2:4b:50:f5:75:47:ba:5c
*/
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
마지막으로 표준 관련 이야기를 해볼까요? ^^ "
Converting OpenSSH public keys" 글에 따르면 ssh-keygen이 생성한 공개키 파일은
RFC 4253을 따른다고 합니다.
아래의 글에서 좀 더 자세하게 설명하는 글이 나오는데요,
OpenSSH public key file format?
; https://superuser.com/questions/1477472/openssh-public-key-file-format
일단, RFC 4251 문서(
"The Secure Shell (SSH) Protocol Architecture")상으로는 파일 포맷에 대한 규정이 없다고 합니다. 단지, 직렬화는 필요할 텐데, 재미있는 것은 SSH 프로토콜 협상에서 개인키가 오고 가는 것은 없으므로 그에 대한 직렬화도 스펙에는 없다고 합니다.
단지, 공개키라면 OpenSSH에서 파일에 저장하기 위해 RFC 4253 포맷을 많이 수용했다는 건데요, 파일 저장의 포맷이 규정된 것이 없으므로 클라이언트들이 개별 포맷을 사용하는 듯합니다. 그중 OpenSSH의 경우 내부적으로 OpenSSL을 사용하기 때문에 결국 OpenSSL의 공개키 파일 포맷이 곧 OpenSSH의 포맷이 됩니다.
별도로 "The SSH Public Key Format"으로 RFC 4716이 정의돼 있다고 하는데,
The Secure Shell (SSH) Public Key File Format
; https://datatracker.ietf.org/doc/html/rfc4716
그다지 일반적으로 차용되고 있지는 않다고 합니다. 이 문서 때문인지는 모르겠지만, 종종 Q&A에 보면
ssh-keygen으로 생성한 공개키에 대해 RFC 4716 포맷을 언급하는 글이 있기도 합니다. (혹시 표준 관련해서 잘 알고 계신 분은 덧글 부탁드립니다. ^^)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]