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.net.NamedEndpoint; 33 import org.apache.hc.core5.util.Timeout; 34 35 /** 36 * TLS capable session layer interface. 37 * 38 * @since 5.0 39 */ 40 public interface TransportSecurityLayer { 41 42 /** 43 * Starts TLS session over an existing network connection with the given SSL context. 44 * {@link NamedEndpoint} details are applicable for client side connections and 45 * are used for host name verification, when supported by the SSL engine. 46 * 47 * @param sslContext SSL context to be used for this session. 48 * @param endpoint optional endpoint details for outgoing client side connections. 49 * @param sslBufferMode SSL buffer management mode. 50 * @param initializer SSL session initialization callback. 51 * @param verifier SSL session verification callback. 52 * @param handshakeTimeout the timeout to use while performing the TLS handshake; may be {@code null}. 53 */ 54 void startTls( 55 SSLContext sslContext, 56 NamedEndpoint endpoint, 57 SSLBufferMode sslBufferMode, 58 SSLSessionInitializer initializer, 59 SSLSessionVerifier verifier, 60 Timeout handshakeTimeout) throws UnsupportedOperationException; 61 62 /** 63 * Returns details of a fully established TLS session. 64 * 65 * @return TLS session details. 66 */ 67 TlsDetails getTlsDetails(); 68 69 }