transparency-exchange-api

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

transparency-exchange-api

(★ 111)

A standard API specification for exchanging supply chain artifacts and intelligence

transparency-exchange-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](https://raw.githubusercontent.com/CycloneDX/transparency-exchange-api/main/LICENSE)
[![Website](https://img.shields.io/badge/https://-cyclonedx.org-blue.svg)](https://cyclonedx.org/)
[![Slack Invite](https://img.shields.io/badge/Slack-Join-blue?logo=slack&labelColor=393939)](https://cyclonedx.org/slack/invite)
[![Group Discussion](https://img.shields.io/badge/discussion-groups.io-blue.svg)](https://groups.io/g/CycloneDX)
[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Follow)](https://twitter.com/CycloneDX_Spec)
[![ECMA TC54](https://img.shields.io/badge/ECMA-TC54-FC7C00?labelColor=404040)](https://tc54.org)
[![ECMA TC54](https://img.shields.io/badge/ECMA-TC54--TG1-FC7C00?labelColor=404040)](https://ecma-international.org/task-groups/tc54-tg1/)

# OWASP Transparency Exchange API Standard

The Transparency Exchange API (TEA) is being worked on within the ECMA TC54 tg 1
with the goal to standardise the API in ECMA. 
The working group has a slack channel in the CycloneDX slack space.

![](https://raw.githubusercontent.com/CycloneDX/transparency-exchange-api/main/images/tealogo.png)

## Status of the standard: Beta 2

TEA is now in beta 2. This beta focuses on ready-to-implement consumer side of the API. Work on the
publisher API will start after the 1.0 release.

We encourage developers to start with both client and server implementations of TEA and
participate in interoperability tests. These will be organised both as hackathons and
informally using the Slack channel.

Priority issues for v1.0:

- E2e poc of authn/z workflow with TEA consumer spec, including consumer spec adjustment to better support authn/z
- Compliance document workflow, see https://github.com/CycloneDX/transparency-exchange-api/issues/205

Check the list of [implementations](doc/tea-implementations.md) that are available.

## Introduction

The TEA API is created to support automation of the software supply chain. Upstream
vendors and open source projects can use this standard to keep downstream consumers
up to date with transparency artefacts such as, but not limited to, bill of materials,
VEX files, attestations and much more.

This specification defines a standard, format agnostic, API for the exchange of
product related artefacts, like BOMs, between systems. The work includes:

- [Discovery of servers](/discovery/readme.md): Describes discovery using the Transparency Exchange Identifier (TEI)
- Retrieval of artefacts
- Publication of artefacts
- [Authentication and authorization](/auth/readme.md)
- Querying

System and tooling implementors are encouraged to adopt this API standard for
sending/receiving transparency artefacts between systems. 
This will enable more widespread
"out of the box" integration support in the BOM ecosystem.

## Use cases and requirements

The working group has produced a list of use cases and requirements for the protocol.

- [TEA requirements](doc/tea-requirements.md)
- [TEA use cases](doc/tea-usecases.md)

## Data model
- [TEA Product Release](tea-product/tea-product-release.md): The primary entry point. The [Transparency Exchange Identifier, TEI](/discovery/readme.md) resolves to a specific Product Release. A Product Release may optionally belong to a [TEA Product](tea-product/tea-product.md).
- [TEA Product](tea-product/tea-product.md): An optional higher-level object that groups a set of Product Releases for a product line or family. Products can be discovered and browsed; releases are accessed via `/product/{uuid}/releases`.
- [TEA Component](tea-component/tea-component.md): Represents a component lineage. A Component is a collection of Component Releases (accessible via `/component/{uuid}/releases`).
- [TEA Release](/tea-component/tea-release.md): A Component Release object. Each Component Release may have its own TEA Collection.
- [TEA Collection](tea-collection/tea-collection.md): A versioned list of artefacts for a specific Release (Component Release) or Product Release. Collections are versioned to indicate changes, e.g., an updated VEX or corrected SBOM.
- [TEA Artifacts](tea-artifact/tea-artifact.md): Files associated with a Collection. A single TEA Artifact can appear in multiple Collections. Note that a TEA Artifact is a named term introduced by the TEA standard.

See [TEA UUID Scope and Stability](doc/tea-uuid-scope.md) for uniqueness and stability rules that apply to all UUIDs in the data model above.

## Artefacts available of the API

The Transparency Exchange API (TEA) supports publication and retrieval of a set of transparency exchange artefacts. The API itself is not restricting the types of the artefacts published. A few examples:

### *xBOM

Bill of materials for any type of component and service are supported. This includes, but is not limited to, SBOM, HBOM, AI/ML-BOM, SaaSBOM, and CBOM. The API provides a BOM format agnostic way of publishing, searching, and retrieval of xBOM artefacts.

### CDXA

Standards and requirements along with attestations to those standards and requirements are captured and supported by CycloneDX Attestations (CDXA). Much like xBOM, these are supply chain artefacts that are captured allowing for consistent publishing, searching, and retrieval.

### VDR/VEX

Vulnerability Disclosure Reports (VDR) and Vulnerability Exploitability eXchange (VEX) are supported artefact types. Like the xBOM element, the VDR/VEX support is format agnostic. However, CSAF has its own distribution requirements that may not be compatible with APIs. Therefore, the initial focus will be on CycloneDX (VDR and VEX) and OpenVEX.

### CLE

Product lifecycle events are communicated through the
[ECMA-428 Common Lifecycle Enumeration standard](https://ecma-international.org/publications-and-standards/standards/ecma-428/).
This includes product rebranding, repackaging, mergers and acquisitions, and product milestone events such as end-of-life and end-of-support.

Inclusion of CLE is optional and it may be introduced on the following levels:

- TEA Product
- TEA Component
- TEA Product Release
- TEA Component Release

If CLE is included, it is the responsibility of the TEA implementation to ensure consistency of
CLE events across the TEA Product and its releases and similarly across the TEA Component and its releases.

## Insights

Much of the focus on Software Transparency from the U.S. Government and others center around the
concept of “full transparency”. Consumers often need to ingest, process, and analyze SBOMs or
VEXs just to be able to answer simple questions such as:

- Do any of my licensed products from Vendor A use Apache Struts?
- Are any of my licensed products from Vendor A vulnerable to log4shell and is there any action I need to take?

Insights allows for “limited transparency” that can be asked and answered using an expression language
that can be tightly scoped or outcome-driven. Insights also removes the complexities of BOM format 
onversion away from the consumers. An object model derived from CycloneDX will be an integral part of
this API, since the objects within CycloneDX are self-contained (thus API friendly) and the specification
supports all the necessary xBOM types along with CDXA.

Insights will be integrated into the API after the 1.0 release.

## Presentations and videos

- You can find presentations in the repository in the [Presentations](/presentations) directory
- Our biweekly meetings are available on [YouTube playlist: Project Koala](https://www.youtube.com/playlist?list=PLqjEqUxHjy1XtSzGYL7Dj_WJbiLu_ty58)
- KoalaCon 2024 - an introduction to the project - can be [viewed on YouTube](https://youtu.be/NStzYW4WnEE?si=ihLirpGVjHc7K4bL)

## Contributors

Contributors are listed in the [Contributors](contributors.md) file.

## Terminology

- API: Application programming interface
- Authorization (authz): Which products/components that a user has the right to access
- Authentication (authn): Credentials to get authorization
- Collection: A set of artefacts representing a version of a product
- Product: An item sold or delivered under one name
- Product variant: A variant of a product
- Version:

![](https://raw.githubusercontent.com/CycloneDX/transparency-exchange-api/main/images/Project-Koala.svg)

## Previous work

- [The CycloneDX BOM Exchange API](/api/bomexchangeapi.md)
   Implemented in the [CycloneDX BOM Repo Server](https://github.com/CycloneDX/cyclonedx-bom-repo-server)

transparency-exchange-api

transparency-exchange-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

transparency-exchange-api

transparency-exchange-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README