org.ofdrw.crypto.enryptor.UserFEKEncryptor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ofdrw-crypto Show documentation

依照《GM/T 0099-2020 开放板式文档密码应用技术规范》实现OFD加解密、完整性保护等密码操作。

The newest version!

package org.ofdrw.crypto.enryptor;

import org.bouncycastle.crypto.CryptoException;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.ofdrw.core.crypto.ProtectionCaseID;
import org.ofdrw.core.crypto.encryt.UserInfo;

import java.io.IOException;
import java.security.GeneralSecurityException;

/**
 * 用户 文件加密密钥 加密器 User File Encrypt Key Encryptor
 * 
 * 用于加密 文件加密密钥 生成 {@link org.ofdrw.core.crypto.encryt.UserInfo}
 *
 * @author 权观宇
 * @since 2021-07-13 19:07:11
 */
public interface UserFEKEncryptor {

    /**
     * 加密 文件加密密钥 并封装为
     *
     * @param fek 文件加密密钥（File Encrypt Key ）
     * @param iv  加密向量IV
     * @return 用户信息（包含加密的文件加密密钥）
     * @throws CryptoException          加密过程运行异常
     * @throws IOException              IO操作异常
     * @throws GeneralSecurityException 加密异常
     */
    UserInfo encrypt(@NotNull byte[] fek, @NotNull byte[] iv) throws CryptoException, IOException, GeneralSecurityException;

    /**
     * 用户加密时使用的证书，仅在使用证书加密的加密器中需要实现
     *
     * @return 证书文件字节内容（DER编码），在使用口令加密时可返还null
     * @throws GeneralSecurityException 证书编码错误
     */
    byte[] userCert() throws GeneralSecurityException;

    /**
     * 加密保护方案标识，见附录 A.1 {@link ProtectionCaseID}
     *
     * @return 加密保护方案标识
     */
    @NotNull
    String encryptCaseId();
}