001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *   https://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.net.util;
019
020import javax.net.ssl.SSLParameters;
021import javax.net.ssl.SSLSocket;
022
023/**
024 * General utilities for SSLSocket.
025 *
026 * @since 3.4
027 */
028public class SSLSocketUtils {
029
030    /**
031     * Enable the HTTPS endpoint identification algorithm on an SSLSocket.
032     *
033     * @param socket the SSL socket
034     * @return Always returns {@code true}
035     */
036    // TODO for 4.0: becomes a void method.
037    public static boolean enableEndpointNameVerification(final SSLSocket socket) {
038        final SSLParameters sslParameters = socket.getSSLParameters();
039        sslParameters.setEndpointIdentificationAlgorithm("HTTPS");
040        socket.setSSLParameters(sslParameters);
041        return true;
042    }
043
044    private SSLSocketUtils() {
045        // Not instantiable
046    }
047}