README
¶
Rekor
Rekór - Greek for “Record”
Rekor's goals are to provide an immutable tamper resistant ledger of metadata generated within a software projects supply chain. Rekor will enable software maintainers and build systems to record signed metadata to an immutable record. Other parties can then query said metadata to enable them to make informed decisions on trust and non-repudiation of an object's lifecycle. For more details visit the sigstore website.
The Rekor project provides a restful API based server for validation and a transparency log for storage. A CLI application is available to make and verify entries, query the transparency log for inclusion proof, integrity verification of the transparency log or retrieval of entries by either public key or artifact.
Rekor fulfils the signature transparency role of sigstore's software signing infrastructure. However, Rekor can be run on its own and is designed to be extensible to working with different manifest schemas and PKI tooling.
Current State of Rekor v1
Rekor v1 is in maintenance mode.
We are actively developing a new version of Rekor designed to be easy to maintain and cheaper to operate. Building on the active development in the Certificate Transparency ecosystem, Rekor v2 will be backed by a tile-based log and will use a modernized version of Trillian, Trillian-Tessera.
Follow its progress on the rekor-tiles repo, and learn more about Rekor v2 on the proposal and design doc. As we near a V2 release, we plan to merge the rekor-tiles codebase into this repository.
Public Instance
Rekor is officially Generally Available with a 1.0.0 release, and follows semver rules for API stability. This means production workloads can rely on the Rekor public instance, which has a 24/7 oncall rotation supporting it and offers a 99.5% availability SLO for the following API endpoints:
/api/v1/log/api/v1/log/publicKey/api/v1/log/proof/api/v1/log/entries/api/v1/log/entries/retrieve
For uptime data on the Rekor public instance, see https://status.sigstore.dev.
More details on the public instance can be found at docs.sigstore.dev.
The attestation size limit for uploads to the public instance is 100KB. If you need to upload larger files, please run your own instance of Rekor. You can find instructions for doing so in the installation documentation.
Installation
Please see the installation page for details on how to install the rekor CLI and set up / run the rekor server
Usage
For examples of uploading signatures for all the supported types to rekor, see the types documentation.
Extensibility
Custom schemas / manifests (rekor type)
Rekor allows customized manifests (which term them as types), type customization is outlined here.
API
If you're interested in integration with Rekor, we have an OpenAPI swagger editor
Security
Should you discover any security issues, please refer to sigstore's security process
Contributions
We welcome contributions from anyone and are especially interested to hear from users of Rekor.
Additional Documentation
In addition to this README file, this folder contains the additional documentation:
- oid-info.md. Rekor OID values.
- types.md. Information about how to sign and upload data in different pluggable types.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
backfill-index
command
|
|
|
cleanup-index
command
|
|
|
copy-index
command
|
|
|
rekor-cli
command
|
|
|
rekor-server
command
|
|
|
internal
|
|
|
config
Package config holds process-wide limits that rekor-server populates from viper at startup.
|
Package config holds process-wide limits that rekor-server populates from viper at startup. |
|
pgpv3
Package pgpv3 provides Rekor's integration with legacy v3 signatures.
|
Package pgpv3 provides Rekor's integration with legacy v3 signatures. |
|
pgpv3/adapted
Package adapted contains the v3 parser and verifier adapted from pgpkeys-eu.
|
Package adapted contains the v3 parser and verifier adapted from pgpkeys-eu. |
|
tlspolicy
Package tlspolicy holds the TLS policy for the Rekor API listener and applies it to the server's TLS config.
|
Package tlspolicy holds the TLS policy for the Rekor API listener and applies it to the server's TLS config. |
|
pkg
|
|
|
events
Package events provides methods for working with CloudEvents.
|
Package events provides methods for working with CloudEvents. |
|
generated/restapi
Package restapi Rekor
|
Package restapi Rekor |
|
pubsub
Package pubsub provides an interface and implementations for publishing notifications for Rekor updates to a Pub/Sub system.
|
Package pubsub provides an interface and implementations for publishing notifications for Rekor updates to a Pub/Sub system. |
|
pubsub/gcp
Package gcp implements the pubsub.Publisher with Google Cloud Pub/Sub.
|
Package gcp implements the pubsub.Publisher with Google Cloud Pub/Sub. |
|
util/jcs
Package jcs implements the JSON Canonicalization Scheme (RFC 8785) on top of the standard library's encoding/json/jsontext package.
|
Package jcs implements the JSON Canonicalization Scheme (RFC 8785) on top of the standard library's encoding/json/jsontext package. |