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 *   http://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 */
018
019package org.apache.commons.net.util;
020
021import javax.net.ssl.SSLParameters;
022import javax.net.ssl.SSLSocket;
023
024/**
025 * General utilities for SSLSocket.
026 *
027 * @since 3.4
028 */
029public class SSLSocketUtils {
030
031    /**
032     * Enable the HTTPS endpoint identification algorithm on an SSLSocket.
033     *
034     * @param socket the SSL socket
035     * @return {@code true} on success
036     */
037    public static boolean enableEndpointNameVerification(final SSLSocket socket) {
038        final SSLParameters sslParameters = socket.getSSLParameters();
039        if (sslParameters != null) {
040            sslParameters.setEndpointIdentificationAlgorithm("HTTPS");
041            socket.setSSLParameters(sslParameters);
042            return true;
043        }
044        return false;
045    }
046
047    private SSLSocketUtils() {
048        // Not instantiable
049    }
050}