MbedTLS Node.js Client

Original DTLS client with fixes and improvements from AI and node-mbed-dtls-modified, including Node.js 12+ support and Node.js v24 compatibility.

Supported Platforms

• Linux (Ubuntu, Fedora, etc.)
• macOS ≥ 13.5 Ventura (Intel and Apple Silicon)
• Windows - Not supported or tested

System Requirements

• Node.js: 18.x, 20.x, 22.x, or 24.x
• macOS: macOS 13.5 (Ventura) or later
• Xcode: 16.1 or later (for macOS development)
• C++ Compiler: Support for C++20 standard

Setup & Build

git submodule update --init mbedtls
npm i

DTLS Client API:

Here is the scope of possible options, along with their default values.

const options = {
  host:    'localhost', // The target address or hostname.
  port:     5684,       // The target UDP port.
  socket:   undefined,  // An already established socket, if you'd rather spin your own.
  key:      undefined,  // Buffer. Our private key.
  cert:     undefined,  // Buffer. Our public key.
  psk:      undefined,  // Buffer. Pre-shared Symmetric Key, if applicable.
  PSKIdent: undefined,  // Buffer. PSK Identity, if applicable.
  CACert:   undefined,  // Buffer. CA public key, if applicable.
  debug:    0           // How chatty is the library? Larger values generate more log.
};

Must be provided with either a key and cert or a psk and PSKIdent. If CACert is provided, the server's certificate will be validated against it.

Events

secureConnect when we successfully establish a connection. This will only occur once for any given client.

// socket: A connection socket, ready for data.
client.on('secureConnect', (socket) => {});

close when the socket closes.

//hadError: A boolean. Did the socket close because of an error?
client.on('close', (hadError) => {});

error when the connection has a problem.

// err: Error code.
// msg: Optional error string.
client.on('error', (err, msg) => {});

Testing

Run the comprehensive test suite:

# Run all tests
npm test

# Run code quality checks
npm run lint

# Run both tests and linting
npm test && npm run lint

The test suite covers:

• ✅ Module loading and API exposure
• ✅ Socket class instantiation and configuration
• ✅ Error handling for invalid inputs
• ✅ Native module binding verification
• ✅ Connection attempt handling with PSK authentication
• ✅ Certificate error handling

Node.js Compatibility

This module has been tested and works with:

• ✅ Node.js 18.x
• ✅ Node.js 20.x
• ✅ Node.js 22.x
• ✅ Node.js 24.x (latest)

The build system automatically detects and configures the appropriate C++ standard for your Node.js version.