Permalink
Browse files

doc: update doc of publicEncrypt method

As per #12946
the crypto doc for publicEncrypt doesn't tell
you whether the encryption happens in place or not.

Fixes: #12946
PR-URL: #12947
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
  • Loading branch information...
fhalde authored and addaleax committed May 10, 2017
1 parent ab34f9d commit eff9252181abe6ebd19252af652f29581711e665
Showing with 4 additions and 3 deletions.
  1. +4 −3 doc/api/crypto.md
View
@@ -1637,7 +1637,7 @@ treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`.
<!-- YAML
added: v1.1.0
-->
- `private_key` {Object | string}
- `public_key` {Object | string}
- `key` {string} A PEM encoded private key.
- `passphrase` {string} An optional passphrase for the private key.
- `padding` {crypto.constants} An optional padding value defined in
@@ -1657,15 +1657,16 @@ be passed instead of a public key.
<!-- YAML
added: v0.11.14
-->
- `private_key` {Object | string}
- `public_key` {Object | string}
- `key` {string} A PEM encoded private key.
- `passphrase` {string} An optional passphrase for the private 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`.
- `buffer` {Buffer | TypedArray | DataView}
Encrypts `buffer` with `public_key`.
Encrypts the content of `buffer` with `public_key` and returns a new
[`Buffer`][] with encrypted content.
`public_key` can be an object or a string. If `public_key` is a string, it is
treated as the key with no passphrase and will use `RSA_PKCS1_OAEP_PADDING`.

0 comments on commit eff9252

Please sign in to comment.