forked from spring-projects/spring-boot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Verify ssl key alias on server startup
- Loading branch information
1 parent
747eab0
commit e351605
Showing
10 changed files
with
256 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
...-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/SslUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
/* | ||
* Copyright 2012-2019 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.boot.web.server; | ||
|
||
import java.security.KeyStore; | ||
import java.security.KeyStoreException; | ||
|
||
import org.springframework.util.Assert; | ||
import org.springframework.util.StringUtils; | ||
|
||
/** | ||
* Provides utilities around SSL. | ||
* | ||
* @author Chris Bono | ||
* @since 2.1.x | ||
*/ | ||
public final class SslUtils { | ||
|
||
private SslUtils() { | ||
} | ||
|
||
public static void assertStoreContainsAlias(KeyStore keyStore, String keyAlias) { | ||
if (!StringUtils.isEmpty(keyAlias)) { | ||
try { | ||
Assert.state(keyStore.containsAlias(keyAlias), | ||
() -> String.format("Keystore does not contain specified alias '%s'", keyAlias)); | ||
} | ||
catch (KeyStoreException ex) { | ||
throw new IllegalStateException( | ||
String.format("Could not determine if keystore contains alias '%s'", keyAlias), ex); | ||
} | ||
} | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
79 changes: 79 additions & 0 deletions
79
...t-project/spring-boot/src/test/java/org/springframework/boot/web/server/SslUtilsTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
/* | ||
* Copyright 2012-2019 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.boot.web.server; | ||
|
||
import java.io.File; | ||
import java.io.FileInputStream; | ||
import java.security.KeyStore; | ||
import java.security.KeyStoreException; | ||
|
||
import org.junit.Before; | ||
import org.junit.Test; | ||
|
||
import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
|
||
/** | ||
* Tests for {@link SslUtils}. | ||
* | ||
* @author Chris Bono | ||
*/ | ||
|
||
public class SslUtilsTest { | ||
|
||
private static final String VALID_ALIAS = "test-alias"; | ||
|
||
private static final String INVALID_ALIAS = "test-alias-5150"; | ||
|
||
private KeyStore keyStore; | ||
|
||
@Before | ||
public void loadKeystore() throws Exception { | ||
this.keyStore = KeyStore.getInstance(KeyStore.getDefaultType()); | ||
this.keyStore.load(new FileInputStream(new File("src/test/resources/test.jks")), "secret".toCharArray()); | ||
} | ||
|
||
@Test | ||
public void assertStoreContainsAliasPassesWhenAliasFound() throws KeyStoreException { | ||
SslUtils.assertStoreContainsAlias(this.keyStore, VALID_ALIAS); | ||
} | ||
|
||
@Test | ||
public void assertStoreContainsAliasPassesWhenNullAlias() throws KeyStoreException { | ||
SslUtils.assertStoreContainsAlias(this.keyStore, null); | ||
} | ||
|
||
@Test | ||
public void assertStoreContainsAliasPassesWhenEmptyAlias() throws KeyStoreException { | ||
SslUtils.assertStoreContainsAlias(this.keyStore, ""); | ||
} | ||
|
||
@Test | ||
public void assertStoreContainsAliasFailsWhenAliasNotFound() throws KeyStoreException { | ||
assertThatThrownBy(() -> SslUtils.assertStoreContainsAlias(this.keyStore, INVALID_ALIAS)) | ||
.isInstanceOf(IllegalStateException.class) | ||
.hasMessage("Keystore does not contain specified alias '" + INVALID_ALIAS + "'"); | ||
} | ||
|
||
@Test | ||
public void assertStoreContainsAliasFailsWhenKeyStoreThrowsExceptionOnContains() throws KeyStoreException { | ||
KeyStore uninitializedKeyStore = KeyStore.getInstance(KeyStore.getDefaultType()); | ||
assertThatThrownBy(() -> SslUtils.assertStoreContainsAlias(uninitializedKeyStore, "alias")) | ||
.isInstanceOf(IllegalStateException.class) | ||
.hasMessage("Could not determine if keystore contains alias 'alias'"); | ||
} | ||
|
||
} |
Oops, something went wrong.