WFLY-11697 WS integration with WildFly Elytron - AuthenticationClient for Authentication / SSL
WildFly Elytron uses the Elytron Client project to enable remote clients to authenticate using Elytron. Elytron client is already used by other WildFly clients allowing for both use of an Elytron API and pre-defined configurations in the xml file (wildfly-config.xml).
This requested feature is about making use of Elytron’s configuration on the client side of WS deployment so that the WS client supports the common framework available within the application server.
The implementation will involve updating Elytron client configuration with additional settings that will specify the policy (mechanisms) the webservices client will use to authenticate with the server.
The implementation will involve loading of this authentication configuration from Elytron client, specifically credentials, mechanisms and SSL context, and making those available to the Webservices client.
This RFE seeks to make use of Elytron configuration for the following methods of authentication:
HTTP Basic authentication
Username Token Profile (message level security, adds credentials to SOAP header)
Elytron client configuration can have credentials and SSL context specified based on URL. Additional configuration to specify what methods of authentication the client wants to use to authenticate with the server must be added. It is important that these additions are in the format that won’t clash with future client integrations (eg. planned RESTEasy client integration).
WS client will make use of Elytron to obtain the credentials along with the method of authentication to use them for (Username Token Profile or HTTP Basic auth or both), and SSLContext by default (if this configuration is present and Elytron is on the classpath). This means the user will not be prompted for credentials or to accept server certificates if this configuration is present in wildfly-config.xml (or is provided in the client’s code by using Elytron API).
Any existing configuration the client already had configured must not be re-written. Configuration specified by user in default WS client descriptor within the application (jaxws-client-config.xml) has precedence.
This RFE deals only with HTTP authentication. It ignores configuration settings from Elytron that are specified for SASL.
Elytron client configuration additions
Additional settings in Elytron client configuration will be added. These will specify whether the credentials should be used with HTTP BASIC auth, Username Token Profile, or both. HTTP BASIC auth mechanism is considered as default. These additions must be in format that won’t clash with RESTEasy client (or other clients) integration in the future.
Since Username Token Profile is used only with webservices I propose this setting should be specified under new
Setting for BASIC HTTP auth mechanism is shared with RESTEasy client.
But since RESTEasy client will have additional HTTP mechanisms allowed in this tag (webservices will currently allow only BASIC), this setting will be placed under
webservices tag as well.
Below is the example setting:
<webservices> <ws-security type="UsernameToken"> <set-http-mechanism name="BASIC"/> </webservices>
WS-Security is a SOAP message security standard where Username Token Profile is specified.
UsernameToken will be the only value allowed in this tag. In the future, additional
ws-security types could be added. The same goes for HTTP mechanism - BASIC will be the only allowed value for now and in the future additional HTTP mechanisms could be added.
It is not part of this RFE to implement client side of HTTP mechanisms. WS client will only use Elytron client to obtain the credentials, mechanisms and TLS configuration to use for its calls. All requests and authentication calls will be handled by the WS stack as is.
Additional SPI will be defined in jbossws-spi repository that Elytron will implement. It will provide methods to obtain credentials and SSL context.
Elytron provider will be loaded during the building and configuration of the client. The credentials and SSLContext will be set only if it is missing.
JBoss Web Services are integrated with Apache CXF. Apache CXF provides methods for setting of TLS parameters and authentication policies that will be used.
Elytron client configuration will be updated to include new settings for
Functionality tests in WebServices testsuite.