com.guardtime.ksi

Interface KSI

All Superinterfaces:

AutoCloseable, Closeable, Extender, PublicationsHandler, Reader, Signer, Verifier

public interface KSI
extends Signer, Extender, Reader, Verifier, PublicationsHandler, Closeable

Composite interface for signing, extending, verifying, and publications handling. An instance of this class can be obtained using KSIBuilder class.

Method Summary

Modifier and Type	Method and Description
VerificationResult	verify(KSISignature signature, Policy policy) Verifies the KSI signature.
VerificationResult	verify(KSISignature signature, Policy policy, DataHash documentHash) Verifies the KSI signature.
VerificationResult	verify(KSISignature signature, Policy policy, DataHash documentHash, PublicationData publicationData) Verifies the KSI signature.
VerificationResult	verify(KSISignature signature, Policy policy, PublicationData publicationData) Verifies the KSI signature.
VerificationResult	verify(VerificationContext context, Policy policy) Verifies the KSI signature.

Methods inherited from interface com.guardtime.ksi.Signer

asyncSign, asyncSign, asyncSign, asyncSign, getAggregatorConfiguration, getSigningService, sign, sign, sign, sign

Methods inherited from interface com.guardtime.ksi.Extender

asyncExtend, asyncExtend, extend, extend, getExtenderConfiguration, getExtendingService

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface com.guardtime.ksi.Reader

read, read, read

Methods inherited from interface com.guardtime.ksi.Verifier

verify, verify, verify

Methods inherited from interface com.guardtime.ksi.PublicationsHandler

getPublicationsFile

Method Detail

verify

VerificationResult verify(VerificationContext context,
                          Policy policy)
                   throws KSIException

Verifies the KSI signature.

Parameters:

context - instance of VerificationContext to be used to validate the KSI signature.

policy - policy to be used to verify the KSI signature.

Returns:

The verification result (VerificationResult).

Throws:

KSIException - when error occurs (e.g. when communication with KSI service fails).

verify

VerificationResult verify(KSISignature signature,
                          Policy policy)
                   throws KSIException

Verifies the KSI signature. Uses the KSIExtenderClient defined by KSIBuilder.setKsiProtocolExtenderClient(KSIExtenderClient) method. The publications file is downloaded using the client specified by method KSIBuilder.setKsiProtocolPublicationsFileClient(KSIPublicationsFileClient).

Parameters:

signature - KSI signature to verify.

policy - policy to be used to verify the signature.

Throws:

KSIException

See Also:

verify(KSISignature, Policy, DataHash, PublicationData)

verify

VerificationResult verify(KSISignature signature,
                          Policy policy,
                          PublicationData publicationData)
                   throws KSIException

Verifies the KSI signature. Uses the KSIExtenderClient defined by KSIBuilder.setKsiProtocolExtenderClient(KSIExtenderClient) method. The publications file is downloaded using the client specified by method KSIBuilder.setKsiProtocolPublicationsFileClient(KSIPublicationsFileClient).

Parameters:

signature - KSI signature to verify.

policy - policy to be used to verify the signature.

publicationData - publication data to be used to verify the signature, may be null.

Throws:

KSIException

See Also:

verify(KSISignature, Policy, DataHash, PublicationData)

verify

VerificationResult verify(KSISignature signature,
                          Policy policy,
                          DataHash documentHash)
                   throws KSIException

Verifies the KSI signature. Uses the KSIExtenderClient defined by KSIBuilder.setKsiProtocolExtenderClient(KSIExtenderClient) method. The publications file is downloaded using the client specified by method KSIBuilder.setKsiProtocolPublicationsFileClient(KSIPublicationsFileClient).

Parameters:

signature - KSI signature to verify.

policy - policy to be used to verify the signature.

documentHash - the original document hash, may be null.

Throws:

KSIException

See Also:

verify(KSISignature, Policy, DataHash, PublicationData)

verify

VerificationResult verify(KSISignature signature,
                          Policy policy,
                          DataHash documentHash,
                          PublicationData publicationData)
                   throws KSIException

Verifies the KSI signature. Uses the KSIExtenderClient defined by KSIBuilder.setKsiProtocolExtenderClient(KSIExtenderClient) method. The publications file is downloaded using the client specified by method KSIBuilder.setKsiProtocolPublicationsFileClient(KSIPublicationsFileClient).

Parameters:

signature - KSI signature to verify.

policy - policy to be used to verify the signature.

documentHash - the original document hash, may be null.

publicationData - publication data to be used to verify the signature, may be null.

Throws:

KSIException

See Also:

verify(VerificationContext, Policy)