Updated Client configuration (markdown)

master
Justin Richer 2013-08-22 11:34:15 -07:00
parent b488789415
commit 673239c886
1 changed files with 25 additions and 1 deletions

@ -54,17 +54,21 @@ There is one filter class `org.mitre.openid.connect.client.OIDCAuthenticationFil
<property name="issuerService"> <property name="issuerService">
... ...
</property> </property>
<property name="authRequestOptionsService">
...
</property>
<property name="authRequestUrlBuilder"> <property name="authRequestUrlBuilder">
... ...
</property> </property>
</bean> </bean>
``` ```
It is configurable for use in different modes through the use of four different properties that can be wired through different beans as described below: It is configurable for use in different modes through the use of different properties that can be wired through different beans as described below:
* `issuerService`: Determines which OpenID Connect Issuer (server) to connect to * `issuerService`: Determines which OpenID Connect Issuer (server) to connect to
* `serverConfigurationService`: Provides the configuration parameters of each OpenID Connect Issuer * `serverConfigurationService`: Provides the configuration parameters of each OpenID Connect Issuer
* `clientConfigurationService`: Provides the configuration parameters for this client to connect to each OpenID Connect Issuer * `clientConfigurationService`: Provides the configuration parameters for this client to connect to each OpenID Connect Issuer
* `authRequestOptionsService`: Provides a set of optional parameter values to be sent to the authorization endpoint
* `authRequestUrlBuilder`: Crafts the URL used to redirect the user to the OpenID Connect server * `authRequestUrlBuilder`: Crafts the URL used to redirect the user to the OpenID Connect server
### Validator ### Validator
@ -361,6 +365,26 @@ Combines a static client configuration service with a dynamically registered one
</bean> </bean>
``` ```
## Authorization Request Options Service
This optional service returns a `Map<String, String>` of parameters and values to add to the request to be sent to the authorization endpoint. These parameters and values may be contextually sensitive to the `serverConfig`, `clientConfig`, and/or the HTTP servlet `request`.
### Static Authorization Request Options Service
This service will return the same Map of options regardless of the context of the client, server, or request. It is configured by passing in a map of options and their values:
```
<bean class="org.mitre.openid.connect.client.service.impl.StaticAuthRequestOptionsService">
<property name="options">
<map>
<entry key="display" value="page" />
<entry key="prompt" value="consent" />
</map>
</property>
</bean>
```
If no options service is configured, a static authorization request options service with an empty map is provided automatically.
## Authorization Request URL Builder ## Authorization Request URL Builder