com.akeyless.api.kfm.KfmApi Maven / Gradle / Ivy
package com.akeyless.api.kfm;
import com.akeyless.api.exceptions.*;
import com.akeyless.kfm.swagger.ApiException;
import com.akeyless.kfm.swagger.ApiResponse;
import com.akeyless.kfm.swagger.model.DerivedFragmentReplyObj;
import com.akeyless.kfm.swagger.model.RSAFragmentDecryptReplyObj;
import com.akeyless.kfm.swagger.model.UploadRSAFragmentReplyObj;
public interface KfmApi {
/**
* Returns a derived fragment from the origin fragment via the supplied derivation data.
*
* @param akeylessKFMUserCreds Temporary credentials for accessing the endpoint (required)
* @param akeylessKFMOperationCreds Temporary credentials for performing the operation (required)
* @param derivationData The derivation data to be used for the fragment derivation operation (required)
* @param doubleDerivation Indicate if perform a double derivation (optional)
* @return DerivedFragmentReplyObj
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the user access credentials or operation credentials not found.
* @throws InvalidCredentialsException If the user's access credentials or operation credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If fragment not found.
*/
DerivedFragmentReplyObj deriveFragment(String akeylessKFMUserCreds,
String akeylessKFMOperationCreds,
String derivationData,
Boolean doubleDerivation
) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
CredentialsNotFoundException, InvalidCredentialsException, NotFoundException;
/**
*
* Gets a fragment of an RSA key for storage in database as a new key fragment and return a test signature on a test message using the uploaded fragment.
* @param akeylessKFMUserCreds Temporary credentials for accessing the endpoint (required)
* @param akeylessKFMOperationCreds Temporary credentials for performing the operation (required)
* @param fragmentValue The value of the RSA key fragment. (required)
* @param testMessage A message to be use to create the testing signature. (required)
* @return UploadRSAFragmentReplyObj
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the user access credentials or operation credentials not found.
* @throws InvalidCredentialsException If the user's access credentials or operation credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter. */
UploadRSAFragmentReplyObj uploadRSAFragment(String akeylessKFMUserCreds,
String akeylessKFMOperationCreds,
String fragmentValue,
String testMessage
) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
CredentialsNotFoundException, InvalidCredentialsException;
/**
* Returns a fragmented decryption result on an RSA fragment.
*
* @param akeylessKFMUserCreds Temporary credentials for accessing the endpoint (required)
* @param akeylessKFMOperationCreds Temporary credentials for performing the operation (required)
* @param cipher The ciphertext to be decrypted (in case of signing operation this parameter should contain the message to be signed) (required)
* @return RSAFragmentDecryptReplyObj
* @throws ApiCommunicationException If fail to call the API, e.g. server error or cannot deserialize the response body
* @throws CredentialsNotFoundException If the user access credentials or operation credentials not found.
* @throws InvalidCredentialsException If the user's access credentials or operation credentials are invalid.
* @throws MissingRequiredParamException Missing required parameter.
* @throws InvalidParamException Invalid parameter.
* @throws NotFoundException If fragment not found.
*/
RSAFragmentDecryptReplyObj rsaFragmentDecrypt(String akeylessKFMUserCreds,
String akeylessKFMOperationCreds,
String cipher
) throws ApiCommunicationException, MissingRequiredParamException, InvalidParamException,
CredentialsNotFoundException, InvalidCredentialsException, NotFoundException;
}