WSO2 Message Broker provides support to send/receive messages via secured connections using the SSL/TLS protocol. The following instructions describe how to configure the MB server and JMS clients to communicate via encrypted connections using SSL.
Enabling SSL in the broker
To enable SSL inthe server side, change the following entries in the <MB_HOME>/repository/conf/broker.xml file under the relevant transport (AMQP or MQTT). See Configuring Transports for WSO2 MB for more information on the available transports.
<sslConnection enabled="true" port="">
<keyStore>
<location>repository/resources/security/wso2carbon.jks</location>
<password>wso2carbon</password>
<certType>SunX509</certType>
</keyStore>
<trustStore>
<location>repository/resources/security/client-truststore.jks</location>
<password>wso2carbon</password>
<certType>SunX509</certType>
</trustStore>
</sslConnection>
The parameters in the above configuration are as follows.
| Parameter | Description |
|---|---|
| SSL Connection | This contains the basic configurations relating to the SSL connection. Setting the
|
| Location | The location where the keystore/truststore used for securing SSL connections is stored. By defaultthis is the default keystore( Note that these (keystore and truststore) should always created for the super tenant. Find out more about setting up keystores for your MB server. |
| Password | The password of the keystore/truststore. |
| Certification Type | The type of SSL certificate used for the keystore/truststore. |
Configuring JMS Clients to use SSL
SSL parameters are configured and sent to the broker as broker options in the TCPConnectionURL defined by the client. You need to set the 'ssl=true' property in theurl and specify thekeystore and client trust store paths and passwords. Use the connectionurl format shown below to pass the SSL parameters:
String connectionURL = "amqp://<USERNAME>:<PASSWORD>@carbon/carbon?brokerlist='tcp://<IP>:<SSL_POR T>?ssl='true'&ssl_cert_alias='<CERTIFICATE_ALIAS_IN_TRUSTSTORE>'&trust_store=' <PATH_TO_TRUST_STORE>'&trust_store_password='<TRUSTSTORE_PASSWORD>'& key_store='<PATH_TO_KEY_STORE>'&key_store_password='<KEYSTORE_PASSWOR D>''";
Setting the 'ssl_cert_alias' property is not mandatory and can be used as an optional way to specify which certificate the broker should use if the trust store contains multiple entries.
Example: Consider that you have WSO2 Enterprise Service Bus (WSO2 ESB) as the JMS client. Shown below is an example connectionurl using the defaultkeystores and trust stores in WSO2 ESB:
String connectionUrl = "amqp://admin:admin@carbon/carbon?brokerlist='tcp://localhost:8672?ssl='true'&ssl_cert_alias='RootCA'&trust_store='{ESB_HOME}/repository/resources/security/client-truststore.jks'&trust_store_password='wso2carbon'&key_store='{ESB_HOME}/repository/resources/security/wso2carbon.jks'&key_store_password='wso2carbon''";
When you configure WSO2 ESB to communicate with the broker (WSO2 MB) using SSL, the SSL url should be configured in the jndi.properties file for WSO2 ESB (stored in the <ESB_HOME>/repository/conf directory). Go to this link for detailed instructions on how WSO2 ESB integrates with WSO2 MB.
Configuring JMS Clients for Failover with SSL
For example, if you have configured a WSO2 Message Broker cluster, you might need to configure failover. If those broker nodes have different certs in place, when configuring a failover connection url at the client side, you can individually specify a client trust store and a keystore for each broker in the broker list. Or else, you can import the certs of all brokers in the cluster to a single trust store with different cert aliases and differentiate the cert to use when failing over by the alias.