com.lark.oapi.okhttp.Handshake Maven / Gradle / Ivy
Show all versions of oapi-sdk Show documentation
/*
*
* * Copyright (C) 2015 Square, Inc.
* *
* * Licensed 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
* *
* * http://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 com.lark.oapi.okhttp;
import com.lark.oapi.okhttp.internal.Util;
import javax.annotation.Nullable;
import javax.net.ssl.SSLPeerUnverifiedException;
import javax.net.ssl.SSLSession;
import java.io.IOException;
import java.security.Principal;
import java.security.cert.Certificate;
import java.security.cert.X509Certificate;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* A record of a TLS handshake. For HTTPS clients, the client is local and the remote server
* is its peer.
*
* This value object describes a completed handshake. Use {@link ConnectionSpec} to set policy
* for new handshakes.
*/
public final class Handshake {
private final TlsVersion tlsVersion;
private final CipherSuite cipherSuite;
private final List peerCertificates;
private final List localCertificates;
private Handshake(TlsVersion tlsVersion, CipherSuite cipherSuite,
List peerCertificates, List localCertificates) {
this.tlsVersion = tlsVersion;
this.cipherSuite = cipherSuite;
this.peerCertificates = peerCertificates;
this.localCertificates = localCertificates;
}
public static Handshake get(SSLSession session) throws IOException {
String cipherSuiteString = session.getCipherSuite();
if (cipherSuiteString == null) {
throw new IllegalStateException("cipherSuite == null");
}
if ("SSL_NULL_WITH_NULL_NULL".equals(cipherSuiteString)) {
throw new IOException("cipherSuite == SSL_NULL_WITH_NULL_NULL");
}
CipherSuite cipherSuite = CipherSuite.forJavaName(cipherSuiteString);
String tlsVersionString = session.getProtocol();
if (tlsVersionString == null) {
throw new IllegalStateException("tlsVersion == null");
}
if ("NONE".equals(tlsVersionString)) {
throw new IOException("tlsVersion == NONE");
}
TlsVersion tlsVersion = TlsVersion.forJavaName(tlsVersionString);
Certificate[] peerCertificates;
try {
peerCertificates = session.getPeerCertificates();
} catch (SSLPeerUnverifiedException ignored) {
peerCertificates = null;
}
List peerCertificatesList = peerCertificates != null
? Util.immutableList(peerCertificates)
: Collections.emptyList();
Certificate[] localCertificates = session.getLocalCertificates();
List localCertificatesList = localCertificates != null
? Util.immutableList(localCertificates)
: Collections.emptyList();
return new Handshake(tlsVersion, cipherSuite, peerCertificatesList, localCertificatesList);
}
public static Handshake get(TlsVersion tlsVersion, CipherSuite cipherSuite,
List peerCertificates, List localCertificates) {
if (tlsVersion == null) {
throw new NullPointerException("tlsVersion == null");
}
if (cipherSuite == null) {
throw new NullPointerException("cipherSuite == null");
}
return new Handshake(tlsVersion, cipherSuite, Util.immutableList(peerCertificates),
Util.immutableList(localCertificates));
}
/**
* Returns the TLS version used for this connection. This value wasn't tracked prior to OkHttp
* 3.0. For responses cached by preceding versions this returns {@link TlsVersion#SSL_3_0}.
*/
public TlsVersion tlsVersion() {
return tlsVersion;
}
/**
* Returns the cipher suite used for the connection.
*/
public CipherSuite cipherSuite() {
return cipherSuite;
}
/**
* Returns a possibly-empty list of certificates that identify the remote peer.
*/
public List peerCertificates() {
return peerCertificates;
}
/**
* Returns the remote peer's principle, or null if that peer is anonymous.
*/
public @Nullable
Principal peerPrincipal() {
return !peerCertificates.isEmpty()
? ((X509Certificate) peerCertificates.get(0)).getSubjectX500Principal()
: null;
}
/**
* Returns a possibly-empty list of certificates that identify this peer.
*/
public List localCertificates() {
return localCertificates;
}
/**
* Returns the local principle, or null if this peer is anonymous.
*/
public @Nullable
Principal localPrincipal() {
return !localCertificates.isEmpty()
? ((X509Certificate) localCertificates.get(0)).getSubjectX500Principal()
: null;
}
@Override
public boolean equals(@Nullable Object other) {
if (!(other instanceof Handshake)) {
return false;
}
Handshake that = (Handshake) other;
return tlsVersion.equals(that.tlsVersion)
&& cipherSuite.equals(that.cipherSuite)
&& peerCertificates.equals(that.peerCertificates)
&& localCertificates.equals(that.localCertificates);
}
@Override
public int hashCode() {
int result = 17;
result = 31 * result + tlsVersion.hashCode();
result = 31 * result + cipherSuite.hashCode();
result = 31 * result + peerCertificates.hashCode();
result = 31 * result + localCertificates.hashCode();
return result;
}
@Override
public String toString() {
return "Handshake{"
+ "tlsVersion="
+ tlsVersion
+ " cipherSuite="
+ cipherSuite
+ " peerCertificates="
+ names(peerCertificates)
+ " localCertificates="
+ names(localCertificates)
+ '}';
}
private List names(List certificates) {
ArrayList strings = new ArrayList<>();
for (Certificate cert : certificates) {
if (cert instanceof X509Certificate) {
strings.add(String.valueOf(((X509Certificate) cert).getSubjectDN()));
} else {
strings.add(cert.getType());
}
}
return strings;
}
}