オブジェクトEd25519Key
楕円曲線暗号化アルゴリズム オブジェクト
次の例は、Ed25519Key の使用法を示しています。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17const 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
2static ECKey Ed25519Key.recover(Buffer data,
Buffer sig) async;
呼び出しパラメータ:
返される結果:
- ECKey、公開キーを含むオブジェクトを返します。
from
DER 形式でキーをロードする
1
2static PKey Ed25519Key.from(Buffer DerKey,
String password = "");
呼び出しパラメータ:
- DerKey:Buffer, DER 形式のキー
- password: 文字列、復号化パスワード
返される結果:
- PKey、キーを含むオブジェクトを返します。
PEM 形式でキーをロードする
1
2static PKey Ed25519Key.from(String pemKey,
String password = "");
呼び出しパラメータ:
- pemKey: PEM 形式の文字列、キー
- password: 文字列、復号化パスワード
返される結果:
- PKey、キーを含むオブジェクトを返します。
JSON形式でキーをロードします
1static 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
文字列。現在のアルゴリズムの楕円曲線名を返します。
1readonly String Ed25519Key.curve;
name
文字列、現在のアルゴリズム名を返します
1readonly String Ed25519Key.name;
keySize
整数。現在のアルゴリズムのパスワードの長さをビット単位で返します。
1readonly Integer Ed25519Key.keySize;
alg
文字列。現在のオブジェクト署名アルゴリズムを返し、設定します。
1readonly String Ed25519Key.alg;
publicKey
PKey、現在のキーの公開キーを返します。
1readonly PKey Ed25519Key.publicKey;
返される結果:
- 現在の鍵の公開鍵
メンバー関数
toX25519
現在のオブジェクトから X25519 公開鍵と秘密鍵のペアを変換します。Ed25519 のみをサポートします
1ECKey Ed25519Key.toX25519() async;
返される結果:
- ECKey、対応する X25519 公開キー オブジェクトを返します。
computeSecret
現在のアルゴリズムを使用して楕円曲線 Diffie-Hellman (ECDH) 共有キーを計算します。
1Buffer Ed25519Key.computeSecret(ECKey publicKey) async;
呼び出しパラメータ:
- publicKey:ECKey、相手の公開鍵を指定します
返される結果:
- Buffer、計算された共有秘密キーを返します。
isPrivate
現在のキーが秘密キーであるかどうかを問い合わせます
1Boolean Ed25519Key.isPrivate();
返される結果:
- Boolean、 True であり、秘密キーを表します
clone
現在のキーをコピーする
1PKey Ed25519Key.clone();
返される結果:
- PKey、現在のキーのコピー オブジェクト
pem
現在のキーの PEM 形式エンコーディングを返します。
1String Ed25519Key.pem();
返される結果:
- String、現在のキーの PEM 形式エンコーディング
der
現在のキーの DER 形式エンコーディングを返します。
1Buffer Ed25519Key.der();
返される結果:
- Buffer、現在のキーの DER 形式エンコーディング
json
現在のキーの jwt 形式のエンコーディングを返します。
1Object Ed25519Key.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 つの公開キーと秘密キーを比較して、それらが同じかどうかを確認します
1Boolean Ed25519Key.equals(object key);
呼び出しパラメータ:
- key:object、相手の公開鍵/秘密鍵を指定します。
返される結果:
- Boolean、同じ場合は true を返します
encrypt
現在のアルゴリズム暗号公開キーを使用してデータを暗号化する
1Buffer Ed25519Key.encrypt(Buffer data) async;
呼び出しパラメータ:
- data:Buffer、暗号化するデータを指定します
返される結果:
- Buffer、暗号化されたデータを返します
decrypt
現在のアルゴリズムのパスワード秘密キーを使用してデータを復号化する
1Buffer Ed25519Key.decrypt(Buffer data) async;
呼び出しパラメータ:
- data:Buffer、復号化するデータを指定します
返される結果:
- Buffer、復号化されたデータを返します
sign
現在のアルゴリズムの暗号化秘密キーを使用してデータに署名する
1
2Buffer Ed25519Key.sign(Buffer data,
Object opts = {}) async;
呼び出しパラメータ:
返される結果:
- 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
3Boolean Ed25519Key.verify(Buffer data,
Buffer sign,
Object opts = {}) async;
呼び出しパラメータ:
返される結果:
- 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]」が返されます。オブジェクトは、独自の特性に従って再実装できます。
1String Ed25519Key.toString();
返される結果:
- String、オブジェクトの文字列表現を返します。
toJSON
オブジェクトの JSON 形式表現を返します。通常は、オブジェクトによって定義された読み取り可能なプロパティのコレクションを返します。
1Value Ed25519Key.toJSON(String key = "");
呼び出しパラメータ:
- key: 文字列、使用されません
返される結果:
- Value、シリアル化可能な JSON を含む値を返します