C# - ssh-keygen으로 생성한 Private Key와 Public Key 연동
지난 글을 통해,
C# - ssh-keygen으로 생성한 Public Key 파일 해석과 fingerprint 값(md5, sha256) 생성
; https://www.sysnet.pe.kr/2/0/13739
C# - ssh-keygen으로 생성한 ecdsa 유형의 Public Key 파일 해석
; https://www.sysnet.pe.kr/2/0/13742
C# - OpenSSH의 공개키 파일에 대한 "BEGIN OPENSSH PUBLIC KEY" / "END OPENSSH PUBLIC KEY" PEM 포맷
; https://www.sysnet.pe.kr/2/0/13747
대충 (rsa, ecdsa, eddsa에 해당하는) Public Key 파일의 해석에 대해 알아봤는데요, 그렇다면 개인키 파일의 해석은 어떻게 해야 할까요?
우선, PKCS#1 형식을 담은 "BEGIN/END RSA PRIVATE KEY"와 PKCS#8 형식을 담은 "BEGIN/END PRIVATE KEY"인 경우에는 닷넷에서 기본 제공하는 ImportFromPem / ImportFromEncryptedPem 메서드로 쉽게 읽어들일 수 있습니다.
C# - PEM 파일을 이용한 RSA 개인키/공개키 설정 방법
; https://www.sysnet.pe.kr/2/0/13245
반면, 근래 들어 ssk-keygen으로 생성한 개인키 파일은 OpenSSH 형식을 사용하는 경우가 많은데요, 예를 들어 아래의 실행 결과를 보면,
// 여기서는 테스트를 쉽게 하기 위해 암호를 생략하도록 (-N 옵션의 빈 문자열) 지정했습니다. (현업에서는 암호 사용을 권장합니다.)
c:\temp> ssh-keygen -N "" -t rsa -b 4096 -f test_rsa
...[생략]...
C:\temp> type test_rsa
-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAACFwAAAAdzc2gtcn
...생략...
8qPM0j0vSniZAAAAC2tldmluQFRIRTEyAQIDBAUGBw==
-----END OPENSSH PRIVATE KEY-----
PEM 파일의 구분자가 "BEGIN/END OPENSSH PRIVATE KEY"입니다. 검색해 보면, 이것은 OpenSSH 측의 독자적인 포맷으로 다음과 같은 구조를 갖는다고 합니다.
// 출처: https://coolaj86.com/articles/the-openssh-private-key-format/
"openssh-key-v1"0x00 # NULL-terminated "Auth Magic" string
32-bit length, "none" # ciphername length and string
32-bit length, "none" # kdfname length and string
32-bit length, nil # kdf (0 length, no kdf)
32-bit 0x01 # number of keys, hard-coded to 1 (no length)
32-bit length, sshpub # public key in ssh format
32-bit length, keytype
32-bit length, pub0
32-bit length, pub1
32-bit length for rnd+prv+comment+pad
64-bit dummy checksum? # a random 32-bit int, repeated
32-bit length, keytype # the private key (including public)
32-bit length, pub0 # Public Key parts
32-bit length, pub1
32-bit length, prv0 # Private Key parts
... # (number varies by type)
32-bit length, comment # comment string
padding bytes 0x010203 # pad to blocksize (see notes below)
상대적으로 개인키의 경우에는 좀 더 복잡한 구조를 갖고 있어 일일이 해석하기가 귀찮아졌습니다. ^^; 게다가 또 다른 문제는, ImportFromPem / ImportFromEncryptedPem 메서드가 "OpenSSH" 포맷을 지원하지 않는다는 점입니다.
따라서 이런 경우 다른 라이브러리를 사용해야 하는데요, 대표적으로
BouncyCastle이 있을 것입니다. 하지만, 여기서는 가능한 "개인키"에만 집중할 수 있도록 "SSH.NET"을 이용해 보겠습니다.
SSH.NET에는 다양한 Private key 포맷을 지원하는 PrivateKeyFile 타입이 있는데요, 가령, "BEGIN/END OPENSSH PRIVATE KEY" 유형에 대해 다음과 같이 읽을 수 있습니다.
// SSH.NET의 경우 2020.0.1 버전부터 OpenSSH Private Key를 지원합니다.
// Install-Package SSH.NET
string openSSHPrivateFilePath = "test_rsa";
{
byte[] keyBuffer = File.ReadAllBytes(openSSHPrivateFilePath);
MemoryStream keyStream = new MemoryStream(keyBuffer);
PrivateKeyFile pkf = new PrivateKeyFile(keyStream);
}
이전에 생성한 test_rsa 파일이 RSA 유형이기 때문에 PrivateKeyFile은 Key 속성을 통해 RsaKey 타입을 반환합니다.
Renci.SshNet.Security.RsaKey? rsaKey = pkf.Key as Renci.SshNet.Security.RsaKey;
그리고 저 RsaKey 타입에는 (.NET BCL의)
RSAParameters 키 값을 채울 수 있는 모든 정보가 BigInteger 타입으로 담겨 있습니다. 하지만, 가벼운 문제가 하나 있는데요, RsaKey 필드의 BigInteger는 System.Numerics의 것이 아닌, Renci.SshNet.Common에 구현된 독자적인 것을 사용한다는 점입니다. 그리고 그 타입(Renci.SshNet.Common.BigInteger)은 아쉽게도
isUnsigned, isBigEndian을 선택할 수 있는 ToByteArray 오버로드를 제공하지 않습니다.
따라서, 그에 대한 처리를 직접 해서 RSAParameters를 채우는 코드를 다음과 같이 작성해야 합니다.
RSAParameters rsaParam = FromOpenSSHKey(rsaKey);
private static RSAParameters FromOpenSSHKey(RsaKey? openSshKey)
{
RSAParameters rsaParams = new RSAParameters();
if (openSshKey == null)
{
throw new ArgumentNullException(nameof(openSshKey));
}
int modulusLength = openSshKey.Modulus.BitLength;
int halfModulusLength = (modulusLength + 1) / 2;
ToUnsignedBigEndian(openSshKey.P, ref rsaParams.P);
ToUnsignedBigEndian(openSshKey.Q, ref rsaParams.Q);
ToUnsignedBigEndian(openSshKey.DP, ref rsaParams.DP);
ToUnsignedBigEndian(openSshKey.DQ, ref rsaParams.DQ);
ToUnsignedBigEndian(openSshKey.InverseQ, ref rsaParams.InverseQ);
ToUnsignedBigEndian(openSshKey.D, ref rsaParams.D);
ToUnsignedBigEndian(openSshKey.Modulus, ref rsaParams.Modulus);
ToUnsignedBigEndian(openSshKey.Exponent, ref rsaParams.Exponent);
return rsaParams;
}
private static void ToUnsignedBigEndian(Renci.SshNet.Common.BigInteger number, ref byte[]? target)
{
Span<byte> buffer = number.ToByteArray();
if (buffer == null || buffer.Length == 0)
{
throw new ArgumentNullException($"{nameof(number)}.{nameof(number.ToByteArray)}");
}
if (buffer[buffer.Length - 1] == 0)
{
buffer = buffer[..^1];
}
buffer.Reverse();
target = new byte[buffer.Length];
buffer.CopyTo(target);
}
자, 이렇게 해서 ImportParameters를 거치면 정상적으로 RSA 복호화를 할 수 있는데요,
지난번에 RSA 공개키를 로드했던 코드와 합치면 다음과 같이 암/복호화 코드를 완성할 수 있습니다.
using Renci.SshNet;
using Renci.SshNet.Security;
using System.Diagnostics;
using System.Security.Cryptography;
using System.Text;
internal class Program
{
static void Main(string[] args)
{
string openSSHPrivateFilePath = "test_rsa";
string publicKeyFilePath = "test_rsa.pub";
byte[] encBuffer = Array.Empty<byte>();
string plainText = "Hello World";
byte[] plainTextBuffer = Encoding.UTF8.GetBytes(plainText);
{
string text = File.ReadAllText(publicKeyFilePath);
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]);
switch (keyType)
{
case "ssh-rsa":
(string algorithmName, RSAParameters rsaParam) = PublicKeyFile.DecodeRsa(bytesEncoded);
var rsa = RSA.Create(rsaParam);
encBuffer = rsa.Encrypt(plainTextBuffer, RSAEncryptionPadding.OaepSHA256);
break;
}
}
Debug.Assert(encBuffer != null && encBuffer.Length != 0);
{
byte[] keyBuffer = File.ReadAllBytes(openSSHPrivateFilePath);
MemoryStream keyStream = new MemoryStream(keyBuffer);
PrivateKeyFile pkf = new PrivateKeyFile(keyStream);
Renci.SshNet.Security.RsaKey? rsaKey = pkf.Key as Renci.SshNet.Security.RsaKey;
RSAParameters rsaParam = FromOpenSSHKey(rsaKey);
var rsa = RSA.Create(rsaParam);
byte[] buffer = rsa.Decrypt(encBuffer, RSAEncryptionPadding.OaepSHA256);
Console.WriteLine(Encoding.UTF8.GetString(buffer));
}
}
private static RSAParameters FromOpenSSHKey(RsaKey? openSshKey)
{
// ...[생략]...
}
}
위에서는 RSA 키를 대상으로 했다면 Elliptic Curve 알고리즘의 개인키를 담은 "BEGIN/END EC PRIVATE KEY" 파일로도 동일하게 테스트할 수 있습니다.
공개키 영역은 지난 글에 설명했으니 건너뛰고,
C# - ssh-keygen으로 생성한 ecdsa 유형의 Public Key 파일 해석
; https://www.sysnet.pe.kr/2/0/13742
Private Key와의 연동을 다음과 같은 식으로 테스트할 수 있습니다.
using Renci.SshNet;
using Renci.SshNet.Security;
using System.Diagnostics;
using System.Security.Cryptography;
using System.Text;
internal class Program
{
static void Main(string[] args)
{
string openSSHPrivateFilePath = "test_ecdsa";
string publicKeyFilePath = "test_ecdsa.pub";
byte[] signedBuffer = Array.Empty<byte>();
string plainText = "Hello World";
byte[] plainTextBuffer = Encoding.UTF8.GetBytes(plainText);
// 개인키를 이용한 서명
{
byte[] keyBuffer = File.ReadAllBytes(openSSHPrivateFilePath);
MemoryStream keyStream = new MemoryStream(keyBuffer);
PrivateKeyFile pkf = new PrivateKeyFile(keyStream);
Renci.SshNet.Security.EcdsaKey? ecdsaKey = pkf.Key as Renci.SshNet.Security.EcdsaKey;
ECParameters ecParam = FromOpenSSHKey(ecdsaKey);
ECDsa ecdsa = ECDsa.Create(ecParam);
signedBuffer = ecdsa.SignData(plainTextBuffer, HashAlgorithmName.SHA256);
// ECDiffieHellman ecdh = ECDiffieHellman.Create(ecParam);
}
Debug.Assert(signedBuffer != null && signedBuffer.Length != 0);
// 공개키를 이용한 검증
{
string text = File.ReadAllText(publicKeyFilePath);
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]);
switch (keyType)
{
case "ecdsa-sha2-nistp256":
(string algorithmName, string curveName, ECParameters ecParam) = PublicKeyFile.DecodeEcdsa(bytesEncoded);
ECDsa ecdsa = ECDsa.Create(ecParam);
// ecdsa.ImportParameters(ecParam);
bool verified = ecdsa.VerifyData(plainTextBuffer, signedBuffer, HashAlgorithmName.SHA256);
Console.WriteLine("Verified: " + verified);
break;
}
}
}
private static ECParameters FromOpenSSHKey(EcdsaKey? openSshKey)
{
if (openSshKey == null)
{
throw new ArgumentNullException(nameof(openSshKey));
}
byte[]? curveNameBuffer = null;
openSshKey.Public[0].ToUnsignedBigEndian(ref curveNameBuffer);
if (curveNameBuffer == null)
{
throw new ArgumentNullException(nameof(curveNameBuffer));
}
string curveName = Encoding.ASCII.GetString(curveNameBuffer);
ECParameters ecParam = new ECParameters
{
Curve = ECCurve.CreateFromFriendlyName(curveName),
};
int length = openSshKey.PrivateKey.Length;
ecParam.D = new byte[length];
Array.Copy(openSshKey.PrivateKey, ecParam.D, length);
return ecParam;
}
}
마지막으로 Ed25519 알고리즘의 개인키를 담은 "BEGIN/END OPENSSH PRIVATE KEY" 파일도 처리해 볼 텐데요,
c:\temp> type test_ed25519
-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZWQyNTUx
OQAAACDQ3a1hJeJfZzky2WZPt4FbX7poA8TV/E9FxF+WDpBPQwAAAIj6Yds3+mHbNwAAAAtzc2gt
ZWQyNTUxOQAAACDQ3a1hJeJfZzky2WZPt4FbX7poA8TV/E9FxF+WDpBPQwAAAEB/KFTh1ivE0ozW
JF4qq7nNWeU/U+UJIbo8cWLJqnsXZtDdrWEl4l9nOTLZZk+3gVtfumgDxNX8T0XEX5YOkE9DAAAA
AAECAwQF
-----END OPENSSH PRIVATE KEY-----
c:\temp> type test_ed25519.pub
ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINDdrWEl4l9nOTLZZk+3gVtfumgDxNX8T0XEX5YOkE9D testuser@TESTPC
역시나 PrivateKeyFile 타입을 이용해 개인키를 로드해 사용하면 되는데요,
PrivateKeyFile pkf = new PrivateKeyFile(keyStream);
Renci.SshNet.Security.ED25519Key? edKey = pkf.Key as Renci.SshNet.Security.ED25519Key;
Ed25519PrivateKeyParameters edParam = new Ed25519PrivateKeyParameters(openSshKey.PrivateKey); // PrivateKey == 64바이트
// 예외 발생 - System.ArgumentException: 'must have length 32 (Parameter 'buf')'
웬일인지 저렇게 예외가 발생합니다. 저도 이번에야 알았는데, Ed25519의 경우 개인키도 32바이트, 공개키도 32바이트라는 특징이 있습니다. 그런데, SSH.NET의 PrivateKeyFile.PrivateKey 속성은 64바이트를 포함하고 있기 때문에 저런 오류가 발생합니다.
관련해서 검색해 보면 이런 답변이 나오는데요,
How to convert 64byte openssh-key-v1 to the resulting 32byte ed25519 private key
; https://security.stackexchange.com/questions/245074/how-to-convert-64byte-openssh-key-v1-to-the-resulting-32byte-ed25519-private-key
For Ed25519, the privatekey (after the name) has 2 length-prefixed values: the first is a copy of the publickey (32 bytes), and the second is what is labelled the 'secret' (private) key in the code, but actually is 64 bytes of which the first 32 bytes are the actual private key and the second 32 bytes are yet another copy of the public key!
그러니까, ED25519Key.PrivateKey 속성에 담긴 값은 이런 포맷이었던 것입니다.
// 64바이트 ed25519 PrivateKey 구조
[32바이트 - PrivateKey][32바이트 - PublicKey]
다행히 형식이 간단하므로, 역시나 서명 및 검증하는 코드를 다음과 같이 작성할 수 있습니다.
using Org.BouncyCastle.Crypto.Parameters;
using Org.BouncyCastle.Crypto.Signers;
using Renci.SshNet;
using Renci.SshNet.Security;
using System.Diagnostics;
using System.Text;
internal class Program
{
static void Main(string[] args)
{
string openSSHPrivateFilePath = "test_ed25519";
string publicKeyFilePath = "test_ed25519.pub";
byte[] signedBuffer = Array.Empty();
string plainText = "Hello World";
byte[] plainTextBuffer = Encoding.UTF8.GetBytes(plainText);
{
byte[] keyBuffer = File.ReadAllBytes(openSSHPrivateFilePath);
MemoryStream keyStream = new MemoryStream(keyBuffer);
PrivateKeyFile pkf = new PrivateKeyFile(keyStream);
Renci.SshNet.Security.ED25519Key? edKey = pkf.Key as Renci.SshNet.Security.ED25519Key;
Ed25519PrivateKeyParameters edParam = FromOpenSSHKey(edKey);
Ed25519Signer signer = new Ed25519Signer();
signer.Init(forSigning: true, edParam);
signer.BlockUpdate(plainTextBuffer);
signedBuffer = signer.GenerateSignature();
}
Debug.Assert(signedBuffer != null && signedBuffer.Length != 0);
{
string text = File.ReadAllText(publicKeyFilePath);
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]);
switch (keyType)
{
case "ssh-ed25519":
(string algorithmName, Ed25519PublicKeyParameters edParam) = PublicKeyFile.DecodeEdDSA(bytesEncoded);
Ed25519Signer signer = new Ed25519Signer();
signer.Init(false, edParam);
signer.BlockUpdate(plainTextBuffer);
bool verified = signer.VerifySignature(signedBuffer);
Console.WriteLine("Verified: " + verified);
break;
}
}
}
private static Ed25519PrivateKeyParameters FromOpenSSHKey(ED25519Key? openSshKey)
{
if (openSshKey == null)
{
throw new ArgumentNullException(nameof(openSshKey));
}
int keySize = Ed25519PrivateKeyParameters.KeySize;
byte[] privateKey = openSshKey.PrivateKey.Take(keySize).ToArray();
#if DEBUG
byte[] publicKey = openSshKey.PrivateKey.Skip(keySize).ToArray();
Debug.Assert(Enumerable.SequenceEqual(publicKey, openSshKey.PublicKey));
#endif
return new Ed25519PrivateKeyParameters(privateKey);
}
}
첨부 파일은, 저렇게 3개의 알고리즘(RSA< Ecdsa, Ed25519)에 대한 개인키/공개키 테스트 코드를 포함하고 있습니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]