Skip to content

openssl list-public-key-algorithms on crypto docs聽#9005

Closed
Closed
openssl list-public-key-algorithms on crypto docs#9005
Labels
cryptoIssues and PRs related to the crypto subsystem.docIssues and PRs related to Node.js documentation.good first issueIssues that are suitable for first-time contributors.

Description

@yagop
yagop
opened on Oct 10, 2016

According with docs openssl list-public-key-algorithms shows the available signing algorithms, but isn't very helpfull, in fact I'm still unable to figure out which parameter to pass to crypto.createVerify(algorithm) 馃槩

By the way, on openssl 1.1.0b does not exists that command:

$ openssl version
OpenSSL 1.1.0b  26 Sep 2016
$ openssl list-public-key-algorithms
Invalid command 'list-public-key-algorithms'; type "help" for a list.
$ openssl list -public-key-algorithms
Name: OpenSSL RSA method
    Type: Builtin Algorithm
    OID: rsaEncryption
    PEM string: RSA
Name: rsa
    Alias for: rsaEncryption
Name: OpenSSL PKCS#3 DH method
    Type: Builtin Algorithm
    OID: dhKeyAgreement
    PEM string: DH
...

Activity

  1. Fishrock123
    added
    cryptoIssues and PRs related to the crypto subsystem.
    docIssues and PRs related to Node.js documentation.
    on Oct 10, 2016

  2. Fishrock123 commented on Oct 10, 2016

    @Fishrock123
    Fishrock123
    on Oct 10, 2016
    Contributor

    cc @nodejs/crypto

  3. mscdex commented on Oct 10, 2016

    @mscdex
    mscdex
    on Oct 10, 2016
    Contributor

    Perhaps we should just add a crypto.getPubKeyAlgos() or similar.

  4. bnoordhuis commented on Oct 10, 2016

    @bnoordhuis
    bnoordhuis
    on Oct 10, 2016
    Member

    I see openssl list-public-key-algorithms mentioned for crypto.createSign() and crypto.createVerify() but I have no idea why. What you want to use is one of the digests from crypto.getHashes(), like RSA-SHA256.

  5. indutny commented on Oct 10, 2016

    @indutny
    indutny
    on Oct 10, 2016
    Member

    Yeah, it is basically contained in crypto.getHashes() as @bnoordhuis pointed out.

  6. bnoordhuis commented on Oct 10, 2016

    @bnoordhuis
    bnoordhuis
    on Oct 10, 2016
    Member

    Looks like the documentation has basically always been wrong -- I traced it back to commit afce4c3 from May 2010, released in v0.1.94! In fairness, we didn't have crypto.getHashes() back then. :-)

  7. indutny commented on Oct 10, 2016

    @indutny
    indutny
    on Oct 10, 2016
    Member

    Nor did anyone know how these things work ;)

  8. gibfahn
    added
    good first issueIssues that are suitable for first-time contributors.
    on Oct 10, 2016

  9. gibfahn commented on Oct 10, 2016

    @gibfahn
    gibfahn
    on Oct 10, 2016
    Member

    Sounds like we're somewhat overdue a documentation update then?

  10. bnoordhuis commented on Oct 10, 2016

    @bnoordhuis
    bnoordhuis
    on Oct 10, 2016
    Member

    Yep.

  11. sstern6 commented on Oct 11, 2016

    @sstern6
    sstern6
    on Oct 11, 2016
    Contributor

    Would like to make a PR for this, from what I understand from the thread I need to:

    1. Remove openssl list-public-key-algorithms explanation from crypto.createSign() and crypto.createVerify() sections in the docs.
    2. Update the crypto.getHashes() to be more clear about listing supported hash algorithms?

    Can have a PR open for this shortly!

    cc @bnoordhuis

    Thanks!

  12. bnoordhuis commented on Oct 11, 2016

    @bnoordhuis
    bnoordhuis
    on Oct 11, 2016
    Member

    @sstern6 Correct. I'd also cross-reference crypto.getHashes() from crypto.createSign() and crypto.createVerify().

  13. sstern6 commented on Oct 11, 2016

    @sstern6
    sstern6
    on Oct 11, 2016
    Contributor

    @bnoordhuis ON IT! Will have a PR open today! Thank you

  14. bnoordhuis commented on Oct 21, 2016

    @bnoordhuis
    bnoordhuis
    on Oct 21, 2016
    Member

    Closing, fixed in 3d294cf.

  15. bnoordhuis
    closed this as completedon Oct 21, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    cryptoIssues and PRs related to the crypto subsystem.docIssues and PRs related to Node.js documentation.good first issueIssues that are suitable for first-time contributors.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions