com.lacunasoftware.restpki

Class ClientSideSignatureInstructions

java.lang.Object

com.lacunasoftware.restpki.ClientSideSignatureInstructions

Direct Known Subclasses:

SignatureStartResult

public class ClientSideSignatureInstructions
extends java.lang.Object

Parameters to perform a client-side signature.

Constructor Summary

Constructors

Constructor and Description
ClientSideSignatureInstructions(java.lang.String token, java.lang.String toSignData, java.lang.String toSignHash, java.lang.String digestAlgorithmOid)

Method Summary

Modifier and Type	Method and Description
DigestAlgorithm	getDigestAlgorithm()
java.lang.String	getDigestAlgorithmOid() Returns the OID of the digest algorithm that must be used to sign the "to sign data" (see method getToSignData()), which is also the digest algorithm that was used to compute the "to sign hash".
byte[]	getEncodedDigestInfo() Returns DER-encoded DigestInfo identification.
java.lang.String	getSignatureAlgorithm() Returns the signature algorithm used by the Signature class to compute a signature.
java.lang.String	getToken() Returns the token, which must be passed when finishing the signature.
java.lang.String	getToSignData() Deprecated. Alias for the getToSignDataBase64 method.
java.lang.String	getToSignDataBase64() Returns the bytes to be signed using the signer certificate's private key, encoded in Base64.
byte[]	getToSignDataRaw() Return the bytes to be signed using the signer certificate's private key.
java.lang.String	getToSignHash() Deprecated. Alias for the getToSignHashBase64 method.
java.lang.String	getToSignHashBase64() Returns the precomputed digest of the bytes to be signed using the signer certificate's private key, encoded in Base64.
byte[]	getToSignHashRaw() Return the precomputed digest of the bytes to be signed using the signer certificate's private key.
void	setDigestAlgorithmOid(java.lang.String digestAlgorithmOid) Sets the OID of the digest algorithm that must be used to sign the "to sign data" (see method getToSignData()), which is also the digest algorithm that was used to compute the "to sign hash".
void	setToken(java.lang.String token) Sets the token, which must be passed when finishing the signature.
void	setToSignData(java.lang.String toSignData)
void	setToSignDataRaw(byte[] toSignData)
void	setToSignHash(byte[] toSignHash) Sets the precomputed digest of the bytes to be singed using the signer certificate's private key.
void	setToSignHash(java.lang.String toSignHash) Sets the precomputed digest of the bytes to be singed using the signer certificate's private key, encoded in Base64.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientSideSignatureInstructions

public ClientSideSignatureInstructions(java.lang.String token,
                                       java.lang.String toSignData,
                                       java.lang.String toSignHash,
                                       java.lang.String digestAlgorithmOid)

Method Detail

getToken

public java.lang.String getToken()

Returns the token, which must be passed when finishing the signature.

Returns:

The token, a 43-character case-sensitive string containing only letters, numbers and the characters "-" and "_" (therefore URL and HTML safe).

setToken

public void setToken(java.lang.String token)

Sets the token, which must be passed when finishing the signature.

Parameters:

token - The token, a 43-character case-sensitive string containing only letters, numbers and the characters "-" and "_" (therefore URL and HTML safe).

getToSignDataRaw

public byte[] getToSignDataRaw()

Return the bytes to be signed using the signer certificate's private key.

If you are using the Web PKI component to perform the client-side signature, this value must be passed to the component's method signData. You can alternatively call the component's method signHash, in which case you should use the method getToSignHash() instead.

Returns:

The "to sign bytes".

getToSignDataBase64

public java.lang.String getToSignDataBase64()

Returns the bytes to be signed using the signer certificate's private key, encoded in Base64.

If you are using the Web PKI component to perform the client-side signature, this value be passed to the component's method signData. You can alternatively call the component's method signHash, in which case you should use the method getToSignHash() instead.

Returns:

The "to sign bytes", encoded in Base64.

getToSignData

@Deprecated
public java.lang.String getToSignData()

Deprecated. Alias for the getToSignDataBase64 method.

Returns:

The "to sign bytes", encoded in Base64.

setToSignData

public void setToSignData(java.lang.String toSignData)

setToSignDataRaw

public void setToSignDataRaw(byte[] toSignData)

getToSignHashRaw

public byte[] getToSignHashRaw()

Return the precomputed digest of the bytes to be signed using the signer certificate's private key.

If you are using the Web PKI component to perform the client-side signature, this value must be passed to the component's method signHash. You can alternatively call the component's method signData, in which case you should use the method getToSignData() instead.

Returns:

The "to sign precomputed digest of the bytes".

getToSignHashBase64

public java.lang.String getToSignHashBase64()

Returns the precomputed digest of the bytes to be signed using the signer certificate's private key, encoded in Base64.

If you are using the Web PKI component to perform the client-side signature, this value must be passed to the component's method signHash. You can alternatively call the component's method signData, in which case you should use the method getToSignData() instead.

Returns:

The "to sign precomputed digest of the bytes", encoded in Base64.

getToSignHash

public java.lang.String getToSignHash()

Deprecated. Alias for the getToSignHashBase64 method.

Returns:

The "to sign precomputed digest of the bytes", encoded in Base64.

setToSignHash

public void setToSignHash(java.lang.String toSignHash)

Sets the precomputed digest of the bytes to be singed using the signer certificate's private key, encoded in Base64.

Parameters:

toSignHash - The "to sign precomputed digest of the bytes", encoded in Base64.

setToSignHash

public void setToSignHash(byte[] toSignHash)

Sets the precomputed digest of the bytes to be singed using the signer certificate's private key.

Parameters:

toSignHash - The "to sign precomputed digest of the bytes", encoded in Base64.

getDigestAlgorithmOid

public java.lang.String getDigestAlgorithmOid()

Returns the OID of the digest algorithm that must be used to sign the "to sign data" (see method getToSignData()), which is also the digest algorithm that was used to compute the "to sign hash".

If you are using the Web PKI component to perform the client-side signature, this value must be passed to the component's methods signData and signHash, depending on which you'll use.

Returns:

The OID of the digest algorithm (for instance, "2.16.840.1.101.3.4.2.1").

setDigestAlgorithmOid

public void setDigestAlgorithmOid(java.lang.String digestAlgorithmOid)

Sets the OID of the digest algorithm that must be used to sign the "to sign data" (see method getToSignData()), which is also the digest algorithm that was used to compute the "to sign hash".

Parameters:

digestAlgorithmOid - The OID of the digest algorithm (for instance "2.16.840.1.101.3.4.2.1").

getSignatureAlgorithm

public java.lang.String getSignatureAlgorithm()

Returns the signature algorithm used by the Signature class to compute a signature.

Returns:

the signature algorithm.

getDigestAlgorithm

public DigestAlgorithm getDigestAlgorithm()

getEncodedDigestInfo

public byte[] getEncodedDigestInfo()

Returns DER-encoded DigestInfo identification. Needed when signing hash. It was recovered from RFC 3447 specification, section 9.2 "EMSA-PKCS1-v1_5". This value should be used when performing a signature of a hash. Reference: https://tools.ietf.org/html/rfc3447#section-9.2