mcpbrowser 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/.mcpregistry_github_token +1 -0
  2. package/.mcpregistry_registry_token +1 -0
  3. package/README.md +50 -52
  4. package/extension/.vscodeignore +6 -0
  5. package/extension/LICENSE +21 -0
  6. package/extension/README.md +61 -0
  7. package/extension/icon.png +0 -0
  8. package/extension/icon.svg +35 -0
  9. package/extension/mcpbrowser-0.1.1.vsix +0 -0
  10. package/extension/mcpbrowser-0.1.2.vsix +0 -0
  11. package/extension/mcpbrowser-0.1.3.vsix +0 -0
  12. package/extension/mcpbrowser-0.1.4.vsix +0 -0
  13. package/extension/mcpbrowser-config-0.1.0.vsix +0 -0
  14. package/extension/node_modules/.package-lock.json +32 -0
  15. package/extension/node_modules/@types/node/LICENSE +21 -0
  16. package/extension/node_modules/@types/node/README.md +15 -0
  17. package/extension/node_modules/@types/node/assert/strict.d.ts +8 -0
  18. package/extension/node_modules/@types/node/assert.d.ts +1062 -0
  19. package/extension/node_modules/@types/node/async_hooks.d.ts +605 -0
  20. package/extension/node_modules/@types/node/buffer.buffer.d.ts +471 -0
  21. package/extension/node_modules/@types/node/buffer.d.ts +1936 -0
  22. package/extension/node_modules/@types/node/child_process.d.ts +1475 -0
  23. package/extension/node_modules/@types/node/cluster.d.ts +577 -0
  24. package/extension/node_modules/@types/node/compatibility/disposable.d.ts +16 -0
  25. package/extension/node_modules/@types/node/compatibility/index.d.ts +9 -0
  26. package/extension/node_modules/@types/node/compatibility/indexable.d.ts +20 -0
  27. package/extension/node_modules/@types/node/compatibility/iterators.d.ts +21 -0
  28. package/extension/node_modules/@types/node/console.d.ts +452 -0
  29. package/extension/node_modules/@types/node/constants.d.ts +21 -0
  30. package/extension/node_modules/@types/node/crypto.d.ts +4590 -0
  31. package/extension/node_modules/@types/node/dgram.d.ts +597 -0
  32. package/extension/node_modules/@types/node/diagnostics_channel.d.ts +578 -0
  33. package/extension/node_modules/@types/node/dns/promises.d.ts +479 -0
  34. package/extension/node_modules/@types/node/dns.d.ts +871 -0
  35. package/extension/node_modules/@types/node/domain.d.ts +170 -0
  36. package/extension/node_modules/@types/node/events.d.ts +977 -0
  37. package/extension/node_modules/@types/node/fs/promises.d.ts +1270 -0
  38. package/extension/node_modules/@types/node/fs.d.ts +4375 -0
  39. package/extension/node_modules/@types/node/globals.d.ts +172 -0
  40. package/extension/node_modules/@types/node/globals.typedarray.d.ts +38 -0
  41. package/extension/node_modules/@types/node/http.d.ts +2049 -0
  42. package/extension/node_modules/@types/node/http2.d.ts +2631 -0
  43. package/extension/node_modules/@types/node/https.d.ts +578 -0
  44. package/extension/node_modules/@types/node/index.d.ts +93 -0
  45. package/extension/node_modules/@types/node/inspector.generated.d.ts +3966 -0
  46. package/extension/node_modules/@types/node/module.d.ts +539 -0
  47. package/extension/node_modules/@types/node/net.d.ts +1012 -0
  48. package/extension/node_modules/@types/node/os.d.ts +506 -0
  49. package/extension/node_modules/@types/node/package.json +140 -0
  50. package/extension/node_modules/@types/node/path.d.ts +200 -0
  51. package/extension/node_modules/@types/node/perf_hooks.d.ts +961 -0
  52. package/extension/node_modules/@types/node/process.d.ts +1957 -0
  53. package/extension/node_modules/@types/node/punycode.d.ts +117 -0
  54. package/extension/node_modules/@types/node/querystring.d.ts +152 -0
  55. package/extension/node_modules/@types/node/readline/promises.d.ts +162 -0
  56. package/extension/node_modules/@types/node/readline.d.ts +589 -0
  57. package/extension/node_modules/@types/node/repl.d.ts +430 -0
  58. package/extension/node_modules/@types/node/sea.d.ts +153 -0
  59. package/extension/node_modules/@types/node/stream/consumers.d.ts +38 -0
  60. package/extension/node_modules/@types/node/stream/promises.d.ts +90 -0
  61. package/extension/node_modules/@types/node/stream/web.d.ts +533 -0
  62. package/extension/node_modules/@types/node/stream.d.ts +1675 -0
  63. package/extension/node_modules/@types/node/string_decoder.d.ts +67 -0
  64. package/extension/node_modules/@types/node/test.d.ts +1787 -0
  65. package/extension/node_modules/@types/node/timers/promises.d.ts +108 -0
  66. package/extension/node_modules/@types/node/timers.d.ts +286 -0
  67. package/extension/node_modules/@types/node/tls.d.ts +1255 -0
  68. package/extension/node_modules/@types/node/trace_events.d.ts +197 -0
  69. package/extension/node_modules/@types/node/ts5.6/buffer.buffer.d.ts +468 -0
  70. package/extension/node_modules/@types/node/ts5.6/globals.typedarray.d.ts +34 -0
  71. package/extension/node_modules/@types/node/ts5.6/index.d.ts +93 -0
  72. package/extension/node_modules/@types/node/tty.d.ts +208 -0
  73. package/extension/node_modules/@types/node/url.d.ts +964 -0
  74. package/extension/node_modules/@types/node/util.d.ts +2331 -0
  75. package/extension/node_modules/@types/node/v8.d.ts +809 -0
  76. package/extension/node_modules/@types/node/vm.d.ts +1001 -0
  77. package/extension/node_modules/@types/node/wasi.d.ts +181 -0
  78. package/extension/node_modules/@types/node/web-globals/abortcontroller.d.ts +34 -0
  79. package/extension/node_modules/@types/node/web-globals/domexception.d.ts +68 -0
  80. package/extension/node_modules/@types/node/web-globals/events.d.ts +97 -0
  81. package/extension/node_modules/@types/node/web-globals/fetch.d.ts +46 -0
  82. package/extension/node_modules/@types/node/worker_threads.d.ts +715 -0
  83. package/extension/node_modules/@types/node/zlib.d.ts +540 -0
  84. package/extension/node_modules/@types/vscode/LICENSE +21 -0
  85. package/extension/node_modules/@types/vscode/README.md +15 -0
  86. package/extension/node_modules/@types/vscode/index.d.ts +21153 -0
  87. package/extension/node_modules/@types/vscode/package.json +26 -0
  88. package/extension/node_modules/undici-types/LICENSE +21 -0
  89. package/extension/node_modules/undici-types/README.md +6 -0
  90. package/extension/node_modules/undici-types/agent.d.ts +31 -0
  91. package/extension/node_modules/undici-types/api.d.ts +43 -0
  92. package/extension/node_modules/undici-types/balanced-pool.d.ts +29 -0
  93. package/extension/node_modules/undici-types/cache.d.ts +36 -0
  94. package/extension/node_modules/undici-types/client.d.ts +108 -0
  95. package/extension/node_modules/undici-types/connector.d.ts +34 -0
  96. package/extension/node_modules/undici-types/content-type.d.ts +21 -0
  97. package/extension/node_modules/undici-types/cookies.d.ts +28 -0
  98. package/extension/node_modules/undici-types/diagnostics-channel.d.ts +66 -0
  99. package/extension/node_modules/undici-types/dispatcher.d.ts +256 -0
  100. package/extension/node_modules/undici-types/env-http-proxy-agent.d.ts +21 -0
  101. package/extension/node_modules/undici-types/errors.d.ts +149 -0
  102. package/extension/node_modules/undici-types/eventsource.d.ts +61 -0
  103. package/extension/node_modules/undici-types/fetch.d.ts +209 -0
  104. package/extension/node_modules/undici-types/file.d.ts +39 -0
  105. package/extension/node_modules/undici-types/filereader.d.ts +54 -0
  106. package/extension/node_modules/undici-types/formdata.d.ts +108 -0
  107. package/extension/node_modules/undici-types/global-dispatcher.d.ts +9 -0
  108. package/extension/node_modules/undici-types/global-origin.d.ts +7 -0
  109. package/extension/node_modules/undici-types/handlers.d.ts +15 -0
  110. package/extension/node_modules/undici-types/header.d.ts +4 -0
  111. package/extension/node_modules/undici-types/index.d.ts +71 -0
  112. package/extension/node_modules/undici-types/interceptors.d.ts +17 -0
  113. package/extension/node_modules/undici-types/mock-agent.d.ts +50 -0
  114. package/extension/node_modules/undici-types/mock-client.d.ts +25 -0
  115. package/extension/node_modules/undici-types/mock-errors.d.ts +12 -0
  116. package/extension/node_modules/undici-types/mock-interceptor.d.ts +93 -0
  117. package/extension/node_modules/undici-types/mock-pool.d.ts +25 -0
  118. package/extension/node_modules/undici-types/package.json +55 -0
  119. package/extension/node_modules/undici-types/patch.d.ts +33 -0
  120. package/extension/node_modules/undici-types/pool-stats.d.ts +19 -0
  121. package/extension/node_modules/undici-types/pool.d.ts +39 -0
  122. package/extension/node_modules/undici-types/proxy-agent.d.ts +28 -0
  123. package/extension/node_modules/undici-types/readable.d.ts +65 -0
  124. package/extension/node_modules/undici-types/retry-agent.d.ts +8 -0
  125. package/extension/node_modules/undici-types/retry-handler.d.ts +116 -0
  126. package/extension/node_modules/undici-types/util.d.ts +18 -0
  127. package/extension/node_modules/undici-types/webidl.d.ts +228 -0
  128. package/extension/node_modules/undici-types/websocket.d.ts +150 -0
  129. package/extension/package-lock.json +44 -0
  130. package/extension/package.json +55 -0
  131. package/extension/src/extension.js +257 -0
  132. package/package.json +1 -1
  133. package/server.json +3 -3
  134. package/src/mcp-browser.js +1 -1
@@ -0,0 +1,1255 @@
1
+ /**
2
+ * The `node:tls` module provides an implementation of the Transport Layer Security
3
+ * (TLS) and Secure Socket Layer (SSL) protocols that is built on top of OpenSSL.
4
+ * The module can be accessed using:
5
+ *
6
+ * ```js
7
+ * import tls from 'node:tls';
8
+ * ```
9
+ * @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/tls.js)
10
+ */
11
+ declare module "tls" {
12
+ import { NonSharedBuffer } from "node:buffer";
13
+ import { X509Certificate } from "node:crypto";
14
+ import * as net from "node:net";
15
+ import * as stream from "stream";
16
+ const CLIENT_RENEG_LIMIT: number;
17
+ const CLIENT_RENEG_WINDOW: number;
18
+ interface Certificate {
19
+ /**
20
+ * Country code.
21
+ */
22
+ C: string;
23
+ /**
24
+ * Street.
25
+ */
26
+ ST: string;
27
+ /**
28
+ * Locality.
29
+ */
30
+ L: string;
31
+ /**
32
+ * Organization.
33
+ */
34
+ O: string;
35
+ /**
36
+ * Organizational unit.
37
+ */
38
+ OU: string;
39
+ /**
40
+ * Common name.
41
+ */
42
+ CN: string;
43
+ }
44
+ interface PeerCertificate {
45
+ /**
46
+ * `true` if a Certificate Authority (CA), `false` otherwise.
47
+ * @since v18.13.0
48
+ */
49
+ ca: boolean;
50
+ /**
51
+ * The DER encoded X.509 certificate data.
52
+ */
53
+ raw: NonSharedBuffer;
54
+ /**
55
+ * The certificate subject.
56
+ */
57
+ subject: Certificate;
58
+ /**
59
+ * The certificate issuer, described in the same terms as the `subject`.
60
+ */
61
+ issuer: Certificate;
62
+ /**
63
+ * The date-time the certificate is valid from.
64
+ */
65
+ valid_from: string;
66
+ /**
67
+ * The date-time the certificate is valid to.
68
+ */
69
+ valid_to: string;
70
+ /**
71
+ * The certificate serial number, as a hex string.
72
+ */
73
+ serialNumber: string;
74
+ /**
75
+ * The SHA-1 digest of the DER encoded certificate.
76
+ * It is returned as a `:` separated hexadecimal string.
77
+ */
78
+ fingerprint: string;
79
+ /**
80
+ * The SHA-256 digest of the DER encoded certificate.
81
+ * It is returned as a `:` separated hexadecimal string.
82
+ */
83
+ fingerprint256: string;
84
+ /**
85
+ * The SHA-512 digest of the DER encoded certificate.
86
+ * It is returned as a `:` separated hexadecimal string.
87
+ */
88
+ fingerprint512: string;
89
+ /**
90
+ * The extended key usage, a set of OIDs.
91
+ */
92
+ ext_key_usage?: string[];
93
+ /**
94
+ * A string containing concatenated names for the subject,
95
+ * an alternative to the `subject` names.
96
+ */
97
+ subjectaltname?: string;
98
+ /**
99
+ * An array describing the AuthorityInfoAccess, used with OCSP.
100
+ */
101
+ infoAccess?: NodeJS.Dict<string[]>;
102
+ /**
103
+ * For RSA keys: The RSA bit size.
104
+ *
105
+ * For EC keys: The key size in bits.
106
+ */
107
+ bits?: number;
108
+ /**
109
+ * The RSA exponent, as a string in hexadecimal number notation.
110
+ */
111
+ exponent?: string;
112
+ /**
113
+ * The RSA modulus, as a hexadecimal string.
114
+ */
115
+ modulus?: string;
116
+ /**
117
+ * The public key.
118
+ */
119
+ pubkey?: NonSharedBuffer;
120
+ /**
121
+ * The ASN.1 name of the OID of the elliptic curve.
122
+ * Well-known curves are identified by an OID.
123
+ * While it is unusual, it is possible that the curve
124
+ * is identified by its mathematical properties,
125
+ * in which case it will not have an OID.
126
+ */
127
+ asn1Curve?: string;
128
+ /**
129
+ * The NIST name for the elliptic curve, if it has one
130
+ * (not all well-known curves have been assigned names by NIST).
131
+ */
132
+ nistCurve?: string;
133
+ }
134
+ interface DetailedPeerCertificate extends PeerCertificate {
135
+ /**
136
+ * The issuer certificate object.
137
+ * For self-signed certificates, this may be a circular reference.
138
+ */
139
+ issuerCertificate: DetailedPeerCertificate;
140
+ }
141
+ interface CipherNameAndProtocol {
142
+ /**
143
+ * The cipher name.
144
+ */
145
+ name: string;
146
+ /**
147
+ * SSL/TLS protocol version.
148
+ */
149
+ version: string;
150
+ /**
151
+ * IETF name for the cipher suite.
152
+ */
153
+ standardName: string;
154
+ }
155
+ interface EphemeralKeyInfo {
156
+ /**
157
+ * The supported types are 'DH' and 'ECDH'.
158
+ */
159
+ type: string;
160
+ /**
161
+ * The name property is available only when type is 'ECDH'.
162
+ */
163
+ name?: string | undefined;
164
+ /**
165
+ * The size of parameter of an ephemeral key exchange.
166
+ */
167
+ size: number;
168
+ }
169
+ interface KeyObject {
170
+ /**
171
+ * Private keys in PEM format.
172
+ */
173
+ pem: string | Buffer;
174
+ /**
175
+ * Optional passphrase.
176
+ */
177
+ passphrase?: string | undefined;
178
+ }
179
+ interface PxfObject {
180
+ /**
181
+ * PFX or PKCS12 encoded private key and certificate chain.
182
+ */
183
+ buf: string | Buffer;
184
+ /**
185
+ * Optional passphrase.
186
+ */
187
+ passphrase?: string | undefined;
188
+ }
189
+ interface TLSSocketOptions extends SecureContextOptions, CommonConnectionOptions {
190
+ /**
191
+ * If true the TLS socket will be instantiated in server-mode.
192
+ * Defaults to false.
193
+ */
194
+ isServer?: boolean | undefined;
195
+ /**
196
+ * An optional net.Server instance.
197
+ */
198
+ server?: net.Server | undefined;
199
+ /**
200
+ * An optional Buffer instance containing a TLS session.
201
+ */
202
+ session?: Buffer | undefined;
203
+ /**
204
+ * If true, specifies that the OCSP status request extension will be
205
+ * added to the client hello and an 'OCSPResponse' event will be
206
+ * emitted on the socket before establishing a secure communication
207
+ */
208
+ requestOCSP?: boolean | undefined;
209
+ }
210
+ /**
211
+ * Performs transparent encryption of written data and all required TLS
212
+ * negotiation.
213
+ *
214
+ * Instances of `tls.TLSSocket` implement the duplex `Stream` interface.
215
+ *
216
+ * Methods that return TLS connection metadata (e.g.{@link TLSSocket.getPeerCertificate}) will only return data while the
217
+ * connection is open.
218
+ * @since v0.11.4
219
+ */
220
+ class TLSSocket extends net.Socket {
221
+ /**
222
+ * Construct a new tls.TLSSocket object from an existing TCP socket.
223
+ */
224
+ constructor(socket: net.Socket | stream.Duplex, options?: TLSSocketOptions);
225
+ /**
226
+ * This property is `true` if the peer certificate was signed by one of the CAs
227
+ * specified when creating the `tls.TLSSocket` instance, otherwise `false`.
228
+ * @since v0.11.4
229
+ */
230
+ authorized: boolean;
231
+ /**
232
+ * Returns the reason why the peer's certificate was not been verified. This
233
+ * property is set only when `tlsSocket.authorized === false`.
234
+ * @since v0.11.4
235
+ */
236
+ authorizationError: Error;
237
+ /**
238
+ * Always returns `true`. This may be used to distinguish TLS sockets from regular`net.Socket` instances.
239
+ * @since v0.11.4
240
+ */
241
+ encrypted: true;
242
+ /**
243
+ * String containing the selected ALPN protocol.
244
+ * Before a handshake has completed, this value is always null.
245
+ * When a handshake is completed but not ALPN protocol was selected, tlsSocket.alpnProtocol equals false.
246
+ */
247
+ alpnProtocol: string | false | null;
248
+ /**
249
+ * Returns an object representing the local certificate. The returned object has
250
+ * some properties corresponding to the fields of the certificate.
251
+ *
252
+ * See {@link TLSSocket.getPeerCertificate} for an example of the certificate
253
+ * structure.
254
+ *
255
+ * If there is no local certificate, an empty object will be returned. If the
256
+ * socket has been destroyed, `null` will be returned.
257
+ * @since v11.2.0
258
+ */
259
+ getCertificate(): PeerCertificate | object | null;
260
+ /**
261
+ * Returns an object containing information on the negotiated cipher suite.
262
+ *
263
+ * For example, a TLSv1.2 protocol with AES256-SHA cipher:
264
+ *
265
+ * ```json
266
+ * {
267
+ * "name": "AES256-SHA",
268
+ * "standardName": "TLS_RSA_WITH_AES_256_CBC_SHA",
269
+ * "version": "SSLv3"
270
+ * }
271
+ * ```
272
+ *
273
+ * See [SSL\_CIPHER\_get\_name](https://www.openssl.org/docs/man1.1.1/man3/SSL_CIPHER_get_name.html) for more information.
274
+ * @since v0.11.4
275
+ */
276
+ getCipher(): CipherNameAndProtocol;
277
+ /**
278
+ * Returns an object representing the type, name, and size of parameter of
279
+ * an ephemeral key exchange in `perfect forward secrecy` on a client
280
+ * connection. It returns an empty object when the key exchange is not
281
+ * ephemeral. As this is only supported on a client socket; `null` is returned
282
+ * if called on a server socket. The supported types are `'DH'` and `'ECDH'`. The `name` property is available only when type is `'ECDH'`.
283
+ *
284
+ * For example: `{ type: 'ECDH', name: 'prime256v1', size: 256 }`.
285
+ * @since v5.0.0
286
+ */
287
+ getEphemeralKeyInfo(): EphemeralKeyInfo | object | null;
288
+ /**
289
+ * As the `Finished` messages are message digests of the complete handshake
290
+ * (with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can
291
+ * be used for external authentication procedures when the authentication
292
+ * provided by SSL/TLS is not desired or is not enough.
293
+ *
294
+ * Corresponds to the `SSL_get_finished` routine in OpenSSL and may be used
295
+ * to implement the `tls-unique` channel binding from [RFC 5929](https://tools.ietf.org/html/rfc5929).
296
+ * @since v9.9.0
297
+ * @return The latest `Finished` message that has been sent to the socket as part of a SSL/TLS handshake, or `undefined` if no `Finished` message has been sent yet.
298
+ */
299
+ getFinished(): NonSharedBuffer | undefined;
300
+ /**
301
+ * Returns an object representing the peer's certificate. If the peer does not
302
+ * provide a certificate, an empty object will be returned. If the socket has been
303
+ * destroyed, `null` will be returned.
304
+ *
305
+ * If the full certificate chain was requested, each certificate will include an`issuerCertificate` property containing an object representing its issuer's
306
+ * certificate.
307
+ * @since v0.11.4
308
+ * @param detailed Include the full certificate chain if `true`, otherwise include just the peer's certificate.
309
+ * @return A certificate object.
310
+ */
311
+ getPeerCertificate(detailed: true): DetailedPeerCertificate;
312
+ getPeerCertificate(detailed?: false): PeerCertificate;
313
+ getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate;
314
+ /**
315
+ * As the `Finished` messages are message digests of the complete handshake
316
+ * (with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can
317
+ * be used for external authentication procedures when the authentication
318
+ * provided by SSL/TLS is not desired or is not enough.
319
+ *
320
+ * Corresponds to the `SSL_get_peer_finished` routine in OpenSSL and may be used
321
+ * to implement the `tls-unique` channel binding from [RFC 5929](https://tools.ietf.org/html/rfc5929).
322
+ * @since v9.9.0
323
+ * @return The latest `Finished` message that is expected or has actually been received from the socket as part of a SSL/TLS handshake, or `undefined` if there is no `Finished` message so
324
+ * far.
325
+ */
326
+ getPeerFinished(): NonSharedBuffer | undefined;
327
+ /**
328
+ * Returns a string containing the negotiated SSL/TLS protocol version of the
329
+ * current connection. The value `'unknown'` will be returned for connected
330
+ * sockets that have not completed the handshaking process. The value `null` will
331
+ * be returned for server sockets or disconnected client sockets.
332
+ *
333
+ * Protocol versions are:
334
+ *
335
+ * * `'SSLv3'`
336
+ * * `'TLSv1'`
337
+ * * `'TLSv1.1'`
338
+ * * `'TLSv1.2'`
339
+ * * `'TLSv1.3'`
340
+ *
341
+ * See the OpenSSL [`SSL_get_version`](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html) documentation for more information.
342
+ * @since v5.7.0
343
+ */
344
+ getProtocol(): string | null;
345
+ /**
346
+ * Returns the TLS session data or `undefined` if no session was
347
+ * negotiated. On the client, the data can be provided to the `session` option of {@link connect} to resume the connection. On the server, it may be useful
348
+ * for debugging.
349
+ *
350
+ * See `Session Resumption` for more information.
351
+ *
352
+ * Note: `getSession()` works only for TLSv1.2 and below. For TLSv1.3, applications
353
+ * must use the `'session'` event (it also works for TLSv1.2 and below).
354
+ * @since v0.11.4
355
+ */
356
+ getSession(): NonSharedBuffer | undefined;
357
+ /**
358
+ * See [SSL\_get\_shared\_sigalgs](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_shared_sigalgs.html) for more information.
359
+ * @since v12.11.0
360
+ * @return List of signature algorithms shared between the server and the client in the order of decreasing preference.
361
+ */
362
+ getSharedSigalgs(): string[];
363
+ /**
364
+ * For a client, returns the TLS session ticket if one is available, or`undefined`. For a server, always returns `undefined`.
365
+ *
366
+ * It may be useful for debugging.
367
+ *
368
+ * See `Session Resumption` for more information.
369
+ * @since v0.11.4
370
+ */
371
+ getTLSTicket(): NonSharedBuffer | undefined;
372
+ /**
373
+ * See `Session Resumption` for more information.
374
+ * @since v0.5.6
375
+ * @return `true` if the session was reused, `false` otherwise.
376
+ */
377
+ isSessionReused(): boolean;
378
+ /**
379
+ * The `tlsSocket.renegotiate()` method initiates a TLS renegotiation process.
380
+ * Upon completion, the `callback` function will be passed a single argument
381
+ * that is either an `Error` (if the request failed) or `null`.
382
+ *
383
+ * This method can be used to request a peer's certificate after the secure
384
+ * connection has been established.
385
+ *
386
+ * When running as the server, the socket will be destroyed with an error after `handshakeTimeout` timeout.
387
+ *
388
+ * For TLSv1.3, renegotiation cannot be initiated, it is not supported by the
389
+ * protocol.
390
+ * @since v0.11.8
391
+ * @param callback If `renegotiate()` returned `true`, callback is attached once to the `'secure'` event. If `renegotiate()` returned `false`, `callback` will be called in the next tick with
392
+ * an error, unless the `tlsSocket` has been destroyed, in which case `callback` will not be called at all.
393
+ * @return `true` if renegotiation was initiated, `false` otherwise.
394
+ */
395
+ renegotiate(
396
+ options: {
397
+ rejectUnauthorized?: boolean | undefined;
398
+ requestCert?: boolean | undefined;
399
+ },
400
+ callback: (err: Error | null) => void,
401
+ ): undefined | boolean;
402
+ /**
403
+ * The `tlsSocket.setKeyCert()` method sets the private key and certificate to use for the socket.
404
+ * This is mainly useful if you wish to select a server certificate from a TLS server's `ALPNCallback`.
405
+ * @since v22.5.0, v20.17.0
406
+ * @param context An object containing at least `key` and `cert` properties from the {@link createSecureContext()} `options`,
407
+ * or a TLS context object created with {@link createSecureContext()} itself.
408
+ */
409
+ setKeyCert(context: SecureContextOptions | SecureContext): void;
410
+ /**
411
+ * The `tlsSocket.setMaxSendFragment()` method sets the maximum TLS fragment size.
412
+ * Returns `true` if setting the limit succeeded; `false` otherwise.
413
+ *
414
+ * Smaller fragment sizes decrease the buffering latency on the client: larger
415
+ * fragments are buffered by the TLS layer until the entire fragment is received
416
+ * and its integrity is verified; large fragments can span multiple roundtrips
417
+ * and their processing can be delayed due to packet loss or reordering. However,
418
+ * smaller fragments add extra TLS framing bytes and CPU overhead, which may
419
+ * decrease overall server throughput.
420
+ * @since v0.11.11
421
+ * @param [size=16384] The maximum TLS fragment size. The maximum value is `16384`.
422
+ */
423
+ setMaxSendFragment(size: number): boolean;
424
+ /**
425
+ * Disables TLS renegotiation for this `TLSSocket` instance. Once called, attempts
426
+ * to renegotiate will trigger an `'error'` event on the `TLSSocket`.
427
+ * @since v8.4.0
428
+ */
429
+ disableRenegotiation(): void;
430
+ /**
431
+ * When enabled, TLS packet trace information is written to `stderr`. This can be
432
+ * used to debug TLS connection problems.
433
+ *
434
+ * The format of the output is identical to the output of`openssl s_client -trace` or `openssl s_server -trace`. While it is produced by
435
+ * OpenSSL's `SSL_trace()` function, the format is undocumented, can change
436
+ * without notice, and should not be relied on.
437
+ * @since v12.2.0
438
+ */
439
+ enableTrace(): void;
440
+ /**
441
+ * Returns the peer certificate as an `X509Certificate` object.
442
+ *
443
+ * If there is no peer certificate, or the socket has been destroyed,`undefined` will be returned.
444
+ * @since v15.9.0
445
+ */
446
+ getPeerX509Certificate(): X509Certificate | undefined;
447
+ /**
448
+ * Returns the local certificate as an `X509Certificate` object.
449
+ *
450
+ * If there is no local certificate, or the socket has been destroyed,`undefined` will be returned.
451
+ * @since v15.9.0
452
+ */
453
+ getX509Certificate(): X509Certificate | undefined;
454
+ /**
455
+ * Keying material is used for validations to prevent different kind of attacks in
456
+ * network protocols, for example in the specifications of IEEE 802.1X.
457
+ *
458
+ * Example
459
+ *
460
+ * ```js
461
+ * const keyingMaterial = tlsSocket.exportKeyingMaterial(
462
+ * 128,
463
+ * 'client finished');
464
+ *
465
+ * /*
466
+ * Example return value of keyingMaterial:
467
+ * <Buffer 76 26 af 99 c5 56 8e 42 09 91 ef 9f 93 cb ad 6c 7b 65 f8 53 f1 d8 d9
468
+ * 12 5a 33 b8 b5 25 df 7b 37 9f e0 e2 4f b8 67 83 a3 2f cd 5d 41 42 4c 91
469
+ * 74 ef 2c ... 78 more bytes>
470
+ *
471
+ * ```
472
+ *
473
+ * See the OpenSSL [`SSL_export_keying_material`](https://www.openssl.org/docs/man1.1.1/man3/SSL_export_keying_material.html) documentation for more
474
+ * information.
475
+ * @since v13.10.0, v12.17.0
476
+ * @param length number of bytes to retrieve from keying material
477
+ * @param label an application specific label, typically this will be a value from the [IANA Exporter Label
478
+ * Registry](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels).
479
+ * @param context Optionally provide a context.
480
+ * @return requested bytes of the keying material
481
+ */
482
+ exportKeyingMaterial(length: number, label: string, context: Buffer): NonSharedBuffer;
483
+ addListener(event: string, listener: (...args: any[]) => void): this;
484
+ addListener(event: "OCSPResponse", listener: (response: NonSharedBuffer) => void): this;
485
+ addListener(event: "secureConnect", listener: () => void): this;
486
+ addListener(event: "session", listener: (session: NonSharedBuffer) => void): this;
487
+ addListener(event: "keylog", listener: (line: NonSharedBuffer) => void): this;
488
+ emit(event: string | symbol, ...args: any[]): boolean;
489
+ emit(event: "OCSPResponse", response: NonSharedBuffer): boolean;
490
+ emit(event: "secureConnect"): boolean;
491
+ emit(event: "session", session: NonSharedBuffer): boolean;
492
+ emit(event: "keylog", line: NonSharedBuffer): boolean;
493
+ on(event: string, listener: (...args: any[]) => void): this;
494
+ on(event: "OCSPResponse", listener: (response: NonSharedBuffer) => void): this;
495
+ on(event: "secureConnect", listener: () => void): this;
496
+ on(event: "session", listener: (session: NonSharedBuffer) => void): this;
497
+ on(event: "keylog", listener: (line: NonSharedBuffer) => void): this;
498
+ once(event: string, listener: (...args: any[]) => void): this;
499
+ once(event: "OCSPResponse", listener: (response: NonSharedBuffer) => void): this;
500
+ once(event: "secureConnect", listener: () => void): this;
501
+ once(event: "session", listener: (session: NonSharedBuffer) => void): this;
502
+ once(event: "keylog", listener: (line: NonSharedBuffer) => void): this;
503
+ prependListener(event: string, listener: (...args: any[]) => void): this;
504
+ prependListener(event: "OCSPResponse", listener: (response: NonSharedBuffer) => void): this;
505
+ prependListener(event: "secureConnect", listener: () => void): this;
506
+ prependListener(event: "session", listener: (session: NonSharedBuffer) => void): this;
507
+ prependListener(event: "keylog", listener: (line: NonSharedBuffer) => void): this;
508
+ prependOnceListener(event: string, listener: (...args: any[]) => void): this;
509
+ prependOnceListener(event: "OCSPResponse", listener: (response: NonSharedBuffer) => void): this;
510
+ prependOnceListener(event: "secureConnect", listener: () => void): this;
511
+ prependOnceListener(event: "session", listener: (session: NonSharedBuffer) => void): this;
512
+ prependOnceListener(event: "keylog", listener: (line: NonSharedBuffer) => void): this;
513
+ }
514
+ interface CommonConnectionOptions {
515
+ /**
516
+ * An optional TLS context object from tls.createSecureContext()
517
+ */
518
+ secureContext?: SecureContext | undefined;
519
+ /**
520
+ * When enabled, TLS packet trace information is written to `stderr`. This can be
521
+ * used to debug TLS connection problems.
522
+ * @default false
523
+ */
524
+ enableTrace?: boolean | undefined;
525
+ /**
526
+ * If true the server will request a certificate from clients that
527
+ * connect and attempt to verify that certificate. Defaults to
528
+ * false.
529
+ */
530
+ requestCert?: boolean | undefined;
531
+ /**
532
+ * An array of strings or a Buffer naming possible ALPN protocols.
533
+ * (Protocols should be ordered by their priority.)
534
+ */
535
+ ALPNProtocols?: readonly string[] | NodeJS.ArrayBufferView | undefined;
536
+ /**
537
+ * SNICallback(servername, cb) <Function> A function that will be
538
+ * called if the client supports SNI TLS extension. Two arguments
539
+ * will be passed when called: servername and cb. SNICallback should
540
+ * invoke cb(null, ctx), where ctx is a SecureContext instance.
541
+ * (tls.createSecureContext(...) can be used to get a proper
542
+ * SecureContext.) If SNICallback wasn't provided the default callback
543
+ * with high-level API will be used (see below).
544
+ */
545
+ SNICallback?: ((servername: string, cb: (err: Error | null, ctx?: SecureContext) => void) => void) | undefined;
546
+ /**
547
+ * If true the server will reject any connection which is not
548
+ * authorized with the list of supplied CAs. This option only has an
549
+ * effect if requestCert is true.
550
+ * @default true
551
+ */
552
+ rejectUnauthorized?: boolean | undefined;
553
+ }
554
+ interface TlsOptions extends SecureContextOptions, CommonConnectionOptions, net.ServerOpts {
555
+ /**
556
+ * Abort the connection if the SSL/TLS handshake does not finish in the
557
+ * specified number of milliseconds. A 'tlsClientError' is emitted on
558
+ * the tls.Server object whenever a handshake times out. Default:
559
+ * 120000 (120 seconds).
560
+ */
561
+ handshakeTimeout?: number | undefined;
562
+ /**
563
+ * The number of seconds after which a TLS session created by the
564
+ * server will no longer be resumable. See Session Resumption for more
565
+ * information. Default: 300.
566
+ */
567
+ sessionTimeout?: number | undefined;
568
+ /**
569
+ * 48-bytes of cryptographically strong pseudo-random data.
570
+ */
571
+ ticketKeys?: Buffer | undefined;
572
+ /**
573
+ * @param socket
574
+ * @param identity identity parameter sent from the client.
575
+ * @return pre-shared key that must either be
576
+ * a buffer or `null` to stop the negotiation process. Returned PSK must be
577
+ * compatible with the selected cipher's digest.
578
+ *
579
+ * When negotiating TLS-PSK (pre-shared keys), this function is called
580
+ * with the identity provided by the client.
581
+ * If the return value is `null` the negotiation process will stop and an
582
+ * "unknown_psk_identity" alert message will be sent to the other party.
583
+ * If the server wishes to hide the fact that the PSK identity was not known,
584
+ * the callback must provide some random data as `psk` to make the connection
585
+ * fail with "decrypt_error" before negotiation is finished.
586
+ * PSK ciphers are disabled by default, and using TLS-PSK thus
587
+ * requires explicitly specifying a cipher suite with the `ciphers` option.
588
+ * More information can be found in the RFC 4279.
589
+ */
590
+ pskCallback?: ((socket: TLSSocket, identity: string) => NodeJS.ArrayBufferView | null) | undefined;
591
+ /**
592
+ * hint to send to a client to help
593
+ * with selecting the identity during TLS-PSK negotiation. Will be ignored
594
+ * in TLS 1.3. Upon failing to set pskIdentityHint `tlsClientError` will be
595
+ * emitted with `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED` code.
596
+ */
597
+ pskIdentityHint?: string | undefined;
598
+ }
599
+ interface PSKCallbackNegotation {
600
+ psk: NodeJS.ArrayBufferView;
601
+ identity: string;
602
+ }
603
+ interface ConnectionOptions extends SecureContextOptions, CommonConnectionOptions {
604
+ host?: string | undefined;
605
+ port?: number | undefined;
606
+ path?: string | undefined; // Creates unix socket connection to path. If this option is specified, `host` and `port` are ignored.
607
+ socket?: stream.Duplex | undefined; // Establish secure connection on a given socket rather than creating a new socket
608
+ checkServerIdentity?: typeof checkServerIdentity | undefined;
609
+ servername?: string | undefined; // SNI TLS Extension
610
+ session?: Buffer | undefined;
611
+ minDHSize?: number | undefined;
612
+ lookup?: net.LookupFunction | undefined;
613
+ timeout?: number | undefined;
614
+ /**
615
+ * When negotiating TLS-PSK (pre-shared keys), this function is called
616
+ * with optional identity `hint` provided by the server or `null`
617
+ * in case of TLS 1.3 where `hint` was removed.
618
+ * It will be necessary to provide a custom `tls.checkServerIdentity()`
619
+ * for the connection as the default one will try to check hostname/IP
620
+ * of the server against the certificate but that's not applicable for PSK
621
+ * because there won't be a certificate present.
622
+ * More information can be found in the RFC 4279.
623
+ *
624
+ * @param hint message sent from the server to help client
625
+ * decide which identity to use during negotiation.
626
+ * Always `null` if TLS 1.3 is used.
627
+ * @returns Return `null` to stop the negotiation process. `psk` must be
628
+ * compatible with the selected cipher's digest.
629
+ * `identity` must use UTF-8 encoding.
630
+ */
631
+ pskCallback?: ((hint: string | null) => PSKCallbackNegotation | null) | undefined;
632
+ }
633
+ /**
634
+ * Accepts encrypted connections using TLS or SSL.
635
+ * @since v0.3.2
636
+ */
637
+ class Server extends net.Server {
638
+ constructor(secureConnectionListener?: (socket: TLSSocket) => void);
639
+ constructor(options: TlsOptions, secureConnectionListener?: (socket: TLSSocket) => void);
640
+ /**
641
+ * The `server.addContext()` method adds a secure context that will be used if
642
+ * the client request's SNI name matches the supplied `hostname` (or wildcard).
643
+ *
644
+ * When there are multiple matching contexts, the most recently added one is
645
+ * used.
646
+ * @since v0.5.3
647
+ * @param hostname A SNI host name or wildcard (e.g. `'*'`)
648
+ * @param context An object containing any of the possible properties from the {@link createSecureContext} `options` arguments (e.g. `key`, `cert`, `ca`, etc), or a TLS context object created
649
+ * with {@link createSecureContext} itself.
650
+ */
651
+ addContext(hostname: string, context: SecureContextOptions | SecureContext): void;
652
+ /**
653
+ * Returns the session ticket keys.
654
+ *
655
+ * See `Session Resumption` for more information.
656
+ * @since v3.0.0
657
+ * @return A 48-byte buffer containing the session ticket keys.
658
+ */
659
+ getTicketKeys(): NonSharedBuffer;
660
+ /**
661
+ * The `server.setSecureContext()` method replaces the secure context of an
662
+ * existing server. Existing connections to the server are not interrupted.
663
+ * @since v11.0.0
664
+ * @param options An object containing any of the possible properties from the {@link createSecureContext} `options` arguments (e.g. `key`, `cert`, `ca`, etc).
665
+ */
666
+ setSecureContext(options: SecureContextOptions): void;
667
+ /**
668
+ * Sets the session ticket keys.
669
+ *
670
+ * Changes to the ticket keys are effective only for future server connections.
671
+ * Existing or currently pending server connections will use the previous keys.
672
+ *
673
+ * See `Session Resumption` for more information.
674
+ * @since v3.0.0
675
+ * @param keys A 48-byte buffer containing the session ticket keys.
676
+ */
677
+ setTicketKeys(keys: Buffer): void;
678
+ /**
679
+ * events.EventEmitter
680
+ * 1. tlsClientError
681
+ * 2. newSession
682
+ * 3. OCSPRequest
683
+ * 4. resumeSession
684
+ * 5. secureConnection
685
+ * 6. keylog
686
+ */
687
+ addListener(event: string, listener: (...args: any[]) => void): this;
688
+ addListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
689
+ addListener(
690
+ event: "newSession",
691
+ listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void,
692
+ ): this;
693
+ addListener(
694
+ event: "OCSPRequest",
695
+ listener: (
696
+ certificate: NonSharedBuffer,
697
+ issuer: NonSharedBuffer,
698
+ callback: (err: Error | null, resp: Buffer | null) => void,
699
+ ) => void,
700
+ ): this;
701
+ addListener(
702
+ event: "resumeSession",
703
+ listener: (
704
+ sessionId: NonSharedBuffer,
705
+ callback: (err: Error | null, sessionData: Buffer | null) => void,
706
+ ) => void,
707
+ ): this;
708
+ addListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
709
+ addListener(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: TLSSocket) => void): this;
710
+ emit(event: string | symbol, ...args: any[]): boolean;
711
+ emit(event: "tlsClientError", err: Error, tlsSocket: TLSSocket): boolean;
712
+ emit(
713
+ event: "newSession",
714
+ sessionId: NonSharedBuffer,
715
+ sessionData: NonSharedBuffer,
716
+ callback: () => void,
717
+ ): boolean;
718
+ emit(
719
+ event: "OCSPRequest",
720
+ certificate: NonSharedBuffer,
721
+ issuer: NonSharedBuffer,
722
+ callback: (err: Error | null, resp: Buffer | null) => void,
723
+ ): boolean;
724
+ emit(
725
+ event: "resumeSession",
726
+ sessionId: NonSharedBuffer,
727
+ callback: (err: Error | null, sessionData: Buffer | null) => void,
728
+ ): boolean;
729
+ emit(event: "secureConnection", tlsSocket: TLSSocket): boolean;
730
+ emit(event: "keylog", line: NonSharedBuffer, tlsSocket: TLSSocket): boolean;
731
+ on(event: string, listener: (...args: any[]) => void): this;
732
+ on(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
733
+ on(
734
+ event: "newSession",
735
+ listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void,
736
+ ): this;
737
+ on(
738
+ event: "OCSPRequest",
739
+ listener: (
740
+ certificate: NonSharedBuffer,
741
+ issuer: NonSharedBuffer,
742
+ callback: (err: Error | null, resp: Buffer | null) => void,
743
+ ) => void,
744
+ ): this;
745
+ on(
746
+ event: "resumeSession",
747
+ listener: (
748
+ sessionId: NonSharedBuffer,
749
+ callback: (err: Error | null, sessionData: Buffer | null) => void,
750
+ ) => void,
751
+ ): this;
752
+ on(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
753
+ on(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: TLSSocket) => void): this;
754
+ once(event: string, listener: (...args: any[]) => void): this;
755
+ once(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
756
+ once(
757
+ event: "newSession",
758
+ listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void,
759
+ ): this;
760
+ once(
761
+ event: "OCSPRequest",
762
+ listener: (
763
+ certificate: NonSharedBuffer,
764
+ issuer: NonSharedBuffer,
765
+ callback: (err: Error | null, resp: Buffer | null) => void,
766
+ ) => void,
767
+ ): this;
768
+ once(
769
+ event: "resumeSession",
770
+ listener: (
771
+ sessionId: NonSharedBuffer,
772
+ callback: (err: Error | null, sessionData: Buffer | null) => void,
773
+ ) => void,
774
+ ): this;
775
+ once(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
776
+ once(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: TLSSocket) => void): this;
777
+ prependListener(event: string, listener: (...args: any[]) => void): this;
778
+ prependListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
779
+ prependListener(
780
+ event: "newSession",
781
+ listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void,
782
+ ): this;
783
+ prependListener(
784
+ event: "OCSPRequest",
785
+ listener: (
786
+ certificate: NonSharedBuffer,
787
+ issuer: NonSharedBuffer,
788
+ callback: (err: Error | null, resp: Buffer | null) => void,
789
+ ) => void,
790
+ ): this;
791
+ prependListener(
792
+ event: "resumeSession",
793
+ listener: (
794
+ sessionId: NonSharedBuffer,
795
+ callback: (err: Error | null, sessionData: Buffer | null) => void,
796
+ ) => void,
797
+ ): this;
798
+ prependListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
799
+ prependListener(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: TLSSocket) => void): this;
800
+ prependOnceListener(event: string, listener: (...args: any[]) => void): this;
801
+ prependOnceListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
802
+ prependOnceListener(
803
+ event: "newSession",
804
+ listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void,
805
+ ): this;
806
+ prependOnceListener(
807
+ event: "OCSPRequest",
808
+ listener: (
809
+ certificate: NonSharedBuffer,
810
+ issuer: NonSharedBuffer,
811
+ callback: (err: Error | null, resp: Buffer | null) => void,
812
+ ) => void,
813
+ ): this;
814
+ prependOnceListener(
815
+ event: "resumeSession",
816
+ listener: (
817
+ sessionId: NonSharedBuffer,
818
+ callback: (err: Error | null, sessionData: Buffer | null) => void,
819
+ ) => void,
820
+ ): this;
821
+ prependOnceListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
822
+ prependOnceListener(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: TLSSocket) => void): this;
823
+ }
824
+ /**
825
+ * @deprecated since v0.11.3 Use `tls.TLSSocket` instead.
826
+ */
827
+ interface SecurePair {
828
+ encrypted: TLSSocket;
829
+ cleartext: TLSSocket;
830
+ }
831
+ type SecureVersion = "TLSv1.3" | "TLSv1.2" | "TLSv1.1" | "TLSv1";
832
+ interface SecureContextOptions {
833
+ /**
834
+ * If set, this will be called when a client opens a connection using the ALPN extension.
835
+ * One argument will be passed to the callback: an object containing `servername` and `protocols` fields,
836
+ * respectively containing the server name from the SNI extension (if any) and an array of
837
+ * ALPN protocol name strings. The callback must return either one of the strings listed in `protocols`,
838
+ * which will be returned to the client as the selected ALPN protocol, or `undefined`,
839
+ * to reject the connection with a fatal alert. If a string is returned that does not match one of
840
+ * the client's ALPN protocols, an error will be thrown.
841
+ * This option cannot be used with the `ALPNProtocols` option, and setting both options will throw an error.
842
+ */
843
+ ALPNCallback?: ((arg: { servername: string; protocols: string[] }) => string | undefined) | undefined;
844
+ /**
845
+ * Treat intermediate (non-self-signed)
846
+ * certificates in the trust CA certificate list as trusted.
847
+ * @since v22.9.0, v20.18.0
848
+ */
849
+ allowPartialTrustChain?: boolean | undefined;
850
+ /**
851
+ * Optionally override the trusted CA certificates. Default is to trust
852
+ * the well-known CAs curated by Mozilla. Mozilla's CAs are completely
853
+ * replaced when CAs are explicitly specified using this option.
854
+ */
855
+ ca?: string | Buffer | Array<string | Buffer> | undefined;
856
+ /**
857
+ * Cert chains in PEM format. One cert chain should be provided per
858
+ * private key. Each cert chain should consist of the PEM formatted
859
+ * certificate for a provided private key, followed by the PEM
860
+ * formatted intermediate certificates (if any), in order, and not
861
+ * including the root CA (the root CA must be pre-known to the peer,
862
+ * see ca). When providing multiple cert chains, they do not have to
863
+ * be in the same order as their private keys in key. If the
864
+ * intermediate certificates are not provided, the peer will not be
865
+ * able to validate the certificate, and the handshake will fail.
866
+ */
867
+ cert?: string | Buffer | Array<string | Buffer> | undefined;
868
+ /**
869
+ * Colon-separated list of supported signature algorithms. The list
870
+ * can contain digest algorithms (SHA256, MD5 etc.), public key
871
+ * algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g
872
+ * 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).
873
+ */
874
+ sigalgs?: string | undefined;
875
+ /**
876
+ * Cipher suite specification, replacing the default. For more
877
+ * information, see modifying the default cipher suite. Permitted
878
+ * ciphers can be obtained via tls.getCiphers(). Cipher names must be
879
+ * uppercased in order for OpenSSL to accept them.
880
+ */
881
+ ciphers?: string | undefined;
882
+ /**
883
+ * Name of an OpenSSL engine which can provide the client certificate.
884
+ */
885
+ clientCertEngine?: string | undefined;
886
+ /**
887
+ * PEM formatted CRLs (Certificate Revocation Lists).
888
+ */
889
+ crl?: string | Buffer | Array<string | Buffer> | undefined;
890
+ /**
891
+ * `'auto'` or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy.
892
+ * If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
893
+ * ECDHE-based perfect forward secrecy will still be available.
894
+ */
895
+ dhparam?: string | Buffer | undefined;
896
+ /**
897
+ * A string describing a named curve or a colon separated list of curve
898
+ * NIDs or names, for example P-521:P-384:P-256, to use for ECDH key
899
+ * agreement. Set to auto to select the curve automatically. Use
900
+ * crypto.getCurves() to obtain a list of available curve names. On
901
+ * recent releases, openssl ecparam -list_curves will also display the
902
+ * name and description of each available elliptic curve. Default:
903
+ * tls.DEFAULT_ECDH_CURVE.
904
+ */
905
+ ecdhCurve?: string | undefined;
906
+ /**
907
+ * Attempt to use the server's cipher suite preferences instead of the
908
+ * client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be
909
+ * set in secureOptions
910
+ */
911
+ honorCipherOrder?: boolean | undefined;
912
+ /**
913
+ * Private keys in PEM format. PEM allows the option of private keys
914
+ * being encrypted. Encrypted keys will be decrypted with
915
+ * options.passphrase. Multiple keys using different algorithms can be
916
+ * provided either as an array of unencrypted key strings or buffers,
917
+ * or an array of objects in the form {pem: <string|buffer>[,
918
+ * passphrase: <string>]}. The object form can only occur in an array.
919
+ * object.passphrase is optional. Encrypted keys will be decrypted with
920
+ * object.passphrase if provided, or options.passphrase if it is not.
921
+ */
922
+ key?: string | Buffer | Array<string | Buffer | KeyObject> | undefined;
923
+ /**
924
+ * Name of an OpenSSL engine to get private key from. Should be used
925
+ * together with privateKeyIdentifier.
926
+ */
927
+ privateKeyEngine?: string | undefined;
928
+ /**
929
+ * Identifier of a private key managed by an OpenSSL engine. Should be
930
+ * used together with privateKeyEngine. Should not be set together with
931
+ * key, because both options define a private key in different ways.
932
+ */
933
+ privateKeyIdentifier?: string | undefined;
934
+ /**
935
+ * Optionally set the maximum TLS version to allow. One
936
+ * of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the
937
+ * `secureProtocol` option, use one or the other.
938
+ * **Default:** `'TLSv1.3'`, unless changed using CLI options. Using
939
+ * `--tls-max-v1.2` sets the default to `'TLSv1.2'`. Using `--tls-max-v1.3` sets the default to
940
+ * `'TLSv1.3'`. If multiple of the options are provided, the highest maximum is used.
941
+ */
942
+ maxVersion?: SecureVersion | undefined;
943
+ /**
944
+ * Optionally set the minimum TLS version to allow. One
945
+ * of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the
946
+ * `secureProtocol` option, use one or the other. It is not recommended to use
947
+ * less than TLSv1.2, but it may be required for interoperability.
948
+ * **Default:** `'TLSv1.2'`, unless changed using CLI options. Using
949
+ * `--tls-v1.0` sets the default to `'TLSv1'`. Using `--tls-v1.1` sets the default to
950
+ * `'TLSv1.1'`. Using `--tls-min-v1.3` sets the default to
951
+ * 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.
952
+ */
953
+ minVersion?: SecureVersion | undefined;
954
+ /**
955
+ * Shared passphrase used for a single private key and/or a PFX.
956
+ */
957
+ passphrase?: string | undefined;
958
+ /**
959
+ * PFX or PKCS12 encoded private key and certificate chain. pfx is an
960
+ * alternative to providing key and cert individually. PFX is usually
961
+ * encrypted, if it is, passphrase will be used to decrypt it. Multiple
962
+ * PFX can be provided either as an array of unencrypted PFX buffers,
963
+ * or an array of objects in the form {buf: <string|buffer>[,
964
+ * passphrase: <string>]}. The object form can only occur in an array.
965
+ * object.passphrase is optional. Encrypted PFX will be decrypted with
966
+ * object.passphrase if provided, or options.passphrase if it is not.
967
+ */
968
+ pfx?: string | Buffer | Array<string | Buffer | PxfObject> | undefined;
969
+ /**
970
+ * Optionally affect the OpenSSL protocol behavior, which is not
971
+ * usually necessary. This should be used carefully if at all! Value is
972
+ * a numeric bitmask of the SSL_OP_* options from OpenSSL Options
973
+ */
974
+ secureOptions?: number | undefined; // Value is a numeric bitmask of the `SSL_OP_*` options
975
+ /**
976
+ * Legacy mechanism to select the TLS protocol version to use, it does
977
+ * not support independent control of the minimum and maximum version,
978
+ * and does not support limiting the protocol to TLSv1.3. Use
979
+ * minVersion and maxVersion instead. The possible values are listed as
980
+ * SSL_METHODS, use the function names as strings. For example, use
981
+ * 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow
982
+ * any TLS protocol version up to TLSv1.3. It is not recommended to use
983
+ * TLS versions less than 1.2, but it may be required for
984
+ * interoperability. Default: none, see minVersion.
985
+ */
986
+ secureProtocol?: string | undefined;
987
+ /**
988
+ * Opaque identifier used by servers to ensure session state is not
989
+ * shared between applications. Unused by clients.
990
+ */
991
+ sessionIdContext?: string | undefined;
992
+ /**
993
+ * 48-bytes of cryptographically strong pseudo-random data.
994
+ * See Session Resumption for more information.
995
+ */
996
+ ticketKeys?: Buffer | undefined;
997
+ /**
998
+ * The number of seconds after which a TLS session created by the
999
+ * server will no longer be resumable. See Session Resumption for more
1000
+ * information. Default: 300.
1001
+ */
1002
+ sessionTimeout?: number | undefined;
1003
+ }
1004
+ interface SecureContext {
1005
+ context: any;
1006
+ }
1007
+ /**
1008
+ * Verifies the certificate `cert` is issued to `hostname`.
1009
+ *
1010
+ * Returns [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object, populating it with `reason`, `host`, and `cert` on
1011
+ * failure. On success, returns [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type).
1012
+ *
1013
+ * This function is intended to be used in combination with the`checkServerIdentity` option that can be passed to {@link connect} and as
1014
+ * such operates on a `certificate object`. For other purposes, consider using `x509.checkHost()` instead.
1015
+ *
1016
+ * This function can be overwritten by providing an alternative function as the `options.checkServerIdentity` option that is passed to `tls.connect()`. The
1017
+ * overwriting function can call `tls.checkServerIdentity()` of course, to augment
1018
+ * the checks done with additional verification.
1019
+ *
1020
+ * This function is only called if the certificate passed all other checks, such as
1021
+ * being issued by trusted CA (`options.ca`).
1022
+ *
1023
+ * Earlier versions of Node.js incorrectly accepted certificates for a given`hostname` if a matching `uniformResourceIdentifier` subject alternative name
1024
+ * was present (see [CVE-2021-44531](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44531)). Applications that wish to accept`uniformResourceIdentifier` subject alternative names can use
1025
+ * a custom `options.checkServerIdentity` function that implements the desired behavior.
1026
+ * @since v0.8.4
1027
+ * @param hostname The host name or IP address to verify the certificate against.
1028
+ * @param cert A `certificate object` representing the peer's certificate.
1029
+ */
1030
+ function checkServerIdentity(hostname: string, cert: PeerCertificate): Error | undefined;
1031
+ /**
1032
+ * Creates a new {@link Server}. The `secureConnectionListener`, if provided, is
1033
+ * automatically set as a listener for the `'secureConnection'` event.
1034
+ *
1035
+ * The `ticketKeys` options is automatically shared between `node:cluster` module
1036
+ * workers.
1037
+ *
1038
+ * The following illustrates a simple echo server:
1039
+ *
1040
+ * ```js
1041
+ * import tls from 'node:tls';
1042
+ * import fs from 'node:fs';
1043
+ *
1044
+ * const options = {
1045
+ * key: fs.readFileSync('server-key.pem'),
1046
+ * cert: fs.readFileSync('server-cert.pem'),
1047
+ *
1048
+ * // This is necessary only if using client certificate authentication.
1049
+ * requestCert: true,
1050
+ *
1051
+ * // This is necessary only if the client uses a self-signed certificate.
1052
+ * ca: [ fs.readFileSync('client-cert.pem') ],
1053
+ * };
1054
+ *
1055
+ * const server = tls.createServer(options, (socket) => {
1056
+ * console.log('server connected',
1057
+ * socket.authorized ? 'authorized' : 'unauthorized');
1058
+ * socket.write('welcome!\n');
1059
+ * socket.setEncoding('utf8');
1060
+ * socket.pipe(socket);
1061
+ * });
1062
+ * server.listen(8000, () => {
1063
+ * console.log('server bound');
1064
+ * });
1065
+ * ```
1066
+ *
1067
+ * The server can be tested by connecting to it using the example client from {@link connect}.
1068
+ * @since v0.3.2
1069
+ */
1070
+ function createServer(secureConnectionListener?: (socket: TLSSocket) => void): Server;
1071
+ function createServer(options: TlsOptions, secureConnectionListener?: (socket: TLSSocket) => void): Server;
1072
+ /**
1073
+ * The `callback` function, if specified, will be added as a listener for the `'secureConnect'` event.
1074
+ *
1075
+ * `tls.connect()` returns a {@link TLSSocket} object.
1076
+ *
1077
+ * Unlike the `https` API, `tls.connect()` does not enable the
1078
+ * SNI (Server Name Indication) extension by default, which may cause some
1079
+ * servers to return an incorrect certificate or reject the connection
1080
+ * altogether. To enable SNI, set the `servername` option in addition
1081
+ * to `host`.
1082
+ *
1083
+ * The following illustrates a client for the echo server example from {@link createServer}:
1084
+ *
1085
+ * ```js
1086
+ * // Assumes an echo server that is listening on port 8000.
1087
+ * import tls from 'node:tls';
1088
+ * import fs from 'node:fs';
1089
+ *
1090
+ * const options = {
1091
+ * // Necessary only if the server requires client certificate authentication.
1092
+ * key: fs.readFileSync('client-key.pem'),
1093
+ * cert: fs.readFileSync('client-cert.pem'),
1094
+ *
1095
+ * // Necessary only if the server uses a self-signed certificate.
1096
+ * ca: [ fs.readFileSync('server-cert.pem') ],
1097
+ *
1098
+ * // Necessary only if the server's cert isn't for "localhost".
1099
+ * checkServerIdentity: () => { return null; },
1100
+ * };
1101
+ *
1102
+ * const socket = tls.connect(8000, options, () => {
1103
+ * console.log('client connected',
1104
+ * socket.authorized ? 'authorized' : 'unauthorized');
1105
+ * process.stdin.pipe(socket);
1106
+ * process.stdin.resume();
1107
+ * });
1108
+ * socket.setEncoding('utf8');
1109
+ * socket.on('data', (data) => {
1110
+ * console.log(data);
1111
+ * });
1112
+ * socket.on('end', () => {
1113
+ * console.log('server ends connection');
1114
+ * });
1115
+ * ```
1116
+ * @since v0.11.3
1117
+ */
1118
+ function connect(options: ConnectionOptions, secureConnectListener?: () => void): TLSSocket;
1119
+ function connect(
1120
+ port: number,
1121
+ host?: string,
1122
+ options?: ConnectionOptions,
1123
+ secureConnectListener?: () => void,
1124
+ ): TLSSocket;
1125
+ function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () => void): TLSSocket;
1126
+ /**
1127
+ * Creates a new secure pair object with two streams, one of which reads and writes
1128
+ * the encrypted data and the other of which reads and writes the cleartext data.
1129
+ * Generally, the encrypted stream is piped to/from an incoming encrypted data
1130
+ * stream and the cleartext one is used as a replacement for the initial encrypted
1131
+ * stream.
1132
+ *
1133
+ * `tls.createSecurePair()` returns a `tls.SecurePair` object with `cleartext` and `encrypted` stream properties.
1134
+ *
1135
+ * Using `cleartext` has the same API as {@link TLSSocket}.
1136
+ *
1137
+ * The `tls.createSecurePair()` method is now deprecated in favor of`tls.TLSSocket()`. For example, the code:
1138
+ *
1139
+ * ```js
1140
+ * pair = tls.createSecurePair(// ... );
1141
+ * pair.encrypted.pipe(socket);
1142
+ * socket.pipe(pair.encrypted);
1143
+ * ```
1144
+ *
1145
+ * can be replaced by:
1146
+ *
1147
+ * ```js
1148
+ * secureSocket = tls.TLSSocket(socket, options);
1149
+ * ```
1150
+ *
1151
+ * where `secureSocket` has the same API as `pair.cleartext`.
1152
+ * @since v0.3.2
1153
+ * @deprecated Since v0.11.3 - Use {@link TLSSocket} instead.
1154
+ * @param context A secure context object as returned by `tls.createSecureContext()`
1155
+ * @param isServer `true` to specify that this TLS connection should be opened as a server.
1156
+ * @param requestCert `true` to specify whether a server should request a certificate from a connecting client. Only applies when `isServer` is `true`.
1157
+ * @param rejectUnauthorized If not `false` a server automatically reject clients with invalid certificates. Only applies when `isServer` is `true`.
1158
+ */
1159
+ function createSecurePair(
1160
+ context?: SecureContext,
1161
+ isServer?: boolean,
1162
+ requestCert?: boolean,
1163
+ rejectUnauthorized?: boolean,
1164
+ ): SecurePair;
1165
+ /**
1166
+ * `{@link createServer}` sets the default value of the `honorCipherOrder` option
1167
+ * to `true`, other APIs that create secure contexts leave it unset.
1168
+ *
1169
+ * `{@link createServer}` uses a 128 bit truncated SHA1 hash value generated
1170
+ * from `process.argv` as the default value of the `sessionIdContext` option, other
1171
+ * APIs that create secure contexts have no default value.
1172
+ *
1173
+ * The `tls.createSecureContext()` method creates a `SecureContext` object. It is
1174
+ * usable as an argument to several `tls` APIs, such as `server.addContext()`,
1175
+ * but has no public methods. The {@link Server} constructor and the {@link createServer} method do not support the `secureContext` option.
1176
+ *
1177
+ * A key is _required_ for ciphers that use certificates. Either `key` or `pfx` can be used to provide it.
1178
+ *
1179
+ * If the `ca` option is not given, then Node.js will default to using [Mozilla's publicly trusted list of
1180
+ * CAs](https://hg.mozilla.org/mozilla-central/raw-file/tip/security/nss/lib/ckfw/builtins/certdata.txt).
1181
+ *
1182
+ * Custom DHE parameters are discouraged in favor of the new `dhparam: 'auto' `option. When set to `'auto'`, well-known DHE parameters of sufficient strength
1183
+ * will be selected automatically. Otherwise, if necessary, `openssl dhparam` can
1184
+ * be used to create custom parameters. The key length must be greater than or
1185
+ * equal to 1024 bits or else an error will be thrown. Although 1024 bits is
1186
+ * permissible, use 2048 bits or larger for stronger security.
1187
+ * @since v0.11.13
1188
+ */
1189
+ function createSecureContext(options?: SecureContextOptions): SecureContext;
1190
+ /**
1191
+ * Returns an array with the names of the supported TLS ciphers. The names are
1192
+ * lower-case for historical reasons, but must be uppercased to be used in
1193
+ * the `ciphers` option of `{@link createSecureContext}`.
1194
+ *
1195
+ * Not all supported ciphers are enabled by default. See
1196
+ * [Modifying the default TLS cipher suite](https://nodejs.org/docs/latest-v20.x/api/tls.html#modifying-the-default-tls-cipher-suite).
1197
+ *
1198
+ * Cipher names that start with `'tls_'` are for TLSv1.3, all the others are for
1199
+ * TLSv1.2 and below.
1200
+ *
1201
+ * ```js
1202
+ * console.log(tls.getCiphers()); // ['aes128-gcm-sha256', 'aes128-sha', ...]
1203
+ * ```
1204
+ * @since v0.10.2
1205
+ */
1206
+ function getCiphers(): string[];
1207
+ /**
1208
+ * The default curve name to use for ECDH key agreement in a tls server.
1209
+ * The default value is `'auto'`. See `{@link createSecureContext()}` for further
1210
+ * information.
1211
+ * @since v0.11.13
1212
+ */
1213
+ let DEFAULT_ECDH_CURVE: string;
1214
+ /**
1215
+ * The default value of the `maxVersion` option of `{@link createSecureContext()}`.
1216
+ * It can be assigned any of the supported TLS protocol versions,
1217
+ * `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. **Default:** `'TLSv1.3'`, unless
1218
+ * changed using CLI options. Using `--tls-max-v1.2` sets the default to `'TLSv1.2'`. Using
1219
+ * `--tls-max-v1.3` sets the default to `'TLSv1.3'`. If multiple of the options
1220
+ * are provided, the highest maximum is used.
1221
+ * @since v11.4.0
1222
+ */
1223
+ let DEFAULT_MAX_VERSION: SecureVersion;
1224
+ /**
1225
+ * The default value of the `minVersion` option of `{@link createSecureContext()}`.
1226
+ * It can be assigned any of the supported TLS protocol versions,
1227
+ * `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. **Default:** `'TLSv1.2'`, unless
1228
+ * changed using CLI options. Using `--tls-min-v1.0` sets the default to
1229
+ * `'TLSv1'`. Using `--tls-min-v1.1` sets the default to `'TLSv1.1'`. Using
1230
+ * `--tls-min-v1.3` sets the default to `'TLSv1.3'`. If multiple of the options
1231
+ * are provided, the lowest minimum is used.
1232
+ * @since v11.4.0
1233
+ */
1234
+ let DEFAULT_MIN_VERSION: SecureVersion;
1235
+ /**
1236
+ * The default value of the `ciphers` option of `{@link createSecureContext()}`.
1237
+ * It can be assigned any of the supported OpenSSL ciphers.
1238
+ * Defaults to the content of `crypto.constants.defaultCoreCipherList`, unless
1239
+ * changed using CLI options using `--tls-default-ciphers`.
1240
+ * @since v19.8.0
1241
+ */
1242
+ let DEFAULT_CIPHERS: string;
1243
+ /**
1244
+ * An immutable array of strings representing the root certificates (in PEM format)
1245
+ * from the bundled Mozilla CA store as supplied by the current Node.js version.
1246
+ *
1247
+ * The bundled CA store, as supplied by Node.js, is a snapshot of Mozilla CA store
1248
+ * that is fixed at release time. It is identical on all supported platforms.
1249
+ * @since v12.3.0
1250
+ */
1251
+ const rootCertificates: readonly string[];
1252
+ }
1253
+ declare module "node:tls" {
1254
+ export * from "tls";
1255
+ }