|
| 1 | +/* |
| 2 | + * Licensed to Elasticsearch under one or more contributor |
| 3 | + * license agreements. See the NOTICE file distributed with |
| 4 | + * this work for additional information regarding copyright |
| 5 | + * ownership. Elasticsearch licenses this file to you under |
| 6 | + * the Apache License, Version 2.0 (the "License"); you may |
| 7 | + * not use this file except in compliance with the License. |
| 8 | + * You may obtain a copy of the License at |
| 9 | + * |
| 10 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | + * |
| 12 | + * Unless required by applicable law or agreed to in writing, |
| 13 | + * software distributed under the License is distributed on an |
| 14 | + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | + * KIND, either express or implied. See the License for the |
| 16 | + * specific language governing permissions and limitations |
| 17 | + * under the License. |
| 18 | + */ |
| 19 | +package org.elasticsearch.repositories.gcs; |
| 20 | + |
| 21 | +import com.google.api.client.googleapis.auth.oauth2.GoogleCredential; |
| 22 | +import com.google.api.services.storage.StorageScopes; |
| 23 | +import org.elasticsearch.common.settings.SecureSetting; |
| 24 | +import org.elasticsearch.common.settings.Setting; |
| 25 | +import org.elasticsearch.common.settings.Settings; |
| 26 | +import org.elasticsearch.common.unit.TimeValue; |
| 27 | + |
| 28 | +import java.io.IOException; |
| 29 | +import java.io.InputStream; |
| 30 | +import java.io.UncheckedIOException; |
| 31 | +import java.util.Collections; |
| 32 | +import java.util.HashMap; |
| 33 | +import java.util.Locale; |
| 34 | +import java.util.Map; |
| 35 | + |
| 36 | +import static org.elasticsearch.common.settings.Setting.timeSetting; |
| 37 | + |
| 38 | +/** |
| 39 | + * Container for Google Cloud Storage clients settings. |
| 40 | + */ |
| 41 | +public class GoogleCloudStorageClientSettings { |
| 42 | + |
| 43 | + private static final String PREFIX = "gcs.client."; |
| 44 | + |
| 45 | + /** A json Service Account file loaded from secure settings. */ |
| 46 | + static final Setting.AffixSetting<InputStream> CREDENTIALS_FILE_SETTING = Setting.affixKeySetting(PREFIX, "credentials_file", |
| 47 | + key -> SecureSetting.secureFile(key, null)); |
| 48 | + |
| 49 | + /** An override for the Storage endpoint to connect to. */ |
| 50 | + static final Setting.AffixSetting<String> ENDPOINT_SETTING = Setting.affixKeySetting(PREFIX, "endpoint", |
| 51 | + key -> new Setting<>(key, "", s -> s, Setting.Property.NodeScope)); |
| 52 | + |
| 53 | + /** |
| 54 | + * The timeout to establish a connection. A value of {@code -1} corresponds to an infinite timeout. A value of {@code 0} |
| 55 | + * corresponds to the default timeout of the Google Cloud Storage Java Library. |
| 56 | + */ |
| 57 | + static final Setting.AffixSetting<TimeValue> CONNECT_TIMEOUT_SETTING = Setting.affixKeySetting(PREFIX, "connect_timeout", |
| 58 | + key -> timeSetting(key, TimeValue.ZERO, TimeValue.MINUS_ONE, Setting.Property.NodeScope)); |
| 59 | + |
| 60 | + /** |
| 61 | + * The timeout to read data from an established connection. A value of {@code -1} corresponds to an infinite timeout. A value of |
| 62 | + * {@code 0} corresponds to the default timeout of the Google Cloud Storage Java Library. |
| 63 | + */ |
| 64 | + static final Setting.AffixSetting<TimeValue> READ_TIMEOUT_SETTING = Setting.affixKeySetting(PREFIX, "read_timeout", |
| 65 | + key -> timeSetting(key, TimeValue.ZERO, TimeValue.MINUS_ONE, Setting.Property.NodeScope)); |
| 66 | + |
| 67 | + /** Name used by the client when it uses the Google Cloud JSON API. **/ |
| 68 | + static final Setting.AffixSetting<String> APPLICATION_NAME_SETTING = Setting.affixKeySetting(PREFIX, "application_name", |
| 69 | + key -> new Setting<>(key, "repository-gcs", s -> s, Setting.Property.NodeScope)); |
| 70 | + |
| 71 | + /** The credentials used by the client to connect to the Storage endpoint **/ |
| 72 | + private final GoogleCredential credential; |
| 73 | + |
| 74 | + /** The Storage root URL the client should talk to, or empty string to use the default. **/ |
| 75 | + private final String endpoint; |
| 76 | + |
| 77 | + /** The timeout to establish a connection **/ |
| 78 | + private final TimeValue connectTimeout; |
| 79 | + |
| 80 | + /** The timeout to read data from an established connection **/ |
| 81 | + private final TimeValue readTimeout; |
| 82 | + |
| 83 | + /** The Storage client application name **/ |
| 84 | + private final String applicationName; |
| 85 | + |
| 86 | + GoogleCloudStorageClientSettings(final GoogleCredential credential, |
| 87 | + final String endpoint, |
| 88 | + final TimeValue connectTimeout, |
| 89 | + final TimeValue readTimeout, |
| 90 | + final String applicationName) { |
| 91 | + this.credential = credential; |
| 92 | + this.endpoint = endpoint; |
| 93 | + this.connectTimeout = connectTimeout; |
| 94 | + this.readTimeout = readTimeout; |
| 95 | + this.applicationName = applicationName; |
| 96 | + } |
| 97 | + |
| 98 | + public GoogleCredential getCredential() { |
| 99 | + return credential; |
| 100 | + } |
| 101 | + |
| 102 | + public String getEndpoint() { |
| 103 | + return endpoint; |
| 104 | + } |
| 105 | + |
| 106 | + public TimeValue getConnectTimeout() { |
| 107 | + return connectTimeout; |
| 108 | + } |
| 109 | + |
| 110 | + public TimeValue getReadTimeout() { |
| 111 | + return readTimeout; |
| 112 | + } |
| 113 | + |
| 114 | + public String getApplicationName() { |
| 115 | + return applicationName; |
| 116 | + } |
| 117 | + |
| 118 | + public static Map<String, GoogleCloudStorageClientSettings> load(final Settings settings) { |
| 119 | + final Map<String, GoogleCloudStorageClientSettings> clients = new HashMap<>(); |
| 120 | + for (String clientName: settings.getGroups(PREFIX).keySet()) { |
| 121 | + clients.put(clientName, getClientSettings(settings, clientName)); |
| 122 | + } |
| 123 | + if (clients.containsKey("default") == false) { |
| 124 | + // this won't find any settings under the default client, |
| 125 | + // but it will pull all the fallback static settings |
| 126 | + clients.put("default", getClientSettings(settings, "default")); |
| 127 | + } |
| 128 | + return Collections.unmodifiableMap(clients); |
| 129 | + } |
| 130 | + |
| 131 | + static GoogleCloudStorageClientSettings getClientSettings(final Settings settings, final String clientName) { |
| 132 | + return new GoogleCloudStorageClientSettings( |
| 133 | + loadCredential(settings, clientName), |
| 134 | + getConfigValue(settings, clientName, ENDPOINT_SETTING), |
| 135 | + getConfigValue(settings, clientName, CONNECT_TIMEOUT_SETTING), |
| 136 | + getConfigValue(settings, clientName, READ_TIMEOUT_SETTING), |
| 137 | + getConfigValue(settings, clientName, APPLICATION_NAME_SETTING) |
| 138 | + ); |
| 139 | + } |
| 140 | + |
| 141 | + /** |
| 142 | + * Loads the service account file corresponding to a given client name. If no file is defined for the client, |
| 143 | + * a {@code null} credential is returned. |
| 144 | + * |
| 145 | + * @param settings the {@link Settings} |
| 146 | + * @param clientName the client name |
| 147 | + * |
| 148 | + * @return the {@link GoogleCredential} to use for the given client, {@code null} if no service account is defined. |
| 149 | + */ |
| 150 | + static GoogleCredential loadCredential(final Settings settings, final String clientName) { |
| 151 | + try { |
| 152 | + if (CREDENTIALS_FILE_SETTING.getConcreteSettingForNamespace(clientName).exists(settings) == false) { |
| 153 | + // explicitly returning null here so that the default credential |
| 154 | + // can be loaded later when creating the Storage client |
| 155 | + return null; |
| 156 | + } |
| 157 | + try (InputStream credStream = CREDENTIALS_FILE_SETTING.getConcreteSettingForNamespace(clientName).get(settings)) { |
| 158 | + GoogleCredential credential = GoogleCredential.fromStream(credStream); |
| 159 | + if (credential.createScopedRequired()) { |
| 160 | + credential = credential.createScoped(Collections.singleton(StorageScopes.DEVSTORAGE_FULL_CONTROL)); |
| 161 | + } |
| 162 | + return credential; |
| 163 | + } |
| 164 | + } catch (IOException e) { |
| 165 | + throw new UncheckedIOException(e); |
| 166 | + } |
| 167 | + } |
| 168 | + |
| 169 | + private static <T> T getConfigValue(final Settings settings, final String clientName, final Setting.AffixSetting<T> clientSetting) { |
| 170 | + Setting<T> concreteSetting = clientSetting.getConcreteSettingForNamespace(clientName); |
| 171 | + return concreteSetting.get(settings); |
| 172 | + } |
| 173 | +} |
0 commit comments