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 TypeMethodDescriptiondecryptSymmetricKey(SymmetricKeyRequestDto symmetricKeyRequestDto) Function to decrypt symmetric keygenerateCSR(CSRGenerateRequestDto csrGenRequestDto) Function to generate CSR for the provided appId invalid input: '&' refId.generateECSignKey(String objectType, KeyPairGenerateRequestDto request) Function to generate ECC key for the provided app id and ref id.generateMasterKey(String objectType, KeyPairGenerateRequestDto request) Function to generate Master key pair in the HSM specified in config.generateSymmetricKey(SymmetricKeyGenerateRequestDto symGenRequestDto) Function to generate Symmetric key for the provided appId invalid input: '&' refId.getAllCertificates(String appId, Optional<String> refId) Function to get all the certificates for the provided appId invalid input: '&' refId.getCertificate(String appId, Optional<String> refId) Function to get certificate for the provided appId invalid input: '&' refId.getSignatureCertificate(String applicationId, Optional<String> referenceId, String timestamp) getSignPublicKey(String applicationId, String timeStamp, Optional<String> referenceId) Function to get public keyrevokeKey(RevokeKeyRequestDto revokeKeyRequestDto) Key Revocation for the provided appId invalid input: '&' refId.uploadCertificate(UploadCertificateRequestDto uploadCertRequestDto) Function to upload certificate for the provided appId invalid input: '&' refId.uploadOtherDomainCertificate(UploadCertificateRequestDto uploadCertRequestDto) Function to upload other domain certificate for the provided appId invalid input: '&' refId.
-
Method Details
-
decryptSymmetricKey
Function to decrypt symmetric key- Parameters:
symmetricKeyRequestDto- symmetricKeyRequestDto- Returns:
SymmetricKeyResponseDtoinstance
-
getSignPublicKey
PublicKeyResponse<String> getSignPublicKey(String applicationId, String timeStamp, Optional<String> referenceId) Function to get public key- Parameters:
applicationId- applicationIdtimeStamp- timeStampreferenceId- referenceId- Returns:
PublicKeyResponseinstance
-
getSignatureCertificate
SignatureCertificate getSignatureCertificate(String applicationId, Optional<String> referenceId, String timestamp) -
generateMasterKey
Function to generate Master key pair in the HSM specified in config.- Parameters:
KeyPairGenerateRequestDto- request- Returns:
KeyPairGenerateResponseDtoinstance
-
getCertificate
Function to get certificate for the provided appId invalid input: '&' refId.- Parameters:
Application- ID appIdReference- ID refId- Returns:
KeyPairGenerateResponseDtoinstance
-
generateCSR
Function to generate CSR for the provided appId invalid input: '&' refId.- Parameters:
CSRGenerateRequestDto- request- Returns:
CSRGenerateRequestDtoinstance
-
uploadCertificate
Function to upload certificate for the provided appId invalid input: '&' refId.- Parameters:
UploadCertificateRequestDto- request- Returns:
UploadCertificateResponseDtoinstance
-
uploadOtherDomainCertificate
UploadCertificateResponseDto uploadOtherDomainCertificate(UploadCertificateRequestDto uploadCertRequestDto) Function to upload other domain certificate for the provided appId invalid input: '&' refId.- Parameters:
UploadCertificateRequestDto- request- Returns:
UploadCertificateResponseDtoinstance
-
generateSymmetricKey
SymmetricKeyGenerateResponseDto generateSymmetricKey(SymmetricKeyGenerateRequestDto symGenRequestDto) Function to generate Symmetric key for the provided appId invalid input: '&' refId.- Parameters:
SymmetricKeyGenerateRequestDto- symGenRequestDto- Returns:
SymmetricKeyGenerateRequestDtoinstance
-
revokeKey
Key Revocation for the provided appId invalid input: '&' refId.- Parameters:
RevokeKeyRequestDto- revokeKeyRequestDto- Returns:
RevokeKeyResponseDtoinstance
-
getAllCertificates
Function to get all the certificates for the provided appId invalid input: '&' refId.- Parameters:
Application- ID appIdReference- ID refId- Returns:
AllCertificatesDataResponseDtoinstance
-
generateECSignKey
Function to generate ECC key for the provided app id and ref id.- Parameters:
objectType- - return Object type can be a certificate or CSRrequest- - request details like appId, refIds, etc.- Returns:
KeyPairGenerateResponseDtoinstance
-