Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: expose provenance transparency url #6428

Merged
merged 3 commits into from
May 5, 2023
Merged

feat: expose provenance transparency url #6428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76dc9c3
feat(libnpmpublish): expose provenance transparency url
JamesHenry May 5, 2023
1c2c058
chore: apply transparency url in 409 retry case
JamesHenry May 5, 2023
638ecac
chore: update workspaces/libnpmpublish/lib/publish.js
JamesHenry May 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 28 additions & 6 deletions workspaces/libnpmpublish/lib/publish.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,25 @@ Remove the 'private' field from the package.json to publish it.`),
)
}

const metadata = await buildMetadata(reg, pubManifest, tarballData, spec, opts)
const { metadata, transparencyLogUrl } = await buildMetadata(
reg,
pubManifest,
tarballData,
spec,
opts
)

try {
return await npmFetch(spec.escapedName, {
const res = await npmFetch(spec.escapedName, {
...opts,
method: 'PUT',
body: metadata,
ignoreBody: true,
})
if (transparencyLogUrl) {
res.transparencyLogUrl = transparencyLogUrl
}
return res
} catch (err) {
if (err.code !== 'E409') {
throw err
Expand All @@ -64,12 +74,17 @@ Remove the 'private' field from the package.json to publish it.`),
query: { write: true },
})
const newMetadata = patchMetadata(current, metadata)
return npmFetch(spec.escapedName, {
const res = await npmFetch(spec.escapedName, {
...opts,
method: 'PUT',
body: newMetadata,
ignoreBody: true,
})
/* istanbul ignore next */
if (transparencyLogUrl) {
wraithgar marked this conversation as resolved.
Show resolved Hide resolved
JamesHenry marked this conversation as resolved.
Show resolved Hide resolved
res.transparencyLogUrl = transparencyLogUrl
}
return res
}
}

Expand Down Expand Up @@ -138,6 +153,7 @@ const buildMetadata = async (registry, manifest, tarballData, spec, opts) => {
}

// Handle case where --provenance flag was set to true
let transparencyLogUrl
if (provenance === true) {
const subject = {
name: npa.toPurl(spec),
Expand Down Expand Up @@ -178,8 +194,11 @@ const buildMetadata = async (registry, manifest, tarballData, spec, opts) => {
const tlogEntry = provenanceBundle?.verificationMaterial?.tlogEntries[0]
/* istanbul ignore else */
if (tlogEntry) {
const logUrl = `${TLOG_BASE_URL}?logIndex=${tlogEntry.logIndex}`
log.notice('publish', `Provenance statement published to transparency log: ${logUrl}`)
transparencyLogUrl = `${TLOG_BASE_URL}?logIndex=${tlogEntry.logIndex}`
log.notice(
'publish',
`Provenance statement published to transparency log: ${transparencyLogUrl}`
)
}

const serializedBundle = JSON.stringify(provenanceBundle)
Expand All @@ -190,7 +209,10 @@ const buildMetadata = async (registry, manifest, tarballData, spec, opts) => {
}
}

return root
return {
metadata: root,
transparencyLogUrl,
}
}

const patchMetadata = (current, newData) => {
Expand Down
6 changes: 6 additions & 0 deletions workspaces/libnpmpublish/test/publish.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,6 +511,7 @@ t.test('publish includes access', async t => {
})

t.ok(ret, 'publish succeeded')
t.notOk(ret.transparencyLogUrl, 'no transparencyLogUrl for non-provenance publish')
})

t.test('refuse if package is unscoped plus `restricted` access', async t => {
Expand Down Expand Up @@ -804,6 +805,11 @@ t.test('publish existing package with provenance in gha', async t => {
rekorURL: rekorURL,
})
t.ok(ret, 'publish succeeded')
t.equal(
ret.transparencyLogUrl,
'https://search.sigstore.dev/?logIndex=2513258',
'has appropriate transparencyLogUrl property'
)
t.match(log, [
['notice', 'publish',
'Signed provenance statement with source and build information from GitHub Actions'],
Expand Down