SBOM no Delphi com o TMS Smart Setup

SBOM (Software Bill of Materials) é a “lista de materiais” de um software: um arquivo que descreve um componente e tudo de que ele depende, com nome, fornecedor, licença e dependências. Com ele, quem usa a sua biblioteca responde rápido a perguntas como “qual é a licença disso?” e “isso traz outro componente junto?”, algo cada vez mais cobrado em auditorias e políticas de segurança. Na Europa, por exemplo, isso já é obrigatório por lei para quem vende software.

O TMS Smart Setup gera esse arquivo com um único comando, no formato CycloneDX. Neste artigo vamos ver isso na prática com duas bibliotecas nossas: a C4D-Exceptions, que depende da C4D-Msg.

Quer entender todo o processo de uso do TMS Smart Setup? Leia o nosso artigo e assista aos vídeos da playlist do canal.

1. A dependência no tmsbuild.yaml

No tmsbuild.yaml da C4D-Exceptions, a dependência aparece em dois lugares:

package definitions:
  C4DExceptions:
    framework type: VCL
    requires: rtl;vcl;C4DMsg

dependencies:
  - c4d.msg: C4D Msg
  • dependencies diz ao Smart Setup que o produto c4d.msg precisa ser baixado e compilado antes. É essa seção que alimenta o SBOM.
  • requires faz o package gerado referenciar o package C4DMsg.

2. Os metadados que vão para o SBOM

O SBOM é montado a partir da seção application. Quanto mais completa ela estiver, mais útil fica o arquivo:

application:
  id: c4d.exceptions
  name: C4D Exceptions
  description: Control exceptions in your systems quickly, easily, and centrally
  company name: Code4Delphi
  copyright: Code4Delphi
  license: MIT
  license url: https://github.com/Code4Delphi/C4D-Exceptions/blob/master/LICENSE
  url: https://github.com/Code4Delphi/C4D-Exceptions
  vcs protocol: git
  version file: version.txt

O version file aponta para um arquivo version.txt na raiz do repositório, com uma única linha:

c4d.exceptions: 1.6.0
Campo no tmsbuild.yamlCampo no SBOM
idname e purl
descriptiondescription
company namepublisher
copyrightcopyright
license e license urllicenses
urlexternalReferences (tipo website)
docsexternalReferences (tipo documentation)
version fileversion
dependenciescomponents e dependencies

Campos não preenchidos simplesmente não aparecem no SBOM.

3. Gerando o SBOM

Instale a biblioteca c4d.exceptions. O c4d.msg vem junto, por causa da dependência:

tms install c4d.exceptions

As bibliotecas estão no servidor Community, que vem desabilitado por padrão. Se ainda não habilitou, rode antes: tms server-enable community

Gere o SBOM dos dois produtos:

tms sbom-generate c4d.exceptions c4d.msg

O Smart Setup cria um arquivo <id>.cdx.json na pasta de cada produto:

Products\c4d.exceptions\src\c4d.exceptions.cdx.json
Products\c4d.msg\src\c4d.msg.cdx.json

Para gerar de tudo o que está instalado, use:

tms sbom-generate *

Se o arquivo já existir, ele é mantido, para sobrescrever, acrescente -force:

tms sbom-generate * -force

4. O resultado

Este é o c4d.exceptions.cdx.json gerado:

{
  "bomFormat": "CycloneDX",
  "specVersion": "1.5",
  "version": 1,
  "serialNumber": "urn:uuid:eb921709-2c2c-4344-b267-c434d9d8150c",
  "metadata": {
    "timestamp": "2026-11-14T21:19:45Z",
    "tools": [
      {
        "vendor": "TMS Software",
        "name": "TMS Smart Setup"
      }
    ],
    "component": {
      "type": "library",
      "name": "c4d.exceptions",
      "version": "1.6.0",
      "description": "Control exceptions in your systems quickly, easily, and centrally",
      "copyright": "Code4Delphi",
      "publisher": "Code4Delphi",
      "licenses": [
        {
          "license": {
            "name": "MIT",
            "url": "https://github.com/Code4Delphi/C4D-Exceptions/blob/master/LICENSE"
          }
        }
      ],
      "purl": "pkg:smartsetup/c4d.exceptions@1.6.0",
      "externalReferences": [
        {
          "type": "website",
          "url": "https://github.com/Code4Delphi/C4D-Exceptions"
        }
      ]
    }
  },
  "components": [
    {
      "type": "library",
      "name": "c4d.msg",
      "purl": "pkg:smartsetup/c4d.msg",
      "description": "C4D Msg"
    }
  ],
  "dependencies": [
    {
      "ref": "pkg:smartsetup/c4d.exceptions@1.6.0",
      "dependsOn": [
        "pkg:smartsetup/c4d.msg"
      ]
    }
  ]
}

São três blocos:

  • metadata.component: quem é a biblioteca, com versão, fornecedor, copyright e licença.
  • components: o que ela usa. Aqui aparece o c4d.msg
  • dependencies: o grafo, dizendo que c4d.exceptions depende de c4d.msg

5. Pontos de atenção

A dependência entra só com id e descrição. No SBOM da c4d.exceptions, o c4d.msg não traz versão, licença nem fornecedor. Esses dados estão no SBOM dele (c4d.msg.cdx.json), por isso geramos os dois.

A versão só aparece com version file. Sem o version.txt, o SBOM é gerado sem o campo version e o purl fica só pkg:smartsetup/c4d.exceptions, mesmo que a biblioteca tenha sido instalada a partir de uma tag. Lembre de atualizar o version.txt a cada nova versão.

Links úteis

Conclusão

Com a dependência declarada e os metadados preenchidos no tmsbuild.yaml, um único comando entrega o SBOM de cada biblioteca ou componente. Para quem publica bibliotecas e componentes, o trabalho está em preencher bem a seção application: licença, copyright e versão são justamente o que quem recebe o SBOM vai procurar primeiro.

📍 Em breve, publicaremos um vídeo com mais detalhes sobre o uso de SBOM com Delphi. Fique ligado em nosso canal para não perder essa novidade!