オブジェクト Ed25519Key

楕円曲線暗号オブジェクト

次の例は、Ed25519Key の使用法を示しています。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
const crypto = require('crypto');

// generate a ed25519 key
const key = crypto.generateKey('ed25519');

// output key in PEM format
console.log('PrivateKey:', key.pem());
console.log('PublicKey:', key.publicKey.pem());

// sign a message
const message = 'Hello, World!';
const sig = key.sign(message);
console.log('Sig:', sig.hex());

// verify the signature
const verifyResult = key.verify(message, sig);
console.log('Verify Result:', verifyResult);

相続関係

静的関数

recover

回復可能な署名から公開鍵を回復します。secp256k1 のみがサポートされています

1
2
static ECKey Ed25519Key.recover(Buffer data,
    Buffer sig) async;

呼び出しパラメーター:

• data:Buffer、署名の元のデータ
• sig:Buffer、回復可能な署名

戻り値:

• ECKey、公開鍵を含むオブジェクトを返します

---

from

DER 形式でキーをロードする

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

呼び出しパラメーター:

• DerKey:Buffer、DER 形式のキー
• password: 文字列、復号化されたパスワード

戻り値:

• PKey、キーを含むオブジェクトを返します

---

キーを PEM 形式でロードする

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

呼び出しパラメーター:

• pemKey: 文字列、PEM 形式のキー
• password: 文字列、復号化されたパスワード

戻り値:

• PKey、キーを含むオブジェクトを返します

---

JSON 形式でキーをロードする

1
static PKey Ed25519Key.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"
}

メンバー属性

curve

文字列、現在のアルゴリズムの楕円曲線名を返します

1
readonly String Ed25519Key.curve;

---

name

文字列、現在のアルゴリズム名を返します

1
readonly String Ed25519Key.name;

---

keySize

整数、現在のアルゴリズムのパスワード長をビット単位で返します

1
readonly Integer Ed25519Key.keySize;

---

alg

現在のオブジェクトの署名アルゴリズムを返し、設定する文字列

1
String Ed25519Key.alg;

---

publicKey

PKey、現在の鍵の公開鍵を返します

1
readonly PKey Ed25519Key.publicKey;

戻り値:

• 現在の鍵の公開鍵

メンバー関数

toX25519

X25519 の公開鍵と秘密鍵のペアを現在のオブジェクトから変換します。Ed25519 のみがサポートされています

1
ECKey Ed25519Key.toX25519() async;

戻り値:

• ECKey、対応する X25519 公開鍵オブジェクトを返します

---

computeSecret

現在のアルゴリズムを使用して楕円曲線 Diffie-Hellman (ECDH) 共有シークレットを計算します

1
Buffer Ed25519Key.computeSecret(ECKey publicKey) async;

呼び出しパラメーター:

• publicKey:ECKey、相手方の公開鍵を指定

戻り値:

• Buffer、計算された共有シークレットを返します

---

isPrivate

現在の鍵が秘密鍵かどうかを問い合わせる

1
Boolean Ed25519Key.isPrivate();

戻り値:

• Boolean、True が秘密鍵を意味する場合

---

clone

現在のキーをコピー

1
PKey Ed25519Key.clone();

戻り値:

• PKey、現在のキーのコピー オブジェクト

---

pem

現在のキーの PEM 形式のエンコーディングを返します

1
String Ed25519Key.pem();

戻り値:

• String、現在のキーの PEM 形式のエンコーディング

---

der

現在のキーの DER 形式のエンコーディングを返します

1
Buffer Ed25519Key.der();

戻り値:

• Buffer、現在の鍵の DER 形式のエンコード

---

json

現在のキーの jwt 形式のエンコーディングを返します

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

呼び出しパラメーター:

• opts: オブジェクト、書き出しオプションを指定

戻り値:

• Object、現在のキーの jwt 形式のエンコーディング

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

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

圧縮をサポートする曲線は次のとおりです。

---

equals

2 つの公開鍵と秘密鍵が同じかどうかを比較する

1
Boolean Ed25519Key.equals(PKey key);

呼び出しパラメーター:

• key:PKey、相手の公開鍵・秘密鍵を指定

戻り値:

• Boolean、同じ場合は true を返します

---

encrypt

現在のアルゴリズムの暗号化公開鍵を使用してデータを暗号化する

1
Buffer Ed25519Key.encrypt(Buffer data) async;

呼び出しパラメーター:

• data:Buffer、暗号化するデータを指定します

戻り値:

• Buffer、暗号化されたデータを返します

---

decrypt

現在のアルゴリズムの暗号化秘密鍵を使用してデータを復号化する

1
Buffer Ed25519Key.decrypt(Buffer data) async;

呼び出しパラメーター:

• data:Buffer、復号化するデータを指定します

戻り値:

• Buffer、復号化されたデータを返します

---

sign

現在のアルゴリズムの暗号化秘密鍵を使用してデータに署名する

1
2
Buffer Ed25519Key.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 Ed25519Key.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

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

1
String Ed25519Key.toString();

戻り値:

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

---

toJSON

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

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

呼び出しパラメーター:

• key: 文字列、未使用

戻り値:

• Value、JSON シリアル化可能な値を返します