Package eu.europa.esig.dss.token

Interface SignatureTokenConnection

All Superinterfaces:
AutoCloseable
All Known Implementing Classes:
AbstractKeyStoreTokenConnection, AbstractSignatureTokenConnection, AppleSignatureToken, JKSSignatureToken, KeyStoreSignatureTokenConnection, MSCAPISignatureToken, Pkcs11SignatureToken, Pkcs12SignatureToken
public interface SignatureTokenConnection extends AutoCloseable
Connection through available API to the QSCD (SmartCard, MSCAPI, PKCS#12)

  • Method Details

    • close

      void close()
      Specified by:
      close in interface AutoCloseable

    • getKeys

      List<DSSPrivateKeyEntry> getKeys() throws DSSException
      Retrieves all the available keys (private keys entries) from the token.
      Returns:
      List of encapsulated private keys
      Throws:
      DSSException - If there is any problem during the retrieval process

    • sign

      SignatureValue sign(ToBeSigned toBeSigned, DigestAlgorithm digestAlgorithm, DSSPrivateKeyEntry keyEntry) throws DSSException
      This method signs the toBeSigned data with the digest digestAlgorithm and the given keyEntry.
      Parameters:
      toBeSigned - The data that need to be signed
      digestAlgorithm - The digest algorithm to be used before signing
      keyEntry - The private key to be used
      Returns:
      the signature value representation with the used algorithm and the binary value
      Throws:
      DSSException - If there is any problem during the signature process

    • sign

      SignatureValue sign(ToBeSigned toBeSigned, DigestAlgorithm digestAlgorithm, MaskGenerationFunction mgf, DSSPrivateKeyEntry keyEntry) throws DSSException
      This method signs the toBeSigned data with the digest digestAlgorithm, the mask mgf and the given keyEntry.
      Parameters:
      toBeSigned - The data that need to be signed
      digestAlgorithm - The digest algorithm to be used before signing
      mgf - the mask generation function
      keyEntry - The private key to be used
      Returns:
      the signature value representation with the used algorithm and the binary value
      Throws:
      DSSException - If there is any problem during the signature process

    • sign

      SignatureValue sign(ToBeSigned toBeSigned, SignatureAlgorithm signatureAlgorithm, DSSPrivateKeyEntry keyEntry) throws DSSException
      This method signs the toBeSigned data with the pre-defined signature algorithm signatureAlgorithm, and the given keyEntry.
      Parameters:
      toBeSigned - The data that need to be signed
      signatureAlgorithm - The signature algorithm to be used before signing
      keyEntry - The private key to be used
      Returns:
      the signature value representation with the used algorithm and the binary value
      Throws:
      DSSException - If there is any problem during the signature process

    • signDigest

      SignatureValue signDigest(Digest digest, DSSPrivateKeyEntry keyEntry) throws DSSException
      This method signs the digest data with the given keyEntry.
      Parameters:
      digest - The digested data that need to be signed
      keyEntry - The private key to be used
      Returns:
      the signature value representation with the used algorithm and the binary value
      Throws:
      DSSException - If there is any problem during the signature process

    • signDigest

      SignatureValue signDigest(Digest digest, MaskGenerationFunction mgf, DSSPrivateKeyEntry keyEntry) throws DSSException
      This method signs the digest data with the given keyEntry.
      Parameters:
      digest - The digested data that need to be signed
      mgf - the mask generation function
      keyEntry - The private key to be used
      Returns:
      the signature value representation with the used algorithm and the binary value
      Throws:
      DSSException - If there is any problem during the signature process

    • signDigest

      SignatureValue signDigest(Digest digest, SignatureAlgorithm signatureAlgorithm, DSSPrivateKeyEntry keyEntry) throws DSSException
      This method signs the digest data with the pre-defined signatureAlgorithm and the given keyEntry.
      Parameters:
      digest - The digested data that need to be signed
      signatureAlgorithm - The signature algorithm
      keyEntry - The private key to be used
      Returns:
      the signature value representation with the used algorithm and the binary value
      Throws:
      DSSException - If there is any problem during the signature process