Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	BCFKSLoadStoreParameter.Builder
public static enum	BCFKSLoadStoreParameter.EncryptionAlgorithm
public static enum	BCFKSLoadStoreParameter.MacAlgorithm

Modifier and Type	Field and Description
private final BCFKSLoadStoreParameter.EncryptionAlgorithm	encAlg
private final BCFKSLoadStoreParameter.MacAlgorithm	macAlg
private final PBKDFConfig	storeConfig

Access	Constructor and Description
private	BCFKSLoadStoreParameter(InputStream in, OutputStream out, PBKDFConfig storeConfig, KeyStore.ProtectionParameter protectionParameter, BCFKSLoadStoreParameter.EncryptionAlgorithm encAlg, BCFKSLoadStoreParameter.MacAlgorithm macAlg)

Method Summary

Modifier and Type	Method and Description
public BCFKSLoadStoreParameter.EncryptionAlgorithm	Returns: the encryption algorithm to use. getStoreEncryptionAlgorithm() Return encryption algorithm used to secure the store and its entries.
public BCFKSLoadStoreParameter.MacAlgorithm	Returns: the encryption algorithm to use. getStoreMacAlgorithm() Return encryption algorithm used to secure the store and its entries.
public PBKDFConfig	Returns: the PBKDF to use for deriving HMAC and store encryption keys. getStorePBKDFConfig() Return the PBKDF used for generating the HMAC and store encryption keys.

Inherited from org.bouncycastle.jcajce.BCLoadStoreParameter:: getInputStream getOutputStream getProtectionParameter

encAlg	back to summary
private final BCFKSLoadStoreParameter.EncryptionAlgorithm encAlg

macAlg	back to summary
private final BCFKSLoadStoreParameter.MacAlgorithm macAlg

storeConfig	back to summary
private final PBKDFConfig storeConfig

BCFKSLoadStoreParameter	back to summary
private BCFKSLoadStoreParameter(InputStream in, OutputStream out, PBKDFConfig storeConfig, KeyStore.ProtectionParameter protectionParameter, BCFKSLoadStoreParameter.EncryptionAlgorithm encAlg, BCFKSLoadStoreParameter.MacAlgorithm macAlg)

Method Detail

getStoreEncryptionAlgorithm	back to summary
public BCFKSLoadStoreParameter.EncryptionAlgorithm getStoreEncryptionAlgorithm() Return encryption algorithm used to secure the store and its entries. Returns:BCFKSLoadStoreParameter.EncryptionAlgorithm the encryption algorithm to use.

getStoreEncryptionAlgorithm

back to summary

public BCFKSLoadStoreParameter.EncryptionAlgorithm getStoreEncryptionAlgorithm()

Return encryption algorithm used to secure the store and its entries.

Returns:BCFKSLoadStoreParameter.EncryptionAlgorithm: the encryption algorithm to use.

getStoreMacAlgorithm	back to summary
public BCFKSLoadStoreParameter.MacAlgorithm getStoreMacAlgorithm() Return encryption algorithm used to secure the store and its entries. Returns:BCFKSLoadStoreParameter.MacAlgorithm the encryption algorithm to use.

getStoreMacAlgorithm

back to summary

public BCFKSLoadStoreParameter.MacAlgorithm getStoreMacAlgorithm()

Return encryption algorithm used to secure the store and its entries.

Returns:BCFKSLoadStoreParameter.MacAlgorithm: the encryption algorithm to use.

getStorePBKDFConfig	back to summary
public PBKDFConfig getStorePBKDFConfig() Return the PBKDF used for generating the HMAC and store encryption keys. Returns:PBKDFConfig the PBKDF to use for deriving HMAC and store encryption keys.

getStorePBKDFConfig

back to summary

public PBKDFConfig getStorePBKDFConfig()

Return the PBKDF used for generating the HMAC and store encryption keys.

Returns:PBKDFConfig: the PBKDF to use for deriving HMAC and store encryption keys.

org.bouncycastle.jcajce back to summary

public Class BCFKSLoadStoreParameter.Builder

Class Inheritance

extends Object

java.lang.Object
org.bouncycastle.jcajce.BCFKSLoadStoreParameter.Builder

Field Summary

Modifier and Type	Field and Description
private BCFKSLoadStoreParameter.EncryptionAlgorithm	encAlg
private final InputStream	in
private BCFKSLoadStoreParameter.MacAlgorithm	macAlg
private final OutputStream	out
private final KeyStore.ProtectionParameter	protectionParameter
private PBKDFConfig	storeConfig

Constructor Summary

Access	Constructor and Description
public	Builder() Base constructor for creating a LoadStoreParameter for initializing a key store.
public	Builder(OutputStream OutputStream to write KeyStore to. out, char[] the password to use to protect the KeyStore. password) Base constructor for storing to an OutputStream using a password.
public	Builder(OutputStream OutputStream to write KeyStore to. out, KeyStore.ProtectionParameter the protection parameter to use to protect the KeyStore. protectionParameter) Base constructor for storing to an OutputStream using a protection parameter.
public	Builder(InputStream InputStream to read the KeyStore from. in, char[] the password used to protect the KeyStore. password) Base constructor for reading a KeyStore from an InputStream using a password.
public	Builder(InputStream InputStream to read the KeyStore from. in, KeyStore.ProtectionParameter the protection parameter used to protect the KeyStore. protectionParameter) Base constructor for reading a KeyStore from an InputStream using a password.

Method Summary

Modifier and Type	Method and Description
public BCFKSLoadStoreParameter	Returns: a new BCFKSLoadStoreParameter. build() Build and return a BCFKSLoadStoreParameter.
public BCFKSLoadStoreParameter.Builder	Returns: the current Builder instance. withStoreEncryptionAlgorithm(BCFKSLoadStoreParameter.EncryptionAlgorithm the PBKDF config to use for protecting the KeyStore and its keys. encAlg) Configure the encryption algorithm to use for protecting the KeyStore and its keys.
public BCFKSLoadStoreParameter.Builder	Returns: the current Builder instance. withStoreMacAlgorithm(BCFKSLoadStoreParameter.MacAlgorithm the PBKDF config to use for protecting the KeyStore. macAlg) Configure the MAC algorithm to use for protecting the KeyStore.
public BCFKSLoadStoreParameter.Builder	Returns: the current Builder instance. withStorePBKDFConfig(PBKDFConfig the PBKDF config to use for protecting the KeyStore. storeConfig) Configure the PBKDF to use for protecting the KeyStore.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

encAlg	back to summary
private BCFKSLoadStoreParameter.EncryptionAlgorithm encAlg

in	back to summary
private final InputStream in

macAlg	back to summary
private BCFKSLoadStoreParameter.MacAlgorithm macAlg

out	back to summary
private final OutputStream out

protectionParameter	back to summary
private final KeyStore.ProtectionParameter protectionParameter

storeConfig	back to summary
private PBKDFConfig storeConfig

Constructor Detail

Builder	back to summary
public Builder() Base constructor for creating a LoadStoreParameter for initializing a key store.

Builder	back to summary
public Builder(OutputStream out, char[] password) Base constructor for storing to an OutputStream using a password. Parameters out:OutputStream OutputStream to write KeyStore to. password:char[] the password to use to protect the KeyStore.

Builder

back to summary

public Builder(OutputStream out, char[] password)

Base constructor for storing to an OutputStream using a password.

Parameters

out:OutputStream: OutputStream to write KeyStore to.
password:char[]: the password to use to protect the KeyStore.

Builder	back to summary
public Builder(OutputStream out, KeyStore.ProtectionParameter protectionParameter) Base constructor for storing to an OutputStream using a protection parameter. Parameters out:OutputStream OutputStream to write KeyStore to. protectionParameter:KeyStore.ProtectionParameter the protection parameter to use to protect the KeyStore.

Builder

back to summary

public Builder(OutputStream out, KeyStore.ProtectionParameter protectionParameter)

Base constructor for storing to an OutputStream using a protection parameter.

Parameters

out:OutputStream: OutputStream to write KeyStore to.
protectionParameter:KeyStore.ProtectionParameter: the protection parameter to use to protect the KeyStore.

Builder	back to summary
public Builder(InputStream in, char[] password) Base constructor for reading a KeyStore from an InputStream using a password. Parameters in:InputStream InputStream to read the KeyStore from. password:char[] the password used to protect the KeyStore.

Builder

back to summary

public Builder(InputStream in, char[] password)

Base constructor for reading a KeyStore from an InputStream using a password.

Parameters

in:InputStream: InputStream to read the KeyStore from.
password:char[]: the password used to protect the KeyStore.

Builder	back to summary
public Builder(InputStream in, KeyStore.ProtectionParameter protectionParameter) Base constructor for reading a KeyStore from an InputStream using a password. Parameters in:InputStream InputStream to read the KeyStore from. protectionParameter:KeyStore.ProtectionParameter the protection parameter used to protect the KeyStore.

Builder

back to summary

public Builder(InputStream in, KeyStore.ProtectionParameter protectionParameter)

Base constructor for reading a KeyStore from an InputStream using a password.

Parameters

in:InputStream: InputStream to read the KeyStore from.
protectionParameter:KeyStore.ProtectionParameter: the protection parameter used to protect the KeyStore.

Method Detail

build	back to summary
public BCFKSLoadStoreParameter build() Build and return a BCFKSLoadStoreParameter. Returns:BCFKSLoadStoreParameter a new BCFKSLoadStoreParameter.

build

back to summary

public BCFKSLoadStoreParameter build()

Build and return a BCFKSLoadStoreParameter.

Returns:BCFKSLoadStoreParameter: a new BCFKSLoadStoreParameter.

withStoreEncryptionAlgorithm	back to summary
public BCFKSLoadStoreParameter.Builder withStoreEncryptionAlgorithm(BCFKSLoadStoreParameter.EncryptionAlgorithm encAlg) Configure the encryption algorithm to use for protecting the KeyStore and its keys. Parameters encAlg:BCFKSLoadStoreParameter.EncryptionAlgorithm the PBKDF config to use for protecting the KeyStore and its keys. Returns:BCFKSLoadStoreParameter.Builder the current Builder instance.

withStoreEncryptionAlgorithm

back to summary

public BCFKSLoadStoreParameter.Builder withStoreEncryptionAlgorithm(BCFKSLoadStoreParameter.EncryptionAlgorithm encAlg)

Configure the encryption algorithm to use for protecting the KeyStore and its keys.

Parameters

encAlg:BCFKSLoadStoreParameter.EncryptionAlgorithm: the PBKDF config to use for protecting the KeyStore and its keys.

Returns:BCFKSLoadStoreParameter.Builder

the current Builder instance.

withStoreMacAlgorithm	back to summary
public BCFKSLoadStoreParameter.Builder withStoreMacAlgorithm(BCFKSLoadStoreParameter.MacAlgorithm macAlg) Configure the MAC algorithm to use for protecting the KeyStore. Parameters macAlg:BCFKSLoadStoreParameter.MacAlgorithm the PBKDF config to use for protecting the KeyStore. Returns:BCFKSLoadStoreParameter.Builder the current Builder instance.

withStoreMacAlgorithm

back to summary

public BCFKSLoadStoreParameter.Builder withStoreMacAlgorithm(BCFKSLoadStoreParameter.MacAlgorithm macAlg)

Configure the MAC algorithm to use for protecting the KeyStore.

Parameters

macAlg:BCFKSLoadStoreParameter.MacAlgorithm: the PBKDF config to use for protecting the KeyStore.

Returns:BCFKSLoadStoreParameter.Builder

the current Builder instance.

withStorePBKDFConfig	back to summary
public BCFKSLoadStoreParameter.Builder withStorePBKDFConfig(PBKDFConfig storeConfig) Configure the PBKDF to use for protecting the KeyStore. Parameters storeConfig:PBKDFConfig the PBKDF config to use for protecting the KeyStore. Returns:BCFKSLoadStoreParameter.Builder the current Builder instance.

withStorePBKDFConfig

back to summary

public BCFKSLoadStoreParameter.Builder withStorePBKDFConfig(PBKDFConfig storeConfig)

Configure the PBKDF to use for protecting the KeyStore.

Parameters

storeConfig:PBKDFConfig: the PBKDF config to use for protecting the KeyStore.

Returns:BCFKSLoadStoreParameter.Builder

the current Builder instance.

org.bouncycastle.jcajce back to summary

public final Enum BCFKSLoadStoreParameter.EncryptionAlgorithm

Class Inheritance

extends Enum<BCFKSLoadStoreParameter.EncryptionAlgorithm>

java.lang.Object
java.lang.Enum
org.bouncycastle.jcajce.BCFKSLoadStoreParameter.EncryptionAlgorithm

Field Summary

Modifier and Type	Field and Description
public static final BCFKSLoadStoreParameter.EncryptionAlgorithm	AES256_CCM
public static final BCFKSLoadStoreParameter.EncryptionAlgorithm	AES256_KWP

Constructor Summary

Access	Constructor and Description
private	EncryptionAlgorithm()

Method Summary

Modifier and Type	Method and Description
public static BCFKSLoadStoreParameter.EncryptionAlgorithm	valueOf(String name)
public static BCFKSLoadStoreParameter.EncryptionAlgorithm[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

AES256_CCM	back to summary
public static final BCFKSLoadStoreParameter.EncryptionAlgorithm AES256_CCM

AES256_KWP	back to summary
public static final BCFKSLoadStoreParameter.EncryptionAlgorithm AES256_KWP

Constructor Detail

EncryptionAlgorithm	back to summary
private EncryptionAlgorithm()

Method Detail

valueOf	back to summary
public static BCFKSLoadStoreParameter.EncryptionAlgorithm valueOf(String name)

values	back to summary
public static BCFKSLoadStoreParameter.EncryptionAlgorithm[] values()

org.bouncycastle.jcajce back to summary

public final Enum BCFKSLoadStoreParameter.MacAlgorithm

Class Inheritance

extends Enum<BCFKSLoadStoreParameter.MacAlgorithm>

java.lang.Object
java.lang.Enum
org.bouncycastle.jcajce.BCFKSLoadStoreParameter.MacAlgorithm

Field Summary

Modifier and Type	Field and Description
public static final BCFKSLoadStoreParameter.MacAlgorithm	HmacSHA3_512
public static final BCFKSLoadStoreParameter.MacAlgorithm	HmacSHA512

Constructor Summary

Access	Constructor and Description
private	MacAlgorithm()

Method Summary

Modifier and Type	Method and Description
public static BCFKSLoadStoreParameter.MacAlgorithm	valueOf(String name)
public static BCFKSLoadStoreParameter.MacAlgorithm[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

HmacSHA3_512	back to summary
public static final BCFKSLoadStoreParameter.MacAlgorithm HmacSHA3_512

HmacSHA512	back to summary
public static final BCFKSLoadStoreParameter.MacAlgorithm HmacSHA512

Constructor Detail

MacAlgorithm	back to summary
private MacAlgorithm()

Method Detail

valueOf	back to summary
public static BCFKSLoadStoreParameter.MacAlgorithm valueOf(String name)

values	back to summary
public static BCFKSLoadStoreParameter.MacAlgorithm[] values()