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.
Add support for SSL bundles in SAML2 signing auto-configuration
- Loading branch information
1 parent
40bb05d
commit e136fc1
Showing
9 changed files
with
438 additions
and
111 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
123 changes: 123 additions & 0 deletions
123
...oot-project/spring-boot/src/main/java/org/springframework/boot/ssl/SslBundleKeyStore.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,123 @@ | ||
| /* | ||
| * Copyright 2012-2024 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.ssl; | ||
|
|
||
| import java.security.GeneralSecurityException; | ||
| import java.security.Key; | ||
| import java.security.KeyStore; | ||
| import java.security.KeyStoreException; | ||
| import java.security.PrivateKey; | ||
| import java.security.UnrecoverableKeyException; | ||
| import java.security.cert.Certificate; | ||
| import java.security.cert.X509Certificate; | ||
| import java.util.Enumeration; | ||
|
|
||
| import org.springframework.util.Assert; | ||
|
|
||
| /** | ||
| * Provides access to private keys and certificates from a {@link KeyStore} created from | ||
| * an {@link SslBundle}. | ||
| * | ||
| * @author Scott Frederick | ||
| * @since 3.4.0 | ||
| */ | ||
| public final class SslBundleKeyStore { | ||
|
|
||
| private final KeyStore keyStore; | ||
|
|
||
| private final SslBundleKey sslBundleKey; | ||
|
|
||
| private SslBundleKeyStore(KeyStore keyStore, SslBundleKey sslBundleKey) { | ||
| this.sslBundleKey = sslBundleKey; | ||
| this.keyStore = keyStore; | ||
| } | ||
|
|
||
| public PrivateKey getPrivateKey() { | ||
| String keyAlias = this.sslBundleKey.getAlias(); | ||
| String keyPassword = this.sslBundleKey.getPassword(); | ||
| try { | ||
| if (keyAlias != null) { | ||
| Key key = this.keyStore.getKey(keyAlias, keyPassword.toCharArray()); | ||
| Assert.notNull(key, "Private key with alias '" + keyAlias + "' was not found in SSL bundle"); | ||
| Assert.isInstanceOf(PrivateKey.class, key, | ||
| "Key with alias '" + keyAlias + "' was expected to be a PrivateKey"); | ||
| return (PrivateKey) key; | ||
| } | ||
| return getFirstPrivateKey(this.keyStore, keyPassword); | ||
| } | ||
| catch (UnrecoverableKeyException kex) { | ||
| throw new IllegalArgumentException("Key with alias '" + keyAlias | ||
| + "' could not be retrieved from the key store with the provided password", kex); | ||
| } | ||
| catch (GeneralSecurityException ex) { | ||
| throw new IllegalStateException("Error getting private key from SSL bundle", ex); | ||
| } | ||
| } | ||
|
|
||
| public X509Certificate getCertificate() { | ||
| String keyAlias = (this.sslBundleKey != null) ? this.sslBundleKey.getAlias() : null; | ||
| try { | ||
| if (keyAlias != null) { | ||
| Certificate certificate = this.keyStore.getCertificate(keyAlias); | ||
| Assert.notNull(certificate, "Certificate with alias '" + keyAlias + "' was not found in SSL bundle"); | ||
| Assert.isInstanceOf(X509Certificate.class, certificate, | ||
| "Certificate with alias '" + keyAlias + "' was expected to be an X509Certificate"); | ||
| return (X509Certificate) certificate; | ||
| } | ||
| return getFirstCertificate(this.keyStore); | ||
| } | ||
| catch (GeneralSecurityException ex) { | ||
| throw new IllegalStateException("Error getting X509 certificate from SSL bundle", ex); | ||
| } | ||
| } | ||
|
|
||
| private PrivateKey getFirstPrivateKey(KeyStore keyStore, String keyPassword) throws KeyStoreException { | ||
| Enumeration<String> aliases = keyStore.aliases(); | ||
| while (aliases.hasMoreElements()) { | ||
| String alias = aliases.nextElement(); | ||
| if (keyStore.isKeyEntry(alias)) { | ||
| try { | ||
| Key key = keyStore.getKey(alias, (keyPassword != null) ? keyPassword.toCharArray() : null); | ||
| if (key instanceof PrivateKey privateKey) { | ||
| return privateKey; | ||
| } | ||
| } | ||
| catch (GeneralSecurityException ex) { | ||
| // did not find the key matching the password, keep looking | ||
| } | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private X509Certificate getFirstCertificate(KeyStore keyStore) throws KeyStoreException { | ||
| Enumeration<String> aliases = keyStore.aliases(); | ||
| while (aliases.hasMoreElements()) { | ||
| String alias = aliases.nextElement(); | ||
| Certificate certificate = keyStore.getCertificate(alias); | ||
| if (certificate instanceof X509Certificate) { | ||
| return (X509Certificate) certificate; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| public static SslBundleKeyStore from(KeyStore keyStore, SslBundleKey sslBundleKey) { | ||
| return new SslBundleKeyStore(keyStore, sslBundleKey); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.