Interface SoapSignatureTokenConnection

All Superinterfaces:
Serializable
All Known Implementing Classes:
SoapSignatureTokenConnectionImpl

public interface SoapSignatureTokenConnection extends Serializable
The server signing service for SOAP webService
  • Method Details

    • getKeys

      List<RemoteKeyEntry> getKeys()
      Retrieves all the available keys (private keys entries) from the token.
      Returns:
      List of encapsulated private keys
    • getKey

      RemoteKeyEntry getKey(String alias)
      Retrieves a key by its alias
      Parameters:
      alias - the key alias to retrieve
      Returns:
      the RemoteKeyEntry with the given alias
    • sign

      SignatureValueDTO sign(ToBeSignedDTO toBeSigned, DigestAlgorithm digestAlgorithm, String alias)
      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
    • sign

      SignatureValueDTO sign(ToBeSignedDTO toBeSigned, DigestAlgorithm digestAlgorithm, MaskGenerationFunction mgf, String alias)
      This method signs the toBeSigned data with the digest digestAlgorithm, the mask mgf and the given alias.
      Parameters:
      toBeSigned - The data that need to be signed
      digestAlgorithm - The digest algorithm to be used before signing
      mgf - the mask generation function
      alias - The key alias to be used
      Returns:
      The array of bytes representing the signature value
    • sign

      SignatureValueDTO sign(ToBeSignedDTO toBeSigned, SignatureAlgorithm signatureAlgorithm, String alias)
      This method signs the toBeSigned data with the signatureAlgorithm and the given alias.
      Parameters:
      toBeSigned - The data that need to be signed
      signatureAlgorithm - The digest algorithm to be used for signing
      alias - The key alias to be used
      Returns:
      The array of bytes representing the signature value
    • signDigest

      SignatureValueDTO signDigest(DigestDTO digest, String alias)
      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
    • signDigest

      SignatureValueDTO signDigest(DigestDTO digest, MaskGenerationFunction mgf, String alias)
      This method signs the digest data with a mask mgf and the given alias.
      Parameters:
      digest - The digested data that need to be signed
      mgf - the mask generation function
      alias - The key alias to be used
      Returns:
      the signature value representation with the used algorithm and the binary value
    • signDigest

      SignatureValueDTO signDigest(DigestDTO digest, SignatureAlgorithm signatureAlgorithm, String alias)
      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 digest 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