1.6. 配置参考

配置属性

类型

default

quarkus.oidc-client.enabled

如果启用了 OIDC 客户端扩展。

环境变量： QUARKUS_OIDC_CLIENT_ENABLED

布尔值

true

quarkus.oidc-client.auth-server-url

quarkus.oidc-client."id".auth-server-url

OpenID Connect (OIDC)服务器的基本 URL，例如 https://host:port/auth。如果您使用 'quarkus-oidc'，且只需要公钥验证(公钥)或证书链验证(certificate-chain)，则不要设置此属性。默认情况下，OIDC 发现端点会在这个 URL 中附加 .well-known/openid-configuration 路径来调用。对于 Keycloak，使用 https://host:port/realms/{realm}，将 {realm} 替换为 Keycloak 域名。

环境变量： QUARKUS_OIDC_CLIENT_AUTH_SERVER_URL

string

quarkus.oidc-client.discovery-enabled

quarkus.oidc-client."id".discovery-enabled

发现 OIDC 端点。如果没有启用，您必须单独配置 OIDC 端点 URL。

环境变量： QUARKUS_OIDC_CLIENT_DISCOVERY_ENABLED

布尔值

true

quarkus.oidc-client.registration-path

quarkus.oidc-client."id".registration-path

OIDC 动态客户端注册端点的相对路径或绝对路径或绝对路径 URL。如果 discovery-enabled 为 false，或必须自定义发现的令牌端点路径。

环境变量： QUARKUS_OIDC_CLIENT_REGISTRATION_PATH

string

quarkus.oidc-client.connection-delay

quarkus.oidc-client."id".connection-delay

尝试初始连接到 OIDC 服务器的持续时间。例如，将持续时间设置为 20S 允许 10 次重试，每 2 秒。此属性仅在创建初始 OIDC 连接时才有效。对于丢弃的连接，请使用 connection-retry-count 属性。

环境变量： QUARKUS_OIDC_CLIENT_CONNECTION_DELAY

duration 

quarkus.oidc-client.connection-retry-count

quarkus.oidc-client."id".connection-retry-count

如果临时丢失，重试重新建立现有 OIDC 连接的次数。与 connection-delay 不同，它只适用于初始连接尝试。例如，如果对 OIDC 令牌端点的请求因为连接问题而失败，它将按此设置重试。

环境变量： QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT

int

3

quarkus.oidc-client.connection-timeout

quarkus.oidc-client."id".connection-timeout

当前 OIDC 连接请求超时的秒数。

环境变量： QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT

duration 

10S

quarkus.oidc-client.use-blocking-dns-lookup

quarkus.oidc-client."id".use-blocking-dns-lookup

是否应该对 worker 线程执行 DNS 查找。当您可以看到由 HTTP 请求到 OIDC 服务器阻止的 Vert.x 事件循环的日志记录警告时，请使用这个选项。

环境变量： QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP

布尔值

false

quarkus.oidc-client.max-pool-size

quarkus.oidc-client."id".max-pool-size

WebClient 使用的连接池的最大大小。

环境变量： QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE

int

quarkus.oidc-client.follow-redirects

quarkus.oidc-client."id".follow-redirects

当 WebClient 获取 HTTP 302 时，自动关注重定向。当此属性只禁用到完全相同原始 URI 的单个重定向时，才允许在重定向请求期间设置了一个或多个 Cookie 时。

环境变量： QUARKUS_OIDC_CLIENT_FOLLOW_REDIRECTS

布尔值

true

quarkus.oidc-client.token-path

quarkus.oidc-client."id".token-path

签发访问和刷新令牌的 OIDC 令牌端点；指定为相对路径或绝对 URL。如果 discovery-enabled 为 false，或必须自定义发现的令牌端点路径。

环境变量： QUARKUS_OIDC_CLIENT_TOKEN_PATH

string

quarkus.oidc-client.revoke-path

quarkus.oidc-client."id".revoke-path

OIDC 令牌撤销端点的相对路径或绝对路径 URL。

环境变量： QUARKUS_OIDC_CLIENT_REVOKE_PATH

string

quarkus.oidc-client.client-id

quarkus.oidc-client."id".client-id

应用程序的客户端 ID。每个应用都有一个客户端 ID，用于标识应用程序。如果 application-type 是 service，且不需要令牌内省，则不需要设置客户端 ID。

环境变量： QUARKUS_OIDC_CLIENT_CLIENT_ID

string

quarkus.oidc-client.client-name

quarkus.oidc-client."id".client-name

应用的客户端名称。它代表应用程序的人类可读描述，您可以在 OpenId Connect 供应商的仪表板中注册应用程序（客户端）时提供。例如，您可以将此属性设置为具有更详细的日志消息，记录给定客户端的活动。

环境变量： QUARKUS_OIDC_CLIENT_CLIENT_NAME

string

quarkus.oidc-client.id

quarkus.oidc-client."id".id

唯一的 OIDC 客户端标识符。它必须在 OIDC 客户端动态创建时设置，并在所有其他情况下是可选的。

环境变量： QUARKUS_OIDC_CLIENT_ID

string

quarkus.oidc-client.client-enabled

quarkus.oidc-client."id".client-enabled

如果启用了此客户端配置。

环境变量： QUARKUS_OIDC_CLIENT_CLIENT_ENABLED

布尔值

true

quarkus.oidc-client.scopes

quarkus.oidc-client."id".scopes

访问令牌范围列表

环境变量： QUARKUS_OIDC_CLIENT_SCOPES

字符串列表

quarkus.oidc-client.refresh-token-time-skew

quarkus.oidc-client."id".refresh-token-time-skew

刷新令牌时间偏移。如果启用了此属性，则配置的持续时间转换为秒，并在检查访问令牌是否应刷新时添加到当前时间。如果总和超过此访问令牌的过期时间，则会进行刷新。

环境变量： QUARKUS_OIDC_CLIENT_REFRESH_TOKEN_TIME_SKEW

duration 

quarkus.oidc-client.access-token-expires-in

quarkus.oidc-client."id".access-token-expires-in

相对于当前时间的访问令牌到期期限。只有在访问令牌授权响应不包括访问令牌到期属性时，才会检查此属性。

环境变量： QUARKUS_OIDC_CLIENT_ACCESS_TOKEN_EXPIRES_IN

duration 

quarkus.oidc-client.access-token-expiry-skew

quarkus.oidc-client."id".access-token-expiry-skew

访问令牌到期时间偏移，可添加到计算的令牌到期时间。

环境变量： QUARKUS_OIDC_CLIENT_ACCESS_TOKEN_EXPIRY_SKEW

duration 

quarkus.oidc-client.absolute-expires-in

quarkus.oidc-client."id".absolute-expires-in

如果访问令牌 'expires_in' 属性应检查为绝对时间值，而不是相对于当前时间的持续时间。

环境变量： QUARKUS_OIDC_CLIENT_ABSOLUTE_EXPIRES_IN

布尔值

false

quarkus.oidc-client.grant.type

quarkus.oidc-client."id".grant.type

授权类型

环境变量： QUARKUS_OIDC_CLIENT_GRANT_TYPE

Client: 'client_credentials' 授权只需要 OIDC 客户端身份验证

Password: 'password' 授权需要 OIDC 客户端和用户('username' 和 'password')身份验证

Code: 'authorization_code' 授权需要 OIDC 客户端身份验证，以及至少 'code' 和 'redirect_uri' 参数，它们必须在令牌请求时传递给 OidcClient。

Exchange: 'urn:ietf:params:oauth:grant-type:token-exchange' 授权需要 OIDC 客户端身份验证，以及至少 'subject_token' 参数，该参数必须在令牌请求时传递给 OidcClient。

JWT: 'urn:ietf:params:oauth:grant-type:jwt-bearer' 授权需要 OIDC 客户端身份验证，以及至少一个 'assertion' 参数，该参数必须在令牌请求时传递给 OidcClient。

refresh: 'refresh_token' 授权需要 OIDC 客户端身份验证和刷新令牌。请注意，如果访问令牌获取响应包含刷新令牌，OidcClient 默认支持此授权。然而，在某些情况下，会提供带外的刷新令牌，例如，它可以在多个机密客户端的服务之间共享，等等。如果 'quarkus.oidc-client.grant-type' 设置为 'refresh'，则 OidcClient 只支持刷新令牌。

ciba: 'urn:openid:params:grant-type:ciba' 授权需要 OIDC 客户端身份验证，以及 'auth_req_id' 参数，该参数必须在令牌请求时传递给 OidcClient。

device: 'urn:ietf:params:oauth:grant-type:device_code' 授权需要 OIDC 客户端身份验证，以及 'device_code' 参数，该参数必须在令牌请求时传递给 OidcClient。

client

quarkus.oidc-client.grant.access-token-property

quarkus.oidc-client."id".grant.access-token-property

令牌授权响应中的访问令牌属性名称

环境变量： QUARKUS_OIDC_CLIENT_GRANT_ACCESS_TOKEN_PROPERTY

string

access_token

quarkus.oidc-client.grant.refresh-token-property

quarkus.oidc-client."id".grant.refresh-token-property

在令牌授权响应中刷新令牌属性名称

环境变量： QUARKUS_OIDC_CLIENT_GRANT_REFRESH_TOKEN_PROPERTY

string

refresh_token

quarkus.oidc-client.grant.expires-in-property

quarkus.oidc-client."id".grant.expires-in-property

令牌授权响应中的访问令牌到期属性名称

环境变量： QUARKUS_OIDC_CLIENT_GRANT_EXPIRES_IN_PROPERTY

string

expires_in

quarkus.oidc-client.grant.refresh-expires-in-property

quarkus.oidc-client."id".grant.refresh-expires-in-property

在令牌授权响应中刷新令牌到期属性名称

环境变量： QUARKUS_OIDC_CLIENT_GRANT_REFRESH_EXPIRES_IN_PROPERTY

string

refresh_expires_in

quarkus.oidc-client.grant-options."grant-name"

quarkus.oidc-client."id".grant-options."grant-name"

授权选项

环境变量： QUARKUS_OIDC_CLIENT_GRANT_OPTIONS__GRANT_NAME_

Map<String,Map<String,String>>

quarkus.oidc-client.early-tokens-acquisition

quarkus.oidc-client."id".early-tokens-acquisition

要求所有使用"OidcClient"的过滤器在后结构初始化时获取令牌，在使用这些令牌之前可能会比较长。如果访问令牌在第一次使用并且没有刷新令牌可用之前过期，则应禁用此属性。

环境变量： QUARKUS_OIDC_CLIENT_EARLY_TOKENS_ACQUISITION

布尔值

true

quarkus.oidc-client.headers."headers"

quarkus.oidc-client."id".headers."headers"

必须发送到令牌端点的自定义 HTTP 标头

环境变量： QUARKUS_OIDC_CLIENT_HEADERS_HEADERS_

Map<String,String>

HTTP 代理配置

类型

default

quarkus.oidc-client.proxy.host

quarkus.oidc-client."id".proxy.host

代理的主机名或 IP 地址。
注： 如果 OIDC 适配器需要代理与 OIDC 服务器(Provider)通信，请将此值设置为以启用代理的使用。

环境变量： QUARKUS_OIDC_CLIENT_PROXY_HOST

string

quarkus.oidc-client.proxy.port

quarkus.oidc-client."id".proxy.port

代理的端口号。默认值为 80。

环境变量： QUARKUS_OIDC_CLIENT_PROXY_PORT

int

80

quarkus.oidc-client.proxy.username

quarkus.oidc-client."id".proxy.username

如果代理需要身份验证，则用户名。

环境变量： QUARKUS_OIDC_CLIENT_PROXY_USERNAME

string

quarkus.oidc-client.proxy.password

quarkus.oidc-client."id".proxy.password

如果代理需要身份验证，则密码。

环境变量： QUARKUS_OIDC_CLIENT_PROXY_PASSWORD

string

TLS 配置

类型

default

quarkus.oidc-client.tls.tls-configuration-name

quarkus.oidc-client."id".tls.tls-configuration-name

要使用的 TLS 配置的名称。

如果配置了名称，它会使用来自 quarkus.tls.<name& gt; configured to name 的配置，但没有找到该名称的 TLS 配置，然后会抛出错误。

默认 TLS 配置 不会被使用。

环境变量： QUARKUS_OIDC_CLIENT_TLS_TLS_CONFIGURATION_NAME

string

OIDC 客户端用来访问 OIDC 令牌和其他安全端点的不同身份验证选项

类型

default

quarkus.oidc-client.credentials.secret

quarkus.oidc-client."id".credentials.secret

client_secret_basic 身份验证方法使用的客户端 secret。必须设置，除非需要在 client-secret 或 jwt 客户端身份验证中设置 secret。您可以使用 client-secret.value，但这两个属性都是互斥的。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_SECRET

string

quarkus.oidc-client.credentials.client-secret.value

quarkus.oidc-client."id".credentials.client-secret.value

客户端机密值。如果设置了 credentials.secret，则忽略这个值。必须设置，除非需要在 client-secret 或 jwt 客户端身份验证中设置 secret。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_CLIENT_SECRET_VALUE

string

quarkus.oidc-client.credentials.client-secret.provider.name

quarkus.oidc-client."id".credentials.client-secret.provider.name

CredentialsProvider bean 名称，只有在注册了多个 CredentialsProvider 时才应设置

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME

string

quarkus.oidc-client.credentials.client-secret.provider.keyring-name

quarkus.oidc-client."id".credentials.client-secret.provider.keyring-name

CredentialsProvider 密钥环名称。只有在使用的 CredentialsProvider 需要密钥环名称来查找 secret 时，才需要密钥环名称，这通常是当一个 CredentialsProvider 被多个扩展共享时，才需要多个扩展从更多动态源（如 vault 实例或 secret manager）检索凭证时。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME

string

quarkus.oidc-client.credentials.client-secret.provider.key

quarkus.oidc-client."id".credentials.client-secret.provider.key

CredentialsProvider 客户端 secret 密钥

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY

string

quarkus.oidc-client.credentials.client-secret.method

quarkus.oidc-client."id".credentials.client-secret.method

身份验证方法。如果设置了 clientSecret.value secret，则此方法默认是 基本的。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_CLIENT_SECRET_METHOD

基本:client_secret_basic （默认）：客户端 ID 和 secret 使用 HTTP 授权基本方案提交。

post:client_secret_post ：客户端 ID 和 secret 作为 client_id 和 client_secret 表单参数提交。

post-jwt:client_secret_jwt: 客户端 ID 和生成的 JWT secret 作为 client_id 和 client_secret 形式参数提交。

query ：客户端 ID 和 secret 作为 HTTP 查询参数提交。这个选项只支持 OIDC 扩展。

quarkus.oidc-client.credentials.jwt.source

quarkus.oidc-client."id".credentials.jwt.source

JWT 令牌源：OIDC 供应商客户端或现有的 JWT bearer 令牌。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_SOURCE

Client: JWT 令牌由 OIDC 供应商客户端生成，以支持 client_secret_jwt 和 private_key_jwt 身份验证方法。

bearer: JWT bearer 令牌用作客户端断言 ：https://www.rfc-editor.org/rfc/rfc7523#section-2.2。

client

quarkus.oidc-client.credentials.jwt.token-path

quarkus.oidc-client."id".credentials.jwt.token-path

具有 JWT bearer 令牌（应用作客户端断言）的文件路径。此路径只能在 JWT 源(source （)）设置为 Source"BEARER 时设置。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_TOKEN_PATH

path

quarkus.oidc-client.credentials.jwt.secret

quarkus.oidc-client."id".credentials.jwt.secret

如果提供，则表示 JWT 使用 secret 密钥进行了签名。它与键 , key -file 和 key-store 属性相互排斥。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_SECRET

string

quarkus.oidc-client.credentials.jwt.secret-provider.name

quarkus.oidc-client."id".credentials.jwt.secret-provider.name

CredentialsProvider bean 名称，只有在注册了多个 CredentialsProvider 时才应设置

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_SECRET_PROVIDER_NAME

string

quarkus.oidc-client.credentials.jwt.secret-provider.keyring-name

quarkus.oidc-client."id".credentials.jwt.secret-provider.keyring-name

CredentialsProvider 密钥环名称。只有在使用的 CredentialsProvider 需要密钥环名称来查找 secret 时，才需要密钥环名称，这通常是当一个 CredentialsProvider 被多个扩展共享时，才需要多个扩展从更多动态源（如 vault 实例或 secret manager）检索凭证时。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME

string

quarkus.oidc-client.credentials.jwt.secret-provider.key

quarkus.oidc-client."id".credentials.jwt.secret-provider.key

CredentialsProvider 客户端 secret 密钥

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_SECRET_PROVIDER_KEY

string

quarkus.oidc-client.credentials.jwt.key

quarkus.oidc-client."id".credentials.jwt.key

私钥的字符串表示。如果提供，则表示 JWT 是使用 PEM 或 JWK 格式的私钥签名的。它与 secret、key-file 和 key-store 属性相互排斥。您可以使用 signature-algorithm 属性覆盖默认的密钥算法 RS256。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_KEY

string

quarkus.oidc-client.credentials.jwt.key-file

quarkus.oidc-client."id".credentials.jwt.key-file

如果提供，则表示 JWT 是使用 PEM 或 JWK 格式的私钥签名的。它与 secret、key 和 key-store 属性相互排斥。您可以使用 signature-algorithm 属性覆盖默认的密钥算法 RS256。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_KEY_FILE

string

quarkus.oidc-client.credentials.jwt.key-store-file

quarkus.oidc-client."id".credentials.jwt.key-store-file

如果提供，则表示 JWT 使用密钥存储中的私钥签名。它与 secret、key 和 key-file 属性相互排斥。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_KEY_STORE_FILE

string

quarkus.oidc-client.credentials.jwt.key-store-password

quarkus.oidc-client."id".credentials.jwt.key-store-password

指定密钥存储文件的密码的参数。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_KEY_STORE_PASSWORD

string

quarkus.oidc-client.credentials.jwt.key-id

quarkus.oidc-client."id".credentials.jwt.key-id

私钥 ID 或别名。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_KEY_ID

string

quarkus.oidc-client.credentials.jwt.key-password

quarkus.oidc-client."id".credentials.jwt.key-password

私钥密码。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_KEY_PASSWORD

string

quarkus.oidc-client.credentials.jwt.audience

quarkus.oidc-client."id".credentials.jwt.audience

JWT 受众(ud)声明值。默认情况下，audience 设置为 OpenId Connect Provider 的令牌端点的地址。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_AUDIENCE

string

quarkus.oidc-client.credentials.jwt.token-key-id

quarkus.oidc-client."id".credentials.jwt.token-key-id

添加为 JWT kid 标头的签名密钥标识符。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_TOKEN_KEY_ID

string

quarkus.oidc-client.credentials.jwt.issuer

quarkus.oidc-client."id".credentials.jwt.issuer

添加为 JWT 的签名密钥的签发者 是s 声明。默认值为客户端 ID。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_ISSUER

string

quarkus.oidc-client.credentials.jwt.subject

quarkus.oidc-client."id".credentials.jwt.subject

添加为 JWT 子 声明的签名密钥的主题。默认值是客户端 ID。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_SUBJECT

string

quarkus.oidc-client.credentials.jwt.claims."claim-name"

quarkus.oidc-client."id".credentials.jwt.claims."claim-name"

其他声明.

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_

Map<String,String>

quarkus.oidc-client.credentials.jwt.signature-algorithm

quarkus.oidc-client."id".credentials.jwt.signature-algorithm

用于 key-file 属性的签名算法。支持的值有： RS256 （默认）、RS384、RS512、PS256、PS384、PS512、ES256、ES256、ES384、ES512、ES512、ES512、ESS256、HS384、HS512.

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_SIGNATURE_ALGORITHM

string

quarkus.oidc-client.credentials.jwt.lifespan

quarkus.oidc-client."id".credentials.jwt.lifespan

JWT 生命周期（以秒为单位）。这个值添加到发出 JWT 的时间，以计算过期时间。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_LIFESPAN

int

10

quarkus.oidc-client.credentials.jwt.assertion

quarkus.oidc-client."id".credentials.jwt.assertion

如果为 true，则客户端身份验证令牌是 JWT bearer 授权断言。不生成 'client_assertion' 和 'client_assertion_type' 表单属性，而是只生成 'assertion'。这个选项只支持 OIDC 客户端扩展。

环境变量： QUARKUS_OIDC_CLIENT_CREDENTIALS_JWT_ASSERTION

布尔值

false

配置属性

类型

default

quarkus.rest-client-oidc-token-propagation.enabled

如果启用了 OIDC Token Reactive Propagation。

环境变量： QUARKUS_REST_CLIENT_OIDC_TOKEN_PROPAGATION_ENABLED

布尔值

true

quarkus.rest-client-oidc-token-propagation.enabled-during-authentication

在 SecurityIdentity 增强过程中是否启用令牌传播。

例如，您可能需要使用 SecurityIdentityAugmentor 中的 REST 客户端传播当前令牌，以获取 SecurityIdentity 的额外角色。

请注意，这个功能依赖于重复的上下文。有关 Vert.x 重复上下文的更多信息，请参阅本指南。

环境变量： QUARKUS_REST_CLIENT_OIDC_TOKEN_PROPAGATION_ENABLED_DURING_AUTHENTICATION

布尔值

false

quarkus.rest-client-oidc-token-propagation.exchange-token

使用 "urn:ietf:params:oauth:grant-type:token-exchange" 或 "urn:ietf:params:oauth:grant-type:jwt-bearer" 令牌授权来交换新令牌的当前令牌。

环境变量： QUARKUS_REST_CLIENT_OIDC_TOKEN_PROPAGATION_EXCHANGE_TOKEN

布尔值

false

quarkus.rest-client-oidc-token-propagation.client-name

配置的 OidcClient 的名称。请注意，只有在启用 exchangeToken 属性时，才会使用此属性。

环境变量： QUARKUS_REST_CLIENT_OIDC_TOKEN_PROPAGATION_CLIENT_NAME

string