Package com.fortanix.sdkms.jce.provider.spec

Class SecurityObjectParameterSpec

java.lang.Object

com.fortanix.sdkms.jce.provider.spec.SecurityObjectParameterSpec

All Implemented Interfaces:

AlgorithmParameterSpec

public class SecurityObjectParameterSpec
extends Object
implements AlgorithmParameterSpec

SecurityObjectParameterSpec is used to set specific key operation and encryption policy on created security object. SecuritObjects are the secrets key like AES, DES, TripleDES, EC and RSA. Key operations like SIGN, VERIFY, WRAP, UNWRAP, EXPORT, ENCRYPT, DECRYPT. if we want to support key to be get wrapped by some other key then wrapped key should have EXPORT permission.

Constructor Summary

Constructors

Constructor	Description
SecurityObjectParameterSpec()
SecurityObjectParameterSpec(boolean isTransientKey)
SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec, boolean isTransientKey)
SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec, List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations)	Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec
SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec, List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations, boolean isTransientKey)
SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec, List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations, com.fortanix.sdkms.v1.model.RsaEncryptionPolicy rsaEncryptionPolicy)	Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy
SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec, List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations, com.fortanix.sdkms.v1.model.RsaEncryptionPolicy rsaEncryptionPolicy, boolean isTransientKey)	Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy
SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec, List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations, com.fortanix.sdkms.v1.model.RsaEncryptionPolicy rsaEncryptionPolicy, com.fortanix.sdkms.v1.model.RsaSignaturePolicy rsaSignaturePolicy)	Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy
SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec, List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations, com.fortanix.sdkms.v1.model.RsaEncryptionPolicy rsaEncryptionPolicy, com.fortanix.sdkms.v1.model.RsaSignaturePolicy rsaSignaturePolicy, boolean isTransientKey)	Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy
SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec, List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations, com.fortanix.sdkms.v1.model.RsaSignaturePolicy rsaSignaturePolicy)	Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy
SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec, List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations, com.fortanix.sdkms.v1.model.RsaSignaturePolicy rsaSignaturePolicy, boolean isTransientKey)	Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy
SecurityObjectParameterSpec(List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations)
SecurityObjectParameterSpec(List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations, boolean isTransientKey)

Method Summary

Modifier and Type	Method	Description
List<com.fortanix.sdkms.v1.model.KeyOperations>	getAllowedKeyOperations()
com.fortanix.sdkms.v1.model.RsaEncryptionPolicy	getEncryptionPolicy()
String	getGroupId()
boolean	getIsTransientKey()
AlgorithmParameterSpec	getParamSpec()
com.fortanix.sdkms.v1.model.RsaSignaturePolicy	getSignaturePolicy()
void	setGroupId(String groupId)
void	setIsTransientKey(boolean isTransientKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityObjectParameterSpec

public SecurityObjectParameterSpec()

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations)

Parameters:

allowedKeyOperations -

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(boolean isTransientKey)

Parameters:

isTransientKey -

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations,
                                   boolean isTransientKey)

Parameters:

allowedKeyOperations -

isTransientKey -

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec,
                                   boolean isTransientKey)

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec,
                                   List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations)

Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec

Parameters:

paramSpec - additional parameter spec, user want to pass

allowedKeyOperations -

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec,
                                   List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations,
                                   boolean isTransientKey)

Parameters:

paramSpec -

allowedKeyOperations -

isTransientKey -

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec,
                                   List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations,
                                   com.fortanix.sdkms.v1.model.RsaSignaturePolicy rsaSignaturePolicy)

Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy

Parameters:

paramSpec - additional parameter spec, user want to pass

rsaSignaturePolicy -

allowedKeyOperations -

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec,
                                   List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations,
                                   com.fortanix.sdkms.v1.model.RsaSignaturePolicy rsaSignaturePolicy,
                                   boolean isTransientKey)

Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy

Parameters:

paramSpec - additional parameter spec, user want to pass

rsaSignaturePolicy -

allowedKeyOperations -

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec,
                                   List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations,
                                   com.fortanix.sdkms.v1.model.RsaEncryptionPolicy rsaEncryptionPolicy,
                                   com.fortanix.sdkms.v1.model.RsaSignaturePolicy rsaSignaturePolicy,
                                   boolean isTransientKey)

Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy

Parameters:

paramSpec - additional parameter spec, user want to pass

rsaEncryptionPolicy -

rsaSignaturePolicy -

allowedKeyOperations -

isTransientKey -

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec,
                                   List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations,
                                   com.fortanix.sdkms.v1.model.RsaEncryptionPolicy rsaEncryptionPolicy,
                                   com.fortanix.sdkms.v1.model.RsaSignaturePolicy rsaSignaturePolicy)

Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy

Parameters:

paramSpec - additional parameter spec, user want to pass

rsaEncryptionPolicy -

rsaSignaturePolicy -

allowedKeyOperations -

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec,
                                   List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations,
                                   com.fortanix.sdkms.v1.model.RsaEncryptionPolicy rsaEncryptionPolicy)

Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy

Parameters:

paramSpec - additional parameter spec, user want to pass

rsaEncryptionPolicy -

allowedKeyOperations -

SecurityObjectParameterSpec

public SecurityObjectParameterSpec(AlgorithmParameterSpec paramSpec,
                                   List<com.fortanix.sdkms.v1.model.KeyOperations> allowedKeyOperations,
                                   com.fortanix.sdkms.v1.model.RsaEncryptionPolicy rsaEncryptionPolicy,
                                   boolean isTransientKey)

Constructor to initialized allowed key operation along with RSA/DES/DES3/AES parameter spec and encryption policy

Parameters:

paramSpec - additional parameter spec, user want to pass

rsaEncryptionPolicy -

allowedKeyOperations -

Method Detail

setGroupId

public void setGroupId(String groupId)

setIsTransientKey

public void setIsTransientKey(boolean isTransientKey)

getParamSpec

public AlgorithmParameterSpec getParamSpec()

Returns:

the paramSpec. null if parameter spec is not set

getAllowedKeyOperations

public List<com.fortanix.sdkms.v1.model.KeyOperations> getAllowedKeyOperations()

Returns:

the allowedKeyOperations. null if allowedKeyOperations is not set

getIsTransientKey

public boolean getIsTransientKey()

Returns:

true if transient is not set false

getEncryptionPolicy

public com.fortanix.sdkms.v1.model.RsaEncryptionPolicy getEncryptionPolicy()

Returns:

the Encryption policy. Only used for RSA Keygen

getSignaturePolicy

public com.fortanix.sdkms.v1.model.RsaSignaturePolicy getSignaturePolicy()

Returns:

the Signature policy. Only used for RSA Keygen

getGroupId

public String getGroupId()