org.eclipse.kura.certificate.enrollment

Interface EnrollmentService

@ProviderType
public interface EnrollmentService

Provides a list of APIs allowing the system to perform an enrollment in a Certificate Authority

Since:

2.4

Method Summary

Modifier and Type	Method and Description
void	enroll() Perform the enrollment of the system with a configured Certificate Authority.
void	forceCACertificateRollover() Force the update of Certificate Authority certificate if a newest is available.
java.security.cert.CertStore	getCACertificates() Get the list of the Certificate Authority certificates stored in the relative KeystoreService
java.security.cert.Certificate	getClientCertificate() Get the Client certificate stored in the relative KeystoreService
boolean	isEnrolled() Check if the system in enrolled or not, that is the presence or not of the client certificate.
void	rekey() Renew the client certificate creating a new keypair and a new CSR submitted to the CA.
void	renew() Renew the client certificate submitting the certificate previously issued by the CA.

Method Detail

enroll

void enroll()
     throws KuraException

Perform the enrollment of the system with a configured Certificate Authority.

Throws:

KuraException - if it is impossible to enroll the system.

renew

void renew()
    throws KuraException

Renew the client certificate submitting the certificate previously issued by the CA.

Throws:

KuraException - if it is impossible to renew the system certificate

rekey

void rekey()
    throws KuraException

Renew the client certificate creating a new keypair and a new CSR submitted to the CA.

Throws:

KuraException - if it is impossible to renew the system certificate

getCACertificates

java.security.cert.CertStore getCACertificates()
                                        throws KuraException

Get the list of the Certificate Authority certificates stored in the relative KeystoreService

Returns:

returns the Certificate Authority CertStore

Throws:

KuraException - if it is impossible to retrieve the certificate store.

getClientCertificate

java.security.cert.Certificate getClientCertificate()
                                             throws KuraException

Get the Client certificate stored in the relative KeystoreService

Returns:

returns the Client Certificate obtained by the Certificate Authority

Throws:

KuraException - if it is impossible to retrieve the certificate.

forceCACertificateRollover

void forceCACertificateRollover()
                         throws KuraException

Force the update of Certificate Authority certificate if a newest is available.

Throws:

KuraException - if it is impossible to perform the request to the server.

isEnrolled

boolean isEnrolled()
            throws KuraException

Check if the system in enrolled or not, that is the presence or not of the client certificate.

Returns:

true if the system in enrolled, false otherwise.

Throws:

KuraException - if it is impossible to query the keystore for the certificate availability.