src/main/java/com/google/devtools/build/lib/authandtls/NetrcCredentials.java

// Copyright 2020 The Bazel Authors. All rights reserved.
//
// 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 com.google.devtools.build.lib.authandtls;

import com.google.auth.Credentials;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.authandtls.Netrc.Credential;
import java.io.IOException;
import java.net.URI;
import java.util.List;
import java.util.Map;

/**
 * Subclass of {@link Credentials} which uses username and password from {@link Netrc} to provide
 * request metadata.
 */
public class NetrcCredentials extends Credentials {
  private final Netrc netrc;

  public NetrcCredentials(Netrc netrc) {
    this.netrc = netrc;
  }

  @Override
  public String getAuthenticationType() {
    return "netrc";
  }

  /**
   * Get the request metadata for a given {@link URI}.
   *
   * <p>The credentials from .netrc file usually consist of machine name and it's corresponding
   * username/password pair.
   *
   * <p>For a given {@link URI}, we compare its host name with credential's machine name to find the
   * username and password. Use {@link BasicHttpAuthenticationEncoder} to encode matched credential.
   * Return empty request metadata if no match found.
   *
   * <p>The returned request metadata has "Authorization" as its key and a single element list of
   * "Basic token" as its value.
   */
  @Override
  public Map<String, List<String>> getRequestMetadata(URI uri) throws IOException {
    Credential credential = netrc.getCredential(uri.getHost());
    if (credential != null) {
      String token =
          BasicHttpAuthenticationEncoder.encode(credential.login(), credential.password());
      return ImmutableMap.of("Authorization", ImmutableList.of(token));
    } else {
      return ImmutableMap.of();
    }
  }

  @Override
  public boolean hasRequestMetadata() {
    return true;
  }

  @Override
  public boolean hasRequestMetadataOnly() {
    return true;
  }

  @Override
  public void refresh() throws IOException {}
}