summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTobias Nießen <tniessen@tnie.de>2019-08-21 00:05:55 +0200
committerTobias Nießen <tniessen@tnie.de>2019-11-20 12:55:47 -0400
commitc63af4fea041673eb7c33f6df3c474d4537fe5eb (patch)
tree73e1942eb0ca50d5414fbe4619099c49d0666494 /doc
parent80efb80f3f9dffb412aa1a41ab36c843c90c60e5 (diff)
downloadandroid-node-v8-c63af4fea041673eb7c33f6df3c474d4537fe5eb.tar.gz
android-node-v8-c63af4fea041673eb7c33f6df3c474d4537fe5eb.tar.bz2
android-node-v8-c63af4fea041673eb7c33f6df3c474d4537fe5eb.zip
crypto: add support for IEEE-P1363 DSA signatures
PR-URL: https://github.com/nodejs/node/pull/29292 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/crypto.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index 91eefa7f16..6bf1dcea36 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -1405,6 +1405,7 @@ changes:
-->
* `privateKey` {Object | string | Buffer | KeyObject}
+ * `dsaEncoding` {string}
* `padding` {integer}
* `saltLength` {integer}
* `outputEncoding` {string} The [encoding][] of the return value.
@@ -1417,6 +1418,10 @@ If `privateKey` is not a [`KeyObject`][], this function behaves as if
`privateKey` had been passed to [`crypto.createPrivateKey()`][]. If it is an
object, the following additional properties can be passed:
+* `dsaEncoding` {string} For DSA and ECDSA, this option specifies the
+ format of the generated signature. It can be one of the following:
+ * `'der'` (default): DER-encoded ASN.1 signature structure encoding `(r, s)`.
+ * `'ieee-p1363'`: Signature format `r || s` as proposed in IEEE-P1363.
* `padding` {integer} Optional padding value for RSA, one of the following:
* `crypto.constants.RSA_PKCS1_PADDING` (default)
* `crypto.constants.RSA_PKCS1_PSS_PADDING`
@@ -1513,6 +1518,7 @@ changes:
-->
* `object` {Object | string | Buffer | KeyObject}
+ * `dsaEncoding` {string}
* `padding` {integer}
* `saltLength` {integer}
* `signature` {string | Buffer | TypedArray | DataView}
@@ -1526,6 +1532,10 @@ If `object` is not a [`KeyObject`][], this function behaves as if
`object` had been passed to [`crypto.createPublicKey()`][]. If it is an
object, the following additional properties can be passed:
+* `dsaEncoding` {string} For DSA and ECDSA, this option specifies the
+ format of the generated signature. It can be one of the following:
+ * `'der'` (default): DER-encoded ASN.1 signature structure encoding `(r, s)`.
+ * `'ieee-p1363'`: Signature format `r || s` as proposed in IEEE-P1363.
* `padding` {integer} Optional padding value for RSA, one of the following:
* `crypto.constants.RSA_PKCS1_PADDING` (default)
* `crypto.constants.RSA_PKCS1_PSS_PADDING`
@@ -2891,6 +2901,10 @@ If `key` is not a [`KeyObject`][], this function behaves as if `key` had been
passed to [`crypto.createPrivateKey()`][]. If it is an object, the following
additional properties can be passed:
+* `dsaEncoding` {string} For DSA and ECDSA, this option specifies the
+ format of the generated signature. It can be one of the following:
+ * `'der'` (default): DER-encoded ASN.1 signature structure encoding `(r, s)`.
+ * `'ieee-p1363'`: Signature format `r || s` as proposed in IEEE-P1363.
* `padding` {integer} Optional padding value for RSA, one of the following:
* `crypto.constants.RSA_PKCS1_PADDING` (default)
* `crypto.constants.RSA_PKCS1_PSS_PADDING`
@@ -2944,6 +2958,10 @@ If `key` is not a [`KeyObject`][], this function behaves as if `key` had been
passed to [`crypto.createPublicKey()`][]. If it is an object, the following
additional properties can be passed:
+* `dsaEncoding` {string} For DSA and ECDSA, this option specifies the
+ format of the generated signature. It can be one of the following:
+ * `'der'` (default): DER-encoded ASN.1 signature structure encoding `(r, s)`.
+ * `'ieee-p1363'`: Signature format `r || s` as proposed in IEEE-P1363.
* `padding` {integer} Optional padding value for RSA, one of the following:
* `crypto.constants.RSA_PKCS1_PADDING` (default)
* `crypto.constants.RSA_PKCS1_PSS_PADDING`