Skip to content

Commit

Permalink
doc: fix: correctly use public key instead of private key
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
pomerantsev authored and MylesBorins committed Oct 11, 2017
1 parent 0ae84c2 commit 7475541
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -1661,8 +1661,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`.
added: v1.1.0
-->
- `publicKey` {Object | string}
- `key` {string} A PEM encoded private key.
- `passphrase` {string} An optional passphrase for the private key.
- `key` {string} A PEM encoded public key.
- `passphrase` {string} An optional passphrase for the public key.
- `padding` {crypto.constants} An optional padding value defined in
`crypto.constants`, which may be: `crypto.constants.RSA_NO_PADDING` or
`RSA_PKCS1_PADDING`.
Expand All @@ -1681,8 +1681,8 @@ be passed instead of a public key.
added: v0.11.14
-->
- `publicKey` {Object | string}
- `key` {string} A PEM encoded private key.
- `passphrase` {string} An optional passphrase for the private key.
- `key` {string} A PEM encoded public key.
- `passphrase` {string} An optional passphrase for the public key.
- `padding` {crypto.constants} An optional padding value defined in
`crypto.constants`, which may be: `crypto.constants.RSA_NO_PADDING`,
`RSA_PKCS1_PADDING`, or `crypto.constants.RSA_PKCS1_OAEP_PADDING`.
Expand Down

0 comments on commit 7475541

Please sign in to comment.