how-do-i-use-the-ssl-transport.html - activemq-web - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!--

     Licensed to the Apache Software Foundation (ASF) under one or more
     contributor license agreements.  See the NOTICE file distributed with
     this work for additional information regarding copyright ownership.
     The ASF licenses this file to You under the Apache License, Version 2.0
     (the "License"); you may not use this file except in compliance with
     the License.  You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
     limitations under the License.
 -->
 <html>
 <head>
     <link href="http://activemq.apache.org/styles/site.css" rel="stylesheet" type="text/css"/>
     <link href="http://activemq.apache.org/styles/type-settings.css" rel="stylesheet" type="text/css"/>
     <script src="http://activemq.apache.org/styles/prototype.js" type="text/javascript"></script>
     <script src="http://activemq.apache.org/styles/rico.js" type="text/javascript"></script>
     <script src="http://activemq.apache.org/styles/site.js" type="text/javascript"></script>
     <style type="text/css">
       .maincontent { overflow:hidden; }
     </style>
     <!--[if IE]>
     <style type="text/css">
       .maincontent { width:100%; }
     </style>
     <![endif]-->


     <title>
     Apache ActiveMQ &#8482; -- How do I use the SSL Transport
     </title>
 </head>
 <body>
 <div class="white_box">
 <div class="header">
   <div class="header_l">
     <div class="header_r">
     </div>
   </div>
 </div>
 <div class="content">
   <div class="content_l">
     <div class="content_r">
       <div>

 <!-- Banner -->
 <p>
 	</p><div id="asf_logo">
 	<div id="activemq_logo">
             <a shape="rect" style="float:left; width:280px;display:block;text-indent:-5000px;text-decoration:none;line-height:60px; margin-top:10px; margin-left:100px;" href="http://activemq.apache.org/">ActiveMQ</a>
             <a shape="rect" style="float:right; width:210px;display:block;text-indent:-5000px;text-decoration:none;line-height:60px; margin-top:15px; margin-right:10px;" href="http://www.apache.org">ASF</a>
 	</div>
         </div>
 <p></p>
         <div class="top_red_bar">
           <div id="site-breadcrumbs">
 <a href="index.html">Index</a>&nbsp;&gt;&nbsp;<a href="community.html">Community</a>&nbsp;&gt;&nbsp;<a href="faq.html">FAQ</a>&nbsp;&gt;&nbsp;<a href="activemq-cpp-usage-faqs.html">ActiveMQ-CPP Usage FAQs</a>&nbsp;&gt;&nbsp;<a href="how-do-i-use-the-ssl-transport.html">How do I use the SSL Transport</a>
           </div>
           <div id="site-quicklinks">
 <p><a shape="rect" href="download.html">Download</a> | <a shape="rect" href="api.html">API</a> | <a shape="rect" href="source.html">Source</a> | <a shape="rect" class="external-link" href="http://activemq.apache.org/discussion-forums.html">Forums</a> | <a shape="rect" href="support.html">Support</a></p>
           </div>
         </div>

   <table border="0">
   <tbody>
         <tr>
         <td valign="top" width="100%">
 <div class="wiki-content maincontent"><p>The first thing you need to do in order to use the SSL Transport in ActiveMQ-CPP is to build the library with SSL support enabled, for that see the <a shape="rect" href="building-faqs.html">Build FAQs</a>.</p>

 <p>Once you have a build that supports the SSL protocol then its pretty simple, just replace the use of the <em>TCP</em> Transport in your connection URI with SSL, for example:  </p>

 <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
 <pre>tcp://broker1:61616
 </pre>
 </div></div>

 <p>becomes:</p>

 <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
 <pre>ssl://broker1:61616
 </pre>
 </div></div>

 <p>You should note that in order to validate that the certificate that the broker sends is the one we want we must validate the "Common Name (CN)" field from the certificate against the host-name in the URI.  If you have trouble connecting to the broker one of the first things to check it if your host-name matches the broker certificate common name.</p>

 <p>That's almost it, there's just a couple other things you need might need to do.  The SSL transport needs to know whether or not to trust the certificate that the Broker sends to it, for this you need to set a property in the Decaf library (this is the native library ActiveMQ-CPP uses for cross platform support).  The property you set tells the library where to find either the Broker's Certificate or the Certificate of the Authority that signed the broker's certificate.  If you are using the Failover Transport (which you should be) in conjunction with the SSL Transport then its best to set the property to point to the certificate that signed all your broker's certificates.  Here's what the code looks like:</p>

 <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
 <pre>
 #include &lt;decaf/lang/System.h&gt;

 ...

 decaf::lang::System::setProperty( "decaf.net.ssl.trustStore", "&lt;path to Certificate file&gt;/certificate.pem" );

 </pre>
 </div></div>

 <p>One thing to note here is that since we are using OpenSSL as our SSL Engine the Certificate needs to be in PEM format.</p></div>
         </td>
         <td valign="top">
           <div class="navigation">
             <div class="navigation_top">
               <div class="navigation_bottom">
 <h3 id="Navigation-Overview"><a shape="rect" href="index.html">Overview</a></h3>

 <ul class="alternate"><li><a shape="rect" href="index.html">Index</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="api.html">API</a></li><li><a shape="rect" href="faq.html">FAQ</a></li><li><a shape="rect" href="download.html">Download</a></li></ul>


 <h3 id="Navigation-Connectivityhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=51964"><a shape="rect" href="connectivity.html">Connectivity</a></h3>

 <ul class="alternate"><li><a shape="rect" href="stomp-support.html">Stomp</a></li><li><a shape="rect" href="openwire-support.html">OpenWire</a></li></ul>


 <h3 id="Navigation-UsingActiveMQ-CPPhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=51968"><a shape="rect" href="using-activemq-cpp.html">Using ActiveMQ-CPP</a></h3>

 <ul class="alternate"><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="cms-api-overview.html">CMS API Overview</a></li><li><a shape="rect" href="example.html">Example</a></li><li><a shape="rect" href="configuring.html">Configuring</a></li></ul>


 <h3 id="Navigation-Search">Search</h3>

 <p></p><p>
 </p><div>
 <form enctype="application/x-www-form-urlencoded" method="get" action="http://www.google.com/search" style="font-size: 10px;">
 <input type="hidden" name="ie" value="UTF-8">
 <input type="hidden" name="oe" value="UTF-8">
   <input maxlength="255" type="text" name="q" size="15" value="value"><br clear="none">
   <input type="submit" name="btnG" value="Search">
   <input type="hidden" name="domains" value="activemq.apache.org">
   <input type="hidden" name="sitesearch" value="activemq.apache.org">
 </form>
 </div>
 <p></p>

 <h3 id="Navigation-Communityhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=45948"><a shape="rect" href="community.html">Community</a></h3>

 <ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" class="external-link" href="http://activemq.apache.org/contributing.html">Contributing</a></li><li><a shape="rect" class="external-link" href="http://activemq.apache.org/discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" class="external-link" href="http://activemq.apache.org/mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" class="external-link" href="irc://irc.codehaus.org/activemq" rel="nofollow">IRC</a></li><li><a shape="rect" class="external-link" href="http://servlet.uwyn.com/drone/log/hausbot/activemq" rel="nofollow">IRC Log</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" class="external-link" href="http://activemq.apache.org/team.html">Team</a></li></ul>


 <h3 id="Navigation-Developershttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=45950"><a shape="rect" href="developers.html">Developers</a></h3>

 <ul class="alternate"><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="building.html">Building</a></li><li><a shape="rect" href="creating-distributions.html">Creating Distributions</a></li></ul>
               </div>
             </div>
           </div>
         </td>
         </tr>
   </tbody>
         </table>
         <div class="bottom_red_bar"></div>
       </div>
     </div>
   </div>
 </div>
 <div class="black_box">
 <div class="footer">
   <div class="footer_l">
     <div class="footer_r">
       <div>
         <a href="http://activemq.apache.org/privacy-policy.html">Privacy Policy</a> -
         (<a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=21792569">edit this page</a>)
       </div>
     </div>
   </div>
 </div>
 </div>
 </div>
 <div class="design_attribution">
 &copy; 2004-2011 The Apache Software Foundation.
 <br/>
 Apache ActiveMQ, ActiveMQ, Apache, the Apache feather logo, and the Apache ActiveMQ project logo are trademarks of The Apache Software Foundation.  All other marks mentioned may be trademarks or registered trademarks of their respective owners.
 <br/>
 <a href="http://hiramchirino.com">Graphic Design By Hiram</a>
 </div>

 <!-- delay the loading of large javascript files to the end so that they don't interfere with the loading of page content -->
 <span style="display: none">
   <script type="text/javascript">
     var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
     document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
   </script>
   <script type="text/javascript">
     var pageTracker = _gat._getTracker("UA-1347593-1");
     pageTracker._initData();
     pageTracker._trackPageview();
   </script>
 </span>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!--

	Licensed to the Apache Software Foundation (ASF) under one or more
	contributor license agreements. See the NOTICE file distributed with
	this work for additional information regarding copyright ownership.
	The ASF licenses this file to You under the Apache License, Version 2.0
	(the "License"); you may not use this file except in compliance with
	the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
	-->
	<html>
	<head>
	<link href="http://activemq.apache.org/styles/site.css" rel="stylesheet" type="text/css"/>
	<link href="http://activemq.apache.org/styles/type-settings.css" rel="stylesheet" type="text/css"/>
	<script src="http://activemq.apache.org/styles/prototype.js" type="text/javascript"></script>
	<script src="http://activemq.apache.org/styles/rico.js" type="text/javascript"></script>
	<script src="http://activemq.apache.org/styles/site.js" type="text/javascript"></script>
	<style type="text/css">
	.maincontent { overflow:hidden; }
	</style>
	<!--[if IE]>
	<style type="text/css">
	.maincontent { width:100%; }
	</style>
	<![endif]-->


	<title>
	Apache ActiveMQ ™ -- How do I use the SSL Transport
	</title>
	</head>
	<body>
	<div class="white_box">
	<div class="header">
	<div class="header_l">
	<div class="header_r">
	</div>
	</div>
	</div>
	<div class="content">
	<div class="content_l">
	<div class="content_r">
	<div>

	<!-- Banner -->
	<p>
	</p><div id="asf_logo">
	<div id="activemq_logo">
	<a shape="rect" style="float:left; width:280px;display:block;text-indent:-5000px;text-decoration:none;line-height:60px; margin-top:10px; margin-left:100px;" href="http://activemq.apache.org/">ActiveMQ</a>
	<a shape="rect" style="float:right; width:210px;display:block;text-indent:-5000px;text-decoration:none;line-height:60px; margin-top:15px; margin-right:10px;" href="http://www.apache.org">ASF</a>
	</div>
	</div>
	<p></p>
	<div class="top_red_bar">
	<div id="site-breadcrumbs">
	<a href="index.html">Index</a> > <a href="community.html">Community</a> > <a href="faq.html">FAQ</a> > <a href="activemq-cpp-usage-faqs.html">ActiveMQ-CPP Usage FAQs</a> > <a href="how-do-i-use-the-ssl-transport.html">How do I use the SSL Transport</a>
	</div>
	<div id="site-quicklinks">
	<p><a shape="rect" href="download.html">Download</a> \| <a shape="rect" href="api.html">API</a> \| <a shape="rect" href="source.html">Source</a> \| <a shape="rect" class="external-link" href="http://activemq.apache.org/discussion-forums.html">Forums</a> \| <a shape="rect" href="support.html">Support</a></p>
	</div>
	</div>

	<table border="0">
	<tbody>
	<tr>
	<td valign="top" width="100%">
	<div class="wiki-content maincontent"><p>The first thing you need to do in order to use the SSL Transport in ActiveMQ-CPP is to build the library with SSL support enabled, for that see the <a shape="rect" href="building-faqs.html">Build FAQs</a>.</p>

	<p>Once you have a build that supports the SSL protocol then its pretty simple, just replace the use of the <em>TCP</em> Transport in your connection URI with SSL, for example: </p>

	<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
	<pre>tcp://broker1:61616
	</pre>
	</div></div>

	<p>becomes:</p>

	<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
	<pre>ssl://broker1:61616
	</pre>
	</div></div>

	<p>You should note that in order to validate that the certificate that the broker sends is the one we want we must validate the "Common Name (CN)" field from the certificate against the host-name in the URI. If you have trouble connecting to the broker one of the first things to check it if your host-name matches the broker certificate common name.</p>

	<p>That's almost it, there's just a couple other things you need might need to do. The SSL transport needs to know whether or not to trust the certificate that the Broker sends to it, for this you need to set a property in the Decaf library (this is the native library ActiveMQ-CPP uses for cross platform support). The property you set tells the library where to find either the Broker's Certificate or the Certificate of the Authority that signed the broker's certificate. If you are using the Failover Transport (which you should be) in conjunction with the SSL Transport then its best to set the property to point to the certificate that signed all your broker's certificates. Here's what the code looks like:</p>

	<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
	<pre>
	#include <decaf/lang/System.h>

	...

	decaf::lang::System::setProperty( "decaf.net.ssl.trustStore", "<path to Certificate file>/certificate.pem" );

	</pre>
	</div></div>

	<p>One thing to note here is that since we are using OpenSSL as our SSL Engine the Certificate needs to be in PEM format.</p></div>
	</td>
	<td valign="top">
	<div class="navigation">
	<div class="navigation_top">
	<div class="navigation_bottom">
	<h3 id="Navigation-Overview"><a shape="rect" href="index.html">Overview</a></h3>

	<ul class="alternate"><li><a shape="rect" href="index.html">Index</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="api.html">API</a></li><li><a shape="rect" href="faq.html">FAQ</a></li><li><a shape="rect" href="download.html">Download</a></li></ul>


	<h3 id="Navigation-Connectivityhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=51964"><a shape="rect" href="connectivity.html">Connectivity</a></h3>

	<ul class="alternate"><li><a shape="rect" href="stomp-support.html">Stomp</a></li><li><a shape="rect" href="openwire-support.html">OpenWire</a></li></ul>


	<h3 id="Navigation-UsingActiveMQ-CPPhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=51968"><a shape="rect" href="using-activemq-cpp.html">Using ActiveMQ-CPP</a></h3>

	<ul class="alternate"><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="cms-api-overview.html">CMS API Overview</a></li><li><a shape="rect" href="example.html">Example</a></li><li><a shape="rect" href="configuring.html">Configuring</a></li></ul>


	<h3 id="Navigation-Search">Search</h3>

	<p></p><p>
	</p><div>
	<form enctype="application/x-www-form-urlencoded" method="get" action="http://www.google.com/search" style="font-size: 10px;">
	<input type="hidden" name="ie" value="UTF-8">
	<input type="hidden" name="oe" value="UTF-8">
	<input maxlength="255" type="text" name="q" size="15" value="value"><br clear="none">
	<input type="submit" name="btnG" value="Search">
	<input type="hidden" name="domains" value="activemq.apache.org">
	<input type="hidden" name="sitesearch" value="activemq.apache.org">
	</form>
	</div>
	<p></p>

	<h3 id="Navigation-Communityhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=45948"><a shape="rect" href="community.html">Community</a></h3>

	<ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" class="external-link" href="http://activemq.apache.org/contributing.html">Contributing</a></li><li><a shape="rect" class="external-link" href="http://activemq.apache.org/discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" class="external-link" href="http://activemq.apache.org/mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" class="external-link" href="irc://irc.codehaus.org/activemq" rel="nofollow">IRC</a></li><li><a shape="rect" class="external-link" href="http://servlet.uwyn.com/drone/log/hausbot/activemq" rel="nofollow">IRC Log</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" class="external-link" href="http://activemq.apache.org/team.html">Team</a></li></ul>



	<h3 id="Navigation-Developershttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=45950"><a shape="rect" href="developers.html">Developers</a></h3>

	<ul class="alternate"><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="building.html">Building</a></li><li><a shape="rect" href="creating-distributions.html">Creating Distributions</a></li></ul>
	</div>
	</div>
	</div>
	</td>
	</tr>
	</tbody>
	</table>
	<div class="bottom_red_bar"></div>
	</div>
	</div>
	</div>
	</div>
	<div class="black_box">
	<div class="footer">
	<div class="footer_l">
	<div class="footer_r">
	<div>
	<a href="http://activemq.apache.org/privacy-policy.html">Privacy Policy</a> -
	(<a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=21792569">edit this page</a>)
	</div>
	</div>
	</div>
	</div>
	</div>
	</div>
	<div class="design_attribution">
	© 2004-2011 The Apache Software Foundation.
	<br/>
	Apache ActiveMQ, ActiveMQ, Apache, the Apache feather logo, and the Apache ActiveMQ project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
	<br/>
	<a href="http://hiramchirino.com">Graphic Design By Hiram</a>
	</div>

	<!-- delay the loading of large javascript files to the end so that they don't interfere with the loading of page content -->
	<span style="display: none">
	<script type="text/javascript">
	var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
	document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
	</script>
	<script type="text/javascript">
	var pageTracker = _gat._getTracker("UA-1347593-1");
	pageTracker._initData();
	pageTracker._trackPageview();
	</script>
	</span>
	</body>
	</html>