org.eclipse.kura.certificate

Interface CertificatesService

public interface CertificatesService

The CertificatesService is used to manage the storage, listing and retrieval of public certificates from a key store.

Method Summary

Methods

Modifier and Type	Method and Description
Enumeration<String>	listBundleCertificatesAliases() listBundleCertificatesAliases provides an enumeration of strings representing the different certificates used to sign the bundles and that are stored in the device key store
Enumeration<String>	listCACertificatesAliases() listCACertificatesAliases provides an enumeration of strings representing the different CA certificates stored in a key store
Enumeration<String>	listDMCertificatesAliases() listDMCertificatesAliases provides an enumeration of strings representing the different certificates used to authenticate the messages coming from the remote platform and stored in the device key store
Enumeration<String>	listSSLCertificatesAliases() listSSLCertificatesAliases provides an enumeration of strings representing the different ssl certificates stored in a key store
void	removeCertificate(String alias) removeCertificate tries to remove the specified certificate from the key store.
Certificate	returnCertificate(String alias) returnCertificate returns the certificate corresponding to the specified alias.
void	storeCertificate(Certificate cert, String alias) The storeCertificate interface method receives a certificate and an alias that should be stored in a key store
boolean	verifySignature(KuraTopic kuraTopic, KuraPayload kuraPayload) verifySignature is a method that takes the topic used to send the message and the signed message to verify the correctness of the signature.

Method Detail

storeCertificate

void storeCertificate(Certificate cert,
                    String alias)
                      throws KuraException

The storeCertificate interface method receives a certificate and an alias that should be stored in a key store

Parameters:

cert - The certificate of type Certificate that has to be stored in a key store

alias - A string that will be used to identify the certificate in a key store

Throws:

KuraException - raised if the certificate storage operation failed

listCACertificatesAliases

Enumeration<String> listCACertificatesAliases()

listCACertificatesAliases provides an enumeration of strings representing the different CA certificates stored in a key store

Returns:

An enumeration containing the strings that represent the CA aliases stored in a key store.

listSSLCertificatesAliases

Enumeration<String> listSSLCertificatesAliases()

listSSLCertificatesAliases provides an enumeration of strings representing the different ssl certificates stored in a key store

Returns:

An enumeration containing the strings that represent the aliases stored in a key store.

listDMCertificatesAliases

Enumeration<String> listDMCertificatesAliases()

listDMCertificatesAliases provides an enumeration of strings representing the different certificates used to authenticate the messages coming from the remote platform and stored in the device key store

Returns:

An enumeration containing the strings that represent the aliases stored in a key store.

listBundleCertificatesAliases

Enumeration<String> listBundleCertificatesAliases()

listBundleCertificatesAliases provides an enumeration of strings representing the different certificates used to sign the bundles and that are stored in the device key store

Returns:

An enumeration containing the strings that represent the aliases stored in a key store.

returnCertificate

Certificate returnCertificate(String alias)
                              throws KuraException

returnCertificate returns the certificate corresponding to the specified alias.

Parameters:

alias - The string used to identify the certificate in a key store

Returns:

A Certificate object retrieved from a key store.

Throws:

KuraException

removeCertificate

void removeCertificate(String alias)
                       throws KuraException

removeCertificate tries to remove the specified certificate from the key store. Returns true, if the removal operation succeeded. False, otherwise.

Parameters:

alias - The string used to identify the certificate in a key store

Throws:

KuraException - raised if the certificate removal operation failed

verifySignature

boolean verifySignature(KuraTopic kuraTopic,
                      KuraPayload kuraPayload)

verifySignature is a method that takes the topic used to send the message and the signed message to verify the correctness of the signature.

Parameters:

kuraTopic - The topic used to send the message

kuraPayload - The kuraPayload message received and that needs to be verified

Returns:

A boolean value that is true if the signature received corresponds with the signature calculated from the message content. False otherwise.