src: split CryptoPemCallback into two functions #12827

danbev · 2017-05-04T12:56:11Z

Currently the function CryptoPemCallback is used for two things:

As a passphrase callback.
To avoid the default OpenSSL passphrase routine.

The default OpenSSL passphase routine would apply if both
the callback and the passphrase are null pointers and the typical
behaviour is to prompt for the passphase which is not appropriate in
node.

This commit suggests that the PasswordCallback function only handle
passphrases, and that an additional function named NoPasswordCallback
used for the second case to avoid OpenSSL's passphase routine.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
commit message follows commit guidelines

Affected core subsystem(s)

src

Currently the function CryptoPemCallback is used for two things: 1. As a passphrase callback. 2. To avoid the default OpenSSL passphrase routine. The default OpenSSL passphase routine would apply if both the callback and the passphrase are null pointers and the typical behaviour is to prompt for the passphase which is not appropriate in node. This commit suggests that the PasswordCallback function only handle passphrases, and that an additional function named NoPasswordCallback used for the second case to avoid OpenSSL's passphase routine.

danbev · 2017-05-04T12:56:48Z

CI: https://ci.nodejs.org/job/node-test-pull-request/7848/

cjihrig

LGTM, but @shigeki should probably take a look.

mscdex · 2017-05-04T19:30:22Z

/cc @nodejs/crypto

indutny

I like this direction, let's do it! Few nits, though.

indutny · 2017-05-04T19:41:13Z

src/node_crypto.cc

+  len = len > buflen ? buflen : len;
+  memcpy(buf, u, len);
+  return len;
+}



Please add one more newline here, please.

I'll fix that.

indutny · 2017-05-04T19:42:08Z

src/node_crypto.cc

@@ -473,7 +475,7 @@ void SecureContext::SetKey(const FunctionCallbackInfo<Value>& args) {

  if (len == 2) {
    if (args[1]->IsUndefined() || args[1]->IsNull())
-      len = 1;
+      has_password = false;
    else
      THROW_AND_RETURN_IF_NOT_STRING(args[1], "Pass phrase");
  }


What if len == 1 from the start? It looks like has_password will be true?

Oh yes, sorry. Let me fix that. Thanks

danbev · 2017-05-05T08:03:36Z

CI: https://ci.nodejs.org/job/node-test-pull-request/7881/

sam-github · 2017-05-05T14:41:30Z

src/node_crypto.cc

-    memcpy(buf, u, len);
-    return len;
-  }
+  CHECK_NE(u, nullptr);


consider bringing back the conditional... EDIT: ... because it simplifies code, see below.

@sam-github why?

sam-github · 2017-05-05T14:44:01Z

src/node_crypto.cc

@@ -482,12 +485,13 @@ void SecureContext::SetKey(const FunctionCallbackInfo<Value>& args) {
  if (!bio)
    return;

-  node::Utf8Value passphrase(env->isolate(), args[1]);
-
+  auto callback = has_password ? PasswordCallback : NoPasswordCallback;


... because it really simplifies this code.

This function uses the password cb because it may have a password.

The other examples below that use NoPasswordCallback I agree are more clear because the usage makes it really clear that there is no password, but I think here it is unnecessarily complex, caused only because the PasswordCallback stopped supporting an empty password.

Ah, I see. 👍

Sorry, for the unnecessarily obscure comments.

Fair point. Let me restore the original allowing a null passphrase but keep the NoPasswordCallback for this.

sam-github · 2017-05-06T09:49:26Z

src/node_crypto.cc

@@ -243,6 +241,13 @@ static int PasswordCallback(char *buf, int size, int rwflag, void *u) {
 }


+// This callback is used to avoid the default passphrase callback in OpenSSL
+// which will typically prompt for the passphrase.


"the prompting is designed for the openssl CLI, but works poorly for Node.js because it involves synchronous interaction with the controlling terminal, something we never want, and use this function to avoid." <--- Maybe add something like that?

I've added that now, thanks!

addaleax

Just reaffirming my LGTM for the latest changes

danbev · 2017-05-09T11:26:50Z

@indutny Would you mind taking a look and see what you think now? Your requested changes have been added (really only became the extra line as the other was reverted following the suggestions by sam-github). Thanks

danbev · 2017-05-12T06:40:47Z

@indutny Sorry about nagging, just wanted to ask again if you have anything against this landing?

addressed

addaleax · 2017-05-18T22:18:24Z

Landed in 29d89c9

Currently the function CryptoPemCallback is used for two things: 1. As a passphrase callback. 2. To avoid the default OpenSSL passphrase routine. The default OpenSSL passphase routine would apply if both the callback and the passphrase are null pointers and the typical behaviour is to prompt for the passphase which is not appropriate in node. This commit suggests that the PasswordCallback function only handle passphrases, and that an additional function named NoPasswordCallback used for the second case to avoid OpenSSL's passphase routine. PR-URL: #12827 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

danbev · 2017-05-19T05:29:38Z

@addaleax Thanks!

Currently the function CryptoPemCallback is used for two things: 1. As a passphrase callback. 2. To avoid the default OpenSSL passphrase routine. The default OpenSSL passphase routine would apply if both the callback and the passphrase are null pointers and the typical behaviour is to prompt for the passphase which is not appropriate in node. This commit suggests that the PasswordCallback function only handle passphrases, and that an additional function named NoPasswordCallback used for the second case to avoid OpenSSL's passphase routine. PR-URL: nodejs#12827 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

Currently the function CryptoPemCallback is used for two things: 1. As a passphrase callback. 2. To avoid the default OpenSSL passphrase routine. The default OpenSSL passphase routine would apply if both the callback and the passphrase are null pointers and the typical behaviour is to prompt for the passphase which is not appropriate in node. This commit suggests that the PasswordCallback function only handle passphrases, and that an additional function named NoPasswordCallback used for the second case to avoid OpenSSL's passphase routine. PR-URL: #12827 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. crypto Issues and PRs related to the crypto subsystem. labels May 4, 2017

cjihrig approved these changes May 4, 2017

View reviewed changes

jasnell approved these changes May 4, 2017

View reviewed changes

addaleax approved these changes May 4, 2017

View reviewed changes

indutny previously requested changes May 4, 2017

View reviewed changes

danbev added 2 commits May 5, 2017 08:43

add additional newline for consistency

281402f

fix bug when len = 1

e7da72f

sam-github suggested changes May 5, 2017

View reviewed changes

restore support for null passphase

3a59be8

sam-github reviewed May 6, 2017

View reviewed changes

sam-github approved these changes May 6, 2017

View reviewed changes

update NoPasswordCallback comment

9c8e991

addaleax approved these changes May 6, 2017

View reviewed changes

addaleax closed this May 18, 2017

jasnell mentioned this pull request May 28, 2017

8.0.0 Release Proposal #12220

Closed

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

danbev deleted the crypto-password-callback-refactor branch June 28, 2017 05:28

MylesBorins added the land-on-v6.x label Jul 17, 2017

MylesBorins mentioned this pull request Jul 18, 2017

v6.11.2 proposal #14356

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src: split CryptoPemCallback into two functions #12827

src: split CryptoPemCallback into two functions #12827

danbev commented May 4, 2017

danbev commented May 4, 2017

cjihrig left a comment

mscdex commented May 4, 2017

indutny left a comment

indutny May 4, 2017

danbev May 5, 2017

indutny May 4, 2017

danbev May 5, 2017

danbev commented May 5, 2017

sam-github May 5, 2017 •

edited

Loading

indutny May 5, 2017

sam-github May 5, 2017

indutny May 5, 2017

sam-github May 5, 2017

danbev May 6, 2017

sam-github May 6, 2017

danbev May 6, 2017

addaleax left a comment

danbev commented May 9, 2017

danbev commented May 12, 2017

addaleax commented May 18, 2017

danbev commented May 19, 2017

src: split CryptoPemCallback into two functions #12827

src: split CryptoPemCallback into two functions #12827

Conversation

danbev commented May 4, 2017

Checklist

Affected core subsystem(s)

danbev commented May 4, 2017

cjihrig left a comment

Choose a reason for hiding this comment

mscdex commented May 4, 2017

indutny left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danbev commented May 5, 2017

sam-github May 5, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

addaleax left a comment

Choose a reason for hiding this comment

danbev commented May 9, 2017

danbev commented May 12, 2017

addaleax commented May 18, 2017

danbev commented May 19, 2017

sam-github May 5, 2017 •

edited

Loading