snowflake-sdk/dist/lib/authentication/auth_web.js

Node.js driver for Snowflake

"use strict";
const util = require('../util');
const querystring = require('querystring');
const URLUtil = require('./../../lib/url_util');
const Util = require('./../../lib/util');
const SsoUrlProvider = require('../authentication/sso_url_provider');
const crypto = require('crypto');
const { rest } = require('../global_config');
const { createServer } = require('./authentication_util');
const { withBrowserActionTimeout } = require('./authentication_util');
const { coordinateAuth } = require('./auth_coordinator');
const AuthenticationTypes = require('./authentication_types');
/**
 * Creates an external browser authenticator.
 *
 * @param {Object} connectionConfig
 * @param {Object} httpClient
 *
 * @returns {Object}
 * @constructor
 */
function AuthWeb(connectionConfig, httpClient) {
    const host = connectionConfig.host;
    const authenticator = connectionConfig.getAuthenticator();
    const serviceName = connectionConfig.getServiceName();
    const account = connectionConfig.account;
    const username = connectionConfig.username;
    const browserRedirectPort = connectionConfig.browserRedirectPort;
    const browserActionTimeout = connectionConfig.getBrowserActionTimeout();
    const ssoUrlProvider = new SsoUrlProvider(httpClient);
    if (!Util.exists(host)) {
        throw new Error(`Invalid value for host: ${host}`);
    }
    if (!Util.number.isPositiveInteger(browserActionTimeout)) {
        throw new Error(`Invalid value for browser action timeout: ${browserActionTimeout}`);
    }
    const open = connectionConfig.openExternalBrowserCallback || require('open');
    let proofKey;
    let token;
    /**
     * Update JSON body with token and proof_key.
     *
     * @param {JSON} body
     *
     * @returns {null}
     */
    this.updateBody = function (body) {
        body['data']['TOKEN'] = token;
        body['data']['PROOF_KEY'] = proofKey;
        body['data']['AUTHENTICATOR'] = 'EXTERNALBROWSER';
    };
    /**
     * Obtain SAML token through SSO URL.
     *
     * @returns {Promise<null>}
     */
    this.authenticate = async function () {
        const result = await coordinateAuth(host, username, AuthenticationTypes.EXTERNAL_BROWSER_AUTHENTICATOR, openBrowserAndCollectTokens);
        token = result.token;
        proofKey = result.proofKey;
    };
    async function openBrowserAndCollectTokens() {
        let server;
        let loginUrl;
        let resultProofKey;
        const receiveData = new Promise((resolve, reject) => {
            // Server to receive SAML token
            server = createServer(resolve, reject, {
                renderer: connectionConfig.browserResponseRenderer,
            });
        });
        try {
            await new Promise((resolve, reject) => {
                server.listen(browserRedirectPort);
                server.on('listening', () => resolve(server.address()));
                server.on('error', reject);
            });
        }
        catch (err) {
            throw new Error(`Error while creating local server on port ${browserRedirectPort}: ${err}`);
        }
        try {
            if (connectionConfig.getDisableConsoleLogin()) {
                // Step 1: query Snowflake to obtain SSO url
                const ssoData = await ssoUrlProvider.getSSOURL(authenticator, serviceName, account, server.address().port, username, host);
                resultProofKey = ssoData['proofKey'];
                loginUrl = ssoData['ssoUrl'];
            }
            else {
                resultProofKey = generateProofKey();
                loginUrl = getLoginUrl(username, resultProofKey, server.address().port);
            }
            // Step 2: validate URL
            if (!URLUtil.isValidURL(loginUrl)) {
                throw new Error(util.format('Invalid SSO URL found - %s ', loginUrl));
            }
            // Step 3: open browser
            open(loginUrl);
            // Step 4: get SAML token
            const tokenGetHttpLine = await withBrowserActionTimeout(browserActionTimeout, receiveData).catch((rejected) => {
                throw new Error(util.format('Error while getting SAML token: %s', rejected));
            });
            return { token: parseToken(tokenGetHttpLine), proofKey: resultProofKey };
        }
        finally {
            server.close();
        }
    }
    function generateProofKey() {
        const randomness = crypto.randomBytes(32);
        return Buffer.from(randomness, 'utf8').toString('base64');
    }
    function getLoginUrl(username, proofKey, port) {
        const url = new URL(rest.HTTPS_PROTOCOL + '://' + host + '/console/login');
        url.searchParams.append('login_name', username);
        url.searchParams.append('proof_key', proofKey);
        url.searchParams.append('browser_mode_redirect_port', port);
        return url.toString();
    }
    function parseToken(tokenHttpGetLine) {
        const data = tokenHttpGetLine.split(' ');
        return querystring.parse(data[1])['/?token'];
    }
}
module.exports = AuthWeb;
//# sourceMappingURL=auth_web.js.map