| Package | Description | 
|---|---|
| com.guardtime.ksi | 
 KSI API interface 
 | 
| com.guardtime.ksi.blocksigner | 
 Classes and interfaces to create multiple signatures with one signing request 
 | 
| com.guardtime.ksi.hashing | 
 Classes to create and represent data hashes 
 | 
| com.guardtime.ksi.pdu | 
 PDU (Protocol Data Unit) interfaces 
 | 
| com.guardtime.ksi.pdu.v2 | 
 PDU v2 implementation 
 | 
| com.guardtime.ksi.publication | 
 Interfaces to decode and encode publications files 
 | 
| com.guardtime.ksi.service | 
 Classes and interfaces to sign and extend, advanced version 
 | 
| com.guardtime.ksi.service.ha | 
 High Availability KSI service, combines other services to achieve redundancy 
 | 
| com.guardtime.ksi.tlv | 
 Classes and interfaces to decode and encode TLV elements 
 | 
| com.guardtime.ksi.tree | 
 Classes and interfaces to build a hash tree 
 | 
| com.guardtime.ksi.unisignature | 
 Interfaces to decode and encode KSI signatures 
 | 
| com.guardtime.ksi.unisignature.inmemory | 
 Classes to decode and encode in-memory KSI signatures 
 | 
| com.guardtime.ksi.unisignature.verifier | 
 Classes and interfaces to verify KSI signatures 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Future<KSISignature> | 
Signer.asyncSign(DataHash dataHash)
Signs the data hash asynchronously. 
 | 
Future<KSISignature> | 
Signer.asyncSign(DataHash dataHash,
         long level)
This method is used to sign data hash asynchronously with user provided aggregation tree height. 
 | 
KSISignature | 
Signer.sign(DataHash dataHash)
Signs the data hash. 
 | 
KSISignature | 
Signer.sign(DataHash dataHash,
    long level)
Signs the data hash with user provided aggregation tree height. 
 | 
VerificationResult | 
SignatureVerifier.verify(KSISignature signature,
      DataHash documentHash,
      ContextAwarePolicy policy)  | 
VerificationResult | 
Verifier.verify(KSISignature signature,
      DataHash documentHash,
      ContextAwarePolicy policy)
Verifies the KSI signature. 
 | 
VerificationResult | 
SignatureVerifier.verify(KSISignature signature,
      DataHash documentHash,
      Long level,
      ContextAwarePolicy policy)  | 
VerificationResult | 
Verifier.verify(KSISignature signature,
      DataHash documentHash,
      Long level,
      ContextAwarePolicy policy)
Verifies the KSI signature. 
 | 
VerificationResult | 
KSI.verify(KSISignature signature,
      Policy policy,
      DataHash documentHash)
Verifies the KSI signature. 
 | 
VerificationResult | 
KSI.verify(KSISignature signature,
      Policy policy,
      DataHash documentHash,
      PublicationData publicationData)
Verifies the KSI signature. 
 | 
| Constructor and Description | 
|---|
SigningFuture(Future<AggregationResponse> aggregationResponseFuture,
             KSISignatureFactory signatureFactory,
             DataHash inputHash)  | 
SigningFuture(Future<AggregationResponse> aggregationResponseFuture,
             KSISignatureFactory signatureFactory,
             DataHash inputHash,
             long level)  | 
| Modifier and Type | Method and Description | 
|---|---|
boolean | 
BlockSigner.add(DataHash dataHash)
Adds a new hash to the signer. 
 | 
boolean | 
KsiBlockSigner.add(DataHash dataHash)
Adds a hash to the  
KsiBlockSigner. | 
boolean | 
BlockSigner.add(DataHash dataHash,
   IdentityMetadata metadata)
Adds a new hash and metadata to the signer. 
 | 
boolean | 
KsiBlockSigner.add(DataHash dataHash,
   IdentityMetadata metadata)
Adds a hash and a signature metadata to the  
KsiBlockSigner. | 
boolean | 
BlockSigner.add(DataHash dataHash,
   long level,
   IdentityMetadata metadata)
Adds a new hash, level, and metadata to the signer. 
 | 
boolean | 
KsiBlockSigner.add(DataHash dataHash,
   long level,
   IdentityMetadata metadata)
Adds a hash (with specific level) and a signature metadata to the  
KsiBlockSigner. | 
| Modifier and Type | Method and Description | 
|---|---|
DataHash | 
DataHasher.getHash()
Gets the final hash value for the digest. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
DataHasher | 
DataHasher.addData(DataHash dataHash)
Adds  
getImprint() to the digest. | 
| Modifier and Type | Method and Description | 
|---|---|
AggregationRequest | 
AggregatorPduFactory.createAggregationRequest(KSIRequestContext context,
                        ServiceCredentials credentials,
                        DataHash imprint,
                        Long level)
Creates a new aggregation request. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
AggregationRequest | 
AggregatorPduV2Factory.createAggregationRequest(KSIRequestContext context,
                        ServiceCredentials credentials,
                        DataHash imprint,
                        Long level)  | 
AggregationRequest | 
PduV2Factory.createAggregationRequest(KSIRequestContext context,
                        ServiceCredentials credentials,
                        DataHash imprint,
                        Long level)  | 
| Modifier and Type | Method and Description | 
|---|---|
DataHash | 
PublicationData.getPublicationDataHash()  | 
| Constructor and Description | 
|---|
PublicationData(Date publicationTime,
               DataHash publicationHash)
Creates a new instance of publication data using publication time and publication hash. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Future<AggregationResponse> | 
KSISigningClientServiceAdapter.sign(DataHash dataHash,
    Long level)  | 
Future<AggregationResponse> | 
KSISigningService.sign(DataHash dataHash,
    Long level)
Creates a new KSI signature. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Future<AggregationResponse> | 
SigningHAService.sign(DataHash dataHash,
    Long level)
Creates a non-blocking signing request. 
 | 
Future<AggregationResponse> | 
HAService.sign(DataHash dataHash,
    Long level)  | 
| Modifier and Type | Method and Description | 
|---|---|
DataHash | 
TLVElement.getDecodedDataHash()
Converts TLV element content data to  
DataHash object. | 
| Modifier and Type | Method and Description | 
|---|---|
static TLVElement | 
TLVElement.create(int type,
      DataHash value)
Creates TLV element with  
DataHash content. | 
void | 
TLVElement.setDataHashContent(DataHash dataHash)  | 
| Modifier and Type | Method and Description | 
|---|---|
DataHash | 
BlindingMaskLinkingHashTreeBuilder.getLastNodeHash()
Returns the last leaf hash of this block/tree (for linking next block/tree). 
 | 
static DataHash | 
Util.hash(HashAlgorithm hashAlgorithm,
    byte[] left,
    byte[] right,
    long level)
Calculates a data hash using the following formula: H(left||right||Util.encodeUnsignedLong(level)) where
 H is a cryptographic hash function defined by  
hashAlgorithm. | 
| Constructor and Description | 
|---|
BlindingMaskLinkingHashTreeBuilder(byte[] initializationVector,
                                  DataHash previousBlockHash)
Creates an instance of  
BlindingMaskLinkingHashTreeBuilder using
 Util.DEFAULT_AGGREGATION_ALGORITHM hash algorithm and a DataHash from
 previous block. | 
BlindingMaskLinkingHashTreeBuilder(HashAlgorithm algorithm,
                                  byte[] initializationVector,
                                  DataHash previousBlockHash)
Creates an instance of  
BlindingMaskLinkingHashTreeBuilder. | 
BlindingMaskLinkingHashTreeBuilder(HashAlgorithm algorithm,
                                  byte[] initializationVector,
                                  DataHash previousBlockHash,
                                  TreeBuilder<ImprintNode> treeBuilder)
Creates an instance of  
BlindingMaskLinkingHashTreeBuilder. | 
ImprintNode(DataHash value)
Creates a new leaf node with given hash and level 0. 
 | 
ImprintNode(DataHash value,
           long level)
Creates a leaf node with given hash and level. 
 | 
ImprintNode(ImprintNode leftChild,
           ImprintNode rightChild,
           DataHash value,
           long level)
Creates a non-leaf node. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
DataHash | 
CalendarHashChainLink.calculateChainStep(DataHash previous)  | 
DataHash | 
CalendarHashChainLink.getDataHash()  | 
DataHash | 
CalendarHashChain.getInputHash()
Returns the input hash of the calendar hash chain 
 | 
DataHash | 
KSISignature.getInputHash()
If RFC3161 compatibility record is present then RFC3161 input hash will be returned. 
 | 
DataHash | 
RFC3161Record.getInputHash()
Returns the RFC3161 record input data hash 
 | 
DataHash | 
AggregationHashChain.getInputHash()
Returns the input hash for the computation specified by the aggregation hash chain 
 | 
DataHash | 
CalendarHashChain.getOutputHash()
Returns the output hash of the calendar hash chain 
 | 
DataHash | 
AggregationHashChain.getOutputHash()
Returns the output hash 
 | 
DataHash | 
ChainResult.getOutputHash()
Returns output hash 
 | 
DataHash | 
RFC3161Record.getOutputHash(HashAlgorithm hashAlgorithm)
Returns the RFC3161 record output data hash 
 | 
| Modifier and Type | Method and Description | 
|---|---|
DataHash | 
CalendarHashChainLink.calculateChainStep(DataHash previous)  | 
AggregationHashChain | 
KSISignatureComponentFactory.createAggregationHashChain(DataHash inputHash,
                          Date aggregationTime,
                          LinkedList<Long> indexes,
                          LinkedList<AggregationChainLink> links,
                          HashAlgorithm aggregationAlgorithm)
Creates a new aggregation hash chain 
 | 
AggregationChainLink | 
KSISignatureComponentFactory.createLeftAggregationChainLink(DataHash siblingHash,
                              long level)
Creates a new left aggregation hash chain link with given sibling hash and level. 
 | 
AggregationChainLink | 
KSISignatureComponentFactory.createRightAggregationChainLink(DataHash siblingHash,
                               long level)
Creates a new right aggregation hash chain link with given sibling hash and level. 
 | 
KSISignature | 
KSISignatureFactory.createSignature(KSISignature signature,
               AggregationHashChain aggregationHashChain,
               DataHash originalInputHash)
Creates a signature by prepending lower aggregation hash chain to a signature. 
 | 
KSISignature | 
KSISignatureFactory.createSignature(TLVElement element,
               DataHash originalInputHash)
Creates a signature from input TLV element. 
 | 
KSISignature | 
KSISignatureFactory.createSignature(TLVElement element,
               DataHash originalInputHash,
               long level)
Creates a signature from input TLV element. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
AggregationHashChain | 
InMemoryKsiSignatureComponentFactory.createAggregationHashChain(DataHash inputHash,
                          Date aggregationTime,
                          LinkedList<Long> indexes,
                          LinkedList<AggregationChainLink> links,
                          HashAlgorithm aggregationAlgorithm)  | 
AggregationChainLink | 
InMemoryKsiSignatureComponentFactory.createLeftAggregationChainLink(DataHash siblingHash,
                              long levelCorrection)  | 
AggregationChainLink | 
InMemoryKsiSignatureComponentFactory.createRightAggregationChainLink(DataHash siblingHash,
                               long levelCorrection)  | 
KSISignature | 
InMemoryKsiSignatureFactory.createSignature(KSISignature signature,
               AggregationHashChain aggregationHashChain,
               DataHash originalInputHash)  | 
KSISignature | 
InMemoryKsiSignatureFactory.createSignature(TLVElement element,
               DataHash inputHash)  | 
KSISignature | 
InMemoryKsiSignatureFactory.createSignature(TLVElement element,
               DataHash inputHash,
               long level)  | 
| Modifier and Type | Method and Description | 
|---|---|
DataHash | 
VerificationContext.getDocumentHash()
Returns the document hash provided by the user or calculated from the input data. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
VerificationContextBuilder | 
VerificationContextBuilder.setDocumentHash(DataHash documentHash)
Used to set the hash of the original document. 
 | 
VerificationContextBuilder | 
VerificationContextBuilder.setDocumentHash(DataHash documentHash,
               Long level)
Used to set the hash and local aggregation tree height. 
 | 
Copyright © 2024 Guardtime. All rights reserved.