com.google.firebase.auth.ExportedUserRecord 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.

The 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;

import com.google.api.client.json.JsonFactory;
import com.google.common.io.BaseEncoding;
import com.google.firebase.auth.internal.DownloadAccountResponse.User;
import com.google.firebase.internal.Nullable;

/**
 * Contains metadata associated with a Firebase user account, along with password hash and salt.
 * Instances of this class are immutable and thread-safe.
 */
public class ExportedUserRecord extends UserRecord {

  private final String passwordHash;
  private final String passwordSalt;
  private static final String REDACTED_BASE64 = BaseEncoding.base64Url().encode(
      "REDACTED".getBytes());

  ExportedUserRecord(User response, JsonFactory jsonFactory) {
    super(response, jsonFactory);
    String passwordHash = response.getPasswordHash();
    if (passwordHash != null && !passwordHash.equals(REDACTED_BASE64)) {
      this.passwordHash = passwordHash;
    } else {
      this.passwordHash = null;
    }
    this.passwordSalt = response.getPasswordSalt();
  }

  /**
   * Returns the user's password hash as a base64-encoded string.
   *
   * If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account,
   * returns the base64-encoded password hash of the user. If a different hashing algorithm was
   * used to create this user, as is typical when migrating from another Auth system, returns
   * an empty string. Returns null if no password is set.
   *
   * @return A base64-encoded password hash, possibly empty or null.
   */
  @Nullable
  public String getPasswordHash() {
    return passwordHash;
  }

  /**
   * Returns the user's password salt as a base64-encoded string.
   *
   * If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account,
   * returns the base64-encoded password salt of the user. If a different hashing algorithm was
   * used to create this user, as is typical when migrating from another Auth system, returns
   * an empty string. Returns null if no password is set.
   *
   * @return A base64-encoded password salt, possibly empty or null.
   */
  @Nullable
  public String getPasswordSalt() {
    return passwordSalt;
  }
}