Interface RemoteSignatureTokenConnection

All Known Implementing Classes:
RemoteSignatureTokenConnectionImpl

public interface RemoteSignatureTokenConnection
The interface used for a remote signing
  • Method Summary

    Modifier and Type
    Method
    Description
    eu.europa.esig.dss.ws.server.signing.dto.RemoteKeyEntry
    getKey(String alias)
    Retrieves a key by its alias
    List<eu.europa.esig.dss.ws.server.signing.dto.RemoteKeyEntry>
    Retrieves all the available keys (private keys entries) from the token.
    eu.europa.esig.dss.ws.dto.SignatureValueDTO
    sign(eu.europa.esig.dss.ws.dto.ToBeSignedDTO toBeSigned, eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm, String alias)
    This method signs the toBeSigned data with the digest digestAlgorithm and the given alias.
    eu.europa.esig.dss.ws.dto.SignatureValueDTO
    sign(eu.europa.esig.dss.ws.dto.ToBeSignedDTO toBeSigned, eu.europa.esig.dss.enumerations.SignatureAlgorithm signatureAlgorithm, String alias)
    This method signs the toBeSigned data with the digest signatureAlgorithm and the given alias.
    eu.europa.esig.dss.ws.dto.SignatureValueDTO
    signDigest(eu.europa.esig.dss.ws.dto.DigestDTO digest, eu.europa.esig.dss.enumerations.SignatureAlgorithm signatureAlgorithm, String alias)
    This method signs the digest data with a signatureAlgorithm and the given alias.
    eu.europa.esig.dss.ws.dto.SignatureValueDTO
    signDigest(eu.europa.esig.dss.ws.dto.DigestDTO digest, String alias)
    This method signs the digest data with the given alias.
  • Method Details

    • getKeys

      List<eu.europa.esig.dss.ws.server.signing.dto.RemoteKeyEntry> getKeys() throws eu.europa.esig.dss.model.DSSException
      Retrieves all the available keys (private keys entries) from the token.
      Returns:
      List of encapsulated private keys
      Throws:
      eu.europa.esig.dss.model.DSSException - If there is any problem during the retrieval process
    • getKey

      eu.europa.esig.dss.ws.server.signing.dto.RemoteKeyEntry getKey(String alias) throws eu.europa.esig.dss.model.DSSException
      Retrieves a key by its alias
      Parameters:
      alias - the key alias to retrieve
      Returns:
      the RemoteKeyEntry with the given alias
      Throws:
      eu.europa.esig.dss.model.DSSException
    • sign

      eu.europa.esig.dss.ws.dto.SignatureValueDTO sign(eu.europa.esig.dss.ws.dto.ToBeSignedDTO toBeSigned, eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm, String alias) throws eu.europa.esig.dss.model.DSSException
      This method signs the toBeSigned data with the digest digestAlgorithm and the given alias.
      Parameters:
      toBeSigned - The data that need to be signed
      digestAlgorithm - The digest algorithm to be used before signing
      alias - The key alias to be used
      Returns:
      The array of bytes representing the signature value
      Throws:
      eu.europa.esig.dss.model.DSSException - If there is any problem during the signature process
    • sign

      eu.europa.esig.dss.ws.dto.SignatureValueDTO sign(eu.europa.esig.dss.ws.dto.ToBeSignedDTO toBeSigned, eu.europa.esig.dss.enumerations.SignatureAlgorithm signatureAlgorithm, String alias) throws eu.europa.esig.dss.model.DSSException
      This method signs the toBeSigned data with the digest signatureAlgorithm and the given alias.
      Parameters:
      toBeSigned - The data that need to be signed
      signatureAlgorithm - The signature algorithm to be used for signing
      alias - The key alias to be used
      Returns:
      The array of bytes representing the signature value
      Throws:
      eu.europa.esig.dss.model.DSSException - If there is any problem during the signature process
    • signDigest

      eu.europa.esig.dss.ws.dto.SignatureValueDTO signDigest(eu.europa.esig.dss.ws.dto.DigestDTO digest, String alias) throws eu.europa.esig.dss.model.DSSException
      This method signs the digest data with the given alias.
      Parameters:
      digest - The digested data that need to be signed
      alias - The key alias to be used
      Returns:
      the signature value representation with the used algorithm and the binary value
      Throws:
      eu.europa.esig.dss.model.DSSException - If there is any problem during the signature process
    • signDigest

      eu.europa.esig.dss.ws.dto.SignatureValueDTO signDigest(eu.europa.esig.dss.ws.dto.DigestDTO digest, eu.europa.esig.dss.enumerations.SignatureAlgorithm signatureAlgorithm, String alias) throws eu.europa.esig.dss.model.DSSException
      This method signs the digest data with a signatureAlgorithm and the given alias.
      Parameters:
      digest - The digested data that need to be signed
      signatureAlgorithm - The signature algorithm to be used for signing
      alias - The key alias to be used
      Returns:
      the signature value representation with the used algorithm and the binary value
      Throws:
      eu.europa.esig.dss.model.DSSException - If there is any problem during the signature process