e09d505103
## Review A dedicated reviewer checked the rule description successfully for: - [x] logical errors and incorrect information - [x] information gaps and missing content - [x] text style and tone - [x] PR summary and labels follow [the guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule) --------- Co-authored-by: hendrik-buchwald-sonarsource <64110887+hendrik-buchwald-sonarsource@users.noreply.github.com>
116 lines
2.7 KiB
Plaintext
116 lines
2.7 KiB
Plaintext
== How to fix it in Node.js
|
|
|
|
=== Code examples
|
|
|
|
include::../../common/fix/code-rationale.adoc[]
|
|
|
|
==== Noncompliant code example
|
|
|
|
include::../../common/fix/rsa.adoc[]
|
|
|
|
[source,javascript,diff-id=1,diff-type=noncompliant]
|
|
----
|
|
const crypto = require('crypto');
|
|
|
|
function callback(err, pub, priv) {}
|
|
|
|
var { privateKey, publicKey } = crypto.generateKeyPairSync('rsa', {
|
|
modulusLength: 1024, // Noncompliant
|
|
publicKeyEncoding: { type: 'spki', format: 'pem' },
|
|
privateKeyEncoding: { type: 'pkcs8', format: 'pem' }
|
|
},
|
|
callback);
|
|
----
|
|
|
|
include::../../common/fix/dsa.adoc[]
|
|
|
|
[source,javascript,diff-id=2,diff-type=noncompliant]
|
|
----
|
|
const crypto = require('crypto');
|
|
|
|
function callback(err, pub, priv) {}
|
|
|
|
var { privateKey, publicKey } = crypto.generateKeyPairSync('dsa', {
|
|
modulusLength: 1024, // Noncompliant
|
|
publicKeyEncoding: { type: 'spki', format: 'pem' },
|
|
privateKeyEncoding: { type: 'pkcs8', format: 'pem' }
|
|
},
|
|
callback);
|
|
----
|
|
|
|
|
|
include::../../common/fix/ec.adoc[]
|
|
|
|
[source,javascript,diff-id=3,diff-type=noncompliant]
|
|
----
|
|
const crypto = require('crypto');
|
|
|
|
function callback(err, pub, priv) {}
|
|
|
|
var { privateKey, publicKey } = crypto.generateKeyPair('ec', {
|
|
namedCurve: 'secp112r2', // Noncompliant
|
|
publicKeyEncoding: { type: 'spki', format: 'pem' },
|
|
privateKeyEncoding: { type: 'pkcs8', format: 'pem' }
|
|
},
|
|
callback);
|
|
----
|
|
|
|
==== Compliant solution
|
|
|
|
include::../../common/fix/rsa.adoc[]
|
|
|
|
[source,javascript,diff-id=1,diff-type=compliant]
|
|
----
|
|
const crypto = require('crypto');
|
|
|
|
function callback(err, pub, priv) {}
|
|
|
|
var { privateKey, publicKey } = crypto.generateKeyPairSync('rsa', {
|
|
modulusLength: 2048,
|
|
publicKeyEncoding: { type: 'spki', format: 'pem' },
|
|
privateKeyEncoding: { type: 'pkcs8', format: 'pem' }
|
|
},
|
|
callback);
|
|
----
|
|
|
|
include::../../common/fix/dsa.adoc[]
|
|
|
|
[source,javascript,diff-id=2,diff-type=compliant]
|
|
----
|
|
const crypto = require('crypto');
|
|
|
|
function callback(err, pub, priv) {}
|
|
|
|
var { privateKey, publicKey } = crypto.generateKeyPairSync('dsa', {
|
|
modulusLength: 2048,
|
|
publicKeyEncoding: { type: 'spki', format: 'pem' },
|
|
privateKeyEncoding: { type: 'pkcs8', format: 'pem' }
|
|
},
|
|
callback);
|
|
----
|
|
|
|
|
|
include::../../common/fix/ec.adoc[]
|
|
|
|
[source,javascript,diff-id=3,diff-type=compliant]
|
|
----
|
|
const crypto = require('crypto');
|
|
|
|
function callback(err, pub, priv) {}
|
|
|
|
var { privateKey, publicKey } = crypto.generateKeyPair('ec', {
|
|
namedCurve: 'secp224k1',
|
|
publicKeyEncoding: { type: 'spki', format: 'pem' },
|
|
privateKeyEncoding: { type: 'pkcs8', format: 'pem' }
|
|
},
|
|
callback);
|
|
----
|
|
|
|
=== How does this work?
|
|
|
|
include::../../common/fix/fix.adoc[]
|
|
|
|
=== Going the extra mile
|
|
|
|
include::../../common/extra-mile/pre-quantum.adoc[]
|