Package dev.sigstore.rekor.client

Interface RekorClient

All Known Implementing Classes:

RekorClientHttp

public interface RekorClient

A client to communicate with a rekor service instance.

Field Summary

Fields

Modifier and Type	Field	Description
static java.net.URI	PUBLIC_GOOD_URI
static java.net.URI	STAGING_URI

Method Summary

Modifier and Type	Method	Description
java.util.Optional<RekorEntry>	getEntry(HashedRekordRequest hashedRekordRequest)	Get an entry from the log
java.util.Optional<RekorEntry>	getEntry(java.lang.String UUID)	Get an entry from the log
RekorResponse	putEntry(HashedRekordRequest hashedRekordRequest)	Put a new hashedrekord entry on the Rekor log.
java.util.List<java.lang.String>	searchEntry(java.lang.String email, java.lang.String hash, java.lang.String publicKeyFormat, java.lang.String publicKeyContent)	Returns a list of UUIDs for matching entries for the given search parameters.

Field Detail

PUBLIC_GOOD_URI

static final java.net.URI PUBLIC_GOOD_URI

STAGING_URI

static final java.net.URI STAGING_URI

Method Detail

putEntry

RekorResponse putEntry(HashedRekordRequest hashedRekordRequest)
                throws java.io.IOException,
                       RekorParseException

Put a new hashedrekord entry on the Rekor log.

Parameters:

hashedRekordRequest - the request to send to rekor

Returns:

a RekorResponse with information about the log entry

Throws:

java.io.IOException

RekorParseException

getEntry

java.util.Optional<RekorEntry> getEntry(HashedRekordRequest hashedRekordRequest)
                                 throws java.io.IOException,
                                        RekorParseException

Get an entry from the log

Parameters:

hashedRekordRequest - the entry to find

Returns:

the entry if found on the log, empty otherwise

Throws:

java.io.IOException

RekorParseException

getEntry

java.util.Optional<RekorEntry> getEntry(java.lang.String UUID)
                                 throws java.io.IOException,
                                        RekorParseException

Get an entry from the log

Parameters:

UUID - the uuid of the log entry

Returns:

the entry if found on the log, empty otherwise

Throws:

java.io.IOException

RekorParseException

searchEntry

java.util.List<java.lang.String> searchEntry(java.lang.String email,
                                             java.lang.String hash,
                                             java.lang.String publicKeyFormat,
                                             java.lang.String publicKeyContent)
                                      throws java.io.IOException

Returns a list of UUIDs for matching entries for the given search parameters.

Parameters:

email - the OIDC email subject

hash - sha256 hash of the artifact

publicKeyFormat - format of public key (one of 'pgp','x509','minisign', 'ssh', 'tuf')

publicKeyContent - public key base64 encoded content

Throws:

java.io.IOException