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

.NET 8–Keyed/Named Services

A feature that a lot of IoC container libraries support but that was missing in the default DI container provided by Microsoft is the support for Keyed or Named Services. This feature allows you to register the same type multiple times using different names, allowing you to resolve a specific instance based on the circumstances. Although there is some controversy if supporting this feature is a good idea or not, it certainly can be handy. To support this feature a new interface IKeyedServiceProvider got introduced in .NET 8 providing 2 new methods on our ServiceProvider instance: object? GetKeyedService(Type serviceType, object? serviceKey); object GetRequiredKeyedService(Type serviceType, object? serviceKey); To use it, we need to register our service using one of the new extension methods: Resolving the service can be done either through the FromKeyedServices attribute: or by injecting the IKeyedServiceProvider interface and calling the GetRequiredKeyedServic...
Read more

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

Kubernetes–Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...
Read more