/*
* Copyright 2014 The Netty Project
*
* The Netty Project 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.
*/
package io.netty.handler.ssl;
import io.netty.buffer.
ByteBufAllocator;
import io.netty.util.internal.
PlatformDependent;
import javax.net.ssl.
SSLEngine;
/**
* The {@link JdkApplicationProtocolNegotiator} to use if you need ALPN and are using {@link SslProvider#JDK}.
*
* @deprecated use {@link ApplicationProtocolConfig}.
*/
@
Deprecated
public final class
JdkAlpnApplicationProtocolNegotiator extends
JdkBaseApplicationProtocolNegotiator {
private static final boolean
AVAILABLE =
Conscrypt.
isAvailable() ||
jdkAlpnSupported() ||
JettyAlpnSslEngine.
isAvailable();
private static final
SslEngineWrapperFactory ALPN_WRAPPER =
AVAILABLE ? new
AlpnWrapper() : new
FailureWrapper();
/**
* Create a new instance.
* @param protocols The order of iteration determines the preference of support for protocols.
*/
public
JdkAlpnApplicationProtocolNegotiator(
Iterable<
String>
protocols) {
this(false,
protocols);
}
/**
* Create a new instance.
* @param protocols The order of iteration determines the preference of support for protocols.
*/
public
JdkAlpnApplicationProtocolNegotiator(
String...
protocols) {
this(false,
protocols);
}
/**
* Create a new instance.
* @param failIfNoCommonProtocols Fail with a fatal alert if not common protocols are detected.
* @param protocols The order of iteration determines the preference of support for protocols.
*/
public
JdkAlpnApplicationProtocolNegotiator(boolean
failIfNoCommonProtocols,
Iterable<
String>
protocols) {
this(
failIfNoCommonProtocols,
failIfNoCommonProtocols,
protocols);
}
/**
* Create a new instance.
* @param failIfNoCommonProtocols Fail with a fatal alert if not common protocols are detected.
* @param protocols The order of iteration determines the preference of support for protocols.
*/
public
JdkAlpnApplicationProtocolNegotiator(boolean
failIfNoCommonProtocols,
String...
protocols) {
this(
failIfNoCommonProtocols,
failIfNoCommonProtocols,
protocols);
}
/**
* Create a new instance.
* @param clientFailIfNoCommonProtocols Client side fail with a fatal alert if not common protocols are detected.
* @param serverFailIfNoCommonProtocols Server side fail with a fatal alert if not common protocols are detected.
* @param protocols The order of iteration determines the preference of support for protocols.
*/
public
JdkAlpnApplicationProtocolNegotiator(boolean
clientFailIfNoCommonProtocols,
boolean
serverFailIfNoCommonProtocols,
Iterable<
String>
protocols) {
this(
serverFailIfNoCommonProtocols ?
FAIL_SELECTOR_FACTORY :
NO_FAIL_SELECTOR_FACTORY,
clientFailIfNoCommonProtocols ?
FAIL_SELECTION_LISTENER_FACTORY :
NO_FAIL_SELECTION_LISTENER_FACTORY,
protocols);
}
/**
* Create a new instance.
* @param clientFailIfNoCommonProtocols Client side fail with a fatal alert if not common protocols are detected.
* @param serverFailIfNoCommonProtocols Server side fail with a fatal alert if not common protocols are detected.
* @param protocols The order of iteration determines the preference of support for protocols.
*/
public
JdkAlpnApplicationProtocolNegotiator(boolean
clientFailIfNoCommonProtocols,
boolean
serverFailIfNoCommonProtocols,
String...
protocols) {
this(
serverFailIfNoCommonProtocols ?
FAIL_SELECTOR_FACTORY :
NO_FAIL_SELECTOR_FACTORY,
clientFailIfNoCommonProtocols ?
FAIL_SELECTION_LISTENER_FACTORY :
NO_FAIL_SELECTION_LISTENER_FACTORY,
protocols);
}
/**
* Create a new instance.
* @param selectorFactory The factory which provides classes responsible for selecting the protocol.
* @param listenerFactory The factory which provides to be notified of which protocol was selected.
* @param protocols The order of iteration determines the preference of support for protocols.
*/
public
JdkAlpnApplicationProtocolNegotiator(
ProtocolSelectorFactory selectorFactory,
ProtocolSelectionListenerFactory listenerFactory,
Iterable<
String>
protocols) {
super(
ALPN_WRAPPER,
selectorFactory,
listenerFactory,
protocols);
}
/**
* Create a new instance.
* @param selectorFactory The factory which provides classes responsible for selecting the protocol.
* @param listenerFactory The factory which provides to be notified of which protocol was selected.
* @param protocols The order of iteration determines the preference of support for protocols.
*/
public
JdkAlpnApplicationProtocolNegotiator(
ProtocolSelectorFactory selectorFactory,
ProtocolSelectionListenerFactory listenerFactory,
String...
protocols) {
super(
ALPN_WRAPPER,
selectorFactory,
listenerFactory,
protocols);
}
private static final class
FailureWrapper extends
AllocatorAwareSslEngineWrapperFactory {
@
Override
public
SSLEngine wrapSslEngine(
SSLEngine engine,
ByteBufAllocator alloc,
JdkApplicationProtocolNegotiator applicationNegotiator, boolean
isServer) {
throw new
RuntimeException("ALPN unsupported. Is your classpath configured correctly?"
+ " For Conscrypt, add the appropriate Conscrypt JAR to classpath and set the security provider."
+ " For Jetty-ALPN, see "
+ "http://www.eclipse.org/jetty/documentation/current/alpn-chapter.html#alpn-starting");
}
}
private static final class
AlpnWrapper extends
AllocatorAwareSslEngineWrapperFactory {
@
Override
public
SSLEngine wrapSslEngine(
SSLEngine engine,
ByteBufAllocator alloc,
JdkApplicationProtocolNegotiator applicationNegotiator, boolean
isServer) {
if (
Conscrypt.
isEngineSupported(
engine)) {
return
isServer ?
ConscryptAlpnSslEngine.
newServerEngine(
engine,
alloc,
applicationNegotiator)
:
ConscryptAlpnSslEngine.
newClientEngine(
engine,
alloc,
applicationNegotiator);
}
if (
jdkAlpnSupported()) {
return new
Java9SslEngine(
engine,
applicationNegotiator,
isServer);
}
if (
JettyAlpnSslEngine.
isAvailable()) {
return
isServer ?
JettyAlpnSslEngine.
newServerEngine(
engine,
applicationNegotiator)
:
JettyAlpnSslEngine.
newClientEngine(
engine,
applicationNegotiator);
}
throw new
RuntimeException("Unable to wrap SSLEngine of type " +
engine.
getClass().
getName());
}
}
static boolean
jdkAlpnSupported() {
return
PlatformDependent.
javaVersion() >= 9 &&
Java9SslUtils.
supportsAlpn();
}
}