test/parallel/test-tls-ticket.js

// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

'use strict';
const common = require('../common');
if (!common.hasCrypto)
  common.skip('missing crypto');

const assert = require('assert');
const tls = require('tls');
const net = require('net');
const crypto = require('crypto');
const fixtures = require('../common/fixtures');

const keys = crypto.randomBytes(48);
const serverLog = [];
const ticketLog = [];

let s;

let serverCount = 0;
function createServer() {
  const id = serverCount++;

  let counter = 0;
  let previousKey = null;

  const server = tls.createServer({
    key: fixtures.readKey('agent1-key.pem'),
    cert: fixtures.readKey('agent1-cert.pem'),
    ticketKeys: keys
  }, function(c) {
    serverLog.push(id);
    // TODO(@sam-github) Triggers close_notify before NewSessionTicket bug.
    // c.end();
    c.end('x');

    counter++;

    // Rotate ticket keys
    //
    // Take especial care to account for TLS1.2 and TLS1.3 differences around
    // when ticket keys are encrypted. In TLS1.2, they are encrypted before the
    // handshake complete callback, but in TLS1.3, they are encrypted after.
    // There is no callback or way for us to know when they were sent, so hook
    // the client's reception of the keys, and use it as proof that the current
    // keys were used, and its safe to rotate them.
    //
    // Rotation can occur right away if the session was reused, the keys were
    // already decrypted or we wouldn't have a reused session.
    function setTicketKeys(keys) {
      if (c.isSessionReused())
        server.setTicketKeys(keys);
      else
        s.once('session', () => {
          server.setTicketKeys(keys);
        });
    }
    if (counter === 1) {
      previousKey = server.getTicketKeys();
      assert.strictEqual(previousKey.compare(keys), 0);
      setTicketKeys(crypto.randomBytes(48));
    } else if (counter === 2) {
      setTicketKeys(previousKey);
    } else if (counter === 3) {
      // Use keys from counter=2
    } else {
      throw new Error('UNREACHABLE');
    }
  });

  return server;
}

const naturalServers = [ createServer(), createServer(), createServer() ];

// 3x servers
const servers = naturalServers.concat(naturalServers).concat(naturalServers);

// Create one TCP server and balance sockets to multiple TLS server instances
const shared = net.createServer(function(c) {
  servers.shift().emit('connection', c);
}).listen(0, function() {
  start(function() {
    shared.close();
  });
});

// 'session' events only occur for new sessions. The first connection is new.
// After, for each set of 3 connections, the middle connection is made when the
// server has random keys set, so the client's ticket is silently ignored, and a
// new ticket is sent.
const onNewSession = common.mustCall((s, session) => {
  assert(session);
  assert.strictEqual(session.compare(s.getSession()), 0);
}, 4);

function start(callback) {
  let sess = null;
  let left = servers.length;

  function connect() {
    s = tls.connect(shared.address().port, {
      session: sess,
      rejectUnauthorized: false
    }, function() {
      if (s.isSessionReused())
        ticketLog.push(s.getTLSTicket().toString('hex'));
    });
    s.on('data', () => {
      s.end();
    });
    s.on('close', function() {
      if (--left === 0)
        callback();
      else
        connect();
    });
    s.on('session', (session) => {
      sess = sess || session;
    });
    s.once('session', (session) => onNewSession(s, session));
    s.once('session', () => ticketLog.push(s.getTLSTicket().toString('hex')));
  }

  connect();
}

process.on('exit', function() {
  assert.strictEqual(ticketLog.length, serverLog.length);
  for (let i = 0; i < naturalServers.length - 1; i++) {
    assert.notStrictEqual(serverLog[i], serverLog[i + 1]);
    assert.strictEqual(ticketLog[i], ticketLog[i + 1]);

    // 2nd connection should have different ticket
    assert.notStrictEqual(ticketLog[i], ticketLog[i + naturalServers.length]);

    // 3rd connection should have the same ticket
    assert.strictEqual(ticketLog[i], ticketLog[i + naturalServers.length * 2]);
  }
});