Commit 7475541
doc: fix: correctly use public key instead of private key
Although, as docs mention, private keys can be used instead of
public keys, I presume that these parameter explanations
should be corrected.
Fixes: #13633
PR-URL: #16038
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>1 parent 0ae84c2 commit 7475541
1 file changed
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1661,8 +1661,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`. | |||
| 1661 | 1661 | added: v1.1.0 | |
| 1662 | 1662 | --> | |
| 1663 | 1663 | - `publicKey` {Object | string} | |
| 1664 | - - `key` {string} A PEM encoded private key. | ||
| 1665 | - - `passphrase` {string} An optional passphrase for the private key. | ||
| 1664 | + - `key` {string} A PEM encoded public key. | ||
| 1665 | + - `passphrase` {string} An optional passphrase for the public key. | ||
| 1666 | 1666 | - `padding` {crypto.constants} An optional padding value defined in | |
| 1667 | 1667 | `crypto.constants`, which may be: `crypto.constants.RSA_NO_PADDING` or | |
| 1668 | 1668 | `RSA_PKCS1_PADDING`. | |
@@ -1681,8 +1681,8 @@ be passed instead of a public key. | |||
| 1681 | 1681 | added: v0.11.14 | |
| 1682 | 1682 | --> | |
| 1683 | 1683 | - `publicKey` {Object | string} | |
| 1684 | - - `key` {string} A PEM encoded private key. | ||
| 1685 | - - `passphrase` {string} An optional passphrase for the private key. | ||
| 1684 | + - `key` {string} A PEM encoded public key. | ||
| 1685 | + - `passphrase` {string} An optional passphrase for the public key. | ||
| 1686 | 1686 | - `padding` {crypto.constants} An optional padding value defined in | |
| 1687 | 1687 | `crypto.constants`, which may be: `crypto.constants.RSA_NO_PADDING`, | |
| 1688 | 1688 | `RSA_PKCS1_PADDING`, or `crypto.constants.RSA_PKCS1_OAEP_PADDING`. | |
0 commit comments