-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
crypto plugin abstractions,encrypted repositories and metadata mgmt
Signed-off-by: Vikas Bansal <[email protected]>
- Loading branch information
Showing
23 changed files
with
1,526 additions
and
28 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
182 changes: 182 additions & 0 deletions
182
server/src/main/java/org/opensearch/action/admin/cluster/crypto/CryptoSettings.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,182 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.action.admin.cluster.crypto; | ||
|
|
||
| import org.opensearch.action.ActionRequestValidationException; | ||
| import org.opensearch.common.io.stream.StreamInput; | ||
| import org.opensearch.common.io.stream.StreamOutput; | ||
| import org.opensearch.common.io.stream.Writeable; | ||
| import org.opensearch.common.settings.Settings; | ||
| import org.opensearch.common.xcontent.XContentType; | ||
| import org.opensearch.core.xcontent.ToXContentObject; | ||
| import org.opensearch.core.xcontent.XContentBuilder; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Map; | ||
|
|
||
| import static org.opensearch.action.ValidateActions.addValidationError; | ||
| import static org.opensearch.common.settings.Settings.Builder.EMPTY_SETTINGS; | ||
| import static org.opensearch.common.settings.Settings.readSettingsFromStream; | ||
| import static org.opensearch.common.settings.Settings.writeSettingsToStream; | ||
|
|
||
| /** | ||
| * Crypto settings supplied during a put repository request | ||
| * | ||
| * @opensearch.internal | ||
| */ | ||
| public class CryptoSettings implements Writeable, ToXContentObject { | ||
|
|
||
| private String keyProviderName; | ||
| private String keyProviderType; | ||
| private Settings settings = EMPTY_SETTINGS; | ||
|
|
||
| public CryptoSettings(StreamInput in) throws IOException { | ||
| keyProviderName = in.readString(); | ||
| keyProviderType = in.readString(); | ||
| settings = readSettingsFromStream(in); | ||
| } | ||
|
|
||
| public CryptoSettings(String keyProviderName) { | ||
| this.keyProviderName = keyProviderName; | ||
| } | ||
|
|
||
| /** | ||
| * Validate settings supplied in put repository request. | ||
| * @return Exception in case validation fails. | ||
| */ | ||
| public ActionRequestValidationException validate() { | ||
| ActionRequestValidationException validationException = null; | ||
| if (keyProviderName == null) { | ||
| validationException = addValidationError("key_provider_name is missing", validationException); | ||
| } | ||
| if (keyProviderType == null) { | ||
| validationException = addValidationError("key_provider_type is missing", validationException); | ||
| } | ||
| return validationException; | ||
| } | ||
|
|
||
| /** | ||
| * Returns key provider name | ||
| * @return keyProviderName | ||
| */ | ||
| public String getKeyProviderName() { | ||
| return keyProviderName; | ||
| } | ||
|
|
||
| /** | ||
| * Returns key provider type | ||
| * @return keyProviderType | ||
| */ | ||
| public String getKeyProviderType() { | ||
| return keyProviderType; | ||
| } | ||
|
|
||
| /** | ||
| * Returns crypto settings | ||
| * @return settings | ||
| */ | ||
| public Settings getSettings() { | ||
| return settings; | ||
| } | ||
|
|
||
| /** | ||
| * Constructs a new crypto settings with provided key provider name. | ||
| * @param keyProviderName Name of the key provider | ||
| */ | ||
| public CryptoSettings keyProviderName(String keyProviderName) { | ||
| this.keyProviderName = keyProviderName; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Constructs a new crypto settings with provided key provider type. | ||
| * @param keyProviderType Type of key provider to be used in encryption. | ||
| */ | ||
| public CryptoSettings keyProviderType(String keyProviderType) { | ||
| this.keyProviderType = keyProviderType; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the encryption settings | ||
| * | ||
| * @param settings for encryption | ||
| * @return this request | ||
| */ | ||
| public CryptoSettings settings(Settings.Builder settings) { | ||
| this.settings = settings.build(); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the encryption settings. | ||
| * | ||
| * @param source encryption settings in json or yaml format | ||
| * @param xContentType the content type of the source | ||
| * @return this request | ||
| */ | ||
| public CryptoSettings settings(String source, XContentType xContentType) { | ||
| this.settings = Settings.builder().loadFromSource(source, xContentType).build(); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the encryption settings. | ||
| * | ||
| * @param source encryption settings | ||
| * @return this request | ||
| */ | ||
| public CryptoSettings settings(Map<String, Object> source) { | ||
| this.settings = Settings.builder().loadFromMap(source).build(); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Parses crypto settings definition. | ||
| * | ||
| * @param cryptoDefinition crypto settings definition | ||
| */ | ||
| public CryptoSettings(Map<String, Object> cryptoDefinition) { | ||
| for (Map.Entry<String, Object> entry : cryptoDefinition.entrySet()) { | ||
| if (entry.getKey().equals("key_provider_name")) { | ||
| keyProviderName(entry.getValue().toString()); | ||
| } else if (entry.getKey().equals("key_provider_type")) { | ||
| keyProviderType(entry.getValue().toString()); | ||
| } else if (entry.getKey().equals("settings")) { | ||
| if (!(entry.getValue() instanceof Map)) { | ||
| throw new IllegalArgumentException("Malformed settings section in crypto settings, should include an inner object"); | ||
| } | ||
| @SuppressWarnings("unchecked") | ||
| Map<String, Object> sub = (Map<String, Object>) entry.getValue(); | ||
| settings(sub); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(StreamOutput out) throws IOException { | ||
| out.writeString(keyProviderName); | ||
| out.writeString(keyProviderType); | ||
| writeSettingsToStream(settings, out); | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(); | ||
| builder.field("key_provider_name", keyProviderName); | ||
| builder.field("key_provider_type", keyProviderType); | ||
|
|
||
| builder.startObject("settings"); | ||
| settings.toXContent(builder, params); | ||
| builder.endObject(); | ||
|
|
||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
server/src/main/java/org/opensearch/action/admin/cluster/crypto/package-info.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,12 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| /** | ||
| * Crypto client request and settings handlers. | ||
| */ | ||
| package org.opensearch.action.admin.cluster.crypto; |
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
Oops, something went wrong.