解决 Java 加载 pfx 报密码错误

解决Java 在加载 AES256-SHA256 加密格式的 pfx 文件时报密码错误.

环境:

• Windows
• Amazon Corretto 8

摘要

Windows 导出的 pfx 私钥加密方式有两种, 分别是 AES256-SHA256 和 TripleDES-SHA1.

Corretto 8 能正常加载 TripleDES-SHA1 加密格式的证书, 但是不能加载 AES256-SHA256 加密的证书. 错误提示如下:

keystore password was incorrect
java.io.IOException: keystore password was incorrect
    at sun.security.pkcs12.PKCS12KeyStore.engineLoad(PKCS12KeyStore.java:2079)
    at java.security.KeyStore.load(KeyStore.java:1445)
    .....
Caused by: java.security.UnrecoverableKeyException:
    failed to decrypt safe contents entry:
    javax.crypto.BadPaddingException:
    Given final block not properly padded. Such issues can arise if a bad key is used during decryption.
    ... 89 more

当然, 首先应该确保的是我们给定密码是正确的.

解决方案

首先在项目中添加 Bouncy Castle Provider 依赖.

Gradle

// https://mvnrepository.com/artifact/org.bouncycastle/bcprov-jdk15on
implementation 'org.bouncycastle:bcprov-jdk15on:1.70'

示例代码.

// import java.io.BufferedInputStream;
// import java.io.IOException;
// import java.io.InputStream;
// import java.security.*;
// import java.util.Enumeration;

public static PrivateKey loadPrivateKey(InputStream in, char[] pass) throws IOException, GeneralSecurityException {
    // 导出的私钥加密方式有两种, 分别是 AES256-SHA256 和 TripleDES-SHA1
    // 部分JRE (比如说 Corretto 8) 默认的 KeyStore 不支持第一种加密方式.
    // see https://bugs.openjdk.org/browse/JDK-8220734
    //
    // 所以我们要在失败之后尝试使用 BouncyCastle 来加载.

    // 为了在失败后使用BC加载, 所以我们需要一个可重复读的流
    InputStream stream = in.markSupported() ? in : new BufferedInputStream(in);

    final String keyStoreType = "PKCS12";
    KeyStore ks = KeyStore.getInstance(keyStoreType);
    try {
        stream.mark(stream.available()); // available 大概率是有效的, 通常来说 in 应该是本地文件流
        ks.load(stream, pass);
    } catch (IOException e) {
        if (!"keystore password was incorrect".equals(e.getMessage())) {
            throw e;
        }
        try {
            Class<?> bc;
            try {
                bc = Class.forName("org.bouncycastle.jce.provider.BouncyCastleProvider");
            } catch (ClassNotFoundException e2) {
                throw new RuntimeException(
                        "password error using JDK default KeyStore, and BouncyCastle not found"
                );
            }
            Object provider = bc.newInstance();
            Security.addProvider((Provider) provider);
            ks = KeyStore.getInstance(keyStoreType, "BC");
        } catch (Exception e2) {
            throw new RuntimeException(
                    "password error. Trying to use BouncyCastle but occurs an error", e2
            );
        }
        stream.reset();
        ks.load(stream, pass);
    }
    Enumeration<String> iter = ks.aliases();
    if (!iter.hasMoreElements()) {
        throw new IOException("invalid private key file");
    }
    String keyPfxPath = iter.nextElement();
    PrivateKey privateKey = (PrivateKey) ks.getKey(keyPfxPath, pass);
    assert privateKey != null;
    return privateKey;
}

上面示例代码是非入侵式的. 如果目还在开发中, 建议在第一次使用的的时候就采用 BC 来加载. 因为BC 对两种加密格式都支持.

在加载之前将 BC 注册到系统中

// import java.security.Security;
// import org.bouncycastle.jce.provider.BouncyCastleProvider;

Security.addProvider(new BouncyCastleProvider());