Package io.mosip.kernel.keymanagerservice.service

Interface KeymanagerService

All Known Implementing Classes:

KeymanagerServiceImpl

public interface KeymanagerService

This interface provides the methods which can be used for Key management

Since:

1.0.0

Author:

Dharmesh Khandelwal, Urvil Joshi

Method Summary

Modifier and Type	Method	Description
SymmetricKeyResponseDto	decryptSymmetricKey(SymmetricKeyRequestDto symmetricKeyRequestDto)	Function to decrypt symmetric key
KeyPairGenerateResponseDto	generateCSR(CSRGenerateRequestDto csrGenRequestDto)	Function to get CSR for the provided appId & refId.
KeyPairGenerateResponseDto	generateMasterKey(String objectType, KeyPairGenerateRequestDto request)	Function to generate Master key pair in the HSM specified in config.
KeyPairGenerateResponseDto	getCertificate(String appId, Optional<String> refId)	Function to get certificate for the provided appId & refId.
SignatureCertificate	getSignatureCertificate(String applicationId, Optional<String> referenceId, String timestamp)
PublicKeyResponse<String>	getSignPublicKey(String applicationId, String timeStamp, Optional<String> referenceId)	Function to get public key
UploadCertificateResponseDto	uploadCertificate(UploadCertificateRequestDto uploadCertRequestDto)	Function to upload certificate for the provided appId & refId.
UploadCertificateResponseDto	uploadOtherDomainCertificate(UploadCertificateRequestDto uploadCertRequestDto)	Function to upload other domain certificate for the provided appId & refId.

Method Detail

decryptSymmetricKey

SymmetricKeyResponseDto decryptSymmetricKey(SymmetricKeyRequestDto symmetricKeyRequestDto)

Function to decrypt symmetric key

Parameters:

symmetricKeyRequestDto - symmetricKeyRequestDto

Returns:

SymmetricKeyResponseDto instance

getSignPublicKey

PublicKeyResponse<String> getSignPublicKey(String applicationId,
                                           String timeStamp,
                                           Optional<String> referenceId)

Function to get public key

Parameters:

applicationId - applicationId

timeStamp - timeStamp

referenceId - referenceId

Returns:

PublicKeyResponse instance

getSignatureCertificate

SignatureCertificate getSignatureCertificate(String applicationId,
                                             Optional<String> referenceId,
                                             String timestamp)

generateMasterKey

KeyPairGenerateResponseDto generateMasterKey(String objectType,
                                             KeyPairGenerateRequestDto request)

Function to generate Master key pair in the HSM specified in config.

Parameters:

KeyPairGenerateRequestDto - request

Returns:

KeyPairGenerateResponseDto instance

getCertificate

KeyPairGenerateResponseDto getCertificate(String appId,
                                          Optional<String> refId)

Function to get certificate for the provided appId & refId.

Parameters:

Application - ID appId

Reference - ID refId

Returns:

KeyPairGenerateResponseDto instance

generateCSR

KeyPairGenerateResponseDto generateCSR(CSRGenerateRequestDto csrGenRequestDto)

Function to get CSR for the provided appId & refId.

Parameters:

CSRGenerateRequestDto - request

Returns:

KeyPairGenerateResponseDto instance

uploadCertificate

UploadCertificateResponseDto uploadCertificate(UploadCertificateRequestDto uploadCertRequestDto)

Function to upload certificate for the provided appId & refId.

Parameters:

UploadCertificateRequestDto - request

Returns:

UploadCertificateResponseDto instance

uploadOtherDomainCertificate

UploadCertificateResponseDto uploadOtherDomainCertificate(UploadCertificateRequestDto uploadCertRequestDto)

Function to upload other domain certificate for the provided appId & refId.

Parameters:

UploadCertificateRequestDto - request

Returns:

UploadCertificateResponseDto instance