OpenSslSession.java — netty Source File

Source Code

/*
 * Copyright 2024 The Netty Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */
package io.netty.handler.ssl;

import javax.net.ssl.SSLPeerUnverifiedException;
import javax.net.ssl.SSLSession;

/**
 * {@link SSLSession} sub-type that is used by our native implementation.
 */
public interface OpenSslSession extends SSLSession {

    /**
     * Returns true if the peer has provided certificates during the handshake.
     * <p>
     * This method is similar to {@link SSLSession#getPeerCertificates()} but it does not throw a
     * {@link SSLPeerUnverifiedException} if no certs are provided, making it more efficient to check if a mTLS
     * connection is used.
     *
     * @return true if peer certificates are available.
     */
    boolean hasPeerCertificates();

    @Override
    OpenSslSessionContext getSessionContext();
}