Skip to content

doc: added 'secure' event to tls.TLSSocket #61066

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
ikeyan wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −1
Open

doc: added 'secure' event to tls.TLSSocket #61066

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
15 changes: 14 additions & 1 deletion doc/api/tls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -951,6 +951,18 @@ The listener callback is passed a single argument when called:
Typically, the `response` is a digitally signed object from the server's CA that
contains information about server's certificate revocation status.

### Event: `'secure'`

<!-- YAML
added: v0.11.4
-->

The `'secure'` event is emitted after the TLS handshake has successfully
completed and a secure connection has been established.

This event is emitted on both client and server {tls.TLSSocket} instances,
including sockets created using the `new tls.TLSSocket()` constructor.

### Event: `'secureConnect'`

<!-- YAML
Expand Down Expand Up @@ -1529,7 +1541,7 @@ changes:
* `requestCert`

* `callback` {Function} If `renegotiate()` returned `true`, callback is
attached once to the `'secure'` event. If `renegotiate()` returned `false`,
attached once to the [`'secure'`][] event. If `renegotiate()` returned `false`,
`callback` will be called in the next tick with an error, unless the
`tlsSocket` has been destroyed, in which case `callback` will not be called
at all.
Expand Down Expand Up @@ -2456,6 +2468,7 @@ added: v0.11.3
[TLS recommendations]: https://wiki.mozilla.org/Security/Server_Side_TLS
[`'newSession'`]: #event-newsession
[`'resumeSession'`]: #event-resumesession
[`'secure'`]: #event-secure
[`'secureConnect'`]: #event-secureconnect
[`'secureConnection'`]: #event-secureconnection
[`'session'`]: #event-session
Expand Down