Skip to content

doc: clarify tlsSocket.authorized on resumption #64584

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

Open
soreavis wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Open

doc: clarify tlsSocket.authorized on resumption #64584

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions doc/api/tls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1072,6 +1072,18 @@ added: v0.11.4
This property is `true` if the peer certificate was signed by one of the CAs
specified when creating the `tls.TLSSocket` instance, otherwise `false`.

The peer certificate is only verified during a full TLS handshake. When a
connection is established by resuming a previous session (see
[Session Resumption][]), verification is not repeated. If the client
presented a certificate in the original handshake, `authorized` and
`authorizationError` carry the result stored with the session, including
any verification error. On TLS 1.3, a client that sent no certificate at
all can resume a session and report `authorized` as `true`, while
[`tls.TLSSocket.getPeerCertificate()`][] returns an empty object. Servers
that authorize clients manually with `rejectUnauthorized: false` should
therefore also check [`tls.TLSSocket.isSessionReused()`][] and that a peer
certificate is present.

### `tlsSocket.disableRenegotiation()`

<!-- YAML
Expand Down Expand Up @@ -2580,6 +2592,7 @@ added: v0.11.3
[`tls.TLSSocket.getProtocol()`]: #tlssocketgetprotocol
[`tls.TLSSocket.getSession()`]: #tlssocketgetsession
[`tls.TLSSocket.getTLSTicket()`]: #tlssocketgettlsticket
[`tls.TLSSocket.isSessionReused()`]: #tlssocketissessionreused
[`tls.TLSSocket.servername`]: #tlssocketservername
[`tls.TLSSocket`]: #class-tlstlssocket
[`tls.connect()`]: #tlsconnectoptions-callback
Expand Down
Loading