Skip to main content

Azure Pipelines - Generate your software bill of materials (SBOM)

If you have never heard about the software bill of materials(SBOM), have a look at my previous post here. In short, an SBOM lists all the components that make up your software , or were used to build it.

Last month Microsoft open sourced their own software bill of materials generation tool. You can find the source code and corresponding releases in Github: https://github.com/microsoft/sbom-tool.

Integrate the SBOM tool in Azure Pipelines

As generating an SBOM is typically not something that you do manually, here is how I integrated this in my Azure Pipelines.

Remark: I’ll first show you how to do this on Windows as my current build server is still Windows based. If you want to know how to do this on Linux, scroll further down to the end of this post.

  • Go to Azure Pipelines and open the pipeline that you want to edit.
  • Add a new Powershell Task after the build activity and change the Type to Inline.

  • Paste the following script:
    • This will download the the sbom tool and executes it. The resulting sbom files will be written to the Artifact Staging directory.

# Write your PowerShell commands here.
Invoke-WebRequest -Uri "https://github.com/microsoft/sbom-tool/releases/latest/download/sbom-tool-win-x64.exe" -OutFile "$(Agent.TempDirectory)/sbom-tool.exe"
$(Agent.TempDirectory)/sbom-tool generate -b $(Build.ArtifactStagingDirectory) -bc $(Build.SourcesDirectory) -pn Example -pv 1.0.0 -nsb https://sbom.mycompany.com -V Verbose

  • The sbom-tool uses the following signature:
generate -b <drop path> -bc <build components path> -pn <package name> -pv <package version> -nsb <namespace uri base>
  • Update the package name and package version. Also set the namespace to something unique for your company.(The tool will add a unique identifier for you) .
    • E.g. https://companyName.com/teamName/<packageName>/<packageVersion>/<new-guid>
  • If you know execute the pipeline, the output should look like this:

  • In your pipeline artifacts you should find a generated SBOM file and hash:

Here is the yaml variant:

And if you are using a Linux based build agent:

Labels:

Popular posts from this blog

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...
Read more

Cleaner switch expressions with pattern matching in C#

Ever find yourself mapping multiple string values to the same result? Being a C# developer for a long time, I sometimes forget that the C# has evolved so I still dare to chain case labels or reach for a dictionary. Of course with pattern matching this is no longer necessary. With pattern matching, you can express things inline, declaratively, and with zero repetition. A small example I was working on a small script that should invoke different actions depending on the environment. As our developers were using different variations for the same environment e.g.  "tst" alongside "test" , "prd" alongside "prod" .  We asked to streamline this a long time ago, but as these things happen, we still see variations in the wild. This brought me to the following code that is a perfect example for pattern matching: The or keyword here is a logical pattern combinator , not a boolean operator. It matches if either of the specified pattern...
Read more