@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
dependabot/npm_and_yarn/npm_and_yarn-826852524d
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 356 lines 16.5 KB
Raw
1 ---
2 title: Trusted publishing for npm packages
3 ---
4
5 Trusted publishing allows you to publish npm packages directly from your CI/CD workflows using [OpenID Connect (OIDC)](https://openid.net/developers/how-connect-works/) authentication, eliminating the need for long-lived npm tokens. This feature implements the [trusted publishers industry standard](https://repos.openssf.org/trusted-publishers-for-all-package-repositories) specified by the Open Source Security Foundation (OpenSSF), joining a growing ecosystem including [PyPI](https://docs.pypi.org/trusted-publishers/), [RubyGems](https://guides.rubygems.org/trusted-publishing/), and other major package registries in offering this security enhancement.
6
7 <Note>
8
9 **Note:** Trusted publishing requires [npm CLI](https://docs.npmjs.com/cli/v11) version 11.5.1 or later and Node version 22.14.0 or higher.
10
11 </Note>
12
13 ## How trusted publishing works
14
15 Trusted publishing creates a trust relationship between npm and your CI/CD provider using OIDC. When you configure a trusted publisher for your package, npm will accept publishes from the specific workflow you've authorized, in addition to traditional authentication methods like npm tokens and manual publishes. The npm CLI automatically detects OIDC environments and uses them for authentication before falling back to traditional tokens.
16
17 This approach eliminates the security risks associated with long-lived write tokens, which can be compromised, accidentally exposed in logs, or require manual rotation. Instead, each publish uses short-lived, cryptographically-signed tokens that are specific to your workflow and cannot be extracted or reused.
18
19 ## Supported CI/CD providers
20
21 Trusted publishing currently supports:
22
23 - [GitHub Actions](https://github.com/features/actions) (GitHub-hosted runners)
24 - [GitLab CI/CD Pipelines](https://docs.gitlab.com/ci/pipelines/) (GitLab.com shared runners)
25 - [CircleCI](https://circleci.com/) (CircleCI cloud)
26
27 Self-hosted runners are not currently supported but are planned for future releases.
28
29 ## Configuring trusted publishing
30
31 ### Step 1: Add a trusted publisher on npmjs.com
32
33 Navigate to your package settings on [npmjs.com](https://www.npmjs.com) and find the "**Trusted Publisher**" section. Under "**Select your publisher**", choose your CI/CD provider by clicking the GitHub Actions, GitLab CI/CD, or CircleCI button.
34
35 <Screenshot src="/packages-and-modules/securing-your-code/trusted-publisher.png" alt="Screenshot showing the Trusted Publisher section with Select your publisher label and provider buttons" />
36
37 #### For GitHub Actions
38
39 Configure the following fields:
40
41 - **Organization or user** (required): Your GitHub username or organization name
42 - **Repository** (required): Your repository name
43 - **Workflow filename** (required): The filename of your workflow (e.g., `publish.yml`)
44 - Enter only the filename, not the full path
45 - Must include the `.yml` or `.yaml` extension
46 - The workflow file must exist in `.github/workflows/` in your repository
47 - **Environment name** (optional): If using [GitHub environments](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment) for deployment protection
48
49 <Screenshot src="/packages-and-modules/securing-your-code/trusted-publisher-github-actions.png" alt="Screenshot of GitHub Actions trusted publisher configuration form" />
50
51 #### For GitLab CI/CD
52
53 Configure the following fields:
54
55 - **Namespace** (required): Your GitLab username or group name
56 - **Project name** (required): Your project name
57 - **Top-level CI file path** (required): The path to your CI file (e.g., `.gitlab-ci.yml`)
58 - Must include the `.yml` extension
59 - **Environment name** (optional): If using [GitLab environments](https://docs.gitlab.com/ee/ci/environments/)
60
61 <Screenshot src="/packages-and-modules/securing-your-code/trusted-publisher-gitlab.png" alt="Screenshot of GitLab CI/CD trusted publisher configuration form" />
62
63 #### For CircleCI
64
65 Configure the following fields:
66
67 - **Organization ID** (required): Your CircleCI organization ID (UUID format). You may find it from your CircleCI Organization Settings Overview page.
68 - **Project ID** (required): Your CircleCI project ID (UUID format). You may find it from your CircleCI Project Settings Overview page.
69 - **Pipeline definition ID** (required): The pipeline definition ID (UUID format). You may find it from your CircleCI Project Settings under Project Setup page.
70 - **VCS origin** (required): The VCS origin URL for your project (e.g., `github.com/myorg/myrepo`)
71 - **Context IDs** (optional): Restrict publishing to jobs using specific CircleCI contexts. You may find them from your CircleCI Organization Settings Contexts.
72
73 <Screenshot src="/packages-and-modules/securing-your-code/trusted-publisher-circleci.png" alt="Screenshot of CircleCI trusted publisher configuration form" />
74
75 <Note>
76
77 **Note:** Each package can only have one trusted publisher configured at a time.
78
79 </Note>
80
81 ### Step 2: Configure your CI/CD workflow
82
83 #### GitHub Actions configuration
84
85 Add the required OIDC permissions to your workflow. Here's a complete example:
86
87 ```yaml
88 name: Publish Package
89
90 on:
91 push:
92 tags:
93 - 'v*'
94
95 permissions:
96 id-token: write # Required for OIDC
97 contents: read
98
99 jobs:
100 publish:
101 runs-on: ubuntu-latest
102 steps:
103 - uses: actions/checkout@v4
104
105 - uses: actions/setup-node@v4
106 with:
107 node-version: '24'
108 registry-url: 'https://registry.npmjs.org'
109 - run: npm ci
110 - run: npm run build --if-present
111 - run: npm test
112 - run: npm publish
113 ```
114
115 The critical requirement is the `id-token: write` permission, which allows GitHub Actions to generate OIDC tokens. Learn more in [GitHub's OIDC documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect).
116
117 #### GitLab CI/CD configuration
118
119 Configure the OIDC ID token in your pipeline:
120
121 ```yaml
122 stages:
123 - test
124 - build
125 - publish
126
127 variables:
128 NODE_VERSION: '24'
129
130 test:
131 stage: test
132 image: node:${NODE_VERSION}
133 script:
134 - npm ci
135 - npm test
136
137 publish:
138 stage: publish
139 image: node:${NODE_VERSION}
140 id_tokens:
141 NPM_ID_TOKEN:
142 aud: "npm:registry.npmjs.org"
143 SIGSTORE_ID_TOKEN:
144 aud: sigstore
145 script:
146 - npm ci
147 - npm run build --if-present
148 - npm publish
149 only:
150 - tags
151 ```
152
153 The `id_tokens` configuration tells GitLab to generate an OIDC token for npm. Learn more in [GitLab's OIDC documentation](https://docs.gitlab.com/ee/ci/cloud_services/).
154
155 <Note>
156
157 **Note:** Don't forget to configure id_tokens 'aud' to `"npm:registry.npmjs.org"` in your GitLab pipeline.
158
159 </Note>
160
161 #### CircleCI configuration
162
163 Set the `NPM_ID_TOKEN` environment variable with an OIDC token from CircleCI, and npm CLI handles the token exchange automatically. Here's a complete example:
164
165 ```yaml
166 version: 2.1
167
168 jobs:
169 publish:
170 docker:
171 - image: cimg/node:22.14
172 steps:
173 - checkout
174 - run:
175 name: Install dependencies
176 command: npm ci
177 - run:
178 name: Run tests
179 command: npm test
180 - run:
181 name: Build
182 command: npm run build --if-present
183 - run:
184 name: Publish to npm with OIDC
185 command: |
186 export NPM_ID_TOKEN=$(circleci run oidc get --claims '{"aud": "npm:registry.npmjs.org"}')
187 npm publish
188
189 workflows:
190 publish:
191 jobs:
192 - publish:
193 filters:
194 tags:
195 only: /^v.*/
196 branches:
197 ignore: /.*/
198 ```
199
200 The `circleci run oidc get` command retrieves an OIDC token from CircleCI. When `NPM_ID_TOKEN` is set, the npm CLI automatically exchanges it for a short-lived publish token. Learn more in [CircleCI's OIDC documentation](https://circleci.com/docs/openid-connect-tokens/).
201
202 ### Managing trusted publisher configurations
203
204 You can modify or remove your trusted publisher configuration at any time through your package settings on [npmjs.com](https://npmjs.com) → Packages → YOUR_PACKAGE → Settings → Trusted publishing. Each package can only have one trusted publisher connection at a time, but this connection can be edited or deleted as needed. To change providers (for example, switching from GitHub Actions to GitLab CI/CD), simply edit your existing configuration and select the new provider. The change takes effect immediately for future publishes. To remove trusted publishing entirely and return to token-based authentication, delete the trusted publisher configuration from your package settings.
205
206 ## Recommended: Restrict token access when using trusted publishers
207
208 Once you've configured trusted publishers for your package, we strongly recommend restricting traditional token-based publishing access for enhanced security.
209
210 ### How to configure maximum security
211
212 1. After enabling trusted publishers, navigate to your package's **Settings** → **Publishing access**
213 2. Select **"Require two-factor authentication and disallow tokens"**
214 3. Save your changes by clicking on **Update Package Settings**
215
216 ### Why this matters
217
218 Trusted publishers use short-lived, scoped credentials that are generated on-demand during your CI/CD workflow, eliminating the need for long-lived tokens. By restricting traditional token access while using trusted publishers, you reduce potential security risks associated with credential management.
219
220 **Note:** The "disallow tokens" setting only affects traditional token authentication. Your trusted publishers will continue to work normally, as they use OIDC tokens.
221
222 ### Migration tip
223
224 If you're transitioning from token-based publishing:
225
226 1. Set up trusted publishers first and verify they work
227 2. Then restrict token access as described above
228 3. [Revoke any existing automation tokens](https://docs.npmjs.com/revoking-access-tokens) that are no longer needed
229
230 This ensures a smooth transition without disrupting your release process.
231
232 ## Automatic provenance generation
233
234 When you publish using trusted publishing from GitHub Actions or GitLab CI/CD, npm automatically generates and publishes [provenance attestations](./generating-provenance-statements) for your package. This happens by default—you don't need to add the `--provenance` flag to your publish command.
235
236 <Note>
237
238 **Note:** Provenance generation is not currently supported for CircleCI. Packages published via CircleCI trusted publishing will not include provenance attestations.
239
240 </Note>
241
242 <Screenshot src="/packages-and-modules/securing-your-code/trusted-publisher-provenance.png" alt="Screenshot showing provenance badge/information on a package page" />
243
244 Provenance provides cryptographic proof of where and how your package was built, allowing users to verify its authenticity. This automatic generation only applies when all of these conditions are met:
245
246 - Publishing via trusted publishing (OIDC)
247 - Publishing from a public repository
248 - Publishing a public package
249
250 <Note>
251
252 **Note:** Provenance generation is [not supported for private repositories](https://github.blog/changelog/2023-07-25-publishing-with-npm-provenance-from-private-source-repositories-is-no-longer-supported/), even when publishing public packages.
253
254 </Note>
255
256 ### Disabling provenance generation
257
258 While we strongly recommend keeping provenance enabled, you can disable it if needed. Set the `provenance` option to `false` in any of these ways:
259
260 **Using environment variable:**
261
262 ```bash
263 NPM_CONFIG_PROVENANCE=false npm publish
264 ```
265
266 **In your `.npmrc` file:**
267
268 ```ini
269 provenance=false
270 ```
271
272 **In your `package.json`:**
273
274 ```json
275 {
276 "publishConfig": {
277 "provenance": false
278 }
279 }
280 ```
281
282 ## Security best practices
283
284 ### Prefer trusted publishing over tokens
285
286 When trusted publishing is available for your workflow, always prefer it over long-lived tokens. Traditional npm tokens pose several security risks:
287
288 - They can be accidentally exposed in CI logs or configuration files
289 - They require manual rotation and management
290 - If compromised, they provide persistent access until revoked
291 - They often have broader permissions than necessary
292
293 Trusted publishing eliminates these risks by using short-lived, workflow-specific credentials that are automatically managed and cannot be extracted.
294
295 ### Handling private dependencies
296
297 While trusted publishing handles the publish operation, you may still need authentication for installing private npm dependencies. For this scenario, we recommend:
298
299 ```yaml
300 # GitHub Actions example
301 - uses: actions/setup-node@v4
302 with:
303 node-version: '24'
304 registry-url: 'https://registry.npmjs.org'
305 # Use a read-only token for installing dependencies
306 - run: npm ci
307 env:
308 NODE_AUTH_TOKEN: ${{ secrets.NPM_READ_TOKEN }}
309
310 # Publish uses OIDC - no token needed
311 - run: npm publish
312 ```
313
314 Always use [read-only granular access tokens](/creating-and-viewing-access-tokens#creating-granular-access-tokens-on-the-website) for installing dependencies. This limits potential damage if the token is ever compromised.
315
316 ### Additional security measures
317
318 Consider implementing these additional security practices:
319
320 - Use [deployment environments](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment) to add approval requirements
321 - Enable [tag protection rules](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules) to control who can create release tags
322 - Regularly audit your trusted publisher configurations
323 - Remove any unused publish tokens from your npm account
324
325 ## Troubleshooting
326
327 If you encounter an "Unable to authenticate" error when publishing, first verify that the workflow filename matches exactly what you configured on [npmjs.com](https://npmjs.com), including the `.yml` extension. All fields are case-sensitive and must be exact. Also ensure you're using GitHub-hosted runners, GitLab.com shared runners, or CircleCI cloud, as self-hosted runners are not currently supported. For GitHub Actions specifically, check that the `id-token: write` permission is set in your workflow. For CircleCI, verify that your Organization ID, Project ID, and Pipeline definition ID match your CircleCI configuration.
328
329 <Note>
330
331 **Note:** npm does not verify your trusted publisher configuration when you save it. Double-check that your repository, workflow filename, and other details are correct, as errors will only appear when you attempt to publish.
332
333 </Note>
334
335 If your package has private dependencies and `npm install` or `npm ci` is failing with authentication errors, remember that trusted publishing only applies to the `npm publish` command. You'll still need to provide a read-only token for installing private packages as shown in the examples above.
336
337 For packages in private repositories, provenance will not be generated even though you're using trusted publishing. This is a [known limitation](https://github.blog/changelog/2023-07-25-publishing-with-npm-provenance-from-private-source-repositories-is-no-longer-supported/) that applies regardless of whether your package itself is public or private.
338
339 Some GitHub Actions workflows use `workflow_call` to invoke other workflows that run `npm publish`, or use `workflow_dispatch` for manual publishing. When this happens, validation checks the calling workflow's name instead of the workflow that actually contains the publish command, which can cause configuration mismatches.
340
341 ## Limitations and future improvements
342
343 Trusted publishing currently supports only cloud-hosted runners. Support for self-hosted runners is intended for a future release. Each package can only have one trusted publisher configured at a time, though you can update this configuration as needed.
344
345 OIDC authentication is currently limited to the publish operation. Other npm commands such as `install`, `view`, or `access` still require traditional authentication methods. The `npm whoami` command will not reflect OIDC authentication status since the authentication occurs only during the publish operation.
346
347 We intend to expand trusted publishing support to additional CI/CD providers and enhance the feature based on community feedback.
348
349 ## Learn more
350
351 - [About npm provenance](./generating-provenance-statements)
352 - [OpenSSF Trusted Publishers specification](https://repos.openssf.org/trusted-publishers-for-all-package-repositories)
353 - [GitHub Actions OIDC documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
354 - [GitLab CI/CD OIDC documentation](https://docs.gitlab.com/ee/ci/cloud_services/)
355 - [CircleCI OIDC documentation](https://circleci.com/docs/openid-connect-tokens/)
356 - [API documentation for exchanging OIDC ID token for npm registry token](https://api-docs.npmjs.com/#tag/registry.npmjs.org/operation/exchangeOidcToken)