Oggetto oggetto incorporato
  1. prima pagina
  2. oggetto integrato
  3. oggettoPKey

oggettoPKey

PKey è integratocryptoUn oggetto fornito dal modulo che rappresenta una coppia di chiavi: una chiave pubblica e una chiave privata. PKey supporta la generazione di chiavi, il caricamento di chiavi, l'archiviazione di chiavi e la gestione del processo di crittografia in JS

L'oggetto PKey supporta più algoritmi di crittografia, come RSA, EC o Ed25519, e ogni algoritmo di crittografia ha i propri metodi di generazione e gestione delle chiavi univoci. L'oggetto PKey contiene anche attributi come il nome dell'algoritmo a cui appartiene la chiave e la lunghezza della chiave.

I seguenti sono metodi comuni di PKey e i relativi esempi:

  1. generateKey(alg | bits): genera una coppia di chiavi, alg specifica l'algoritmo della chiave, bits specifica la lunghezza della chiave, il valore predefinito è 2048.
1
2
3
var crypto = require('crypto');

var pkey = crypto.generateKey(2048);
  1. from(value[, password]): carica una chiave in formato DER o PEM in un oggetto PKey.
1
2
3
var crypto = require('crypto');

var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));
  1. publicKey: ottiene la chiave pubblica della chiave corrente.
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): determina se le due chiavi pubblica e privata sono uguali.
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

rapporto ereditario

%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

Costruttore

PKey

Costruisci una PKey da una chiave in formato DER

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

Parametri di chiamata:

  • DerKey:Buffer, la chiave in formato DER
  • password: stringa, password decrittografata

Costruisci una PKey da una chiave in formato PEM

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

Parametri di chiamata:

  • pemKey: Stringa, digita in formato PEM
  • password: stringa, password decrittografata

Costruisci una PKey da una chiave in formato JSON

1
new PKey(Object jsonKey);

Parametri di chiamata:

  • jsonKey: Oggetto, digita in formato JSON

Il formato di jsonKey supporta i seguenti quattro tipi di chiave privata 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=="
}

Chiave pubblica RSA:

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

Chiave privata 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"
}

Chiave pubblica CE:

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

funzione statica

from

Carica una chiave in formato DER

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

Parametri di chiamata:

  • DerKey:Buffer, la chiave in formato DER
  • password: stringa, password decrittografata

risultato di ritorno:

  • PKey, restituisce un oggetto contenente la chiave

Carica una chiave in formato PEM

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

Parametri di chiamata:

  • pemKey: Stringa, digita in formato PEM
  • password: stringa, password decrittografata

risultato di ritorno:

  • PKey, restituisce un oggetto contenente la chiave

Carica una chiave in formato JSON

1
static PKey PKey.from(Object jsonKey);

Parametri di chiamata:

  • jsonKey: Oggetto, digita in formato JSON

risultato di ritorno:

  • PKey, restituisce un oggetto contenente la chiave

Il formato di jsonKey supporta i seguenti quattro tipi di chiave privata 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=="
}

Chiave pubblica RSA:

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

Chiave privata 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"
}

Chiave pubblica CE:

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

attributo membro

name

Stringa, restituisce il nome dell'algoritmo corrente

1
readonly String PKey.name;

keySize

Intero, restituisce la lunghezza della password dell'algoritmo corrente in bit

1
readonly Integer PKey.keySize;

alg

String, restituisce e imposta l'algoritmo di firma dell'oggetto corrente

1
String PKey.alg;

publicKey

PKey, restituisce la chiave pubblica della chiave corrente

1
readonly PKey PKey.publicKey;

risultato di ritorno:

  • la chiave pubblica della chiave corrente

funzione membro

isPrivate

Interroga se la chiave corrente è una chiave privata

1
Boolean PKey.isPrivate();

risultato di ritorno:

  • Boolean, se True significa chiave privata

clone

copia la chiave corrente

1
PKey PKey.clone();

risultato di ritorno:

  • PKey, l'oggetto copia della chiave corrente

pem

Restituisce la codifica del formato PEM della chiave corrente

1
String PKey.pem();

risultato di ritorno:

  • String, la codifica del formato PEM della chiave corrente

der

Restituisce la codifica del formato DER della chiave corrente

1
Buffer PKey.der();

risultato di ritorno:

  • Buffer, la codifica del formato DER della chiave corrente

json

Restituisce la codifica in formato jwt della chiave corrente

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

Parametri di chiamata:

  • opts: Oggetto, specifica le opzioni di esportazione

risultato di ritorno:

  • Object, la codifica del formato jwt della chiave corrente

opts supporta i seguenti parametri:

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

Le curve che supportano la compressione sono: secp192r1, secp192k1, secp256r1, secp256k1, brainpoolP256r1, secp384r1, brainpoolP384r1, brainpoolP512r1, secp521r1, sm2

equals

Confronta se due chiavi pubbliche/private sono uguali

1
Boolean PKey.equals(PKey key);

Parametri di chiamata:

  • key: PKey, specifica la chiave pubblica/privata dell'altra parte

risultato di ritorno:

  • Boolean, restituisce true se uguale

encrypt

Crittografare i dati utilizzando la chiave pubblica crittografica dell'algoritmo corrente

1
Buffer PKey.encrypt(Buffer data) async;

Parametri di chiamata:

  • data:Buffer, specifica i dati da crittografare

risultato di ritorno:

  • Buffer, restituisce i dati crittografati

decrypt

Decrittografare i dati utilizzando la chiave privata crittografica dell'algoritmo corrente

1
Buffer PKey.decrypt(Buffer data) async;

Parametri di chiamata:

  • data:Buffer, specifica i dati da decrittografare

risultato di ritorno:

  • Buffer, restituisce i dati decrittografati

sign

Firma i dati utilizzando la chiave privata crittografica dell'algoritmo corrente

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

Parametri di chiamata:

  • data:Buffer, specifica i dati da firmare
  • opts: Oggetto, specifica le opzioni di firma

risultato di ritorno:

  • Buffer, restituisce i dati firmati

opts supporta i seguenti parametri:

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

Verificare i dati utilizzando la chiave pubblica crittografica dell'algoritmo corrente

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

Parametri di chiamata:

  • data:Buffer, specificando i dati da convalidare
  • sign:Buffer, specificando la firma da verificare
  • opts: Oggetto, specifica le opzioni di autenticazione

risultato di ritorno:

  • Boolean, restituisce il risultato verificato

opts supporta i seguenti parametri:

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

Restituisce la rappresentazione in stringa dell'oggetto, generalmente restituisce "[Native Object]", l'oggetto può essere reimplementato secondo le proprie caratteristiche

1
String PKey.toString();

risultato di ritorno:

  • String, restituisce una rappresentazione in forma di stringa dell'oggetto

toJSON

Restituisce la rappresentazione in formato JSON dell'oggetto, in genere restituisce una raccolta di proprietà leggibili definite dall'oggetto

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

Parametri di chiamata:

  • key: stringa, non utilizzata

risultato di ritorno:

  • Value, che restituisce un valore serializzabile in JSON
© Copyright 2012-2021 fibjs.org | Sostienici