XML syntax elements for using a secure connection with SSL

XML syntax elements for using a secure connection with SSL

This topic lists the syntax elements for using the XML command line client with SSL over a secure HTTPS connection.

Syntax element Description
-truststore Use this element to specify the name of the truststore file containing the server certificates required for accepting SSL connections with trusted servers. If no truststore is provided, the XML client will use the default Java cacerts truststore.
-trustpwd Use this element to specify the password required for accessing the truststore. If the default Java cacerts truststore is used, no trust password needs to be provided.
-trusttype Use this element to specify the type of the truststore used. The default type is jks. As long as the used truststore is of type jks, we do not have to provide this parameter.
-keystore Use this element to specify the name of the keystore file containing client certificates required for establishing an SSL connection with a server that requires client certificate authentication. If no keystore is provided, the XML client will use the default Java cacerts keystore.
-keypwd Use this element to specify the password required for accessing the keystore. If the default Java cacerts keystore is used, no key password needs to be provided.
-keytype Use this element to specify the type of the used keystore. The default type is jks. If the used keystore is of type jks, we do not have to provide this parameter.
-protocol Use this element to specify the protocol, for example SSL, SSLv1, SSLv3, or TLS . Note we can select only protocols that WebSphere Application Server supports and has enabled. The parameter is evaluated only if the URL of the xmlaccess servlet selects a secure connection with HTTPs. Otherwise, the parameter is ignored.
See the following examples.

Example 1

The following is an example of how to use xmlaccess.sh to establish an SSL connection with a WebSphere Portal server, using the default certificate stores provided by WebSphere Application Server:
xmlaccess.sh -user wpsadmin -password your_password -url https://portalhost:10035/wps/config/
             -in $PortalHome/doc/xml-samples/ExportAllUsers.xml -out result.xml
             -truststore $WASHome/profiles/wp_profile/etc/trust.p12 -trustpwd WebAS -trusttype PKCS12
For this example to run, use the trusttype parameter with a value of PKCS12 to avoid an invalid file format error.

Example 2

The following is an example of how to use xmlaccess.sh to establish an SSL connection with a WebSphere Portal server, using the dummy certificate stores provided by WebSphere Application Server:
xmlaccess.sh -user wpsadmin -password your_password -url https://portalhost:10035/wps/config/
             -in $PortalHome/doc/xml-samples/ExportAllUsers.xml -out result.xml -truststore $WASHome/profiles/wp_profile/etc/DummyClientTrustFile.jks -trustpwd WebAS
For this example to be able to run, configure the SSL configuration in WebSphere Application Server using the DummyServerKeyFile.jks and the DummyServerTrustFile.jks for secure connections. The option require client authentication must not be active.

Example 3

If the option require client authentication is active, provide a keyfile when establishing the SSL connection with the XML configuration interface:
xmlaccess.sh -user wpsadmin -password yourpassword -url https://portalhost:10035/wps/config/
             -in $PortalHome/doc/xml-samples/ExportAllUsers.xml -out result.xml -truststore $WASHome/profiles/wp_profile/etc/DummyClientTrustFile.jks -trustpwd WebAS -keystore $WASHome/profiles/wp_profile/etc/DummyClientKeyFile.jks -keypwd WebAS
This example allows xmlaccess.sh to send a client certificate to the server, if the server requests one. Using client certificate authentication is required wherever the number of clients that can administer WebSphere Portal needs to be controlled. Only clients with the correct client certificate will be able establish a connection with WebSphere Portal.

Parent XML Syntax for using a secure connection with SSL

Syntax element	Description
-truststore	Use this element to specify the name of the truststore file containing the server certificates required for accepting SSL connections with trusted servers. If no truststore is provided, the XML client will use the default Java cacerts truststore.
-trustpwd	Use this element to specify the password required for accessing the truststore. If the default Java cacerts truststore is used, no trust password needs to be provided.
-trusttype	Use this element to specify the type of the truststore used. The default type is jks. As long as the used truststore is of type jks, we do not have to provide this parameter.
-keystore	Use this element to specify the name of the keystore file containing client certificates required for establishing an SSL connection with a server that requires client certificate authentication. If no keystore is provided, the XML client will use the default Java cacerts keystore.
-keypwd	Use this element to specify the password required for accessing the keystore. If the default Java cacerts keystore is used, no key password needs to be provided.
-keytype	Use this element to specify the type of the used keystore. The default type is jks. If the used keystore is of type jks, we do not have to provide this parameter.
-protocol	Use this element to specify the protocol, for example SSL, SSLv1, SSLv3, or TLS . Note we can select only protocols that WebSphere Application Server supports and has enabled. The parameter is evaluated only if the URL of the xmlaccess servlet selects a secure connection with HTTPs. Otherwise, the parameter is ignored.