Package io.quarkus.vertx.http.runtime
Class CertificateConfig
java.lang.Object
io.quarkus.vertx.http.runtime.CertificateConfig
A certificate configuration.
Provide either the certificate and key files or a keystore.
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe CredentialsProvider.The credentials provider bean name.The list of path to server certificates using the PEM format.The list of path to server certificates private key files using the PEM format.An optional keystore that holds the certificate information instead of specifying separate files.An optional parameter to specify the type of the keystore file.An optional parameter to select a specific key in the keystore.An optional parameter to define the password for the key, in case it is different fromkeyStorePassword
If not given, it might be retrieved from CredentialsProvider.A parameter to specify a CredentialsProvider property key, which can be used to get the password for the key from CredentialsProvider.A parameter to specify the password of the keystore file.A parameter to specify a CredentialsProvider property key, which can be used to get the password of the key store file from CredentialsProvider.An optional parameter to specify a provider of the keystore file.An optional parameter to trust a single certificate from the trust store rather than trusting all certificates in the store.An optional trust store that holds the certificate information of the trusted certificates.An optional parameter to specify the type of the trust store file.A parameter to specify the password of the trust store file.A parameter to specify a CredentialsProvider property key, which can be used to get the password of the trust store file from CredentialsProvider.An optional parameter to specify a provider of the trust store file. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
credentialsProvider
@ConfigItem @ConvertWith(io.quarkus.runtime.configuration.TrimmedStringConverter.class) public Optional<String> credentialsProviderThe CredentialsProvider. If this property is configured, then a matching 'CredentialsProvider' will be used to get the keystore, keystore key, and truststore passwords unless these passwords have already been configured. Please note that using MicroProfile ConfigSource which is directly supported by Quarkus Configuration should be preferred unless using `CredentialsProvider` provides for some additional security and dynamism. -
credentialsProviderName
@ConfigItem @ConvertWith(io.quarkus.runtime.configuration.TrimmedStringConverter.class) public Optional<String> credentialsProviderNameThe credentials provider bean name.This is a bean name (as in
@Named
) of a bean that implementsCredentialsProvider
. It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.For Vault, the credentials provider bean name is
vault-credentials-provider
. -
files
The list of path to server certificates using the PEM format. Specifying multiple files requires SNI to be enabled. -
keyFiles
The list of path to server certificates private key files using the PEM format. Specifying multiple files requires SNI to be enabled. The order of the key files must match the order of the certificates. -
keyStoreFile
An optional keystore that holds the certificate information instead of specifying separate files. -
keyStoreFileType
An optional parameter to specify the type of the keystore file. If not given, the type is automatically detected based on the file name. -
keyStoreProvider
An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. -
keyStorePassword
A parameter to specify the password of the keystore file. If not given, and if it can not be retrieved from CredentialsProvider. -
keyStorePasswordKey
A parameter to specify a CredentialsProvider property key, which can be used to get the password of the key store file from CredentialsProvider. -
keyStoreKeyAlias
An optional parameter to select a specific key in the keystore. When SNI is disabled, and the keystore contains multiple keys and no alias is specified; the behavior is undefined. -
keyStoreKeyPassword
An optional parameter to define the password for the key, in case it is different fromkeyStorePassword
If not given, it might be retrieved from CredentialsProvider. -
keyStoreKeyPasswordKey
A parameter to specify a CredentialsProvider property key, which can be used to get the password for the key from CredentialsProvider. -
trustStoreFile
An optional trust store that holds the certificate information of the trusted certificates. -
trustStoreFileType
An optional parameter to specify the type of the trust store file. If not given, the type is automatically detected based on the file name. -
trustStoreProvider
An optional parameter to specify a provider of the trust store file. If not given, the provider is automatically detected based on the trust store file type. -
trustStorePassword
A parameter to specify the password of the trust store file. If not given, it might be retrieved from CredentialsProvider. -
trustStorePasswordKey
A parameter to specify a CredentialsProvider property key, which can be used to get the password of the trust store file from CredentialsProvider. -
trustStoreCertAlias
An optional parameter to trust a single certificate from the trust store rather than trusting all certificates in the store.
-
-
Constructor Details
-
CertificateConfig
public CertificateConfig()
-