1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.net.util;
19
20 import javax.net.ssl.SSLParameters;
21 import javax.net.ssl.SSLSocket;
22
23 /**
24 * General utilities for SSLSocket.
25 *
26 * @since 3.4
27 */
28 public class SSLSocketUtils {
29
30 /**
31 * Enable the HTTPS endpoint identification algorithm on an SSLSocket.
32 *
33 * @param socket the SSL socket
34 * @return Always returns {@code true}
35 */
36 // TODO for 4.0: becomes a void method.
37 public static boolean enableEndpointNameVerification(final SSLSocket socket) {
38 final SSLParameters sslParameters = socket.getSSLParameters();
39 sslParameters.setEndpointIdentificationAlgorithm("HTTPS");
40 socket.setSSLParameters(sslParameters);
41 return true;
42 }
43
44 private SSLSocketUtils() {
45 // Not instantiable
46 }
47 }