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 generate CSR for the provided appId invalid input: '&' refId.
KeyPairGenerateResponseDto	generateECSignKey(String objectType, KeyPairGenerateRequestDto request)	Function to generate ECC key for the provided app id and ref id.
KeyPairGenerateResponseDto	generateMasterKey(String objectType, KeyPairGenerateRequestDto request)	Function to generate Master key pair in the HSM specified in config.
SymmetricKeyGenerateResponseDto	generateSymmetricKey(SymmetricKeyGenerateRequestDto symGenRequestDto)	Function to generate Symmetric key for the provided appId invalid input: '&' refId.
AllCertificatesDataResponseDto	getAllCertificates(String appId, Optional<String> refId)	Function to get all the certificates for the provided appId invalid input: '&' refId.
KeyPairGenerateResponseDto	getCertificate(String appId, Optional<String> refId)	Function to get certificate for the provided appId invalid input: '&' 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
RevokeKeyResponseDto	revokeKey(RevokeKeyRequestDto revokeKeyRequestDto)	Key Revocation for the provided appId invalid input: '&' refId.
UploadCertificateResponseDto	uploadCertificate(UploadCertificateRequestDto uploadCertRequestDto)	Function to upload certificate for the provided appId invalid input: '&' refId.
UploadCertificateResponseDto	uploadOtherDomainCertificate(UploadCertificateRequestDto uploadCertRequestDto)	Function to upload other domain certificate for the provided appId invalid input: '&' refId.

Method Details

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 invalid input: '&' refId.

Parameters:

Application - ID appId

Reference - ID refId

Returns:

KeyPairGenerateResponseDto instance

generateCSR

KeyPairGenerateResponseDto generateCSR(CSRGenerateRequestDto csrGenRequestDto)

Function to generate CSR for the provided appId invalid input: '&' refId.

Parameters:

CSRGenerateRequestDto - request

Returns:

CSRGenerateRequestDto instance

uploadCertificate

UploadCertificateResponseDto uploadCertificate(UploadCertificateRequestDto uploadCertRequestDto)

Function to upload certificate for the provided appId invalid input: '&' refId.

Parameters:

UploadCertificateRequestDto - request

Returns:

UploadCertificateResponseDto instance

uploadOtherDomainCertificate

UploadCertificateResponseDto uploadOtherDomainCertificate(UploadCertificateRequestDto uploadCertRequestDto)

Function to upload other domain certificate for the provided appId invalid input: '&' refId.

Parameters:

UploadCertificateRequestDto - request

Returns:

UploadCertificateResponseDto instance

generateSymmetricKey

SymmetricKeyGenerateResponseDto generateSymmetricKey(SymmetricKeyGenerateRequestDto symGenRequestDto)

Function to generate Symmetric key for the provided appId invalid input: '&' refId.

Parameters:

SymmetricKeyGenerateRequestDto - symGenRequestDto

Returns:

SymmetricKeyGenerateRequestDto instance

revokeKey

RevokeKeyResponseDto revokeKey(RevokeKeyRequestDto revokeKeyRequestDto)

Key Revocation for the provided appId invalid input: '&' refId.

Parameters:

RevokeKeyRequestDto - revokeKeyRequestDto

Returns:

RevokeKeyResponseDto instance

getAllCertificates

AllCertificatesDataResponseDto getAllCertificates(String appId,
 Optional<String> refId)

Function to get all the certificates for the provided appId invalid input: '&' refId.

Parameters:

Application - ID appId

Reference - ID refId

Returns:

AllCertificatesDataResponseDto instance

generateECSignKey

KeyPairGenerateResponseDto generateECSignKey(String objectType,
 KeyPairGenerateRequestDto request)

Function to generate ECC key for the provided app id and ref id.

Parameters:

objectType - - return Object type can be a certificate or CSR

request - - request details like appId, refIds, etc.

Returns:

KeyPairGenerateResponseDto instance