com.feilong.lib.org.apache.http.ssl.SSLContextBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF 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
*
* 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
*
* Please note: the default Oracle JSSE implementation of {@link SSLContext#init(KeyManager[], TrustManager[], SecureRandom)}
* accepts multiple key and trust managers, however only only first matching type is ever used.
* See for example:
*
* SSLContext.html#init
*
*
* TODO Specify which Oracle JSSE versions the above has been verified.
*
*
* @since 4.4
*/
public class SSLContextBuilder{
static final String TLS = "TLS";
private String protocol;
private final Set keyManagers;
private String keyManagerFactoryAlgorithm = KeyManagerFactory.getDefaultAlgorithm();
private String keyStoreType = KeyStore.getDefaultType();
private final Set trustManagers;
private String trustManagerFactoryAlgorithm = TrustManagerFactory.getDefaultAlgorithm();
private SecureRandom secureRandom;
private Provider provider;
public static SSLContextBuilder create(){
return new SSLContextBuilder();
}
public SSLContextBuilder(){
super();
this.keyManagers = new LinkedHashSet<>();
this.trustManagers = new LinkedHashSet<>();
}
/**
* Sets the SSLContext protocol algorithm name.
*
* @param protocol
* the SSLContext protocol algorithm name of the requested protocol. See
* the SSLContext section in the Java
* Cryptography Architecture Standard Algorithm Name
* Documentation for more information.
* @return this builder
* @see Java
* Cryptography Architecture Standard Algorithm Name Documentation
* @deprecated Use {@link #setProtocol(String)}.
*/
@Deprecated
public SSLContextBuilder useProtocol(final String protocol){
this.protocol = protocol;
return this;
}
/**
* Sets the SSLContext protocol algorithm name.
*
* @param protocol
* the SSLContext protocol algorithm name of the requested protocol. See
* the SSLContext section in the Java
* Cryptography Architecture Standard Algorithm Name
* Documentation for more information.
* @return this builder
* @see Java
* Cryptography Architecture Standard Algorithm Name Documentation
* @since 4.4.7
*/
public SSLContextBuilder setProtocol(final String protocol){
this.protocol = protocol;
return this;
}
public SSLContextBuilder setSecureRandom(final SecureRandom secureRandom){
this.secureRandom = secureRandom;
return this;
}
public SSLContextBuilder setProvider(final Provider provider){
this.provider = provider;
return this;
}
public SSLContextBuilder setProvider(final String name){
this.provider = Security.getProvider(name);
return this;
}
/**
* Sets the key store type.
*
* @param keyStoreType
* the SSLkey store type. See
* the KeyStore section in the Java
* Cryptography Architecture Standard Algorithm Name
* Documentation for more information.
* @return this builder
* @see Java
* Cryptography Architecture Standard Algorithm Name Documentation
* @since 4.4.7
*/
public SSLContextBuilder setKeyStoreType(final String keyStoreType){
this.keyStoreType = keyStoreType;
return this;
}
/**
* Sets the key manager factory algorithm name.
*
* @param keyManagerFactoryAlgorithm
* the key manager factory algorithm name of the requested protocol. See
* the KeyManagerFactory section in the Java
* Cryptography Architecture Standard Algorithm Name
* Documentation for more information.
* @return this builder
* @see Java
* Cryptography Architecture Standard Algorithm Name Documentation
* @since 4.4.7
*/
public SSLContextBuilder setKeyManagerFactoryAlgorithm(final String keyManagerFactoryAlgorithm){
this.keyManagerFactoryAlgorithm = keyManagerFactoryAlgorithm;
return this;
}
/**
* Sets the trust manager factory algorithm name.
*
* @param trustManagerFactoryAlgorithm
* the trust manager algorithm name of the requested protocol. See
* the TrustManagerFactory section in the Java
* Cryptography Architecture Standard Algorithm Name
* Documentation for more information.
* @return this builder
* @see Java
* Cryptography Architecture Standard Algorithm Name Documentation
* @since 4.4.7
*/
public SSLContextBuilder setTrustManagerFactoryAlgorithm(final String trustManagerFactoryAlgorithm){
this.trustManagerFactoryAlgorithm = trustManagerFactoryAlgorithm;
return this;
}
public SSLContextBuilder loadTrustMaterial(final KeyStore truststore,final TrustStrategy trustStrategy)
throws NoSuchAlgorithmException,KeyStoreException{
final TrustManagerFactory tmfactory = TrustManagerFactory.getInstance(
trustManagerFactoryAlgorithm == null ? TrustManagerFactory.getDefaultAlgorithm() : trustManagerFactoryAlgorithm);
tmfactory.init(truststore);
final TrustManager[] tms = tmfactory.getTrustManagers();
if (tms != null){
if (trustStrategy != null){
for (int i = 0; i < tms.length; i++){
final TrustManager tm = tms[i];
if (tm instanceof X509TrustManager){
tms[i] = new TrustManagerDelegate((X509TrustManager) tm, trustStrategy);
}
}
}
Collections.addAll(this.trustManagers, tms);
}
return this;
}
public SSLContextBuilder loadTrustMaterial(final TrustStrategy trustStrategy) throws NoSuchAlgorithmException,KeyStoreException{
return loadTrustMaterial(null, trustStrategy);
}
public SSLContextBuilder loadTrustMaterial(final File file,final char[] storePassword,final TrustStrategy trustStrategy)
throws NoSuchAlgorithmException,KeyStoreException,CertificateException,IOException{
Args.notNull(file, "Truststore file");
final KeyStore trustStore = KeyStore.getInstance(keyStoreType);
final FileInputStream inStream = new FileInputStream(file);
try{
trustStore.load(inStream, storePassword);
}finally{
inStream.close();
}
return loadTrustMaterial(trustStore, trustStrategy);
}
public SSLContextBuilder loadTrustMaterial(final File file,final char[] storePassword)
throws NoSuchAlgorithmException,KeyStoreException,CertificateException,IOException{
return loadTrustMaterial(file, storePassword, null);
}
public SSLContextBuilder loadTrustMaterial(final File file)
throws NoSuchAlgorithmException,KeyStoreException,CertificateException,IOException{
return loadTrustMaterial(file, null);
}
public SSLContextBuilder loadTrustMaterial(final URL url,final char[] storePassword,final TrustStrategy trustStrategy)
throws NoSuchAlgorithmException,KeyStoreException,CertificateException,IOException{
Args.notNull(url, "Truststore URL");
final KeyStore trustStore = KeyStore.getInstance(keyStoreType);
final InputStream inStream = url.openStream();
try{
trustStore.load(inStream, storePassword);
}finally{
inStream.close();
}
return loadTrustMaterial(trustStore, trustStrategy);
}
public SSLContextBuilder loadTrustMaterial(final URL url,final char[] storePassword)
throws NoSuchAlgorithmException,KeyStoreException,CertificateException,IOException{
return loadTrustMaterial(url, storePassword, null);
}
public SSLContextBuilder loadKeyMaterial(final KeyStore keystore,final char[] keyPassword,final PrivateKeyStrategy aliasStrategy)
throws NoSuchAlgorithmException,KeyStoreException,UnrecoverableKeyException{
final KeyManagerFactory kmfactory = KeyManagerFactory.getInstance(
keyManagerFactoryAlgorithm == null ? KeyManagerFactory.getDefaultAlgorithm() : keyManagerFactoryAlgorithm);
kmfactory.init(keystore, keyPassword);
final KeyManager[] kms = kmfactory.getKeyManagers();
if (kms != null){
if (aliasStrategy != null){
for (int i = 0; i < kms.length; i++){
final KeyManager km = kms[i];
if (km instanceof X509ExtendedKeyManager){
kms[i] = new KeyManagerDelegate((X509ExtendedKeyManager) km, aliasStrategy);
}
}
}
Collections.addAll(keyManagers, kms);
}
return this;
}
public SSLContextBuilder loadKeyMaterial(final KeyStore keystore,final char[] keyPassword)
throws NoSuchAlgorithmException,KeyStoreException,UnrecoverableKeyException{
return loadKeyMaterial(keystore, keyPassword, null);
}
public SSLContextBuilder loadKeyMaterial(
final File file,
final char[] storePassword,
final char[] keyPassword,
final PrivateKeyStrategy aliasStrategy)
throws NoSuchAlgorithmException,KeyStoreException,UnrecoverableKeyException,CertificateException,IOException{
Args.notNull(file, "Keystore file");
final KeyStore identityStore = KeyStore.getInstance(keyStoreType);
final FileInputStream inStream = new FileInputStream(file);
try{
identityStore.load(inStream, storePassword);
}finally{
inStream.close();
}
return loadKeyMaterial(identityStore, keyPassword, aliasStrategy);
}
public SSLContextBuilder loadKeyMaterial(final File file,final char[] storePassword,final char[] keyPassword)
throws NoSuchAlgorithmException,KeyStoreException,UnrecoverableKeyException,CertificateException,IOException{
return loadKeyMaterial(file, storePassword, keyPassword, null);
}
public SSLContextBuilder loadKeyMaterial(
final URL url,
final char[] storePassword,
final char[] keyPassword,
final PrivateKeyStrategy aliasStrategy)
throws NoSuchAlgorithmException,KeyStoreException,UnrecoverableKeyException,CertificateException,IOException{
Args.notNull(url, "Keystore URL");
final KeyStore identityStore = KeyStore.getInstance(keyStoreType);
final InputStream inStream = url.openStream();
try{
identityStore.load(inStream, storePassword);
}finally{
inStream.close();
}
return loadKeyMaterial(identityStore, keyPassword, aliasStrategy);
}
public SSLContextBuilder loadKeyMaterial(final URL url,final char[] storePassword,final char[] keyPassword)
throws NoSuchAlgorithmException,KeyStoreException,UnrecoverableKeyException,CertificateException,IOException{
return loadKeyMaterial(url, storePassword, keyPassword, null);
}
protected void initSSLContext(
final SSLContext sslContext,
final Collection keyManagers,
final Collection trustManagers,
final SecureRandom secureRandom) throws KeyManagementException{
sslContext.init(
!keyManagers.isEmpty() ? keyManagers.toArray(new KeyManager[keyManagers.size()]) : null,
!trustManagers.isEmpty() ? trustManagers.toArray(new TrustManager[trustManagers.size()]) : null,
secureRandom);
}
public SSLContext build() throws NoSuchAlgorithmException,KeyManagementException{
final SSLContext sslContext;
final String protocolStr = this.protocol != null ? this.protocol : TLS;
if (this.provider != null){
sslContext = SSLContext.getInstance(protocolStr, this.provider);
}else{
sslContext = SSLContext.getInstance(protocolStr);
}
initSSLContext(sslContext, keyManagers, trustManagers, secureRandom);
return sslContext;
}
static class TrustManagerDelegate implements X509TrustManager{
private final X509TrustManager trustManager;
private final TrustStrategy trustStrategy;
TrustManagerDelegate(final X509TrustManager trustManager, final TrustStrategy trustStrategy){
super();
this.trustManager = trustManager;
this.trustStrategy = trustStrategy;
}
@Override
public void checkClientTrusted(final X509Certificate[] chain,final String authType) throws CertificateException{
this.trustManager.checkClientTrusted(chain, authType);
}
@Override
public void checkServerTrusted(final X509Certificate[] chain,final String authType) throws CertificateException{
if (!this.trustStrategy.isTrusted(chain, authType)){
this.trustManager.checkServerTrusted(chain, authType);
}
}
@Override
public X509Certificate[] getAcceptedIssuers(){
return this.trustManager.getAcceptedIssuers();
}
}
static class KeyManagerDelegate extends X509ExtendedKeyManager{
private final X509ExtendedKeyManager keyManager;
private final PrivateKeyStrategy aliasStrategy;
KeyManagerDelegate(final X509ExtendedKeyManager keyManager, final PrivateKeyStrategy aliasStrategy){
super();
this.keyManager = keyManager;
this.aliasStrategy = aliasStrategy;
}
@Override
public String[] getClientAliases(final String keyType,final Principal[] issuers){
return this.keyManager.getClientAliases(keyType, issuers);
}
public Map getClientAliasMap(final String[] keyTypes,final Principal[] issuers){
final Map validAliases = new HashMap<>();
for (final String keyType : keyTypes){
final String[] aliases = this.keyManager.getClientAliases(keyType, issuers);
if (aliases != null){
for (final String alias : aliases){
validAliases.put(alias, new PrivateKeyDetails(keyType, this.keyManager.getCertificateChain(alias)));
}
}
}
return validAliases;
}
public Map getServerAliasMap(final String keyType,final Principal[] issuers){
final Map validAliases = new HashMap<>();
final String[] aliases = this.keyManager.getServerAliases(keyType, issuers);
if (aliases != null){
for (final String alias : aliases){
validAliases.put(alias, new PrivateKeyDetails(keyType, this.keyManager.getCertificateChain(alias)));
}
}
return validAliases;
}
@Override
public String chooseClientAlias(final String[] keyTypes,final Principal[] issuers,final Socket socket){
final Map validAliases = getClientAliasMap(keyTypes, issuers);
return this.aliasStrategy.chooseAlias(validAliases, socket);
}
@Override
public String[] getServerAliases(final String keyType,final Principal[] issuers){
return this.keyManager.getServerAliases(keyType, issuers);
}
@Override
public String chooseServerAlias(final String keyType,final Principal[] issuers,final Socket socket){
final Map validAliases = getServerAliasMap(keyType, issuers);
return this.aliasStrategy.chooseAlias(validAliases, socket);
}
@Override
public X509Certificate[] getCertificateChain(final String alias){
return this.keyManager.getCertificateChain(alias);
}
@Override
public PrivateKey getPrivateKey(final String alias){
return this.keyManager.getPrivateKey(alias);
}
@Override
public String chooseEngineClientAlias(final String[] keyTypes,final Principal[] issuers,final SSLEngine sslEngine){
final Map validAliases = getClientAliasMap(keyTypes, issuers);
return this.aliasStrategy.chooseAlias(validAliases, null);
}
@Override
public String chooseEngineServerAlias(final String keyType,final Principal[] issuers,final SSLEngine sslEngine){
final Map validAliases = getServerAliasMap(keyType, issuers);
return this.aliasStrategy.chooseAlias(validAliases, null);
}
}
@Override
public String toString(){
return "[provider=" + provider + ", protocol=" + protocol + ", keyStoreType=" + keyStoreType + ", keyManagerFactoryAlgorithm="
+ keyManagerFactoryAlgorithm + ", keyManagers=" + keyManagers + ", trustManagerFactoryAlgorithm="
+ trustManagerFactoryAlgorithm + ", trustManagers=" + trustManagers + ", secureRandom=" + secureRandom + "]";
}
}