com.nulabinc.zxcvbn.Strength Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zxcvbn Show documentation
This is a java port of zxcvbn, which is a JavaScript password strength generator.
The newest version!
package com.nulabinc.zxcvbn;

import com.nulabinc.zxcvbn.matchers.Match;
import java.util.ArrayList;
import java.util.List;

public class Strength {

  private CharSequence password;
  private double guesses;
  private double guessesLog10;
  private AttackTimes.CrackTimeSeconds crackTimeSeconds;
  private AttackTimes.CrackTimesDisplay crackTimesDisplay;
  private int score;
  private Feedback feedback;
  private List sequence;
  private long calcTime;

  /**
   * Default constructor.
   *
   * @deprecated This constructor is discouraged from use as it does not ensure all fields are
   *     initialized properly. Instead, use the {@link #Strength(CharSequence, double, List, long)}
   *     constructor to provide all necessary data.
   */
  @Deprecated
  public Strength() {
    this.sequence = new ArrayList<>();
  }

  /**
   * Constructs a Strength object with the given parameters.
   *
   * @param password The password for which strength is calculated.
   * @param guesses Estimated number of guesses needed to crack the password.
   * @param sequence A list of matching patterns found in the password.
   * @param calcTime Time taken to calculate the password's strength.
   */
  public Strength(CharSequence password, double guesses, List sequence, long calcTime) {
    this.password = password;
    this.guesses = guesses;
    this.guessesLog10 = Scoring.log10(guesses);

    if (sequence == null) {
      sequence = new ArrayList<>();
    }
    this.sequence = sequence;

    AttackTimes attackTimes = TimeEstimates.estimateAttackTimes(guesses);
    this.crackTimeSeconds = attackTimes.getCrackTimeSeconds();
    this.crackTimesDisplay = attackTimes.getCrackTimesDisplay();
    this.score = attackTimes.getScore();
    this.feedback = Feedback.getFeedback(attackTimes.getScore(), sequence);

    this.calcTime = calcTime;
  }

  public CharSequence getPassword() {
    return password;
  }

  /**
   * Sets the password.
   *
   * @deprecated Use constructor for initialization. Modifying after instantiation is not
   *     recommended.
   */
  @Deprecated
  public void setPassword(CharSequence password) {
    this.password = password;
  }

  public double getGuesses() {
    return guesses;
  }

  /**
   * Sets the estimated number of guesses.
   *
   * @deprecated Use constructor for initialization. Modifying after instantiation is not
   *     recommended.
   */
  @Deprecated
  public void setGuesses(double guesses) {
    this.guesses = guesses;
  }

  public double getGuessesLog10() {
    return guessesLog10;
  }

  /**
   * Sets the logarithm (base 10) of the estimated number of guesses.
   *
   * @deprecated Use constructor for initialization. Modifying after instantiation is not
   *     recommended.
   */
  @Deprecated
  public void setGuessesLog10(double guessesLog10) {
    this.guessesLog10 = guessesLog10;
  }

  public AttackTimes.CrackTimeSeconds getCrackTimeSeconds() {
    return crackTimeSeconds;
  }

  /**
   * Sets the crack time in seconds.
   *
   * @deprecated Use constructor for initialization. Modifying after instantiation is not
   *     recommended.
   */
  @Deprecated
  public void setCrackTimeSeconds(AttackTimes.CrackTimeSeconds crackTimeSeconds) {
    this.crackTimeSeconds = crackTimeSeconds;
  }

  public AttackTimes.CrackTimesDisplay getCrackTimesDisplay() {
    return crackTimesDisplay;
  }

  /**
   * Sets the display times for crack attempts.
   *
   * @deprecated Use constructor for initialization. Modifying after instantiation is not
   *     recommended.
   */
  @Deprecated
  public void setCrackTimesDisplay(AttackTimes.CrackTimesDisplay crackTimesDisplay) {
    this.crackTimesDisplay = crackTimesDisplay;
  }

  public int getScore() {
    return score;
  }

  /**
   * Sets the score.
   *
   * @deprecated Use constructor for initialization. Modifying after instantiation is not
   *     recommended.
   */
  @Deprecated
  public void setScore(int score) {
    this.score = score;
  }

  public Feedback getFeedback() {
    return feedback;
  }

  /**
   * Sets the feedback.
   *
   * @deprecated Use constructor for initialization. Modifying after instantiation is not
   *     recommended.
   */
  @Deprecated
  public void setFeedback(Feedback feedback) {
    this.feedback = feedback;
  }

  public List getSequence() {
    return sequence;
  }

  /**
   * Sets the sequence of matches.
   *
   * @deprecated Use constructor for initialization. Modifying after instantiation is not
   *     recommended.
   */
  @Deprecated
  public void setSequence(List sequence) {
    if (sequence == null) {
      sequence = new ArrayList<>();
    }
    this.sequence = sequence;
  }

  public long getCalcTime() {
    return calcTime;
  }

  /**
   * Sets the calculation time.
   *
   * @deprecated Use constructor for initialization. Modifying after instantiation is not
   *     recommended.
   */
  @Deprecated
  public void setCalcTime(long calcTime) {
    this.calcTime = calcTime;
  }

  /** Attempts to wipe any sensitive content from the object. */
  public void wipe() {
    WipeableString.wipeIfPossible(password);
    for (Match match : sequence) {
      WipeableString.wipeIfPossible(match.token);
      WipeableString.wipeIfPossible(match.baseToken);
      WipeableString.wipeIfPossible(match.matchedWord);
    }
  }
}