-
-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added support for Google Cloud KMS via HashiCorp Vault (#144)
- Loading branch information
1 parent
214413c
commit c592716
Showing
8 changed files
with
244 additions
and
5 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
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
146 changes: 146 additions & 0 deletions
146
jsign-core/src/main/java/net/jsign/jca/HashiCorpVaultSigningService.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,146 @@ | ||
| /** | ||
| * Copyright 2023 Maria Merkel | ||
| * | ||
| * 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 | ||
| * | ||
| * http://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 net.jsign.jca; | ||
|
|
||
| import java.io.IOException; | ||
| import java.security.GeneralSecurityException; | ||
| import java.security.KeyStoreException; | ||
| import java.security.UnrecoverableKeyException; | ||
| import java.security.cert.Certificate; | ||
| import java.util.Arrays; | ||
| import java.util.Base64; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.function.Function; | ||
|
|
||
| import com.cedarsoftware.util.io.JsonWriter; | ||
|
|
||
| import net.jsign.DigestAlgorithm; | ||
|
|
||
| /** | ||
| * Signing service using the HashiCorp Vault API. | ||
| * | ||
| * @see <a href="https://developer.hashicorp.com/vault/api-docs/secret/gcpkms">HashiCorp Vault API - Google Cloud KMS Secrets Engine</a> | ||
| * @since 5.0 | ||
| */ | ||
| public class HashiCorpVaultSigningService implements SigningService { | ||
|
|
||
| private final Function<String, Certificate[]> certificateStore; | ||
|
|
||
| /** Cache of private keys indexed by id */ | ||
| private final Map<String, SigningServicePrivateKey> keys = new HashMap<>(); | ||
|
|
||
| private final RESTClient client; | ||
|
|
||
| /** | ||
| * Creates a new HashiCorp Vault signing service. | ||
| * | ||
| * @param engineURL the URL of the HashiCorp Vault secrets engine | ||
| * @param token the HashiCorp Vault token | ||
| * @param certificateStore provides the certificate chain for the keys | ||
| */ | ||
| public HashiCorpVaultSigningService(String engineURL, String token, Function<String, Certificate[]> certificateStore) { | ||
| this.certificateStore = certificateStore; | ||
| this.client = new RESTClient(engineURL.endsWith("/") ? engineURL : engineURL + "/", conn -> conn.setRequestProperty("Authorization", "Bearer " + token)); | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return "HashiCorpVault"; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the list of key names available in the secrets engine. | ||
| * | ||
| * NOTE: This will return the key name only, not the key name and version. | ||
| * HashiCorp Vault does not provide a function to retrieve the key version. | ||
| * The key version will need to be appended to the key name when using the key. | ||
| * | ||
| * @return list of key names | ||
| */ | ||
| @Override | ||
| public List<String> aliases() throws KeyStoreException { | ||
| List<String> aliases; | ||
|
|
||
| try { | ||
| Map<String, ?> response = client.get("keys?list=true"); | ||
| String[] keys = ((Map<String, String[]>) response.get("data")).get("keys"); | ||
| aliases = Arrays.asList(keys); | ||
| } catch (IOException e) { | ||
| throw new KeyStoreException(e); | ||
| } | ||
|
|
||
| return aliases; | ||
| } | ||
|
|
||
| @Override | ||
| public Certificate[] getCertificateChain(String alias) throws KeyStoreException { | ||
| return certificateStore.apply(alias); | ||
| } | ||
|
|
||
| @Override | ||
| public SigningServicePrivateKey getPrivateKey(String alias, char[] password) throws UnrecoverableKeyException { | ||
| if (keys.containsKey(alias)) { | ||
| return keys.get(alias); | ||
| } | ||
|
|
||
| if (!alias.contains(":")) { | ||
| throw new UnrecoverableKeyException("Unable to fetch HashiCorp Vault Google Cloud private key '" + alias + "' (missing key version)"); | ||
| } | ||
|
|
||
| String algorithm; | ||
|
|
||
| try { | ||
| Map<String, ?> response = client.get("keys/" + alias.substring(0, alias.indexOf(":"))); | ||
| algorithm = ((Map<String, String>) response.get("data")).get("algorithm"); | ||
| } catch (IOException e) { | ||
| throw (UnrecoverableKeyException) new UnrecoverableKeyException("Unable to fetch HashiCorp Vault Google Cloud private key '" + alias + "'").initCause(e); | ||
| } | ||
|
|
||
| algorithm = algorithm.substring(0, algorithm.indexOf("_")).toUpperCase(); | ||
|
|
||
| SigningServicePrivateKey key = new SigningServicePrivateKey(alias, algorithm); | ||
| keys.put(alias, key); | ||
| return key; | ||
| } | ||
|
|
||
| @Override | ||
| public byte[] sign(SigningServicePrivateKey privateKey, String algorithm, byte[] data) throws GeneralSecurityException { | ||
| DigestAlgorithm digestAlgorithm = DigestAlgorithm.of(algorithm.substring(0, algorithm.toLowerCase().indexOf("with"))); | ||
| data = digestAlgorithm.getMessageDigest().digest(data); | ||
|
|
||
| String alias = privateKey.getId(); | ||
| String keyName = alias.substring(0, alias.indexOf(":")); | ||
| String keyVersion = alias.substring(alias.indexOf(":") + 1); | ||
|
|
||
| Map<String, Object> request = new HashMap<>(); | ||
| request.put("key_version", keyVersion); | ||
| request.put("digest", Base64.getEncoder().encodeToString(data)); | ||
|
|
||
| try { | ||
| Map<String, Object> args = new HashMap<>(); | ||
| args.put(JsonWriter.TYPE, "false"); | ||
| Map<String, ?> response = client.post("sign/" + keyName, JsonWriter.objectToJson(request, args)); | ||
| String signature = ((Map<String, String>) response.get("data")).get("signature"); | ||
|
|
||
| return Base64.getDecoder().decode(signature); | ||
| } catch (IOException e) { | ||
| throw new GeneralSecurityException(e); | ||
| } | ||
| } | ||
| } |
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