1 /*
2 * Copyright 2024 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty.handler.ssl;
17
18 import javax.net.ssl.SSLPeerUnverifiedException;
19 import javax.net.ssl.SSLSession;
20
21 /**
22 * {@link SSLSession} sub-type that is used by our native implementation.
23 */
24 public interface OpenSslSession extends SSLSession {
25
26 /**
27 * Returns true if the peer has provided certificates during the handshake.
28 * <p>
29 * This method is similar to {@link SSLSession#getPeerCertificates()} but it does not throw a
30 * {@link SSLPeerUnverifiedException} if no certs are provided, making it more efficient to check if a mTLS
31 * connection is used.
32 *
33 * @return true if peer certificates are available.
34 */
35 boolean hasPeerCertificates();
36
37 /**
38 * Returns the used named group or {@code null} if none was used or if it can't be determined.
39 *
40 * @return the named group
41 */
42 default String getNamedGroup() {
43 return null;
44 }
45
46 @Override
47 OpenSslSessionContext getSessionContext();
48 }