config.io_helidon_security_providers_httpsign_InboundClientDefinition.adoc Maven / Gradle / Ivy
///////////////////////////////////////////////////////////////////////////////
Copyright (c) 2024 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.security.providers.httpsign.InboundClientDefinition
:keywords: helidon, config, io.helidon.security.providers.httpsign.InboundClientDefinition
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.security.providers.httpsign.InboundClientDefinition
include::{rootdir}/includes/attributes.adoc[]
= InboundClientDefinition (security.providers.httpsign) Configuration
// tag::config[]
Type: link:{javadoc-base-url}/io.helidon.security.providers.httpsign/io/helidon/security/providers/httpsign/InboundClientDefinition.html[io.helidon.security.providers.httpsign.InboundClientDefinition]
== Configuration options
.Optional configuration options
[cols="3,3a,2,5a"]
|===
|key |type |default value |description
|`algorithm` |string |{nbsp} |Algorithm of signature used by this client.
Currently supported:
- rsa-sha256 - asymmetric based on public/private keys
- hmac-sha256 - symmetric based on a shared secret
|`hmac.secret` |string |{nbsp} |Helper method to configure a password-like secret (instead of byte based hmacSecret(byte[]).
The password is transformed to bytes with StandardCharsets.UTF_8 charset.
|`key-id` |string |{nbsp} |The key id of this client to map to this signature validation configuration.
|`principal-name` |string |{nbsp} |The principal name of the client, defaults to keyId if not configured.
|`principal-type` |SubjectType (USER, SERVICE) |`SERVICE` |The type of principal we have authenticated (either user or service, defaults to service).
|`public-key` |xref:{rootdir}/config/io_helidon_common_pki_Keys.adoc[Keys] |{nbsp} |For algorithms based on public/private key (such as rsa-sha256), this provides access to the public key of the client.
|===
// end::config[]