codeql-action/lib/start-proxy.js

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
    var ownKeys = function(o) {
        ownKeys = Object.getOwnPropertyNames || function (o) {
            var ar = [];
            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
            return ar;
        };
        return ownKeys(o);
    };
    return function (mod) {
        if (mod && mod.__esModule) return mod;
        var result = {};
        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
        __setModuleDefault(result, mod);
        return result;
    };
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.parseLanguage = parseLanguage;
exports.getCredentials = getCredentials;
const core = __importStar(require("@actions/core"));
const languages_1 = require("./languages");
const util_1 = require("./util");
/*
 * Language aliases supported by the start-proxy Action.
 *
 * In general, the CodeQL CLI is the source of truth for language aliases, and to
 * allow us to more easily support new languages, we want to avoid hardcoding these
 * aliases in the Action itself.  However this is difficult to do in the start-proxy
 * Action since this Action does not use CodeQL, so we're accepting some hardcoding
 * for this Action.
 */
const LANGUAGE_ALIASES = {
    c: languages_1.KnownLanguage.cpp,
    "c++": languages_1.KnownLanguage.cpp,
    "c#": languages_1.KnownLanguage.csharp,
    kotlin: languages_1.KnownLanguage.java,
    typescript: languages_1.KnownLanguage.javascript,
    "javascript-typescript": languages_1.KnownLanguage.javascript,
    "java-kotlin": languages_1.KnownLanguage.java,
};
/**
 * Parse the start-proxy language input into its canonical CodeQL language name.
 *
 * Exported for testing. Do not use this outside of the start-proxy Action
 * to avoid complicating the process of adding new CodeQL languages.
 */
function parseLanguage(language) {
    // Normalize to lower case
    language = language.trim().toLowerCase();
    // See if it's an exact match
    if (language in languages_1.KnownLanguage) {
        return language;
    }
    // Check language aliases
    if (language in LANGUAGE_ALIASES) {
        return LANGUAGE_ALIASES[language];
    }
    return undefined;
}
const LANGUAGE_TO_REGISTRY_TYPE = {
    java: "maven_repository",
    csharp: "nuget_feed",
    javascript: "npm_registry",
    python: "python_index",
    ruby: "rubygems_server",
    rust: "cargo_registry",
    go: "goproxy_server",
};
/**
 * Checks that `value` is neither `undefined` nor `null`.
 * @param value The value to test.
 * @returns Narrows the type of `value` to exclude `undefined` and `null`.
 */
function isDefined(value) {
    return value !== undefined && value !== null;
}
// getCredentials returns registry credentials from action inputs.
// It prefers `registries_credentials` over `registry_secrets`.
// If neither is set, it returns an empty array.
function getCredentials(logger, registrySecrets, registriesCredentials, languageString) {
    const language = languageString ? parseLanguage(languageString) : undefined;
    const registryTypeForLanguage = language
        ? LANGUAGE_TO_REGISTRY_TYPE[language]
        : undefined;
    let credentialsStr;
    if (registriesCredentials !== undefined) {
        logger.info(`Using registries_credentials input.`);
        credentialsStr = Buffer.from(registriesCredentials, "base64").toString();
    }
    else if (registrySecrets !== undefined) {
        logger.info(`Using registry_secrets input.`);
        credentialsStr = registrySecrets;
    }
    else {
        logger.info(`No credentials defined.`);
        return [];
    }
    // Parse and validate the credentials
    let parsed;
    try {
        parsed = JSON.parse(credentialsStr);
    }
    catch {
        // Don't log the error since it might contain sensitive information.
        logger.error("Failed to parse the credentials data.");
        throw new util_1.ConfigurationError("Invalid credentials format.");
    }
    // Check that the parsed data is indeed an array.
    if (!Array.isArray(parsed)) {
        throw new util_1.ConfigurationError("Expected credentials data to be an array of configurations, but it is not.");
    }
    const out = [];
    for (const e of parsed) {
        if (e === null || typeof e !== "object") {
            throw new util_1.ConfigurationError("Invalid credentials - must be an object");
        }
        // Mask credentials to reduce chance of accidental leakage in logs.
        if (isDefined(e.password)) {
            core.setSecret(e.password);
        }
        if (isDefined(e.token)) {
            core.setSecret(e.token);
        }
        if (!isDefined(e.url) && !isDefined(e.host)) {
            // The proxy needs one of these to work. If both are defined, the url has the precedence.
            throw new util_1.ConfigurationError("Invalid credentials - must specify host or url");
        }
        // Filter credentials based on language if specified. `type` is the registry type.
        // E.g., "maven_feed" for Java/Kotlin, "nuget_repository" for C#.
        if (registryTypeForLanguage && e.type !== registryTypeForLanguage) {
            continue;
        }
        const isPrintable = (str) => {
            return str ? /^[\x20-\x7E]*$/.test(str) : true;
        };
        if (!isPrintable(e.type) ||
            !isPrintable(e.host) ||
            !isPrintable(e.url) ||
            !isPrintable(e.username) ||
            !isPrintable(e.password) ||
            !isPrintable(e.token)) {
            throw new util_1.ConfigurationError("Invalid credentials - fields must contain only printable characters");
        }
        out.push({
            type: e.type,
            host: e.host,
            url: e.url,
            username: e.username,
            password: e.password,
            token: e.token,
        });
    }
    return out;
}
//# sourceMappingURL=start-proxy.js.map