apigeelint/lib/package/plugins/TD007-targetSslInfo-Truststore.js

Node module and tool to lint a bundle for an Apigee API Proxy or sharedflow.

/*
  Copyright 2019-2025 Google LLC

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      https://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/

const ruleId = require("../lintUtil.js").getRuleId();

const plugin = {
  ruleId,
  name: "TargetEndpoint HTTPTargetConnection SSLInfo TrustStore",
  message:
    "TargetEndpoint HTTPTargetConnection should use TrustStore with SSLInfo.",
  fatal: false,
  severity: 1, // 1 = warn, 2 = error
  nodeType: "Endpoint",
  enabled: true,
};

const path = require("path"),
  util = require("util"),
  debug = require("debug")("apigeelint:" + ruleId);

let bundleProfile = "apigee";
const onBundle = function (bundle, cb) {
  if (bundle.profile) {
    bundleProfile = bundle.profile;
  }
  if (typeof cb == "function") {
    cb(null, false);
  }
};

const onTargetEndpoint = function (endpoint, cb) {
  const htc = endpoint.getHTTPTargetConnection(),
    shortFilename = path.basename(endpoint.getFileName());
  let flagged = false;

  debug(`onTargetEndpoint shortfile(${shortFilename})`);
  if (htc) {
    try {
      const urls = htc.select("URL");
      const sslInfos = htc.select("SSLInfo");
      if (urls.length == 1) {
        debug(`onTargetEndpoint url(${util.format(urls[0])})`);
        const endpointUrl =
          urls[0].childNodes &&
          urls[0].childNodes[0] &&
          urls[0].childNodes[0].nodeValue;
        if (endpointUrl) {
          const isHttps = endpointUrl.startsWith("https://");
          if (isHttps) {
            if (sslInfos.length != 0) {
              const elts = htc.select(`SSLInfo/TrustStore`);
              const hasTrustStore =
                elts &&
                elts.length == 1 &&
                elts[0].childNodes &&
                elts[0].childNodes[0];
              if (!hasTrustStore) {
                endpoint.addMessage({
                  plugin,
                  line: sslInfos[0].lineNumber,
                  column: sslInfos[0].columnNumber,
                  message: "Missing TrustStore in SSLInfo",
                });
                flagged = true;
              }
            }
          }
        }
      }
    } catch (exc1) {
      console.error("exception in TD007: " + exc1);
      debug(`onTargetEndpoint exc(${exc1})`);
      debug(`${exc1.stack}`);
    }
  }

  if (typeof cb == "function") {
    debug(`onTargetEndpoint isFlagged(${flagged})`);
    cb(null, flagged);
  }
};

module.exports = {
  plugin,
  onBundle,
  onTargetEndpoint,
};