com.lacunasoftware.restpki

Class SignatureStarter2

java.lang.Object

com.lacunasoftware.restpki.SignatureStarter2

Direct Known Subclasses:

CadesSignatureStarter2, PadesSignatureStarter2

public abstract class SignatureStarter2
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	callbackArgument
protected java.lang.String	certificateBase64
protected RestPkiClient	client
protected boolean	ignoreRevocationStatusUnknown
protected java.lang.String	securityContextId
protected java.lang.String	signaturePolicyId

Constructor Summary

Constructors

Constructor and Description
SignatureStarter2(RestPkiClient client) Create a new instance using the given RestPkiClient.

Method Summary

Modifier and Type	Method and Description
void	setCallbackArgument(java.lang.String argument) Optional, sets a callback argument that will be returned on the second step.
void	setIgnoreRevocationStatusUnknown(boolean ignoreRevocationStatusUnknown) Sets the option of "IgnoreRevocationStatusUnknown".
void	setSecurityContext(SecurityContext securityContext) Sets the security context to be used to validate the signature.
void	setSignaturePolicy(SignaturePolicy signaturePolicy) Sets the signature policy to be used for the signature.
void	setSignerCertificate(java.lang.String certificateBase64) Deprecated. Alias for the setSignerCertificateBase64 method.
void	setSignerCertificateBase64(java.lang.String certificateBase64) Sets the signer's certificate, encoded in Base64.
void	setSignerCertificateRaw(byte[] certificateRaw) Sets the signer's certificate.
abstract SignatureStartResult	start() Performs the first step, should be called after setting the necessary parameters.
abstract SignatureStartWithWebPkiResult	startWithWebPki() Performs the first step, should be called after setting the necessary parameters.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected RestPkiClient client

certificateBase64

protected java.lang.String certificateBase64

signaturePolicyId

protected java.lang.String signaturePolicyId

securityContextId

protected java.lang.String securityContextId

callbackArgument

protected java.lang.String callbackArgument

ignoreRevocationStatusUnknown

protected boolean ignoreRevocationStatusUnknown

Constructor Detail

SignatureStarter2

public SignatureStarter2(RestPkiClient client)

Create a new instance using the given RestPkiClient.

Parameters:

client - the RestPkiClient which shall be used.

Method Detail

setSignerCertificateRaw

public void setSignerCertificateRaw(byte[] certificateRaw)

Sets the signer's certificate. This is optional if the start() method will be used instead of the startWithWebPki() method.

Parameters:

certificateRaw - The signer's certificate. If you're using the Web PKI component on the client-side, this is the format given by the component.

setSignerCertificateBase64

public void setSignerCertificateBase64(java.lang.String certificateBase64)

Sets the signer's certificate, encoded in Base64. This is optional if the start() method will be used instead of the startWithWebPki() method.

Parameters:

certificateBase64 - The signer's certificate, encoded in Base64. If you're using the Web PKI component on the client-side, this is the format given by the component.

setSignerCertificate

@Deprecated
public void setSignerCertificate(java.lang.String certificateBase64)

Deprecated. Alias for the setSignerCertificateBase64 method.

Parameters:

certificateBase64 - The signer's certificate, encoded in Base64. If you're using the Web PKI component on the client-side, this is the format given by the component.

setSignaturePolicy

public void setSignaturePolicy(SignaturePolicy signaturePolicy)

Sets the signature policy to be used for the signature.

Parameters:

signaturePolicy - The signature policy. Depending on the policy, it might also be necessary to set a security context.

setSecurityContext

public void setSecurityContext(SecurityContext securityContext)

Sets the security context to be used to validate the signature. Depending on the signature policy selected, this may be mandatory. If the signature policy does not require a security context to be set but one is nevertheless passed, the given security context overrides the one that would otherwise be inferred from the policy.

Parameters:

securityContext - The security context to be used to validate the signature.

setCallbackArgument

public void setCallbackArgument(java.lang.String argument)

Optional, sets a callback argument that will be returned on the second step.

The callback argument can be used to simplify the code of the client application. For instance, it might be the ID of the document being signed.

As the PDf content, the callback argument is also stored in the server with AES-128 encryption using a key which is never stored by the server, therefore it cannot read the value on its own, protecting it against compromise even in the event of a complete data leakage.

Parameters:

argument - The callback argument, a string whose UTF-8 encoding must not exceed 200 bytes.

setIgnoreRevocationStatusUnknown

public void setIgnoreRevocationStatusUnknown(boolean ignoreRevocationStatusUnknown)

Sets the option of "IgnoreRevocationStatusUnknown".

Parameters:

ignoreRevocationStatusUnknown - The option of "IgnoreRevocationStatusUnknown".

start

public abstract SignatureStartResult start()
                                    throws RestException,
                                           java.io.IOException

Performs the first step, should be called after setting the necessary parameters. If you intend to use the Web PKI component on the client-side, use the startWithWebPki() method instead.

Returns:

An instance of SignatureStartResult with the information necessary to perform the client-side signature and later call the server back with the results.

Throws:

RestException - if an error occurs when calling REST PKI.

java.io.IOException - if an error occurs when trying to obtain the file to be signed or be cosign or when trying to compute all hashes from this file, both files had to be provided before this method is called.

startWithWebPki

public abstract SignatureStartWithWebPkiResult startWithWebPki()
                                                        throws RestException,
                                                               java.io.IOException

Performs the first step, should be called after setting the necessary parameters. This method should be used if the Web PKI component is being used on the client-side.

Returns:

An instance of SignatureStartWithWebPkiResult containing the token that should be passed on the signWithRestPki() method of the Web PKI component (on the client-side logic) and the signer's certificate.

Throws:

RestException - if an error occurs when calling REST PKI.

java.io.IOException - if an error occurs when trying to obtain the file to be signed or be cosign or when trying to compute all hashes from this file, both files had to be provided before this method is called.