lemon-tls 0.6.0 → 0.9.0

package/README.md

@@ -11,29 +11,32 @@
   <a href="https://www.npmjs.com/package/lemon-tls">
     <img src="https://img.shields.io/npm/v/lemon-tls?color=blue" alt="npm">
   </a>
-  <img src="https://img.shields.io/badge/status-in%20development-yellow" alt="status">
   <img src="https://img.shields.io/github/license/colocohen/lemon-tls?color=brightgreen" alt="license">
 </p>
 
 ---
 
-> **⚠️ Project status: *Active development*.**
-> APIs may change without notice until we reach v1.0.
-> Use at your own risk and please report issues!
-
 ## ✨ Features
 
 * 🔒 **Pure JavaScript** – no OpenSSL, no native bindings. Zero dependencies.
 * ⚡ **TLS 1.3 (RFC 8446)** + **TLS 1.2** – both server and client.
+* 📡 **DTLS 1.3 (RFC 9147)** + **DTLS 1.2** – server and client, with cookie exchange, retransmission, and **DTLS-SRTP** (RFC 5764) for WebRTC. Not a shim over TLS: the record layer, epochs, and sequence-number handling are implemented for datagrams.
 * 🌐 **Browser-tested** – verified interop with Chrome, curl, Node.js, openssl s_client, and msquic.
 * 🔑 **Key Access** – read handshake secrets, traffic keys, ECDHE shared secret, and resumption data at any point.
-* 🔁 **Session Resumption** – session tickets + PSK with binder validation.
+* 🔁 **Session Resumption** – session tickets + PSK with binder validation, with application data carried inside the ticket (`ticketData`, `getTicketInfo()`).
 * 🔄 **Key Update** – refresh traffic keys on long-lived TLS 1.3 connections.
 * 🔃 **HelloRetryRequest** – automatic group negotiation fallback (X25519, P-256, P-384).
+* 🛰 **Post-quantum key exchange** – the hybrid **X25519MLKEM768** group, as Chrome, Firefox, Safari and Cloudflare negotiate it, wherever `node:crypto` has ML-KEM (Node 24.7+).
+* 🕶 **Encrypted Client Hello (RFC 9849)** – server *and* client. The real ClientHello — the site's name, the ALPN list — goes encrypted with HPKE to a key published in DNS. Key generation, rotation, `retry_configs`, HelloRetryRequest, resumption inside ECH, and GREASE ECH. Tested against Go's `crypto/tls` in both directions.
+* 🗜 **Certificate compression (RFC 8879)** – brotli, zlib and zstd, both directions; a public CA's chain often shrinks by half — over QUIC that can save a round trip.
+* 📄 **OCSP stapling** – the server staples (`'OCSPRequest'`, as `node:tls`), the client asks for it (`requestOCSP`, `'OCSPResponse'`).
 * 📜 **Client Certificate Auth** – mutual TLS (mTLS) with `requestCert` / `cert` / `key` options.
-* 🛡 **Designed for extensibility** – exposes cryptographic keys and record-layer primitives for QUIC, DTLS, or custom transports.
+* 🛡 **Designed for extensibility** – exposes cryptographic keys and record-layer primitives for QUIC or custom transports (DTLS ships implemented, see above).
 * 🧩 **Two API levels** – high-level `TLSSocket` (drop-in Node.js Duplex stream) and low-level `TLSSession` (state machine only, you handle the transport).
-* 🔧 **Beyond Node.js** – per-connection cipher/sigalg/group selection, JA3 fingerprinting, certificate pinning, and more options that are impossible or require `openssl.cnf` hacks in Node.js.
+* 🔍 **TLS fingerprinting, built in** – `getJA4()`, `getJA5()` and `getJA4S()`: the client's fingerprint, its resumption-stable variant, and the server's. Each is available **in either role**, because both hellos are visible to both peers. Verified byte-for-byte against independent implementations. Node cannot do this at all: OpenSSL parses the ClientHello and discards the offer, so other libraries re-read the raw bytes off the socket in parallel — here the data is already in hand.
+* 🎭 **Handshake shaping** – `permuteExtensions` (Chrome 110+ extension-order randomisation), `grease` (RFC 8701, across all seven insertion points) and `echGrease` (GREASE ECH, RFC 9849 §6.2). All opt-in, all collision-safe against anything you configured by hand.
+* 🧮 **HPKE (RFC 9180)** – exported as a module of its own (`crypto.hpke`): all four modes, the DHKEMs over X25519, X448, P-256, P-384 and P-521 — what ECH is built on, and the base of Oblivious HTTP and MLS.
+* 🔧 **Beyond Node.js** – per-connection cipher/sigalg/group selection, certificate pinning, `ALPNCallback`, `setKeyCert`, and more options that are impossible or require `openssl.cnf` hacks in Node.js.
 * 📘 **TypeScript support** – full `.d.ts` bundled, type-checked in strict mode.
 
 ## 📦 Installation
@@ -122,6 +125,91 @@ const socket = tls.connect(8443, 'localhost', {
 });
 ```
 
+### Encrypted Client Hello (ECH)
+
+Without ECH the first message of every TLS connection — the ClientHello, with the
+site's name — crosses the network in the clear. With ECH (RFC 9849) the client sends
+the real ClientHello encrypted, inside an outer one that names only a shared
+*public name*, to a key the server publishes in DNS (the `ech=` key of its HTTPS
+record, RFC 9460).
+
+```js
+import tls from 'lemon-tls';
+
+// Server: a key — keep k.config and k.privateKey across restarts,
+// publish k.configListBase64 as ech= in the domain's HTTPS record.
+const k = tls.generateEchKey({ publicName: 'ech.example.com' });
+
+const server = tls.createServer({
+  key, cert,                     // must cover ech.example.com too (see below)
+  ech: { keys: [{ config: k.config, privateKey: k.privateKey }] },
+}, (socket) => {
+  console.log(socket.servername, socket.echStatus);   // 'www.example.com' 'accepted'
+});
+
+// Client: the server's key list, from DNS.
+const socket = tls.connect({
+  host: 'www.example.com', port: 443, servername: 'www.example.com',
+  ech: k.configListBase64,
+}, () => console.log(socket.echStatus));               // 'accepted'
+
+socket.on('error', (err) => {
+  if (err.code === 'ERR_ECH_REJECTED' && err.retryConfigs) {
+    // The server's keys changed: connect again with err.retryConfigs.
+  }
+});
+```
+
+**When the server cannot decrypt** (a key it no longer holds), it completes the
+handshake as the public name — so its certificate must cover that name too — and
+sends its current keys (`retry_configs`). The client checks that certificate against
+the public name, sends `ech_required`, and fails with `ERR_ECH_REJECTED`:
+`err.retryConfigs` is the server's new ECHConfigList (given only when the server was
+authenticated), or `null` — the server has turned ECH off. There is no automatic
+fallback to a hello in the clear: that is the application's decision.
+
+**What the client does.** Two hellos go in one:
+- **Inner:** the real one, sealed with HPKE.
+- **Outer:** in the clear, naming the public name.
+
+Extensions the two share, the `key_share` above all, are sent once: the inner hello
+names them (`ech_outer_extensions`). The inner hello is padded so its length tells
+little about the name. The server says which hello it answered with 8 bytes of its
+random (or of its HelloRetryRequest) that only a holder of the inner hello can compute.
+
+**Also covered:**
+- HelloRetryRequest
+- A resumed session inside the inner hello
+- `echGrease: true`: an ECH extension no server can decrypt, as Chrome and Firefox send, so that clients using ECH do not stand out.
+
+**Key rotation** — the new key in DNS first, then on the server, the old one kept with
+`retry: false` until the old record's TTL has passed:
+
+```js
+server.setEchKeys({ keys: [
+  { config: next.config, privateKey: next.privateKey },
+  { config: prev.config, privateKey: prev.privateKey, retry: false },
+] });
+```
+
+A key is not certified by anyone — its trust comes from DNS. A substituted key could
+reveal which name was asked for, never let anyone impersonate the site: the
+certificate is still checked against that name. TLS 1.3 only, not DTLS.
+
+### OCSP Stapling
+
+```js
+// Server — as node:tls: asked when a client requests status. Fetch and cache
+// responses ahead of time; the handshake waits for the callback.
+server.on('OCSPRequest', (certificate, issuer, callback) => {
+  callback(null, cachedOcspResponseFor(certificate));   // DER Buffer, or null for none
+});
+
+// Client
+const socket = tls.connect({ host, port, requestOCSP: true });
+socket.on('OCSPResponse', (response) => { /* DER Buffer — check it, e.g. with the `ocsp` package */ });
+```
+
 ## 📚 API
 
 ### Module-Level Functions
@@ -137,7 +225,22 @@ tls.getCiphers()                                   // ['tls_aes_128_gcm_sha256',
 tls.DEFAULT_MIN_VERSION                            // 'TLSv1.2'
 tls.DEFAULT_MAX_VERSION                            // 'TLSv1.3'
 tls.DEFAULT_CIPHERS                                // 'TLS_AES_256_GCM_SHA384:...'
+tls.rootCertificates                               // the shipped CA bundle (~144 PEMs)
+tls.getCACertificates('default')                   // same, as a copy
+tls.setDefaultCACertificates([...])                // replace it for later connections
 tls.DEFAULT_ECDH_CURVE                             // 'auto'
+
+// node:tls's option strings → the code lists lemon-tls works with (what
+// createServer / connect do with `ciphers`, `ecdhCurve`, `sigalgs`)
+tls.parseCiphers('TLS_AES_256_GCM_SHA384:ECDHE-RSA-AES128-GCM-SHA256')  // [0x1302, 0xc02f]
+tls.parseEcdhCurve('X25519:P-256')                 // [0x001d, 0x0017]; 'auto' → null (the default)
+tls.parseSigalgs('ECDSA+SHA256:rsa_pss_rsae_sha256') // [0x0403, 0x0804]
+tls.certificateObject(der)                         // a DER certificate as getPeerCertificate() describes it
+
+// Encrypted Client Hello (RFC 9849)
+tls.generateEchKey({ publicName, configId?, maxNameLength?, kem? })
+                                                   // → { config, privateKey, configList, configListBase64 }
+tls.checkEchKeys({ keys: [{ config, privateKey, retry }] })  // throws, saying what is wrong
 ```
 
 ### `tls.Server` (returned by `createServer`)
@@ -148,6 +251,8 @@ server.close(callback?)                            // Stop accepting new connect
 server.setSecureContext({ key, cert })             // Runtime cert rotation (Let's Encrypt, etc.)
 server.getTicketKeys()                             // 48-byte Buffer (ticket encryption keys)
 server.setTicketKeys(keys)                         // For clustered deployments
+server.getEchKeys()                                // the current `ech` option
+server.setEchKeys(ech)                             // ECH key rotation; a bad key throws, the old set stays
 server.address()                                   // { port, family, address }
 ```
 
@@ -160,6 +265,7 @@ server.address()                                   // { port, family, address }
 | `keylog` | `(line, socket)` | SSLKEYLOGFILE-format line (for Wireshark) |
 | `newSession` | `(id, data, cb)` | Store a TLS 1.2 Session ID (for custom session stores) |
 | `resumeSession` | `(id, cb)` | Look up a TLS 1.2 Session ID (for custom session stores) |
+| `OCSPRequest` | `(certificate, issuer, callback)` | A client asked for the certificate's OCSP status (as `node:tls`). `certificate` and `issuer` are DER Buffers (`issuer` `null` when the chain has none); `callback(null, response)` staples a DER OCSP response, `callback(null, null)` none, `callback(err)` fails the handshake. Without a listener nothing is stapled |
 | `error` / `close` | — | Transport-level |
 
 ### `TLSSocket`
@@ -185,6 +291,9 @@ High-level wrapper extending `stream.Duplex`, API-compatible with Node.js [`tls.
 | `requestCert` | boolean | Request client certificate (server) |
 | `cert` | Buffer/string | Client certificate PEM (for mTLS) |
 | `key` | Buffer/string | Client private key PEM (for mTLS) |
+| `ciphers`, `ecdhCurve`, `sigalgs` | string | As `node:tls` takes them (`createServer` / `connect`); a value naming nothing usable throws. `sigalgs` limits what the endpoint signs with, as well as what it offers and accepts |
+| `requestOCSP` | boolean | Client: ask for the server's stapled OCSP response; it comes as `'OCSPResponse'` |
+| `sessionTimeout` | number | Server: seconds a session stays good — TLS 1.2 Session IDs, and the ticket lifetime unless `ticketLifetime` is given |
 
 **LemonTLS-only (not available in Node.js):**
 
@@ -197,9 +306,72 @@ High-level wrapper extending `stream.Duplex`, API-compatible with Node.js [`tls.
 | `maxRecordSize` | number | Max plaintext per TLS record (default: 16384) |
 | `allowedCipherSuites` | number[] | Whitelist - only these ciphers are offered |
 | `pins` | string[] | Certificate pinning: `['sha256/AAAA...']` |
-| `handshakeTimeout` | number | Abort handshake after N ms |
+| `handshakeTimeout` | number | Abort handshake after N ms. `createServer`: `120000` by default, as in Node |
 | `maxHandshakeSize` | number | Max handshake bytes - DoS protection |
 | `certificateCallback` | function | Dynamic cert selection: `(info, cb) => cb(null, ctx)` |
+| `ech` | object / Buffer / string | Encrypted Client Hello (RFC 9849). **Server:** `{ keys: [{ config, privateKey, retry }] }` — from `generateEchKey()`; `retry: false` keeps a key for decrypting without offering it in `retry_configs`. **Client:** the server's ECHConfigList, bytes or base64 (the `ech=` of its HTTPS record); the hello then offers TLS 1.3 only. A malformed list, or one with no config this client can use, throws |
+| `echGrease` | boolean | Client, without `ech`: send GREASE ECH (RFC 9849 §6.2), as browsers do (default `false`) |
+| `certificateCompression` | boolean / string[] | RFC 8879: `['brotli', 'zlib', 'zstd']`, `true` (all this Node has) or `false`. Server: what it compresses its chain with, for a client that offers it (default: all). Client: what it offers (default: none) |
+| `ticketLifetime` | number | Server: seconds a TLS 1.3 ticket is good for (default `7200`, capped at 7 days, RFC 8446 §4.6.1) |
+| `ticketData` | function | Server: `(resumed) => data` — JSON-safe data (≤ 256 bytes serialized) carried inside each ticket, encrypted with `ticketKeys`; `resumed` is the data of the ticket this connection resumed with (`null` on a full handshake). It comes back in `getTicketInfo()` on the connection that presents the ticket |
+
+**Client certificates and resumption.** A resumed handshake carries no certificate, so the
+ticket (or TLS 1.2 session) keeps the client's: on a resumed connection `authorized`,
+`authorizationError` and `getPeerCertificate()` answer as on the full handshake that issued it.
+A server that requires an authorized client (`requestCert` + `rejectUnauthorized`) resumes
+only a ticket that says it had one — anything else is a full handshake, where the
+certificate is asked for again.
+
+### Supported cipher suites
+
+Sixteen suites are implemented; three are offered by default. Anything else has
+to be asked for explicitly via `local_supported_cipher_suites` or narrowed with
+`allowedCipherSuites` — the default list stays small on purpose, because every
+extra suite widens the offer and changes your JA3/JA4.
+
+**TLS 1.3** — offered by default
+
+| Code | Suite | AEAD | Hash |
+|---|---|---|---|
+| `0x1301` | `TLS_AES_128_GCM_SHA256` | AES-128-GCM | SHA-256 |
+| `0x1302` | `TLS_AES_256_GCM_SHA384` | AES-256-GCM | SHA-384 |
+| `0x1303` | `TLS_CHACHA20_POLY1305_SHA256` | ChaCha20-Poly1305 | SHA-256 |
+
+**TLS 1.2 — AEAD** (opt in)
+
+| Code | Suite | Key exchange | AEAD |
+|---|---|---|---|
+| `0xC02B` | `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256` | ECDHE_ECDSA | AES-128-GCM |
+| `0xC02C` | `TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384` | ECDHE_ECDSA | AES-256-GCM |
+| `0xC02F` | `TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256` | ECDHE_RSA | AES-128-GCM |
+| `0xC030` | `TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384` | ECDHE_RSA | AES-256-GCM |
+| `0xCCA8` | `TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256` | ECDHE_RSA | ChaCha20-Poly1305 |
+| `0xCCA9` | `TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256` | ECDHE_ECDSA | ChaCha20-Poly1305 |
+| `0xCCAA` | `TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256` | DHE_RSA | ChaCha20-Poly1305 |
+| `0x009C` | `TLS_RSA_WITH_AES_128_GCM_SHA256` | RSA | AES-128-GCM |
+| `0x009D` | `TLS_RSA_WITH_AES_256_GCM_SHA384` | RSA | AES-256-GCM |
+
+**TLS 1.2 — CBC** (opt in; legacy, no forward secrecy on the RSA ones)
+
+| Code | Suite | Key exchange | Cipher | MAC |
+|---|---|---|---|---|
+| `0xC013` | `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA` | ECDHE_RSA | AES-128-CBC | SHA-1 |
+| `0xC014` | `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA` | ECDHE_RSA | AES-256-CBC | SHA-1 |
+| `0x003C` | `TLS_RSA_WITH_AES_128_CBC_SHA256` | RSA | AES-128-CBC | SHA-256 |
+| `0x003D` | `TLS_RSA_WITH_AES_256_CBC_SHA256` | RSA | AES-256-CBC | SHA-256 |
+
+The `0xCCAA` / `0x009C` / `0x009D` suites and the CBC block carry no forward
+secrecy with an RSA key exchange; they exist for interoperability with older
+peers, not as a recommendation.
+
+ChaCha20-Poly1305 uses a full 12-byte IV with no explicit nonce (RFC 7905),
+unlike GCM — the registry records that per suite.
+
+`prioritizeChaCha: true` moves the ChaCha suites ahead of AES. Note this
+changes your **JA3** but not your **JA4**: JA4 sorts the cipher list before
+hashing, so only *which* suites you offer matters there, never their order.
+
+
 
 #### Events
 
@@ -210,9 +382,11 @@ High-level wrapper extending `stream.Duplex`, API-compatible with Node.js [`tls.
 | `session` | `(Buffer)` | **Opaque session blob** — pass back to `connect({ session })` to resume |
 | `keyUpdate` | `(direction)` | Traffic keys refreshed: `'send'` or `'receive'` |
 | `keylog` | `(Buffer)` | SSLKEYLOGFILE-format line (for Wireshark) |
-| `clienthello` | `(raw, parsed)` | ClientHello received (server side). Fires **synchronously before the ServerHello is built** — use it for JA3 fingerprinting, or to inspect the client's offered extensions (`parsed.extensions` / `getRemoteExtension`) and answer them via `set_context({ local_extensions })` (e.g. DTLS-SRTP `use_srtp`) |
+| `secure` | `()` | Handshake complete. Fires on **both** sides and on sockets built with `new TLSSocket()` — unlike `secureConnect`, which Node does not emit there. The signal to use when wrapping an existing socket for STARTTLS |
+| `clienthello` | `(raw, parsed)` | ClientHello received (server side). Fires **synchronously before the ServerHello is built** — use it for JA4/JA5 fingerprinting, or to inspect the client's offered extensions (`parsed.extensions` / `getRemoteExtension`) and answer them via `set_context({ local_extensions })` (e.g. DTLS-SRTP `use_srtp`) |
 | `handshakeMessage` | `(type, raw, parsed)` | Every handshake message (debugging) |
 | `certificateRequest` | `(msg)` | Server requested a client certificate |
+| `OCSPResponse` | `(Buffer)` | Client, with `requestOCSP`: the server's stapled OCSP response (DER) |
 | `error` | `(Error)` | TLS or transport error |
 | `close` | `()` | Connection closed |
 
@@ -243,7 +417,7 @@ High-level wrapper extending `stream.Duplex`, API-compatible with Node.js [`tls.
 | `socket.authorized` | `true` if peer certificate is valid |
 | `socket.authorizationError` | Error string or `null` |
 | `socket.alpnProtocol` | Negotiated ALPN protocol or `false` |
-| `socket.servername` | SNI value (string or `false`) |
+| `socket.servername` | SNI value (string or `false`). Server with ECH accepted: the name that was hidden; rejected: the public name |
 | `socket.encrypted` | Always `true` |
 | `socket.remoteAddress` / `.remotePort` | Peer address (delegated to transport) |
 | `socket.setNoDelay()` / `.setKeepAlive()` / `.setTimeout()` | Transport delegation |
@@ -257,7 +431,27 @@ High-level wrapper extending `stream.Duplex`, API-compatible with Node.js [`tls.
 | `socket.session` | Access the underlying `TLSSession` (low-level state machine) |
 | `socket.isResumed` | Alias for `isSessionReused()` |
 | `socket.handshakeDuration` | Handshake time in ms |
-| `socket.getJA3()` | `{ hash, raw }` - JA3 fingerprint (server-side) |
+| `socket.echStatus` | Encrypted Client Hello. Server: `null` (not offered), `'accepted'`, `'rejected'` (the handshake ran as the public name and `retry_configs` went out). Client: `null` (no ECH), `'grease'`, `'accepted'`, `'rejected'` |
+| `socket.echAccepted` | `echStatus === 'accepted'` |
+| `socket.getTicketInfo()` | `{ data, resumed, offered, state }` — the `ticketData` of the ticket this connection resumed with (server), whether it resumed, whether a ticket was offered |
+| `useDefaultCA` | When no `ca` is given, chain against the platform trust store instead of authorizing everything (default `true`). **Breaking change**: a self-signed or private-CA peer that previously connected with no `ca` configured now fails with `UNABLE_TO_GET_ISSUER_CERT`. That is the point — the old behaviour reported a connection as verified while verifying nothing, with `rejectUnauthorized` defaulting to true. Set `false` to opt back out explicitly. DTLS defaults to `false`, since WebRTC peers are self-signed by design and authenticated by SDP fingerprint |
+| `allowHalfOpen` | When `false` (the Node default, and now ours) the writable side ends automatically once the peer stops writing. This was hardcoded `true`, the opposite of Node — code expecting the documented behaviour was left holding connections open |
+| `checkServerIdentity(hostname, cert)` | Replaces the built-in RFC 6125 identity check. Return `undefined` to accept, an `Error` to reject. Runs **after** chain verification, as Node documents — a hook that only checks a pin cannot rescue a chain that failed |
+| `socket` | Run the handshake over an existing `Duplex` instead of dialling out. `host`/`port` are then ignored and nothing is connected for you, so the caller can speak cleartext first and upgrade — STARTTLS for SMTP, IMAP, PostgreSQL |
+| `secureContext` | A context from `createSecureContext()`, reused across connections instead of re-parsing the same PEM each time. Explicit `secureContext` wins over `key`/`cert` |
+| `ALPNCallback` | `({ servername, protocols }) => protocol \| undefined`. Server-side, synchronous. Returning `undefined` refuses with `no_application_protocol`. Mutually exclusive with `ALPNProtocols` |
+| `grease` | Insert GREASE (RFC 8701) reserved values into the ClientHello, as browsers do (default `false`). Covers cipher suites, extension types, supported groups, signature algorithms, supported versions, ALPN, `psk_key_exchange_modes` and a dummy `key_share` entry. **Changes no fingerprint** — JA3 and JA4 both strip GREASE — but its *absence* reads as "not a browser". Any list you already GREASE'd by hand is left alone, so `grease: true` never collides with manual configuration. Safe against public HTTPS servers; leave off for DTLS/WebRTC peers until tested |
+| `permuteExtensions` | Shuffle ClientHello extension order per connection, as Chrome 110+ does (default `false`). Changes your **JA3** on every handshake; leaves your **JA4** byte-for-byte identical, since JA4 sorts before hashing. Order is chosen once and replayed on a post-HRR retry, per RFC 8446 §4.1.2 |
+| `socket.getJA4(opts?)` | The client's **JA4** fingerprint, `{ hash, raw }` (`t13d1516h2_8daaf6152771_e5627ece308c`). Available in either role, since both hellos are visible to both peers; `null` before the ClientHello has been seen. Pass `{ protocol: 'q' }` when driving the session from QUIC |
+| `socket.getJA5(opts?)` | **JA5**: JA4 without the extensions that describe the connection rather than the client (`pre_shared_key`, `session_ticket`, `early_data`, `padding`, `cookie`, `psk_key_exchange_modes`) — the same client build has one JA5 whether it resumed or not — and with the `supported_groups` it offers, which JA4 does not look at. `{ hash, raw }` |
+| `socket.getJA4S(opts?)` | The server's **JA4S** fingerprint, `{ hash, raw }` — `null` until a ServerHello exists |
+| `socket.getFinished()` / `getPeerFinished()` | The Finished verify_data, ours and the peer's — the `tls-unique` channel binding of RFC 5929. `undefined` before the handshake |
+| `socket.isSessionReused()` | Whether this connection resumed an earlier session (same value as the `isResumed` property; Node spells it as a method) |
+| `socket.address()` | `{ port, family, address }` of the underlying transport, `{}` when not connected |
+| `socket.getEphemeralKeyInfo()` | `{ type, name, size }` for the negotiated key agreement. `null` on a server socket, as in Node |
+| `server.injectConnection(stream)` | Feed an arbitrary `Duplex` into the server as if it had just connected. Node does this by emitting `'connection'` by hand; here it is a method, because the server emits that event itself and a self-listener would re-enter on every real connection |
+| `server.addContext(host, ctx)` | Register a certificate for an SNI host or wildcard (`'*.example.com'`, or `'*'` as catch-all). Takes a `createSecureContext()` result or plain `{ key, cert }`. Exact matches beat wildcards; re-registering a host replaces it. Each context is compiled **once** — the hand-written `SNICallback` equivalent usually recompiles per connection, and often reads the cert off disk on the handshake path |
+| `socket.setKeyCert(context)` | Swap the certificate and key for this one connection. Takes a `createSecureContext()` result or a plain `{ key, cert }`. Pairs with `ALPNCallback`, where the protocol is known but `SNICallback` has already run |
 | `socket.getSharedSecret()` | ECDHE shared secret (Buffer) |
 | `socket.getNegotiationResult()` | `{ version, cipher, group, sni, alpn, resumed, helloRetried, ... }` |
 | `socket.rekeySend()` | Refresh outgoing encryption keys (TLS 1.3) |
@@ -306,15 +500,27 @@ session.on('secureConnect', () => {
 session.requestKeyUpdate(true); // true = request peer to update too
 session.on('keyUpdate', ({ direction, secret }) => { /* ... */ });
 
+// Tickets carrying the protocol layer's own state (server, TLS 1.3) —
+// apart from the application's ticketData, ≤ 128 bytes JSON. A QUIC stack
+// keeps its path measurements here; sendTicket() issues another ticket
+// now, after the handshake (OpenSSL's SSL_new_session_ticket), carrying it.
+session.setTicketState({ rtt: 120, bw: 1250000 });
+session.sendTicket();
+// …and on the connection that resumes with it:
+session.getTicketInfo(); // { data, resumed: true, offered: true, state: { rtt: 120, bw: 1250000 } }
+
 // PSK callback - full control over ticket validation (server)
 session.on('psk', (identity, callback) => {
   const psk = myTicketStore.lookup(identity);
   callback(psk ? { psk, cipher: 0x1301 } : null);
 });
 
-// JA3 fingerprinting (server)
+// Fingerprinting (server) — fires before the ServerHello is built, so this is
+// where you drop a connection without spending a full handshake on it.
 session.on('clienthello', (raw, parsed) => {
-  console.log(session.getJA3()); // { hash: 'abc...', raw: '769,47-53,...' }
+  console.log(session.getJA4().hash);  // 't13d521100_b262b3658495_8e6e362c5eac'
+  // getJA4S() is still null here — no ServerHello exists yet. Ask again
+  // later in the session and it will be there.
 });
 ```
 
@@ -469,10 +675,20 @@ tls.createServer({
 socket.on('keylog', (line) => fs.appendFileSync('keys.log', line));
 // Wireshark: Edit → Preferences → TLS → Pre-Master-Secret log filename → keys.log
 
-// JA3 fingerprinting (server-side bot detection)
+// Fingerprinting — server-side bot detection
 server.on('secureConnection', (socket) => {
-  const ja3 = socket.getJA3();
-  console.log(ja3.hash); // 'e7d705a3286e19ea42f587b344ee6865'
+  const ja4 = socket.getJA4();
+  console.log(ja4.hash);              // 't13d1516h2_8daaf6152771_e5627ece308c' — the client
+  console.log(ja4.raw);               // unhashed form: shows which ciphers actually differ
+  console.log(socket.getJA5().hash);  // the same client, resumed or not
+  console.log(socket.getJA4S().hash); // 't130200_1301_a56c5b993250' — how WE look to them
+});
+
+// Client side: the same calls, the same values
+const socket = connect({ host: 'example.com', port: 443 });
+socket.on('secureConnect', () => {
+  console.log(socket.getJA4().hash);  // how this library looks to the server
+  console.log(socket.getJA4S().hash); // which server stack answered
 });
 
 // Full negotiation result
@@ -499,6 +715,7 @@ LemonTLS is verified against real-world TLS implementations:
 | **Node.js `tls`** | Client / Server | 1.2 / 1.3 | Bidirectional interop + session resumption |
 | **openssl s_client** | Client | 1.2 / 1.3 | All supported ciphers & groups |
 | **msquic** | (via QUICO) | 1.3 | HRR + P-384 + AES-256-GCM-SHA384 tested |
+| **Go `crypto/tls`** | Client / Server | 1.3 | **ECH** both ways: accepted, `retry_configs` then accepted with them, HelloRetryRequest; GREASE ECH (our client), resumption inside ECH (our server) |
 
 ## ⚡ Performance
 
@@ -549,6 +766,12 @@ For a pure-JavaScript implementation with zero native dependencies, this is with
 | ✅ | Zero dependencies - `node:crypto` only |
 | ✅ | **72 automated tests** (compat, resumption, data transfer) |
 | ✅ | Browser-tested (Chrome) |
+| ✅ | Encrypted Client Hello (RFC 9849) — server and client, GREASE ECH |
+| ✅ | HPKE (RFC 9180) — all modes, five KEMs |
+| ✅ | Hybrid post-quantum key exchange — X25519MLKEM768 |
+| ✅ | Certificate compression (RFC 8879) — brotli, zlib, zstd |
+| ✅ | OCSP stapling — server (`'OCSPRequest'`) and client (`requestOCSP`) |
+| ✅ | Application data in session tickets (`ticketData`, `getTicketInfo()`) |
 
 ### ⏳ Planned
 
@@ -557,7 +780,6 @@ For a pure-JavaScript implementation with zero native dependencies, this is with
 | ⏳ | Loss detection + PTO (for QUIC integration) | Buffer ready, needs timers |
 | ⏳ | 0-RTT Early Data | Risky (replay attacks), low priority |
 | ⏳ | Full certificate chain validation | Including CA/revocation checks |
-| ⏳ | OCSP stapling | Rare in modern web, low priority |
 | ⏳ | Fuzz testing | Security hardening |
 
 ### Compatibility Test Summary
@@ -599,15 +821,20 @@ src/
   crypto.js              - key schedule (HKDF, PRF, resumption primitives)
   compat.js              - Node.js tls API wrappers (connect, createServer,
                            checkServerIdentity, Server)
+  node_options.js        - node:tls option strings (ciphers, ecdhCurve, sigalgs)
+                           → code-point lists
   secure_context.js      - PEM/DER cert/key loading
-  utils.js               - array helpers
+  utils.js               - array helpers, certificateObject
   dtls_session.js        - DTLS state machine
   dtls_socket.js         - DTLS socket wrapper (UDP transport)
   session/
     signing.js           - signature scheme selection + signing
     ecdh.js              - X25519 / P-256 / P-384 key exchange
     message.js           - high-level message build/parse
-    ticket.js            - TLS 1.2 session ticket encryption
+    ticket.js            - session ticket encryption
+    ech.js               - Encrypted Client Hello: configs, keys, both sides
+    hpke.js              - HPKE (RFC 9180)
+    cert_compression.js  - certificate compression (RFC 8879)
 ```
 
 ## 🤝 Contributing
@@ -630,6 +857,12 @@ You can support ongoing development via [GitHub Sponsors](https://github.com/spo
 * [RFC 6125 – Hostname Verification](https://datatracker.ietf.org/doc/html/rfc6125)
 * [RFC 5705 – Exported Keying Material](https://datatracker.ietf.org/doc/html/rfc5705)
 * [RFC 5077 – Stateless Session Resumption (TLS 1.2 tickets)](https://datatracker.ietf.org/doc/html/rfc5077)
+* [RFC 9849 – TLS Encrypted Client Hello](https://datatracker.ietf.org/doc/html/rfc9849)
+* [RFC 9180 – Hybrid Public Key Encryption (HPKE)](https://datatracker.ietf.org/doc/html/rfc9180)
+* [RFC 9460 – SVCB and HTTPS DNS records](https://datatracker.ietf.org/doc/html/rfc9460)
+* [RFC 8879 – TLS Certificate Compression](https://datatracker.ietf.org/doc/html/rfc8879)
+* [RFC 8701 – GREASE](https://datatracker.ietf.org/doc/html/rfc8701)
+* [draft-ietf-tls-ecdhe-mlkem – Hybrid ML-KEM key agreement](https://datatracker.ietf.org/doc/draft-ietf-tls-ecdhe-mlkem/)
 
 ## 📜 License
 

package/index.d.ts

@@ -31,16 +31,39 @@ export interface PeerCertificate {
 }
 
 export interface EphemeralKeyInfo {
-  type: 'X25519' | 'ECDH' | 'DH';
+  /** 'TLSGroup' for a group that is not a plain curve, as Node reports it —
+   *  X25519MLKEM768 among them (no size). Client side only; {} on a server. */
+  type: 'X25519' | 'ECDH' | 'DH' | 'TLSGroup';
   name?: string;
-  size: number;
+  size?: number;
 }
 
-export interface JA3Result {
+/** A TLS fingerprint: `hash` is the fingerprint, `raw` what was hashed. */
+export interface FingerprintResult {
   hash: string;
   raw: string;
 }
 
+export interface FingerprintOptions {
+  /** Transport character, for a caller driving the session from a transport
+   *  it cannot see: 't' TCP (default), 'q' QUIC, 'd' DTLS. */
+  protocol?: 't' | 'q' | 'd';
+}
+
+/**
+ * Server: this connection's session ticket, from the first connection on.
+ * `data` is what the ticketData option put in the ticket — the one this
+ * connection resumed with, or, on a full handshake, the one made for the
+ * ticket issued to it (null until the server's Finished is sent).
+ * `offered && !resumed`: the client presented a ticket that was turned away
+ * (expired, issued before a restart, no compatible cipher).
+ */
+export interface TicketInfo {
+  data: any;
+  resumed: boolean;
+  offered: boolean;
+}
+
 export interface NegotiationResult {
   version: number | null;
   versionName: string | null;
@@ -91,6 +114,14 @@ export interface TLSSocketOptions {
   rejectUnauthorized?: boolean;
   ca?: Buffer | string;
   ticketKeys?: Buffer;
+  /**
+   * Server: what to carry inside each session ticket issued. Called once per
+   * connection as ticketData(resumed) — `resumed` is the data of the ticket
+   * this connection resumed with, null on a full handshake. The return value
+   * (JSON-safe, at most 256 bytes serialized) rides in the ticket, encrypted
+   * with ticketKeys; read it back with getTicketInfo().
+   */
+  ticketData?: (resumed: any) => any;
   /**
    * Opaque serialized session from a previous 'session' event.
    * Pass this back to resume a TLS 1.2/1.3 session.
@@ -100,6 +131,21 @@ export interface TLSSocketOptions {
   cert?: Buffer | string;
   key?: Buffer | string;
 
+  // TCP options, as in node:net. connect() passes them (and the rest of
+  // net.connect's: localAddress, localPort, family, lookup, timeout) to
+  // net.connect; createServer() applies noDelay/keepAlive to every
+  // connection it accepts. Defaults as in Node: off.
+  /** Disable Nagle's algorithm (TCP_NODELAY). Default: false. */
+  noDelay?: boolean;
+  /** Enable TCP keep-alive. Default: false. */
+  keepAlive?: boolean;
+  /** Milliseconds before the first keep-alive probe. Default: 0. */
+  keepAliveInitialDelay?: number;
+  localAddress?: string;
+  localPort?: number;
+  family?: number;
+  timeout?: number;
+
   // LemonTLS-only options
   noTickets?: boolean;
   sessionTickets?: boolean;
@@ -179,7 +225,17 @@ export class TLSSocket extends Duplex {
   /** Returns the underlying TLSSession for low-level access. */
   session: TLSSession;
   readonly handshakeDuration: number | null;
-  getJA3(): JA3Result | null;
+  /** JA4 of the ClientHello — the published format, what fingerprint
+   *  databases match. Changes when a client resumes (pre_shared_key). */
+  getJA4(opts?: FingerprintOptions): FingerprintResult | null;
+  /** JA5 of the ClientHello (ntop's draft): as JA4 without the extensions that
+   *  vary per connection, plus supported_groups — the same for a client
+   *  whether it resumed or not. */
+  getJA5(opts?: FingerprintOptions): FingerprintResult | null;
+  /** JA4S of the ServerHello. */
+  getJA4S(opts?: FingerprintOptions): FingerprintResult | null;
+  /** Server: this connection's session ticket — see TicketInfo. */
+  getTicketInfo(): TicketInfo;
   getSharedSecret(): Buffer | null;
   getNegotiationResult(): NegotiationResult | null;
   rekeySend(): void;
@@ -246,6 +302,8 @@ export interface TLSSessionOptions {
   ALPNProtocols?: string[];
   SNICallback?: (servername: string, cb: (err: Error | null, ctx: SecureContext | null) => void) => void;
   ticketKeys?: Buffer;
+  /** See TLSSocketOptions.ticketData. */
+  ticketData?: (resumed: any) => any;
   session?: Buffer | Uint8Array | SessionTicketData;
   psk?: any;
   rejectUnauthorized?: boolean;
@@ -295,6 +353,8 @@ export class TLSSession extends EventEmitter {
   getCipher(): number | null;
   getALPN(): string | null;
   getPeerCertificate(): Array<{ cert: Buffer }> | null;
+  /** Our own certificate chain — the one this connection presents. */
+  getCertificate(): Array<{ cert: Buffer }> | null;
   getTrafficSecrets(): TrafficSecrets;
   getHandshakeSecrets(): HandshakeSecrets;
   exportKeyingMaterial(length: number, label: string, context: Uint8Array): Uint8Array;
@@ -302,7 +362,11 @@ export class TLSSession extends EventEmitter {
   getPeerFinished(): Buffer | null;
   getSharedSecret(): Buffer | null;
   getNegotiationResult(): NegotiationResult;
-  getJA3(): JA3Result | null;
+  getJA4(opts?: FingerprintOptions): FingerprintResult | null;
+  getJA5(opts?: FingerprintOptions): FingerprintResult | null;
+  getJA4S(opts?: FingerprintOptions): FingerprintResult | null;
+  /** Server: this connection's session ticket — see TicketInfo. */
+  getTicketInfo(): TicketInfo;
   requestKeyUpdate(requestPeer?: boolean): void;
 
   // Events
@@ -338,6 +402,19 @@ export function createServer(
 
 export function getCiphers(): string[];
 
+/** Node-compat: the shipped CA bundle (PEM strings) — tls.rootCertificates. */
+export const rootCertificates: readonly string[];
+/**
+ * Node-compat: tls.getCACertificates([type]). 'default' and 'bundled' return
+ * the CA set clients verify against when given no `ca` (the shipped bundle,
+ * or what setDefaultCACertificates put in its place); 'extra' and 'system'
+ * are not sourced here and return [].
+ */
+export function getCACertificates(type?: 'default' | 'bundled' | 'extra' | 'system'): string[];
+/** Node-compat: tls.setDefaultCACertificates(certs) — replaces that set for
+ *  every later connection that passes no `ca`. Throws if not an array. */
+export function setDefaultCACertificates(certs: string[]): void;
+
 /**
  * Validates that the peer certificate matches the hostname (RFC 6125).
  * Returns undefined on success, or an Error on mismatch.
@@ -363,6 +440,14 @@ export declare const crypto: {
   hkdf_expand: (hash: string, prk: Uint8Array, info: Uint8Array, length: number) => Uint8Array;
   hkdf_expand_label: (hash: string, secret: Uint8Array, label: string, context: Uint8Array, length: number) => Uint8Array;
   hmac: (hash: string, key: Uint8Array, data: Uint8Array) => Uint8Array;
+  /** TLS 1.2 PRF (RFC 5246 §5). */
+  tls12_prf: (secret: Uint8Array, label: string, seed: Uint8Array, length: number, hash: string) => Uint8Array;
+  /** RFC 5705 exporter over a TLS 1.2 master secret. */
+  tls12_exporter: (hash: string, masterSecret: Uint8Array, label: string, clientRandom: Uint8Array,
+                   serverRandom: Uint8Array, context: Uint8Array | null, length: number) => Uint8Array;
+  /** RFC 8446 §7.5 exporter; labelPrefix defaults to TLS 1.3's ('tls13 '). */
+  tls13_exporter: (hash: string, exporterMasterSecret: Uint8Array, label: string,
+                   context: Uint8Array | null, length: number, labelPrefix?: string) => Uint8Array;
 };
 
 export declare const wire: any;
@@ -398,6 +483,9 @@ declare const _default: {
   createServer: typeof createServer;
   getCiphers: typeof getCiphers;
   checkServerIdentity: typeof checkServerIdentity;
+  getCACertificates: typeof getCACertificates;
+  setDefaultCACertificates: typeof setDefaultCACertificates;
+  rootCertificates: typeof rootCertificates;
   DEFAULT_MIN_VERSION: string;
   DEFAULT_MAX_VERSION: string;
   DEFAULT_CIPHERS: string;
@@ -411,4 +499,4 @@ declare const _default: {
   connectDTLS: typeof connectDTLS;
 };
 
-export default _default;
+export default _default;