Crypto add opensslerror stack #15518

gla5001 · 2017-09-21T02:47:49Z

Feature request to add openSSL error stack to the exception object
thrown from crypto. New exception property only added to object
if the error stack has not cleared out prior to calling
ThrowCryptoError.

I did something very wrong when trying to rebase, so i just created a new branch and a new PR. This PR has all the changes requested from #14725. I will close the other one.

Refs: #5444

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

crypto

gla5001 · 2017-09-21T02:50:26Z

doc/api/errors.md

@@ -193,7 +193,7 @@ detailing the point in the code at which the `Error` was instantiated, and may
 provide a text description of the error.


This commit has the latest review comment fixes.
@bnoordhuis, i believe i've addressed all of your comments. Thanks for the review.

gla5001 · 2017-09-21T02:51:50Z

src/node_crypto.cc

+  if (es->bottom != es->top) {
+    Local<Array> error_stack = Array::New(env->isolate());
+    int top = es->top;
+


Now, we wont add the property to the exception every time.

gla5001 · 2017-09-21T02:52:18Z

src/node_crypto.cc

+      // arithmetic to loop back around in the case where bottom is after top.
+      // Using ERR_NUM_ERRORS  macro defined in openssl.
+      es->top = (((es->top - 1) % ERR_NUM_ERRORS) + ERR_NUM_ERRORS) %
+          ERR_NUM_ERRORS;
    }


handle the ring buffer with modular arithmetic

gla5001 · 2017-09-21T02:52:31Z

src/node_crypto.cc

@@ -4326,8 +4339,6 @@ SignBase::Error Verify::VerifyFinal(const char* key_pem,
  int r = 0;
  EVP_PKEY_CTX* pkctx = nullptr;

-  ERR_set_mark();
-
  bp = BIO_new_mem_buf(const_cast<char*>(key_pem), key_pem_len);


this is not needed

gla5001 · 2017-09-21T02:52:51Z

test/parallel/test-crypto.js

-      err.openSSLErrorStack !== undefined &&
-      Array.isArray(err.openSSLErrorStack) &&
-      err.openSSLErrorStack.length === 0) {
+      err.openSSLErrorStack === undefined) {
    return true;


update test since the openSSLErrorStack is not always added

gla5001 · 2017-09-21T03:30:01Z

The only new commit is 720a5af. Everything else was reviewed in #14725.

jasnell · 2017-09-21T12:59:40Z

ping @nodejs/crypto

jasnell · 2017-09-25T17:21:43Z

doc/api/errors.md

@@ -193,7 +193,7 @@ detailing the point in the code at which the `Error` was instantiated, and may
 provide a text description of the error.

 For crypto only, `Error` objects will include the OpenSSL error stack in a
-separate property called `openSSLErrorStack` if it is available when the error is thrown.


long line here?

indutny

LGTM

BridgeAR · 2017-09-27T22:41:10Z

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

BridgeAR · 2017-09-27T22:45:45Z

@gla5001 when trying to rebase this on the CI it gets a conflict. I am a bit surprised that this is not shown here but would you be so kind and rebase this nevertheless?

gla5001 · 2017-09-28T00:44:59Z

@BridgeAR sure thing


        crypto: better crypto error messages

Feature request to add openSSL error stack to the exception object thrown from crypto. New exception property only added to object if the error stack has not cleared out prior to calling ThrowCryptoError. Refs: #5444


        Review updates and tests


        Additional review updates.


        Review update. Use the overload of Set()


        Nit fix: changing local variable to snake_case


        PR review updates


        changing openSSLErrorStack property name to opensslErrorStack


        fixing long doc line

gla5001 · 2017-09-28T03:31:39Z

@BridgeAR rebased and pushed. Could you let me know if this resolves the issue?

BridgeAR · 2017-09-28T03:33:55Z

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

BridgeAR · 2017-09-28T05:24:06Z

Landed in ccfcd88


        crypto: better crypto error messages

Add openSSL error stack to the exception object thrown from crypto. The new exception property is only added to the object if the error stack has not cleared out prior to calling ThrowCryptoError. PR-URL: #15518 Refs: #5444 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>


        crypto: better crypto error messages

Add openSSL error stack to the exception object thrown from crypto. The new exception property is only added to the object if the error stack has not cleared out prior to calling ThrowCryptoError. PR-URL: nodejs#15518 Refs: nodejs#5444 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>

bnoordhuis · 2017-09-28T08:03:32Z

The commit log could have had a link to #14725, that's where 95% of the review took place. This comment will have to do.


        crypto: better crypto error messages

Add openSSL error stack to the exception object thrown from crypto. The new exception property is only added to the object if the error stack has not cleared out prior to calling ThrowCryptoError. PR-URL: #15518 Refs: #5444 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>


        crypto: better crypto error messages

Add openSSL error stack to the exception object thrown from crypto. The new exception property is only added to the object if the error stack has not cleared out prior to calling ThrowCryptoError. PR-URL: nodejs/node#15518 Refs: nodejs/node#5444 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>


        crypto: better crypto error messages

Add openSSL error stack to the exception object thrown from crypto. The new exception property is only added to the object if the error stack has not cleared out prior to calling ThrowCryptoError. PR-URL: #15518 Refs: #5444 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>


        crypto: better crypto error messages

Add openSSL error stack to the exception object thrown from crypto. The new exception property is only added to the object if the error stack has not cleared out prior to calling ThrowCryptoError. PR-URL: #15518 Refs: #5444 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>

MylesBorins · 2017-10-17T19:06:06Z

Should this be backported to v6.x-staging? If yes please follow the guide and raise a backport PR, if not let me know or add the dont-land-on label.

edit: this likely shouldn'y be backported if it is changing error messages prior to error codes... but I wanted to confirm

gla5001 · 2017-10-17T19:10:57Z

@MylesBorins I believe it should not be backported.

nodejs-github-bot added C++ crypto labels Sep 21, 2017

gla5001 reviewed Sep 21, 2017

View changes

src/node_crypto.cc

if (es->bottom != es->top) {

Local<Array> error_stack = Array::New(env->isolate());

int top = es->top;

This comment has been minimized.

Sign in to view

Copy link

gla5001 Sep 21, 2017
Author Contributor

Now, we wont add the property to the exception every time.

gla5001 reviewed Sep 21, 2017

View changes

gla5001 mentioned this pull request Sep 21, 2017

crypto: better crypto error messages #14725

Closed

4 of 4 tasks complete

jasnell requested review from bnoordhuis and targos Sep 21, 2017

sam-github approved these changes Sep 22, 2017

View changes

jasnell reviewed Sep 25, 2017

View changes

indutny approved these changes Sep 26, 2017

View changes

gla5001 added 8 commits Aug 10, 2017

crypto: better crypto error messages

f2c9e49

Feature request to add openSSL error stack to the exception object thrown from crypto. New exception property only added to object if the error stack has not cleared out prior to calling ThrowCryptoError. Refs: #5444

Review updates and tests

dc2165a

Additional review updates.

5c24f07

Review update. Use the overload of Set()

d1296cf

Nit fix: changing local variable to snake_case

2b177cb

PR review updates

bbaea8b

changing openSSLErrorStack property name to opensslErrorStack

a5a2f64

fixing long doc line

2ad7440

gla5001 force-pushed the gla5001:crypto-add-opensslerror-stack branch from 537284e to 2ad7440 Sep 28, 2017

BridgeAR closed this Sep 28, 2017

MylesBorins mentioned this pull request Oct 3, 2017

v8.7.0 proposal #15762

Merged

MylesBorins added the backport-requested-v6.x label Oct 17, 2017

MylesBorins added dont-land-on-v6.x and removed backport-requested-v6.x labels Oct 17, 2017

bnoordhuis mentioned this pull request Oct 26, 2017

Can we refactor opensslErrorStack? #16521

Closed

nodejs/node

Crypto add opensslerror stack #15518

Crypto add opensslerror stack #15518

gla5001 commented Sep 21, 2017 •

edited

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

gla5001 commented Sep 21, 2017

This comment has been minimized.

jasnell commented Sep 21, 2017

This comment has been minimized.

indutny left a comment

This comment has been minimized.

BridgeAR commented Sep 27, 2017 •

edited

This comment has been minimized.

BridgeAR commented Sep 27, 2017

This comment has been minimized.

gla5001 commented Sep 28, 2017

This comment has been minimized.

gla5001 commented Sep 28, 2017

This comment has been minimized.

BridgeAR commented Sep 28, 2017

This comment has been minimized.

BridgeAR commented Sep 28, 2017

This comment has been minimized.

bnoordhuis commented Sep 28, 2017

This comment has been minimized.

MylesBorins commented Oct 17, 2017 •

edited

This comment has been minimized.

gla5001 commented Oct 17, 2017

nodejs/node

Join GitHub today

Crypto add opensslerror stack #15518

Crypto add opensslerror stack #15518

Conversation

gla5001 commented Sep 21, 2017 • edited

Checklist

Affected core subsystem(s)

This comment has been minimized.

gla5001 Sep 21, 2017 • edited

This comment has been minimized.

gla5001 Sep 21, 2017

This comment has been minimized.

gla5001 Sep 21, 2017

This comment has been minimized.

gla5001 Sep 21, 2017

This comment has been minimized.

gla5001 Sep 21, 2017

This comment has been minimized.

gla5001 commented Sep 21, 2017

This comment has been minimized.

jasnell commented Sep 21, 2017

This comment has been minimized.

jasnell Sep 25, 2017

indutny left a comment

This comment has been minimized.

BridgeAR commented Sep 27, 2017 • edited

This comment has been minimized.

BridgeAR commented Sep 27, 2017

This comment has been minimized.

gla5001 commented Sep 28, 2017

This comment has been minimized.

gla5001 commented Sep 28, 2017

This comment has been minimized.

BridgeAR commented Sep 28, 2017

This comment has been minimized.

BridgeAR commented Sep 28, 2017

This comment has been minimized.

bnoordhuis commented Sep 28, 2017

This comment has been minimized.

MylesBorins commented Oct 17, 2017 • edited

This comment has been minimized.

gla5001 commented Oct 17, 2017

gla5001 commented Sep 21, 2017 •

edited

gla5001 Sep 21, 2017 •

edited

BridgeAR commented Sep 27, 2017 •

edited

MylesBorins commented Oct 17, 2017 •

edited