개체 내장 개체

objectPKey

PKey 내장crypto키 쌍(공개 키 및 개인 키)을 나타내는 모듈에서 제공하는 개체입니다. PKey는 JS에서 키 생성, 키 로드, 키 저장 및 암호화 프로세스 관리를 지원합니다.

PKey 개체는 RSA, EC 또는 Ed25519와 같은 여러 암호화 알고리즘을 지원하며 각 암호화 알고리즘에는 고유한 키 생성 및 관리 방법이 있습니다. PKey 개체에는 키가 속한 알고리즘의 이름 및 키 길이와 같은 특성도 포함됩니다.

다음은 PKey의 일반적인 방법과 그 예입니다.

  1. generateKey(alg | bits): 키 쌍을 생성하고, alg는 키 알고리즘을 지정하고, bits는 키 길이를 지정하고, 기본값은 2048입니다.
1 2 3
var crypto = require('crypto'); var pkey = crypto.generateKey(2048);
  1. from(value[, password]): DER 또는 PEM 형식의 키를 PKey 객체로 로드합니다.
1 2 3
var crypto = require('crypto'); var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));
  1. publicKey: 현재 키의 공개 키를 가져옵니다.
1 2 3 4
var crypto = require('crypto'); var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem')); var pubkey = pkey.publicKey;
  1. equals(other): 두 개의 공개 키와 개인 키가 같은지 확인합니다.
1 2 3 4 5
var crypto = require('crypto'); var pkey1 = crypto.PKey.from(fs.readFile('rsa.private.pem')); var pkey2 = crypto.PKey.from(fs.readFile('rsa.public.pem')); console.log(pkey1.equals(pkey2)); // output: true

상속 관계

건설자

PKey

DER 형식의 키에서 PKey 구성

1 2
new PKey(Buffer DerKey, String password = "");

호출 매개변수:

  • DerKey:Buffer, DER 형식의 키
  • password: 문자열, 복호화된 비밀번호

PEM 형식의 키에서 PKey 생성

1 2
new PKey(String pemKey, String password = "");

호출 매개변수:

  • pemKey: 문자열, PEM 형식의 키
  • password: 문자열, 복호화된 비밀번호

JSON 형식의 키에서 PKey 생성

1
new PKey(Object jsonKey);

호출 매개변수:

  • jsonKey: 객체, JSON 형식의 키

jsonKey의 형식은 다음 네 가지 유형인 RSA 개인 키를 지원합니다.

1 2 3 4 5 6 7 8 9 10 11
{ "kty": "RSA", "n": "0m5lvKpWqy9JS7tV2HIPqHCYHLquSuxIC3F8strIQLJKO3rZmTT96KTnhsOfBO7Y1bI7mnT0PB3_vcHd9ekWMEoZJQw7MuB8KeM_Wn54-elJr5DNLk5bMppSGxX7ZnumiXGG51_X3Yp-_EbGtDG80GxXXix7Mucyo7K25uE0uW8=", "e": "AQAB", "d": "agN2O9NxMHL1MTMi75WfL9Pxvl-KWXKqZSF6mjzAsF9iKI8euyHIXYFepzU8kual1RsjDhCnzvWqFvZplW8lXqrHf_P-rS_9Y4gBUw6pjnI_DnFIRwWHRvrUHHSCfWOdTCIKdOTkgLZuGFuhEY3RMIW0WSYejjLtftwy0RVxAzk=", "p": "6a4G1qmfwWmn1biigN7IVFlkbLf9oVe6g7rOmHxI-hn1GRxKDSVuAUrmR1IhuAnca9M0y7SD-7TUs6wjOxWxaw==", "q": "5ofkxFKdPBD0CQHMb9q13AMHUVe0rJ-hSjqqIBrmqApUOneyAcMV76M0QyIQnI2p3POa4Qu_7XChDwRVl7LlDQ==", "dp": "2mXGiGwCHl8j-FBWuID-1C6z-BRB3MBEVoeKPOOzxOPruatB3mWEGXsqG7A8SWgV9URxTI2K6P3J6Z7RUpBkvw==", "dq": "oagn5vfb5NQqnOpS9xkSsD67cfIj821ZSFlNFYhnuOzNVda7z_qCtnHm4zDPH0lEFXoKYMfBhfqWJpaugttjPQ==", "qi": "dqEQgxNmOVFrF4s776hTqeC6oEDila8EvpVb2F2ZvwAOLjCQ66OiAZK1BiYGHqUy0NeqNmtlsLSuBEZQZvqZwg==" }

RSA 공개 키:

1 2 3 4 5
{ "kty": "RSA", "n": "0m5lvKpWqy9JS7tV2HIPqHCYHLquSuxIC3F8strIQLJKO3rZmTT96KTnhsOfBO7Y1bI7mnT0PB3_vcHd9ekWMEoZJQw7MuB8KeM_Wn54-elJr5DNLk5bMppSGxX7ZnumiXGG51_X3Yp-_EbGtDG80GxXXix7Mucyo7K25uE0uW8=", "e": "AQAB" }

EC 개인 키:

1 2 3 4 5 6 7
{ "kty": "EC", "crv": "P-521", "x": "ATfNNFuuvlGxrTGoXgyfSAGgRNNDnO3rN3k74urKJdVS14RYhdnSwm91Bm-F1l-T1XKlAY2yRnzG9w1Ukvo8c0wL", "y": "ASBHqrruB6kdkEUB3vlW3-UIkk4HtKdUeTwN-7m3j2rgZvYR1ffRAapDvWqKGiBjomqWafxokBkbDI0c95f6f4XU", "d": "AfkIbUHXfW41njdpoKuqqKludcoLJS8D_oMEwkj-GVaXFNKccIoF5iKGu2c69kNDjo83R_7wyGlfRczsklkik1ST" }

EC 공개 키:

1 2 3 4 5 6
{ "kty": "EC", "crv": "P-521", "x": "ATfNNFuuvlGxrTGoXgyfSAGgRNNDnO3rN3k74urKJdVS14RYhdnSwm91Bm-F1l-T1XKlAY2yRnzG9w1Ukvo8c0wL", "y": "ASBHqrruB6kdkEUB3vlW3-UIkk4HtKdUeTwN-7m3j2rgZvYR1ffRAapDvWqKGiBjomqWafxokBkbDI0c95f6f4XU" }

정적 함수

from

DER 형식으로 키 로드

1 2
static PKey PKey.from(Buffer DerKey, String password = "");

호출 매개변수:

  • DerKey:Buffer, DER 형식의 키
  • password: 문자열, 복호화된 비밀번호

반환 결과:

  • PKey, 키를 포함하는 객체를 반환합니다.

PEM 형식으로 키 로드

1 2
static PKey PKey.from(String pemKey, String password = "");

호출 매개변수:

  • pemKey: 문자열, PEM 형식의 키
  • password: 문자열, 복호화된 비밀번호

반환 결과:

  • PKey, 키를 포함하는 객체를 반환합니다.

JSON 형식으로 키 로드

1
static PKey PKey.from(Object jsonKey);

호출 매개변수:

  • jsonKey: 객체, JSON 형식의 키

반환 결과:

  • PKey, 키를 포함하는 객체를 반환합니다.

jsonKey의 형식은 다음 네 가지 유형인 RSA 개인 키를 지원합니다.

1 2 3 4 5 6 7 8 9 10 11
{ "kty": "RSA", "n": "0m5lvKpWqy9JS7tV2HIPqHCYHLquSuxIC3F8strIQLJKO3rZmTT96KTnhsOfBO7Y1bI7mnT0PB3_vcHd9ekWMEoZJQw7MuB8KeM_Wn54-elJr5DNLk5bMppSGxX7ZnumiXGG51_X3Yp-_EbGtDG80GxXXix7Mucyo7K25uE0uW8=", "e": "AQAB", "d": "agN2O9NxMHL1MTMi75WfL9Pxvl-KWXKqZSF6mjzAsF9iKI8euyHIXYFepzU8kual1RsjDhCnzvWqFvZplW8lXqrHf_P-rS_9Y4gBUw6pjnI_DnFIRwWHRvrUHHSCfWOdTCIKdOTkgLZuGFuhEY3RMIW0WSYejjLtftwy0RVxAzk=", "p": "6a4G1qmfwWmn1biigN7IVFlkbLf9oVe6g7rOmHxI-hn1GRxKDSVuAUrmR1IhuAnca9M0y7SD-7TUs6wjOxWxaw==", "q": "5ofkxFKdPBD0CQHMb9q13AMHUVe0rJ-hSjqqIBrmqApUOneyAcMV76M0QyIQnI2p3POa4Qu_7XChDwRVl7LlDQ==", "dp": "2mXGiGwCHl8j-FBWuID-1C6z-BRB3MBEVoeKPOOzxOPruatB3mWEGXsqG7A8SWgV9URxTI2K6P3J6Z7RUpBkvw==", "dq": "oagn5vfb5NQqnOpS9xkSsD67cfIj821ZSFlNFYhnuOzNVda7z_qCtnHm4zDPH0lEFXoKYMfBhfqWJpaugttjPQ==", "qi": "dqEQgxNmOVFrF4s776hTqeC6oEDila8EvpVb2F2ZvwAOLjCQ66OiAZK1BiYGHqUy0NeqNmtlsLSuBEZQZvqZwg==" }

RSA 공개 키:

1 2 3 4 5
{ "kty": "RSA", "n": "0m5lvKpWqy9JS7tV2HIPqHCYHLquSuxIC3F8strIQLJKO3rZmTT96KTnhsOfBO7Y1bI7mnT0PB3_vcHd9ekWMEoZJQw7MuB8KeM_Wn54-elJr5DNLk5bMppSGxX7ZnumiXGG51_X3Yp-_EbGtDG80GxXXix7Mucyo7K25uE0uW8=", "e": "AQAB" }

EC 개인 키:

1 2 3 4 5 6 7
{ "kty": "EC", "crv": "P-521", "x": "ATfNNFuuvlGxrTGoXgyfSAGgRNNDnO3rN3k74urKJdVS14RYhdnSwm91Bm-F1l-T1XKlAY2yRnzG9w1Ukvo8c0wL", "y": "ASBHqrruB6kdkEUB3vlW3-UIkk4HtKdUeTwN-7m3j2rgZvYR1ffRAapDvWqKGiBjomqWafxokBkbDI0c95f6f4XU", "d": "AfkIbUHXfW41njdpoKuqqKludcoLJS8D_oMEwkj-GVaXFNKccIoF5iKGu2c69kNDjo83R_7wyGlfRczsklkik1ST" }

EC 공개 키:

1 2 3 4 5 6
{ "kty": "EC", "crv": "P-521", "x": "ATfNNFuuvlGxrTGoXgyfSAGgRNNDnO3rN3k74urKJdVS14RYhdnSwm91Bm-F1l-T1XKlAY2yRnzG9w1Ukvo8c0wL", "y": "ASBHqrruB6kdkEUB3vlW3-UIkk4HtKdUeTwN-7m3j2rgZvYR1ffRAapDvWqKGiBjomqWafxokBkbDI0c95f6f4XU" }

구성원 속성

name

문자열, 현재 알고리즘 이름을 반환합니다.

1
readonly String PKey.name;

keySize

정수, 현재 알고리즘 암호 길이를 비트로 반환합니다.

1
readonly Integer PKey.keySize;

alg

문자열, 현재 개체의 서명 알고리즘을 반환하고 설정합니다.

1
String PKey.alg;

publicKey

PKey는 현재 키의 공개 키를 반환합니다.

1
readonly PKey PKey.publicKey;

반환 결과:

  • 현재 키의 공개 키

멤버 함수

isPrivate

현재 키가 개인 키인지 쿼리

1
Boolean PKey.isPrivate();

반환 결과:

  • Boolean, True가 개인 키를 의미하는 경우

clone

현재 키 복사

1
PKey PKey.clone();

반환 결과:

  • PKey, 현재 키의 복사 객체

pem

현재 키의 PEM 형식 인코딩을 반환합니다.

1
String PKey.pem();

반환 결과:

  • String, 현재 키의 PEM 형식 인코딩

der

현재 키의 DER 형식 인코딩을 반환합니다.

1
Buffer PKey.der();

반환 결과:

  • Buffer, 현재 키의 DER 형식 인코딩

json

현재 키의 jwt 형식 인코딩을 반환합니다.

1
Object PKey.json(Object opts = {});

호출 매개변수:

  • opts: 개체, 내보내기 옵션 지정

반환 결과:

  • Object, 현재 키의 jwt 형식 인코딩

opts는 다음 매개변수를 지원합니다.

1 2 3
{ compress: false, 指定签名以压缩方式输出公钥 }

압축을 지원하는 곡선은 다음과 같습니다.


equals

두 개의 공개/개인 키가 동일한지 비교

1
Boolean PKey.equals(PKey key);

호출 매개변수:

  • key: PKey, 상대방의 공개/개인 키 지정

반환 결과:

  • Boolean, 같은 경우 true 반환

encrypt

현재 알고리즘 암호화 공개 키를 사용하여 데이터 암호화

1
Buffer PKey.encrypt(Buffer data) async;

호출 매개변수:

  • data:Buffer, 암호화할 데이터를 지정합니다.

반환 결과:

  • Buffer, 암호화된 데이터를 반환합니다.

decrypt

현재 알고리즘 암호화 개인 키를 사용하여 데이터 복호화

1
Buffer PKey.decrypt(Buffer data) async;

호출 매개변수:

  • data:Buffer, 해독할 데이터를 지정합니다.

반환 결과:

  • Buffer, 해독된 데이터를 반환합니다.

sign

현재 알고리즘 암호화 개인 키를 사용하여 데이터 서명

1 2
Buffer PKey.sign(Buffer data, Object opts = {}) async;

호출 매개변수:

  • data:Buffer, 서명할 데이터를 지정합니다.
  • opts: 개체, 서명 옵션 지정

반환 결과:

  • Buffer, 서명된 데이터를 반환합니다.

opts는 다음 매개변수를 지원합니다.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
{ alg: 0, 指定签名的 hash 算法, 仅在 RSA 时有效, 缺省为 0. 支持算法: 0 = NONE, 1 = MD5, 2 = SHA1, 3 = SHA224, 4 = SHA256, 5 = SHA384, 6 = SHA512, 7 = RIPEMD160 to: pk, 指定验证方公钥, 仅在 ecsdsa 或 sm2 时有效 format: "der", 指定签名格式, 可选为 der 和 raw, 缺省为 der recoverable: false 指定返回可恢复签名, 仅在 secp256k1 有效 }

verify

현재 알고리즘 암호화 공개 키를 사용하여 데이터를 확인합니다.

1 2 3
Boolean PKey.verify(Buffer data, Buffer sign, Object opts = {}) async;

호출 매개변수:

  • data:Buffer, 검증할 데이터 지정
  • sign:Buffer, 확인할 서명 지정
  • opts: 개체, 인증 옵션을 지정합니다.

반환 결과:

  • Boolean, 검증된 결과를 반환합니다.

opts는 다음 매개변수를 지원합니다.

1 2 3 4 5 6 7 8 9 10 11 12 13 14
{ alg: 0, 指定签名的 hash 算法, 仅在 RSA 时有效, 缺省为 0. 支持算法: 0 = NONE, 1 = MD5, 2 = SHA1, 3 = SHA224, 4 = SHA256, 5 = SHA384, 6 = SHA512, 7 = RIPEMD160 to: pk, 指定验证方公钥, 仅在 ecsdsa 或 sm2 时有效 format: "der", 指定签名格式, 可选为 der 和 raw, 缺省为 der }

toString

개체의 문자열 표현을 반환하고 일반적으로 "[네이티브 개체]"를 반환하며 개체는 자체 특성에 따라 다시 구현될 수 있습니다.

1
String PKey.toString();

반환 결과:

  • String, 객체의 문자열 표현을 반환합니다.

toJSON

개체의 JSON 형식 표현을 반환하며 일반적으로 개체에 의해 정의된 읽기 가능한 속성 모음을 반환합니다.

1
Value PKey.toJSON(String key = "");

호출 매개변수:

  • key: 문자열, 사용하지 않음

반환 결과:

  • Value, JSON 직렬화 가능 값을 반환합니다.