ObjectPKey
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, ecc. Ogni algoritmo di crittografia ha il proprio modo unico di generare e gestire le chiavi. L'oggetto PKey contiene anche attributi come il nome dell'algoritmo a cui appartiene la chiave e la lunghezza della chiave.
Di seguito sono riportati i metodi comuni di PKey e i relativi esempi:
- generateKey(alg | bits): genera una coppia di chiavi, alg specifica l'algoritmo della chiave, bits specifica la lunghezza della chiave e il valore predefinito è 2048.
1
2
3var crypto = require('crypto');
var pkey = crypto.generateKey(2048);
- from(value[, password]): carica la chiave in formato DER o PEM nell'oggetto PKey.
1
2
3var crypto = require('crypto');
var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));
- publicKey: ottiene la chiave pubblica della chiave corrente.
1
2
3
4var crypto = require('crypto');
var pkey = crypto.PKey.from(fs.readFile('rsa.private.pem'));
var pubkey = pkey.publicKey;
- equals(other): determina se due chiavi pubblica e privata sono uguali.
1
2
3
4
5var 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
Costruttore
PKey
Costruisci PKey dalla chiave in formato DER
1
2new PKey(Buffer DerKey,
String password = "");
Parametri di chiamata:
- DerKey:Buffer, digitare il formato DER
- password: Stringa, password di decrittazione
Costruisci PKey dalla chiave in formato PEM
1
2new PKey(String pemKey,
String password = "");
Parametri di chiamata:
- pemKey: stringa, chiave in formato PEM
- password: Stringa, password di decrittazione
Costruisci PKey dalla chiave in formato JSON
1new PKey(Object jsonKey);
Parametri di chiamata:
- jsonKey: Oggetto, chiave in formato JSON
Il formato di jsonKey supporta i seguenti quattro tipi di chiavi private 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 CE:
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
2static PKey PKey.from(Buffer DerKey,
String password = "");
Parametri di chiamata:
- DerKey:Buffer, digitare il formato DER
- password: Stringa, password di decrittazione
Risultati restituiti:
- PKey, restituisce un oggetto contenente la chiave
Carica una chiave in formato PEM
1
2static PKey PKey.from(String pemKey,
String password = "");
Parametri di chiamata:
- pemKey: stringa, chiave in formato PEM
- password: Stringa, password di decrittazione
Risultati restituiti:
- PKey, restituisce un oggetto contenente la chiave
Carica una chiave in formato JSON
1static PKey PKey.from(Object jsonKey);
Parametri di chiamata:
- jsonKey: Oggetto, chiave in formato JSON
Risultati restituiti:
- PKey, restituisce un oggetto contenente la chiave
Il formato di jsonKey supporta i seguenti quattro tipi di chiavi private 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 CE:
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"
}
proprietà dei membri
name
String, restituisce il nome dell'algoritmo corrente
1readonly String PKey.name;
keySize
Intero, restituisce la lunghezza della password dell'algoritmo corrente in bit
1readonly Integer PKey.keySize;
alg
Stringa, restituisce e imposta l'algoritmo di firma dell'oggetto corrente
1readonly String PKey.alg;
publicKey
PKey, restituisce la chiave pubblica della chiave corrente
1readonly PKey PKey.publicKey;
Risultati restituiti:
- la chiave pubblica della chiave corrente
funzione membro
isPrivate
Interroga se la chiave corrente è una chiave privata
1Boolean PKey.isPrivate();
Risultati restituiti:
- Boolean, è True e rappresenta la chiave privata
clone
copia la chiave corrente
1PKey PKey.clone();
Risultati restituiti:
- PKey, l'oggetto copia della chiave corrente
pem
Restituisce la codifica del formato PEM della chiave corrente
1String PKey.pem();
Risultati restituiti:
- String, Codifica del formato PEM della chiave corrente
der
Restituisce la codifica del formato DER della chiave corrente
1Buffer PKey.der();
Risultati restituiti:
- Buffer, la codifica del formato DER della chiave corrente
json
Restituisce la codifica del formato jwt della chiave corrente
1Object PKey.json(Object opts = {});
Parametri di chiamata:
- opts: Oggetto, specifica le opzioni di esportazione
Risultati restituiti:
- Object, la codifica del formato jwt della chiave corrente
opts supporta i seguenti parametri:
1
2
3{
compress: false // specify whether to output public key in compressed form
}
Le curve che supportano la compressione sono: secp192r1, secp192k1, secp256r1, secp256k1, brainpoolP256r1, secp384r1, brainpoolP384r1, brainpoolP512r1, secp521r1, sm2
equals
Confronta due chiavi pubblica/privata per vedere se sono la stessa cosa
1Boolean PKey.equals(object key);
Parametri di chiamata:
- key:object, specificare la chiave pubblica/privata dell'altra parte
Risultati restituiti:
- Boolean, se sono uguali, restituisce true
encrypt
Crittografare i dati utilizzando la chiave pubblica di crittografia dell'algoritmo corrente
1Buffer PKey.encrypt(Buffer data) async;
Parametri di chiamata:
- data:Buffer, specificare i dati da crittografare
Risultati restituiti:
- Buffer, restituisce i dati crittografati
decrypt
Decrittografare i dati utilizzando la chiave privata della password dell'algoritmo corrente
1Buffer PKey.decrypt(Buffer data) async;
Parametri di chiamata:
- data:Buffer, specificare i dati da decrittografare
Risultati restituiti:
- Buffer, restituisce i dati decrittografati
sign
Firmare i dati utilizzando la chiave privata crittografica dell'algoritmo corrente
1
2Buffer PKey.sign(Buffer data,
Object opts = {}) async;
Parametri di chiamata:
- data:Buffer, specificare i dati da firmare. Quando l'algoritmo è RSA, il parametro di input deve essere eseguito con l'algoritmo specificato da alg.hash
- opts: Oggetto, specifica le opzioni di firma
Risultati restituiti:
- Buffer, restituisce i dati firmati
opts supporta i seguenti parametri:
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
Verificare i dati utilizzando la chiave pubblica crittografica dell'algoritmo corrente
1
2
3Boolean PKey.verify(Buffer data,
Buffer sign,
Object opts = {}) async;
Parametri di chiamata:
- data:Buffer, specificare i dati da verificare
- sign:Buffer, specificare la firma da verificare
- opts: Oggetto, specifica le opzioni di verifica
Risultati restituiti:
- Boolean, restituisce il risultato verificato
opts supporta i seguenti parametri:
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
Restituisce la rappresentazione in formato stringa dell'oggetto. Generalmente viene restituito "[Oggetto nativo]". L'oggetto può essere reimplementato in base alle proprie caratteristiche.
1String PKey.toString();
Risultati restituiti:
- String, restituisce la rappresentazione di stringa dell'oggetto
toJSON
Restituisce una rappresentazione in formato JSON dell'oggetto, generalmente restituendo una raccolta di proprietà leggibili definite dall'oggetto.
1Value PKey.toJSON(String key = "");
Parametri di chiamata:
- key: Stringa, non utilizzata
Risultati restituiti:
- Value, restituisce un valore contenente JSON serializzabile