Browse Source

Inline ResourceKeyConverterAdapter

Closes gh-9689
Closes gh-9626
Josh Cummings 4 years ago
parent
commit
17cfc6ade3

+ 70 - 1
config/src/main/java/org/springframework/security/config/crypto/RsaKeyConversionServicePostProcessor.java

@@ -18,6 +18,12 @@ package org.springframework.security.config.crypto;
 
 import java.beans.PropertyEditor;
 import java.beans.PropertyEditorSupport;
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.UncheckedIOException;
+import java.nio.charset.StandardCharsets;
+import java.security.Key;
 import java.security.interfaces.RSAPrivateKey;
 import java.security.interfaces.RSAPublicKey;
 
@@ -27,8 +33,9 @@ import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.core.convert.ConversionService;
 import org.springframework.core.convert.converter.Converter;
 import org.springframework.core.convert.converter.ConverterRegistry;
+import org.springframework.core.io.DefaultResourceLoader;
+import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
-import org.springframework.security.converter.ResourceKeyConverterAdapter;
 import org.springframework.security.converter.RsaKeyConverters;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
@@ -104,4 +111,66 @@ public class RsaKeyConversionServicePostProcessor implements BeanFactoryPostProc
 
 	}
 
+	static class ResourceKeyConverterAdapter<T extends Key> implements Converter<String, T> {
+
+		private ResourceLoader resourceLoader = new DefaultResourceLoader();
+
+		private final Converter<String, T> delegate;
+
+		/**
+		 * Construct a {@link ResourceKeyConverterAdapter} with the provided parameters
+		 * @param delegate converts a stream of key material into a {@link Key}
+		 */
+		ResourceKeyConverterAdapter(Converter<InputStream, T> delegate) {
+			this.delegate = pemInputStreamConverter().andThen(autoclose(delegate));
+		}
+
+		/**
+		 * {@inheritDoc}
+		 */
+		@Override
+		public T convert(String source) {
+			return this.delegate.convert(source);
+		}
+
+		/**
+		 * Use this {@link ResourceLoader} to read the key material
+		 * @param resourceLoader the {@link ResourceLoader} to use
+		 */
+		void setResourceLoader(ResourceLoader resourceLoader) {
+			Assert.notNull(resourceLoader, "resourceLoader cannot be null");
+			this.resourceLoader = resourceLoader;
+		}
+
+		private Converter<String, InputStream> pemInputStreamConverter() {
+			return (source) -> source.startsWith("-----") ? toInputStream(source)
+					: toInputStream(this.resourceLoader.getResource(source));
+		}
+
+		private InputStream toInputStream(String raw) {
+			return new ByteArrayInputStream(raw.getBytes(StandardCharsets.UTF_8));
+		}
+
+		private InputStream toInputStream(Resource resource) {
+			try {
+				return resource.getInputStream();
+			}
+			catch (IOException ex) {
+				throw new UncheckedIOException(ex);
+			}
+		}
+
+		private <T> Converter<InputStream, T> autoclose(Converter<InputStream, T> inputStreamKeyConverter) {
+			return (inputStream) -> {
+				try (InputStream is = inputStream) {
+					return inputStreamKeyConverter.convert(is);
+				}
+				catch (IOException ex) {
+					throw new UncheckedIOException(ex);
+				}
+			};
+		}
+
+	}
+
 }

+ 0 - 102
core/src/main/java/org/springframework/security/converter/ResourceKeyConverterAdapter.java

@@ -1,102 +0,0 @@
-/*
- * Copyright 2002-2021 the original author or authors.
- *
- * 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
- *
- *      https://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.
- */
-
-package org.springframework.security.converter;
-
-import java.io.ByteArrayInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.UncheckedIOException;
-import java.nio.charset.StandardCharsets;
-import java.security.Key;
-
-import org.springframework.core.convert.converter.Converter;
-import org.springframework.core.io.DefaultResourceLoader;
-import org.springframework.core.io.Resource;
-import org.springframework.core.io.ResourceLoader;
-import org.springframework.util.Assert;
-
-/**
- * Adapts any {@link Key} {@link Converter} into once that will first extract that key
- * from a resource.
- *
- * By default, keys can be read from the file system, the classpath, and from HTTP
- * endpoints. This can be customized by providing a {@link ResourceLoader}
- *
- * @author Josh Cummings
- * @since 5.5
- */
-public class ResourceKeyConverterAdapter<T extends Key> implements Converter<String, T> {
-
-	private ResourceLoader resourceLoader = new DefaultResourceLoader();
-
-	private final Converter<String, T> delegate;
-
-	/**
-	 * Construct a {@link ResourceKeyConverterAdapter} with the provided parameters
-	 * @param delegate converts a stream of key material into a {@link Key}
-	 */
-	public ResourceKeyConverterAdapter(Converter<InputStream, T> delegate) {
-		this.delegate = pemInputStreamConverter().andThen(autoclose(delegate));
-	}
-
-	/**
-	 * {@inheritDoc}
-	 */
-	@Override
-	public T convert(String source) {
-		return this.delegate.convert(source);
-	}
-
-	/**
-	 * Use this {@link ResourceLoader} to read the key material
-	 * @param resourceLoader the {@link ResourceLoader} to use
-	 */
-	public void setResourceLoader(ResourceLoader resourceLoader) {
-		Assert.notNull(resourceLoader, "resourceLoader cannot be null");
-		this.resourceLoader = resourceLoader;
-	}
-
-	private Converter<String, InputStream> pemInputStreamConverter() {
-		return (source) -> source.startsWith("-----") ? toInputStream(source)
-				: toInputStream(this.resourceLoader.getResource(source));
-	}
-
-	private InputStream toInputStream(String raw) {
-		return new ByteArrayInputStream(raw.getBytes(StandardCharsets.UTF_8));
-	}
-
-	private InputStream toInputStream(Resource resource) {
-		try {
-			return resource.getInputStream();
-		}
-		catch (IOException ex) {
-			throw new UncheckedIOException(ex);
-		}
-	}
-
-	private <T> Converter<InputStream, T> autoclose(Converter<InputStream, T> inputStreamKeyConverter) {
-		return (inputStream) -> {
-			try (InputStream is = inputStream) {
-				return inputStreamKeyConverter.convert(is);
-			}
-			catch (IOException ex) {
-				throw new UncheckedIOException(ex);
-			}
-		};
-	}
-
-}

+ 0 - 117
core/src/test/java/org/springframework/security/converter/ResourceKeyConverterAdapterTests.java

@@ -1,117 +0,0 @@
-/*
- * Copyright 2002-2021 the original author or authors.
- *
- * 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
- *
- *      https://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.
- */
-
-package org.springframework.security.converter;
-
-import java.security.interfaces.RSAPrivateKey;
-
-import org.junit.Before;
-import org.junit.Test;
-
-import org.springframework.core.io.DefaultResourceLoader;
-import org.springframework.core.io.Resource;
-import org.springframework.core.io.ResourceLoader;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
-/**
- * Tests for {@link ResourceKeyConverterAdapter}
- */
-public class ResourceKeyConverterAdapterTests {
-
-	// @formatter:off
-	private static final String PKCS8_PRIVATE_KEY = "-----BEGIN PRIVATE KEY-----\n"
-			+ "MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQCMk7CKSTfu3QoV\n"
-			+ "HoPVXxwZO+qweztd36cVWYqGOZinrOR2crWFu50AgR2CsdIH0+cqo7F4Vx7/3O8i\n"
-			+ "RpYYZPe2VoO5sumzJt8P6fS80/TAKjhJDAqgZKRJTgGN8KxCM6p/aJli1ZeDBqiV\n"
-			+ "v7vJJe+ZgJuPGRS+HMNa/wPxEkqqXsglcJcQV1ZEtfKXSHB7jizKpRL38185SyAC\n"
-			+ "pwyjvBu6Cmm1URfhQo88mf239ONh4dZ2HoDfzN1q6Ssu4F4hgutxr9B0DVLDP5u+\n"
-			+ "WFrm3nsJ76zf99uJ+ntMUHJ+bY+gOjSlVWIVBIZeAaEGKCNWRk/knjvjbijpvm3U\n"
-			+ "acGlgdL3AgMBAAECggEACxxxS7zVyu91qI2s5eSKmAQAXMqgup6+2hUluc47nqUv\n"
-			+ "uZz/c/6MPkn2Ryo+65d4IgqmMFjSfm68B/2ER5FTcvoLl1Xo2twrrVpUmcg3BClS\n"
-			+ "IZPuExdhVNnxjYKEWwcyZrehyAoR261fDdcFxLRW588efIUC+rPTTRHzAc7sT+Ln\n"
-			+ "t/uFeYNWJm3LaegOLoOmlMAhJ5puAWSN1F0FxtRf/RVgzbLA9QC975SKHJsfWCSr\n"
-			+ "IZyPsdeaqomKaF65l8nfqlE0Ua2L35gIOGKjUwb7uUE8nI362RWMtYdoi3zDDyoY\n"
-			+ "hSFbgjylCHDM0u6iSh6KfqOHtkYyJ8tUYgVWl787wQKBgQDYO3wL7xuDdD101Lyl\n"
-			+ "AnaDdFB9fxp83FG1cWr+t7LYm9YxGfEUsKHAJXN6TIayDkOOoVwIl+Gz0T3Z06Bm\n"
-			+ "eBGLrB9mrVA7+C7NJwu5gTMlzP6HxUR9zKJIQ/VB1NUGM77LSmvOFbHc9Q0+z8EH\n"
-			+ "X5WO516a3Z7lNtZJcCoPOtu2rwKBgQCmbj41Fh+SSEUApCEKms5ETRpe7LXQlJgx\n"
-			+ "yW7zcJNNuIb1C3vBLPxjiOTMgYKOeMg5rtHTGLT43URHLh9ArjawasjSAr4AM3J4\n"
-			+ "xpoi/sKGDdiKOsuDWIGfzdYL8qyTHSdpZLQsCTMRiRYgAHZFPgNa7SLZRfZicGlr\n"
-			+ "GHN1rJW6OQKBgEjiM/upyrJSWeypUDSmUeAZMpA6aWkwsfHgmtnkfUn5rQa74cDB\n"
-			+ "kKO9e+D7LmOR3z+SL/1NhGwh2SE07dncGr3jdGodfO/ZxZyszozmeaECKcEFwwJM\n"
-			+ "GV8WWPKplGwUwPiwywmZ0mvRxXcoe73KgBS88+xrSwWjqDL0tZiQlEJNAoGATkei\n"
-			+ "GMQMG3jEg9Wu+NbxV6zQT3+U0MNjhl9RQU1c63x0dcNt9OFc4NAdlZcAulRTENaK\n"
-			+ "OHjxffBM0hH+fySx8m53gFfr2BpaqDX5f6ZGBlly1SlsWZ4CchCVsc71nshipi7I\n"
-			+ "k8HL9F5/OpQdDNprJ5RMBNfkWE65Nrcsb1e6oPkCgYAxwgdiSOtNg8PjDVDmAhwT\n"
-			+ "Mxj0Dtwi2fAqQ76RVrrXpNp3uCOIAu4CfruIb5llcJ3uak0ZbnWri32AxSgk80y3\n"
-			+ "EWiRX/WEDu5znejF+5O3pI02atWWcnxifEKGGlxwkcMbQdA67MlrJLFaSnnGpNXo\n"
-			+ "yPfcul058SOqhafIZQMEKQ==\n"
-			+ "-----END PRIVATE KEY-----";
-	// @formatter:on
-
-	private static final String PKCS8_PRIVATE_KEY_LOCATION = "classpath:org/springframework/security/converter/simple.priv";
-
-	private ResourceKeyConverterAdapter<RSAPrivateKey> adapter;
-
-	@Before
-	public void setup() {
-		this.adapter = new ResourceKeyConverterAdapter<>(RsaKeyConverters.pkcs8());
-	}
-
-	@Test
-	public void convertWhenUsingAdapterForRawKeyThenOk() {
-		RSAPrivateKey key = this.adapter.convert(PKCS8_PRIVATE_KEY);
-		assertThat(key.getModulus().bitLength()).isEqualTo(2048);
-	}
-
-	@Test
-	public void convertWhenReferringToClasspathPublicKeyThenConverts() {
-		RSAPrivateKey key = this.adapter.convert(PKCS8_PRIVATE_KEY_LOCATION);
-		assertThat(key.getModulus().bitLength()).isEqualTo(2048);
-	}
-
-	@Test
-	public void convertWhenReferringToClasspathPrivateKeyThenConverts() {
-		this.adapter.setResourceLoader(new CustomResourceLoader());
-		RSAPrivateKey key = this.adapter.convert("custom:simple.priv");
-		assertThat(key.getModulus().bitLength()).isEqualTo(2048);
-	}
-
-	private static class CustomResourceLoader implements ResourceLoader {
-
-		private final ResourceLoader delegate = new DefaultResourceLoader();
-
-		@Override
-		public Resource getResource(String location) {
-			if (location.startsWith("classpath:")) {
-				return this.delegate.getResource(location);
-			}
-			else if (location.startsWith("custom:")) {
-				String[] parts = location.split(":");
-				return this.delegate.getResource("classpath:org/springframework/security/converter/" + parts[1]);
-			}
-			throw new IllegalArgumentException("unsupported resource");
-		}
-
-		@Override
-		public ClassLoader getClassLoader() {
-			return this.delegate.getClassLoader();
-		}
-
-	}
-
-}