オブジェクト組み込みオブジェクト
  1. 表紙
  2. 組み込みオブジェクト
  3. オブジェクトPキー

オブジェクトPキー

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. quals(other): 2 つの公開キーと秘密キーが等しいかどうかを判断します。
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

相続関係

%0 object object toString() toJSON() PKey PKey new PKey() from() name keySize alg publicKey isPrivate() clone() pem() der() json() equals() encrypt() decrypt() sign() verify() object->PKey ECKey ECKey PKey->ECKey BlsKey BlsKey ECKey->BlsKey Ed25519Key Ed25519Key ECKey->Ed25519Key

コンストラクタ

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 の形式は、次の 4 種類の 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 の形式は、次の 4 種類の 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
readonly 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 // specify whether to output public key in compressed form
}

圧縮をサポートするカーブは次のとおりです: secp192r1、secp192k1、secp256r1、secp256k1、brainpoolP256r1、secp384r1、brainpoolP384r1、brainpoolP512r1、secp521r1、sm2

equals

2 つの公開キーと秘密キーを比較して、それらが同じかどうかを確認します

1
Boolean PKey.equals(object key);

呼び出しパラメータ:

  • key:object、相手の公開鍵/秘密鍵を指定します。

返される結果:

  • 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アルゴリズムが RSA の場合、入力パラメータは alg で指定されたアルゴリズムで実行される必要があります。hash
  • opts: オブジェクト、署名オプションを指定します

返される結果:

  • Buffer、署名されたデータを返します

opts は次のパラメータをサポートしています。

1
2
3
4
5
{
    alg: 0, // specify the hash algorithm for signing, only valid for RSA, default is 0. Supported algorithms: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
    format: "der", // specify the signature format, default is der, supported formats: der, raw
    recoverable: false // specify whether to return a recoverable signature, only valid for 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
{
    alg: 0, // specify the hash algorithm for signing, only valid for RSA, default is 0. Supported algorithms: 0=NONE,1=MD5,2=SHA1,3=SHA224,4=SHA256,5=SHA384,6=SHA512,7=RIPEMD160
    format: "der" // specify the signature format, default is der, supported formats: der, raw
}

toString

オブジェクトの文字列表現を返します。通常、「[Native Object]」が返されます。オブジェクトは、独自の特性に従って再実装できます。

1
String PKey.toString();

返される結果:

  • String、オブジェクトの文字列表現を返します。

toJSON

オブジェクトの JSON 形式表現を返します。通常は、オブジェクトによって定義された読み取り可能なプロパティのコレクションを返します。

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

呼び出しパラメータ:

  • key: 文字列、使用されません

返される結果:

  • Value、シリアル化可能な JSON を含む値を返します
© Copyright 2012-2024 fibjs.org |サポートしてください