Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

document how to use crypto.sign() for algorithm+digest combinations without named constants #6108

Closed
wants to merge 2 commits into from
Closed

document how to use crypto.sign() for algorithm+digest combinations without named constants #6108

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9616c8a
document using algorithms not directly exposed with sign
hillbrad Apr 7, 2016
969c028
identifier typo
hillbrad Apr 7, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions doc/api/crypto.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,6 +734,28 @@ console.log(sign.sign(private_key, 'hex'));
// Prints the calculated signature
```

A [`sign`][] instance can also be created by just passing in the digest
algorithm name, in which case OpenSSL will infer the full signature algorithm
from the type of the PEM-formatted private key, including algorithms that
do not have directly exposed name constants, e.g. 'ecdsa-with-SHA256'.

Example: signing using ECDSA with SHA256

```js
const crypto = require('crypto');
const sign = crypto.createSign('sha256');

sign.update('some data to sign');

const privateKey = '-----BEGIN EC PRIVATE KEY-----\n' +
Copy link

Choose a reason for hiding this comment

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

Either update this const name to be private_key for consistency, or update the one passed into sign() below.

Copy link
Contributor

Choose a reason for hiding this comment

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

Should be camelcase for javascript, so the other should be fixed.

Copy link

Choose a reason for hiding this comment

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

You are correct that it should be camelCase, but the rest of the references in the doc use lower_case, so, I agree that consistency with the existing examples wins.

'MHcCAQEEIF+jnWY1D5kbVYDNvxxo/Y+ku2uJPDwS0r/VuPZQrjjVoAoGCCqGSM49\n' +
'AwEHoUQDQgAEurOxfSxmqIRYzJVagdZfMMSjRNNhB8i3mXyIMq704m2m52FdfKZ2\n' +
'pQhByd5eyj3lgZ7m7jbchtdgyOF8Io/1ng==\n' +
'-----END EC PRIVATE KEY-----\n',
Copy link
Member

Choose a reason for hiding this comment

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

s/,/;/


console.log(sign.sign(private_key).toString('hex'));
```

### sign.sign(private_key[, output_format])

Calculates the signature on all the data passed through using either
Expand Down