io.polaris.crypto.PemKeys Maven / Gradle / Ivy
package io.polaris.crypto;
import io.polaris.core.crypto.CryptoKeys;
import io.polaris.core.io.IO;
import io.polaris.core.string.Strings;
import org.bouncycastle.util.io.pem.PemObject;
import org.bouncycastle.util.io.pem.PemObjectGenerator;
import org.bouncycastle.util.io.pem.PemReader;
import org.bouncycastle.util.io.pem.PemWriter;
import java.io.*;
import java.nio.charset.StandardCharsets;
import java.security.GeneralSecurityException;
import java.security.Key;
import java.security.PrivateKey;
import java.security.PublicKey;
/**
* PEM(Privacy Enhanced Mail)格式相关工具类。（基于Bouncy Castle）
*
*
* PEM一般为文本格式，以 -----BEGIN... 开头，以 -----END... 结尾，中间的内容是 BASE64 编码。
*
* 这种格式可以保存证书和私钥，有时我们也把PEM格式的私钥的后缀改为 .key 以区别证书与私钥。
*
* @author Qt
* @since 1.8
*/
public class PemKeys {
/**
* 读取PEM格式的私钥，支持PKCS#8和PKCS#1的ECC格式
*
* @param pemStream pem流
* @return {@link PrivateKey}
*/
public static PrivateKey readPemPrivateKey(InputStream pemStream) throws GeneralSecurityException, IOException {
return (PrivateKey) readPemKey(pemStream);
}
/**
* 读取PEM格式的公钥
*
* @param pemStream pem流
* @return {@link PublicKey}
*/
public static PublicKey readPemPublicKey(InputStream pemStream) throws GeneralSecurityException, IOException {
return (PublicKey) readPemKey(pemStream);
}
/**
* 从pem文件中读取公钥或私钥
* 根据类型返回 {@link PublicKey} 或者 {@link PrivateKey}
*
* @param keyStream pem流
* @return {@link Key}，null表示无法识别的密钥类型
*/
public static Key readPemKey(InputStream keyStream) throws GeneralSecurityException, IOException {
final PemObject object = readPemObject(keyStream);
final String type = object.getType();
if (Strings.isNotBlank(type)) {
//private
if (type.endsWith("EC PRIVATE KEY")) {
try {
// 尝试PKCS#8
return CryptoKeys.generatePrivateKey("EC", object.getContent());
} catch (final Exception e) {
// 尝试PKCS#1
return CryptoKeys.generatePrivateKey("EC", ECKeys.createOpenSSHPrivateKeySpec(object.getContent()));
}
}
if (type.endsWith("PRIVATE KEY")) {
return CryptoKeys.generateRSAPrivateKey(object.getContent());
}
// public
if (type.endsWith("EC PUBLIC KEY")) {
try {
// 尝试DER
return CryptoKeys.generatePublicKey("EC", object.getContent());
} catch (Exception e) {
// 尝试PKCS#1
return CryptoKeys.generatePublicKey("EC", ECKeys.createOpenSSHPublicKeySpec(object.getContent()));
}
} else if (type.endsWith("PUBLIC KEY")) {
return CryptoKeys.generateRSAPublicKey(object.getContent());
} else if (type.endsWith("CERTIFICATE")) {
return CryptoKeys.readPublicKeyByX509(new ByteArrayInputStream(object.getContent()));
}
}
//表示无法识别的密钥类型
return null;
}
/**
* 从pem流中读取公钥或私钥
*
* @param keyStream pem流
* @return 密钥bytes
*/
public static byte[] readPem(InputStream keyStream) throws IOException {
final PemObject pemObject = readPemObject(keyStream);
if (null != pemObject) {
return pemObject.getContent();
}
return null;
}
/**
* 读取pem文件中的信息，包括类型、头信息和密钥内容
*
* @param keyStream pem流
* @return {@link PemObject}
*/
public static PemObject readPemObject(InputStream keyStream) throws IOException {
return readPemObject(IO.getReader(keyStream, StandardCharsets.UTF_8));
}
/**
* 读取pem文件中的信息，包括类型、头信息和密钥内容
*
* @param reader pem Reader
* @return {@link PemObject}
*/
public static PemObject readPemObject(Reader reader) throws IOException {
PemReader pemReader = null;
try {
pemReader = new PemReader(reader);
return pemReader.readPemObject();
} finally {
IO.close(pemReader);
}
}
/**
* 读取OpenSSL生成的ANS1格式的Pem私钥文件，必须为PKCS#1格式
*
* @param keyStream 私钥pem流
* @return {@link PrivateKey}
* @deprecated 请使用 {@link #readPemPrivateKey(InputStream)}
*/
@Deprecated
public static PrivateKey readSm2PemPrivateKey(InputStream keyStream) throws GeneralSecurityException, IOException {
return readPemPrivateKey(keyStream);
}
/**
* 将私钥或公钥转换为PEM格式的字符串
*
* @param type 密钥类型（私钥、公钥、证书）
* @param content 密钥内容
* @return PEM内容
*/
public static String toPem(String type, byte[] content) throws IOException {
final StringWriter stringWriter = new StringWriter();
writePemObject(type, content, stringWriter);
return stringWriter.toString();
}
/**
* 写出pem密钥（私钥、公钥、证书）
*
* @param type 密钥类型（私钥、公钥、证书）
* @param content 密钥内容，需为PKCS#1格式
* @param keyStream pem流
*/
public static void writePemObject(String type, byte[] content, OutputStream keyStream) throws IOException {
writePemObject(new PemObject(type, content), keyStream);
}
/**
* 写出pem密钥（私钥、公钥、证书）
*
* @param type 密钥类型（私钥、公钥、证书）
* @param content 密钥内容，需为PKCS#1或PKCS#8格式
* @param writer pemWriter
*/
public static void writePemObject(String type, byte[] content, Writer writer) throws IOException {
writePemObject(new PemObject(type, content), writer);
}
/**
* 写出pem密钥（私钥、公钥、证书）
*
* @param pemObject pem对象，包括密钥和密钥类型等信息
* @param keyStream pem流
*/
public static void writePemObject(PemObjectGenerator pemObject, OutputStream keyStream) throws IOException {
writePemObject(pemObject, IO.getWriter(keyStream, StandardCharsets.UTF_8));
}
/**
* 写出pem密钥（私钥、公钥、证书）
*
* @param pemObject pem对象，包括密钥和密钥类型等信息
* @param writer pemWriter
*/
public static void writePemObject(PemObjectGenerator pemObject, Writer writer) throws IOException {
final PemWriter pemWriter = new PemWriter(writer);
try {
pemWriter.writeObject(pemObject);
} finally {
IO.close(pemWriter);
}
}
}