1 /* 2 * ==================================================================== 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * ==================================================================== 20 * 21 * This software consists of voluntary contributions made by many 22 * individuals on behalf of the Apache Software Foundation. For more 23 * information on the Apache Software Foundation, please see 24 * <http://www.apache.org/>. 25 * 26 */ 27 28 package org.apache.hc.core5.reactor.ssl; 29 30 import javax.net.ssl.SSLContext; 31 32 import org.apache.hc.core5.concurrent.FutureCallback; 33 import org.apache.hc.core5.net.NamedEndpoint; 34 import org.apache.hc.core5.util.Timeout; 35 36 /** 37 * TLS capable session layer interface. 38 * 39 * @since 5.0 40 */ 41 public interface TransportSecurityLayer { 42 43 /** 44 * Starts TLS session over an existing network connection with the given SSL context. 45 * {@link NamedEndpoint} details are applicable for client side connections and 46 * are used for host name verification, when supported by the SSL engine. 47 * 48 * @param sslContext SSL context to be used for this session. 49 * @param endpoint optional endpoint details for outgoing client side connections. 50 * @param sslBufferMode SSL buffer management mode. 51 * @param initializer SSL session initialization callback. 52 * @param verifier SSL session verification callback. 53 * @param handshakeTimeout the timeout to use while performing the TLS handshake; may be {@code null}. 54 */ 55 void startTls( 56 SSLContext sslContext, 57 NamedEndpoint endpoint, 58 SSLBufferMode sslBufferMode, 59 SSLSessionInitializer initializer, 60 SSLSessionVerifier verifier, 61 Timeout handshakeTimeout) throws UnsupportedOperationException; 62 63 /** 64 * Starts TLS session over an existing network connection with the given SSL context. 65 * {@link NamedEndpoint} details are applicable for client side connections and 66 * are used for host name verification, when supported by the SSL engine. 67 * 68 * @param sslContext SSL context to be used for this session. 69 * @param endpoint optional endpoint details for outgoing client side connections. 70 * @param sslBufferMode SSL buffer management mode. 71 * @param initializer SSL session initialization callback. 72 * @param verifier SSL session verification callback. 73 * @param handshakeTimeout the timeout to use while performing the TLS handshake; may be {@code null}. 74 * 75 * @since 5.2 76 */ 77 default void startTls( 78 SSLContext sslContext, 79 NamedEndpoint endpoint, 80 SSLBufferMode sslBufferMode, 81 SSLSessionInitializer initializer, 82 SSLSessionVerifier verifier, 83 Timeout handshakeTimeout, 84 FutureCallback<TransportSecurityLayer> callback) throws UnsupportedOperationException { 85 startTls(sslContext, endpoint, sslBufferMode, initializer, verifier, handshakeTimeout); 86 if (callback != null) { 87 callback.completed(null); 88 } 89 } 90 91 /** 92 * Returns details of a fully established TLS session. 93 * 94 * @return TLS session details. 95 */ 96 TlsDetails getTlsDetails(); 97 98 }