com.guardtime.ksi.blocksigner

Class KsiBlockSigner

java.lang.Object

com.guardtime.ksi.blocksigner.KsiBlockSigner

All Implemented Interfaces:

BlockSigner<List<KSISignature>>

public class KsiBlockSigner
extends Object
implements BlockSigner<List<KSISignature>>

Creates multiple signatures with one request.

Methods add(DataHash, long, IdentityMetadata), add(DataHash) and/or add(DataHash, long, IdentityMetadata) can be used to add new input hash to the block signer.

Method sign() must be called to get the final group of signatures. The signatures are returned in the same order as the data hashes were added to block signer.

Current implementation returns one signature per input hash.

Note that this class can not be used multiple times.

The following sample shows how to use KsiBlockSigner class:

 

 // initialize ksi block signer
 KSISigningClient signingClient = getSigningClient();
 TreeBuilder treeBuilder = new HashTreeBuilder();
 KsiBlockSigner signer = new KsiBlockSignerBuilder()
                 .setKsiSigningClient(signingClient)
                 .setTreeBuilder(treeBuilder)
                 .build();

 // add data hashes
 signer.add(new DataHash(HashAlgorithm.SHA2_256, new byte[32]));
 signer.add(dataHash2);
 signer.add(dataHash3);
 signer.add(dataHash4, new IdentityMetadata("my_client_id", "my_machine_id", SEQUENCE_NUMBER, REQUEST_TIME));

 // call sign methods to get final signatures
 List<KSISignature> signatures = signer.sign();
 
 

This class isn't thread safe.

See Also:

HashTreeBuilder, BlindingMaskLinkingHashTreeBuilder

Constructor Summary

Constructors

Constructor and Description
KsiBlockSigner(KSISigningClient signingClient) Deprecated. Use KsiBlockSignerBuilder instead.
KsiBlockSigner(KSISigningClient signingClient, HashAlgorithm algorithm) Deprecated. Use KsiBlockSignerBuilder instead.
KsiBlockSigner(KSISigningClient signingClient, KSISignatureFactory signatureFactory, HashAlgorithm algorithm) Deprecated. Use KsiBlockSignerBuilder instead.
KsiBlockSigner(KSISigningService signingService) Deprecated. Use KsiBlockSignerBuilder instead.
KsiBlockSigner(KSISigningService signingService, HashAlgorithm algorithm) Deprecated. Use KsiBlockSignerBuilder instead.
KsiBlockSigner(KSISigningService signingService, KSISignatureFactory signatureFactory, HashAlgorithm algorithm) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	add(DataHash dataHash) Adds a hash to the KsiBlockSigner.
boolean	add(DataHash dataHash, IdentityMetadata metadata) Adds a hash and a signature metadata to the KsiBlockSigner.
boolean	add(DataHash dataHash, long level, IdentityMetadata metadata) Adds a hash (with specific level) and a signature metadata to the KsiBlockSigner.
List<KSISignature>	sign() Creates a block of multiple signatures.

Methods inherited from class java.lang.Object

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

Constructor Detail

KsiBlockSigner

@Deprecated
public KsiBlockSigner(KSISigningService signingService)

Deprecated. Use KsiBlockSignerBuilder instead.

Creates a new instance of KsiBlockSigner with given KSISigningService and default hash algorithm Util.DEFAULT_AGGREGATION_ALGORITHM. HashTreeBuilder is always used for aggregation.

Parameters:

signingService - an instance of KSISigningService.

KsiBlockSigner

@Deprecated
public KsiBlockSigner(KSISigningService signingService,
                                  HashAlgorithm algorithm)

Deprecated. Use KsiBlockSignerBuilder instead.

Creates a new instance of KsiBlockSigner with given KSISigningService and HashAlgorithm. HashTreeBuilder is always used for aggregation.

Parameters:

signingService - an instance of KSISigningService.

algorithm - hash algorithm to be used.

KsiBlockSigner

@Deprecated
public KsiBlockSigner(KSISigningClient signingClient)

Deprecated. Use KsiBlockSignerBuilder instead.

Creates a new instance of KsiBlockSigner with given KSISigningClient and default hash algorithm Util.DEFAULT_AGGREGATION_ALGORITHM. HashTreeBuilder is always used for aggregation.

Parameters:

signingClient - an instance of KSISigningClient.

KsiBlockSigner

@Deprecated
public KsiBlockSigner(KSISigningClient signingClient,
                                  HashAlgorithm algorithm)

Deprecated. Use KsiBlockSignerBuilder instead.

Creates a new instance of KsiBlockSigner with given KSISigningClient and HashAlgorithm. HashTreeBuilder is always used for aggregation.

Parameters:

signingClient - an instance of KSISigningClient.

algorithm - hash algorithm to be used.

KsiBlockSigner

@Deprecated
public KsiBlockSigner(KSISigningClient signingClient,
                                  KSISignatureFactory signatureFactory,
                                  HashAlgorithm algorithm)

Deprecated. Use KsiBlockSignerBuilder instead.

Creates a new instance of KsiBlockSigner with given KSISigningClient, KSISignatureFactory and HashAlgorithm. HashTreeBuilder is always used for aggregation.

Parameters:

signingClient - an instance of KSISigningClient.

signatureFactory - an instance of KSISignatureFactory.

algorithm - hash algorithm to be used.

KsiBlockSigner

@Deprecated
public KsiBlockSigner(KSISigningService signingService,
                                  KSISignatureFactory signatureFactory,
                                  HashAlgorithm algorithm)

Deprecated.

Creates a new instance of KsiBlockSigner with given KSISigningService, KSISignatureFactory and HashAlgorithm. HashTreeBuilder is always used for aggregation.

Parameters:

signingService - an instance of KSISigningService.

signatureFactory - an instance of KSISignatureFactory.

algorithm - hash algorithm to be used.

Method Detail

add

public boolean add(DataHash dataHash,
                   IdentityMetadata metadata)
            throws KSIException

Adds a hash and a signature metadata to the KsiBlockSigner.

Specified by:

add in interface BlockSigner<List<KSISignature>>

Parameters:

dataHash - data hash.

metadata - metadata to be added.

Returns:

True, if data hash and metadata were added.

Throws:

KSIException

add

public boolean add(DataHash dataHash)
            throws KSIException

Adds a hash to the KsiBlockSigner.

Specified by:

add in interface BlockSigner<List<KSISignature>>

Parameters:

dataHash - data hash.

Returns:

True, if data hash was added.

Throws:

KSIException

add

public boolean add(DataHash dataHash,
                   long level,
                   IdentityMetadata metadata)
            throws KSIException

Adds a hash (with specific level) and a signature metadata to the KsiBlockSigner.

Specified by:

add in interface BlockSigner<List<KSISignature>>

Parameters:

dataHash - data hash.

level - hash level.

metadata - metadata to be added.

Returns:

True, if data hash and metadata were added.

Throws:

KSIException

sign

public List<KSISignature> sign()
                        throws KSIException

Creates a block of multiple signatures.

Specified by:

sign in interface BlockSigner<List<KSISignature>>

Returns:

Multiple signatures, according to number of input hashes.

Throws:

KSIException