Node.js tlsSocket.enableTrace() Method

The tlsSocket.enableTrace() method is an inbuilt application programming interface of class TLSSocket within tls module which is used to debug TLS connection problems.

Syntax:

tlsSocket.enableTrace()

Parameters: This method does not accept any parameter.

Return Value: This method will display TLS packet trace information in stderr.

How to generate a private key and public certificates?

Private Key

Step 1: Open Notepad and copy and paste the following key:

Step 2: Save as a private key.pem

Public Certificate

Step 1: Open Notepad and copy and paste the following key:

Step 2: Save as public cert.pem

Example 1: Filename: index.js

javascript

// Node.js program to demonstrate the
// tlsSocket.enableTrace() method
const tls = require('tls'),
    fs = require('fs'),

    // Port and host address for server
    PORT = 1337,
    HOST = '127.0.0.1',
    value = null;

// Private key and public certificate for access
const options = {
    key: fs.readFileSync('private-key.pem'),
    cert: fs.readFileSync('public-cert.pem'),
    rejectUnauthorized: false
};

// Creating and initializing server
const server = tls.createServer(options, function (socket) {

    // Print the data that we received
    socket.on('data', function (data) {
        console.log('\nReceived: %s ',
            data.toString().replace(/(\n)/gm, ""));
    });

    // Stopping the server
    // by using the close() method
    server.close(() => {
        console.log("Server closed successfully");
    });
});

// Start listening on a specific port and address
// by using listen() method
server.listen(PORT, HOST, function () {
    console.log("I'm listening at %s, on port %s", HOST, PORT);
});

// Creating and initializing client
const client = tls.connect(PORT, HOST, options, function () {

    // Display TLS packet trace information
    // by using tlsSocket.enableTrace() method
    client.enableTrace();

    client.end(() => {
        console.log("Client closed successfully");
    });

});

Run the index.js file using the following command:

node index.js

Output:

I'm listening at 127.0.0.1, on port 1337
Sent Record
Header:
Version = TLS 1.2 (0x303)
Content Type = ApplicationData (23)
Length = 19
Inner Content Type = Alert (21)
Level=warning(1), description=close notify(0)
Client closed successfully
Server closed successfully
Received Record
Header:
Version = TLS 1.2 (0x303)
Content Type = ApplicationData (23)
Length = 266
Inner Content Type = Handshake (22)
NewSessionTicket, Length=245
ticket_lifetime_hint=7200
ticket_age_add=1553580394
ticket_nonce (len=8): 0000000000000000
ticket (len=224): 7C75222CD19446A54CE.........2F1948461E4F43C6DB547A6
No extensions
Received Record
Header:
Version = TLS 1.2 (0x303)
Content Type = ApplicationData (23)
Length = 266
Inner Content Type = Handshake (22)
NewSessionTicket, Length=245
ticket_lifetime_hint=7200
ticket_age_add=3758812927
ticket_nonce (len=8): 0000000000000001
ticket (len=224): 7C75222CD19446A54CE156C84..........603ECFEA28F1
No extensions
Received Record
Header:
Version = TLS 1.2 (0x303)
Content Type = ApplicationData (23)
Length = 19
Inner Content Type = Alert (21)
Level=warning(1), description=close notify(0)

Example 2: Filename: index.js

javascript

// Node.js program to demonstrate the
// tlsSocket.enableTrace() method
const tls = require('tls'),
    fs = require('fs'),

    // Port and host address for server
    PORT = 1337,
    HOST = '127.0.0.1';

// Private key and public certificate for access
const options = {
    key: fs.readFileSync('private-key.pem'),
    cert: fs.readFileSync('public-cert.pem'),
    rejectUnauthorized: false
};

// Creating and initializing server
const server = tls.createServer(options, function (socket) {

    // Display TLS packet trace information
    // by using tlsSocket.enableTrace() method
    client.enableTrace();

    // Stopping the server
    // by using the close() method
    server.close(() => {
        console.log("Server closed successfully")
    });
});

// Start listening on a specific port and address
// by using listen() method
server.listen(PORT, HOST, function () {
    console.log("I'm listening at %s, on port %s", HOST, PORT);
});

// Creating and initializing client
const client = tls.connect(PORT, HOST, options, function () {
    console.log("client is connected");
});

client.on("data", function (data) {
    console.log('\nReceived: %s ',
        data.toString().replace(/(\n)/gm, ""));

    // Close the connection after receiving the message
    client.end(() => {
        console.log("client closed successfully")
    });
});

Run the index.js file using the following command:

node index.js

Output:

I'm listening at 127.0.0.1, on port 1337
client is connected
Received Record
Header:
Version = TLS 1.2 (0x303)
Content Type = ApplicationData (23)
Length = 266
Inner Content Type = Handshake (22)
NewSessionTicket, Length=245
ticket_lifetime_hint=7200
ticket_age_add=1281657603
ticket_nonce (len=8): 0000000000000000
ticket (len=224): 491710CA336E8346C5811978AE......8B152830D4AD866055BFAF
No extensions
Received Record
Header:
Version = TLS 1.2 (0x303)
Content Type = ApplicationData (23)
Length = 266
Inner Content Type = Handshake (22)
NewSessionTicket, Length=245
ticket_lifetime_hint=7200
ticket_age_add=2916884006
ticket_nonce (len=8): 0000000000000001
ticket (len=224): 491710CA33...........5DD7B580C29D366B3447B85121593C9C
No extensions

Reference: https://nodejs.org/dist/latest-v12.x/docs/api/tls.html#tls_tlssocket_enabletrace

Node.js tlsSocket.enableTrace() Method

Explore