diff options
| author | Adam Langley <agl@google.com> | 2016-01-27 14:38:07 -0800 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2016-08-26 21:45:26 -0700 |
| commit | f4aa2c2c93a831ef12864333a5a1c8cbc0f672d3 (patch) | |
| tree | 243189d096bf4032d293c3c292fc34a4575fd55a /doc | |
| parent | a6d53c67795bf957b8b57d96814520f98069e80e (diff) | |
| download | android-node-v8-f4aa2c2c93a831ef12864333a5a1c8cbc0f672d3.tar.gz android-node-v8-f4aa2c2c93a831ef12864333a5a1c8cbc0f672d3.tar.bz2 android-node-v8-f4aa2c2c93a831ef12864333a5a1c8cbc0f672d3.zip | |
crypto: remove POINT_CONVERSION_HYBRID from documentation.
Compressed points are already rare and, as far as I know, nobody has used
the 'hybrid' format anywhere, ever. It's prohibited in X.509
certificates too[1].
This change removes mentions of it from the documentation in the
interests of trying to pare-down the complexity of cryptography.
[1] https://tools.ietf.org/html/rfc5480#section-2.2
PR-URL: https://github.com/nodejs/node/pull/4956
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/crypto.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 1d4b451be0..7a85f20a81 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -472,9 +472,9 @@ Generates private and public EC Diffie-Hellman key values, and returns the public key in the specified `format` and `encoding`. This key should be transferred to the other party. -The `format` arguments specifies point encoding and can be `'compressed'`, -`'uncompressed'`, or `'hybrid'`. If `format` is not specified, the point will -be returned in `'uncompressed'` format. +The `format` argument specifies point encoding and can be `'compressed'` or +`'uncompressed'`. If `format` is not specified, the point will be returned in +`'uncompressed'` format. The `encoding` argument can be `'latin1'`, `'hex'`, or `'base64'`. If `encoding` is provided a string is returned; otherwise a [`Buffer`][] @@ -491,9 +491,9 @@ a string is returned; otherwise a [`Buffer`][] is returned. Returns the EC Diffie-Hellman public key in the specified `encoding` and `format`. -The `format` argument specifies point encoding and can be `'compressed'`, -`'uncompressed'`, or `'hybrid'`. If `format` is not specified the point will be -returned in `'uncompressed'` format. +The `format` argument specifies point encoding and can be `'compressed'` or +`'uncompressed'`. If `format` is not specified the point will be returned in +`'uncompressed'` format. The `encoding` argument can be `'latin1'`, `'hex'`, or `'base64'`. If `encoding` is specified, a string is returned; otherwise a [`Buffer`][] is |