1 | declare module 'tls' {
|
2 | import * as net from 'net';
|
3 | import * as stream from 'stream';
|
4 |
|
5 | const CLIENT_RENEG_LIMIT: number;
|
6 | const CLIENT_RENEG_WINDOW: number;
|
7 |
|
8 | interface Certificate {
|
9 | |
10 |
|
11 |
|
12 | C: string;
|
13 | |
14 |
|
15 |
|
16 | ST: string;
|
17 | |
18 |
|
19 |
|
20 | L: string;
|
21 | |
22 |
|
23 |
|
24 | O: string;
|
25 | |
26 |
|
27 |
|
28 | OU: string;
|
29 | |
30 |
|
31 |
|
32 | CN: string;
|
33 | }
|
34 |
|
35 | interface PeerCertificate {
|
36 | subject: Certificate;
|
37 | issuer: Certificate;
|
38 | subjectaltname: string;
|
39 | infoAccess: NodeJS.Dict<string[]>;
|
40 | modulus: string;
|
41 | exponent: string;
|
42 | valid_from: string;
|
43 | valid_to: string;
|
44 | fingerprint: string;
|
45 | fingerprint256: string;
|
46 | ext_key_usage: string[];
|
47 | serialNumber: string;
|
48 | raw: Buffer;
|
49 | }
|
50 |
|
51 | interface DetailedPeerCertificate extends PeerCertificate {
|
52 | issuerCertificate: DetailedPeerCertificate;
|
53 | }
|
54 |
|
55 | interface CipherNameAndProtocol {
|
56 | |
57 |
|
58 |
|
59 | name: string;
|
60 | |
61 |
|
62 |
|
63 | version: string;
|
64 |
|
65 | |
66 |
|
67 |
|
68 | standardName: string;
|
69 | }
|
70 |
|
71 | interface EphemeralKeyInfo {
|
72 | |
73 |
|
74 |
|
75 | type: string;
|
76 | |
77 |
|
78 |
|
79 | name?: string | undefined;
|
80 | |
81 |
|
82 |
|
83 | size: number;
|
84 | }
|
85 |
|
86 | interface KeyObject {
|
87 | |
88 |
|
89 |
|
90 | pem: string | Buffer;
|
91 | |
92 |
|
93 |
|
94 | passphrase?: string | undefined;
|
95 | }
|
96 |
|
97 | interface PxfObject {
|
98 | |
99 |
|
100 |
|
101 | buf: string | Buffer;
|
102 | |
103 |
|
104 |
|
105 | passphrase?: string | undefined;
|
106 | }
|
107 |
|
108 | interface TLSSocketOptions extends SecureContextOptions, CommonConnectionOptions {
|
109 | |
110 |
|
111 |
|
112 |
|
113 | isServer?: boolean | undefined;
|
114 | |
115 |
|
116 |
|
117 | server?: net.Server | undefined;
|
118 |
|
119 | |
120 |
|
121 |
|
122 | session?: Buffer | undefined;
|
123 | |
124 |
|
125 |
|
126 |
|
127 |
|
128 | requestOCSP?: boolean | undefined;
|
129 | }
|
130 |
|
131 | class TLSSocket extends net.Socket {
|
132 | |
133 |
|
134 |
|
135 | constructor(socket: net.Socket, options?: TLSSocketOptions);
|
136 |
|
137 | /**
|
138 | * A boolean that is true if the peer certificate was signed by one of the specified CAs, otherwise false.
|
139 | */
|
140 | authorized: boolean;
|
141 | /**
|
142 | * The reason why the peer's certificate has not been verified.
|
143 | * This property becomes available only when tlsSocket.authorized === false.
|
144 | */
|
145 | authorizationError: Error;
|
146 | /**
|
147 | * Static boolean value, always true.
|
148 | * May be used to distinguish TLS sockets from regular ones.
|
149 | */
|
150 | encrypted: true;
|
151 |
|
152 | /**
|
153 | * String containing the selected ALPN protocol.
|
154 | * Before a handshake has completed, this value is always null.
|
155 | * When a handshake is completed but not ALPN protocol was selected, tlsSocket.alpnProtocol equals false.
|
156 | */
|
157 | alpnProtocol: string | false | null;
|
158 |
|
159 | /**
|
160 | * Returns an object representing the local certificate. The returned
|
161 | * object has some properties corresponding to the fields of the
|
162 | * certificate.
|
163 | *
|
164 | * See tls.TLSSocket.getPeerCertificate() for an example of the
|
165 | * certificate structure.
|
166 | *
|
167 | * If there is no local certificate, an empty object will be returned.
|
168 | * If the socket has been destroyed, null will be returned.
|
169 | */
|
170 | getCertificate(): PeerCertificate | object | null;
|
171 | /**
|
172 | * Returns an object representing the cipher name and the SSL/TLS protocol version of the current connection.
|
173 | * @returns Returns an object representing the cipher name
|
174 | * and the SSL/TLS protocol version of the current connection.
|
175 | */
|
176 | getCipher(): CipherNameAndProtocol;
|
177 | /**
|
178 | * Returns an object representing the type, name, and size of parameter
|
179 | * of an ephemeral key exchange in Perfect Forward Secrecy on a client
|
180 | * connection. It returns an empty object when the key exchange is not
|
181 | * ephemeral. As this is only supported on a client socket; null is
|
182 | * returned if called on a server socket. The supported types are 'DH'
|
183 | * and 'ECDH'. The name property is available only when type is 'ECDH'.
|
184 | *
|
185 | * For example: { type: 'ECDH', name: 'prime256v1', size: 256 }.
|
186 | */
|
187 | getEphemeralKeyInfo(): EphemeralKeyInfo | object | null;
|
188 | |
189 |
|
190 |
|
191 |
|
192 |
|
193 |
|
194 |
|
195 |
|
196 |
|
197 |
|
198 |
|
199 |
|
200 |
|
201 |
|
202 | getFinished(): Buffer | undefined;
|
203 | |
204 |
|
205 |
|
206 |
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 | getPeerCertificate(detailed: true): DetailedPeerCertificate;
|
213 | getPeerCertificate(detailed?: false): PeerCertificate;
|
214 | getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate;
|
215 | |
216 |
|
217 |
|
218 |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 | getPeerFinished(): Buffer | undefined;
|
230 | |
231 |
|
232 |
|
233 |
|
234 |
|
235 |
|
236 |
|
237 | getProtocol(): string | null;
|
238 | |
239 |
|
240 |
|
241 |
|
242 | getSession(): Buffer | undefined;
|
243 | |
244 |
|
245 |
|
246 |
|
247 | getSharedSigalgs(): string[];
|
248 | |
249 |
|
250 |
|
251 |
|
252 |
|
253 | getTLSTicket(): Buffer | undefined;
|
254 | |
255 |
|
256 |
|
257 | isSessionReused(): boolean;
|
258 | |
259 |
|
260 |
|
261 |
|
262 |
|
263 |
|
264 |
|
265 |
|
266 |
|
267 |
|
268 |
|
269 | renegotiate(options: { rejectUnauthorized?: boolean | undefined, requestCert?: boolean | undefined }, callback: (err: Error | null) => void): undefined | boolean;
|
270 | |
271 |
|
272 |
|
273 |
|
274 |
|
275 |
|
276 |
|
277 |
|
278 |
|
279 |
|
280 | setMaxSendFragment(size: number): boolean;
|
281 |
|
282 | |
283 |
|
284 |
|
285 |
|
286 |
|
287 | disableRenegotiation(): void;
|
288 |
|
289 | |
290 |
|
291 |
|
292 |
|
293 |
|
294 |
|
295 |
|
296 |
|
297 |
|
298 | enableTrace(): void;
|
299 |
|
300 | |
301 |
|
302 |
|
303 |
|
304 |
|
305 |
|
306 | exportKeyingMaterial(length: number, label: string, context: Buffer): Buffer;
|
307 |
|
308 | addListener(event: string, listener: (...args: any[]) => void): this;
|
309 | addListener(event: "OCSPResponse", listener: (response: Buffer) => void): this;
|
310 | addListener(event: "secureConnect", listener: () => void): this;
|
311 | addListener(event: "session", listener: (session: Buffer) => void): this;
|
312 | addListener(event: "keylog", listener: (line: Buffer) => void): this;
|
313 |
|
314 | emit(event: string | symbol, ...args: any[]): boolean;
|
315 | emit(event: "OCSPResponse", response: Buffer): boolean;
|
316 | emit(event: "secureConnect"): boolean;
|
317 | emit(event: "session", session: Buffer): boolean;
|
318 | emit(event: "keylog", line: Buffer): boolean;
|
319 |
|
320 | on(event: string, listener: (...args: any[]) => void): this;
|
321 | on(event: "OCSPResponse", listener: (response: Buffer) => void): this;
|
322 | on(event: "secureConnect", listener: () => void): this;
|
323 | on(event: "session", listener: (session: Buffer) => void): this;
|
324 | on(event: "keylog", listener: (line: Buffer) => void): this;
|
325 |
|
326 | once(event: string, listener: (...args: any[]) => void): this;
|
327 | once(event: "OCSPResponse", listener: (response: Buffer) => void): this;
|
328 | once(event: "secureConnect", listener: () => void): this;
|
329 | once(event: "session", listener: (session: Buffer) => void): this;
|
330 | once(event: "keylog", listener: (line: Buffer) => void): this;
|
331 |
|
332 | prependListener(event: string, listener: (...args: any[]) => void): this;
|
333 | prependListener(event: "OCSPResponse", listener: (response: Buffer) => void): this;
|
334 | prependListener(event: "secureConnect", listener: () => void): this;
|
335 | prependListener(event: "session", listener: (session: Buffer) => void): this;
|
336 | prependListener(event: "keylog", listener: (line: Buffer) => void): this;
|
337 |
|
338 | prependOnceListener(event: string, listener: (...args: any[]) => void): this;
|
339 | prependOnceListener(event: "OCSPResponse", listener: (response: Buffer) => void): this;
|
340 | prependOnceListener(event: "secureConnect", listener: () => void): this;
|
341 | prependOnceListener(event: "session", listener: (session: Buffer) => void): this;
|
342 | prependOnceListener(event: "keylog", listener: (line: Buffer) => void): this;
|
343 | }
|
344 |
|
345 | interface CommonConnectionOptions {
|
346 | |
347 |
|
348 |
|
349 | secureContext?: SecureContext | undefined;
|
350 |
|
351 | |
352 |
|
353 |
|
354 |
|
355 |
|
356 | enableTrace?: boolean | undefined;
|
357 | |
358 |
|
359 |
|
360 |
|
361 |
|
362 | requestCert?: boolean | undefined;
|
363 | |
364 |
|
365 |
|
366 |
|
367 | ALPNProtocols?: string[] | Uint8Array[] | Uint8Array | undefined;
|
368 | |
369 |
|
370 |
|
371 |
|
372 |
|
373 |
|
374 |
|
375 |
|
376 |
|
377 | SNICallback?: ((servername: string, cb: (err: Error | null, ctx: SecureContext) => void) => void) | undefined;
|
378 | /**
|
379 | * If true the server will reject any connection which is not
|
380 | * authorized with the list of supplied CAs. This option only has an
|
381 | * effect if requestCert is true.
|
382 | * @default true
|
383 | */
|
384 | rejectUnauthorized?: boolean | undefined;
|
385 | }
|
386 |
|
387 | interface TlsOptions extends SecureContextOptions, CommonConnectionOptions, net.ServerOpts {
|
388 | /**
|
389 | * Abort the connection if the SSL/TLS handshake does not finish in the
|
390 | * specified number of milliseconds. A 'tlsClientError' is emitted on
|
391 | * the tls.Server object whenever a handshake times out. Default:
|
392 | * 120000 (120 seconds).
|
393 | */
|
394 | handshakeTimeout?: number | undefined;
|
395 | /**
|
396 | * The number of seconds after which a TLS session created by the
|
397 | * server will no longer be resumable. See Session Resumption for more
|
398 | * information. Default: 300.
|
399 | */
|
400 | sessionTimeout?: number | undefined;
|
401 | /**
|
402 | * 48-bytes of cryptographically strong pseudo-random data.
|
403 | */
|
404 | ticketKeys?: Buffer | undefined;
|
405 |
|
406 | /**
|
407 | *
|
408 | * @param socket
|
409 | * @param identity identity parameter sent from the client.
|
410 | * @return pre-shared key that must either be
|
411 | * a buffer or `null` to stop the negotiation process. Returned PSK must be
|
412 | * compatible with the selected cipher's digest.
|
413 | *
|
414 | * When negotiating TLS-PSK (pre-shared keys), this function is called
|
415 | * with the identity provided by the client.
|
416 | * If the return value is `null` the negotiation process will stop and an
|
417 | * "unknown_psk_identity" alert message will be sent to the other party.
|
418 | * If the server wishes to hide the fact that the PSK identity was not known,
|
419 | * the callback must provide some random data as `psk` to make the connection
|
420 | * fail with "decrypt_error" before negotiation is finished.
|
421 | * PSK ciphers are disabled by default, and using TLS-PSK thus
|
422 | * requires explicitly specifying a cipher suite with the `ciphers` option.
|
423 | * More information can be found in the RFC 4279.
|
424 | */
|
425 |
|
426 | pskCallback?(socket: TLSSocket, identity: string): DataView | NodeJS.TypedArray | null;
|
427 | /**
|
428 | * hint to send to a client to help
|
429 | * with selecting the identity during TLS-PSK negotiation. Will be ignored
|
430 | * in TLS 1.3. Upon failing to set pskIdentityHint `tlsClientError` will be
|
431 | * emitted with `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED` code.
|
432 | */
|
433 | pskIdentityHint?: string | undefined;
|
434 | }
|
435 |
|
436 | interface PSKCallbackNegotation {
|
437 | psk: DataView | NodeJS.TypedArray;
|
438 | identity: string;
|
439 | }
|
440 |
|
441 | interface ConnectionOptions extends SecureContextOptions, CommonConnectionOptions {
|
442 | host?: string | undefined;
|
443 | port?: number | undefined;
|
444 | path?: string | undefined; // Creates unix socket connection to path. If this option is specified, `host` and `port` are ignored.
|
445 | socket?: stream.Duplex | undefined; // Establish secure connection on a given socket rather than creating a new socket
|
446 | checkServerIdentity?: typeof checkServerIdentity | undefined;
|
447 | servername?: string | undefined; // SNI TLS Extension
|
448 | session?: Buffer | undefined;
|
449 | minDHSize?: number | undefined;
|
450 | lookup?: net.LookupFunction | undefined;
|
451 | timeout?: number | undefined;
|
452 | /**
|
453 | * When negotiating TLS-PSK (pre-shared keys), this function is called
|
454 | * with optional identity `hint` provided by the server or `null`
|
455 | * in case of TLS 1.3 where `hint` was removed.
|
456 | * It will be necessary to provide a custom `tls.checkServerIdentity()`
|
457 | * for the connection as the default one will try to check hostname/IP
|
458 | * of the server against the certificate but that's not applicable for PSK
|
459 | * because there won't be a certificate present.
|
460 | * More information can be found in the RFC 4279.
|
461 | *
|
462 | * @param hint message sent from the server to help client
|
463 | * decide which identity to use during negotiation.
|
464 | * Always `null` if TLS 1.3 is used.
|
465 | * @returns Return `null` to stop the negotiation process. `psk` must be
|
466 | * compatible with the selected cipher's digest.
|
467 | * `identity` must use UTF-8 encoding.
|
468 | */
|
469 | pskCallback?(hint: string | null): PSKCallbackNegotation | null;
|
470 | }
|
471 |
|
472 | class Server extends net.Server {
|
473 | constructor(secureConnectionListener?: (socket: TLSSocket) => void);
|
474 | constructor(options: TlsOptions, secureConnectionListener?: (socket: TLSSocket) => void);
|
475 |
|
476 | /**
|
477 | * The server.addContext() method adds a secure context that will be
|
478 | * used if the client request's SNI name matches the supplied hostname
|
479 | * (or wildcard).
|
480 | */
|
481 | addContext(hostName: string, credentials: SecureContextOptions): void;
|
482 | /**
|
483 | * Returns the session ticket keys.
|
484 | */
|
485 | getTicketKeys(): Buffer;
|
486 | /**
|
487 | *
|
488 | * The server.setSecureContext() method replaces the
|
489 | * secure context of an existing server. Existing connections to the
|
490 | * server are not interrupted.
|
491 | */
|
492 | setSecureContext(details: SecureContextOptions): void;
|
493 | /**
|
494 | * The server.setSecureContext() method replaces the secure context of
|
495 | * an existing server. Existing connections to the server are not
|
496 | * interrupted.
|
497 | */
|
498 | setTicketKeys(keys: Buffer): void;
|
499 |
|
500 | /**
|
501 | * events.EventEmitter
|
502 | * 1. tlsClientError
|
503 | * 2. newSession
|
504 | * 3. OCSPRequest
|
505 | * 4. resumeSession
|
506 | * 5. secureConnection
|
507 | * 6. keylog
|
508 | */
|
509 | addListener(event: string, listener: (...args: any[]) => void): this;
|
510 | addListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
|
511 | addListener(event: "newSession", listener: (sessionId: Buffer, sessionData: Buffer, callback: () => void) => void): this;
|
512 | addListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this;
|
513 | addListener(event: "resumeSession", listener: (sessionId: Buffer, callback: (err: Error | null, sessionData: Buffer | null) => void) => void): this;
|
514 | addListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
|
515 | addListener(event: "keylog", listener: (line: Buffer, tlsSocket: TLSSocket) => void): this;
|
516 |
|
517 | emit(event: string | symbol, ...args: any[]): boolean;
|
518 | emit(event: "tlsClientError", err: Error, tlsSocket: TLSSocket): boolean;
|
519 | emit(event: "newSession", sessionId: Buffer, sessionData: Buffer, callback: () => void): boolean;
|
520 | emit(event: "OCSPRequest", certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void): boolean;
|
521 | emit(event: "resumeSession", sessionId: Buffer, callback: (err: Error | null, sessionData: Buffer | null) => void): boolean;
|
522 | emit(event: "secureConnection", tlsSocket: TLSSocket): boolean;
|
523 | emit(event: "keylog", line: Buffer, tlsSocket: TLSSocket): boolean;
|
524 |
|
525 | on(event: string, listener: (...args: any[]) => void): this;
|
526 | on(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
|
527 | on(event: "newSession", listener: (sessionId: Buffer, sessionData: Buffer, callback: () => void) => void): this;
|
528 | on(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this;
|
529 | on(event: "resumeSession", listener: (sessionId: Buffer, callback: (err: Error | null, sessionData: Buffer | null) => void) => void): this;
|
530 | on(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
|
531 | on(event: "keylog", listener: (line: Buffer, tlsSocket: TLSSocket) => void): this;
|
532 |
|
533 | once(event: string, listener: (...args: any[]) => void): this;
|
534 | once(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
|
535 | once(event: "newSession", listener: (sessionId: Buffer, sessionData: Buffer, callback: () => void) => void): this;
|
536 | once(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this;
|
537 | once(event: "resumeSession", listener: (sessionId: Buffer, callback: (err: Error | null, sessionData: Buffer | null) => void) => void): this;
|
538 | once(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
|
539 | once(event: "keylog", listener: (line: Buffer, tlsSocket: TLSSocket) => void): this;
|
540 |
|
541 | prependListener(event: string, listener: (...args: any[]) => void): this;
|
542 | prependListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
|
543 | prependListener(event: "newSession", listener: (sessionId: Buffer, sessionData: Buffer, callback: () => void) => void): this;
|
544 | prependListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this;
|
545 | prependListener(event: "resumeSession", listener: (sessionId: Buffer, callback: (err: Error | null, sessionData: Buffer | null) => void) => void): this;
|
546 | prependListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
|
547 | prependListener(event: "keylog", listener: (line: Buffer, tlsSocket: TLSSocket) => void): this;
|
548 |
|
549 | prependOnceListener(event: string, listener: (...args: any[]) => void): this;
|
550 | prependOnceListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
|
551 | prependOnceListener(event: "newSession", listener: (sessionId: Buffer, sessionData: Buffer, callback: () => void) => void): this;
|
552 | prependOnceListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this;
|
553 | prependOnceListener(event: "resumeSession", listener: (sessionId: Buffer, callback: (err: Error | null, sessionData: Buffer | null) => void) => void): this;
|
554 | prependOnceListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
|
555 | prependOnceListener(event: "keylog", listener: (line: Buffer, tlsSocket: TLSSocket) => void): this;
|
556 | }
|
557 |
|
558 | interface SecurePair {
|
559 | encrypted: TLSSocket;
|
560 | cleartext: TLSSocket;
|
561 | }
|
562 |
|
563 | type SecureVersion = 'TLSv1.3' | 'TLSv1.2' | 'TLSv1.1' | 'TLSv1';
|
564 |
|
565 | interface SecureContextOptions {
|
566 | /**
|
567 | * Optionally override the trusted CA certificates. Default is to trust
|
568 | * the well-known CAs curated by Mozilla. Mozilla's CAs are completely
|
569 | * replaced when CAs are explicitly specified using this option.
|
570 | */
|
571 | ca?: string | Buffer | Array<string | Buffer> | undefined;
|
572 | /**
|
573 | * Cert chains in PEM format. One cert chain should be provided per
|
574 | * private key. Each cert chain should consist of the PEM formatted
|
575 | * certificate for a provided private key, followed by the PEM
|
576 | * formatted intermediate certificates (if any), in order, and not
|
577 | * including the root CA (the root CA must be pre-known to the peer,
|
578 | * see ca). When providing multiple cert chains, they do not have to
|
579 | * be in the same order as their private keys in key. If the
|
580 | * intermediate certificates are not provided, the peer will not be
|
581 | * able to validate the certificate, and the handshake will fail.
|
582 | */
|
583 | cert?: string | Buffer | Array<string | Buffer> | undefined;
|
584 | /**
|
585 | * Colon-separated list of supported signature algorithms. The list
|
586 | * can contain digest algorithms (SHA256, MD5 etc.), public key
|
587 | * algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g
|
588 | * 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).
|
589 | */
|
590 | sigalgs?: string | undefined;
|
591 | /**
|
592 | * Cipher suite specification, replacing the default. For more
|
593 | * information, see modifying the default cipher suite. Permitted
|
594 | * ciphers can be obtained via tls.getCiphers(). Cipher names must be
|
595 | * uppercased in order for OpenSSL to accept them.
|
596 | */
|
597 | ciphers?: string | undefined;
|
598 | /**
|
599 | * Name of an OpenSSL engine which can provide the client certificate.
|
600 | */
|
601 | clientCertEngine?: string | undefined;
|
602 | /**
|
603 | * PEM formatted CRLs (Certificate Revocation Lists).
|
604 | */
|
605 | crl?: string | Buffer | Array<string | Buffer> | undefined;
|
606 | /**
|
607 | * Diffie Hellman parameters, required for Perfect Forward Secrecy. Use
|
608 | * openssl dhparam to create the parameters. The key length must be
|
609 | * greater than or equal to 1024 bits or else an error will be thrown.
|
610 | * Although 1024 bits is permissible, use 2048 bits or larger for
|
611 | * stronger security. If omitted or invalid, the parameters are
|
612 | * silently discarded and DHE ciphers will not be available.
|
613 | */
|
614 | dhparam?: string | Buffer | undefined;
|
615 | /**
|
616 | * A string describing a named curve or a colon separated list of curve
|
617 | * NIDs or names, for example P-521:P-384:P-256, to use for ECDH key
|
618 | * agreement. Set to auto to select the curve automatically. Use
|
619 | * crypto.getCurves() to obtain a list of available curve names. On
|
620 | * recent releases, openssl ecparam -list_curves will also display the
|
621 | * name and description of each available elliptic curve. Default:
|
622 | * tls.DEFAULT_ECDH_CURVE.
|
623 | */
|
624 | ecdhCurve?: string | undefined;
|
625 | /**
|
626 | * Attempt to use the server's cipher suite preferences instead of the
|
627 | * client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be
|
628 | * set in secureOptions
|
629 | */
|
630 | honorCipherOrder?: boolean | undefined;
|
631 | /**
|
632 | * Private keys in PEM format. PEM allows the option of private keys
|
633 | * being encrypted. Encrypted keys will be decrypted with
|
634 | * options.passphrase. Multiple keys using different algorithms can be
|
635 | * provided either as an array of unencrypted key strings or buffers,
|
636 | * or an array of objects in the form {pem: <string|buffer>[,
|
637 | * passphrase: <string>]}. The object form can only occur in an array.
|
638 | * object.passphrase is optional. Encrypted keys will be decrypted with
|
639 | * object.passphrase if provided, or options.passphrase if it is not.
|
640 | */
|
641 | key?: string | Buffer | Array<Buffer | KeyObject> | undefined;
|
642 | /**
|
643 | * Name of an OpenSSL engine to get private key from. Should be used
|
644 | * together with privateKeyIdentifier.
|
645 | */
|
646 | privateKeyEngine?: string | undefined;
|
647 | /**
|
648 | * Identifier of a private key managed by an OpenSSL engine. Should be
|
649 | * used together with privateKeyEngine. Should not be set together with
|
650 | * key, because both options define a private key in different ways.
|
651 | */
|
652 | privateKeyIdentifier?: string | undefined;
|
653 | /**
|
654 | * Optionally set the maximum TLS version to allow. One
|
655 | * of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the
|
656 | * `secureProtocol` option, use one or the other.
|
657 | * **Default:** `'TLSv1.3'`, unless changed using CLI options. Using
|
658 | * `--tls-max-v1.2` sets the default to `'TLSv1.2'`. Using `--tls-max-v1.3` sets the default to
|
659 | * `'TLSv1.3'`. If multiple of the options are provided, the highest maximum is used.
|
660 | */
|
661 | maxVersion?: SecureVersion | undefined;
|
662 | /**
|
663 | * Optionally set the minimum TLS version to allow. One
|
664 | * of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the
|
665 | * `secureProtocol` option, use one or the other. It is not recommended to use
|
666 | * less than TLSv1.2, but it may be required for interoperability.
|
667 | * **Default:** `'TLSv1.2'`, unless changed using CLI options. Using
|
668 | * `--tls-v1.0` sets the default to `'TLSv1'`. Using `--tls-v1.1` sets the default to
|
669 | * `'TLSv1.1'`. Using `--tls-min-v1.3` sets the default to
|
670 | * 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.
|
671 | */
|
672 | minVersion?: SecureVersion | undefined;
|
673 | /**
|
674 | * Shared passphrase used for a single private key and/or a PFX.
|
675 | */
|
676 | passphrase?: string | undefined;
|
677 | /**
|
678 | * PFX or PKCS12 encoded private key and certificate chain. pfx is an
|
679 | * alternative to providing key and cert individually. PFX is usually
|
680 | * encrypted, if it is, passphrase will be used to decrypt it. Multiple
|
681 | * PFX can be provided either as an array of unencrypted PFX buffers,
|
682 | * or an array of objects in the form {buf: <string|buffer>[,
|
683 | * passphrase: <string>]}. The object form can only occur in an array.
|
684 | * object.passphrase is optional. Encrypted PFX will be decrypted with
|
685 | * object.passphrase if provided, or options.passphrase if it is not.
|
686 | */
|
687 | pfx?: string | Buffer | Array<string | Buffer | PxfObject> | undefined;
|
688 | /**
|
689 | * Optionally affect the OpenSSL protocol behavior, which is not
|
690 | * usually necessary. This should be used carefully if at all! Value is
|
691 | * a numeric bitmask of the SSL_OP_* options from OpenSSL Options
|
692 | */
|
693 | secureOptions?: number | undefined; // Value is a numeric bitmask of the `SSL_OP_*` options
|
694 | /**
|
695 | * Legacy mechanism to select the TLS protocol version to use, it does
|
696 | * not support independent control of the minimum and maximum version,
|
697 | * and does not support limiting the protocol to TLSv1.3. Use
|
698 | * minVersion and maxVersion instead. The possible values are listed as
|
699 | * SSL_METHODS, use the function names as strings. For example, use
|
700 | * 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow
|
701 | * any TLS protocol version up to TLSv1.3. It is not recommended to use
|
702 | * TLS versions less than 1.2, but it may be required for
|
703 | * interoperability. Default: none, see minVersion.
|
704 | */
|
705 | secureProtocol?: string | undefined;
|
706 | /**
|
707 | * Opaque identifier used by servers to ensure session state is not
|
708 | * shared between applications. Unused by clients.
|
709 | */
|
710 | sessionIdContext?: string | undefined;
|
711 | /**
|
712 | * 48-bytes of cryptographically strong pseudo-random data.
|
713 | * See Session Resumption for more information.
|
714 | */
|
715 | ticketKeys?: Buffer | undefined;
|
716 | /**
|
717 | * The number of seconds after which a TLS session created by the
|
718 | * server will no longer be resumable. See Session Resumption for more
|
719 | * information. Default: 300.
|
720 | */
|
721 | sessionTimeout?: number | undefined;
|
722 | }
|
723 |
|
724 | interface SecureContext {
|
725 | context: any;
|
726 | }
|
727 |
|
728 | /*
|
729 | * Verifies the certificate `cert` is issued to host `host`.
|
730 | * @host The hostname to verify the certificate against
|
731 | * @cert PeerCertificate representing the peer's certificate
|
732 | *
|
733 | * Returns Error object, populating it with the reason, host and cert on failure. On success, returns undefined.
|
734 | */
|
735 | function checkServerIdentity(host: string, cert: PeerCertificate): Error | undefined;
|
736 | function createServer(secureConnectionListener?: (socket: TLSSocket) => void): Server;
|
737 | function createServer(options: TlsOptions, secureConnectionListener?: (socket: TLSSocket) => void): Server;
|
738 | function connect(options: ConnectionOptions, secureConnectListener?: () => void): TLSSocket;
|
739 | function connect(port: number, host?: string, options?: ConnectionOptions, secureConnectListener?: () => void): TLSSocket;
|
740 | function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () => void): TLSSocket;
|
741 | /**
|
742 | * @deprecated since v0.11.3 Use `tls.TLSSocket` instead.
|
743 | */
|
744 | function createSecurePair(credentials?: SecureContext, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair;
|
745 | function createSecureContext(options?: SecureContextOptions): SecureContext;
|
746 | function getCiphers(): string[];
|
747 |
|
748 | /**
|
749 | * The default curve name to use for ECDH key agreement in a tls server.
|
750 | * The default value is 'auto'. See tls.createSecureContext() for further
|
751 | * information.
|
752 | */
|
753 | let DEFAULT_ECDH_CURVE: string;
|
754 | /**
|
755 | * The default value of the maxVersion option of
|
756 | * tls.createSecureContext(). It can be assigned any of the supported TLS
|
757 | * protocol versions, 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Default:
|
758 | * 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets
|
759 | * the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to
|
760 | * 'TLSv1.3'. If multiple of the options are provided, the highest maximum
|
761 | * is used.
|
762 | */
|
763 | let DEFAULT_MAX_VERSION: SecureVersion;
|
764 | /**
|
765 | * The default value of the minVersion option of tls.createSecureContext().
|
766 | * It can be assigned any of the supported TLS protocol versions,
|
767 | * 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Default: 'TLSv1.2', unless
|
768 | * changed using CLI options. Using --tls-min-v1.0 sets the default to
|
769 | * 'TLSv1'. Using --tls-min-v1.1 sets the default to 'TLSv1.1'. Using
|
770 | * --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options
|
771 | * are provided, the lowest minimum is used.
|
772 | */
|
773 | let DEFAULT_MIN_VERSION: SecureVersion;
|
774 |
|
775 | /**
|
776 | * An immutable array of strings representing the root certificates (in PEM
|
777 | * format) used for verifying peer certificates. This is the default value
|
778 | * of the ca option to tls.createSecureContext().
|
779 | */
|
780 | const rootCertificates: ReadonlyArray<string>;
|
781 | }
|
782 | declare module 'node:tls' {
|
783 | export * from 'tls';
|
784 | }
|
785 |
|
\ | No newline at end of file |