Skip to content

doc: fix crypto update() signatures - #5500

Merged
mscdex merged 1 commit into
nodejs:masterfrom
mscdex:doc-crypto-fix-hmac-update-signature
Mar 18, 2016
Merged

doc: fix crypto update() signatures#5500
mscdex merged 1 commit into
nodejs:masterfrom
mscdex:doc-crypto-fix-hmac-update-signature

Conversation

@mscdex

@mscdexmscdex commented Mar 1, 2016

Copy link
Copy Markdown
Contributor

Pull Request check-list

  • Does make -j8 test (UNIX) or vcbuild test nosign (Windows) pass with
    this change (including linting)?
  • Is the commit message formatted according to CONTRIBUTING.md?
  • If this change fixes a bug (or a performance problem), is a regression
    test (or a benchmark) included?
  • Is a documentation update included (if this change modifies
    existing APIs, or introduces new ones)?

Affected core subsystem(s)

  • doc
  • crypto

Description of change

Fixes: #5499

@mscdexmscdex added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Mar 1, 2016
@mscdexmscdex mentioned this pull request Mar 1, 2016
Closed
@shigeki

shigeki commented Mar 1, 2016

Copy link
Copy Markdown
Contributor

@mscdex Does Sign/Verify.update() also need to add the same descriptions?

@mscdex
mscdexforce-pushed the doc-crypto-fix-hmac-update-signature branch 2 times, most recently from 8de1720 to 92a60fdCompareMarch 1, 2016 02:45
@mscdex

mscdex commented Mar 1, 2016

Copy link
Copy Markdown
ContributorAuthor

@shigeki Fixed.

@mscdexmscdex changed the title doc: fix crypto hash.update() signaturedoc: fix crypto update() signaturesMar 1, 2016
@shigeki

shigeki commented Mar 1, 2016

Copy link
Copy Markdown
Contributor

Thanks. LGTM.

@kirked

kirked commented Mar 1, 2016

Copy link
Copy Markdown

As the originator of #5499, I have to say that the most misleading part of the doc is near the top of the page where it states

The crypto module provides cryptographic functionality that includes a set of wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions.

Once I saw that it should be OpenSSL compatible, it was easy to prove that it isn't.

I don't know of a way to arrive at the same digest that node does using OpenSSL when multibyte characters are in the digest stream (which is probably just ignorance on my part). My real problem now is that other systems (e.g., JDK) digest the same as OpenSSL (there is no such thing as binary encoding), so node seems to be the outlier.

@mscdex
doc: fix crypto update() signatures
af09a9c
PR-URL: nodejs#5500
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp>
@mscdex
mscdexforce-pushed the doc-crypto-fix-hmac-update-signature branch from 92a60fd to af09a9cCompareMarch 18, 2016 02:31
@mscdex
mscdex merged commit af09a9c into nodejs:masterMar 18, 2016
@mscdex
mscdex deleted the doc-crypto-fix-hmac-update-signature branch March 18, 2016 02:38
@Fishrock123Fishrock123 mentioned this pull request Mar 22, 2016
Merged
Fishrock123 pushed a commit that referenced this pull request Mar 22, 2016
@mscdex@Fishrock123
doc: fix crypto update() signatures
d8318c2
PR-URL: #5500
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp>
@MylesBorins

MylesBorins commented Mar 23, 2016

Copy link
Copy Markdown
Contributor

@mscdex should this go to lts?

@mscdex

mscdex commented Mar 23, 2016

Copy link
Copy Markdown
ContributorAuthor

Probably, I think the API has been this way at least since v0.10 IIRC.

@jasnell

jasnell commented Mar 23, 2016

Copy link
Copy Markdown
Member

+1

MylesBorins pushed a commit that referenced this pull request Mar 30, 2016
@mscdexMyles Borins
doc: fix crypto update() signatures
af23632
PR-URL: #5500
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp>
MylesBorins pushed a commit that referenced this pull request Mar 30, 2016
@mscdexMyles Borins
doc: fix crypto update() signatures
a6ec8a6
PR-URL: #5500
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp>
@addaleaxaddaleax mentioned this pull request Jul 13, 2016
Closed
addaleax added a commit to addaleax/node that referenced this pull request Jul 19, 2016
@addaleax
doc: correct crypto encoding information
f297286
The default encoding for crypto methods was changed in v6.0.0,
with v4.x keeping a default of `binary`.
Ref: nodejs#5500Fixes: nodejs#7712
@addaleaxaddaleax mentioned this pull request Jul 19, 2016
Closed
2 tasks
jasnell pushed a commit that referenced this pull request Aug 1, 2016
@addaleax@jasnell
doc: correct crypto encoding information
d771d5e
The default encoding for crypto methods was changed in v6.0.0,
with v4.x keeping a default of `binary`.
Ref: #5500Fixes: #7712
PR-URL: #7799
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
@addaleaxaddaleax mentioned this pull request Sep 17, 2016
Closed
3 tasks
@JacksonTian

JacksonTian commented Sep 20, 2016

Copy link
Copy Markdown
Contributor

This should not be landed in LTS v4.

lmoe pushed a commit to lmoe/node that referenced this pull request Feb 16, 2017
Lukas Möller
crypto: fix default encoding of LazyTransform
fe9de5d
PullRequest nodejs#5522 and nodejs#5500 described the change
of the default encoding into UTF8 in crypto functions.
This however was only changed for the non-streaming API.
The streaming API still used binary as the default encoding.
This commit will change the default streaming API encoding to UTF8
to make both APIs behave the same.
It will also add tests to validate the behavior.
addaleax pushed a commit that referenced this pull request Mar 11, 2017
Lukas Möller@addaleax
crypto: fix default encoding of LazyTransform
443691a
PullRequest #5522 and #5500 described the change
of the default encoding into UTF8 in crypto functions.
This however was only changed for the non-streaming API.
The streaming API still used binary as the default encoding.
This commit will change the default streaming API encoding to UTF8
to make both APIs behave the same.
It will also add tests to validate the behavior.
Refs: #5522
Refs: #5500
PR-URL: #8611
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
jungx098 pushed a commit to jungx098/node that referenced this pull request Mar 21, 2017
Lukas Möller@jungx098
crypto: fix default encoding of LazyTransform
98659fd
PullRequest nodejs#5522 and nodejs#5500 described the change
of the default encoding into UTF8 in crypto functions.
This however was only changed for the non-streaming API.
The streaming API still used binary as the default encoding.
This commit will change the default streaming API encoding to UTF8
to make both APIs behave the same.
It will also add tests to validate the behavior.
Refs: nodejs#5522
Refs: nodejs#5500
PR-URL: nodejs#8611
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

cryptoIssues and PRs related to the crypto subsystem.docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Incorrect HMAC result!

6 participants

@mscdex@shigeki@kirked@MylesBorins@jasnell@JacksonTian