diff options
| author | Sam Roberts <vieuxtech@gmail.com> | 2016-12-20 14:16:18 -0800 |
|---|---|---|
| committer | Myles Borins <mylesborins@google.com> | 2017-04-18 20:01:54 -0400 |
| commit | cbfc3fcd9dfbae4d1215199d503f30cb2b9bda7c (patch) | |
| tree | 23add5a219d80af56d00c43a2e884462b0f7f86b /doc | |
| parent | 1d7fab37406d288e38a7db31310546d260b1eb08 (diff) | |
| download | node-new-cbfc3fcd9dfbae4d1215199d503f30cb2b9bda7c.tar.gz | |
doc: use correct tls certificate property name
Docs referred to an `issuer` property being optionally present, when it
should have referred to the `issuerCertificate` property.
Backport-PR-URL: https://github.com/nodejs/node/pull/12468
PR-URL: https://github.com/nodejs/node/pull/10389
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/tls.md | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md index ee3d37d6a4..0e47ddac03 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -583,13 +583,16 @@ For Example: `{ type: 'ECDH', name: 'prime256v1', size: 256 }` added: v0.11.4 --> -* `detailed` {boolean} Specify `true` to request that the full certificate - chain with the `issuer` property be returned; `false` to return only the - top certificate without the `issuer` property. +* `detailed` {boolean} Include the full certificate chain if `true`, otherwise + include just the peer's certificate. Returns an object representing the peer's certificate. The returned object has some properties corresponding to the fields of the certificate. +If the full certificate chain was requested, each certificate will include a +`issuerCertificate` property containing an object representing its issuer's +certificate. + For example: ```text @@ -600,15 +603,15 @@ For example: O: 'node.js', OU: 'Test TLS Certificate', CN: 'localhost' }, - issuerInfo: + issuer: { C: 'UK', ST: 'Acknack Ltd', L: 'Rhys Jones', O: 'node.js', OU: 'Test TLS Certificate', CN: 'localhost' }, - issuer: - { ... another certificate ... }, + issuerCertificate: + { ... another certificate, possibly with a .issuerCertificate ... }, raw: < RAW DER buffer >, valid_from: 'Nov 11 09:52:22 2009 GMT', valid_to: 'Nov 6 09:52:22 2029 GMT', @@ -616,8 +619,7 @@ For example: serialNumber: 'B9B0D332A1AA5635' } ``` -If the peer does not provide a certificate, `null` or an empty object will be -returned. +If the peer does not provide a certificate, an empty object will be returned. ### tlsSocket.getProtocol() <!-- YAML |