Private package manager integration for npm

Learn how to configure Endor Labs to access private npm repositories for dependency resolution and security scanning.

Configure Endor Labs to integrate with private npm repositories to access proprietary dependencies during security scanning and analysis. When your JavaScript/Node.js projects depend on packages hosted in private or corporate repositories, Endor Labs requires authentication credentials to resolve these dependencies and generate a complete bill of materials.

This integration enables Endor Labs to:

  • Access private npm packages during dependency resolution
  • Generate comprehensive security analysis including private dependencies
  • Maintain complete visibility into your software supply chain

Endor Labs integrates with your self-hosted package repositories and source control systems to give you visibility into your environment. Package manager integrations allow users to simplify scanning using custom repositories.

Endor Labs generally respects package authentication and configuration settings and a package manager integration is usually not required to scan private packages successfully.

  • Use package manager integrations to simplify scanning when authentication to private repositories is not part of standard manifest or settings files.

  • Package manager integrations allow you to set custom repositories for each package ecosystem and the priority of each repository for scanning.

To set up a package manager integration:

  1. Sign in to Endor Labs.

  2. Select Manage > Integrations from the left sidebar.

  3. Click Manage in the package manager configuration you want to customize.

  4. Select Add Package Manager.

  5. Enter the name of the package manager.

  6. Select either Basic or AWS Code Artifactory as Authentication Type.

    See AWS authentication for more information.

  7. Click Advanced and select Propagate this policy to all child namespaces to apply the package manager integration to all child namespaces.

  8. Select Add Package Manager.

If you want to delete a package manager integration, click the trash can icon at the far right of the integration.

To connect to private repositories of npm enter the package manager URL and the package registry credentials such as username and password.

Basic Authentication for package manager integrations

  1. Select Manage > Integrations from the left sidebar.
  2. Click Manage in the package manager configuration you want to customize.
  3. Click the vertical three dots of the package manager configured and select Test Connection.

Use endorctl to create a package manager resource for your private npm registry and authenticate using one of the following tokens:

  • Base64-encoded username and password
  • Basic authentication token

  1. Generate base64 token

    To generate the base64 encoded username and password, run the following command. Copy the token generated and store it in a secure place.

    echo -n 'username:plain_password' | openssl base64

  2. Create package manager resource

    Run the following command to create a package manager resource and authenticate to npm registry using base64 token without scope.

    Replace:

    • base64 token with the generated base64 encoded username and password in the previous step.
    • namespace with your namespace.
    endorctl api create  -r PackageManager -n <namespace> -d '
{
    "meta": {
        "name": "test npm with base64",
        "description": "test npm with base 64 token without scope"
    },
    "spec": {
        "npm": {
            "priority": 1,
            "url": "package manager url"
            "token": "base64 token"
        }
    },
    "propagate": true
} '

Run the following command to create a package manager resource and authenticate to npm registry using basic authentication token with scope.

Replace:

  • xxx with your authentication token.
  • namespace with your namespace.
  • @scope with your scope. For example, "scope":"@abc-corp".
endorctl api create  -r PackageManager -n <namespace> -d '
{
    "meta": {
        "name": "test npm with auth token",
        "description": "test npm with auth token with scope"
    },
    "spec": {
        "npm": {
            "priority": 1,
            "scope": "@scope",
            "url": "package manager url",
            "auth_token": "xxxx"
        }
    },
    "propagate": true
} '

Run the following command to fetch the package manager using the UUID:

endorctl api get -r packageManager -n <your namespace>  --uuid <take uuid from list command>

Run the following command to delete the package manager using the UUID:

endorctl api delete -r packageManager -n <your namespace>  --uuid <take uuid from list command>