The following interfaces and classes are available for implementing digital signatures and encryption in your applications. These interfaces and classes are contained in the tc~bl~security~lib façade.
Interfaces and Classes Pertaining to the Data Format Used
Name | Description |
---|---|
Interface | |
ISsfData |
This interface is the central interface used for the cryptographic functions. Its underlying classes specify the data format used, for example, SsfDataPKCS7 , SsfDataSMIME and SsfDataXML . Available methods: sign , verify , encrypt , decrypt , writeTo |
Classes | |
SsfDataPKCS7 |
This class is derived from the interface ISsfData . It provides specific methods for using the PKCS#7 data format. |
SsfDataSMIME |
This class is also derived from the interface ISsfData . It provides specific methods for using S/MIME. |
SsfDataXML |
This class is also derived from the interface ISsfData . It provides the specific methods for using XML. |
For most cases, the methods available with ISsfData suffice for creating and verifying digital signatures and for encrypting and decrypting data. However, there are few methods available with the underlying classes that may be necessary. For example, the XML signature can contain an arbitrary list of URIs. Therefore, it may be necessary to explicitly use the methods available with the class SsfDataXML .
Interfaces and Classes Used for Accessing Keys
Name | Description |
---|---|
Interface | |
ISsfProfile |
This interface provides access to the user's or server's profile, where the private key and corresponding public-key certificate are stored. If the public-key certificate has been signed by a CA, then the interface also provides access to the CA chain associated with the certificate. |
ISsfPab |
This interface contains a list of public-key certificates belonging to others. This public-key certificates contained in this list are used to verify their owners' digital signatures or to encrypt documents. |
Classes | |
SsfProfileKeyStore |
This class is derived from the interface ISsfProfile . It provides specific methods when using the AS Java's keystore as the storage location for the key pairs. |
SsfProfilePKCS12File |
This class is derived from the interface ISsfProfile . It provides specific methods when using a PKCS#12 file as the storage location for the key pairs. |
SsfPabKeyStore |
This class is derived from the interface ISsfPab . It provides specific methods when using the AS Java's keystore as the storage location for the list of public-key certificates. |
SsfPabPKCS12File |
This class is derived from the interface ISsfPab . It provides specific methods when using a PKCS#12 file as the storage location for the list of public-key certificates. |
SsfSigRcpInfo |
This class contains the information about a particular signer or recipient. It contains the singer's or recipient's public-key certificate and the result of the corresponding operation (verify or encrypt). |
SsfSigRcpList |
This class contains a list of signers or recipients of type SsfSigRcpInfo . |
XML-Specific Classes
Name | Description |
---|---|
Class | |
SsfRefXMLInfo |
This class contains information about an XML reference, which includes the URI, a list of transformations, the message digest algorithm used, and a status. |
SsfRefXMLList |
This class contains a list of objects type SsfRefXMLInfo . |
Exceptions
Name | Description |
---|---|
Class | |
SsfInvalidAlgException |
This class is derived from the class Exception . It is returned if an invalid algorithm is requested, for example, if the library used does not support encryption, but an encryption algorithm was specified. |
SsfInvalidDataException |
This class is also derived from the class Exception . It is returned if the data is invalid, for example, the data exists in a different format than that what was requested. |
SsfInvalidKeyException |
This class is also derived from the class Exception . It is returned if the key being accessed is not valid. |