org.eclipse.che.infrastructure.docker.client.InitialAuthConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docker-client Show documentation
There is a newer version: 7.3.3
/*
 * Copyright (c) 2012-2018 Red Hat, Inc.
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *   Red Hat, Inc. - initial API and implementation
 */
package org.eclipse.che.infrastructure.docker.client;

import static com.google.common.base.Strings.isNullOrEmpty;
import static com.google.common.collect.Maps.newHashMapWithExpectedSize;
import static java.lang.String.format;
import static org.eclipse.che.dto.server.DtoFactory.newDto;

import com.google.common.annotations.VisibleForTesting;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import javax.inject.Inject;
import javax.inject.Singleton;
import org.eclipse.che.infrastructure.docker.auth.dto.AuthConfig;
import org.eclipse.che.infrastructure.docker.auth.dto.AuthConfigs;
import org.eclipse.che.inject.ConfigurationProperties;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Collects auth configurations for private docker registries. Credential might be configured in
 * .properties files, see details {@link org.eclipse.che.inject.CheBootstrap}. Credentials
 * configured as (key=value) pairs. Key is string that starts with prefix {@code
 * che.docker.registry.auth.} followed by url and credentials of docker registry server.
 *
 * {@code
 * che.docker.registry.auth.url=localhost:5000
 * che.docker.registry.auth.username=user1
 * che.docker.registry.auth.password=pass
 * }
 *
 * @author Alexander Garagatyi
 * @author Alexander Andrienko
 * @author Mykola Morhun
 */
@Singleton
public class InitialAuthConfig {

  private static final Logger LOG = LoggerFactory.getLogger(InitialAuthConfig.class);

  private static final String URL = "url";
  private static final String USER_NAME = "username";
  private static final String PASSWORD = "password";

  private AuthConfigs authConfigs;

  @VisibleForTesting protected static final String CONFIG_PREFIX = "che.docker.registry.auth.";

  @VisibleForTesting
  protected static final String CONFIGURATION_PREFIX_PATTERN =
      "che\\.docker\\.registry\\.auth\\..+";

  @VisibleForTesting
  protected static final String VALID_DOCKER_PROPERTY_NAME_EXAMPLE =
      CONFIG_PREFIX + "registry_name.parameter_name";

  @VisibleForTesting
  public InitialAuthConfig() {
    authConfigs = newDto(AuthConfigs.class);
  }

  @Inject
  public InitialAuthConfig(ConfigurationProperties configurationProperties) {
    Map authProperties =
        configurationProperties.getProperties(CONFIGURATION_PREFIX_PATTERN);

    Set registryPrefixes =
        authProperties
            .entrySet()
            .stream()
            .map(property -> getRegistryPrefix(property.getKey()))
            .collect(Collectors.toSet());

    Map configMap = newHashMapWithExpectedSize(registryPrefixes.size());
    for (String regPrefix : registryPrefixes) {
      String url = getPropertyValue(authProperties, regPrefix + URL);
      String userName = getPropertyValue(authProperties, regPrefix + USER_NAME);
      String password = getPropertyValue(authProperties, regPrefix + PASSWORD);

      configMap.put(url, newDto(AuthConfig.class).withUsername(userName).withPassword(password));
    }
    ensureDockerHubConfiguredNoMoreThanOnce(configMap);

    authConfigs = newDto(AuthConfigs.class).withConfigs(configMap);
  }

  /** Returns docker model config file {@link AuthConfig} */
  public AuthConfigs getAuthConfigs() {
    return authConfigs;
  }

  private String getRegistryPrefix(String propertyName) {
    String[] parts = propertyName.replaceFirst(CONFIG_PREFIX, "").split("\\.");

    if (parts.length < 2) {
      throw new IllegalArgumentException(
          format(
              "In the property '%s' is missing '.'. Valid credential registry format is '%s'",
              propertyName, VALID_DOCKER_PROPERTY_NAME_EXAMPLE));
    }
    if (parts.length > 2) {
      throw new IllegalArgumentException(
          format(
              "Property '%s' contains redundant '.'. Valid credential registry format is '%s'",
              propertyName, VALID_DOCKER_PROPERTY_NAME_EXAMPLE));
    }

    String propertyIdentifier = parts[1];
    if (!URL.equals(propertyIdentifier)
        && !USER_NAME.equals(propertyIdentifier)
        && !PASSWORD.equals(propertyIdentifier)) {
      LOG.warn("Set unused property: '{}'.", propertyName);
    }

    return CONFIG_PREFIX + parts[0] + ".";
  }

  private String getPropertyValue(Map authProperties, String propertyName) {
    String propertyValue = authProperties.get(propertyName);
    if (isNullOrEmpty(propertyValue)) {
      throw new IllegalArgumentException(format("Property '%s' is missing.", propertyName));
    }
    return propertyValue;
  }

  private void ensureDockerHubConfiguredNoMoreThanOnce(Map configMap) {
    boolean isDockerHubConfigured = false;
    for (String defaultRegistryAlias : DockerRegistryAuthResolver.DEFAULT_REGISTRY_SYNONYMS) {
      if (configMap.containsKey(defaultRegistryAlias)) {
        if (isDockerHubConfigured) {
          throw new IllegalArgumentException(
              "Docker hub registry is configured more than one time");
        }
        isDockerHubConfigured = true;
      }
    }
  }
}