FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: public keys don't accept passphrases by bnoordhuis · Pull Request #16087 · nodejs/node · GitHub

/ node Public

doc: public keys don't accept passphrases - #16087

Closed
bnoordhuis wants to merge 1 commit into
nodejs:masterfrom
bnoordhuis:undocument-passphrase-option
ConversationCommits (1)ChecksFiles changed
Closed

doc: public keys don't accept passphrases#16087
bnoordhuis wants to merge 1 commit into
nodejs:masterfrom
bnoordhuis:undocument-passphrase-option

Conversation

bnoordhuis commented Oct 8, 2017

Copy link
Copy Markdown
Member

While crypto.publicDecrypt() and crypto.publicEncrypt() do accept a
passphrase option, the C++ code simply ignores it because OpenSSL does
not support it for public keys. Undocument the option.

Refs: #16038

nodejs-github-bot added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Oct 8, 2017
bnoordhuis mentioned this pull request Oct 8, 2017
Closed
2 tasks
addaleax requested review from seishun and tniessen October 8, 2017 15:41
seishun suggested changes Oct 8, 2017
View reviewed changes

seishun left a comment •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

While crypto.publicDecrypt() and crypto.publicEncrypt() do accept a passphrase option, the C++ code simply ignores it because OpenSSL does not support it for public keys.

It does support it for private keys, and you can call both crypto.publicDecrypt() and crypto.publicEncrypt() with a private key, which will fail if it's encrypted and you don't provide a passphrase.

> var key = fs.readFileSync('private.pem', {encoding: 'ascii'});
> var data  = new Buffer(15)
> crypto.publicEncrypt(key, data)
Error: error:06065064:digital envelope routines:EVP_DecryptFinal_ex:bad decrypt
    at Object.publicEncrypt (crypto.js:388:12)
    at repl:1:8
    at ContextifyScript.Script.runInThisContext (vm.js:44:33)
    at REPLServer.defaultEval (repl.js:239:29)
    at bound (domain.js:301:14)
    at REPLServer.runBound [as eval] (domain.js:314:12)
    at REPLServer.onLine (repl.js:433:10)
    at emitOne (events.js:120:20)
    at REPLServer.emit (events.js:210:7)
    at REPLServer.Interface._onLine (readline.js:278:10)
> crypto.publicEncrypt({ key: key, passphrase: 'whatever'}, data)
<Buffer 74 49 d9 b7 6b fe 8a 1a 53 0d c2 46 8f 75 7c b4 34 cf f0 4a b6 11 df 43 c8 8b e2 bc 1c f1 30 cd 95 2a 19 2f 82 87 4f 4f 6a 15 ca b5 16 9c 23 1c f5 8f ... >
>

doc: public keys don't accept passphrases
3cdd070 
Since `crypto.publicDecrypt()` and `crypto.publicEncrypt()` accept both
public and private keys, make it clear that the `passphrase` option only
applies to private keys.

Refs: nodejs#16038
bnoordhuis force-pushed the undocument-passphrase-option branch from b60a804 to 3cdd070 Compare October 8, 2017 17:38

bnoordhuis commented Oct 8, 2017

Copy link
Copy Markdown
Member Author

Okay, fair enough. I rewrote it more rigorously, PTAL.

jasnell pushed a commit that referenced this pull request Oct 18, 2017
doc: public keys don't accept passphrases
3469eb9 
Since `crypto.publicDecrypt()` and `crypto.publicEncrypt()` accept both
public and private keys, make it clear that the `passphrase` option only
applies to private keys.

PR-URL: #16087
Ref: #16038
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

jasnell commented Oct 18, 2017

Copy link
Copy Markdown
Member

Landed in 3469eb9

jasnell closed this Oct 18, 2017
targos pushed a commit that referenced this pull request Oct 18, 2017
doc: public keys don't accept passphrases
e34509e 
Since `crypto.publicDecrypt()` and `crypto.publicEncrypt()` accept both
public and private keys, make it clear that the `passphrase` option only
applies to private keys.

PR-URL: #16087
Ref: #16038
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
addaleax pushed a commit to ayojs/ayo that referenced this pull request Oct 26, 2017
doc: public keys don't accept passphrases
76e0ecb 
Since `crypto.publicDecrypt()` and `crypto.publicEncrypt()` accept both
public and private keys, make it clear that the `passphrase` option only
applies to private keys.

PR-URL: nodejs/node#16087
Ref: nodejs/node#16038
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
addaleax pushed a commit to ayojs/ayo that referenced this pull request Dec 7, 2017
doc: public keys don't accept passphrases
dca3ef6 
Since `crypto.publicDecrypt()` and `crypto.publicEncrypt()` accept both
public and private keys, make it clear that the `passphrase` option only
applies to private keys.

PR-URL: nodejs/node#16087
Ref: nodejs/node#16038
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MarcelRaschke mentioned this pull request Aug 19, 2022
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jasnell jasnell approved these changes
addaleax addaleax approved these changes
cjihrig cjihrig approved these changes
tniessen tniessen approved these changes
BridgeAR BridgeAR approved these changes
+2 more reviewers
danbev danbev approved these changes
seishun seishun approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

10 participants

Back | FazBrowse Home | New Git URL