sslfilter.html

MINA+API 关于MINA的API

<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>     <em class="jxr_javadoccomment">/**</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     * A session attribute key that should be set to an {@link InetSocketAddress}.</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">     * Setting this attribute causes</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     * {@link SSLContext#createSSLEngine(String, int)} to be called passing the</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     * hostname and port of the {@link InetSocketAddress} to get an</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * {@link SSLEngine} instance. If not set {@link SSLContext#createSSLEngine()}</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     * will be called.</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     * .</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     * Using this feature {@link SSLSession} objects may be cached and reused</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * when in client mode.</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     *</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     * @see SSLContext#createSSLEngine(String, int)</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">     */</em>
<a name="128" href="#128">128</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/common/AttributeKey.html">AttributeKey</a> PEER_ADDRESS = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/common/AttributeKey.html">AttributeKey</a>(SslFilter.<strong class="jxr_keyword">class</strong>, <span class="jxr_string">"peerAddress"</span>);
<a name="129" href="#129">129</a> 
<a name="130" href="#130">130</a>     <em class="jxr_javadoccomment">/**</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * A special message object which is emitted with a {@link IoHandler#messageReceived(IoSession, Object)}</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     * event when the session is secured and its {@link #USE_NOTIFICATION}</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     * attribute is set.</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     */</em>
<a name="135" href="#135">135</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/filter/ssl/SslFilter.html">SslFilterMessage</a> SESSION_SECURED = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/filter/ssl/SslFilter.html">SslFilterMessage</a>(
<a name="136" href="#136">136</a>             <span class="jxr_string">"SESSION_SECURED"</span>);
<a name="137" href="#137">137</a> 
<a name="138" href="#138">138</a>     <em class="jxr_javadoccomment">/**</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">     * A special message object which is emitted with a {@link IoHandler#messageReceived(IoSession, Object)}</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * event when the session is not secure anymore and its {@link #USE_NOTIFICATION}</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * attribute is set.</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     */</em>
<a name="143" href="#143">143</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/filter/ssl/SslFilter.html">SslFilterMessage</a> SESSION_UNSECURED = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/filter/ssl/SslFilter.html">SslFilterMessage</a>(
<a name="144" href="#144">144</a>             <span class="jxr_string">"SESSION_UNSECURED"</span>);
<a name="145" href="#145">145</a> 
<a name="146" href="#146">146</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/common/AttributeKey.html">AttributeKey</a> NEXT_FILTER = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/common/AttributeKey.html">AttributeKey</a>(SslFilter.<strong class="jxr_keyword">class</strong>, <span class="jxr_string">"nextFilter"</span>);
<a name="147" href="#147">147</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/common/AttributeKey.html">AttributeKey</a> SSL_HANDLER = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/common/AttributeKey.html">AttributeKey</a>(SslFilter.<strong class="jxr_keyword">class</strong>, <span class="jxr_string">"handler"</span>);
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a>     <em class="jxr_comment">// SSL Context</em>
<a name="150" href="#150">150</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> SSLContext sslContext;
<a name="151" href="#151">151</a> 
<a name="152" href="#152">152</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> autoStart;
<a name="153" href="#153">153</a> 
<a name="154" href="#154">154</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> client;
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> needClientAuth;
<a name="157" href="#157">157</a> 
<a name="158" href="#158">158</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> wantClientAuth;
<a name="159" href="#159">159</a> 
<a name="160" href="#160">160</a>     <strong class="jxr_keyword">private</strong> String[] enabledCipherSuites;
<a name="161" href="#161">161</a> 
<a name="162" href="#162">162</a>     <strong class="jxr_keyword">private</strong> String[] enabledProtocols;
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a>     <em class="jxr_javadoccomment">/**</em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">     * Creates a new SSL filter using the specified {@link SSLContext}.</em>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">     */</em>
<a name="167" href="#167">167</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/ssl/SslFilter.html">SslFilter</a>(SSLContext sslContext) {
<a name="168" href="#168">168</a>         <strong class="jxr_keyword">this</strong>(sslContext, <strong class="jxr_keyword">true</strong>);
<a name="169" href="#169">169</a>     }
<a name="170" href="#170">170</a> 
<a name="171" href="#171">171</a>     <em class="jxr_javadoccomment">/**</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     * Creates a new SSL filter using the specified {@link SSLContext}.</em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">     */</em>
<a name="174" href="#174">174</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/ssl/SslFilter.html">SslFilter</a>(SSLContext sslContext, <strong class="jxr_keyword">boolean</strong> autoStart) {
<a name="175" href="#175">175</a>         <strong class="jxr_keyword">if</strong> (sslContext == <strong class="jxr_keyword">null</strong>) {
<a name="176" href="#176">176</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"sslContext"</span>);
<a name="177" href="#177">177</a>         }
<a name="178" href="#178">178</a> 
<a name="179" href="#179">179</a>         <strong class="jxr_keyword">this</strong>.sslContext = sslContext;
<a name="180" href="#180">180</a>         <strong class="jxr_keyword">this</strong>.autoStart = autoStart;
<a name="181" href="#181">181</a>     }
<a name="182" href="#182">182</a> 
<a name="183" href="#183">183</a>     <em class="jxr_javadoccomment">/**</em>
<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">     * Returns the underlying {@link SSLSession} for the specified session.</em>
<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">     *</em>
<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">     * @return &lt;tt&gt;null&lt;/tt&gt; if no {@link SSLSession} is initialized yet.</em>
<a name="187" href="#187">187</a> <em class="jxr_javadoccomment">     */</em>
<a name="188" href="#188">188</a>     <strong class="jxr_keyword">public</strong> SSLSession getSslSession(<a href="../../../../../org/apache/mina/common/IoSession.html">IoSession</a> session) {
<a name="189" href="#189">189</a>         <strong class="jxr_keyword">return</strong> (SSLSession) session.getAttribute(SSL_SESSION);
<a name="190" href="#190">190</a>     }
<a name="191" href="#191">191</a> 
<a name="192" href="#192">192</a>     <em class="jxr_javadoccomment">/**</em>
<a name="193" href="#193">193</a> <em class="jxr_javadoccomment">     * (Re)starts SSL session for the specified &lt;tt&gt;session&lt;/tt&gt; if not started yet.</em>
<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">     * Please note that SSL session is automatically started by default, and therefore</em>
<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">     * you don't need to call this method unless you've used TLS closure.</em>
<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">     *</em>
<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">     * @return &lt;tt&gt;true&lt;/tt&gt; if the SSL session has been started, &lt;tt&gt;false&lt;/tt&gt; if already started.</em>
<a name="198" href="#198">198</a> <em class="jxr_javadoccomment">     * @throws SSLException if failed to start the SSL session</em>
<a name="199" href="#199">199</a> <em class="jxr_javadoccomment">     */</em>
<a name="200" href="#200">200</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> startSsl(<a href="../../../../../org/apache/mina/common/IoSession.html">IoSession</a> session) <strong class="jxr_keyword">throws</strong> SSLException {
<a name="201" href="#201">201</a>         <a href="../../../../../org/apache/mina/filter/ssl/SslHandler.html">SslHandler</a> handler = getSslSessionHandler(session);
<a name="202" href="#202">202</a>         <strong class="jxr_keyword">boolean</strong> started;
<a name="203" href="#203">203</a>         <strong class="jxr_keyword">synchronized</strong> (handler) {
<a name="204" href="#204">204</a>             <strong class="jxr_keyword">if</strong> (handler.isOutboundDone()) {
<a name="205" href="#205">205</a>                 <a href="../../../../../org/apache/mina/common/IoFilter.html">NextFilter</a> nextFilter = (NextFilter) session
<a name="206" href="#206">206</a>                         .getAttribute(NEXT_FILTER);
<a name="207" href="#207">207</a>                 handler.destroy();
<a name="208" href="#208">208</a>                 handler.init();
<a name="209" href="#209">209</a>                 handler.handshake(nextFilter);
<a name="210" href="#210">210</a>                 started = <strong class="jxr_keyword">true</strong>;
<a name="211" href="#211">211</a>             } <strong class="jxr_keyword">else</strong> {
<a name="212" href="#212">212</a>                 started = false;
<a name="213" href="#213">213</a>             }
<a name="214" href="#214">214</a>         }
<a name="215" href="#215">215</a> 
<a name="216" href="#216">216</a>         handler.flushScheduledEvents();
<a name="217" href="#217">217</a>         <strong class="jxr_keyword">return</strong> started;
<a name="218" href="#218">218</a>     }
<a name="219" href="#219">219</a> 
<a name="220" href="#220">220</a>     <em class="jxr_javadoccomment">/**</em>
<a name="221" href="#221">221</a> <em class="jxr_javadoccomment">     * Returns &lt;tt&gt;true&lt;/tt&gt; if and only if the specified &lt;tt&gt;session&lt;/tt&gt; is</em>
<a name="222" href="#222">222</a> <em class="jxr_javadoccomment">     * encrypted/decrypted over SSL/TLS currently.  This method will start</em>
<a name="223" href="#223">223</a> <em class="jxr_javadoccomment">     * to retun &lt;tt&gt;false&lt;/tt&gt; after TLS &lt;tt&gt;close_notify&lt;/tt&gt; message</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     * is sent and any messages written after then is not goinf to get encrypted.</em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     */</em>
<a name="226" href="#226">226</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSslStarted(<a href="../../../../../org/apache/mina/common/IoSession.html">IoSession</a> session) {
<a name="227" href="#227">227</a>         <a href="../../../../../org/apache/mina/filter/ssl/SslHandler.html">SslHandler</a> handler = getSslSessionHandler0(session);
<a name="228" href="#228">228</a>         <strong class="jxr_keyword">if</strong> (handler == <strong class="jxr_keyword">null</strong>) {
<a name="229" href="#229">229</a>             <strong class="jxr_keyword">return</strong> false;
<a name="230" href="#230">230</a>         }
<a name="231" href="#231">231</a> 
<a name="232" href="#232">232</a>         <strong class="jxr_keyword">synchronized</strong> (handler) {
<a name="233" href="#233">233</a>             <strong class="jxr_keyword">return</strong> !handler.isOutboundDone();
<a name="234" href="#234">234</a>         }
<a name="235" href="#235">235</a>     }
<a name="236" href="#236">236</a>