diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/PrivateKeyParser.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/PrivateKeyParser.java index 924653d12528..93df27cb1c6c 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/PrivateKeyParser.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/PrivateKeyParser.java @@ -24,8 +24,11 @@ import java.security.GeneralSecurityException; import java.security.KeyFactory; import java.security.PrivateKey; -import java.security.spec.InvalidKeySpecException; import java.security.spec.PKCS8EncodedKeySpec; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.function.Function; import java.util.regex.Matcher; import java.util.regex.Pattern; @@ -45,21 +48,68 @@ final class PrivateKeyParser { private static final String PKCS1_FOOTER = "-+END\\s+RSA\\s+PRIVATE\\s+KEY[^-]*-+"; + private static final String PKCS8_HEADER = "-+BEGIN\\s+PRIVATE\\s+KEY[^-]*-+(?:\\s|\\r|\\n)+"; + private static final String PKCS8_FOOTER = "-+END\\s+PRIVATE\\s+KEY[^-]*-+"; - private static final String PKCS8_HEADER = "-+BEGIN\\s+PRIVATE\\s+KEY[^-]*-+(?:\\s|\\r|\\n)+"; + private static final String EC_HEADER = "-+BEGIN\\s+EC\\s+PRIVATE\\s+KEY[^-]*-+(?:\\s|\\r|\\n)+"; + + private static final String EC_FOOTER = "-+END\\s+EC\\s+PRIVATE\\s+KEY[^-]*-+"; private static final String BASE64_TEXT = "([a-z0-9+/=\\r\\n]+)"; - private static final Pattern PKCS1_PATTERN = Pattern.compile(PKCS1_HEADER + BASE64_TEXT + PKCS1_FOOTER, - Pattern.CASE_INSENSITIVE); + private static final List PEM_PARSERS; + static { + List parsers = new ArrayList<>(); + parsers.add(new PemParser(PKCS1_HEADER, PKCS1_FOOTER, "RSA", PrivateKeyParser::createKeySpecForPkcs1)); + parsers.add(new PemParser(EC_HEADER, EC_FOOTER, "EC", PrivateKeyParser::createKeySpecForEc)); + parsers.add(new PemParser(PKCS8_HEADER, PKCS8_FOOTER, "RSA", PKCS8EncodedKeySpec::new)); + PEM_PARSERS = Collections.unmodifiableList(parsers); + } + + /** + * ASN.1 encoded object identifier {@literal 1.2.840.113549.1.1.1}. + */ + private static final int[] RSA_ALGORITHM = { 0x2A, 0x86, 0x48, 0x86, 0xF7, 0x0D, 0x01, 0x01, 0x01 }; - private static final Pattern PKCS8_KEY_PATTERN = Pattern.compile(PKCS8_HEADER + BASE64_TEXT + PKCS8_FOOTER, - Pattern.CASE_INSENSITIVE); + /** + * ASN.1 encoded object identifier {@literal 1.2.840.10045.2.1}. + */ + private static final int[] EC_ALGORITHM = { 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x02, 0x01 }; + + /** + * ASN.1 encoded object identifier {@literal 1.3.132.0.34}. + */ + private static final int[] EC_PARAMETERS = { 0x2b, 0x81, 0x04, 0x00, 0x22 }; private PrivateKeyParser() { } + private static PKCS8EncodedKeySpec createKeySpecForPkcs1(byte[] bytes) { + return createKeySpecForAlgorithm(bytes, RSA_ALGORITHM, null); + } + + private static PKCS8EncodedKeySpec createKeySpecForEc(byte[] bytes) { + return createKeySpecForAlgorithm(bytes, EC_ALGORITHM, EC_PARAMETERS); + } + + private static PKCS8EncodedKeySpec createKeySpecForAlgorithm(byte[] bytes, int[] algorithm, int[] parameters) { + try { + DerEncoder encoder = new DerEncoder(); + encoder.integer(0x00); // Version 0 + DerEncoder algorithmIdentifier = new DerEncoder(); + algorithmIdentifier.objectIdentifier(algorithm); + algorithmIdentifier.objectIdentifier(parameters); + byte[] byteArray = algorithmIdentifier.toByteArray(); + encoder.sequence(byteArray); + encoder.octetString(bytes); + return new PKCS8EncodedKeySpec(encoder.toSequence()); + } + catch (IOException ex) { + throw new IllegalStateException(ex); + } + } + /** * Load a private key from the specified resource. * @param resource the private key to parse @@ -68,82 +118,139 @@ private PrivateKeyParser() { static PrivateKey parse(String resource) { try { String text = readText(resource); - Matcher matcher = PKCS1_PATTERN.matcher(text); - if (matcher.find()) { - return parsePkcs1(decodeBase64(matcher.group(1))); + for (PemParser pemParser : PEM_PARSERS) { + PrivateKey privateKey = pemParser.parse(text); + if (privateKey != null) { + return privateKey; + } } - matcher = PKCS8_KEY_PATTERN.matcher(text); - if (matcher.find()) { - return parsePkcs8(decodeBase64(matcher.group(1))); - } - throw new IllegalStateException("Unrecognized private key format in " + resource); + throw new IllegalStateException("Unrecognized private key format"); } - catch (GeneralSecurityException | IOException ex) { + catch (Exception ex) { throw new IllegalStateException("Error loading private key file " + resource, ex); } } - private static PrivateKey parsePkcs1(byte[] privateKeyBytes) throws GeneralSecurityException { - byte[] pkcs8Bytes = convertPkcs1ToPkcs8(privateKeyBytes); - return parsePkcs8(pkcs8Bytes); + private static String readText(String resource) throws IOException { + URL url = ResourceUtils.getURL(resource); + try (Reader reader = new InputStreamReader(url.openStream())) { + return FileCopyUtils.copyToString(reader); + } } - private static byte[] convertPkcs1ToPkcs8(byte[] pkcs1) { - try { - ByteArrayOutputStream result = new ByteArrayOutputStream(); - int pkcs1Length = pkcs1.length; - int totalLength = pkcs1Length + 22; - // Sequence + total length - result.write(bytes(0x30, 0x82)); - result.write((totalLength >> 8) & 0xff); - result.write(totalLength & 0xff); - // Integer (0) - result.write(bytes(0x02, 0x01, 0x00)); - // Sequence: 1.2.840.113549.1.1.1, NULL - result.write( - bytes(0x30, 0x0D, 0x06, 0x09, 0x2A, 0x86, 0x48, 0x86, 0xF7, 0x0D, 0x01, 0x01, 0x01, 0x05, 0x00)); - // Octet string + length - result.write(bytes(0x04, 0x82)); - result.write((pkcs1Length >> 8) & 0xff); - result.write(pkcs1Length & 0xff); - // PKCS1 - result.write(pkcs1); - return result.toByteArray(); + /** + * Parser for a specific PEM format. + */ + private static class PemParser { + + private final Pattern pattern; + + private final String algorithm; + + private final Function keySpecFactory; + + PemParser(String header, String footer, String algorithm, + Function keySpecFactory) { + this.pattern = Pattern.compile(header + BASE64_TEXT + footer, Pattern.CASE_INSENSITIVE); + this.algorithm = algorithm; + this.keySpecFactory = keySpecFactory; } - catch (IOException ex) { - throw new IllegalStateException(ex); + + PrivateKey parse(String text) { + Matcher matcher = this.pattern.matcher(text); + return (!matcher.find()) ? null : parse(decodeBase64(matcher.group(1))); + } + + private static byte[] decodeBase64(String content) { + byte[] contentBytes = content.replaceAll("\r", "").replaceAll("\n", "").getBytes(); + return Base64Utils.decode(contentBytes); } - } - private static byte[] bytes(int... elements) { - byte[] result = new byte[elements.length]; - for (int i = 0; i < elements.length; i++) { - result[i] = (byte) elements[i]; + private PrivateKey parse(byte[] bytes) { + try { + PKCS8EncodedKeySpec keySpec = this.keySpecFactory.apply(bytes); + KeyFactory keyFactory = KeyFactory.getInstance(this.algorithm); + return keyFactory.generatePrivate(keySpec); + } + catch (GeneralSecurityException ex) { + throw new IllegalArgumentException("Unexpected key format", ex); + } } - return result; + } - private static PrivateKey parsePkcs8(byte[] privateKeyBytes) throws GeneralSecurityException { - try { - PKCS8EncodedKeySpec keySpec = new PKCS8EncodedKeySpec(privateKeyBytes); - KeyFactory keyFactory = KeyFactory.getInstance("RSA"); - return keyFactory.generatePrivate(keySpec); + /** + * Simple ASN.1 DER encoder. + */ + static class DerEncoder { + + private final ByteArrayOutputStream stream = new ByteArrayOutputStream(); + + void objectIdentifier(int... encodedObjectIdentifier) throws IOException { + int code = (encodedObjectIdentifier != null) ? 0x06 : 0x05; + codeLengthBytes(code, bytes(encodedObjectIdentifier)); } - catch (InvalidKeySpecException ex) { - throw new IllegalArgumentException("Unexpected key format", ex); + + void integer(int... encodedInteger) throws IOException { + codeLengthBytes(0x02, bytes(encodedInteger)); } - } - private static String readText(String resource) throws IOException { - URL url = ResourceUtils.getURL(resource); - try (Reader reader = new InputStreamReader(url.openStream())) { - return FileCopyUtils.copyToString(reader); + void octetString(byte[] bytes) throws IOException { + codeLengthBytes(0x04, bytes); + } + + void sequence(int... elements) throws IOException { + sequence(bytes(elements)); + } + + void sequence(byte[] bytes) throws IOException { + codeLengthBytes(0x30, bytes); + } + + void codeLengthBytes(int code, byte[] bytes) throws IOException { + this.stream.write(code); + int length = (bytes != null) ? bytes.length : 0; + if (length <= 127) { + this.stream.write(length & 0xFF); + } + else { + ByteArrayOutputStream lengthStream = new ByteArrayOutputStream(); + while (length != 0) { + lengthStream.write(length & 0xFF); + length = length >> 8; + } + byte[] lengthBytes = lengthStream.toByteArray(); + this.stream.write(0x80 | lengthBytes.length); + for (int i = lengthBytes.length - 1; i >= 0; i--) { + this.stream.write(lengthBytes[i]); + } + } + if (bytes != null) { + this.stream.write(bytes); + } + } + + private static byte[] bytes(int... elements) { + if (elements == null) { + return null; + } + byte[] result = new byte[elements.length]; + for (int i = 0; i < elements.length; i++) { + result[i] = (byte) elements[i]; + } + return result; + } + + byte[] toSequence() throws IOException { + DerEncoder sequenceEncoder = new DerEncoder(); + sequenceEncoder.sequence(toByteArray()); + return sequenceEncoder.toByteArray(); + } + + byte[] toByteArray() { + return this.stream.toByteArray(); } - } - private static byte[] decodeBase64(String content) { - byte[] contentBytes = content.replaceAll("\r", "").replaceAll("\n", "").getBytes(); - return Base64Utils.decode(contentBytes); } } diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/server/PrivateKeyParserTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/server/PrivateKeyParserTests.java index 0a55581ea915..31a54748034b 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/server/PrivateKeyParserTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/server/PrivateKeyParserTests.java @@ -35,6 +35,15 @@ void parsePkcs8KeyFile() { PrivateKey privateKey = PrivateKeyParser.parse("classpath:test-key.pem"); assertThat(privateKey).isNotNull(); assertThat(privateKey.getFormat()).isEqualTo("PKCS#8"); + assertThat(privateKey.getAlgorithm()).isEqualTo("RSA"); + } + + @Test + void parsePkcs8KeyFileWithEcdsa() { + PrivateKey privateKey = PrivateKeyParser.parse("classpath:test-ec-key.pem"); + assertThat(privateKey).isNotNull(); + assertThat(privateKey.getFormat()).isEqualTo("PKCS#8"); + assertThat(privateKey.getAlgorithm()).isEqualTo("EC"); } @Test diff --git a/spring-boot-project/spring-boot/src/test/resources/test-ec-key.pem b/spring-boot-project/spring-boot/src/test/resources/test-ec-key.pem new file mode 100644 index 000000000000..b3a1ce0bd8ea --- /dev/null +++ b/spring-boot-project/spring-boot/src/test/resources/test-ec-key.pem @@ -0,0 +1,5 @@ +-----BEGIN EC PRIVATE KEY----- +MHcCAQEEIBEZhSR+d8kwL5L/K0f/eNBm4RfzyyA1jfg+dV1/8WvqoAoGCCqGSM49 +AwEHoUQDQgAEBbfdBTSUWuui7O2R+W9mDPjAHjgdBJsjrjnvkjnq8f/k4U/OqvjK +qnHEZwYgdaF2WqYdqBYMns0n+tSMgBoonQ== +-----END EC PRIVATE KEY-----