config.io_helidon_common_pki_PemKeys.adoc Maven / Gradle / Ivy

Go to download
///////////////////////////////////////////////////////////////////////////////

    Copyright (c) 2023 Oracle and/or its affiliates.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

///////////////////////////////////////////////////////////////////////////////

ifndef::rootdir[:rootdir: {docdir}/..]
:description: Configuration of io.helidon.common.pki.PemKeys
:keywords: helidon, config, io.helidon.common.pki.PemKeys
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.common.pki.PemKeys
include::{rootdir}/includes/attributes.adoc[]

= PemKeys (common.pki) Configuration

// tag::config[]


Type: link:{javadoc-base-url}/io.helidon.common.pki/io/helidon/common/pki/PemKeys.html[io.helidon.common.pki.PemKeys]




== Configuration options



.Optional configuration options
[cols="3,3a,2,5a"]

|===
|key |type |default value |description

|`cert-chain.resource` |xref:{rootdir}/config/io_helidon_common_configurable_Resource.adoc[Resource] |{nbsp} |Load certificate chain from PEM resource.

 @return resource (e.g. classpath, file path, URL etc.)
|`certificates.resource` |xref:{rootdir}/config/io_helidon_common_configurable_Resource.adoc[Resource] |{nbsp} |Read one or more certificates in PEM format from a resource definition. Used eg: in a trust store.

 @return key resource (file, classpath, URL etc.)
|`key.passphrase` |char[] |{nbsp} |Passphrase for private key. If the key is encrypted (and in PEM PKCS#8 format), this passphrase will be used to
 decrypt it.

 @return passphrase used to encrypt the private key
|`key.resource` |xref:{rootdir}/config/io_helidon_common_configurable_Resource.adoc[Resource] |{nbsp} |Read a private key from PEM format from a resource definition.

 @return key resource (file, classpath, URL etc.)
|`public-key.resource` |xref:{rootdir}/config/io_helidon_common_configurable_Resource.adoc[Resource] |{nbsp} |Read a public key from PEM format from a resource definition.

 @return public key resource (file, classpath, URL etc.)

|===

// end::config[]