github.com/google/trillian-examples@v0.0.0-20240520080811-0d40d35cef0e/README.md (about)

     1  # Trillian examples
     2  
     3  [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/google/trillian-examples/badge)](https://securityscorecards.dev/viewer/?uri=github.com/google/trillian-examples)
     4  [![GoDoc](https://godoc.org/github.com/google/trillian?status.svg)](https://godoc.org/github.com/google/trillian-examples)
     5  [![Slack Status](https://img.shields.io/badge/Slack-Chat-blue.svg)](https://gtrillian.slack.com/)
     6  
     7  
     8  This repository contains example applications built on top of
     9  [Trillian][], showing that it's possible to apply
    10  transparency concepts to problems other than
    11  [certificates](https://github.com/google/certificate-transparency-go).  It also
    12  contains general-purpose components that can be used to strengthen the
    13  guarantees of a transparent ecosystem that already contains verifiable logs.
    14  
    15  Currently the examples here are:
    16  
    17  * [binary_transparency/firmware](binary_transparency/firmware): A demo
    18     showing how to apply transparency bring discoverability to device firmware
    19     updates, but the principles are also more generally applicable to all kinds
    20     of binaries/updates.
    21  * [helloworld](helloworld): A simple example demonstrating the correct
    22     configuration of a Trillian log, personality, and client.
    23  * [sumdbaudit](sumdbaudit): Demonstration of an auditor for the
    24     [GoLang SumDB](https://go.googlesource.com/proposal/+/master/design/25530-sumdb.md)
    25     module proxy, which clones a log and verifies the data in it.
    26  
    27  The general-purpose components are:
    28  
    29  * [serverless](serverless): A suite of command-line tools for managing
    30     transparency logs whose state is entirely composed of on-disk files, along
    31     with examples of how to use GitHub/GitHub Actions to host & publicly serve
    32     the log.
    33  
    34  Notable projects that have graduated from this repository to their own top-level repositories:
    35  
    36  * [witness](https://github.com/transparency-dev/witness)
    37  * [distributor](https://github.com/transparency-dev/distributor)
    38  
    39  There are two experimental deployments of the witness that have been deleted but
    40  are signposted here for archival reasons. Both of these tools can be retrieved
    41  by cloning this repository at git commit `793dcf1`:
    42  
    43  * [usbarmory witness](https://github.com/google/trillian-examples/tree/793dcf1a313b1478e30f7a7e65bdf344b10f1da4/witness/golang/omniwitness/usbarmory)
    44  * [ethereum witness](https://github.com/google/trillian-examples/tree/793dcf1a313b1478e30f7a7e65bdf344b10f1da4/witness/ethereum)
    45  
    46  These examples and components are not supported per-se, but the Trillian team 
    47  will likely try to help where possible.  You can contact them via the channels 
    48  listed under *Support* on the [Trillian][] repo.
    49  
    50  [Trillian]: https://github.com/google/trillian