org.dromara.hutool.crypto.provider.GlobalProviderFactory Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* 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 org.dromara.hutool.crypto.provider;
import org.dromara.hutool.core.spi.SpiUtil;
import org.dromara.hutool.crypto.SecureUtil;
import java.security.Provider;
/**
* 全局单例的{@link Provider}对象
* 在此类加载时，通过SPI方式查找用户引入的加密库，查找对应的{@link Provider}实现，然后全局创建唯一的{@link Provider}对象
* 用户依旧可以通过{@link #setUseCustomProvider(boolean)} 方法选择是否使用自定义的Provider。
*
* @author looly
*/
public class GlobalProviderFactory {
private static boolean useCustomProvider = true;
private static final Provider provider = _createProvider();
/**
* 获取{@link Provider}，无提供方，返回{@code null}表示使用JDK默认
*
* @return {@link Provider} or {@code null}
*/
public static Provider getProvider() {
return useCustomProvider ? provider : null;
}
/**
* 设置是否使用自定义的{@link Provider}
* 如果设置为false，表示使用JDK默认的Provider
*
* @param isUseCustomProvider 是否使用自定义{@link Provider}
*/
public static void setUseCustomProvider(final boolean isUseCustomProvider) {
useCustomProvider = isUseCustomProvider;
}
/**
* 通过SPI方式，创建{@link Provider}，无提供的返回{@code null}
*
* @return {@link Provider} or {@code null}
*/
private static Provider _createProvider() {
final ProviderFactory factory = SpiUtil.loadFirstAvailable(ProviderFactory.class);
if (null == factory) {
// 默认JCE
return null;
}
final Provider provider = factory.create();
// issue#2631@Github
SecureUtil.addProvider(provider);
return provider;
}
}