Skip to content

Commit 5fc6473

Browse files
bdehamerwraithgar
authored andcommitted
feat: add provenance attestation
This adds a new `--provenance` flag to npm for provenance attestation during `npm publish` If set to `true`, npm will detect if it is running in GitHub actions and will generate an appropriate attestation bundle for that environment. The primary work in this PR was done by [@bdehamer](https://github.com/bdehamer), with some cleanup and edge-case handling added by the npm cli team.
1 parent c606653 commit 5fc6473

File tree

216 files changed

+13907
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

216 files changed

+13907
-4
lines changed

DEPENDENCIES.md

+6
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,7 @@ graph LR;
398398
libnpmpack-->pacote;
399399
libnpmpack-->spawk;
400400
libnpmpack-->tap;
401+
libnpmpublish-->ci-info;
401402
libnpmpublish-->lodash.clonedeep;
402403
libnpmpublish-->nock;
403404
libnpmpublish-->normalize-package-data;
@@ -407,6 +408,7 @@ graph LR;
407408
libnpmpublish-->npmcli-mock-registry["@npmcli/mock-registry"];
408409
libnpmpublish-->npmcli-template-oss["@npmcli/template-oss"];
409410
libnpmpublish-->semver;
411+
libnpmpublish-->sigstore;
410412
libnpmpublish-->ssri;
411413
libnpmpublish-->tap;
412414
libnpmsearch-->nock;
@@ -734,6 +736,8 @@ graph LR;
734736
readable-stream-->util-deprecate;
735737
rimraf-->glob;
736738
semver-->lru-cache;
739+
sigstore-->make-fetch-happen;
740+
sigstore-->tuf-js;
737741
socks-->ip;
738742
socks-->smart-buffer;
739743
socks-proxy-agent-->agent-base;
@@ -756,6 +760,8 @@ graph LR;
756760
tar-->minizlib;
757761
tar-->mkdirp;
758762
tar-->yallist;
763+
tuf-js-->make-fetch-happen;
764+
tuf-js-->minimatch;
759765
unique-filename-->unique-slug;
760766
unique-slug-->imurmurhash;
761767
validate-npm-package-license-->spdx-correct;

lib/commands/publish.js

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ class Publish extends BaseCommand {
3535
'workspace',
3636
'workspaces',
3737
'include-workspace-root',
38+
'provenance',
3839
]
3940

4041
static usage = ['<package-spec>']

lib/utils/config/definitions.js

+9
Original file line numberDiff line numberDiff line change
@@ -1620,6 +1620,15 @@ define('progress', {
16201620
},
16211621
})
16221622

1623+
define('provenance', {
1624+
default: false,
1625+
type: Boolean,
1626+
description: `
1627+
Indicates that a provenance statement should be generated.
1628+
`,
1629+
flatten,
1630+
})
1631+
16231632
define('proxy', {
16241633
default: null,
16251634
type: [null, false, url], // allow proxy to be disabled explicitly

node_modules/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,7 @@
241241
!/semver/node_modules/lru-cache
242242
!/set-blocking
243243
!/signal-exit
244+
!/sigstore
244245
!/smart-buffer
245246
!/socks-proxy-agent
246247
!/socks
@@ -263,6 +264,7 @@
263264
!/text-table
264265
!/tiny-relative-date
265266
!/treeverse
267+
!/tuf-js
266268
!/unique-filename
267269
!/unique-slug
268270
!/util-deprecate

node_modules/sigstore/LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

node_modules/sigstore/bin/sigstore.js

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#!/usr/bin/env node
2+
/*
3+
Copyright 2022 The Sigstore Authors.
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
*/
17+
require('../dist/cli').processArgv();
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/// <reference types="node" />
2+
/// <reference types="node" />
3+
import { KeyObject } from 'crypto';
4+
import { CertificateRequest } from '../client/fulcio';
5+
export declare function toCertificateRequest(publicKey: KeyObject, challenge: Buffer): CertificateRequest;
+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"use strict";
2+
Object.defineProperty(exports, "__esModule", { value: true });
3+
exports.toCertificateRequest = void 0;
4+
function toCertificateRequest(publicKey, challenge) {
5+
return {
6+
publicKey: {
7+
content: publicKey
8+
.export({ type: 'spki', format: 'der' })
9+
.toString('base64'),
10+
},
11+
signedEmailAddress: challenge.toString('base64'),
12+
};
13+
}
14+
exports.toCertificateRequest = toCertificateRequest;
+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/// <reference types="node" />
2+
/// <reference types="node" />
3+
import { KeyObject } from 'crypto';
4+
export interface CA {
5+
createSigningCertificate: (identityToken: string, publicKey: KeyObject, challenge: Buffer) => Promise<string[]>;
6+
}
7+
export interface CAClientOptions {
8+
fulcioBaseURL: string;
9+
}
10+
export declare class CAClient implements CA {
11+
private fulcio;
12+
constructor(options: CAClientOptions);
13+
createSigningCertificate(identityToken: string, publicKey: KeyObject, challenge: Buffer): Promise<string[]>;
14+
}
+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
"use strict";
2+
Object.defineProperty(exports, "__esModule", { value: true });
3+
exports.CAClient = void 0;
4+
const client_1 = require("../client");
5+
const error_1 = require("../error");
6+
const util_1 = require("../util");
7+
const format_1 = require("./format");
8+
class CAClient {
9+
constructor(options) {
10+
this.fulcio = new client_1.Fulcio({ baseURL: options.fulcioBaseURL });
11+
}
12+
async createSigningCertificate(identityToken, publicKey, challenge) {
13+
const request = (0, format_1.toCertificateRequest)(publicKey, challenge);
14+
try {
15+
const certificate = await this.fulcio.createSigningCertificate(identityToken, request);
16+
return util_1.pem.split(certificate);
17+
}
18+
catch (err) {
19+
throw new error_1.InternalError('error creating signing certificate', err);
20+
}
21+
}
22+
}
23+
exports.CAClient = CAClient;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import * as sigstore from '../../types/sigstore';
2+
import { x509Certificate } from '../../x509/cert';
3+
export declare function verifyChain(bundleCerts: sigstore.X509Certificate[], certificateAuthorities: sigstore.CertificateAuthority[]): x509Certificate[];

0 commit comments

Comments
 (0)