com.google.gcloud.AuthCredentials Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gcloud-java-core Show documentation
Core module for the gcloud-java.
There is a newer version: 0.1.7
/*
 * Copyright 2015 Google Inc. 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.gcloud;

import static com.google.common.base.Preconditions.checkNotNull;

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.compute.ComputeCredential;
import com.google.api.client.googleapis.extensions.appengine.auth.oauth2.AppIdentityCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.jackson.JacksonFactory;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectStreamException;
import java.io.Serializable;
import java.security.GeneralSecurityException;
import java.security.PrivateKey;
import java.util.Objects;
import java.util.Set;

/**
 * Credentials for accessing Google Cloud services.
 */
public abstract class AuthCredentials implements Serializable {

  private static final long serialVersionUID = 236297804453464604L;

  private static class AppEngineAuthCredentials extends AuthCredentials {

    private static final long serialVersionUID = 7931300552744202954L;

    private static final AuthCredentials INSTANCE = new AppEngineAuthCredentials();

    @Override
    protected HttpRequestInitializer httpRequestInitializer(HttpTransport transport,
        Set scopes) {
      return new AppIdentityCredential(scopes);
    }

    private Object readResolve() throws ObjectStreamException {
      return INSTANCE;
    }
  }

  public static class ServiceAccountAuthCredentials extends AuthCredentials {

    private static final long serialVersionUID = 8007708734318445901L;
    private final String account;
    private final PrivateKey privateKey;

    private static final AuthCredentials NO_CREDENTIALS = new ServiceAccountAuthCredentials();

    ServiceAccountAuthCredentials(String account, PrivateKey privateKey) {
      this.account = checkNotNull(account);
      this.privateKey = checkNotNull(privateKey);
    }

    ServiceAccountAuthCredentials() {
      account = null;
      privateKey = null;
    }

    @Override
    protected HttpRequestInitializer httpRequestInitializer(
        HttpTransport transport, Set scopes) {
      GoogleCredential.Builder builder = new GoogleCredential.Builder()
          .setTransport(transport)
          .setJsonFactory(new JacksonFactory());
      if (privateKey != null) {
        builder.setServiceAccountPrivateKey(privateKey);
        builder.setServiceAccountId(account);
        builder.setServiceAccountScopes(scopes);
      }
      return builder.build();
    }

    public String account() {
      return account;
    }

    public PrivateKey privateKey() {
      return privateKey;
    }

    @Override
    public int hashCode() {
      return Objects.hash(account, privateKey);
    }

    @Override
    public boolean equals(Object obj) {
      if (!(obj instanceof ServiceAccountAuthCredentials)) {
        return false;
      }
      ServiceAccountAuthCredentials other = (ServiceAccountAuthCredentials) obj;
      return Objects.equals(account, other.account)
          && Objects.equals(privateKey, other.privateKey);
    }
  }

  private static class ComputeEngineAuthCredentials extends AuthCredentials {

    private static final long serialVersionUID = -5217355402127260144L;

    private transient ComputeCredential computeCredential;

    ComputeEngineAuthCredentials() throws IOException, GeneralSecurityException {
      computeCredential = getComputeCredential();
    }

    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
      in.defaultReadObject();
      try {
        computeCredential = getComputeCredential();
      } catch (GeneralSecurityException e) {
       throw new IOException(e);
      }
    }

    @Override
    protected HttpRequestInitializer httpRequestInitializer(HttpTransport transport,
        Set scopes) {
      return computeCredential;
    }
  }

  private static class ApplicationDefaultAuthCredentials extends AuthCredentials {

    private static final long serialVersionUID = -8306873864136099893L;

    private transient GoogleCredentials googleCredentials;

    ApplicationDefaultAuthCredentials() throws IOException {
      googleCredentials = GoogleCredentials.getApplicationDefault();
    }

    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
      in.defaultReadObject();
      googleCredentials =  GoogleCredentials.getApplicationDefault();
    }

    @Override
    protected HttpRequestInitializer httpRequestInitializer(HttpTransport transport,
        Set scopes) {
      return new HttpCredentialsAdapter(googleCredentials);
    }
  }

  protected abstract HttpRequestInitializer httpRequestInitializer(HttpTransport transport,
      Set scopes);

  public static AuthCredentials createForAppEngine() {
    return AppEngineAuthCredentials.INSTANCE;
  }

  public static AuthCredentials createForComputeEngine()
      throws IOException, GeneralSecurityException {
    return new ComputeEngineAuthCredentials();
  }

  /**
   * Returns the Application Default Credentials.
   *
   * Returns the Application Default Credentials which are credentials that identify and
   * authorize the whole application. This is the built-in service account if running on
   * Google Compute Engine or the credentials file from the path in the environment variable
   * GOOGLE_APPLICATION_CREDENTIALS.
   * 
   *
   * @return the credentials instance.
   * @throws IOException if the credentials cannot be created in the current environment.
   */
  public static AuthCredentials createApplicationDefaults() throws IOException {
    return new ApplicationDefaultAuthCredentials();
  }

  public static ServiceAccountAuthCredentials createFor(String account, PrivateKey privateKey) {
    return new ServiceAccountAuthCredentials(account, privateKey);
  }

  public static AuthCredentials noCredentials() {
    return ServiceAccountAuthCredentials.NO_CREDENTIALS;
  }

  static ComputeCredential getComputeCredential() throws IOException, GeneralSecurityException {
    NetHttpTransport transport = GoogleNetHttpTransport.newTrustedTransport();
    // Try to connect using Google Compute Engine service account credentials.
    ComputeCredential credential = new ComputeCredential(transport, new JacksonFactory());
    // Force token refresh to detect if we are running on Google Compute Engine.
    credential.refreshToken();
    return credential;
  }
}