Skip to main content

A command-line tool for querying and verifying entries in a Rekor transparency log. This tool allows you to fetch log entries, verify inclusion proofs, and check the consistency of the log's Merkle tree.

Project description

Python Rekor Verifier

A command-line tool for querying and verifying entries in a Rekor transparency log. This tool allows you to fetch log entries, verify inclusion proofs, and check the consistency of the log's Merkle tree.

Description

This project provides a client to interact with a Rekor server (e.g., https://rekor.sigstore.dev).

Key features include:

  • Fetching log entries by index.
  • Verifying artifact signatures against public keys from log entries.
  • Performing inclusion proof verification to confirm an entry is in the log.
  • Verifying consistency between an old and new tree state.

Installation

  1. Clone the repository:

    git clone https://github.com/sdg8193/Software-Supply-Chain-HW-1.git
    cd python-rekor-monitor-template
    
  2. Install the required dependencies:

    pip install poetry
    poetry install
    

Usage

The tool is operated via the command line.

Get Latest Checkpoint

Fetch the latest signed tree head (checkpoint) from the Rekor server.

python main.py --checkpoint

Verify Inclusion

Verify that an artifact is included in the log at a specific index. You need the log index and the path to the original artifact.

python main.py --inclusion <LOG_INDEX> --artifact <PATH_TO_ARTIFACT>

Example:

python main.py --inclusion 12345 --artifact ./my-file.txt

Verify Consistency

Verify that a previously known checkpoint is consistent with the latest checkpoint. You need the treeID, treeSize, and rootHash from the old checkpoint.

python main.py --consistency --tree-id <TREE_ID> --tree-size <OLD_TREE_SIZE> --root-hash <OLD_ROOT_HASH>

Example:

python main.py --consistency --tree-id 238498... --tree-size 1000 --root-hash abcdef123...

Debug Mode

For more verbose output for any command, use the --debug or -d flag.

python main.py --checkpoint --debug

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sdg8193_rekor-0.1.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sdg8193_rekor-0.1.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file sdg8193_rekor-0.1.0.tar.gz.

File metadata

  • Download URL: sdg8193_rekor-0.1.0.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.8.10 Linux/5.10.102.1-microsoft-standard-WSL2

File hashes

Hashes for sdg8193_rekor-0.1.0.tar.gz
Algorithm Hash digest
SHA256 59a54f0bc2ffd6416a2b652e21ac479f973ed4eca5b45c59e25af5bb28c94ca0
MD5 6fab85a012427b5da0aa412084db96d3
BLAKE2b-256 2ccc9f13cd605d865c9c60845cd283a8ee7722b6ef09573d4d79cd6fc3f1a150

See more details on using hashes here.

File details

Details for the file sdg8193_rekor-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sdg8193_rekor-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.8.10 Linux/5.10.102.1-microsoft-standard-WSL2

File hashes

Hashes for sdg8193_rekor-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5da9279a13e5d26634acad72f98b2d1f4cf65ce54a72f1084dc61d3386199d24
MD5 ba259b46b141e5b2db050338c82e7157
BLAKE2b-256 3d58247a2c10859f05d2fdb820ef2321766ba2e1f17a2b4e05e431584b4626c1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page