net.jsign.jca

Interface SigningService

All Known Implementing Classes:

AmazonSigningService, AzureKeyVaultSigningService, AzureTrustedSigningService, CryptoCertumCardSigningService, DigiCertOneSigningService, ESignerSigningService, GaraSignSigningService, GoogleCloudSigningService, HashiCorpVaultSigningService, OpenPGPCardSigningService, OracleCloudSigningService, PIVCardSigningService, SignPathSigningService, SignServerSigningService

public interface SigningService

Interface to a signing service.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
List<String>	aliases() Returns the certificate aliases available.
Certificate[]	getCertificateChain(String alias) Returns the certificate chain for the alias specified.
String	getName() Returns the name of the service.
default SigningServicePrivateKey	getPrivateKey(String alias) Deprecated.
SigningServicePrivateKey	getPrivateKey(String alias, char[] password) Returns the private key for the certificate alias specified.
byte[]	sign(SigningServicePrivateKey privateKey, String algorithm, byte[] data) Sign the data with the private key specified.

Method Detail

aliases

List<String> aliases()
              throws KeyStoreException

Returns the certificate aliases available.

Throws:

KeyStoreException

getCertificateChain

Certificate[] getCertificateChain(String alias)
                           throws KeyStoreException

Returns the certificate chain for the alias specified.

Parameters:

alias - the name of the certificate

Throws:

KeyStoreException

getName

String getName()

Returns the name of the service.

getPrivateKey

@Deprecated
default SigningServicePrivateKey getPrivateKey(String alias)
                                                     throws UnrecoverableKeyException

Deprecated.

Returns the private key for the certificate alias specified.

Parameters:

alias - the name of the certificate

Throws:

UnrecoverableKeyException

getPrivateKey

SigningServicePrivateKey getPrivateKey(String alias,
                                       char[] password)
                                throws UnrecoverableKeyException

Returns the private key for the certificate alias specified.

Parameters:

alias - the name of the certificate

password - the secret required to access the key

Throws:

UnrecoverableKeyException

sign

byte[] sign(SigningServicePrivateKey privateKey,
            String algorithm,
            byte[] data)
     throws GeneralSecurityException

Sign the data with the private key specified.

Parameters:

privateKey - the private key

algorithm - the signing algorithm (for example SHA256withRSA)

data - the data to be signed

Throws:

GeneralSecurityException