Skip to main content

Add an ISM endpoint to a gateway

When you configure a gateway, you must create one endpoint that connects to it. After you configure the gateway, you can add more endpoints to it. Veracode recommends that you install one endpoint in each network in which you scan your internal applications or REST APIs.

note

ISM currently supports ASCII characters, not UTF-8, for the names and descriptions of gateways and endpoints.

Before you begin:

Before installing an endpoint on a machine, verify that you can connect to the applications you want to scan from that machine.

To complete this task:

  1. From the gear icon menu at the top of the Veracode Platform, select Internal Scanning Management.

  2. Select the name of the gateway to which you want to add the endpoint.

  3. On the gateway page, select Add Endpoint.

  4. Enter the endpoint name and description.

  5. Select the platform of the machine running the endpoint. If you do not use Windows or Linux, select Other to perform a manual endpoint installation.

    If you select Other, see Manually install an endpoint.

  6. Select Next.

  7. Complete these steps to start the installer:

    a. Select Download to download the ZIP file containing the installer.

    b. Select Copy in the text box in step 2.3 to copy your endpoint key to your clipboard.

    c. Move the downloaded ZIP file to a machine behind your firewall with access to your internal applications or REST APIs.

    d. Extract the ZIP file.

    e. Open the installer file.

    • For Windows machines, the filename is veracode_ism_install.bat.
    • For Linux machines, the filename is veracode_ism_install.sh

    If you have insufficient permissions to create the service, run the file as an administrator. If you are using a Linux machine without a GUI wrapper, Veracode recommends you open the installer with this command: sudo -s ./veracode_ism_install.sh

  8. After you launch the installer, complete these steps to install the endpoint. For Linux machines without a GUI wrapper, opening the installer prompts you to provide the information listed in these steps on the command line.

    a. Read the terms of use for the endpoint, select the checkbox and select Next.

    b. Verify the installation folder and Java home are correct or select your preferred folders and select Next.

    c. If you use a proxy, select Manual configuration and complete these steps. If the installer cannot automatically detect the Java home, you must specify it.

    • Enter your proxy hostname and port number.
    • If you want to use the proxy only for communication between the endpoint and gateway:
      • Select For gateway connection.
      • If you want the proxy to resolve the gateway hostname, which means you need to allow only the gateway hostname, clear the Let endpoint resolve hostname for gateway checkbox. If you do not clear it, you must include the hostname and IP address of the gateway in your allowlist.
    • If you want to use the proxy for communication between the endpoint and gateway and between the endpoint and the URLs you scan:
      • Select For gateway and URL connections.
      • If you want the proxy to resolve the gateway or URL hostnames, which means you need to allow only the hostname for the gateway and the URLs you scan, clear the Let endpoint resolve hostname for gateway or Let endpoint resolve hostname for URLs checkboxes. If you do not clear them, you must include the hostname and IP address of the gateway and URLs in your allowlist.
    • If the proxy requires authentication, select Authentication Required and, then, enter your proxy credentials.

    d. Select Next.

    e. Paste the endpoint key you copied in step 7 and select Next. If you did not copy the endpoint key, go to the gateway page in the Veracode Platform, select the Actions menu for this endpoint, and select Copy Endpoint Key.

    f. When the key validates, select Install.

    g. Select Close.

    After you complete the installation, the new endpoint appears on the gateway page with a status of Ready.

Next steps:

You can now create the following Dynamic Analyses for internal scanning: