Skip to content

Commit b631966

Browse files
sam-githubMylesBorins
authored andcommitted
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: #12468 PR-URL: #10389 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent 54486c0 commit b631966

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

doc/api/tls.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -583,13 +583,16 @@ For Example: `{ type: 'ECDH', name: 'prime256v1', size: 256 }`
583583
added: v0.11.4
584584
-->
585585

586-
* `detailed` {boolean} Specify `true` to request that the full certificate
587-
chain with the `issuer` property be returned; `false` to return only the
588-
top certificate without the `issuer` property.
586+
* `detailed` {boolean} Include the full certificate chain if `true`, otherwise
587+
include just the peer's certificate.
589588

590589
Returns an object representing the peer's certificate. The returned object has
591590
some properties corresponding to the fields of the certificate.
592591

592+
If the full certificate chain was requested, each certificate will include a
593+
`issuerCertificate` property containing an object representing its issuer's
594+
certificate.
595+
593596
For example:
594597

595598
```text
@@ -600,24 +603,23 @@ For example:
600603
O: 'node.js',
601604
OU: 'Test TLS Certificate',
602605
CN: 'localhost' },
603-
issuerInfo:
606+
issuer:
604607
{ C: 'UK',
605608
ST: 'Acknack Ltd',
606609
L: 'Rhys Jones',
607610
O: 'node.js',
608611
OU: 'Test TLS Certificate',
609612
CN: 'localhost' },
610-
issuer:
611-
{ ... another certificate ... },
613+
issuerCertificate:
614+
{ ... another certificate, possibly with a .issuerCertificate ... },
612615
raw: < RAW DER buffer >,
613616
valid_from: 'Nov 11 09:52:22 2009 GMT',
614617
valid_to: 'Nov 6 09:52:22 2029 GMT',
615618
fingerprint: '2A:7A:C2:DD:E5:F9:CC:53:72:35:99:7A:02:5A:71:38:52:EC:8A:DF',
616619
serialNumber: 'B9B0D332A1AA5635' }
617620
```
618621

619-
If the peer does not provide a certificate, `null` or an empty object will be
620-
returned.
622+
If the peer does not provide a certificate, an empty object will be returned.
621623

622624
### tlsSocket.getProtocol()
623625
<!-- YAML

0 commit comments

Comments
 (0)