com.buession.security.crypto.Crypto Maven / Gradle / Ivy

Go to download
/*
 * 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
 * .
 *
 * +-------------------------------------------------------------------------------------------------------+
 * | License: http://www.apache.org/licenses/LICENSE-2.0.txt 										       |
 * | Author: Yong.Teng  													       |
 * | Copyright @ 2013-2023 Buession.com Inc.														       |
 * +-------------------------------------------------------------------------------------------------------+
 */
package com.buession.security.crypto;

import java.nio.charset.Charset;
import java.security.Provider;

/**
 * 加解密
 *
 * @author Yong.Teng
 * @since 2.3.0
 */
public interface Crypto {

	/**
	 * 返回请求算法的名称
	 *
	 * @return 返回请求算法的名称
	 */
	String getAlgorithmName();

	/**
	 * 返回加密密钥
	 *
	 * @return 加密密钥
	 */
	String getSalt();

	/**
	 * 设置加密密钥
	 *
	 * @param salt
	 * 		加密密钥
	 */
	void setSalt(final String salt);

	/**
	 * 获取字符串编码
	 *
	 * @return 字符串编码
	 */
	Charset getCharset();

	/**
	 * 设置字符串编码
	 *
	 * @param charset
	 * 		字符串编码
	 */
	void setCharset(final Charset charset);

	/**
	 * 返回此信息摘要对象的提供者
	 *
	 * @return 信息摘要对象的提供者
	 */
	Provider getProvider();

	/**
	 * 设置信息摘要对象的提供者
	 *
	 * @param provider
	 * 		信息摘要对象的提供者
	 */
	void setProvider(final Provider provider);

	/**
	 * 对象加密
	 *
	 * @param object
	 * 		需要加密的字符串
	 *
	 * @return 加密后的字符串
	 */
	String encrypt(final Object object);

	/**
	 * 字符串解密
	 * 该方法需要提供信息摘要算法支持双向解密才可用
	 *
	 * @param cs
	 * 		要被解密的 char 值序列
	 *
	 * @return 解密后的字符串
	 */
	String decrypt(final CharSequence cs);

}