Package dev.sigstore.rekor.client

Class RekorClientHttp

java.lang.Object

dev.sigstore.rekor.client.RekorClientHttp

All Implemented Interfaces:

RekorClient

public class RekorClientHttp
extends java.lang.Object
implements RekorClient

A client to communicate with a rekor service instance over http.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RekorClientHttp.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	REKOR_ENTRIES_PATH
static java.lang.String	REKOR_INDEX_SEARCH_PATH

Fields inherited from interface dev.sigstore.rekor.client.RekorClient

PUBLIC_GOOD_URI, STAGING_URI

Method Summary

Modifier and Type	Method	Description
static RekorClientHttp.Builder	builder()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REKOR_ENTRIES_PATH

public static final java.lang.String REKOR_ENTRIES_PATH

See Also:

Constant Field Values

REKOR_INDEX_SEARCH_PATH

public static final java.lang.String REKOR_INDEX_SEARCH_PATH

See Also:

Constant Field Values

Method Detail

builder

public static RekorClientHttp.Builder builder()

putEntry

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

Description copied from interface: RekorClient

Put a new hashedrekord entry on the Rekor log.

Specified by:

putEntry in interface RekorClient

Parameters:

hashedRekordRequest - the request to send to rekor

Returns:

a RekorResponse with information about the log entry

Throws:

java.io.IOException

RekorParseException

getEntry

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

Description copied from interface: RekorClient

Get an entry from the log

Specified by:

getEntry in interface RekorClient

Parameters:

hashedRekordRequest - the entry to find

Returns:

the entry if found on the log, empty otherwise

Throws:

java.io.IOException

RekorParseException

getEntry

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

Description copied from interface: RekorClient

Get an entry from the log

Specified by:

getEntry in interface RekorClient

Parameters:

UUID - the uuid of the log entry

Returns:

the entry if found on the log, empty otherwise

Throws:

java.io.IOException

RekorParseException

searchEntry

public 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

Description copied from interface: RekorClient

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

Specified by:

searchEntry in interface RekorClient

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