/*
 * Copyright [2020-2030] [https://www.stylefeng.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.
 *
 * Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
 *
 * 1.请不要删除和修改根目录下的LICENSE文件。
 * 2.请不要删除和修改Guns源码头部的版权声明。
 * 3.请保留源码和相关描述文件的项目出处，作者声明等。
 * 4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns
 * 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns
 * 6.若您的项目无法满足以上几点，可申请商业授权
 */
package cn.stylefeng.roses.kernel.auth.api.password;

import cn.stylefeng.roses.kernel.auth.api.pojo.password.SaltedEncryptResult;

/**
 * 密码存储时，将密码进行加密的api
 *
 * @author fengshuonan
 * @since 2020/12/21 16:50
 */
public interface PasswordStoredEncryptApi {

    /**
     * 加密密码
     *
     * @param originPassword 密码明文，待加密的密码
     * @return 加密后的密码密文
     * @author fengshuonan
     * @since 2020/12/21 16:52
     */
    String encrypt(String originPassword);

    /**
     * 加密密码，通过密码 + 盐的方式
     *
     * @param originPassword 密码明文，待加密的密码
     * @return 加密后的密码
     * @author fengshuonan
     * @since 2023/6/25 8:49
     */
    SaltedEncryptResult encryptWithSalt(String originPassword);

    /**
     * 校验密码加密前和加密后是否一致，多用于判断用户输入密码是否正确
     *
     * @param encryptBefore 密码明文
     * @return true-密码正确，false-密码错误
     * @author fengshuonan
     * @since 2020/12/21 17:09
     */
    Boolean checkPassword(String encryptBefore, String encryptAfter);

    /**
     * 校验密码，通过密码 + 盐的方式
     *
     * @author fengshuonan
     * @since 2023/6/25 8:51
     */
    Boolean checkPasswordWithSalt(String encryptBefore, String passwordSalt, String encryptAfter);

}
