Skip to content

Commit 517bc7c

Browse files
committed
Polish gh-18614
1 parent a2d4075 commit 517bc7c

1 file changed

Lines changed: 18 additions & 19 deletions

File tree

docs/modules/ROOT/pages/servlet/oauth2/authorization-server/core-model-components.adoc

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -95,37 +95,36 @@ public class RegisteredClient implements Serializable {
9595
[[oauth2AuthorizationServer-client-settings]]
9696
== ClientSettings
9797

98-
`ClientSettings` contains configuration for the `RegisteredClient`. The following example shows the available settings:
98+
`ClientSettings` contains the configuration settings associated to a `RegisteredClient`.
99+
100+
`ClientSettings` provides the following accessors:
99101

100102
[source,java]
101103
----
102104
public final class ClientSettings extends AbstractSettings {
103105
104-
...
106+
public boolean isRequireProofKey() ... <1>
107+
108+
public boolean isRequireAuthorizationConsent() ... <2>
105109
106-
public static Builder builder() {
107-
return new Builder()
108-
.requireProofKey(true) <1>
109-
.requireAuthorizationConsent(false) <2>
110-
.jwkSetUrl("https://client.example.com/jwks") <3>
111-
.tokenEndpointAuthenticationSigningAlgorithm(MacAlgorithm.HS256) <4>
112-
.x509CertificateSubjectDN("CN=demo-client-sample, OU=Spring Samples, O=Spring, C=US"); <5>
113-
}
110+
public String getJwkSetUrl() ... <3>
111+
112+
public JwsAlgorithm getTokenEndpointAuthenticationSigningAlgorithm() ... <4>
113+
114+
public String getX509CertificateSubjectDN() ... <5>
114115
115116
...
116117
117-
}
118+
}
118119
----
119-
<1> `requireProofKey`: If `true`, the client is required to provide a proof key challenge and verifier when performing the Authorization Code Grant flow (PKCE). The default is `true`.
120-
<2> `requireAuthorizationConsent`: If `true`, authorization consent is required when the client requests access. The default is `false`.
121-
<3> `jwkSetUrl`: Sets the the URL for the client's JSON Web Key Set. Used for `client_secret_jwt` and `private_key_jwt` client authentication methods, as well as for Self-Signed Certificate Mutual-TLS.
122-
<4> `tokenEndpointAuthenticationSigningAlgorithm`: The `JwsAlgorithm` that must be used for signing the JWT used to authenticate the client at the Token Endpoint for `private_key_jwt` and `client_secret_jwt` authentication methods.
123-
<5> `x509CertificateSubjectDN`: The expected subject distinguished name in the client X509Certificate received during client authentication when using the `tls_client_auth` method.
120+
<1> `isRequireProofKey()`: If `true`, the client is required to provide a proof key challenge and verifier when performing the Authorization Code Grant flow (PKCE). The default is `true`.
121+
<2> `isRequireAuthorizationConsent()`: If `true`, authorization consent is required when the client requests access. The default is `false`.
122+
<3> `getJwkSetUrl()`: The `URL` for the client's JSON Web Key Set. Used for `private_key_jwt`, `self_signed_tls_client_auth` and `client_secret_jwt` client authentication methods.
123+
<4> `getTokenEndpointAuthenticationSigningAlgorithm()`: The `JwsAlgorithm` that must be used for signing the JWT used to authenticate the client at the Token Endpoint for `private_key_jwt` and `client_secret_jwt` authentication methods.
124+
<5> `getX509CertificateSubjectDN()`: The expected subject distinguished name associated to the client `X509Certificate` received during client authentication when using the `tls_client_auth` method.
124125

125126
[NOTE]
126-
====
127-
https://datatracker.ietf.org/doc/html/rfc7636[Proof Key for Code Exchange (PKCE)] is enabled by default for all clients using the Authorization Code grant. To disable PKCE, set `requireProofKey` to `false`
128-
====
127+
https://datatracker.ietf.org/doc/html/rfc7636[Proof Key for Code Exchange (PKCE)] is enabled by default for all clients using the Authorization Code grant. To disable PKCE, set `requireProofKey` to `false`.
129128

130129
[[oauth2AuthorizationServer-registered-client-repository]]
131130
== RegisteredClientRepository

0 commit comments

Comments
 (0)