Skip to content

Add COSE paths to SbomConfig #1152

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

Merged
JoseRenan merged 4 commits into from
Aug 21, 2025
Merged

Add COSE paths to SbomConfig #1152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
86465fa
Add COSE file paths on sbom config
JoseRenan Jul 29, 2025
1e05b28
Merge branch 'main' of https://github.com/microsoft/sbom-tool into re…
JoseRenan Jul 29, 2025
77809bb
Fix tests
JoseRenan Aug 5, 2025
a60a5de
Merge branch 'main' into renan/add-cose-paths
JoseRenan Aug 20, 2025
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
6 changes: 6 additions & 0 deletions src/Microsoft.Sbom.Api/Manifest/BaseManifestConfigHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ protected BaseManifestConfigHandler(

protected string BsiFilePath => fileSystemUtils.JoinPaths(SbomDirPath, Constants.BsiFileName);

protected string BsiCoseFilePath => fileSystemUtils.JoinPaths(SbomDirPath, Constants.BsiCoseFileName);

protected string ManifestCoseFilePath => fileSystemUtils.JoinPaths(SbomDirPath, Constants.ManifestCoseFileName);

protected IMetadataBuilder MetadataBuilder => metadataBuilderFactory.Get(ManifestInfo);

protected ISbomConfig CreateSbomConfig()
Expand All @@ -57,6 +61,8 @@ protected ISbomConfig CreateSbomConfig()
ManifestJsonFilePath = SbomFilePath,
CatalogFilePath = CatalogFilePath,
BsiFilePath = BsiFilePath,
BsiCoseFilePath = BsiCoseFilePath,
ManifestCoseFilePath = ManifestCoseFilePath,
ManifestJsonFileSha256FilePath = ManifestJsonSha256FilePath,
MetadataBuilder = MetadataBuilder,
Recorder = new SbomPackageDetailsRecorder()
Expand Down
10 changes: 10 additions & 0 deletions src/Microsoft.Sbom.Api/Manifest/Configuration/SbomConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ public SbomConfig(IFileSystemUtils fileSystemUtils)
/// </summary>
public string BsiFilePath { get; set; }

/// <summary>
/// Gets or sets the absolute path of the build session information COSE file.
/// </summary>
public string BsiCoseFilePath { get; set; }

/// <summary>
/// Gets or sets the absolute path of the manifest COSE file.
/// </summary>
public string ManifestCoseFilePath { get; set; }

/// <summary>
/// Gets or sets derived manifestInfo or from configurations.
/// </summary>
Expand Down
8 changes: 8 additions & 0 deletions src/Microsoft.Sbom.Api/Manifest/Configuration/SbomConfigFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ public ISbomConfig Get(
string manifestFileSha256HashPath,
string catalogFilePath,
string bsiFilePath,
string bsiCoseFilePath,
string manifestCoseFilePath,
ISbomPackageDetailsRecorder recorder,
IMetadataBuilder metadataBuilder)
{
Expand All @@ -35,6 +37,8 @@ public ISbomConfig Get(
ManifestJsonDirPath = manifestDirPath,
ManifestJsonFilePath = manifestFilePath,
BsiFilePath = bsiFilePath,
BsiCoseFilePath = bsiCoseFilePath,
ManifestCoseFilePath = manifestCoseFilePath,
CatalogFilePath = catalogFilePath,
ManifestJsonFileSha256FilePath = manifestFileSha256HashPath,
MetadataBuilder = metadataBuilder,
Expand All @@ -52,6 +56,8 @@ public ISbomConfig Get(
var shaFilePath = $"{sbomFilePath}.sha256";
var catFilePath = fileSystemUtils.JoinPaths(sbomDirPath, Constants.CatalogFileName);
var bsiFilePath = fileSystemUtils.JoinPaths(sbomDirPath, Constants.BsiFileName);
var bsiCoseFilePath = fileSystemUtils.JoinPaths(sbomDirPath, Constants.BsiCoseFileName);
var manifestCoseFilePath = fileSystemUtils.JoinPaths(sbomDirPath, Constants.ManifestCoseFileName);
if (!fileSystemUtils.FileExists(shaFilePath) && !fileSystemUtils.FileExists(catFilePath) && !fileSystemUtils.FileExists(bsiFilePath))
{
// This is likely a CloudBuild SBOM, adjust paths accordingly
Expand All @@ -66,6 +72,8 @@ public ISbomConfig Get(
shaFilePath,
catFilePath,
bsiFilePath,
bsiCoseFilePath,
manifestCoseFilePath,
new SbomPackageDetailsRecorder(),
metadataBuilderFactory.Get(manifestInfo));
}
Expand Down
2 changes: 2 additions & 0 deletions src/Microsoft.Sbom.Api/Utils/Constants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ public static class Constants
public const string DefaultRootElement = "SPDXRef-Document";
public const string CatalogFileName = "manifest.cat";
public const string BsiFileName = "bsi.json";
public const string BsiCoseFileName = "bsi.cose";
public const string ManifestCoseFileName = "manifest.spdx.cose";
public const string DeleteManifestDirBoolVariableName = "DeleteManifestDirIfPresent";
public const string RootPackageIdValue = "SPDXRef-RootPackage";

Expand Down
2 changes: 2 additions & 0 deletions src/Microsoft.Sbom.Common/ISbomConfigFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ public ISbomConfig Get(
string manifestFileSha256HashPath,
string catalogFilePath,
string bsiFilePath,
string bsiCoseFilePath,
string manifestCoseFilePath,
ISbomPackageDetailsRecorder recorder,
IMetadataBuilder metadataBuilder);

Expand Down
10 changes: 10 additions & 0 deletions src/Microsoft.Sbom.Extensions/ISbomConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@ public interface ISbomConfig : IDisposable, IAsyncDisposable
/// </summary>
public string BsiFilePath { get; set; }

/// <summary>
/// Gets or sets the absolute path of the build session information COSE file.
/// </summary>
public string BsiCoseFilePath { get; set; }

/// <summary>
/// Gets or sets the absolute path of the manifest COSE file.
/// </summary>
public string ManifestCoseFilePath { get; set; }

/// <summary>
/// Gets or sets derived manifestInfo or from configurations.
/// </summary>
Expand Down
14 changes: 14 additions & 0 deletions test/Microsoft.Sbom.Api.Tests/Manifest/Configuration/SbomConfigFactoryTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ public class SbomConfigFactoryTests
private string cbCatFilePathStub = "cloud-build-cat-file-path";
private string bsiFilePathStub = "bsi-file-path";
private string cbBsiFilePathStub = "cloud-build-bsi-file-path";
private string bsiCoseFilePathStub = "bsi-cose-file-path";
private string manifestCoseFilePathStub = "manifest-cose-file-path";
private ManifestInfo manifestInfoStub = Api.Utils.Constants.SPDX30ManifestInfo;
private string manifestInfoStringStub = "spdx_3.0";
private string manifestFileNameStub = "manifest.spdx.json";
Expand Down Expand Up @@ -85,6 +87,12 @@ public void Get_ReturnsCorrectConfig_AdoStyleSbom()
fileSystemUtilsMock
.Setup(m => m.JoinPaths(spdxDirPathStub, Api.Utils.Constants.BsiFileName))
.Returns(bsiFilePathStub);
fileSystemUtilsMock
.Setup(m => m.JoinPaths(spdxDirPathStub, Api.Utils.Constants.BsiCoseFileName))
.Returns(bsiCoseFilePathStub);
fileSystemUtilsMock
.Setup(m => m.JoinPaths(spdxDirPathStub, Api.Utils.Constants.ManifestCoseFileName))
.Returns(manifestCoseFilePathStub);
fileSystemUtilsMock
.Setup(m => m.FileExists($"{sbomFilePathStub}.sha256"))
.Returns(true);
Expand Down Expand Up @@ -114,6 +122,12 @@ public void Get_ReturnsCorrectConfig_CloudBuildStyleSbom()
fileSystemUtilsMock
.Setup(m => m.JoinPaths(spdxDirPathStub, Api.Utils.Constants.BsiFileName))
.Returns(bsiFilePathStub);
fileSystemUtilsMock
.Setup(m => m.JoinPaths(spdxDirPathStub, Api.Utils.Constants.BsiCoseFileName))
.Returns(bsiCoseFilePathStub);
fileSystemUtilsMock
.Setup(m => m.JoinPaths(spdxDirPathStub, Api.Utils.Constants.ManifestCoseFileName))
.Returns(manifestCoseFilePathStub);
fileSystemUtilsMock
.Setup(m => m.FileExists($"{sbomFilePathStub}.sha256"))
.Returns(false);
Expand Down
2 changes: 2 additions & 0 deletions test/Microsoft.Sbom.Api.Tests/VersionSpecificPins/Version_4_0/InterfaceConcretionTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,8 @@ private class PinnedISbomConfig : ISbomConfig
public string ManifestJsonFileSha256FilePath { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
public string CatalogFilePath { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
public string BsiFilePath { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
public string BsiCoseFilePath { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
public string ManifestCoseFilePath { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
public ManifestInfo ManifestInfo { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
public IMetadataBuilder MetadataBuilder { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }

Expand Down