com.google.firebase.auth.internal.KeyManagers Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of firebase-admin Show documentation

This is the official Firebase Admin Java SDK. Build extraordinary native JVM apps in minutes with Firebase. The Firebase platform can power your app’s backend, user authentication, static hosting, and more.

There is a newer version: 9.3.0

Show newest version

/*
 * Copyright 2017 Google Inc.
 *
 * 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.firebase.auth.internal;

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

import com.google.api.client.googleapis.auth.oauth2.GooglePublicKeysManager;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.client.util.Clock;
import com.google.common.annotations.VisibleForTesting;
import com.google.firebase.FirebaseApp;
import com.google.firebase.internal.NonNull;

/**
 * A utility for initializing and keeping tack of the various public key manager instances
 * used by {@link com.google.firebase.auth.FirebaseAuth}.
 */
public class KeyManagers {

  private final GooglePublicKeysManager idTokenKeysManager;
  private final GooglePublicKeysManager sessionCookieKeysManager;

  private KeyManagers(
      GooglePublicKeysManager idTokenKeysManager,
      GooglePublicKeysManager sessionCookieKeysManager) {
    this.idTokenKeysManager = checkNotNull(idTokenKeysManager);
    this.sessionCookieKeysManager = checkNotNull(sessionCookieKeysManager);
  }

  /**
   * Returns the key manager that should be used for ID token verification.
   */
  GooglePublicKeysManager getIdTokenKeysManager() {
    return idTokenKeysManager;
  }

  /**
   * Returns the key manager that should be used for session cookie verification.
   */
  GooglePublicKeysManager getSessionCookieKeysManager() {
    return sessionCookieKeysManager;
  }

  /**
   * Initialize a new set of key managers for the specified app using the given clock.
   *
   * @param app A {@link FirebaseApp} instance.
   * @param clock A {@code Clock} to be used with Google API client.
   * @return A new {@link KeyManagers} instance.
   */
  public static KeyManagers getDefault(@NonNull FirebaseApp app, @NonNull Clock clock) {
    HttpTransport transport = app.getOptions().getHttpTransport();
    return getDefault(transport, clock);
  }

  @VisibleForTesting
  static KeyManagers getDefault(HttpTransport transport, Clock clock) {
    return new KeyManagers(
        createPublicKeysManager(transport, clock, FirebaseTokenVerifier.ID_TOKEN_CERT_URL),
        createPublicKeysManager(transport, clock, FirebaseTokenVerifier.SESSION_COOKIE_CERT_URL));
  }

  private static GooglePublicKeysManager createPublicKeysManager(
      HttpTransport transport, Clock clock, String certUrl) {
    return new GooglePublicKeysManager.Builder(transport, new GsonFactory())
        .setClock(clock)
        .setPublicCertsEncodedUrl(certUrl)
        .build();
  }
}