Module me.gosimple.nbvcxz
Package me.gosimple.nbvcxz.matching.match

Interface Match

All Known Implementing Classes:
BaseMatch, BruteForceMatch, DateMatch, DictionaryMatch, RepeatMatch, SeparatorMatch, SequenceMatch, SpacialMatch, YearMatch
public interface Match
Object to represent a match found by a PasswordMatcher which contains the portion of the password, where in the password the match was found (token), how many characters it is.

It should also be able to calculate a log^2 value of the guesses it would take to exhaust the problem space.

Additionally it should be able to return a string with details about the match to display to a user with relevant information pertaining to the type of Match.
Author:
Adam Brusselback

  • Method Summary

    Modifier and Type Method Description
    double calculateEntropy()
    Calculate the entropy for the current match
    double getAverageEntropy()
    Get the average entropy per character of the current match
    java.lang.String getDetails()
    Returns details about this match in the form of a String to be printed directly
    int getEndIndex()
    Returns the end index of this part of the password
    int getLength()
    Returns the length of this part of the password
    int getStartIndex()
    Returns the start index of this part of the password
    java.lang.String getToken()  

  • Method Details

    • getToken

      java.lang.String getToken()
      Returns:
      the String value of the Match.

    • calculateEntropy

      double calculateEntropy()
      Calculate the entropy for the current match
      Returns:
      a double representing the entropy of the current Match.

    • getAverageEntropy

      double getAverageEntropy()
      Get the average entropy per character of the current match
      Returns:
      a double representing the average entropy per character of the current Match.

    • getStartIndex

      int getStartIndex()
      Returns the start index of this part of the password
      Returns:
      the int start index of this Match.

    • getEndIndex

      int getEndIndex()
      Returns the end index of this part of the password
      Returns:
      the int end index of this Match.

    • getLength

      int getLength()
      Returns the length of this part of the password
      Returns:
      the int length of this Match.

    • getDetails

      java.lang.String getDetails()
      Returns details about this match in the form of a String to be printed directly
      Returns:
      all specific details about this Match in printable String format.