imapflow/lib/commands/starttls.js

IMAP Client for Node

'use strict';

/**
 * Initiates STARTTLS connection upgrade.
 *
 * @param {Object} connection - IMAP connection instance
 * @returns {Promise<boolean>} True if STARTTLS was initiated, false if not supported or already secure
 */
module.exports = async connection => {
    if (!connection.capabilities.has('STARTTLS') || connection.secureConnection) {
        // nothing to do here
        return false;
    }

    let response;
    try {
        response = await connection.exec('STARTTLS');
        // Whether the server sent anything after the STARTTLS OK and before the TLS
        // handshake. upgradeToSTARTTLS() uses this to reject a plaintext injection.
        connection._starttlsHadTrailingData = !!(response && response.hasTrailingData);
        response.next();
        return true;
    } catch (err) {
        connection.log.warn({ err, cid: connection.id });
        return false;
    }
};