Foo.java

// SPDX-FileCopyrightText: the secureCodeBox authors
//
// SPDX-License-Identifier: Apache-2.0

package io.securecodebox.persistence.defectdojo.http;

import io.securecodebox.persistence.defectdojo.config.Config;
import lombok.NonNull;
import lombok.extern.slf4j.Slf4j;
import org.apache.http.HttpHost;
import org.apache.http.auth.AuthScope;
import org.apache.http.auth.Credentials;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.CredentialsProvider;
import org.apache.http.impl.client.BasicCredentialsProvider;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.impl.client.ProxyAuthenticationStrategy;
import org.springframework.http.HttpHeaders;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate;

import java.nio.charset.StandardCharsets;
import java.util.Base64;

/**
 * Placeholder to move duplicated code, will be named better later
 */
@Slf4j
public final class Foo {
  private final Config config;
  private final ProxyConfig proxyConfig;

  public Foo(@NonNull final Config config, @NonNull final ProxyConfig proxyConfig) {
    super();
    this.config = config;
    this.proxyConfig = proxyConfig;
  }

  /**
   * This method generates appropriate authorization headers
   *
   * @return never {@code null}
   */
  public HttpHeaders generateAuthorizationHeaders() {
    HttpHeaders headers = new HttpHeaders();
    headers.set(HttpHeaders.AUTHORIZATION, "Token " + this.config.getApiKey());

    if (proxyConfig.isComplete()) {
      log.info("Setting Proxy Auth Header...");
      headers.set(HttpHeaders.PROXY_AUTHORIZATION, "Basic " + encodeProxyCredentials(proxyConfig));
    }

    return headers;
  }

  static String encodeProxyCredentials(@NonNull final ProxyConfig cfg) {
    final var credential = String.format("%s:%s", cfg.getUser(), cfg.getPassword());
    return Base64.getEncoder().encodeToString(credential.getBytes(StandardCharsets.UTF_8));
  }

  public RestTemplate createRestTemplate() {
    if (proxyConfig.isComplete()) {
      // Configuring Proxy Authentication explicitly as it isn't done by default for spring rest templates :(
      final var builder = HttpClientBuilder.create()
        .useSystemProperties()
        .setProxy(createHttpHost())
        .setDefaultCredentialsProvider(createCredentialsProvider())
        .setProxyAuthenticationStrategy(new ProxyAuthenticationStrategy());

      final var factory = new HttpComponentsClientHttpRequestFactory();
      factory.setHttpClient(builder.build());

      return new RestTemplate(factory);
    }

    return new RestTemplate();
  }

  CredentialsProvider createCredentialsProvider() {
    final var provider = new BasicCredentialsProvider();
    provider.setCredentials(createAuthScope(), createCredentials());
    return provider;
  }

  AuthScope createAuthScope() {
    return new AuthScope(proxyConfig.getHost(), proxyConfig.getPort());
  }

  Credentials createCredentials() {
    return new UsernamePasswordCredentials(proxyConfig.getUser(), proxyConfig.getPassword());
  }

  HttpHost createHttpHost() {
    return new HttpHost(proxyConfig.getHost(), proxyConfig.getPort());
  }
}